Index: README =================================================================== --- README (revision 284196) +++ README (working copy) @@ -17,8 +17,8 @@ pear channel-discover doc.php.net This command only needs to be executed once - From CVS: - cvs -d:pserver:cvsread@cvs.php.net/repository co phd + From SVN: + svn checkout http://svn.php.net/repository/phd/trunk phd cd phd pear install -f package.xml @@ -30,23 +30,23 @@ Rendering the documentations for the first time: WINDOWS: #1) cd c:\ - #2) cvs -d:pserver:cvsread@cvs.php.net/repository co phpdoc - #3) cd phpdoc + #2) svn checkout http://svn.php.net/repository/phpdoc/modules/doc-en + #3) cd doc-en\doc-base #4) php configure.php (Using PHP5.3:) - #5) phd --docbook c:\phpdoc\.manual.xml + #5) phd --docbook c:\doc-en\doc-base\.manual.xml (Using PHP prior to 5.3:) - #5-old) phd c:\phpdoc\ - + #5-old) phd c:\doc-en\doc-base\ + *NIX: #1) cd ~ - #2) cvs -d:pserver:cvsread@cvs.php.net/repository co phpdoc - #3) cd phpdoc + #2) svn checkout http://svn.php.net/repository/phpdoc/modules/doc-en + #3) cd doc-en/doc-base #4) php configure.php (Using PHP5.3:) - #5) phd --docbook ~/phpdoc/.manual.xml + #5) phd --docbook ~/doc-en/doc-base/.manual.xml (Using PHP prior to 5.3:) - #5-old) phd -d ~/phpdoc/.manual.xml + #5-old) phd -d ~/doc-en/doc-base/.manual.xml NOTE: The short form works on PHP5.3 too @@ -54,14 +54,24 @@ "php" directory containing the "phpweb" files NOTE: You CANNOT view these files without a phpweb mirror running. See http://doc.php.net/wiki/phd/view#viewing_the_phpfolder - "html" direcotry containing the "downloadable chunked html" files + "html" directory containing the "downloadable chunked html" files NOTE: Do NOT move these files onto your webserver. Just double click them and your browser will open and show you the content "bightml.html" file, which is the "downloadable bightml" file -Now edit the XML files as you wish in the phpdoc folder. +Now edit the XML files as you wish in the doc-en/en directory. To build the documentation again follow the instructions above, skipping step#2. +NOTE: To work on translations, you should replace the 'en' in all +of the above examples with the appropriate ISO 639-1 Code of the desired language. +(see http://www.sil.org/iso639-3/codes.asp for a list of codes) +e.g. 'pt' for Portuguese, or pt_BR for Brazillian Portuguese. Step two in the +example above would change to: + svn checkout http://svn.php.net/repository/phpdoc/modules/doc-pt +or + svn checkout http://svn.php.net/repository/phpdoc/modules/doc-pt_BR +The XML files to edit will be in doc-pt/pt or doc-pt_BR/pt_BR directories. + The `phd` command optionally takes more arguments. For information about those arguments please type `phd -h`