cvs: phd(PHD_0_4) / HOWTO.GENERATE_CHM

bjori Sun Oct 19 14:32:32 2008 UTC Added files: (Branch: PHD_0_4) /phd HOWTO.GENERATE_CHM Log: MFH http://cvs.php.net/viewvc.cgi/phd/HOWTO.GENERATE_CHM?view=markup&rev=1.1 Index: phd/HOWTO.GENERATE_CHM +++ phd/HOWTO.GENERATE_CHM PhD - PHP DocBook Copyright(c) 2007-2008 The PHP Documentation Team All Rights Reserved. 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 Then, you need to get the documentation: cvs -d:pserver:cvsread@cvs.php.net/repository co phpdoc 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) To render the documentation: #1) cd {PHPDOC_PATH} where {PHPDOC_PATH} is the path of the grabbed phpdoc directory #2) php configure.php [ --with-lang={lang} ] to generate the .manual.xml file required by PhD #3) cd {RENDER_PATH} #4) php {PHD_PATH}\build.php {PHPDOC_PATH} #5) You should see the message "[hh:mm:ss - VERBOSE_FORMAT_RENDERING] Finished rendering" Finally, to compile the CHM sources: #1) Download & install Microsoft HTML Help Workshop (http://go.microsoft.com/fwlink/?linkid=14188) #2) Open the "chm\php_manual_en.hhp" (CHM Project) file with HTML Help Workshop #3) In the "File" menu, click on "Compile...", then the "Compile" button. #4) After the compilation process, you should see the message "Created {RENDER_PATH}\chm\php_manual_{lang}.chm". You can quit HTML Help Workshop. Done ! The compiled CHM file is located on "{RENDER_PATH}\chm\php_manual_{lang}.chm". Please read the README file for further information. - The PHP Documentation team