帮助:样式

来自 Alpine Linux

为了在 Alpine Linux Wiki 的所有页面上实现一致的外观和感觉,编辑者必须尽可能遵循以下样式指南。

页面标题和标题

  • 页面标题和所有标题应使用句子首字母大写
  • 避免在标题中包含 Alpine Linux
  • 标题应从级别 2 开始,因为级别 1 标题用于页面标题。
  • 不要跳过级别。

章节组织

每个页面都应以引言部分开头——文章的简洁摘要——引言部分永远不应再分章节。文章的其余部分通常分为章节。以下章节标题是在 Wiki 页面上推荐使用的

 === Prerequisite ===

  If there any Prerequisite, it must be properly listed here.

 === Installation ===

  The Installation section must appear early in the page.

 === Configuration ===

  The Configuration section must follow with detailed sub-headings to handle all sub-topics.

 === Troubleshooting ===

  Troubleshooting section must include common errors that may be encountered by the users.

 === See also ===

  Add both internal wikilinks and external references relevant to the page in this section.

项目符号和编号列表

  • 如果一段文字可以轻松地以普通段落阅读,则不要使用列表。
  • 仅在以下情况下使用数字而不是项目符号
    • 可能需要按编号引用元素;
    • 条目的顺序至关重要;

链接

仅在链接与上下文相关且有帮助时才添加链接:过度使用超链接可能会分散注意力并减慢读者的速度。仅添加值得追踪的链接。

检查链接:确保目标是预期的目标并进行测试。

外部链接通常不应在文章正文中使用,而应使用#参见部分来放置它们。谨慎添加外部链接,不要将 Wiki 用于自我推销。

Transclusion

对于可能在多个页面中需要的内容,请使用transclusion。为了快速识别此类页面,请在常规标题前使用 Include: 作为此类页面的标题。例如:Include:Setup-desktop

分类

每个页面都应从分类列表中分配至少一个分类,方法是将它们放在页面的底部。

参见