[TYPO3-dev] Extension Documentation in DocBook?

Troels Kjær Rasmussen troelsr at msn.com
Thu Jun 1 10:04:01 CEST 2006


The Joomla-people have this: 
http://forge.joomla.org/sf/sfmain/do/viewProject/projects.docbook_collab

...I envy them a bit...

-- 

Med venlig hilsen / Best regards

Troels Kjær Rasmussen
LinkFactory | + 45 70 22 23 22
troels at linkfactory.dk

TYPO3 Open Source CMS - Enterprise CMS uden licensomkostninger, læs mere på 
www.linkfactory.dk
"Jacob Floyd" <techgurufloyd+typo3dev at gmail.com> wrote in message 
news:mailman.4451.1149137203.22948.typo3-dev at lists.netfielders.de...
>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