[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: RFC: Changing of /doc/manuals/ implementation



Hi,

First reference should be 

  http://www.debian.org/doc/docpolicy

Which we including myself did not follow.

On Mon, Sep 09, 2002 at 05:26:30PM +0200, Martin Schulze wrote:
> Rob Bradford wrote:
> > I'm proposing a new hierarchy for the /doc/manuals/ tree.
> 
> I'd like to object, if I may...
> 
> > My suggestion for the hierarchy is as follows:
> > 
> > /doc/manuals/<lang>/<manual-name>/<format>/
> 
> Hmm, I just noticed something odd:
> 
> HTML	/doc/manuals/<manual-name>/
> other	/doc/manuals/<lang>/<manual-name>.<format>.<suffix>

You mean <format-suffix> instead of <format>.<suffix>
(Only info will create suffix after <format> and not useful on web.)

> I wonder why this isn't implemented like:
> 
> HTML	/doc/manuals/<manual-name>/
> other	/doc/manuals/<manual-name>/<manual-name>.<lang><format>.<suffix>

Again you mean:

HTML	/doc/manuals/<manual-name>/*.<web-lang>.html
other	/doc/manuals/<manual-name>/<manual-name>.<lang-format>.<format-suffix>

That was 3 month ago with my documents.  No body complained because no
one was aware of existence of PS/PDF files :-(  Browser can nor see it.

> This would have the benefit of still relatively short links, preserve
> content negotiation, and has a relatively logical placement for other
> format files as well.

Yep but if browser can not find it, it is bad.

> Getting rid of the /manuals/ component would be nice from a users
> point of view, but is probably a little bit more difficult from
> an implementators point of view.  However, isn't the computer and
> the system meant to support humans instead of vice versa?

Well, /doc/manuals/<manual-name>/*.<web-lang>.html are for CVS generated
documents but /doc/<manual-name>/*.<web-lang>.html are used for
"released version of documents.  Developer manual, for example.

In short, this is difficult problem and we need clean solution.

-- 
~\^o^/~~~ ~\^.^/~~~ ~\^*^/~~~ ~\^_^/~~~ ~\^+^/~~~ ~\^:^/~~~ ~\^v^/~~~ +++++
        Osamu Aoki @ Cupertino CA USA, GPG-key: A8061F32
 .''`.  Debian Reference: post-installation user's guide for non-developers
 : :' : http://www.debian.org/doc/manuals/reference/ also http://qref.sf.net
 `. `'  "Our Priorities are Our Users and Free Software" --- Social Contract



Reply to: