Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

CHM build issues

未关闭
#203 29 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
需要澄清
活跃度
活跃
技术栈
php

调研方向

从 phpdotnet/phd/Package/PHP/HOWTO.GENERATE_CHM 开始,检查已报告的 HTMLHelp Workshop 和 Free Pascal chmcmd 失败问题。尽可能重现 CHM 构建过程,包括缺少文件的警告和 Windows 加载失败。完成的标准是记录可用的工具和步骤,或为放弃 CHM 支持提供明确依据。

由索引模型根据 Issue 内容生成。

描述

Attempted to build the CHM (non-enhanced) version of the manual and while the build itself appears to work, I ran into issues compiling the output into a chm file.

There's some CHM build instructions at https://github.com/php/phd/blob/master/phpdotnet/phd/Package/PHP/HOWTO.GENERATE_CHM but as you'll see from my notes below, they're not very helpful.

The first issue I encountered is that HTMLHelp Workshop (which contains the HTMLHelp Compiler) will not install on Windows 11 (installer errors saying a newer version is already installed).

Additionally I should note HTMLHelp Workshop no longer appears to be available for download from Microsoft (there's web documentation for it, but none of the download links leads anywhere. The closest I could find was this MS Answers post linking to an archive.org copy

I then tried the chmcmd compiler from freepascal on Linux (I was using fpc 3.2.2 on Gentoo). While this appeared to create a .chm file, this file failed to load on Windows 11. Additionally it output an Access Violation error.

chmcmd produced a number of warnings relating to content during the build. The most common 2 were:

  • Warning: Found file res/language.types.value.html while scanning res/<filename>.html, but couldn't find it on disk - appears to be caused by specific instances of the <type> tag on true and false
  • Warning: Found file res/ while scanning res/mongodb.persistence.html, but couldn't find it on disk - appears to be caused by anchors with no file attached. I think created by (for example) <footnoteref linkend="mongodb.pclass"/>

Does anyone have working instructions / tools to build the chm version of the manual?

The apparent lack of tools for building CHMs (I did have a search but there weren't many options, never mind free and maintained options) has me moving towards suggesting dropping support for CHM.

主要语言
PHP
星标
91
派生
59
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

php/phd 的其他 Issue

查看 php/phd 的全部 Issue

相似的 Issue

更多 PHP Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。