Re: R-alpha: suggestion for the R help system

Thomas Lumley (thomas@biostat.washington.edu)
Wed, 13 Nov 1996 09:18:05 -0800 (PST)


Date: Wed, 13 Nov 1996 09:18:05 -0800 (PST)
From: Thomas Lumley <thomas@biostat.washington.edu>
To: r-testers@stat.math.ethz.ch
Subject: Re: R-alpha: suggestion for the R help system
In-Reply-To: <199611131059.LAA12930@aragorn.ci.tuwien.ac.at>

On Wed, 13 Nov 1996, Kurt Hornik wrote:

> * Have a trivial shell script which `builds' the real index by doing
> 
> 	cat AnIndex.* | uniq | sort > AnIndex
> 
> in the R help directory.

We also need to build the html index and help files.  I have a non-trivial
script that converts S help to R help source files, allowing HTML
conversion except that hyperlinking still doesn't work (I posted it some 
time ago). The survival and gee packages both use this to create help files.

Also, R comes with scripts to build complete indexes (html.index, 
help.index). It may be best to distribute R help source files, convert 
them to help and html and then run the index commands. 

If you also copy the help source files to the appropriate place in mansrc/
the help system will also be properly rebuilt when R is remade (a 
relatively frequent occurence in some places).

thomas lumley




=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
r-testers mailing list -- To (un)subscribe, send
subscribe	or	unsubscribe
(in the "body", not the subject !)  To: r-testers-request@stat.math.ethz.ch
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-