Re: /doc layout in ftp.debian.org [was: Documentation provided in the Woody CDs (should be fixed)]

[barbier@linuxfr.org (Denis Barbier)]

On Tue, May 07, 2002 at 09:29:30PM +0200, Josip Rodin wrote:
> On Fri, May 03, 2002 at 02:34:17PM +0200, Javier Fernández-Sanguino Pe?a wrote:
> > 	?Have you had time to take a look at auric.debian.org/home/jfs/doc ?
> 
> We have in the meantime discussed a little bit on IRC about this, and Javi
> made some adjustments. It's generally an improvement over the current layout
> (or rather, the current patchwork).
> 
> http://auric.debian.org/~jfs/ BTW.
> 
> We agreed that there is one thing missing -- proper indices. Apache's
> DirectoryIndex feature only goes so far in user-friendliness :)
> He started making a script to autogenerate indices.
> 
> Javier and myself disagreed on two points of the layout:
> 
>   * he put the language choice before the exact document choice.
>     I.e. once you pick a section, you get to pick the language, and then
>     the specific document. I think you should get to pick the section,
>     the document and then the language.

Why should we restrict to only one naming convention?
We could use a pool-like scheme:
    doc/section1/document1/document1.en.html
    doc/section1/document1/document1.en.txt.gz
    doc/section1/document1/document1.xx.html
    doc/section1/document1/document1.xx.txt.gz
    doc/section1/document2/document2.xx.html
    etc.
and use symbolic links to match whatever hierarchy we want, e.g.
    en-html/section1/document1/document1.en.html
    en-html/section1/document2/document2.en.html
    ...
    en-txt/section1/document1/document1.en.txt.gz
    en-txt/section1/document2/document2.en.txt.gz
    ...
    xx-html/section1/document1/document1.xx.html
    xx-html/section1/document2/document2.xx.html
    ...
    xx-txt/section1/document1/document1.xx.txt.gz
    xx-txt/section1/document2/document2.xx.txt.gz
    ...

When a document is not translated into xx, we could also include a link
to show that this document does exist, even if it is not available in
this language:
    xx-txt/section1/document3.en/document3.en.txt.gz

I assume that all docs are generated in all available formats, whereas
this is obviously wrong with languages.

>   * he chose foo-twoletterlanguagecode.filetypeextension
>     I would prefer foo.twoletterlanguagecode.filetypeextension

Agreed, I also prefer dots for the same reason.

Denis


-- 
To UNSUBSCRIBE, email to debian-doc-request@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org