Re: [R] FAQ 7.x when 7 does not exist. Useability question

2007-08-27 Thread Duncan Murdoch
On 8/27/2007 8:52 AM, John Kane wrote:
> --- Duncan Murdoch <[EMAIL PROTECTED]> wrote:

>> I like the first, simple suggestion best; I'll put
>> it into R-devel.  
>> (With the slight change to use ul.menu instead
>> of just ul, because FAQ 2.7 includes a plain ul
>> list.)
>> 
>> Duncan Murdoch
> Thanks Deepayan and Duncan.  
> 
> It is not a make or break point in using R but it does
> seem to make the FAQ a bit more user-friendly.

I'm about to commit the change, but it's not perfect.  I've applied the 
change to the css used in all the manuals, not just the FAQ, so the HTML 
versions of the manuals now end up with numbered contents listings too. 
  However, appendices continue the chapter numbering, rather than 
switching to letters.  I think this is preferable to no numbering at 
all, but if others object to it, we can make this change for the FAQ only.

Another way to do this is what's used in the texinfo manual
http://www.gnu.org/software/texinfo/manual/texinfo/texinfo.html
but I find that ugly and inconsistent.  The contents listing gets the 
numbering and lettering right (but not well formatted), but within each 
chapter the menus are unnumbered.

The texinfo format is just a bit limited for this kind of thing.

Duncan Murdoch

__
R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] FAQ 7.x when 7 does not exist. Useability question

2007-08-27 Thread John Kane

--- Duncan Murdoch <[EMAIL PROTECTED]> wrote:

> Deepayan Sarkar wrote:
> > On 8/23/07, Duncan Murdoch <[EMAIL PROTECTED]>
> wrote:
> >   
> >> On 8/23/2007 11:28 AM, Prof Brian Ripley wrote:
> >> 
> >>> On Thu, 23 Aug 2007, John Kane wrote:
> >>>
> >>>   
>  The FAQ Section 7 is a very useful place for
> new users
>  to find out any number of R idiosycracies. 
> However
>  there is no numbering on the FAQ Table of
> Content or
>  on the Sections Tables of Contents.
>  
> >>> Hmm, doc/FAQ does have a numbered table of
> contents and numbered sections
> >>> and doc/manual/R-FAQ.html does have numbered
> sections and my browser's
> >>> search finds 7.10 straight away.
> >>>   
> >> I think the suggestion is to change the contents
> lists in HTML from 
> >> lists to  lists.  Then one would see
> >>
> >> 1. Introduction
> >> 2. R Basics
> >> 3. R and S
> >> 4. R Web Interfaces
> >> 5. R Add-On Packages
> >> 6. R and Emacs
> >> 7. R Miscellanea
> >> 8. R Programming
> >> 9. R Bugs
> >>10. Acknowledgments
> >>
> >> instead of
> >>
> >>  * Introduction
> >>  * R Basics
> >>  * R and S
> >>  * R Web Interfaces
> >>  * R Add-On Packages
> >>  * R and Emacs
> >>  * R Miscellanea
> >>  * R Programming
> >>  * R Bugs
> >>  * Acknowledgments
> >>
> >> in a browser, and I agree that would be
> preferable (assuming the
> >> numbering is consistent with what we get in the
> other formats).
> >> However, I don't see how to tell makeinfo --html
> to do this.  Adding
> >> --number-sections isn't enough.
> >> 
> >
> > A simple CSS hack is to have
> >
> > ul{
> > list-style-type: decimal;
> > }
> >
> > in the style. The result can be seen in
> >
> > http://dsarkar.fhcrc.org/R/RFAQ-1.png
> >
> > A more sophisticated hack is to have something
> like
> >
> > ---
> > body{
> > counter-reset: chapter;
> > counter-reset: section;
> > }
> > h2.chapter {
> > counter-increment: chapter;
> > counter-reset: section;
> > }
> >
> > ul {
> > list-style-type: none;
> > }
> >
> > li:before {
> > counter-increment: section;
> > content: counter(chapter) "." counter(section)
> " " ;
> > }
> > -
> >
> > which results in
> >
> > http://dsarkar.fhcrc.org/R/RFAQ-2.png
> >
> > The only problem here is that there is no way to
> distinguish between
> > the chapter listing and the section listings (both
> are  > class="menu">). If that could be made to have a
> different class, the
> > chapter listing could be improved.
> 
> I like the first, simple suggestion best; I'll put
> it into R-devel.  
> (With the slight change to use ul.menu instead
> of just ul, because FAQ 2.7 includes a plain ul
> list.)
> 
> Duncan Murdoch
Thanks Deepayan and Duncan.  

