[TYPO3-dev] Extension Documentation in DocBook?

Jacob Floyd techgurufloyd+typo3dev at gmail.com
Thu Jun 1 06:46:37 CEST 2006


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?
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.

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 )

Why am I interested? - Because I want to document the extension I'm
developing as I go without dealing with changing the file format
somewhere along the line (what a pain).
What am I developing? - The 'RealFileE Framework' to begin with... :D
(more details later, after I have something more substantial.)

Thanks!
Jacob Floyd




More information about the TYPO3-dev mailing list