好育宝医院 好育宝医院

选择好育宝

开启您的好孕之旅

结构化写作第3部分-工具

发布时间:2023-10-08

如果你有一个简单的场景,比如在微软Word中创建一封信,那么结构化写作不一定依赖工具,而不是写程序。然而,结构化写作通常用于更复杂的场景,例如,如果您在基于XML的编辑器(如XMetaL)中创建数百个主题。因为有各种各样的场景,所以我将把重点放在结构化编写上,因为它适合重用使用DITA用XML编写的技术内容,这需要工具。在这种情况下,我将在较高层次上讨论所需的五个主要工具。

1.XML创作工具

您需要一个XML创作和编辑工具,比如oXygen XML编辑器、XMetaL或Arbortext编辑器。这些工具有一系列的功能和许可结构。

编写架构

DITA(达尔文信息分类体系结构)是一个具有结构化内容的开放体系结构。它允许您用预定义的元素标记内容的所有组件。虽然总的来说有许多不同的元素,但主题的主要元素是任务、概念和参考。例如,我在上一篇关于结构化写作的博文中使用的主题“如何验证包内容”就是一个任务元素。要使用DITA,您需要首先检查您的内容,然后查看它是否符合标准。当内容不适合架构时,也可以使用变体。尽管还有其他内容模型,DITA是最常用的技术编写标准,而XML创作工具支持DITA。

3.文档类型定义(Document Type Definition的缩写)

每条指令都需要一个标题。

步骤必须编号。

如果我们编写一个像下面这样的任务,并使用段落描述,DTD将识别出格式不正确,您将收到一个错误:

如何验证包装内容

打开箱子,找到装箱单。确保内容匹配。

DTD在开发内容时验证结构,因此您将无法执行任何不适合该结构的操作。DTD附带了标准的XML创作工具。您也可以创建自己的或修改现有的,如果您有专业知识,您可能会想这样做。

4.样式表(XSLT)

样式表或XSLT(可扩展样式表语言转换)

定义每个元素的格式和输出类型。标准的XML创作工具带有样式表,但是您可能希望修改它们以包括公司的风格标准。例如,如果您想将编号步骤的字体更改为Calibri 11磅,您可以在样式表中定义它。

5.组件内容管理系统

与独立文档不同,以XML格式创建的文档可能包含数十或数百个较小的XML文件,这些文件通过创建DITA映射来汇总。所有这些小XML文件都需要在组件内容管理系统(CCMS)中存储和管理。每个文件都可以在许多不同的文档和输出中重用。CCMS管理每个文件的生命周期。有许多不同功能和成本的CCMS选项。

结论

结构化XML编写中使用的五个主要工具是XML编写工具、DITA编写架构、DTD、样式表和内容管理工具。在本系列的下一篇博文中,我将详细解释如何使用DITA创建可重用的内容。

结构化写作第3部分-工具

和您一起,孕育新生命
用心倾听,专业解答。我们随时为渴望生育的您提供帮助,竭尽所能开启您的好孕之旅。