从文本RFC和勘误表数据库构建HTML文件。
rfc-errata的Python项目详细描述
自动对RFC应用勘误表
RFC系列是RFC Editor为了 互联网社区。它包含有关互联网的技术和组织文档, 包括四个文件流生成的规范和政策文件 RFC系列:因特网工程任务组(IETF),因特网研究任务 Force(IRTF)、Internet架构委员会(IAB)和独立提交。文件 在RFC系列中,由一个数字标识,并永久冻结,不能更改。
RFC编辑器维护用户提交的勘误表数据库 RFC。这些勘误表一经报告,可予以核实、拒绝或“保留以供文件更新”。 勘误表对RFC消费者的可见性在历史上一直很差或根本不存在。 这个计划是提高这些勘误表可见度的努力的一部分。
此程序从RFC Editor和文本版本中提取勘误表数据库的副本 一个RFC的。然后合并勘误表和RFC的文本,生成一个html文件。
用法
RFC勘误表从RFC Editor网站获取运行所需的所有信息。工具可以是 运行以更新所有有勘误表的RFC或仅更新一组特定的RFC
基本用法:rfc-errata [options] [<list of RFCs>]
- 选项
以下参数会影响svgcheck的行为,但不需要任何参数。
Short Long Description ^{tt2}$ ^{tt3}$ provide a server to download errata and RFCs from . ^{tt4}$ do not download errata.json from the website . ^{tt5}$ directory containing templates to be used . ^{tt6}$ directory to store unmodified text RFCs in . ^{tt7}$ directory to place modified HTML RFCs in . ^{tt8}$ relative location for CSS files at final website . ^{tt9}$ update all RFCs rather than a list of RFCs . ^{tt10}$ apply ‘reported’ errata (yes/no) . ^{tt11}$ apply ‘held for update’ errata (yes/no) . ^{tt12}$ apply ‘rejected’ errata (yes/no) . ^{tt13}$ apply ‘verified’ errata (yes/no) . ^{tt14}$ rebuild all HTML files rather than using timestamps . ^{tt15}$ clear destination copy list . ^{tt16}$ path to css files in the HTML output . ^{tt17}$ specify the destinations to copy to (multiple) ^{tt18}$ ^{tt19}$ print extra information ^{tt20}$ ^{tt21}$ display the version number and exit
操作
该工具可以在批处理模式下使用,批处理模式设计为在cron作业中使用。 为此,只有具有新勘误表的文件才能重新生成并发布到 必要的位置。删除勘误表的文档不会重新生成为 没有关于这一事实的通知。
该工具将信息存储在CWD中的status.json文件中。这个文件是用来记忆的 不同工具调用之间的命令行选项。这意味着,例如, 要应用的勘误表集在调用之间被记住,不需要 每次都指定。该工具还将errata.json文件存储在cwd中。
当处理过程中发生故障时,它们会记录到CWD中的“errors.log”文件中。
选项的默认值为:
- 服务器=www.rfc-editor.org
- RFC勘误表安装目录中的模板
- html=./html
- 文本=/RFC
- css=./css
- 报告=否
- 拒绝=否
- 保持=是
- 验证=是
依赖关系
无
更改日志
版本0.2.1(8月6日星期二)
- Update the header template to say this is not an offical RFC
0.2.0版(7月22日周一)
- Fixed an error when specifying the html directory.
版本0.1.5(6月18日星期二)
- RFC Editor requested some changes in how the templates are worded
- Fixed corner case where an entire section can disappear
- Return a count of errors
- Fix an error with a None field for new text