Extended CHM 的主要特点
可自定义右键菜单
php代码块以语法高亮显示
php代码块中的函数带有相应的函数手册链接
更清晰的手册界面
可以自定义手册的外观样式
支持换肤功能
更详尽的手册内容
附带非常实用用户笔记
可以集成于大多数ide和编辑器
详细信息请访问
<&/docsechmphp>>
为什么要 DIY
不知为什么 这么好的东东在 php 的官方网站上已经很久没有更新了 (最新的官方
版本是 发布的) 尤其是在 php 发布以后更是有不少内容都查不到 所
以就只能发扬 DIY 精神 来自己制作了 ^_^
预备知识
cvs 客户端的使用
linux 环境下的基本操作 以及软件的编译与安装
软件需求
cvs客户端软件:
我们要通过 php 官方网站的 cvs 服务器来取得 phpdoc 的最新版本
windows 环境下推荐使用 wincvs中文版
<<
ncvs/>>
unix 阵营的操作系统一般都自带 cvs 客户端
你可以在命令行下直接键入 cvs version 来检查 cvs 是否安装
如果没有安装请从
<<>> 中下载最新版
本的 cvs 客户端
Windows 操作系统:
需要在 windows 系统中运行 Microsoft Html Help Workshop 来生成 chm 文件
你也可以在linux下运行wine来模拟windows
Microsoft Html Help Workshop
微软发布的用语生成 chm 文件的工具
<<Microsoft Html Help
Workshop>>
Linux 操作系统:
我们需要在此进行手册和一些必备软件包的编译安装
你也可以使用其他的 unix 阵营的系统
或者干脆用 cygwin vmware 等软件来在 Windows 下模拟一个 linux 环境
PHP或以上版本:
编译和生成 chm 文件时均需要用到 php 所以你需要再 windows 和 linux 环境下
都安装 php
本文所使用的环境:
两台pc 分别装有 redhat 以及 windows professional
开始 DIY
首先 在 linux 机中
安装 OpenJada 和 OpenSP
进入 linux 控制台
代码:
$mkdir /home/phpdoc
$cd /home/phpdoc
$wget targz
$wget targz
$tar zxvf *targz
$cd openjade
$/configure
$make
$make install
$cd /OpenSP
$/configure
$make
$make install
$cd /
然后 我们要从 php 的官方 cvs 服务器中取得 phpdoc 的最新版本
代码:
$export CVSROOT=:pserver::/repository
$cvs z checkout phpdoc
$cd phpdoc
$cvs update dP DDecember :pm xsl
$cvs up A xsl/versionxml xsl/docbook/html/chunkerxsl
设置编译参数
代码:
$autoconf
$/configure withchm=yes withlang=en
这时 要做一些小小的修正
用编辑器打开 /home/phpdoc/phpdoc/xsl/htmlhelpdbxsl
在此文件中搜索 @DOCBOOKXSL_HTML@
将其替换为 /docbook/html/chunkxsl 并存盘退出
然后再打开 /home/phpdoc/phpdoc/xsl/htmlcommonxsl
将如下代码加入文件尾部</xsl:stylesheet>一行之上 并存盘退出
代码:
<xsl:template match=collabname mode=titlepagemode>
<xsl:applytemplates />
</xsl:template>
<xsl:param name=chunkeroutputdoctypesystem
select=/>
<xsl:param name=chunkeroutputdoctypepublic select=//WC//DTD HTML
Transitional//EN/>
然后继续执行编译操作
代码:
$make chm_xsl
待编译结束以后 我们需要取得最新的 php 镜像站点列表 和用户笔记文件
代码:
$cd htmlhelp
$wget /include/mirrorsinc
$wget /backend/notes/allbz
$bunzip allbz
cd /
可以把生成的文件打个包 传至 windows 机上
代码:
tar czvf phpdoctargz /htmlhelp
到这里 需要再 linux 平台上执行的操作就完成了
现在起操作转到windows环境中
首先 解压缩刚才生成的phpdoctargz
由于我所取得的版本编译后所生成的一些文件中 相关函数的链接存在错误
所以需要修改一下 htmlhelp/filter_filesphp 文件
先在其头部加入如下代码
PHP代码:
//fix functions link error
function fix_function_link($m) {
$fname = functionstrtolower(str_replace(_$m[]))l;
$fname = functionstrtolower(str_replace(_$m[]))l;
if(file_exists(html/$fname)) {
return <a $fname><b>$m[]()</b></a>;
}elseif(file_exists(html/$fname)) {
return <a $fname><b>$m[]()</b></a>;
}else{
return <a # onclick=return false;><b>$m[]()</b></a>;
}
}
然后在文件中找到如下这段代码
PHP代码:
// Read in the contents of the source file
$content = join( file($HTML_SRC/$filename));
将其改为
PHP代码:
// Read in the contents of the source file
$content = join( file($HTML_SRC/$filename));
$content = str_replace(»»$content);
$reg_fix = /preg_quote(<a ><b> /)(\w+)\(\)preg_quote(</b></a> /)/is;
$content = preg_replace_callback($reg_fixfix_function_link$content);
$reg_fix = /preg_quote(<a ><b> /)(\w+)\(\)preg_quote(</b></a> /)/is;
$content = preg_replace_callback($reg_fixfix_function_link$content);
存盘后 再将 htmlhelp\local_varsphpsrc 重命名为
htmlhelp\local_varsphp
编辑 htmlhelp\local_varsphp
将其中的 $HELP_WORKSHOP 变量值设置为 Html Help Workshop 的安装目录 存盘退
出
将 phpexe 所在目录加入 path 环境变量中
在 运行 中键入 cmd 进入控制台模式并进入 phpdoctargz 的释放目录
代码:
cd htmlhelp
make_chmbat
待其执行结束后 Extended CHM 版的 php 语法手册就生成完毕了
储存在 htmlhelp/release 目录下
再下载
<<php_manual_prefsexe>> 并保存在手册目录
执行此程序即可对手册中的右键菜单 所用皮肤等进行设置了
设置完成后 双击 php_manual_enchm 即可浏览手册了
