修复存储库工具
FIXation的Python项目详细描述
从修复库生成好看的文档。
命令行界面
fix-parse [--base fixation/fix_repository_2010_edition_20140507] [--document] [--fiximate]
--base
指向存储修复库的位置。
--document
生成适合转换为pdf的单页document.html。
使用自己的模板
固定的核心是围绕jinja2模板,在开始之前,您应该将[http://jinja.pocoo.org/docs/2.10/templates/]包含编写良好且易于理解的关于如何编写模板的文档。
现在最简单的方法是将模板/文件夹复制到当前工作目录中,有几个基本模板包含泛型结构,然后是扩展基础的更具体的模板。
编写模板
在--fiximate
的情况下,您将得到一个repository
,它将告诉您正在处理的type
,以及copyright
和version
您还可以访问jinja2过滤器linkify
(它为您提供一个到项目的相对链接)和测试messages
、field
、component
和blacklist
/whitelist
(有或没有上下文)。
下面是messages.html如何使用linkify生成链接。
<a href="{{ msgcontent | linkify }}">
下面是messages.html如何检查某个字段或组件的。
{% if msgcontent is component %}
下面的示例来自document.html,处理有上下文和无上下文的黑名单/白名单。
{% if msgcontent is not blacklisted(message) %} {% if message is not blacklisted %}
文档设置.json
如果您想黑名单或白名单的事情有两种方法,在下面的例子中,标准拖车将被视为黑名单的上下文中的消息重新发送(2)
任何放入额外数据的内容都将被插入到文档中,因此下面的示例将允许您使用{{ key }}
访问列表。
{"blacklist":["0","StandardHeader"],"ctx_blacklist":{"2":["StandardTrailer"]},"extra_data":{"key":["value1","value2"]}}