Arbortext editor详细中文教程

Arbortext? Editor? 教程—关于本教程

Arbortext Editor 教程介绍了关于使用 Arbortext Editor 进行编辑和创作的基本概念。本教程包括常规示例和分步练习，可以在 Arbortext Editor 中尝试这些内容来进行练习。

这些练习涉及两种文档类型：DocBook 和 DITA (达尔文信息类型化体系结构)。对于这些文档类型，某些 Arbortext Editor 功能会有所不同。练习会对不同之处加以注释。 必备知识

以下知识是了解本文档内容的先决条件：

熟悉操作系统及计算机 ? 具有创作或编辑软件的经验

?

本指南的结构

本教程按以下顺序编排：

? ? ? ? ?

结构文档概述 – 结构文档概念的简介

Arbortext Editor 环境 - Arbortext Editor创作环境的概述。 使用 Arbortext Editor 创作 – 有关基本创作任务的练习 使用 DITA 主题 – 介绍 DITA 主题文档创作方法的练习 使用 DITA 映射 – 介绍 DITA 映射文档创作方法的练习

相关文档

有关详细信息，请参考 Arbortext Editor 帮助中心。

结构文档概述

结构化文档符合定义和控制文档结构的一组规则。XML 和 HTML 是结构化文档的实例。

定义文档结构的规则集合称为―文档类型‖。在 Arbortext Editor 中创作文档时，编辑器将持续检查在关联文档类型中定义的规则，并且仅允许将符合这些规则的内容插入到文档中。DocBook 和 DITA (达尔文信息类型化体系结构) 是文档类型的实例。 文档类型定义文档的以下组成部分：

?

可在文档中使用的标记集

标记是结构化文档的基本构建块。标记是一个容器，具有起始标记和结束标记。标记可包含其它标记、属性和文本。段落和列表是标记的实例。

?

与各标记关联的―属性‖

属性提供有关标记的附加信息，属性包含在标记内部。例如，标记可具有一个属性，用于定义标记中的信息适用于何种用户类型。

?

用于排列标记的结构

每个文档类型都有一个单独的标记，该标记包含在文档类型中定义的所有其它标记。文档类型定义该外部标记中包含的标记的层次结构。文档类型也定义标记是可选的还是必需的，及其是否可包含其它标记、文本或二者。

下面是用于写信的文档类型的一个示例：

Letter、Date、Greeting、Body、Paragraph、List、Table 或 Close Letter 文档类型包含以下主要标记：

?

Letter

Letter 标记是文档类型中的外部标记，包含另外七个标记。其中四个标记 (Date、Greeting、Body 和 Close) 是必需的，并且必须以该顺序出现在 Letter 文档中。

?

日期

Date 标记必须是插入到 Letter 文档中的第一个标记。它只能包含文本，并且用于包含日期。

?

问候语

Greeting 标记必须是插入到 Letter 文档中的第二个标记。它只能包含文本。

?

正文

Body 标记必须是插入到 Letter 文档中的第三个标记。它只能包含其它标记，而不能包含文本。Body 标记可包含一个或多个 Paragraph、List 或 Table 标记。Body 可以包含任意数量及任意顺序的这些标记。

?

关闭

Close 标记必须是插入到 Letter 文档中的最后一个标记。它只能包含文本。

样式表

结构化文档的格式并不存储在文档自身中。相反，各种文档类型都具有与其相关联的一个或多个样式表，用于通过一系列样式设置来控制文档的外观。样式设置可包含基本格式化信息，如字体大小、段落间距及页面布局，也可包含更多的高级格式化信息，如目录和索引的自动生成。 通过样式表控制 Arbortext Editor 窗口中文档的外观。

Arbortext Editor 环境

Arbortext Editor 用户界面符合标准窗口约定。下列主题提供了专用于 Arbortext Editor 的外观和功能的概述。 相关链接 打开示例文档

Arbortext Editor 窗口组件 查看光标更改

展开和折叠标记内容 使用拖放操作 删除标记和内容 查看生成的文本 获取帮助 打开示例文档

开始本练习之前，请先启动 Arbortext Editor。

