维基教科书:样式指南

维基教科书样式指南旨在建立良好的结构和风格实践，以帮助编辑制作更高质量的维基教科书。

维基教科书标题

有关如何命名书籍及其章节的信息，请参阅 维基教科书：命名政策。

维基教科书应根据其方面命名。这是目标受众、范围和书籍深度的组合。关于同一个主题但具有不同方面的书籍可以同时存在。例如，针对普通大众的木工书籍可能仅名为“木工”，而针对商业学生的数学教科书可能被称为“商业数学”或“商业数学”，而不是仅仅“数学”。

有些人更喜欢使用 标题大小写，就像书籍经常做的那样，而另一些人则更喜欢使用 句子大小写，就像维基百科一样。标题大小写建议用于 书籍标题，因为它减少了标题和书架类别之间的潜在混淆。子页面名称 和 节 的大小写完全是风格问题。无论您对书籍标题、页面和节使用哪种方案组合，请保持一致，并遵循您正在编辑的书籍的现有风格。

描述章节内容的子页面名称——例如，“Chess/Notating_The_Game”——比编号的章节——例如“Chess/Chapter_10”——更受欢迎，这样在现有章节之间插入新章节或重新排序章节时，所需的工作量更少。

结构

有关一些有用的提示和想法，请参阅 书籍设计。

主页

主页通常是新读者看到的第一个页面。它应该快速概述书籍的范围、目标受众和布局。应避免使用 首页。通常，布局只是完整的目录。集合、可打印版本和 PDF 文件应易于从该页面访问。

从 卡片目录办公室 和外部网站到书籍的链接应该指向书籍的主页。卡片目录办公室的主题索引要求在书籍的主页上放置 {{shelves}} 模板。书籍的主页和类别应放置在书籍所属的任何 类别 中。使用 {{status}} 指示书籍的完成状态，以便读者在浏览 书架页面 时了解书籍的进度。如果您在对书籍进行分类时仍需要帮助，请 在阅览室请求帮助。

跨语言链接应放置在书籍的主页上。跨语言项目中的书籍，即使是关于同一个主题，也可能有所不同。请谨慎地在其他页面上放置跨语言链接。

目录

通常，目录应该在主页上，以便读者可以了解可用的材料。在不切实际的情况下，可以为其创建一个特殊页面。此类页面的常用名称是目录, 目录或类似。

• 目录示例
• 
  标准目录
• 
  2 列目录
• 
  2 列目录

介绍

一个 介绍 页面是学习开始的第一个页面。书籍的介绍页面通常深入探讨书籍的目的和目标；书籍旨在教授什么，目标受众是谁，书籍的范围是什么，书籍涵盖哪些主题，主题的历史，学习主题的原因，书籍中使用的任何约定，或任何其他在介绍性章节中可能说得通的信息。此类页面的常用名称是介绍或关于。后者更常用于将关于书籍的信息与主题内容的介绍分开。

本地样式指南——当它不是介绍页面的一部分——通常直接命名为“本地样式指南”、“样式指南”、“如何贡献”、“如何帮助”、“关于”等——当然要附加到书籍名称。无论您正在编辑的书籍中它被称为什么，最好将指向它的链接放在与目录相同的页面上。在 WB:LMOS 中进一步讨论了拥有本地样式指南。

导航

导航辅助是页面上包含的链接，用于简化页面之间的导航。导航辅助可以帮助读者更轻松地阅读书籍，但也可能使维护和贡献书籍变得更加困难。大多数网络浏览器可以回溯已访问的页面，维基软件还会添加用于返回目录的链接（如果页面使用其名称中的斜杠约定，并且书籍的主页是建议的目录）。使用书籍特定的模板来保存导航辅助（而不是将其复制粘贴到书籍的每个页面上）可以帮助减少一些维护问题，因为如果发生更改，只需编辑该模板即可。对于导航辅助没有标准。由于其潜在的缺点，导航辅助是可选的。

参考书目

一个 参考书目 有助于收集书籍中引用的资源，链接到关于该主题的超出书籍范围的其他有用资源，以及包括有助于验证书籍中所写内容的事实准确性的作品。使用时，此类页面通常称为进一步阅读, 参考文献，或类似。

术语表

一个 术语表 列出了特定知识领域的术语及其定义。术语表完全是可选的，对于针对该领域新手的人来说最有用。术语表应始终用于此类页面。

