Re: What's down, doc? Standartize - standartize ...

[Stefan Kost <ensonic hora-obscura de>]

Hi,


Shaun McCance wrote:
<snip>
> > 1. We have po* subdirectories to hold the translations. We should expect 
> > the help to always be in help*
>
>
> I agree.  In fact, I generally push for a two-directory layout,
> like so:
>
> /sound-juicer/help/sound-juicer/C/sound-juicer.xml
>
> Note the extra sound-juicer directory.  This allows you to add
> new documents without having to move stuff around in your source
> tree.  When we switch to subversion after 2.14, we'll be better
> able to change directory names.
I use a structure lib this in my project:
foo/
  docs/
    reference
      libfoo
      foo
    help
      foo
      faq
  src
    ...

This is inspired from other projects. As moving directories around is not fun in 
CVS, stuff like that is not easy to change :(

> A longer-term goal is to get developer documentation also using
> xml2po for translations.  Developer docs have traditionally been
> put under the "doc" or "docs" subdirectory.  I think using help
> for user help and docs for developer docs is perfectly fine.

Ciao
  Stefan