[TYPO3-dev] Extension Documentation in DocBook?

[Peter Niederlag]

Hi,

Jacob Floyd schrieb:
> I think I read somewhere that the recommended format for extension
> documentation is:
> DocBook Format
> in separate extension
> 'your_extension_key_doc'
> 
> Is this true?

I hear this for the first time.

> If so, what kind of file structure would this *_doc extension have?
> Should the DocBook document still be located in the subdirectory doc/
> or somewhere else?
> 
> Where is the documentation that says DocBook is preferred? I know I
> read it somewhere, but I am at a loss as to where.

afaik DocBook is used already as an internal intermediate step in
converting to .pdf so it could(!) be possible to maintain Documentation
in DocBook in the future.

> Is there an example of extension documentation in DocBook that I can
> use as a template to write my documentation?
> 
> What's *your* favorite DocBook editor?  (As I haven't done much with
> the format other than note that a file says it's docbook. :-P )

OxygenXML, XMLMind, both not OpenSource. .-<

Greets,
Peter
-- 
Peter Niederlag
http://www.niekom.de * TYPO3 & EDV Dienstleistungen *
http://www.typo3partner.net * professional services network *