svn: /phd/trunk/ HOWTO.GENERATE_CHM README

From: Date: Mon, 27 Jul 2009 07:49:47 +0000
Subject: svn: /phd/trunk/ HOWTO.GENERATE_CHM README
Groups: php.doc.cvs 
Request: Send a blank email to doc-cvs+get-4519@lists.php.net to get a copy of this message
bjori Mon, 27 Jul 2009 07:49:47 +0000 Revision: http://svn.php.net/viewvc?view=revision&revision=286388 Log: - Update to talk about SVN Changed paths: U phd/trunk/HOWTO.GENERATE_CHM U phd/trunk/README Modified: phd/trunk/HOWTO.GENERATE_CHM =================================================================== --- phd/trunk/HOWTO.GENERATE_CHM 2009-07-27 07:39:01 UTC (rev 286387) +++ phd/trunk/HOWTO.GENERATE_CHM 2009-07-27 07:49:47 UTC (rev 286388) @@ -2,18 +2,23 @@ Copyright(c) 2007-2009 The PHP Documentation Team All Rights Reserved. -Warning : you'll need Windows to build CHM files. +Warning: you'll need Windows to build CHM files. -First, you will need to get the last CVS version of the PhD renderer from the repository: - cvs -d:pserver:cvsread@cvs.php.net/repository co phd +First, you will need to get the last SVN version of the PhD renderer from the repository: + svn checkout http://svn.php.net/repository/phd/trunk phd Then, you need to get the documentation: - cvs -d:pserver:cvsread@cvs.php.net/repository co phpdoc + svn checkout http://svn.php.net/repository/phpdoc/modules/doc-en If you want to render a translated documentation instead: - cvs -d:pserver:cvsread@cvs.php.net/repository co phpdoc-{lang} - where {lang} is the ISO Code of the wished language - (see http://www.unicode.org/unicode/onlinedat/languages.html) + svn checkout http://svn.php.net/repository/phpdoc/modules/doc-{lang} +where {lang} is the 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. +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 To render the documentation: #1) cd {PHPDOC_PATH} @@ -35,3 +40,4 @@ Please read the README file for further information. - The PHP Documentation team + Modified: phd/trunk/README =================================================================== --- phd/trunk/README 2009-07-27 07:39:01 UTC (rev 286387) +++ phd/trunk/README 2009-07-27 07:49:47 UTC (rev 286388) @@ -1,13 +1,11 @@ PhD - PHP DocBook Copyright(c) 2007-2009 The PHP Documentation Team All Rights Reserved. -$Id$ +$Revision$ At the moment, the code depends upon the following: - - PHP 5.2.3 or later. PHP 5.3 is recommended. PHP 6 is unsupported, but - might work. - - An available CLI binary. - - DOM, libXML2, and xmlreader. + - PHP 5.3 + - DOM, libXML2, and XMLReader. Installing the PhD renderer: @@ -17,8 +15,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 +28,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,16 +52,27 @@ "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 - The PHP Documentation team +

« previous php.doc.cvs (#4519) next »