It is not a make or break point in using R but it does
seem to make the FAQ a bit more user-friendly.

__
R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] FAQ 7.x when 7 does not exist. Useability question

2007-08-26 Thread Duncan Murdoch
Deepayan Sarkar wrote:
> On 8/23/07, Duncan Murdoch <[EMAIL PROTECTED]> wrote:
>   
>> On 8/23/2007 11:28 AM, Prof Brian Ripley wrote:
>> 
>>> On Thu, 23 Aug 2007, John Kane wrote:
>>>
>>>   
 The FAQ Section 7 is a very useful place for new users
 to find out any number of R idiosycracies.  However
 there is no numbering on the FAQ Table of Content or
 on the Sections Tables of Contents.
 
>>> Hmm, doc/FAQ does have a numbered table of contents and numbered sections
>>> and doc/manual/R-FAQ.html does have numbered sections and my browser's
>>> search finds 7.10 straight away.
>>>   
>> I think the suggestion is to change the contents lists in HTML from 
>> lists to  lists.  Then one would see
>>
>> 1. Introduction
>> 2. R Basics
>> 3. R and S
>> 4. R Web Interfaces
>> 5. R Add-On Packages
>> 6. R and Emacs
>> 7. R Miscellanea
>> 8. R Programming
>> 9. R Bugs
>>10. Acknowledgments
>>
>> instead of
>>
>>  * Introduction
>>  * R Basics
>>  * R and S
>>  * R Web Interfaces
>>  * R Add-On Packages
>>  * R and Emacs
>>  * R Miscellanea
>>  * R Programming
>>  * R Bugs
>>  * Acknowledgments
>>
>> in a browser, and I agree that would be preferable (assuming the
>> numbering is consistent with what we get in the other formats).
>> However, I don't see how to tell makeinfo --html to do this.  Adding
>> --number-sections isn't enough.
>> 
>
> A simple CSS hack is to have
>
> ul{
> list-style-type: decimal;
> }
>
> in the style. The result can be seen in
>
> http://dsarkar.fhcrc.org/R/RFAQ-1.png
>
> A more sophisticated hack is to have something like
>
> ---
> body{
> counter-reset: chapter;
> counter-reset: section;
> }
> h2.chapter {
> counter-increment: chapter;
> counter-reset: section;
> }
>
> ul {
> list-style-type: none;
> }
>
> li:before {
> counter-increment: section;
> content: counter(chapter) "." counter(section) " " ;
> }
> -
>
> which results in
>
> http://dsarkar.fhcrc.org/R/RFAQ-2.png
>
> The only problem here is that there is no way to distinguish between
> the chapter listing and the section listings (both are  class="menu">). If that could be made to have a different class, the
> chapter listing could be improved.

I like the first, simple suggestion best; I'll put it into R-devel.  
(With the slight change to use ul.menu instead
of just ul, because FAQ 2.7 includes a plain ul list.)

Duncan Murdoch

__
R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] FAQ 7.x when 7 does not exist. Useability question

2007-08-23 Thread John Kane

--- Prof Brian Ripley <[EMAIL PROTECTED]> wrote:

> On Thu, 23 Aug 2007, John Kane wrote:
> 
> > The FAQ Section 7 is a very useful place for new
> users
> > to find out any number of R idiosycracies. 
> However
> > there is no numbering on the FAQ Table of Content
> or
> > on the Sections Tables of Contents.
> 
> Hmm, doc/FAQ does have a numbered table of contents
> and numbered sections 

Perhaps we are not talking about the same thing but I
don't see any numbers. My procedure  
- click on FAQ link below documentation, 
- click on R-FAQ link
Result
http://ca.geocities.com/jrkrideau/R/RFAQ.jpg

> and doc/manual/R-FAQ.html does have numbered
sections
 
Click on R-Miscelanea 
Result
http://ca.geocities.com/jrkrideau/R/RFAQ.jpg

The sections themselves are numbered but not the ToC,
at least as displayed in my browser.

Apologies for the poor quality of the screen capture.

As a check, I even found IE and had a look. I am
getting the same display in Firefox and IE so it does
not look like a browser issue.

>and my browser's search finds 7.10 straight away.

