Documentation Center

主题

主题旨在代表独立的逻辑信息单元,可单独创建、存储、管理、分发和重复使用。 主题具有不同的类型。这对您可以编写的内容以及如何编写内容有直接影响。

什么构成了主题?

作为一般规则,主题应具有标题,并包含可单独理解和在多个上下文中使用的信息。它应该足够短,能够处理一个主题或回答一个问题,但长度应足以使其本身有意义,并被作为独立的单元撰写。尽管如此,主题也可以仅包含标题,并用于整个出版物中的特定功能,例如将目录中的其他子主题分组。

标准类型

标准主题类型是由 DITA 标准定义的主题类型。应用范围最广的三种标准类型以及您最可能遇到的类型如下:
  • 概念:在概念主题中,您可提供有关事物通常的运作方式的解释。这些主题包含您的内容的理论方面。概念非常灵活,允许使用表格、图像、列表等。您可以在概念中使用部分来创建内容结构。但是,您只能使用一个级别的部分(一个部分中不能再包含部分)。
  • 任务:在任务主题中,您可提供过程和操作。这些主题通常遵循概念主题,因为它们描述了您的内容的实用方面。任务是最受限制的主题类型之一:您只能列出操作步骤以及可选的步骤选择和结果。它仍然允许在主题开始时进行上下文演示,也允许提供前提条件列表。

    技术文档通常涉及用户如何执行操作,因此任务主题往往是文档的主干。

  • 引用:在引用主题中,您可提供完整项目列表以供引用。这些主题是内容的词典部分,可以是包含定义的术语列表、错误代码表格、兼容软件列表...引用是一个灵活的主题,您可以在其中按照自己喜欢的方式使用表格、列表和其他分隔结构构建内容,如部分或“定义列表”结构。但是,当您开始使用一个结构时,必须在整个主题中坚持使用该结构。

这些标准类型可以进一步专门用于专用标准主题类型或自定义主题类型。

自定义类型

每个组织都可以创建自己特定类型的主题、构建模板,来确定主题中应使用的内部结构和强制元素。

主题由许多不同元素组成,每个元素都具有特定的功能:标题、段落、列表、任务步骤、前提条件、表格等。因此,根据内容的特定应用程序,您的组织可以定义:
  • 使某些元素在主题中成为强制或禁止元素的样式表。
  • 将生成以特定元素填充的主题的模板。

例如,贵组织可以定义一个模板,用段落、图片和表格填充新主题,并禁止使用任何其他元素。在这种情况下,任何作者都必须将内容调整为允许的格式,在这种情况下,不允许创建部分、任务步骤或新主题中已有元素以外的任何元素。当然,样式表和模板也可以更加灵活。

这就是为什么当您创建主题时,需要知道您应该根据必须添加的内容类型选择哪种类型的主题。如果您在创建主题并开始在其中写入内容后意识到,您的内容与类型不匹配,则除了删除此主题并创建具有正确类型的新主题之外,没有其他解决方案。

主题标题

对于主题对象,标题属性与将在已发布输出中显示的标题相关,但与之不同。发布的标题来自主题内容中的标题元素,而不是属性的值。首次创建新主题时,您输入的标题属性也用作主题内容中的标题,但从那时起,它们不连接,并且标题属性和主题标题可能不同。断开连接时,可以更高效地管理存储库中的主题。