R-alpha: old Rdoc 2 new Rdoc

Peter Dalgaard BSA p.dalgaard@kubism.ku.dk
01 Sep 1997 17:28:08 +0200


Friedrich Leisch <Friedrich.Leisch@ci.tuwien.ac.at> writes:

> Attached is a conversion script for converting current R doc files to
> the proposed new format ... I'm not sure if it handles everything

Speaking of the docs, we really need to make sure that our HTML pages
pass weblint or similar checkers. I just tried it and found several
pieces of strangeness. Basically, what you get out is stuff like

$ weblint /home/sfe/pd/R/html/funs/density.html
/home/sfe/pd/R/html/funs/density.html(1): <HEAD> must immediately follow <HTML>
/home/sfe/pd/R/html/funs/density.html(1): outer tags should be <HTML> .. </HTML>.
/home/sfe/pd/R/html/funs/density.html(2): empty container element <A>.
/home/sfe/pd/R/html/funs/density.html(90): illegal context for <TR> - must appear in <TABLE> element.
/home/sfe/pd/R/html/funs/density.html(93): illegal context for <TR> - must appear in <TABLE> element.
/home/sfe/pd/R/html/funs/density.html(96): illegal context for <TR> - must appear in <TABLE> element.
/home/sfe/pd/R/html/funs/density.html(99): illegal context for <TR> - must appear in <TABLE> element.
/home/sfe/pd/R/html/funs/density.html(102): illegal context for <TR> - must appear in <TABLE> element.
/home/sfe/pd/R/html/funs/density.html(126): <XMP> is obsolete.
/home/sfe/pd/R/html/funs/density.html(133): unknown element <->.
/home/sfe/pd/R/html/funs/density.html(134): no closing </XMP> seen for <XMP> on line 126.

Here's what I found of obvious pieces of "fluff":

The whole page needs to be inside <HTML>..</HTML>
"<" symbols make trouble, even within <PRE> (use "&lt;")
<XMP> should not be used ("use <PRE>" seems to be the idea)
<TR>'s need to be surrounded by a <TABLE> environment

"<" within <PRE> gets formatted correctly by Netscape, but not by
lynx, so it isn't all just formalities.
-- 
   O__  ---- Peter Dalgaard             Blegdamsvej 3  
  c/ /'_ --- Dept. of Biostatistics     2200 Cph. N   
 (*) \(*) -- University of Copenhagen   Denmark      Ph: (+45) 35327918
~~~~~~~~~~ - (p.dalgaard@biostat.ku.dk)             FAX: (+45) 35327907
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
r-devel mailing list -- Read http://www.ci.tuwien.ac.at/~hornik/R/R-FAQ.html
Send "info", "help", or "[un]subscribe"
(in the "body", not the subject !)  To: r-devel-request@stat.math.ethz.ch
=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-