As does mine. I just question if this is recommended
as the default approach.  

> 
> > An R-help list reply of "Read FAQ 7.10" in
> response to
> > a question about converting a factor to numeric is
>  a
> > bit cryptic. The only time 7.10 appears is after
> the
> > searcher has found the entry.
> 
> It would help if you told us what you are searching
> that did not contain 
> '7.10'.
> 
> > Would it be a good idea to actually number the
> entries
> > for the FAQ Table of Contents and the Table of
> > Contents for the Sections?
> 
> I think we do.
> 
> -- 
> Brian D. Ripley, 
> [EMAIL PROTECTED]
> Professor of Applied Statistics, 
> http://www.stats.ox.ac.uk/~ripley/
> University of Oxford, Tel:  +44 1865
> 272861 (self)
> 1 South Parks Road, +44 1865
> 272866 (PA)
> Oxford OX1 3TG, UKFax:  +44 1865
> 272595
>

__
R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] FAQ 7.x when 7 does not exist. Useability question

2007-08-23 Thread Deepayan Sarkar
On 8/23/07, Duncan Murdoch <[EMAIL PROTECTED]> wrote:
> On 8/23/2007 11:28 AM, Prof Brian Ripley wrote:
> > On Thu, 23 Aug 2007, John Kane wrote:
> >
> >> The FAQ Section 7 is a very useful place for new users
> >> to find out any number of R idiosycracies.  However
> >> there is no numbering on the FAQ Table of Content or
> >> on the Sections Tables of Contents.
> >
> > Hmm, doc/FAQ does have a numbered table of contents and numbered sections
> > and doc/manual/R-FAQ.html does have numbered sections and my browser's
> > search finds 7.10 straight away.
>
> I think the suggestion is to change the contents lists in HTML from 
> lists to  lists.  Then one would see
>
> 1. Introduction
> 2. R Basics
> 3. R and S
> 4. R Web Interfaces
> 5. R Add-On Packages
> 6. R and Emacs
> 7. R Miscellanea
> 8. R Programming
> 9. R Bugs
>10. Acknowledgments
>
> instead of
>
>  * Introduction
>  * R Basics
>  * R and S
>  * R Web Interfaces
>  * R Add-On Packages
>  * R and Emacs
>  * R Miscellanea
>  * R Programming
>  * R Bugs
>  * Acknowledgments
>
> in a browser, and I agree that would be preferable (assuming the
> numbering is consistent with what we get in the other formats).
> However, I don't see how to tell makeinfo --html to do this.  Adding
> --number-sections isn't enough.

A simple CSS hack is to have

ul{
list-style-type: decimal;
}

in the style. The result can be seen in

http://dsarkar.fhcrc.org/R/RFAQ-1.png

A more sophisticated hack is to have something like

---
body{
counter-reset: chapter;
counter-reset: section;
}
h2.chapter {
counter-increment: chapter;
counter-reset: section;
}

ul {
list-style-type: none;
}

li:before {
counter-increment: section;
content: counter(chapter) "." counter(section) " " ;
}
-

which results in

http://dsarkar.fhcrc.org/R/RFAQ-2.png

The only problem here is that there is no way to distinguish between
the chapter listing and the section listings (both are ). If that could be made to have a different class, the
chapter listing could be improved.

-Deepayan

__
R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] FAQ 7.x when 7 does not exist. Useability question

2007-08-23 Thread John Kane
Yes that is it. Thanks
--- "Michael A. Miller" <[EMAIL PROTECTED]> wrote:

> > "John" == John Kane <[EMAIL PROTECTED]>
> writes:
> 
> > Apologies for the poor quality of the screen
> capture.
> 
> I think the first one is a screen cap of
> http://cran.r-project.org/doc/FAQ/R-FAQ.html.  Is
> that correct?
> 
> The faq that is part of the r-doc-html package from
> Debian also
> has the same "bulleted" table of contents.
> 
> Mike

__
R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] FAQ 7.x when 7 does not exist. Useability question

2007-08-23 Thread John Kane
Thank you Duncan. That is exactly what I meant.  The 
next level (for example, after clicking on R
Miscellanea) should also have numbers.

Whether or not it's possible in html as implimented on
the R website is another matter of course.

--- Duncan Murdoch <[EMAIL PROTECTED]> wrote:

