Re: basic questions

From: Date: Fri, 02 Feb 2001 14:28:50 +0000
Subject: Re: basic questions
References: 1  Groups: php.doc 
Request: Send a blank email to phpdoc+get-969334113@lists.php.net to get a copy of this message
Sergey Kartashoff wrote: > > Hi! > > I am novice in writing documentation for php. > So i decided to write here my questions. > > Currently i writing new php extension. > It is already working and uploaded into php cvs tree. > > Now i should create documentation about this module, its > installation requirements, abount function it exports, and so on. > > Could anyone explain me step-by-step how i should do this ? > What tools do i need ? What files i should update... > > Thank you very much for your help ! > > -- > Regards, Sergey aka gluke. i guess you used ext_skel to create the base for your extension? if you did so and have generated function stubs using the prototype file mechanism you can use ext_skel to generate an XML-template for your extension to generate the docs you need a working 'jade' installation and DocBook modular stylesheets theese should be part of recent linux distributions (i know for sure that SuSE provides what is needed), for windows there were detailed instructions posted on this list today or yesterday as soon as you have succeded in building the manual from scratch you can copy your new XML file into phpdoc/en/functions, add a '&functions.filename;' into manual.xml.in at the approproate palce amongst the other '&functions...' entries, rerun configure and make this should accept the file generated by ext_skel without problems the next step is then to add 'flesh' to your XML doc file -- Hartmut Holzgraefe hartmut@six.de http://www.six.de +49-711-99091-77 Besuchen Sie uns auf der CeBIT 2001 - in Halle 6 Stand F62/4

« previous php.doc (#969334113) next »