Arbortext Editor 中的大多数文档类型均具有与其相关的模板和示例文档。模板是一组预定义的空标记，这些标记提供文档所需的所有基本标记。在本练习中，您将打开一个示例文档。

1. 选择文件 ? 新建可打开新建对话框。

2. 选择 Arbortext XML DocBook V4.0，然后选中示例复选框并单击确定。

示例文档会显示在 Arbortext Editor 窗口中。请注意，Arbortext Editor 窗口中显示的示例文档可能与以下示例中显示的文档有所不同。

Arbortext Editor 窗口组件

默认情况下，Arbortext Editor 窗口分为两个窗格。―文档结构图‖提供大纲视图，―编辑‖视图显示文档的完整内容。拆分条用于分开―文档结构图‖和―编辑‖视图。可以调整该拆分条来更改窗格尺寸。 下图显示了主要的 Arbortext Editor 窗口组件。

菜单和工具栏

菜单和工具栏会显示一组标准的命令。有关菜单、工具栏及其功能的详细说明，请参考帮助 ? Arbortext Editor 中提供的联机帮助主题。 ―编辑‖视图

―编辑‖视图显示文档及其内容以及控制文档结构的标记。可以使用视图菜单更改这些标记的显示。这些选项用于控制在将内容和新标记添加到文档中时希望看到多少标记结构。以下示例来自 Arbortext XML DocBook 文档类型 (文档中显示的标记可能会有所不同)：

?

完整标记 - 显示标记图标和名称。

?

无标记 — 禁止标记显示。

如果您习惯于在―带标记的视图‖环境中工作 (例如，使用 HTML 文档)，则可能要使用在 Arbortext Editor 中显示的标记。 文档结构图

利用―文档结构图‖可导航文档结构的图形轮廓。也可以折叠文档的较大部分并在―文档结构图‖中移动它们。―文档结构图‖和―编辑‖视图是完全交互的，因此一个窗格中所做的任何更改都会立即反映在另一窗格中。

下图显示了―文档结构图‖组件。

―文档结构图‖包含下列组件：

?

标记图标

元素 - 标识文档中的标记。与标记相关的内容会与图标一起显示。

?

展开和折叠图标

折叠 – 使您能够在文档中折叠标记的内容。 展开 – 使您能够在文档中展开标记的内容。

?

修改属性图标

展开修改属性 - 与某个元素关联的属性的值在映射中处于未打开状态时显示。单击此图标可查看属性名称和编辑其关联的值。

收缩修改属性 - 与某个元素关联的属性的值在映射中处于打开状态时显示。单击此图标可关闭属性值的显示。

?

图形图标

图形 - 标识文档中的图形。图形本身不会出现在―文档结构图‖中，但是可通过单击与图形关联的―修改属性‖图标来获取有关图形的信息。图形将显示在―编辑‖视图中。

?

表格图标

表格 - 标识文档中的表格。―文档结构图‖包含表格的标记，但未将表格显示为行和列。―编辑‖视图中将显示表格的图形表示。

状态栏

位于屏幕左下方区域的状态栏显示与 Arbortext Editor 的界面和操作有关的工具提示和其他消息。

查看光标更改

进行本练习之前，请先在 Arbortext Editor 中打开 Arbortext XML DocBook V4.0 示例文档。 Arbortext Editor 光标会根据其在文档结构图和编辑视图中的位置，来更改外观。按照以下步骤操作以查看某些光标更改：

1. 使用箭头键导航―文档结构图‖。

光标会根据其位置更改形状。 2. 将光标移动到 para 标记的左侧。

I 形光标

表示您可以输入文本和其它可能的标记。

3. 键入以下文本：Inserting text into my document using the Document Map.

在输入时，会自动添加新的 para 标记，以容纳新的文本。 4. 将光标移动到 chapter 标记的末尾。

光标显示为双箭头 5. 键入您的名称。

，这表示不允许在此位置插入任何文本。

一条消息将显示在状态栏上，警告您不允许插入文本。 6. 在 Arbortext Editor 窗口外单击。

光标更改为不活动光标

，这表示窗口未处于活动状态。

有关详细信息，请参考 Arbortext Editor 帮助中的光标主题。

展开和折叠标记内容

进行本练习之前，请先在 Arbortext Editor 中打开 Arbortext XML DocBook V4.0 示例文档。 通过―文档结构图‖，可查看或隐藏标记内容，以便更容易浏览文档。按照以下步骤操作来折叠和展开标记内容：

1. 找到―文档结构图‖顶部的 book 标记。

下图所示为完全展开的 book 标记的层次结构。

2. 单击 book 元素左侧的折叠图标 。

注意，整本书的内容会折叠，但标题会保留，因此您可以识别折叠的内容。折叠图标被展开图标 所代替，如下图所示。

3. 单击展开图标以展开 book 标记。 相关链接

使用拖放操作

进行本练习之前，请先在 Arbortext Editor 中打开 Arbortext XML DocBook V4.0 示例文档。 您可以仅拖放内容，或拖放标记及其内容、空标记，或内容和标记的混合体。可以在以下位置使用拖放操作：

在文档中

? 同一编辑器窗口中文档的不同视图间 ? 在单独文档之间

?

?

在应用程序之间

按照以下步骤使用拖放操作：

1. 在―文档结构图‖中，查找 para 标记。

2. 单击与 para 标记相关的 para 标记 图标，可选择该标记及其相关内容，如下例所示。

3. 单击文本，然后按住鼠标键，沿―文档结构图‖分层结构向下拖动所选文本。

注意光标的变化方式：

o o o

如果移动所选区域导致文档结构冲突，系统将显示此符号：当所选内容定位在有效粘贴位置时，系统显示此符号：

如果释放位置定位在有效粘贴位置，但为了保持正确的文档结构而导致已粘贴内容中添加了一个元素，系统将显示此符号：

4. 在文档中移动光标，直到光标形状如下所示：

5. 释放鼠标按钮，完成拖放操作。

还可以选择 para 标记内的一些文本，然后将该文本拖动到文档中的其它位置。对于此操作，显示的符号与移动标记及其内容时相同。

有关详细信息，请参考 Arbortext Editor 帮助中的拖放操作主题。 相关链接

删除标记和内容

进行本练习之前，请先在 Arbortext Editor 中打开 Arbortext XML DocBook V4.0 示例文档。 可以只删除文本，或删除标记及其内容。按照以下步骤删除标记：

1. 在文档结构图中，单击 para 元素左侧的标记 图标。 2. 按 DELETE 键。

删除元素及其内容随即删除。

3. 单击 Undo 工具栏按钮可撤消删除操作。

您还可以选择 para 标记内的一些文本并仅删除该文本。

有关详细信息，请参考 Arbortext Editor 帮助中的删除标记对主题。 相关链接

查看生成的文本

进行本练习之前，请先在 Arbortext Editor 中打开 Arbortext XML DocBook V4.0 示例文档。 生成的文本根据文档类型的样式表定义并自动插入到文档中。举例来说，目录、索引和列表编号便是生成的文本。生成的文本以不同的字体颜色 (默认为蓝色) 显示，并且不能在 Arbortext Editor 中直接对其进行编辑。按照以下步骤操作以更改生成文本的显示：

1. 选择工具 ? 首选项，并选择窗口类别。

2. 如果未复选完整菜单，请单击该复选框。单击―确定‖。

3. 选择视图 ? 生成的文本 ? 显示可清除所选的内容，并隐藏生成的文本的显示。 4. 上下滚动您的文档，并记下缺少的项目符号、章节号和列表编号。 5. 再次选择视图 ? 生成的文本 ? 显示可恢复生成的文本的显示。

6. 选择视图 ? 生成的文本并记下更新生成的文本可用的选项。验证是否选择了部分自动更新选

项。

7. 按 ESC 键可退出该菜单。

有关详细信息，请参考 Arbortext Editor 帮助中的生成的文本概述主题。 相关链接

12. 选择文件 ? 保存可保存您的更改。

有关详细信息，请参考 Arbortext Editor 帮助中的插入标注和使用快速标记插入标记主题。 相关链接

将结构添加到内容

在本练习中，将使用您在上次练习中修改的 Arbortext XML DocBook 文档。

Arbortext Editor 允许您将段落块转换为项目符号列表或编号列表。按照以下步骤创建编号列表：

1. 将光标置于最后一个 para 标记的右侧。

2. 将新的 para 标记插入您的文档，方法是：按 ENTER 键并从快速标记列表中选择 para 标

记。

3. 输入下列文本，在前三行每一行的结尾处插入新的 para 标记，从而生成四个 para 元素及其

内容：

编号列表可提供逐步指导。

每个项目前有一个编号，该编号由 Arbortext Editor 自动生成。 还将自动确定并应用适当的缩进。

利用结构化内容可减少为保持表示形式一致而手动应用格式的工作量。

4. 选择所有四个段落 (包括 para 标记)，并单击应用程序工具栏上的数字列表工具栏按钮

这四个段落随即显示为数字列表。

。

还可以通过将数字或项目符号列表标记插入到文档并将列表项添加到列表来生成列表。

有关详细信息，请参考 Arbortext Editor 帮助中的创建列表主题。

创建并插入文本实体

在本练习中，将使用您在上次练习中修改的 Arbortext XML DocBook 文档。

实体是您希望能够重复使用的内容块。当实体的内容更改时，包含实体的文档会自动更新。可以根据要重复使用的内容量创建文件实体或文本实体。实体在文档中可以显示为带实体名称的图标或带展开实体内容的图标。

有一些菜单和选项 (如实体菜单)，只有在已选择显示完整菜单时才可用。要显示完整菜单，请选择工具 ? 首选项，选择窗口选项卡，并单击完整菜单旁的复选框。单击确定退出首选项对话框。 注意

DITA 文档以不同方式重复使用内容。有关 DITA 引用的信息，请参考使用 DITA 主题。 按照以下步骤创建并插入文本实体：

1. 选择某一范围的文本。

2. 选择实体 ? 从所选内容创建文本实体。

从所选内容创建文本实体对话框打开。

3. 在名称字段中键入 mytext，然后单击确定关闭对话框。 4. 将光标置于 para 标记内，并选择实体 ? 文本。

文本实体对话框打开。

5. 选择 mytext 文本实体。

6. 单击插入，然后单击关闭关闭对话框。

文本实体随即以图标的形式插入。

7. 选择查看 ? 文本实体可查看已展开的实体内容。

有关详细信息，请参考 Arbortext Editor 帮助中的文本实体概述和文件实体概述主题。 相关链接 插入链接

在本练习中，将使用您在上次练习中修改的 Arbortext XML DocBook 文档。 可以使用 Link 标记从文档中的一个位置链接到另一位置，或链接到 URL。 注意

DITA 文档支持以不同方式链接。有关 DITA 引用的信息，请参考使用 DITA 主题。 按照以下步骤插入指向 URL 的链接：

1. 插入新的 para 标记。

2. 键入有关结构化文档的详细信息，请参考 PTC 网站。 3. 选择单词 PTC website，然后选择插入 ? 链接。

插入链接对话框打开。

4. 选择 Web 选项卡，在 URL 字段中键入 http://www.ptc.com/，然后单击插入以插入链接

并关闭对话框。

5. 双击突出显示的链接以打开 Web 浏览器并显示 PTC Web 站点。

有关详细信息，请参考 Arbortext Editor 帮助中的插入链接对话框和插入链接目标对话框主题。 相关链接 修改属性

在本练习中，将使用您在上次练习中修改的 Arbortext XML DocBook 文档。

节、标题、段落和列表等标记组成了文档的基本结构。属性定义标记的特定方面。添加属性可指定特定属性，如文件引用、放大和字体样式。 注意

DITA 文档允许以不同方式修改某些属性。有关修改 DITA 引用的信息，请参考使用 DITA 主题。 按照以下步骤修改属性以更改字体样式：

1. 选择段落中的任意 1 个词，并按 Enter 键激活快速标记菜单。 2. 选择 emphasis 标记。

单词格式更改为斜体。emphasis 应用到此文档类型中的文本时，斜体是默认字体样式。 3. 选择编辑 ? 修改属性。

修改属性对话框打开。

4. 在角色字段中键入 bold，然后单击确定关闭对话框。

注意，在―编辑‖视图和―文档结构图‖中单词的格式从斜体更改为粗体。