附录

一个 附录 包含不适合书籍流程的重要信息。例如，数学公式列表可以在数学书中用作附录。附录是可选的，书籍可以包含多个附录。以下是常见附录名称示例：Appendix/Keywords和Appendix:Formulas.

示例

• Conlang/Appendix/Glossary
• Inkscape/Appendix:Reference

封面页

封面页对于印刷版很有用。这些应该与主页分开（请记住：维基教科书不是纸张），但可用于制作印刷版。使用时，通常命名为封面.

印刷版

有关印刷版本的更多信息，请参阅 帮助：印刷版本。它们通常命名为书名/印刷版本.

PDF 版本

有些书有一个文件：书名.pdf用于将整本书一次性保存在单个 PDF 文件中。如果有人创建了书籍的 PDF 版本，最好在 维基教科书：PDF 版本 中提及该 PDF 文件，并在目录中放置 {{PDF 版本}} 以链接到该 PDF 文件。

示例

• 控制系统 有一个很好的介绍，描述了（并链接到了一些）这本​​书的先决条件。
• 西班牙语 使用了首页，但目录注释清晰且易于访问。
• Haskell 有一个非常好的布局部分，适合不同级别的受众。

风格

在适当的情况下，第一次使用类似于页面标题的词语或短语应该用 粗体 标记，当引入新术语时，则应将其 斜体。

标题

标题应该用于划分页面部分并提供内容布局。主要信息应使用“==”标记，其次要信息应使用“===”标题标记，依此类推，例如

== Animals ==
There are many kinds of animals.

=== Cats ===
Cats are animals.

=== Dogs ===
Dogs are animals.

无需在标题之间提供系统导航；只需提供页面之间的导航即可。当使用超过 3 个标题时，页面上会自动提供部分列表。

链接

具有深度子页面层次结构的书籍应包含导航链接，以帮助在层次结构中导航。 模板 可以通过简化在必要页面上包含导航辅助工具的方式来帮助维护一致性。

脚注和参考文献

维基教科书为脚注和参考文献提供了两种非常简单的实现。一种使用 {{注释}} 将注释放置在页面底部，使用 {{引用}} 在文本中的适当位置引用这些注释。另一种将参考文献放置在文本中的 <ref> 和 </ref> 标签之间，然后使用 {{reflist}} 或 <references /> 自动在页面底部生成这些参考文献的列表。

数学

在句子中使用变量或其他简单数学符号时，使用 HTML 或内联 Mediawiki 标记进行格式化。对于更复杂的公式，使用 <math></math> 标签。

对变量使用斜体：a+b 等。不要对希腊字母变量、函数名或它们的括号使用斜体。

要在 显示 格式中介绍数学符号，请移动到新行的开头，添加一个冒号，然后在 <math></math> 标签中添加符号。如果符号后面有标点符号，则应将其 放在 标签 内。

例如

标记	显示
: <math>\int_0^\infty {1 \over {x^2 + 1}}\,dx = \frac{\pi}{2}</math>	$\int _{0}^{\infty }{1 \over {x^{2}+1}}\,dx={\frac {\pi }{2}}$

正确地用于“显示”指南。

如果符号没有以 PNG 格式呈现，可以通过在公式末尾添加“\,\!”强制其以 PNG 格式呈现。

软件

关于计算机软件的书籍或依赖于使用计算机软件来说明示例的书籍应明确指出软件的哪个版本与手头的书籍、页面或部分相关。有关此方面的帮助模板及其使用示例，请访问 维基教科书：模板。

颜色

在使用颜色时要小心，以维护可访问性。

嵌套

嵌套是指子章节嵌套/位于/每个/其他/像/这样。在某些情况下，这可能是合适的，例如在包含具有大量内容的子部分的大型教科书中。避免创建每个都包含很少内容的过多的子章节——相反，考虑将这些子章节合并到一个单独的章节中，并使用标题适当划分内容。此外，在嵌套时，重要的是要有一个直观且可访问的导航系统。在子章节中“隐藏”目录通常是不合适的，因为这使得难以一目了然地查看书籍结构并在各个部分之间导航。它还为自动更新的导航模板（例如 Template:Nav）带来了挑战。相反，通常最好将所有子章节链接到主目录中，如下所示

• 第 1 章
  • 子章节 A
    • 子章节 α
• 第 2 章
• 等等。