用途:按 docs.typo3.org 官方标准创建和维护 TYPO3 扩展文档,适用于编写、编辑或审查 Documentation/*.rst、guides.xml、README.md 及 XLF 翻译,并渲染文档。
主要能力:提供文档缺口提取与分析、参考文件查阅、TYPO3 专用指令使用、校验与渲染流程。核心工作流为先运行 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 渲染。用户要求“show docs”时应渲染并展示 HTML 输出,而非原始 RST。
元素选择:完整代码用 literalinclude(优先于 code-block),短片段用带 :caption: 的 code-block,配置项用 confval 并带 :name:、:type:、:default:,PHP API 用 php:method:: 并以 :returntype: 处理可空/联合类型,提示用 note、tip、warning、important,功能网格用 card-grid 配合 footer 中的 stretched-link,备选用同步 tabs,截图用 figure 并带 :zoom: lightbox、:class: with-border with-shadow。
关键规则:UTF-8、4 空格缩进、80 字符行宽、LF;文件名 CamelCase、标题句首大写;每个标题前加永久锚点(.. _label:);每个子目录含 Index.rst;PNG 截图带 :alt: 与 :zoom: lightbox;Documentation/ 下含 .editorconfig;后端模块、配置、工作流必须有截图;每个 RST 最多 250 行,超出用 toctree 拆分;不用 mailto:,改用 GitHub Issues/Discussions;PHP 域中 php:method:: 不写 ?Type/Type|null,改用 :returntype:。
代码示例校验:对照扩展源码交叉检查,在 Classes/ 中 grep 方法名,比对 CLI 参数与 configure(),验证 API 签名,详见 references/extraction-patterns.md。
提交前检查:Documentation/ 含 .editorconfig、每个目录含 Index.rst;4 空格缩进、无制表符、最多 80 字符;代码块带 :caption:、行内代码用正确角色;截图带 :alt: 与 :zoom: lightbox;scripts/validate_docs.sh 通过且渲染无警告;README 与 Documentation/ 同步。
限制:资料未提供具体安装命令、收费、价格、平台或效果信息;参考文件与脚本选项详见 references/ 下对应文档。