5. 在―文档结构图‖中，单击相应的修改属性 图标以查看为此标记定义的属性列表。 6. 再次单击修改属性 图标可关闭属性列表。

有关详细信息，请参考 帮助中的属性 - 概述Arbortext Editor主题。 相关链接 插入图形

在本练习中，将使用您在上次练习中修改的 Arbortext XML DocBook 文档。

在 Arbortext Editor 中，通过引用将图形包括在文档中。文档包含对外部图形文件（不是图形自身）的引用。 注意

DITA 文档允许以不同方式插入图形。有关 DITA 引用的信息，请参考使用 DITA 主题。 按照以下步骤插入图形并修改图形尺寸：

1. 插入新的 para 标记。 2. 选择插入 ? 图形。

插入图形对话框打开。

3. 选择 inlinegraphic 标记以使图形与文档中的文本走向相一致，然后单击确定。

定位引用图形文件对话框打开。

4. 浏览到系统上的图形文件，或打开 Arbortext Editor 安装文件夹中的 graphics 文件夹并选

择 instrument.jpg，然后选择打开以插入图形。

图形显示在文档中的现有文本旁。

5. 通过单击―文档结构图‖中的修改属性 图标显示与新图形相关的属性。 6. 单击显示的属性可打开修改属性对话框。

7. 在 scale 字段中键入 25，然后单击确定关闭对话框。

图形缩小为其原始大小的 25％。

有关详细信息，请参考 Arbortext Editor 帮助中的插入图形概述主题。 相关链接 插入符号

在本练习中，将使用您在上次练习中修改的 Arbortext XML DocBook 文档。 可以将各种符号插入文档中。按照以下步骤插入符号：

1. 将光标放置在 para 标记中。 2. 选择插入 ? 符号。

显示插入符号对话框。 3. 单击对话框中的符号。

4. 单击插入可在光标位置处插入符号。 5. 单击关闭关闭对话框。

有关详细信息，请参考 Arbortext Editor 帮助中的插入符号主题。 相关链接 搜索内容

在本练习中，将使用您在上次练习中修改的 Arbortext XML DocBook 文档。

Arbortext Editor 提供标准的查找和替换功能。按照以下步骤查找文档中的内容：

1. 选择查找 ? 查找/替换。

将显示查找/替换对话框。

2. 在查找内容字段中键入 structure。 3. 单击查找下一个按钮。

包含 structure 的词的第一个匹配项在文档中突出显示。如果要仅搜索 \一词，可在搜索该单词之前选中全字匹配复选框。 4. 单击取消关闭对话框。

有关详细信息，请参考 Arbortext Editor 帮助中的查找和更改文本主题。 相关链接 搜索标记

在本练习中，将使用您在上次练习中修改的 Arbortext XML DocBook 文档。 除了搜索内容外，还可搜索标记。按照以下步骤查找文档中的标记：

1. 选择查找 ? 查找标记/属性。

12. 以名称 meetingMinutes.dita 保存引用。 完成的―引用‖应当如下所示：

相关链接

术语表

DITA 术语表主题提供单个术语及其关联的定义，使用户可以获得对陌生术语的解释。该主题也提供有关术语的附加信息。如果某术语有多种定义，您应为每个定义都创建一个单独的 DITA 术语表主题。 ―术语表‖包含以下主要标记：

? ? ? ? ?

glossentry - 包含所有其它标记 glossterm - 术语 glossdef - 定义

prolog - 有关主题的各种元数据，如作者、版权、索引术语，等等。 glossBody - 提供有关术语的附加信息

glossBody 标记包含若干其它标记，用于提供有关术语的附加信息，如词性、用途、术语变型等。

?

related-links - 到相关术语的交叉引用链接

以上大多数标记是可选的，因此可以只使用创作主题所需的标记。 相关链接

创建术语表

按照以下步骤创建―术语表‖主题：

1. 选择文件 ? 新建。

新建对话框打开。

2. 在新建对话框中选择 DITA Glossary 并单击确定。

DITA Glossary 模板载入到 Arbortext Editor 窗口中：

3. 在 glossterm 标记中输入以下文本：

Meeting Agenda

4. 在 glossdef 标记中输入以下文本：

