Re: Policy Weekly Issue #4/10: Filesystem location of non-english documentation files
Hi,
>>"Andreas" == Andreas Jellinghaus <aj@dungeon.inka.de> writes:
>> Some people suggested to have an extra directory level for the
>> documentation file format (e.g. 'HTML/'). I suggest to postpone the
>> discussion about this sub-topic until we discuss the `documentation
>> policy'. (Until then, maintainers can decide whether they want to
>> use an extra directory, or not.)
Andreas> i suggest to add a directory HTML/ for html documentation,
Andreas> and but not subdirectories for other formats. rationale :
Andreas> html documents often consist of several files easy way for
Andreas> scripts to build an index of documentation.
Andreas> a package should either have a index.html file or symlink in
Andreas> that directory.
A nit: only one package can have an index.html file in the
HTML directory. For this to work, you'll have to create a
subdirectory for each package anyway, and create a master index.html
file in the top level.
You can get the same effect by letting all HTML docs remain in
/usr/doc/<package> and constructing your master index.html file to
point to things.
The current http://localhost/usr/doc/ page (as per the web
standard) already does this: if the package provides a suitable
/usr/doc/<package>/index.html file, you can use the URL above to
browse all HTML documentation.
This already works.
I see no reason to change this.
manoj
--
"...The Universe is thronged with fire and light, And we but smaller
suns, which, skinned, trapped and kept Enshrined in blood and
precious bones, hold back the night." Ray Bradbury
Manoj Srivastava <srivasta@acm.org> <http://www.datasync.com/%7Esrivasta/>
Key C7261095 fingerprint = CB D9 F4 12 68 07 E4 05 CC 2D 27 12 1D F5 E8 6E
Reply to: