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

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

2018-11-08 08:54:10

如果您有一个简单的场景，比如在Microsoft Word中创建一个字母，那么结构化编写不一定依赖于工具，而不是编写程序。但是，结构化编写通常用于更复杂的场景，例如，如果您在基于XML的编辑器（如XMetaL）中创建了数百个主题。由于存在 各种各样的场景，我将重点关注结构化编写，因为它适用于使用DITA在XML中编写的重用技术内容，这需要工具。在这种情况下，我将高层讨论所需的五个主要工具。

1. XML创作工具

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

2. 编写架构

DITA（达尔文信息类型化架构）是一种结构化内容的开放式架构。它允许您使用预定义元素标记内容的所有组件。虽然总体上有许多不同的元素，但主题的主要元素是 任务， 概念和 参考。例如，我在之前关于结构化写作的博客文章中使用的“如何验证包内容”主题 是一个任务元素。要使用DITA，首先需要 审核您的内容然后看看它是如何符合标准的。对于内容不适合体系结构的情况，您也可以使用变体。虽然还有其他内容模型，但DITA是最常用的技术编写标准，而XML创作工具则支持DITA。

3. DTD

DTD（文档类型定义）是一组标记声明，用于定义哪些结构有效。例如，假设我们决定执行以下任务：

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

2. 步骤必须采用编号格式。

如果我们像下面的示例一样编写任务，并使用段落形式的说明，DTD将识别格式不正确，您将收到错误：

如何验证包装内容

打开包装盒，找到装箱单。确保内容匹配。

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

4. 样式表（XSLT）

样式表或 XSLT（可扩展样式表语言转换）

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

5. 组件内容管理系统

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

结论

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