Re: package description

About this list Date view Thread view Subject view Author view Other groups

Subject: Re: package description
From: Paul Gilbert (pgilbert@bank-banque-canada.ca)
Date: Wed 03 Nov 1999 - 01:25:33 EST


Message-ID: <381F026D.685C82B6@bank-banque-canada.ca>

>we can put the contents of the DESCRIPTION file on top of 00Index.html
>and cat both DESCRIPTION and 00Index for library(help=foo). Would this
>do what you want?

I'm thinking of a description which would be several paragraphs, so I would
rather link to it from 00Index than place all the text in 00Index above the
links to the individual help for functions. I thought DESCRIPTION was suppose
to be a fairly short standard form with some things like version, requires,
author, licence, ..., and perhaps it would be better not to clutter it with the
kind of description I'm thinking about.

I've been playing a bit by putting my description in a file
00General_Description.Rd, which usually puts it at the top since that is fairly
high on the collating sequence. I think it would be better if there was a
standard name that is guaranteed to get a link at the top of 00Index.html. Also,
it would be nice to have a system which would work with help formats other than
html.

Paul Gilbert

-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-.-
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
_._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._._


About this list Date view Thread view Subject view Author view Other groups

This archive was generated by hypermail 2b25 : Tue 04 Jan 2000 - 14:16:09 EST