Oxygen XML 编辑器教程

2025年3月17日 | 阅读11分钟

Oxygen XML 是市场上广泛使用的 XML 编辑器工具。它包含各种 XML 创作和开发工具。它能够容纳从初学者到 XML 专家的大量用户。由于它基于 Java 应用程序，因此可以在多个平台（如 Windows、Mac OS X 和 Linux）上使用。Oxygen XML 编辑器可以与基于 XML 的技术结合使用。它还包括用于创建、编辑和发布 XML 文档的各种强大工具。

Oxygen XML 的功能

以下是 Oxygen XML 的功能：

单源发布：它可以使用相同的源以各种格式（如 HTML、PDF、ePUB）生成输出。它包含一个标准的 DITA Open Standard 工具包，可将 DITA 映射转换为最终输出。
结构化 XML 编辑：Oxygen XML 编辑器提供了 XML 编辑功能和用户友好的界面，可以提高工作效率。
XML 发布框架：它为 DITA、DocBook、XHTML 和 TEI 等框架提供了现成的支持。它支持 DITA XML 文档，并允许用户通过可视化界面编辑 DITA 文档，而无需深入了解 XML。
可扩展的 XML 编辑器：它有助于增强 XML 编辑器的内置 XML 发布框架，也可用于创建自己的框架。它使用 **文档类型关联** 概念，为框架提供现成的支持。此概念为最流行的 XML 框架提供了内置支持，并为自定义用户定义的框架提供了支持。
连接性：它还提供强大的连接性支持，允许您与 XML 数据库、内容管理系统和 WebDAV 进行交互。
所有 XML 标准支持：Oxygen XML 编辑器支持所有 XML 标准。该编辑器提供的专用视图和操作允许您编辑所有类型的 XML 文档。

Oxygen XML 编辑器的安装

以下是安装 Oxygen XML 编辑器的步骤：

步骤 1：导航到网站 https://www.oxygenxml.com/。单击此链接后，屏幕将显示如下：

步骤 2：在屏幕上，我们可以看到“产品”选项出现在菜单栏上。鼠标悬停在“产品”上时，会出现如下下拉菜单：

步骤 3：我们要使用的工具是 Oxygen XML Author。导航到 Oxygen XML Author。导航到 Oxygen XML Author 后，屏幕将显示如下：

步骤 4：首先，我们下载试用版软件。因此，我们选择菜单栏上出现的“获取试用版”选项。单击此选项后，我们将获得如下屏幕：

步骤 5：为了获得试用版许可证密钥，我们需要填写**上述截图**中显示的信息。

步骤 6：填写完表单后，屏幕将显示如下截图：

步骤 7：我们要下载 Oxygen XML Author 工具。因此，我们单击 Oxygen XML Author 下方出现的“下载”选项。单击“下载”选项后，屏幕将显示如下：

步骤 8：单击上述屏幕中的“下载”选项后，将下载 OxygenAuthor-64bit.exe 文件。

步骤 9：单击 OxygenAuthor-64bit.exe 文件，屏幕将显示如下：

步骤 10：单击“运行”，安装过程将开始。

步骤 11：选择语言，然后单击“确定”按钮。

步骤 12：单击 **运行**。

步骤 13：单击 **是** 按钮以允许应用程序进行更改。

步骤 14：单击 **是** 按钮后，屏幕将显示如下：

步骤 11：选择语言，然后单击“确定”按钮。

步骤 15：单击 **下一步**。

步骤 16：选择“**我接受协议**”选项。

步骤 17：单击 **下一步**。

步骤 18：选择 **目标目录**。

步骤 19：选择“开始”菜单文件夹。

步骤 20：选择要创建的文件关联。

步骤 21：单击 **下一步**，设置将开始安装，如下所示：

步骤 22：安装过程完成后，我们单击 **完成** 按钮。

什么是 Dita？

在了解 Dita 之前，我们应该了解结构化内容。结构化内容是遵循预定标准的内容。符合预定标准的内容对系统和应用程序是可理解的。Dita 是一种独特的结构化内容。Dita 专为优化技术文档的发布而设计。

什么是结构化写作？

