叶元命令,用于绘制项目部分的方案。
foliantcontrib.project-graph的Python项目详细描述
项目图
叶元命令,用于绘制项目部分的方案。此扩展使用由folinatcontrib.meta扩展收集的元信息。
Graphviz用于生成方案。
libgraphviz-dev
需要安装在您的计算机上。
安装
$ pip install foliantcontrib.project_graph
用法
首先,需要指定项目中文档之间的所有关系。为此,请将relates
部分添加到文档的元数据中:
---relates:-tests/test1.md-specs/spec.md---
在relates
部分中,需要指定与当前文档相关的文档列表。您可以指定连接文档的相对路径或其ID(如果相应文档的meta部分分配了ID):
# index.md---id:index---
# glossary.md---relates:-index---
指定所有关系后,运行draw命令:
$ foliant draw
scheme将出现在文件project_graph.png
配置
projectgraph有许多选项:
project_graph:directed:falsefilename:project_graph.pnggv_attributes:node:shape:rectcolor:greenedge:arrowhead:opengraph:ranksep:1main_relation:penwidth:2
directed
:指定要定向或不定向的图形。默认值:false
filename
:图形输出文件名。默认值:project_graph.png
gv_attributes
:具有图形全局属性的字典。每个字典都应该存储在graphviz实体键(node
,edge
,或graph
)或类型键下。所有具有此类型的节或关系都将获得这些属性。
如果只想调整一个节点的外观,请在文档的meta中添加一个gv_attributes
选项:
---id:indexrelates:-glossarygv_attributes:color:greenshape:circle---
还可以更改连接节点的边的外观。为此,可以使用关系的详细语法。
关系详细语法
如前所述,要指定关系,您需要添加一个relates
参数,并包括一个相关文档ID的列表\文件路径:
---relates:-doc1.md-MAIN_SPEC---
但也有一个详细的语法用于指定关系,如下所示:
---relates:-rel_path:doc1.mdtype:details-rel_id:MAIN_SPECgv_attributes:color:#CCCCCCarrowhead:none---
在详细的语法中,每个关系不是一个字符串,而是一个映射。这一次,如果按路径指向文档,则必须显式使用rel_path
键;如果按ID指向文档,则必须使用rel_id
键。
还可以通过添加type
键来指定关系类型。现在,这个键的值只转到边标签,但是很快您就可以用一种类型更改所有边的外观。
最后,可以通过调整gv_attributes
键中的graphviz属性来覆盖此特定边的外观。