[TYPO3-doc] Migration of doc_template completed (for extension developers)

Xavier Perseguers xavier at typo3.org
Wed May 30 17:50:31 CEST 2012


Hi François,

> I don't have the time to follow this discussion properly for now. What I
> would just like to express is that I would really like all repositories
> to have the same structure (as far as documentation is concerned),
> whether they are TYPO3 extensions, FLOW3 packages or straight Git
> repositories of various manuals.

Sure!

> The base we agreed on was that there would be a "Documentation" folder
> where the reST files reside. What is missing? Extra folders on the same
> level? Sub-folders inside "Documentation"? Can we still achieve to have
> a common structure for all the elements mentioned above?

To make it clear, my idea would be to have

Documentation
`-- source
    |-- Index.rst
    `-- all-that-stuff

instead of

Documentation
|-- Index.rst
`-- all-that-stuff

The idea behind is to allow clean translation if needed with (in Git repo):

Documentation
|-- source
|   |-- Index.rst
|   `-- all-that-stuff
`-- locale
    `-- source
        |-- fr
        |   `-- .po files
        `-- de
            `-- .po files

That's all! and for the explanation on why I suggest this "weird"
structure within "locale", see my previous mails to see how compiled
files will populate the blanks.

But again, this is just my suggestion as best practice.

-- 
Xavier Perseguers
Release Manager TYPO3 4.6

TYPO3 .... inspiring people to share!
Get involved: http://typo3.org



More information about the TYPO3-project-documentation mailing list