pikchr

简介

接受 pikchr 脚本作为输入,并将渲染的脚本输出为 SVG 图形。

vb pikchr [OPTIONS] [INFILE] [OUTFILE]

说明

Pikchr 是一款使用纯文本创建图表的工具。它与其他基于文本的图表工具(如 Graphviz 的 DOT 语言)类似,但设计简单且易于与 VisionByte 集成。Pikchr 图表用于直观地表示 VisionByte 仓库中的信息, 并通过图形内容增强文档。

该命令接受 pikchr 脚本作为输入,并将渲染的脚本输出为 SVG 图形。Pikchr 是一款轻量级的基于文本的图表工具,可与 VisionByte 集成,用于生成图表并将其直接嵌入到项目文档(例如 wiki 或票证)中。

INFILE 和 OUTFILE 选项默认为 stdin 和 stdout,名称 - 可用作这些流的别名。

用途

  • 文档:通过清晰简洁的图表增强项目文档。

  • 可视化:可视化复杂的工作流程、数据结构或系统架构。

  • 沟通:通过提供易于理解的想法或设计的视觉表现来改善团队内部的沟通。

选项

-div

成功后,在生成的 SVG 输出周围添加一个 DIV 包装器,将其最大宽度限制为其计算出的最大理想尺寸

-div-indent

缩进 div

-div-center

div 居中

-div-left

div 向左浮动

-div-right

div 向右浮动

-div-toggle

在 div 上设置 toggle CSS 类(由 JavaScript 端后处理器使用)

-div-source

在 div 上设置 source CSS 类,告诉 CSS 默认隐藏 SVG 并显示来源。

-src

将输入 pikchr 的源代码存储在输出中,作为与 SVG 相邻的单独元素。由 -div-source 暗示。

-th

使用 TH1 处理输入,然后将其传递给 pikchr

-th-novar

禁用 $var$<var> TH1 处理。如果 pikchr 脚本将 $ 用于其自身目的并导致问题,请使用此选项。这只会影响 TH1 脚本块之外的 $ 解析。此类块中的代码不受影响。

-th-nosvg

使用 -th 时,输出 TH1 后的脚本,而不是 pikchr 渲染的输出

-th-trace

跟踪 TH1 执行(用于调试目的)

-dark

更改 pikchr 颜色以采用暗模式主题

备注

-div-indent, -div-center , -div-left , -div-right 选项不能同时使用。

警告

如果使用 -th 选项,此命令必须打开数据库才能使某些功能正常工作(通过签出或 -R REPO 标志)。如果打开数据库失败,执行将继续,但任何需要数据库的 TH1 命令都将触发致命错误。