【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>>
目前,从 PHP 官网 https://www.php.net/download-docs.php 下载的 chm 中文手册有两个大问题:
- 索引不完整,中文标题的页面没有索引
- 搜索栏用不了,无论搜什么都搜不出来
鉴于此,本人参考了网上制作 chm 的文档,自己重新编译一个版本。
在 Windows 系统下,chm 文件是通过微软的 HTML Help Workshop 生成的。chm 文件可以用 7-zip 进行打开,解压出来后可得到原 html 文件、hhc 目录文件、hhk 索引文件。
本人用 7-zip 解压从 PHP 官网下载的 php_enhanced_zh.chm ,得到所有的 html,以及 php_manual_zh.hhc
、php_manual_zh.hhk
,打开这两个文件没有看到任何中文字符,猜测可能是解压的时候丢失了,或者原本官网打包就有问题。如果要重新制作 chm 手册,我们还缺少一个 hhp 后缀名的项目配置文件 。
下面是本人写的一个 PHP 脚本,用于重新生成 php_manual_zh.hhc
、php_manual_zh.hhk
、php_manual_zh.hhp
(也可访问码云仓库 https://gitee.com/yangrz/recompile_php_manual_zh):
<?php
error_reporting(E_ALL);
set_time_limit(0);
ini_set('display_errors', 'on');
define('CHM_PATH', __DIR__ . '/php_enhanced_zh/');
/**
* 搜索html文件
* @return array
*/
function searchHtml()
{
$pattern = CHM_PATH . 'res/*.html';
$files = glob($pattern);
return $files;
}
/**
* 获取文件内容并转换为UTF-8编码
* @param string $file
* @return string
*/
function getFileWithUTF8($file)
{
$content = file_get_contents($file);
$content = iconv('gbk', 'utf-8', $content);
return $content;
}
/**
* 修复导航条
* @param string $content
* @return string
*/
function fixNavbar($content)
{
$pattern = [
'#<li style="float: left;"><a href="([^"]+)">\? (.+?)</a></li>#',
'#<li style="float: right;"><a href="([^"]+)">(.+?) \?</a></li>#'
];
$replacement = [
'<li style="float: left;"><a href="\1">« \2</a></li>',
'<li style="float: right;"><a href="\1">\2 »</a></li>'
];
$content = preg_replace($pattern, $replacement, $content);
return $content;
}
/**
* 修复面包屑
* @param string $content
* @return string
*/
function fixBreadcrumbs($content)
{
$search = '<ul class="breadcrumbs-container">';
$replace = '<ul id="breadcrumbs-inner" class="breadcrumbs-container">';
$content = str_replace($search, $replace, $content);
return $content;
}
/**
* 解析页面标题
* @param type $content
* @return string
*/
function parseTitle($content)
{
$patterns = [
'#<h1([^>]*)>(.+?)</h1>#',
'#<h2([^>]*)>(.+?)</h2>#',
'#<h3([^>]*)>(.+?)</h3>#'
];
foreach ($patterns as $pattern) {
preg_match($pattern, $content, $matches);
if ($matches) {
$title = trim(strip_tags($matches[2]));
return $title;
}
}
return '';
}
/**
* 以gbk编码保存文件内容
* @param string $file
* @param string $content
*/
function saveFileWithGBK($file, $content)
{
$content = iconv('utf-8', 'gbk', $content);
file_put_contents($file, $content);
}
/**
* 计算进度百分比
* @param int $num 当前值
* @param int $count 总数
* @param int $step 步长
* @return int
*/
function calcProgress($num, $count, $step = 1)
{
$progress = 0;
if ($num == $count) {
$progress = 100;
} elseif ($num % $step == 0) {
$progress = floor($num / $count * 100);
}
return $progress;
}
/**
* 重建目录文件
* @param array $titles
*/
function buildHhcFile(&$titles)
{
$hhcFile = CHM_PATH . 'php_manual_zh.hhc';
$content = getFileWithUTF8($hhcFile);
$pattern = '#<param name="Name" value="">\s+<param name="Local" value="([^"]+)">#s';
preg_match_all($pattern, $content, $matches);
foreach ($matches[0] as $key => $value) {
$shortPath = $matches[1][$key];
$title = isset($titles[$shortPath]) ? $titles[$shortPath] : '';
$replace = str_replace('value=""', 'value="' . $title . '"', $value);
$content = str_replace($value, $replace, $content);
}
saveFileWithGBK($hhcFile, $content);
}
/**
* 重建索引文件
* @param array $titles
*/
function buildHhkFile(&$titles)
{
$hhkFile = CHM_PATH . 'php_manual_zh.hhk';
$content = getFileWithUTF8($hhkFile);
$content = preg_replace('#<ul>(.+)</ul>#s', '<ul>PLACEHOLDER</ul>', $content);
$html = '';
foreach ($titles as $path => $title) {
$html .= '
<LI><OBJECT type="text/sitemap">
<param name="Local" value="' . $path . '">
<param name="Name" value="' . $title . '">
</OBJECT>';
}
$content = str_replace('PLACEHOLDER', $html, $content);
saveFileWithGBK($hhkFile, $content);
}
/**
* 生成项目配置文件
* @param array $htmlFiles
*/
function buildHhpFile(&$htmlFiles)
{
$date = date('Ymd');
$content = <<<EOT
[OPTIONS]
Compatibility=1.1 or later
Compiled file=php_enhanced_zh.chm
Contents file=php_manual_zh.hhc
Default Window=phpchm
Default topic=res\index.html
Display compile progress=Yes
Full-text search=Yes
Index file=php_manual_zh.hhk
Language=0x804 中文(简体,中国)
Title=PHP中文手册
[WINDOWS]
phpchm="PHP中文手册 - {$date}","php_manual_zh.hhc","php_manual_zh.hhk","res\index.html","res\index.html",,,,,0x23520,,0x387e,,0x1000000,,,,,,0
[FILES]
EOT;
foreach ($htmlFiles as $filePath) {
$shortPath = str_replace([CHM_PATH, '/'], ['', '\\'], $filePath);
$content .= "\n" . $shortPath;
}
$hhpFile = CHM_PATH . 'php_manual_zh.hhp';
saveFileWithGBK($hhpFile, $content);
}
$startTime = time();
$titles = [];
$htmlFiles = searchHtml();
if (!$htmlFiles) {
echo "未检索到 html 文件,请下载手册原文件并解压至 " . CHM_PATH . " 目录\n";
echo "下载地址 https://www.php.net/distributions/manual/php_enhanced_zh.chm\n";
exit;
}
echo "开始处理 html 文件\n";
$count = count($htmlFiles);
$progress = 0;
foreach ($htmlFiles as $key => $filePath) {
$content = getFileWithUTF8($filePath);
$content = fixNavbar($content);
$content = fixBreadcrumbs($content);
$title = parseTitle($content);
$shortPath = str_replace([CHM_PATH, '\\'], ['', '/'], $filePath);
$titles[$shortPath] = $title;
saveFileWithGBK($filePath, $content);
$newProgress = calcProgress($key + 1, $count, 500);
if ($newProgress && $progress != $newProgress) {
$progress = $newProgress;
echo "进度 {$progress}%\n";
}
}
echo "正在生成目录文件 php_manual_zh.hhc\n";
buildHhcFile($titles);
echo "正在生成索引文件 php_manual_zh.hhk\n";
buildHhkFile($titles);
echo "正在生成项目文件 php_manual_zh.hhp\n";
buildHhpFile($htmlFiles);
$useTime = time() - $startTime;
$minute = floor($useTime / 60);
$second = $useTime % 60;
echo "已完成,用时 {$minute} 分 {$second} 秒\n";
使用方法:
- 复制以上代码保存为 index.php
- 在当前目录下新建子目录 php_enhanced_zh/,并解压 php_enhanced_zh.chm 到这个子目录下
- 通过浏览器访问这个 index.php,或者命令行执行 php index.php(耗时较长,耐心等待)
- 用 HTML Help Workshop 打开生成的 php_enhanced_zh/php_manual_zh.hhp
- 点击 HTML Help Workshop 工具栏的 “Compile HTML file” 按钮进行编译
- 编译完成后,新的手册文件保存在 php_enhanced_zh/php_enhanced_zh.chm
操作截图如下:
可访问码云仓库下载本人已编辑好的手册文件:https://gitee.com/yangrz/recompile_php_manual_zh/releases
本程序中的部分代码参考了: https://www.atuser.com/
来源:oschina
链接:https://my.oschina.net/u/590866/blog/3155056