打印格式编辑器用于设计文档打印出来的样子。你可以把字段拖到页面上,按区块和列进行排列,并立即用真实文档的值查看效果。不需要 HTML 或代码,但需要时也可以自己添加。
适用于 Frappe v16 及更高版本。
开始之前
你需要:
- 创建打印格式的权限。系统管理员默认拥有该权限。
- 至少一份你要设计的目标类型的已保存文档,这样编辑器才能显示真实的值。
创建打印格式
- 打开 打印格式 列表,点击 添加打印格式。
- 将 打印格式用于 设置为 DocType,然后选择 DocType,例如销售发票。
- 输入 名称,例如“客户发票”。
- 将 起始方式 保留为默认值,即可视化编辑器。
- 点击 创建。编辑器随即打开。
然后编辑器会询问你想如何开始:
- 从默认开始 会用文档中所有可打印字段填满页面,顺序与表单一致。删除不需要的内容即可。这是最快的开始方式。
- 从空白开始 会给你一个空白页面,由你自己搭建。
你也可以从打印页面开始。打开一份文档,按 Ctrl+P,打开 ⋯ 菜单,在选中标准格式时点击 自定义。
快速了解
| 区域 | 作用 |
|---|---|
| 左侧面板 | 四个标签页。字段 列出文档的每个字段。图层 以树形结构显示页面。区块 包含非字段内容,如文本、图片和条形码。库 保存你已保存的片段。 |
| 页面 | 打印稿本身。点击任意内容即可选中。拖动即可移动。 |
| 右侧面板 | 你所选中内容的设置。未选中任何内容时,显示页面设置。 |
| 预览文档 | 页面上方的框。在这里选择一份文档,页面就会显示它的真实值。 |
| 工具栏 | 版本历史、显示预览、打印设置、编辑打印格式(打开该格式的表单)和 保存并应用。 |
打印格式是如何构成的
打印格式是由 区块 从上到下堆叠而成的。每个区块有一到四 列,每列包含 字段 和 区块。区块的上方和下方分别是 页眉 和 页脚。只有在打印设置中开启 重复页眉和页脚 时,它们才会在每一页重复。关闭时,页眉只在顶部打印一次,页脚只在末尾打印一次。
Header letter head and header fields
Section 1 to 4 columns
Column fields and blocks, top to bottom
Section
...
Footer footer fields and letter head footer
下面的页面会逐一说明各部分:
- 区块、列和页面:区块、列、边框、页眉、页脚、信头和分页符。
- 字段:添加字段并更改每个字段的打印方式。
- 表格:子表格,如发票明细、它们的列、样式和行筛选器。
- 区块:文本、图片、条形码、二维码、链接值、自定义表格、自定义 HTML 和 Typst。
- 显示或隐藏内容:区块、字段、表格行和列的显示条件。
- 页面设置和 PDF 渲染器:字体、颜色、边距、页码、Chromium 和 Typst。
- 版本、片段和快捷键。
保存你的工作
编辑器会保留你的格式的两个副本:
- 草稿 是你编辑时看到的内容。它会随着你的操作自动保存,工具栏会先显示 正在保存…,然后显示 草稿。此时打印效果还没有任何变化。
- 已发布 版本才是实际打印的内容。点击 保存并应用,或按 Ctrl+S,即可发布草稿。
如果你在未应用更改的情况下离开编辑器,它会先询问。你的草稿会被保留,所以你可以稍后再回来继续。
用真实数据预览
在页面上方的框中选择一份文档。每个字段都会显示该文档的值,任何不会为它打印的内容都会以虚线边框置灰显示。将鼠标悬停在置灰的区块上即可查看原因:它被自身条件隐藏了,或者它在这份文档中没有值。
点击工具栏中的 显示预览,即可查看与打印完全一致的 PDF。
只有在打印设置中开启 允许打印草稿 或 允许打印已取消 时,才能预览草稿和已取消的文档。
使用该格式
- 在打印页面上,在 打印格式 框中选择它。
- 要将其设为其文档类型的默认格式,请在打印页面上选中它,然后选择 ⋯ > 设为默认格式。
故障排除
| 问题 | 检查什么 |
|---|---|
| 打印时我的更改没有显示 | 点击保存并应用。草稿不会被打印。 |
| 某个字段没有打印出来 | 它的值为空,或者它的条件为假。在预览中悬停在它上面即可查看是哪种情况。 |
| 某个部分从新的一页开始 | 它上方有一个分页符,或者保持在一起已开启,而该部分无法容纳在当前页面上。 |
| 无法选择Typst(快速) | 悬停在PDF 渲染器旁边的信息图标上。它会列出 Typst 无法渲染的内容,例如自定义 HTML 块。请参阅页面设置和 PDF 渲染器。 |
| PDF 中缺少信头页脚 | 在打印设置中开启重复页眉和页脚。 |
相关主题
- 打印文档
- 信头
- HTML 打印格式,用于通过 HTML 和 Jinja 进行完全控制