> On 8/23/2007 11:28 AM, Prof Brian Ripley wrote:
> > On Thu, 23 Aug 2007, John Kane wrote:
> > 
> >> The FAQ Section 7 is a very useful place for new
> users
> >> to find out any number of R idiosycracies. 
> However
> >> there is no numbering on the FAQ Table of Content
> or
> >> on the Sections Tables of Contents.
> > 
> > Hmm, doc/FAQ does have a numbered table of
> contents and numbered sections 
> > and doc/manual/R-FAQ.html does have numbered
> sections and my browser's 
> > search finds 7.10 straight away.
> 
> I think the suggestion is to change the contents
> lists in HTML from  
> lists to  lists.  Then one would see
> 
> 1. Introduction
> 2. R Basics
> 3. R and S
> 4. R Web Interfaces
> 5. R Add-On Packages
> 6. R and Emacs
> 7. R Miscellanea
> 8. R Programming
> 9. R Bugs
>10. Acknowledgments
> 
> instead of
> 
>  * Introduction
>  * R Basics
>  * R and S
>  * R Web Interfaces
>  * R Add-On Packages
>  * R and Emacs
>  * R Miscellanea
>  * R Programming
>  * R Bugs
>  * Acknowledgments
> 
> in a browser, and I agree that would be preferable
> (assuming the 
> numbering is consistent with what we get in the
> other formats). 
> However, I don't see how to tell makeinfo --html to
> do this.  Adding 
> --number-sections isn't enough.
> 
> Duncan Murdoch
> 
> > 
> > 
> >> An R-help list reply of "Read FAQ 7.10" in
> response to
> >> a question about converting a factor to numeric
> is  a
> >> bit cryptic. The only time 7.10 appears is after
> the
> >> searcher has found the entry.
> > 
> > It would help if you told us what you are
> searching that did not contain 
> > '7.10'.
> > 
> >> Would it be a good idea to actually number the
> entries
> >> for the FAQ Table of Contents and the Table of
> >> Contents for the Sections?
> > 
> > I think we do.
> > 
> 
>

__
R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] FAQ 7.x when 7 does not exist. Useability question

2007-08-23 Thread Michael A. Miller
> "John" == John Kane <[EMAIL PROTECTED]> writes:

> Apologies for the poor quality of the screen capture.

I think the first one is a screen cap of
http://cran.r-project.org/doc/FAQ/R-FAQ.html.  Is that correct?

The faq that is part of the r-doc-html package from Debian also
has the same "bulleted" table of contents.

Mike

__
R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] FAQ 7.x when 7 does not exist. Useability question

2007-08-23 Thread Duncan Murdoch
On 8/23/2007 11:28 AM, Prof Brian Ripley wrote:
> On Thu, 23 Aug 2007, John Kane wrote:
> 
>> The FAQ Section 7 is a very useful place for new users
>> to find out any number of R idiosycracies.  However
>> there is no numbering on the FAQ Table of Content or
>> on the Sections Tables of Contents.
> 
> Hmm, doc/FAQ does have a numbered table of contents and numbered sections 
> and doc/manual/R-FAQ.html does have numbered sections and my browser's 
> search finds 7.10 straight away.

I think the suggestion is to change the contents lists in HTML from  
lists to  lists.  Then one would see

1. Introduction
2. R Basics
3. R and S
4. R Web Interfaces
5. R Add-On Packages
6. R and Emacs
7. R Miscellanea
8. R Programming
9. R Bugs
   10. Acknowledgments

instead of

 * Introduction
 * R Basics
 * R and S
 * R Web Interfaces
 * R Add-On Packages
 * R and Emacs
 * R Miscellanea
 * R Programming
 * R Bugs
 * Acknowledgments

in a browser, and I agree that would be preferable (assuming the 
numbering is consistent with what we get in the other formats). 
However, I don't see how to tell makeinfo --html to do this.  Adding 
--number-sections isn't enough.

Duncan Murdoch

> 
> 
>> An R-help list reply of "Read FAQ 7.10" in response to
>> a question about converting a factor to numeric is  a
>> bit cryptic. The only time 7.10 appears is after the
>> searcher has found the entry.
> 
> It would help if you told us what you are searching that did not contain 
> '7.10'.
> 
>> Would it be a good idea to actually number the entries
>> for the FAQ Table of Contents and the Table of
>> Contents for the Sections?
> 
> I think we do.
>

__
R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] FAQ 7.x when 7 does not exist. Useability question

2007-08-23 Thread Prof Brian Ripley
On Thu, 23 Aug 2007, John Kane wrote:

