doc:howto

This is an old revision of the document!


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.

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.

Related to this HOWTO is the simple README file that lives within the phpdoc CVS module. It's a quick guide for those already familiar with the basics of XML and CVS.

TOC

  • gettingstarted - Getting started and setup to handle the docs
  • docbook - Information about DocBook, which is how the sources are stored
  • translations - Translation specific information
  • pecldocs - PECL specific information
  • faq - Frequently asked questions
  • structure - Structure of the docs

Feedback

Feedback is most certainly welcome on this document. Without 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.1252458578.txt.gz · Last modified: 2017/09/22 13:28 (external edit)