Adobe FrameMaker 概览

若将一个技术文档拆分为多个模块,则还需要版本、状态和有效性等信息。Adobe FrameMaker提供了哪些方式,用于管理此类元数据?

在编辑工作中,需要在文档中保存附加信息。其任务是提供有关编辑流程的信息。特别是在手册采用模块化结构时,在模块文档中针对具体的版本提供历史信息、版本编号、编辑状态和内容有效性等信息非常有帮助。

若制作以XML为基础的FrameMaker文档,则需将文档的附加信息保存在属性XML结构最上方的元素上。该位置非常醒目,并设定有误操作修改保护。但在使用本地化的FrameMaker文档工作时,为保存文档中的元数据必须有相应的解决方案。

元数据信息采用变量?

对于本地化的FrameMaker文档的标识,多推荐使用用户定义变量。其适于在文本、页眉或页脚中显示其内容。

变量定义在程序中属于功能格式目录。通过该目录可在文档中保存格式定义,通过导入格式可对格式定义进行交换。因此,用户设定的特殊变量定义可能存在被其他定义覆盖的风险。若此类重要信息不应进行更改,则建议这些信息不应包含变量。

图1:在该对话框内可对格式导入的范围进行设置。
SCREEN Adobe/Ute Mitschke

使用文件属性?

在文件属性中可将元数据信息保存在每个Framemaker文档中,这些信息在保存时将导入到PDF中。根据标准,其中已经包含编辑(作者)信息、准确的描述性主题、关键词或版权。若在手册中插入文档并以PDF格式保存手册,则手册文件的文件信息将导入到PDF中。手册各部分的文件信息不会因此改变,但也不会导入到PDF中。

图2:作者可以输入文件信息。
SCREEN Adobe/Ute Mitschke

文件信息适于保存文档中的元数据信息。因为在导入其他格式和文档属性时,原始信息将被覆盖。解决方案并不稳妥,因此不适用。

如果观察FrameMaker文档的结构,在工作页、模板页、参考页上的信息可以采用变量定义或文件信息的形式保存。除工作页的内容外,所有其他页均可通过格式导入访问。每次打开格式导入的对话框时,所有选项均会启用。因此,在编辑时很容易出现一些用于分类和追踪文档的关键信息被覆盖的情况。

在正文文本中附带?

一般情况下,作者希望文档的正文文本仅包含实际的内容。因此,在发布时不会同时输出关于编辑任务的干扰信息。但工作页内容会提供此类信息,因为格式¬导入不会对其进行更改。

可在工作页上添加一个带有附加文本的文本框。例如,文本框可以命名为“元数据”。因此,信息可与正文文本分开。一个文档的正文文本起始部分尤其适于说明元数据信息。因此,编辑可以添加相应的段落格式。以下章节将对过程进行说明。

添加模块描述

段落格式“元数据模块描述”位于正文的第一段,其中对模块的内容进行了明确描述。若需管理FrameMaker手册内的所有模块文件,可直接在手册封面中显示描述信息。

图3:在手册封面中显示描述信息,而非文件名称。
SCREEN Adobe/Ute Mitschke

版本、状态和有效性

下面将对有关产品及其不同型号的版本、状态及有效性进行说明,包括相应的定义格式。通常,对状态和有效性会通过规定的概念进行说明。为不必手动输入这些概念,可将概念输入到其他参考页的文本框内。然后可将概念作为参照添加至元数据信息内。

图 4:在参考页的文本框内保存了预选值。
EEN Adobe/Ute Mitschke

若编辑时当前状态在每页上均显示为水印,则作者可在模板页上插入一个文本框。在文本框中添加正文文本状态段落的参考信息。通过在特殊段落格式的段落中对元数据信息进行明确分类,可在文档中对内容进行任意参照。

所有模块的概览信息

在管理所有模块的手册中,应针对所有模块的所有元数据汇总一个概览表,其中将包括一个段落列表,与目录类似。该列表将按照顺序对所有信息进行列举,说明在手册中出现的方式。

为使该概览具有清晰的结构,针对包含模块元数据信息的第一段,会在段落上方分配一根框线,在我们的示例中为格式“元模块描述EAL”。所生成的内容可放在参考页上,与目录相似。通过<$file¬name>之前<$paratext> 模块的补充内容,会针对相应的信息添加文件名称。这样,模块信息的分类会更为清晰。

编辑处理的原因非常重要

在模块的另外一个表格中将会对编辑历史进行备注。建议不仅包含日期和编辑人员的姓名,还应包含更改模块的原因。

若由于复制此后还将继续使用的模块而生成了一个模块,则还需包含有关原模块的所有信息:复制时的文件名称、版本、状态。

发布时隐藏

为在模块发布时隐藏元数据信息,相关的段落应作为受限文本使用条件格式“元数据信息”进行标注。这样,手册发布时便可对隐藏进行设置管理。同样,在编辑模块时也可根据需要隐藏元数据信息。这种情况下,编辑人员必须注意不要误删除正文文本起始部分标记中隐藏的元数据信息。

XML

模块化是对内容进行再利用和更新的一种适宜工具。同时还可节约翻译成本,因为版本的数量较少。为使文件及其编辑状态处于可控范围内,建议在每个模块¬文件内的正文文本中保存元数据信息。若技术文档采用FrameMaker文件模块化设计,则技术编辑工作需要耗费大量的时间进行编写。通过转换表,FrameMaker可将内容不同的格式文本转换适当的XML结构,而这对将元数据信息直接导入到XML结构中来说非常重要。