doc:scratchpad: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:scratchpad:howto [2008/10/21 08:23] – initial commit for review, most content stolen from http://marc.info/?l=phpdoc&m=122453079823213 philipdoc:scratchpad:howto [2009/08/04 11:32] – Fix CVS mentions mrook
Line 1: Line 1:
 ===== Quick guide for improving the existing PHP documentation ===== ===== Quick guide for improving the existing PHP documentation =====
- +==== Getting setup ====
-=== Getting setup ===+
  
 What you need is: What you need is:
-  * Source files of the PHP Manual, which is stored in a CVS module named 'phpdoc' (HOWTO Here) 
-  * The build system, and it's named PhD ([[doc:phd|HOWTO Here]]) 
-  * A text editor (any will do) 
-  * Knowledge of the [[http://doc.php.net/php/dochowto/chapter-conventions.php|coding standards]]:  
  
-Before you get started documenting you should make sure the tool chain and your checkout is okay. To do so, consider the following scenario:+== Source files of the PHP Manual == 
 +They are stored in a SVN module named 'phpdoc'. See also the [[http://www.php.net/svn.php|generic generic php.net SVN instructions]]. And these examples use the svn command but other methods exist, like [[http://www.tortoisesvn.net/|TortoiseSVN]] for Windows users.
 <code> <code>
-  $ phd -V (check to see if phd is installed, and in the path) +$ svn checkout http://svn.php.net/repository/phpdoc
-  $ cd phpdoc (make the manual sources your current directory) +
-  $ php configure.php -V (check to see if this works) +
-  $ php configure.php (This will create a huge .manual.xml file which PhD uses to render the docs) +
-  $ phd -d .manual.xml -f xhtml -t chunkedhtml (Creates an html/ folder few thousand files)+
 </code> </code>
  
-Poke around the **html/** directory and open up some of the files in you favorite browser to see if everything is fine.+== Using TortoiseSVN on Windows to do a checkout == 
 +  * First off, download and install TortoiseSVN from its website: [[http://tortoisesvn.net/]] 
 +  * Open a new explorer window and go to the folder you wish to do a checkout in 
 +  * Right click anywhere in the blank area to spawn the context menu, select "SVN Checkout..." 
 +  * A new window will popup asking for details about the checkout, these values will be remembered, so you will not need to enter them again 
 +  * Enter the following URL: "http://svn.php.net/repository/phpdoc", then OK to begin the checkout. If you're prompted to enter a password while checking out, then type in "phpfi" and OK 
 +  * When the checkout is complete, then it should have created a directory called "phpdoc" where the php documentation source tree will be
  
-=== Knowing the structure ===+ 
 + 
 + 
 +== The build system == 
 +This renders the DocBook XML into other formats, like the HTML you see at php.net. It's named [[doc:phd|PhD]] (See: [[doc:phd:install|PhD install guide]]) 
 + 
 +<code> 
 +$ pear channel-discover doc.php.net 
 +$ pear install doc.php.net/phd-beta 
 +</code> 
 + 
 +== A text editor == 
 +Any will do 
 + 
 +== Knowledge == 
 +  * PHP 
 +  * The [[http://doc.php.net/php/dochowto/chapter-conventions.php|coding standards]]:  
 + 
 +== Everything working == 
 +Before you get started documenting, make sure the tool chain and checkout are okay. To do so, consider the following scenario: 
 +<code> 
 +$ phd -V (check to see if phd is installed, and in the path) 
 +$ cd phpdoc (make the manual sources your current directory) 
 +$ php configure.php -V (check to see if this works) 
 +$ php configure.php (This will create a huge .manual.xml file which PhD uses to render the docs) 
 +$ phd -d .manual.xml -f xhtml -t chunkedhtml (Creates an html/ folder with a few thousand files) 
 +</code> 
 + 
 +Poke around the **html/** directory and open up some of the files in you favorite browser to see if everything is fine. 
 +==== Knowing the structure ====
  
 The documentation for extensions is located in: The documentation for extensions is located in:
  
-  /phpdoc/en/reference/extension_name/+  /phpdoc/en/trunk/reference/extension_name/
  
 For example, the SVN extension documentation exists in: For example, the SVN extension documentation exists in:
    
-  /phpdoc/en/reference/svn/+  /phpdoc/en/trunk/reference/svn/
  
 There you'll find several files: There you'll find several files:
  
-  * //book.xml// (Acts as the container for the extension and contains the preface)+  * //book.xml// (Acts as the container for the extension and contains the preface. Other files (like //examples.xml// are included from here)
   * //setup.xml// (Includes setup, install and configuration documentaiton)   * //setup.xml// (Includes setup, install and configuration documentaiton)
   * //constants.xml// (Lists all constants the extension declares, if any)   * //constants.xml// (Lists all constants the extension declares, if any)
   * //configure.xml// (Usually this information is in setup.xml, but if the file exists it is magically included into setup.xml)   * //configure.xml// (Usually this information is in setup.xml, but if the file exists it is magically included into setup.xml)
 +  * //examples.xml// (Various examples)
 +  * //foo.xml// (Example, foo can be anything specific to a topic. Just be sure to include via //book.xml//)
  
-For procedural extension (like SVN) you also have:+A procedural extension (like SVN) also has:
  
   * //reference.xml// (container for the functions, rarely contains any info)   * //reference.xml// (container for the functions, rarely contains any info)
   * //functions///    (folder with one XML file per function that the extension declares)   * //functions///    (folder with one XML file per function that the extension declares)
  
-For OO extensions (such as imagick) you have:+And OO extensions (such as imagick) contain:
  
   * //classname//.xml (container for the methods defined by the class, contains also basic info about it)   * //classname//.xml (container for the methods defined by the class, contains also basic info about it)
Line 49: Line 78:
   * Note: "//classname//" is the lowercased name of the class, not a literal file or directory name.   * Note: "//classname//" is the lowercased name of the class, not a literal file or directory name.
  
-=== Adding new documentation ===+==== Editing existing documentation ==== 
 +Simply open the files and edit them. Remember to follow the "coding standard" described in the documentation howto. And after it validates, commit. 
 +<code> 
 +$ vim phpdoc/en/trunk/reference/strings/strlen.xml 
 +$ php configure.php 
 +$ svn commit -m "Added SeeAlso strpos()" phpdoc/en/trunk/reference/strings/strlen.xml 
 +</code> 
 + 
 +==== Adding new documentation ==== 
 + 
 +When adding new functions or methods, there are a couple of options. Either way, the generated (or copied) files will need to be filled out.
  
-When adding new functions or methods you start by copying the skeleton files into the correct location:+== Option A: Copy skeleton files == 
 +This involves copying the skeleton files into the correct location:
  
 <code> <code>
Line 62: Line 102:
   * Note: "functionname" is the lowercased name of the function name, not a literal file name.   * Note: "functionname" is the lowercased name of the function name, not a literal file name.
  
-Then you fill out the new file (from the skeleton) with as much detail as possible.+== Option B: Generating files using docgen == 
 +The docgen script is found within the php documentation (phpdoc/scripts/docgen/) and uses Reflection to generate documentation (DocBook) files. See the [[doc:scratchpad:pecldocs|PECL Docs]] section for details.
  
-To make changes to existing documentation just open the files and edit them. Remember to follow the "coding standard" described in the documentation howto. +==== Testing the changes ====
- +
-After that its time to test it. +
- +
-=== Testing the changes ===+
  
 Methods and functions are automagically included into the hierarchy so you don't have to "configure" anything, just run "//php configure.php//" to build the .manual.xml and validate the changes. If no error occur it means you changes validated. Methods and functions are automagically included into the hierarchy so you don't have to "configure" anything, just run "//php configure.php//" to build the .manual.xml and validate the changes. If no error occur it means you changes validated.
  
-Now its time to check the rendering:+<code> 
 +$ cd phpdoc 
 +$ php configure.php 
 +</code> 
 + 
 +When the above outputs something like "All good. Saving .manual.xml... done." then you know it validates. Now its time to optionally check the rendering:
  
 <code> <code>
-  $ phd -d .manual.xml -f xhtml -t chunkedhtml+$ phd -d .manual.xml -f xhtml -t chunkedhtml
 </code> </code>
  
Line 81: Line 123:
  
 If everything is looking good, its time to post the changes. If everything is looking good, its time to post the changes.
- +==== Committing the changes ====
-=== Committing the changes ===+
  
 == Creating patches == == Creating patches ==
Line 89: Line 130:
  
 <code> <code>
-  $ cvs diff -u > changes.patch+  $ svn diff > changes.patch
 </code> </code>
  
-If you added new files you will have to create an archive of the new files you added (tar -cf changes.tar file1.xml file2.xml file3.xml).+If you added new files you will have to create an archive of the new files you added (tar -cf changes.tar file1.xml file2.xml file3.xml). On Windows you may use an external utility to create an archive such as [[http://www.rarsoft.com/|WinRAR]].
  
 Then upload the archive (or patch file) to http somewhere and post the link to phpdoc@lists.php.net including a short summary of what you did. Then upload the archive (or patch file) to http somewhere and post the link to phpdoc@lists.php.net including a short summary of what you did.
Line 100: Line 141:
 == Committing patches == == Committing patches ==
  
-If you have CVS karma then there is no need to create patches... just commit!  +If you have SVN karma then there is no need to create patches... just commit! 
- +
doc/scratchpad/howto.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1

Page Tools