用途:按 docs.typo3.org 标准创建和维护 TYPO3 扩展文档,使手册能在该站点渲染。
主要能力:提供从零生成 Documentation/guides.xml 的骨架、文档提取与差距分析、RST 指令选择、文档校验与渲染等脚本化流程。核心是 guides.xml 的命名空间必须为 https://www.phpdoc.org/guides,写错会生成合法 XML 但渲染为空;Settings.cfg 已被 guides.xml 取代,不再被读取。
使用方式:无 Documentation/ 时先创建目录并写入 guides.xml,可用 grep -Fc 'xmlns="https://www.phpdoc.org/guides"' Documentation/guides.xml 校验命名空间(输出 1 为正确),再替换 TITLE 与版本;assets/guides.xml.dist 是更完整的起点。随后运行 scripts/extract-all.sh /path/to/extension 与 scripts/analyze-docs.sh /path/to/extension 找缺口,用 scripts/validate_docs.sh /path/to/extension 校验,用 scripts/render_docs.sh /path/to/extension 渲染。展示文档时应渲染 HTML 而非原始 RST。
适用场景:TYPO3 扩展手册编写、内容指令选择(literalinclude、code-block、confval、php:method、note/tip/warning、card-grid、tabs、figure 等)、截图与代码示例校验、提交前检查。
限制与规则:官方文档为准,冲突时以线上手册为准并报告偏差;UTF-8、4 空格缩进、LF、尽量 80 字符换行;文件名 CamelCase、标题句首大写;每个标题前加永久锚点,每个子目录含 Index.rst;图片用 PNG/AVIF 并带 :alt:;php:method 不使用 ?Type/Type|null,改用 :returntype:;不使用 mailto:,Documentation/ 内放 .editorconfig;单文件约 250 行,超出用 toctree 拆分。具体脚本选项与更多细节见技能内 references 目录,资料未提供收费、价格与平台信息。