From ripley at stats.ox.ac.uk  Fri Jan 28 08:46:22 2011
From: ripley at stats.ox.ac.uk (Prof Brian Ripley)
Date: Fri, 28 Jan 2011 07:46:22 +0000 (GMT)
Subject: [Rd] generating HTML help pages
In-Reply-To: <ad4dfacdb33eb9107f09750cf5a4ca8b@mbox.erasmusmc.nl>
References: <ad4dfacdb33eb9107f09750cf5a4ca8b@mbox.erasmusmc.nl>
Message-ID: <alpine.LFD.2.02.1101280741190.28640@gannet.stats.ox.ac.uk>

Installing your package with 'R CMD INSTALL --html' gives you an 
'html' directory with an index and all the static HTML help files.
(That is in the R-admin manual, under 'Help options'.)

For a single page, you will need to write your own code -- but since R 
is Open Source you have lots of examples to go from.

On Fri, 28 Jan 2011, 016750 wrote:

> Dear All,
>
> I need to convert all Rd help pages for my package to HTML format in order to 
> serve these on our web-server. Ideally, I would like to do that as "all docs 
> in single page" and also index page + one html page per Rd file.
>
> Looking through documentation the only clues I could find were
>
> * R CMD Rdconv --type=html FILE, which does not produce cross-links, does not 
> process multiple files, and does not produce index file
>
> and
>
> * 
> tools::Rd2HTML("pathtopackage/file.Rd",Links=findHTMLlinks("pathtopackage")); 
> this will do a better job by producing cross-links, but again, no multiple 
> files processing, and no index
>
> This is not a big deal to make a loop over all files in my "man", and I can 
> copy "00Index.html" from library/package/html after install, but I wonder if 
> there is a more straightforward way to achieve my aim? Also, any suggestions 
> as for generating a single HTML with all help pages of a package?
>
> with best regards, and sorry if I am off-topic,
> Yurii
>
> ______________________________________________
> R-devel at r-project.org mailing list
> https://stat.ethz.ch/mailman/listinfo/r-devel
>

-- 
Brian D. Ripley,                  ripley at stats.ox.ac.uk
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, UK                Fax:  +44 1865 272595



[Rd] generating HTML help pages
Prof Brian Ripley