A list of meeting activities in the order in which they are to be taken up, beginning with the call to order and ending with adjournment.It usually includes one or more specific items of business to be considered.It may, but is not required to, include specific times for one or more activities. 5. 以名称 meetingAgenda.dita 保存术语表。 完成的―术语表‖应当如下所示：

相关链接

插入节

本练习中，将需要在创建概念主题练习中创建的 prodMeetings.dita 文档。 section 标记使您可以将分区包含到 DITA 主题的正文中。除―术语表‖主题外的所有主题类型都允许在主题正文中包含节。节应当包含与主题直接相关的信息子集。如果要包含在节中的信息可以独立出来，那么应当将其包含在另一主题中。

如果在主题中包含了多个节，各节间不会表示为层级形式。它们是同级分区。节可以有一个可选的标题。

按照以下步骤将节包含到 prodMeetings.dita 文档中。

1. 在 Arbortext Editor 中打开 prodMeetings.dita。

2. 将光标放在 ul 标记之后并按 ENTER 键，以显示―快速标记‖菜单。

3. 在菜单中单击分区以将节插入到文档中。 4. 在 title 标记中输入以下文本：

Remote Meeting Participants 5. 在 title 标记后面插入 p 标记。 6. 在 p 标记中输入以下文本：

If your meeting includes participants who will attend remotely, make sure that you make adequate preparations for those attendees.For example, set up telephone conferences ahead of time, send out the meeting agenda by electronic mail, and so forth. 7. 保存文档。

完成的文档应当如下所示：

相关链接

生成 ID

本练习中，将需要在前面的练习中修改的 prodMeetings.dita 文档。

DITA 标记包含一个用于保存标记 ID 的 id 属性。通过 ID 可唯一地标识 DITA 主题或主题中包含某个标记。必须为所有主题分配一个 ID。第一次保存新主题时，DITA 应用程序会自动为该主题分配一个 ID。对于所有其它 DITA 标记，ID 是可选的。

使用 ID 标识链接或交叉引用的目标。DITA 应用程序还提供一个功能，可为任何 DITA 标记生成 ID。

按照以下步骤为标记生成 ID：

1. 在 prodMeetings.dita 文档中，将光标置于起始 section 标记的右侧：

2. 选择插入 ? 生成 ID。

DITA 应用程序为 section 标记生成一个 ID：

也可以使用生成 ID 3. 保存文档。

有关详细信息，请参考 Arbortext Editor 帮助中的定制 DITA ID 生成主题。 相关链接

工具栏按钮生成 ID。

使用资源管理器

可将以下类型的引用添加到 DITA 主题中：

交叉引用 ? 链接 ? 图像 ? 内容引用

?

为帮助您将这些引用类型添加到文档中，DITA 应用程序提供了资源管理器。资源管理器是一个对话框，可通过其浏览文件系统、内容管理系统或 Internet 以查找要添加到文档中的引用。它包含几个选项卡，可添加上面的所有引用类型：

通过选择视图 ? 资源管理器或选择资源管理器

工具栏按钮来调用资源管理器。某些情况下，在执

行与在 DITA 主题中插入引用相关的编辑操作时会打开资源管理器。例如，在选择插入 ? 图形时资源管理器会出现，驻靠在 Arbortext Editor 窗口的左侧，并且图像选项卡处于活动状态。 有关详细信息，请参考 Arbortext Editor 帮助中的资源管理器概述主题。

添加交叉引用

本练习中，将需要在前面的练习中创建的 prodMeetings.dita 和 meetingAgenda.dita 文档。 使用 DITA 交叉引用可以链接到正在创作的主题内部的内容。交叉引用也可以链接到另一主题、主题内部的标记或外部文档。交叉引用使用 xref 标记。

按照以下步骤将交叉引用添加到 prodMeetings.dita 文档中：

1. 在 Arbortext Editor 中打开 prodMeetings.dita。 2. 选择视图 ? 资源管理器。

将打开资源管理器，并且链接/Xref 选项卡处于活动状态。

3. 选择无序列表 (ul) 中第一个 li 标记中的单词 \。

4. 使用资源管理器浏览器导航到保存先前练习中创建的 DITA Glossary 的文件夹。

本文来源：https://www.bwwdw.com/article/s0v3.html