帮助:有效使用标题

来自 ArchWiki

本文旨在帮助 wiki 作者和编辑创建有效的文章,并扩展 ArchWiki 读者的体验。

您无需知道如何编辑 wiki 页面即可阅读本文。本页是更通用的风格指南,而不是 技术编辑 HOWTO

关于文章标题

标题标记新章节的开始。章节可以树形形式组织,一些章节嵌套在其他章节中。为了反映章节结构,标题可以采用不同的格式。章节和相应的标题根据它们相对于其他章节的位置划分为不同的级别。

本文中使用的术语

一个包含在另一个章节中的章节被称为比其容器(或父章节级别更低。因此,父章节的级别更高

每个标题及其文本跨度到下一个相同级别的标题都称为副标题

副标题具有数字,用于描述它们在树中的级别。级别较高的副标题数字较低,反之亦然。例如,ArchWiki 上的文章标题是1 级副标题

标题和副标题的使用

标题和副标题有几个重要的用途

  • 它们放慢读者阅读速度,以便更好地吸收信息
  • 它们将文章的各个部分分组为逻辑单元
  • 它们标记重要的文本片段

放慢读者阅读速度

在向读者介绍您的主题时,您必须知道,即使是最短的文章也需要一些时间才能读完。标题可以作为缓冲区,在读者阅读以下章节之前放慢他们的速度。这种减速让读者思考内容,并为接下来的文本做好准备。

将段落分组为子主题

大多数时候,您的文章不会只处理一个主题,您需要访问一些或多或少相关的主题,以便解释和扩展您的主要主题。当读者尝试浏览文章时,此类访问可能会令人困惑。因此,您需要为此类偏离发出信号。

标记重要部分

有时,读者只想浏览目录 (TOC),以识别文章中特别感兴趣的部分。他们也可以通过查看标题本身来做到这一点。在这两种情况下,明确定义的标题都服务于快速识别文章重要部分的目的。此外,TOC 是通过自动列出文章中的副标题来创建的。

关于标题级别

在讨论标题级别时,有一些重要事项需要注意。

相同级别的标题应具有相同的意义

这听起来可能是不言自明的,但它并不像看起来那么简单。考虑以下示例

  • 导言
  • 步骤 1:安装 X
  • 步骤 2:编辑键盘设置
  • 步骤 3:编辑鼠标设置
  • 步骤 4:编辑显示设置
  • 步骤 5:添加 fglrx 选项
  • 步骤 6:启动 X
  • 结论

如果您仔细分析此列表,您会注意到步骤 2 到 4 实际上不如步骤 1 和 6 重要,而步骤 5 最不重要。这并不是说所有这些步骤的文本都比其他步骤多或少。重要的是概念上的意义。

为了修正这一点,我们将修改标题,如下所示

  • 导言
  • 步骤 1:安装 X
  • 步骤 2:配置 X
    • 步骤 2a:编辑键盘设置
    • 步骤 2b:编辑鼠标设置
    • 步骤 2c:编辑显示设置
      • 步骤 2c-1:添加 fglrx 选项
  • 步骤 3:启动 X
  • 结论

如您所见,我们将步骤 2 到 4 合并为一个标题,标题为配置 X,并将该标题分为 3 个子标题。此外,我们将步骤 5 附加到步骤 2c,并将其转换为子标题。

顶级标题应始终为最高级别

这听起来也像是常识,但有一个小问题。标题具有与之关联的格式样式。许多人使用这些关联的格式规则来操纵文章的外观。这反过来会产生损坏的标题结构。

让我们看一下这个例子

  • 导言
  • 步骤 1
  • 步骤 2
  • 步骤 3
    • 结论

文章的作者认为 1 级标题对于像结论这样不重要的章节来说太大了,最好使用 2 级标题。这导致标题结构使最后一个章节比其他章节低一个级别。正确的结构应该是

  • 导言
  • 步骤 1
  • 步骤 2
  • 步骤 3
  • 结论

结论现在与文章的其余部分保持一致。

注意:导言结论这样的章节与文章主体具有相同的重要性可能看起来有些别扭,但这些章节实际上很重要。最好在文章末尾添加注释(像这样的注释),或者完全排除措辞不当或缺乏的章节,而不是将它们降级为较低级别的标题,并为了美观问题而破坏文章的逻辑结构。

标题结构的类型

根据使用的级别数量及其用途,标题结构可以分为以下几类

  1. 单级结构
  2. 伪多级结构
  3. 多级结构

单级结构

在撰写文章时,最直接的方法是将其分为几个步骤。这些步骤不一定是真正的步骤,读者需要采取的步骤。它们可能是作者在撰写文章时采取的步骤。在任何情况下,这些步骤都彼此跟随,并以单级结构排列。

这种类型的典型设置可能如下所示

  • 导言
  • 步骤 1:执行此操作或彼操作
  • 步骤 2:清理
  • 步骤 3:故障排除
  • 延伸阅读

这是一个简单的 3 步 HOWTO,带有导言和参考文献的示例。

伪多级结构

有时,需要偏离简单流畅的单级结构。

旁注

通常,您需要短暂地偏离主流程以详细说明某些内容。

  • 导言
  • 步骤 1:执行此操作或彼操作
    • 关于配置 XYZ 的注释
  • 步骤 2:清理
  • 步骤 3:故障排除
  • 延伸阅读

将此视为通过 Note 模板 添加注释和评论的替代方法。

标记辅助信息

也许您想为某些重要部分添加标记,这些部分充当主要讨论的附加论点,或者以某种其他方式增强主要讨论。

  • 导言
  • 步骤 1:执行此操作或彼操作
    • 这是示例代码
  • 步骤 2:清理
    • 这是示例代码
  • 步骤 3:故障排除
    • 这是示例代码
  • 延伸阅读

多级结构

多级结构是较长、更深入的文章的典型特征。但是,它也可以有效地用于较短的 HOWTO。

以下是一些多级结构可能派上用场的情况。

注意: 请记住,我们描述的是标题级别的父子关系,父级别是 1 级、2 级还是 3 级并不重要。这同样适用于具有 2 个或更多级别的所有多级结构。

将论点组合在一起

子标题对于主标题的作用就像标题对于整篇文章的作用一样。

一个例子

  • 导言
  • 步骤 1:执行此操作或彼操作
  • 步骤 2:清理
    • 首先这样做
    • 然后那样做
    • 你完成了!
  • 步骤 3:故障排除
  • 延伸阅读

替代论点

有时,您需要从几个不同的角度向读者介绍一个主题。

例如

  • 导言
  • 步骤 1:执行此操作或彼操作
    • 这是一种方法
    • 这是另一种方法
  • 步骤 2:清理
  • 步骤 3:故障排除
  • 延伸阅读

矛盾的论点

如果您需要谈论对立的论点,您可以给每一方一个自己的子标题。

例如

  • 导言
  • 步骤 1:执行此操作或彼操作
    • 你想要这个
    • 尽管如此,还是有不想要这个的理由
  • 步骤 2:清理
  • 步骤 3:故障排除
  • 延伸阅读

标题文本

我们将在此处总结一些要点,如果您想要更详细的说明,您可以阅读 Help:文章命名指南。此处列出的规则适用于标题文本和文章名称。

  • 标题文本应尽可能具体,并且应反映标题的范围
  • 标题文本应足够通用,以便将来可以增强标题
  • 标题文本应尽可能简短(另请参阅 Help:文章命名指南

格式化

正如我们已经指出的,不要滥用标题格式样式来美化您的文章至关重要。如果您不喜欢您所看到的,请联系管理员或系统管理员并征求他们的意见,或提出以不会损害标题结构的方式来解决问题。

要将某些文本标记为标题,必须使用两个或多个等号 (==)。

注意: 实际支持的最低标题级别为 1 (=),但其格式保留用于文章标题:文章章节必须始终从级别 2 开始。

以下是标记标题的代码

== Header level 2 ==

=== Header level 3 ===

==== Header level 4 ====

===== Header level 5 =====

====== Header level 6 ======

如果您想查看这些格式化的方式,可以使用沙盒。有关相关的样式约定,请参阅 Help:Style#章节标题