结构化写作是一种技术写作形式，它使用和创建技术文档。技术写作的特定目标是解决用户的特定问题。作为技术作者，我们需要组织和组织内容，以便能够轻松满足客户的需求。

Dita 有何不同？

大多数系统将内容组织为文档或页面，并且这些文档以线性方式编写。其中的思想相互交织并重叠。但是 Dita 的组织和编写方式不同。Dita 内容按组件部分（主题）组织，主题按映射（map）理想地组织。它存储在组件内容管理系统中。组件内容管理系统允许您在组件级别而不是文档级别管理、组织和发布内容。这与大多数系统有巨大区别。典型的系统内容包含纠缠不清的思想，难以分离。但 Dita 使用主题和映射来构建文档。主题是回答单个问题的内容块，它是自包含的且模块化的。与典型内容系统中的纠缠文档不同，文档中的每个主题都贡献了一个独特的思想。我们可以将主题视为大型文档的构建块。有了这些构建块，内容策略师就可以构建文档并轻松重用或重新排列其内容。

主题有三种主要类型：

概念：概念主题非常通用，用于描述性信息、扩展定义和概念性信息。
任务：它提供任务的逐步说明。
参考：它提供产品的规范，如产品部件、环境规范、命令、API 信息。

DITA 映射

Dita Map 为一组主题提供目的和顺序。例如：如果我们把一个旅行者想象成要进行一次穿越全国的公路旅行，我们可能知道沿途的一些地标。但我们需要一张地图，它能提供方向、距离、地标的顺序和整个周围的地形。一张地图为一系列地标提供目的和顺序。同样，Dita Map 为一组主题提供目的和顺序。Dita Maps 在最终的交付物中提供顺序、层次结构和导航（类似目录）以及跨主题链接。作为内容创作者，我们是地图绘制员，而读者是旅行者。我们创建的地图可以引导旅行者完成旅程。一张地图引导旅行者从 A 点到 B 点，并在这两个点之间提供相关信息，按正确的顺序排列。同样，公路地图对于成功的公路旅行至关重要，而 Dita Map 对于发布内容也至关重要。正如我们已经讨论过的，Dita Map 用于优化技术文档的发布。Dita Map 与其他技术沟通方法不同。Dita 不是格式化您创建的内容，而是自动格式化发布的内容。Dita 内容可以以各种格式发布，如门户、PDF、移动应用程序、网站等。借助 Dita，多渠道发布就像按一下按钮一样简单。使用简洁、自包含主题的原因是它允许您重用内容。这里的重用内容不是复制粘贴。当我们重用一个主题时，意味着我们引用了一个主题，而不是复制它。在 Dita 中开发的内容构建在一个框架中，该框架允许内容增长、演变并满足组织的需求。非结构化内容是使用 Microsoft Word 等创作工具开发的；在这种情况下，您组织的增长意味着您的工作量和复杂性的指数级增长。

在 Dita 中创作

作为一名技术作者，我们需要用 Dita XML 编写一些文档。Dita 基于各种信息类型，如任务、概念和参考。如果我们正在创建软件文档，那么我们主要使用任务主题类型。任务是我们提供给用户的指令集。内容的一部分将是架构或概念信息，这里的概念信息包括我们提供给用户的特性和功能。这种类型的信息被写入概念主题类型。那些已经知道程序并想了解权限类型信息的则选择参考主题类型。

作者必须遵循严格的写作规则。如果我们不遵循严格的规则，那么内容将无法得到妥善的组织和结构化。作者必须遵循预定义的标准，以便内容能够得到有效的组织。

我们编写的内容必须分成组件，以便内容可以被重用。

如何使用 Oxygen XML 编辑器编写 Dita XML。

指令

To use the calculator app, you need to unlock your phone first.
You can use a calculator app on your smartphone. You will find it useful, when you need to quickly calculate some numbers. 
To start the application:
  1. Navigate to the Calculator application icon.
  2. Tap the icon. 
The application starts. 
You are now ready to calculate with it.
For example, if you have purchased a book for 5$ and you have given 10$, how much change should you expect? Answer is 10-5=5 $ change.

现在，我们必须创建上述指令的文档。以下是用于创建文档的步骤：

步骤 1：转到项目 -> 新建项目。

步骤 2：输入项目名称并选择要存储项目的路径。

