结构化写作第5部分-应用DITA元素


2018-11-08 08:35:47

假设您已经完成内容审核以确定应该重复使用内容的位置,您已经选择了工具,现在您已准备好使用DITA以XML格式开发内容。我将最后几篇博客文章的各个部分放在一起,并分享将DITA元素应用于内容时的样子。我还将介绍如何解释主题变化以及为什么要开发信息模型。

应用DITA元素的示例


翻译写作

我们来看一个例子。基于内容重用的概念和组织有意义的最小块的内容,假设我们有一个名为“如何验证包内容”的主题,它有一些简单的部分。这个主题应该在三种不同的产品中相同,因此我们决定将其作为自己的主题并在所有三种产品中重复使用。该主题包含说明,因此我们希望将其作为任务信息类型。在<task>元素中,可以使用20多个其他元素来构造任务内容。我们决定在介绍段落中使用<context>元素,对过程使用<steps>,在结果中使用<result>。以下是我们的示例中结构类型,内容和关联的DITA元素的外观:

结构类型

内容

DITA元素

标题1

如何验证包装内容

<任务>(标题)

介绍段落

在开始之前验证包内容。

<上下文>

(程序)

步骤1

第2步

第3步

打开盒子。

找到装箱单。

将内容与装箱单进行比较。

<步骤>

结果

结构化写作第5部分-应用DITA元素

现在你已经完成了验证包内容的工作。

<结果>

使用条件属性计算主题变体


翻译写作

使用上面的示例,假设我们有第四个产品(产品D),其说明是相同的,只是有一个额外的步骤。您仍然可以通过在XML创作程序中设置条件属性(其中一个是product)来重用该主题。在这里,您可以添加不同的产品。然后,当您对内容有一些变化时,可以将产品条件属性应用于特定元素。发布产品内容时,重复使用的主题将与特定产品内容一起显示。

因此,DITA为您提供了处理异常的灵活性,这确实有助于构建内容重用案例,并再次降低了创作和翻译成本。

验证结构

DTD(文档类型定义)是一组验证结构的标记声明。当您使用XML创建内容时,DTD将检查结构规则,如果您尝试执行不属于规则的某些操作,则会出现错误。XML创作程序附带DTD。

记录信息模型中的元素

有许多DITA元素,通常有多种方法来定义结构,因此您应该与团队一起确定如何构建内容。例如,在完成此过程后,您可能会发现只使用了20-30个元素。您在如何构建内容时所做出的决策应该在称为信息模型的文档或Web输出中捕获,以便编写者始终如一地创建内容。信息模型应包含要使用的元素,描述,上下文和示例。

结论

将DITA应用于内容的过程涉及制定内容重用决策,然后使用DITA元素编写内容。在本系列的最后一篇博文中,我将讨论发布XML内容。