doc:articles:localdocsetup

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:articles:localdocsetup [2011/06/04 22:24] – initial _rough_ (seriously) draft philipdoc:articles:localdocsetup [2011/06/14 05:55] – [Use PhD to build the documentation] typo philip
Line 8: Line 8:
   * A basic level of shell/terminal usage, or know that shell commands follow a **$** below   * A basic level of shell/terminal usage, or know that shell commands follow a **$** below
   * A desire to build and display the documentation locally   * A desire to build and display the documentation locally
-  * Your PHP Documentation path will be: **/tmp/svn/doc-en** +  * Your PHP Documentation path will be: **/tmp/svn/doc-en** (change this no doubt) 
-  * Your local mirror path will be: **/home/sites/myphpnet/** +  * Your local mirror path will be: **/home/sites/myphpnet/** (change this no doubt) 
-  * Your local hostname will be: **http://mydocs.site/**+  * Your local hostname will be: **http://mydocs.site/** (change this no doubt)
   * You are using Linux or a Mac (@todo Make this guide Windows friendly)   * You are using Linux or a Mac (@todo Make this guide Windows friendly)
  
-If you're interested in simply setting up a local PHP mirror (and NOT build the documentation) then simply follow the php.net mirroring guidelines and ignore this document.+If you're interested in simply setting up a local PHP mirror (and NOT build the documentation) then simply follow the [[http://php.net/mirroring|php.net mirroring guidelines]] and ignore this document.
  
 ===== Checkout the php documentation from SVN ===== ===== Checkout the php documentation from SVN =====
Line 23: Line 23:
  $ mkdir /tmp/svn  $ mkdir /tmp/svn
  $ cd /tmp/svn  $ cd /tmp/svn
- $ svn co http://svn.php.net/repository/phpdoc/modules/doc-en doc-en+ $ svn co https://svn.php.net/repository/phpdoc/modules/doc-en doc-en
  $ cd /tmp/svn/doc-en  $ cd /tmp/svn/doc-en
 </code> </code>
Line 29: Line 29:
 <code shell> <code shell>
  $ cd /tmp  $ cd /tmp
- $ wget http://svn.php.net/repository/phpdoc/doc-base/trunk/scripts/create-phpdoc-setup.php+ $ wget https://svn.php.net/repository/phpdoc/doc-base/trunk/scripts/create-phpdoc-setup.php
  $ php create-phpdoc-setup.php -h  $ php create-phpdoc-setup.php -h
  $ php create-phpdoc-setup.php -b /tmp/svn -l en  $ php create-phpdoc-setup.php -b /tmp/svn -l en
Line 67: Line 67:
  Note: This builds the php.net version of the documentation, but does not contain the files and includes used to run php.net. In other words, files like the php.net headers and footers are not built by PhD and are instead stored in a separate SVN module (web/php).  Note: This builds the php.net version of the documentation, but does not contain the files and includes used to run php.net. In other words, files like the php.net headers and footers are not built by PhD and are instead stored in a separate SVN module (web/php).
  
- Alternative: The XHTML format is an alternative approach to the PHP format, and displays manual pages as plain HTML files. To run that:+ Alternative: The XHTML format is simple and does not require mirroring the php.net website. The following builds manual pages as plain HTML files:
 <code shell> <code shell>
 +   $ cd /tmp/svn/doc-en
    $ phd --docbook /tmp/svn/doc-en/doc-base/.manual.xml --package PHP --format xhtml --output mydocs    $ phd --docbook /tmp/svn/doc-en/doc-base/.manual.xml --package PHP --format xhtml --output mydocs
    $ cd /tmp/svn/doc-en/mydocs/php-chunked-xhtml/    $ cd /tmp/svn/doc-en/mydocs/php-chunked-xhtml/
-   $ open strlen.html +   $ open function.strlen.html 
 </code> </code>
 ===== Setup a local php.net mirror ===== ===== Setup a local php.net mirror =====
Line 139: Line 140:
 ===== View the new site ===== ===== View the new site =====
  
-  * http://mydocs.site/manual/en/+  * http://myphp.site/manual/en/
  
doc/articles/localdocsetup.txt · Last modified: 2017/09/22 13:28 by 127.0.0.1

Page Tools