步骤 3：项目文件夹创建后，我们将创建一个 Dita Map。转到文件 -> 新建 -> Dita Maps。

正如我们在上面的屏幕中观察到的，“demo maps”已被创建。现在我们有了一个可以组织和构建 Dita 主题的地方。

步骤 4：要创建 Dita 主题，请转到文件 -> 新建 -> 主题，如下所示：

步骤 5：在主题中，我们必须执行一些任务。因此，我们将创建一个新任务。转到文件 -> 新建 -> 任务，如下所示：

单击 **创建** 后，将创建一个名为“**demo task**”的任务，如下所示：

步骤 6：到目前为止，我们已经创建了一个映射和一个 Dita 主题，但两者没有相互关联。为了将每个主题与映射关联起来，我们需要创建一个引用。打开 Dita Maps 的上下文菜单，然后导航到“附加子项”并单击“引用当前编辑的文件”，如下所示：

下面的屏幕询问我们希望为其创建引用的主题。在下面的屏幕中，url 和 id 中已显示 **demo task**，如下所示：

步骤 7：单击 **插入** 和 **关闭** 按钮。

正如我们在下面的屏幕中观察到的，“demo task”已成为“demo maps”的子项。

让我们看一下 Dita Map 的 XML 代码。打开 Demo maps 的上下文菜单，然后单击“在编辑器中打开映射”。

Dita Map 的 XML 代码如下：

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE map PUBLIC "-//OASIS//DTD DITA Map//EN" "map.dtd">
<map>
    <title>demo maps</title>
    <topicref href="demo_task.dita"/>
</map>

上面的代码代表了一些基本的 XML 元素。Map 由 `` 元素表示。在 `` 标签下，有一个 `title` 标签表示 Map 的标题，而 `` 是从 Map 到 Dita 主题的引用。

现在我们将转到 demo task，在那里我们将编写文档。在编写文档之前，我们单击菜单最左侧出现的下拉菜单，如下所示：

步骤 8：单击 **完整标签和属性**。

屏幕将显示如下：

注意：始终建议打开“完整标签和属性”选项，以便我们知道自己在 XML 文档中的位置。

根据 Dita 规范，我们应该向用户提供最重要的信息。在编写所有说明之前，我们应该首先在主题开头提供先决条件，如下面的屏幕截图所示：

如果我们将先决条件部分放在正文的中间或末尾，则会导致错误。因为 DITA 保证文档以结构化的方式呈现。

现在我们将使用段落标签描述任务。

下一步是创建执行任务的步骤。

所有步骤都指定后，最后一个任务是指定结果信息。结果信息始终出现在步骤之后，并在结果元素中指定，如下所示：

示例信息剩余，因此我们在文档的最后提供示例。由于 DITA 提供了一个内置的示例元素，因此我们在该元素内提供示例，如下所示：

现在还剩下我们主题的两个最重要元素，即标题和简短描述。此文档的标题将是“如何启动计算器”。在简短描述中，我们将说明为什么我们要阅读此特定主题。我们将提供简短描述为“在这里我们将提供有关如何在手机上启动计算器应用程序的信息”。

在提供标题和简短描述方面做得出色非常重要，因为这是最终交付给用户时首先出现的内容。用户首先查看 **标题** 和 **简短描述**，因此有必要在标题和简短描述中提供有意义的信息。

我如何从 Dita 获取内容？

由于我们以 XML 格式编写文档，但 XML 内容不是可以显示给用户的实际格式。我们需要应用某种类型的转换，将 XML 内容转换为其他格式，如 HTML 或 PDF。让我们了解如何应用转换。Oxygen 编辑器内置了将 XML 格式转换为其他格式的转换场景。我们可以触发 Dita Map 上的转换，而不是 Dita Topic 上的转换。

转换步骤

以下是转换内容所需的步骤：

首先观察 **Dita Maps Manager** 中的两个按钮。
在应用转换之前，我们需要配置转换场景。这里的配置转换场景意味着我们需要选择我们想要的格式，如下所示：

在上面的屏幕中，我们可以观察到“配置转换场景”中可用的不同格式。
假设我们要从 XML 格式生成 PDF 文件。选择 Dita Map PDF 并单击“应用关联按钮”。