Andy's Blog » » 编译chm格式PHP手册

编译chm格式PHP手册

微软的chm文件格式是很受我们喜爱的,因为它可以把很多HTML文件打包成一个文件,容易传输和分享。而且非常方便易用,支持索引、搜索等。正因为这样,大家通常都使用chm版本的PHP手册。

php.net会定期编译PHP手册,提供各种版本供大家下载,包括chm格式。由于是定期编译,所以我们拿到的永远不会是最新的手册。 如果你想得到最新的手册,就只能自己编译了。而且php.net提供的中文手册不能搜索中文,索引也是乱码。

介绍一下编译流程:
1。准备好HTML格式的手册文件。
有两种途径:
1)通过cvs下载手册文件,自己编译出来 (保证最新,但编译过程要花费5个小时左右,生成6000多个文件,要有耐心,唉。)
2)通过php.net下载打包好的html手册,到本地解压缩。

2。下载并安装Microsoft(r) HTML Help Workshop,默认安装在 c:\Program Files\HTML Help Workshop\;
3。通过cvs下载 chm 手册生成脚本文件,位于phpdoc/chm目录下:
common.php
make_chm.README
make_chm.bat
make_chm.php
make_chm_fancy.php
make_chm_spc.gif
make_chm_style.css
  <DIR>          chm
  <DIR>          html
4。编辑make_chm.bat:
     根据你的实际情况修改相应选项:
     rem Path of the PHP CLI executable
     set PHP_PATH=C:\php5\php.exe

      rem Path of the Help Compiler command line tool
      set PHP_HELP_COMPILER="c:\Program Files\HTML Help Workshop\hhc.exe"

      rem The language of the manual to compile
      set PHP_HELP_COMPILE_LANG=zh

      rem The source directory with the original DSSSL made HTML
      set PHP_HELP_COMPILE_DIR=.\html

注意,我们把要用到的HTML文件的目录设置为.\html,所以我们要把所有HTML文件放进去。

5。点击“开始”->“运行”->“cmd”,在命令行下进入相应目录,输入:
make_chm.bat

如果顺利,就会在chm/chm目录下生成chm格式的PHP手册了。

编译带评论(User Notes)的PHP手册:

在phpdoc/htmlhelp目录下,存在另一个chm文件编译系统,用于生成extended CHM文件(即带扩展功能的chm文件)。

使用步骤:

1. 得到最新的phpdoc html文件; 可以查看xsl/version.xml来得到版本信息,确保编译最新的手册。

2. 在phpdoc目录下:
autoconf
./configure --with-chm=yes
make chm_xsl
  可选参数:    "--with-xsltproc=path" 指定 XSLTProc路径

3.     将HTML文件放在   phpdoc/htmlhelp/html 目录下(一般情况况执行完1之后会自动复制HTML文件到该目录)

4. 下载http://cn.php.net/include/mirrors.inc
或者http://cn2.php.net/include/mirrors.inc
放到htmlhelp目录下,与make_chm.bat同目录。

5. 下载 http://cn.php.net/backend/notes/all.bz2
使用bunzip2 all.bz2命令解压,同样放到htmlhelp目录下。

6. 把local_vars.php.src重命名为local_vars.php,并根据实际情况修改其中配置。
7. 最后运行:
make_chm.bat

编译过程中会先生成一个评论相关的chm文件,然后最后生成一个总的chm手册。

Tags: PHP手册, 编译

本文地址: http://www.21andy.com/new/20091208/1461.html