帮助 > 创作 > 使用标注 > 完整性检查和上下文检查 > 检查完整性
  
检查完整性
可以对文档执行完整性检查,也可根据需要对文档的所有子组件 (如文件实体) 进行完整性检查。 Arbortext Editor 检查以确保文档类型需要的所有组件都存在。创建并编辑文档时,Arbortext Editor 不断检查要进行更改或添加的上下文并提供反馈,以确保创建的文档为有效 SGML 或 XML 文档。但是,当您尝试保存并退出文档时,某些必需的元素可能仍丢失,因为 Arbortext Editor 不要求完整的文档。如果丢失了任何必需的元素,系统将报告一个问题列表。
在此检查过程中,Arbortext Editor 还会寻找各种有关 ID 引用、交叉引用、空元素和丢失必需属性的问题,并检查图形实体的有效性。对于 DITA 文档,Arbortext Editor 在常规完整检查完成后将执行附加增强的完整性检查。此增强的完整性检查包括特定于 DITA 文档的几个附加领域。有关详细信息,请参阅对 DITA 文档执行完整性检查
执行完整性检查
要查找文档中的完整性错误:
1. 完整菜单打开的情况下,选取工具 > 检查完整性
使用带有 -full 选项的 check_completeness 命令包括实体。
如果文档完整,状况栏上将显示一条消息,证明未找到错误。如果 INC 在“编辑”窗口底部的状况栏中突出显示,则表明您的文档不完整,此时将打开完整性检查日志窗口,其中显示相应的错误。
2. 双击完整性检查日志窗口中列出的第一个错误旁的链接。
这样会将光标移动至文档中出现错误的位置。
3. 如有必要,修复该错误。
4. 对窗口中的每个错误重复此操作。
完整性检查日志窗口
完整性检查消息显示在完整性检查日志窗口中。 这些消息分为以下几类:
完整性错误 – 上下文检查错误,例如,元素脱离上下文,以及所需单元丢失
标注错误 - 关于标注不正确的各种错误,例如,标记或属性未声明、属性重复、属性值无效、所需属性丢失、PI 名称无效、文件实体未解析,以及空元素等。
实体引用错误 – 引用未声明的实体和符号
ID 和 ID 引用错误 - 报告丢失的 ID 引用数量以及任何被多次定义的 ID
此类别中的任何错误都包含可调用 ID 和 ID 引用对话框的链接。
空元素 - 可以包含文本但为空的元素。此类别中的任何警告都包含可调用“空元素”对话框的链接。可在文档类型配置文件中取消激活有关空元素的警告。
方案错误 – 对“XML 方案”文档类型的任何标识约束
表格标记错误 – 错误的表格标注,可阻止 Arbortext Editor 将标注识别为表格 (如不含任何单元格标记的行)
表格标注警告 – 错误的表格标注,可能会导致表格出现问题,但不会阻止 Arbortext Editor 将标注识别为表格
Schematron 警告 – 由文档类型的默认 schematron 报告的警告
请注意,DITA 文档还包含其他类别。
完整性检查日志窗口有两个菜单和一个快捷菜单。
文件菜单具有以下选项:
保存 — 将消息窗口的内容保存为 .xml 文件。 如果这是自窗口打开后的第一次保存操作,会要求您选择输出文件名称。
另存为 — 用其他名称将内容保存到输出。
另存为 HTML — 将内容保存为 .htm 文件。
打印 - 打印消息窗口的发布版本。此打印输出将显示当前由视图菜单设置为显示的信息。
关闭 — 关闭消息窗口。
视图菜单具有以下选项:
显示 — 确定在消息窗口中显示的内容的类型:
消息 — 显示所有信息(消息、警告和错误)。
警告 — 仅显示警告和错误。这是默认设置。
错误 — 仅显示错误。
字体大小 — 提供了两个选项,用于更改消息窗口中的字体大小:
增大 — 增大显示字体大小。
减小 — 减小显示字体大小。
在消息窗口中单击鼠标右键时,将出现一个快捷菜单。它具有以下选项:
复制 — 将所选区域复制到剪贴板。仅当在所选区域内单击时,此选项才可用。
跟踪链接 — 如果在消息窗口中右键单击一个链接,并且选择了此选项,则将显示所链接的文档,并且光标定位在源文档中的相应位置。 如果在消息窗口中没有链接,则此选项不起作用。
折叠/展开 — 折叠或展开当前条目。
可能的完整性检查问题
使用检查完整性功能时,应注意以下潜在问题:
如果已经在文档类型配置文件 (.dcf)) 中为图形支持定义了可选的 filename 属性,当该属性没有属性值时,Arbortext Editor 将报告完整性错误。
如果已将别名映射应用于文档,则面板中的元素名称将是别名。
当使用 Equation Editor 编写方程时,虽然方程看起来正确,但仍可能出现解析器错误。这种情况有可能发生,因为当数学文档类型碎片合并到另一个文档类型时,目标文档类型可能具有允许空内容的内容模型。有关详细信息,请参阅 Integrating the Equation Editor in a Document Type
如果 SGML 文档包括在非 Arbortext Editor 中创建的文件实体或在其他位置编辑的实体,则保存文档时,不会将它们规范化。规范化将添加省略的标记,这样标记对将会完整。规范化文件实体失败可能在尝试编辑文档中的文件实体时产生上下文错误或完整性错误。要确保文档规范化和完整,从打开对话框打开文档时选取读取为选项:导入 SGML