使用仓库式文件夹和仓库式topic
避免文档管理混乱,不要在仓库式文件夹和仓库式topic中直接维护所有能重用的内容。
在能重用的map中组织仓库topic,并把那些map与<mapref processing-role=”resource-only”>合并到你的map中。
定义文件和ID的命名规则
即便大多数DITA编辑工具会自动给可重用的元素分配一个ID,但最好还是人为地去设这个ID,以便大家辨识。这么做的不利因素是:ID冲突的几率较大。要避免这种冲突,可以做以下两件事:
- 为ID创建一个命名规则,以便大大降低ID冲突的可能性。
- 建立一个清除器用来检测ID,以便快速判断ID是否唯一。简单来讲,它可以是一个共享的电子表格,甚至是一个文本文件。如果必要,也可以做得复杂得多。
- 在仓库式文件夹中使用一个map来验证新增加的可重用的元素。验证器会标识重复的ID。在提交到你地CCMS系统或者源头控制系统之前,来做这个校验,能让你地管理更有效。
保证你的topic和元素都是可以重用的
上一课已经讲解了创建重用topic。课程中提到即便在英语内容中使用conref没有问题,但在这些内容被翻译出来时可能会有问题。
- 不要使用包含有<ph>元素的conref来代替句子的一部分。
- 当用conref来重用一整句话的时候,要特别小心。
- 当你用conref的时候,这一整块元素需要满足以下要求:
-
重用的内容是语法上独立的。
-
被引用元素和引用元素使用相同的上下文。
-
交流意味着一切
在修改仓库式topic之前,确保你自己清楚这些topic以及它们的内容用在何处。有些内容管理系统里有工具能帮助找到所有引用的topic或map。
所有相关人员都应该参与共享内容的修改。你可能会发现,要满足所有共享内容的适用场景,需要为这些内容创建单独的版本。你应当避免修改共享内容而破坏文档,或引入谬误。
练习
- 打开文件samples/conrefs/t_watching_wild_ducks_start.dita。
- 在前提条件里的第一段,在topic文件samples/conrefs/c_duck_safety.dita唯一的一段里创建conref。
- 根据文件samples/conrefs/t_watching_wild_ducks.dita检查你的文件samples/conrefs/t_watching_wild_ducks_start.dita。