> The FAQ Section 7 is a very useful place for new users
> to find out any number of R idiosycracies.  However
> there is no numbering on the FAQ Table of Content or
> on the Sections Tables of Contents.

Hmm, doc/FAQ does have a numbered table of contents and numbered sections 
and doc/manual/R-FAQ.html does have numbered sections and my browser's 
search finds 7.10 straight away.


> An R-help list reply of "Read FAQ 7.10" in response to
> a question about converting a factor to numeric is  a
> bit cryptic. The only time 7.10 appears is after the
> searcher has found the entry.

It would help if you told us what you are searching that did not contain 
'7.10'.

> Would it be a good idea to actually number the entries
> for the FAQ Table of Contents and the Table of
> Contents for the Sections?

I think we do.

-- 
Brian D. Ripley,  [EMAIL PROTECTED]
Professor of Applied Statistics,  http://www.stats.ox.ac.uk/~ripley/
University of Oxford, Tel:  +44 1865 272861 (self)
1 South Parks Road, +44 1865 272866 (PA)
Oxford OX1 3TG, UKFax:  +44 1865 272595

__
R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] FAQ 7.x when 7 does not exist. Useability question

2007-08-23 Thread John Kane

--- Gabor Grothendieck <[EMAIL PROTECTED]>
wrote:

> Note that googling
> 
> R FAQ 7.10
> 
> will get it on the first hit.

True, however this is not exactly a self-contained
solution if one is actually trying to use the FAQ. I
may be old fashioned but when directed to the FAQ I
tend to go to the FAQ rather than Google.  

> 
> On 8/23/07, John Kane <[EMAIL PROTECTED]> wrote:
> > The FAQ Section 7 is a very useful place for new
> users
> > to find out any number of R idiosycracies. 
> However
> > there is no numbering on the FAQ Table of Content
> or
> > on the Sections Tables of Contents.
> >
> > An R-help list reply of "Read FAQ 7.10" in
> response to
> > a question about converting a factor to numeric is
>  a
> > bit cryptic. The only time 7.10 appears is after
> the
> > searcher has found the entry.
> >
> > Would it be a good idea to actually number the
> entries
> > for the FAQ Table of Contents and the Table of
> > Contents for the Sections?
> >
> > __
> > R-help@stat.math.ethz.ch mailing list
> > https://stat.ethz.ch/mailman/listinfo/r-help
> > PLEASE do read the posting guide
> http://www.R-project.org/posting-guide.html
> > and provide commented, minimal, self-contained,
> reproducible code.
> >
>

__
R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


Re: [R] FAQ 7.x when 7 does not exist. Useability question

2007-08-23 Thread Gabor Grothendieck
Note that googling

R FAQ 7.10

will get it on the first hit.

On 8/23/07, John Kane <[EMAIL PROTECTED]> wrote:
> The FAQ Section 7 is a very useful place for new users
> to find out any number of R idiosycracies.  However
> there is no numbering on the FAQ Table of Content or
> on the Sections Tables of Contents.
>
> An R-help list reply of "Read FAQ 7.10" in response to
> a question about converting a factor to numeric is  a
> bit cryptic. The only time 7.10 appears is after the
> searcher has found the entry.
>
> Would it be a good idea to actually number the entries
> for the FAQ Table of Contents and the Table of
> Contents for the Sections?
>
> __
> R-help@stat.math.ethz.ch mailing list
> https://stat.ethz.ch/mailman/listinfo/r-help
> PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
> and provide commented, minimal, self-contained, reproducible code.
>

__
R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.


[R] FAQ 7.x when 7 does not exist. Useability question

2007-08-23 Thread John Kane
The FAQ Section 7 is a very useful place for new users
to find out any number of R idiosycracies.  However
there is no numbering on the FAQ Table of Content or
on the Sections Tables of Contents. 

An R-help list reply of "Read FAQ 7.10" in response to
a question about converting a factor to numeric is  a
bit cryptic. The only time 7.10 appears is after the
searcher has found the entry. 

Would it be a good idea to actually number the entries
for the FAQ Table of Contents and the Table of
Contents for the Sections?

__
R-help@stat.math.ethz.ch mailing list
https://stat.ethz.ch/mailman/listinfo/r-help
PLEASE do read the posting guide http://www.R-project.org/posting-guide.html
and provide commented, minimal, self-contained, reproducible code.