使用 DITAVAL 文件
Arbortext Editor 支持在 OASIS DITA Architectural Specification (DITA 体系结构规范) 的 Conditional processing (profiling) (条件处理 (配置文件)) 部分中定义的条件处理。条件处理在 DITAVAL 文件中定义,您可以在发布对话框的 DITAVAL 文件选项中发布 DITA 映射或主题时对其进行指定。Arbortext Editor 也支持在 DITA 映射中引用 DITAVAL 文件,以便文件的条件处理操作在发布期间可应用于所有或部分映射。可以同时使用 DITAVAL 文件和配置文件 (.pcf),但 DITAVAL 文件操作的处理会在应用任意配置文件之前进行。
DITAVAL 文件中所定义的操作均基于分配至下列 DITA 条件处理属性的值:
• audience
• platform
• product
• otherprops
• rev
注意:rev 属性只能用于标记操作。
• props
基于 props 的专用属性也可以用在 DITAVAL 文件中。注意:默认情况下,props 属性不会出现在 Arbortext Editor 的用户界面中。
DITAVAL 文件包含一系列用于在 action 属性中定义条件处理操作的 prop 元素。其中包括下列操作:
• include - 将具有指定属性和值的元素包括在处理中。
• exclude - 从处理中排除具有指定属性和值的元素。
• flag - 在处理期间标记具有指定属性和值的元素。
元素中的文本可用各种不同方式来突出显示、分配颜色和背景颜色,还可以在文本前后出现图形。
prop 元素还包含其他属性,用于定义操作所适用的属性和值以及提供有关所需标记类型的详细信息。有关 DITAVAL 文件的详细信息,请参考 Arbortext Editor 帮助中的 Darwin Information Typing Architecture (DITA) Version 1.2 OASIS 标准。
编辑 DITAVAL 文件
新建文档对话框列出了 DITA Technical Content 类别中的 DITAVAL 文件。可以使用“列”视图在 Arbortext Editor 中对 DITAVAL 文件进行编辑。然而,Arbortext Editor 提供了 DITAVAL 编辑器对话框来帮助您开发 DITAVAL 文件。
以下为 DITAVAL 文件在 Arbortext Editor 中的出现方式:
DITAVAL 编辑器对话框使您可以在不了解文件中所需特定设置的情况下对 DITAVAL 文件进行编辑。该对话框也显示了在发布期间如何处理未在文件中明确定义的条件处理属性的其他值。可通过选取 > 来打开 DITAVAL 文件中的对话框。也可以在 > 子菜单中编辑 DITA 映射或主题时打开该对话框。
以下是相同的文件出现在 DITAVAL 编辑器对话框中的方式:
当在 Arbortext Editor 中编辑 DITAVAL 文件时会出现下列附加菜单选项:
• >
- 使您可以将现有 .pcf 文件中的设置配置文件组导入 DITAVAL 文件。
• >
- 打开当前 DITAVAL 文件的 DITAVAL 编辑器对话框。
• >
- 使您可以选择 DITA 主题或映射并对当前 DITAVAL 文件中所定义的操作进行预览。
在编辑 DITA 主题或映射时会出现下列与 DITAVAL 文件相关的菜单选项:
• > > - 使您可以选择 DITAVAL 文件并对当前文档的文件中所定义的操作进行预览。
• > > - 可使用与当前文档相关联的任意 .pcf 文件中的设置来打开新 DITAVAL 文件的 DITAVAL 编辑器对话框。
• > > - 可通过将 DITAVAL 文件中的设置与任意与当前文档相关联的 .pcf 文件合并来打开现有 DITAVAL 文件的 DITAVAL编辑器对话框。
DITAVAL 文件在用户界面中以下列方式得到了进一步的支持:
• 当使用资源管理器向 data 元素的 href 属性分配值时,会在类型选项中提供 DITAVAL 选项。
• 如果此时选择了 href 属性的 DITAVAL 文件,那么 data 元素的 name 属性也会被设置为值 ditavalref。
• 当将 DITAVAL 文件分配至 DITA 映射时,DITAVAL 引用在映射“列”视图的轮廓列中的标签为 DITAVAL 引用。
• 当打开包含 DITAVAL 引用的 DITA 映射的“用于编辑的已解析文档”时,分配至映射中主题引用的所有 DITAVAL 操作都会被执行。例如,如果某一主题引用将排除操作分配给自己,则在已解析的文档中就不会包括该主题。
• 可将 DITAVAL 引用选为 DITA 文档的增强的完整性检查的一部分。
将 DITAVAL 文件分配至 DITA 映射
可以将 DITAVAL 文件分配至整个 DITA 映射,也可以分配至映射的单个部分。从 topicmeta 元素内的 data 元素中引用 DITAVAL 文件。在 data 元素中,将 name 属性设置为 ditavalref 并将 href 属性设置为 DITAVAL 文件的位置。DITA 引用路径可用于解析 DITAVAL 文件引用。
要将 DITAVAL 文件与整个映射相关联,可将引用添加至映射最高级别处的 topicmeta 元素。要将文件仅与映射的一部分相关联,可将引用添加至映射内的 topicref 元素 (或 topicref 的专门化属性) 中的 topicmeta 元素。此时,DITAVAL 文件将仅适用于主题引用以及任何包含在该主题引用中的主题引用。
在一个映射中可以有一个以上的 DITAVAL 文件引用。如果在多个 DITAVAL 文件中定义的设置不相冲突,就可以执行文件中定义的所有操作。如果在文件中定义的设置有冲突,可通过使用下列规则解决冲突:
• 在发布对话框的 DITAVAL 文件选项中提供的 DITAVAL 文件始终具有较高优先权。
• 分配至整个映射的 DITAVAL 文件优先于分配至部分映射的文件。
• 如果两个 DITAVAL 文件处于映射的同一级别,则映射所引用的第一个文件具有较高的优先权。
data 元素还具有 keyref 属性,所以可以使用 DITAVAL 文件的键引用。
调试 DITAVAL 文件
Arbortext Editor 使您可以预览到在 DITAVAL 预览窗口的 DITAVAL 文件中所定义的操作的效果。对于 DITAVAL 文件来说,您可以通过选取工具 > 。对于 DITA 映射或主题来说,您可以通过选取 > > 来打开当前文档的预览窗口。如果当前文档是 DITA 映射,则会询问您是打开映射还是打开映射的“用于定义样式的解析文档”。
已应用 DITAVAL 规则的显示方式由 ditavaldebug 高级首选项的设置确定。在默认情况下,预览的文档仅显示应用当前 DITAVAL 文件设置的结果。如果将 ditavaldebug 设置为 on,则会在 DITAVAL 预览窗口中显示下列附加信息:
• 在列出了所有用于处理文档的 DITAVAL 文件的文档开始处会插入一个备注。
• 在所有受影响的元素前面会插入一个备注,这些元素可用于描述包括、排除或标记内容的原因。备注包括规则所在的 DITAVAL 文件的位置以及规则的说明。
• 所有被排除的文本都会以带有红色文本和黄色背景的删除线表示。
可以使用此信息来解决 DITAVAL 文件中出现的任何问题。