doc:howto

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
Next revisionBoth sides next revision
doc:howto [2008/05/25 20:02] – imported doc howto into wiki philipdoc:howto [2011/07/10 22:51] – linked new rough style guide philip
Line 1: Line 1:
 ===== HOWTO contribute to the PHP Manual ===== ===== HOWTO contribute to the PHP Manual =====
 +
 +=== Introduction ===
  
 PHP is well known for having excellent documentation, documentation that is created by volunteers who collectively make changes every day. This HOWTO is designed for people who work on the official PHP documentation. See also http://www.php.net/docs for viewable and downloadable versions of the PHP manual. PHP is well known for having excellent documentation, documentation that is created by volunteers who collectively make changes every day. This HOWTO is designed for people who work on the official PHP documentation. See also http://www.php.net/docs for viewable and downloadable versions of the PHP manual.
  
-This HOWTO contains information about every aspect of the documentation process, which includes editing the DocBook XML sources, validating changes made to these sources, using the build system to generate documentation into other formats, and general tips like how to use CVS.+This HOWTO contains information about every aspect of the documentation process, which includes editing the DocBook XML sources, validating changes made to these sources, using the build system to generate documentation into other formats, and general tips like how to use SVN. 
 + 
 +Related to this HOWTO is the simple README file that lives within the [[http://svn.php.net/viewvc/phpdoc/|phpdoc SVN module]]. It's a quick guide for those already familiar with the basics of XML and SVN. 
 + 
 +=== TOC === 
 + 
 +  * [[doc/howto/gettingstarted]] - Getting started and setup to handle the docs 
 +  * [[doc/howto/communication]] - How the Documentation team communicates 
 +  * [[doc/howto/docbook]] - Information about DocBook, which is how the sources are stored 
 +  * [[doc/howto/translations]] - Translation specific information  
 +  * [[doc/howto/pecldocs]] - PECL specific information 
 +  * [[doc/howto/faq]] - Frequently asked questions 
 +  * [[doc/howto/structure]] - Structure of the docs 
 +  * [[doc/howto/skeletons]] - Doc XML skeletons 
 +  * [[doc/howto/styleguide]] - Style Guide 
 +  * [[doc/howto/editing]] - Editing, validating and building the docs 
 + 
 +=== Feedback ===
  
-Related to this HOWTO is the simple README file that lives within the phpdoc CVS moduleIt's a quick guide for those already familiar with the basics of XML and CVS.+Feedback is most certainly welcome on this documentWithout your submissions and input, this document wouldn't exist. Please send your additions, comments and criticisms to the following email address: <phpdoc@lists.php.net>.
doc/howto.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1