Template_Library_Documentation
HTML / 文档 · 作者 PLCnext
面向 IEC 61131 库的 Markdown 文档模板，经 Pandoc 与 wkhtmltopdf 生成 HTML/PDF，可导入 PLCnext Engineer 做上下文帮助。
使用许可与条件
免费使用 · 保留许可声明
MIT许可证允许免费使用、复制、修改、合并、发布、分发、再许可和销售，仅需保留版权与许可声明。
使用时需要遵守
- 保留原作者版权声明和 MIT 许可证声明。
- 在所有副本或实质性部分中包含版权声明和许可声明
需要另行核对
- README中提及的Pandoc和wkhtmltopdf为免费软件，但其自身许可未在提供文本中明确
查看原文依据
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software
许可证原文
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
许可证原文
https://github.com/PLCnext/Template_Library_Documentation/blob/main/LICENSEhttps://github.com/PLCnext/Template_Library_Documentation/blob/HEAD/README.mdPermission is hereby granted, free of char
许可证原文
DeepSeek 根据仓库许可证和 README 整理 · 2026-09-24。结果仅覆盖已读取资料，依赖、图片、字体及后续条款变更以各自原文为准。
模板详细介绍
这个仓库是 PLCnext 官方提供的库文档模板，用 Markdown 编写 IEC 61131 函数、功能块和 HMI 符号的说明，再通过批处理脚本一次生成 HTML 与 PDF 两种输出。模板本身不包含任何库代码，重点在于把内容组织、章节顺序和样式统一起来，让作者只关注写什么，而不是怎么排版。
生成物有明确去向：HTML 可以导入 PLCnext Engineer，为单个组件提供 SHIFT+F1 上下文帮助，也能作为整库说明挂到项目描述里；PDF 则适合上传到 PLCnext Store 作为可打印文档。仓库提供了带注释的 Markdown 模板文件、现成的 make.bat 和样式表，文件名前缀决定 PDF 章节顺序，组件文档集中在 Components 子目录下，便于按功能块逐个维护。
使用前需要自行安装 Pandoc 和 wkhtmltopdf，并可能要把它们加入 Windows 的 Path 环境变量；组件级 HTML 文件是重定向页，不能直接在浏览器里打开，只有在 PLCnext Engineer 中集成后才生效。另外，PLCnext Engineer 低于 2024.6 的版本对受读保护的功能块无法打开 HTML 帮助，集成步骤也要求 2023.3 及以上版本，这些版本边界需要按实际环境核对。
主要特点
- Markdown 单一来源，同时产出 HTML 与 PDF，避免两套内容不一致
- HTML 可导入 PLCnext Engineer，为函数、功能块和 HMI 符号提供上下文帮助
- PDF 面向 PLCnext Store 的可打印文档场景
- 附带 make.bat 批处理脚本和可自定义的样式表
- 文件名前缀控制章节顺序，Components 子目录按组件组织文档
适用场景
- 为自研 IEC 61131 库编写随库发布的使用说明
- 需要把库文档同时交付为在线帮助和可打印 PDF
- 在 PLCnext Engineer 项目中为功能块配置 SHIFT+F1 上下文帮助
适合人群
- 使用 PLCnext Engineer 并发布库的开发者
- 习惯用 Markdown 写作、希望统一输出格式的文档维护者
- 能自行安装 Pandoc 与 wkhtmltopdf 的 Windows 用户
使用前需要核对
- 需预先安装 Pandoc 和 wkhtmltopdf，必要时加入系统 Path
- 模板文件夹名不要包含空格，复制后按库名重命名
- HTML 帮助集成要求 PLCnext Engineer ≥ 2023.3，受保护块的帮助需 ≥ 2024.6
- 组件级 HTML 为重定向文件，不能直接在浏览器中查看
- 仓库许可证状态标注为 review，使用前需确认授权条款
本介绍由 AI 根据目录元数据和仓库 README 整理，实际功能以原仓库为准。
功能与适用范围
目录记录的用途为文档，主要技术栈为HTML。功能是否完整实现，需要在源码和演示中进一步确认。
- HTML
- 文档