设计文档模板

文档模板定义报告的结构、布局和内容。创建成功的模板需要对该模板进行规划、开发、测试和存储。

过程

如果您提供模板以供在集成应用程序中使用,请参阅创建报告以在集成应用程序中使用场景。

支持概念
要创建文档模板,请完成以下步骤:

1:收集需求

不同的需求需要不同的设计。在开始设计模板之前,确定文档的业务需要和实际需求。

数据元素
有多种模板元素,它们显示不同类型的信息。将要查看文档的人员需要哪些信息?当您了解这些内容后,就可以开始确定数据元素:
  • 哪些模板元素显示该数据?它在最终文档中将显示为什么样?
  • 是否有多种方式可显示该信息?如果是,那么哪种显示最适合于查看文档时所在的上下文?
  • 需要多少数据?您可以过滤出不必要的数据,从而在生成报告输出时节省时间。
输出类型
考虑哪种输入类型能够最好地满足将查看文档的人员的需求。使用不同输出类型生成您设计的模板时,该模板的外观可能有所不同。某些元素进行了优化以使用特定格式显示,而某些元素不支持使用特定格式。请熟悉模板元素使用不同输出格式时显示的方式。这使您可以选择可产生最佳组合效果的元素和输出类型。
一个模板与多个模板
这是单次使用的模板,还是可以将其中某些部分复用在其他模板中?
  • 一个模板:可以使用一个模板来包含文档设计的所有不同部分。这表示所有内容都在同一位置,并且不需要合并。
  • 多个模板:可以使用模块化方法,即创建多个模板,然后可以将它们合并在一起以创建一个完整的文档。例如,可以具有目录模板、封面模板、数据模板、索引模板和封底模板。可以复用这些模板以生成不同的文档。
根据这些需求,确定所需的模板数。可以在元数据属性中对每个模板块进行命名和描述。名称内容显示在模板中,而描述内容显示在模板元素提示字段中。
查看上下文
某人将如何查看此文档?
  • 是否将打印此文档?是否在屏幕上查看?是否两种操作均进行?
  • 是否将在集成产品中运行此文档?
支持概念

2:设计模板

设计模板时,以下策略可以帮助您高效地使用时间。
  • 可以将模板设计为提供特定的页面布局属性,例如最可能用在文档中的段类型的页面大小、方向、页边距、列数和样式。
  • 模板可以包含:
    • 文档结构元素,例如段、表、列表和目录。
    • 文档布局块,例如主控页、样式表、页眉和页脚。
    • 用户定义的内部和外部样式,例如文本或段落格式。文本格式包括粗体、斜体、下划线、字体大小和字体颜色。段格式设置包括页边距、边框、缩进以及 JavaScript 格式的脚本编制参数。
    • 嵌入式模板内容,例如图像、静态文本以及对静态文件和样式表的引用。
    • 数据元素,例如属性、条件和动态数据元素。
    • 查询和过滤器格式的数据抽取。
    • 在运行时接收值的外部变量和用于计算的内部变量。比起在模板中对数据源 URL 进行硬编码,创建外部变量是更好的选择。如果您对 URL 进行硬编码而服务器名称发生更改,那么您必须更新每个模板中的 URL。使用外部变量,就可以在运行时覆盖 URL。对于嵌入在其他产品中的模板,请使用这些产品引用数据时可识别的特殊变量。
  1. 启动 Document Studio。
  2. 从头开始或根据现有模板创建新模板
  3. 添加数据源模式
  4. 添加元素
  5. 向元素添加格式设置
  6. 定义动态内容
  7. 可选:使用过滤器、排序或条件来优化数据

3:测试模板

  1. 运行验证工具。
  2. 生成预览。

4:存储模板

后续步骤

创建并测试模板之后:

反馈