doc:articles:phd_ide

Differences

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

Link to this comparison view

Next revision		Previous revision
doc:articles:phd_ide [2011/06/26 03:53] – begun the process of writing a phd_ide article philipdoc:articles:phd_ide [2017/09/22 13:28] (current) – external edit 127.0.0.1
Line 1: Line 1:
-How to build your own PHP Manual format+===== How to build your own PHP Manual format =====
  
 ==== Requirements ==== ==== Requirements ====
Line 8: Line 8:
 ==== Step #1 : Download the PHP Manual DocBook sources ==== ==== Step #1 : Download the PHP Manual DocBook sources ====
  
-The following commands will checkout the PHP Manual DocBook sources from SVN. +{{page>doc:articles:localdocsetup#checkout_the_php_documentation_from_svn&nofooter&noeditbtn}}
- +
-=== Option A -- Automated == +
- +
-=== Option B -- Typical == +
  
 ==== Step #2 : Install PhD ==== ==== Step #2 : Install PhD ====
  
-=== Option A -- Automated ==+{{page>doc:articles:localdocsetup#install_phd&nofooter&noeditbtn}}
  
-=== Option B -- Automated == +==== Step #3 : Install PhD_IDE ==== 
- +<code bash> 
- + $ pear install phpdocs/PhD_IDE-beta 
-==== Step #3 : Use PhD to generate the appropriate files ====+</code> 
 +==== Step #4 : Use PhD to generate the appropriate files ====
  
 The following commands will build the files used by PhD_IDE: The following commands will build the files used by PhD_IDE:
Line 28: Line 24:
  $ cd /path/to/your/php/doc/checkout  $ cd /path/to/your/php/doc/checkout
  $ php doc-base/configure.php  $ php doc-base/configure.php
- $ phd --docbook doc-base/.manual.xml --package ide --format xml --format funclist+ $ phd --docbook doc-base/.manual.xml --package IDE --format xml --format funclist
 </code> </code>
 You now have the following file structure: You now have the following file structure:
 <code bash> <code bash>
- /path/to/your/php/doc/checkout/doc-base/output/ + /path/to/your/php/doc/checkout/doc-base/output/index.sqlite 
- /path/to/your/php/doc/checkout/doc-base/output/+ /path/to/your/php/doc/checkout/doc-base/output/ide-xml/ 
 + /path/to/your/php/doc/checkout/doc-base/output/ide-funclist.txt
 </code> </code>
 Tip: The --output PhD option changes the output directory. Tip: The --output PhD option changes the output directory.
  
-==== Step #4 : Build your own structure ====+==== Step #5 : Build your own structure ==== 
 + 
 +=== Json ===
  
 The following commands use an example script called 'gen-ide.php', and this script requires you to edit its configuration. Namely, the path to your PhD and PHP Documentation checkouts. Edit this script to fit your needs. The following describes default usage: The following commands use an example script called 'gen-ide.php', and this script requires you to edit its configuration. Namely, the path to your PhD and PHP Documentation checkouts. Edit this script to fit your needs. The following describes default usage:
 <code bash> <code bash>
- $ cp /path/to/your/php/doc/checkout/doc-base/scripts/gen-ide.php /tmp/test-ide.php+ $ cp /path/to/your/php/doc/checkout/doc-base/scripts/gen-ide-json.php /tmp/test-ide.php
  $ cd /tmp  $ cd /tmp
  $ vim test-ide.php  $ vim test-ide.php
  $ ./test-ide.php  $ ./test-ide.php
  $ open php_manual.json  $ open php_manual.json
 +</code>
 +
 +=== SQLite 3 ===
 +<code bash>
 + $ phd --docbook path/to/.manual.xml --package IDE --format sqlite
 </code> </code>
 ==== Conclusion ==== ==== Conclusion ====
  
 The PhD_IDE PhD package allows customizing the output of the PHP Manual. It takes DocBook XML and converts it to a PHP object containing all (most) of the functions documentation. The main purpose is to allow IDE's to build syntax files for code insight and PHP documentation, but its usage is flexible. The PhD_IDE PhD package allows customizing the output of the PHP Manual. It takes DocBook XML and converts it to a PHP object containing all (most) of the functions documentation. The main purpose is to allow IDE's to build syntax files for code insight and PHP documentation, but its usage is flexible.
doc/articles/phd_ide.1309060428.txt.gz · Last modified: 2017/09/22 13:28 (external edit)

Page Tools