维基教科书:风格指南

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

维基教科书标题

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

维基教科书的标题应基于其方面。这包括书籍的目标受众、范围和深度。同一主题但方面不同的书籍可以同时存在。例如，一本面向普通大众的木工书可以简单地命名为“木工”，而一本面向商业专业的数学教材可以叫做“商业数学”或“商业数学”，而不是简单地叫做“数学”。

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

描述章节内容的子页面名称 - 例如，“Chess/Notating_The_Game” - 比带编号的章节更可取 - 比如“Chess/Chapter_10” - 这样，在现有章节之间插入新章节或重新排序章节所需的步骤就更少了。

结构

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

首页

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

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

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

目录

一般来说，目录应该在首页上，以便读者了解可用的资料。如果这样做不切实际，则可以为它创建一个特殊的页面。此类页面的常见名称为目录, 目录或类似名称。

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

简介

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

本地风格指南 - 当它不是简介页面 - 通常直接命名为“本地风格指南”、“风格指南”、“如何贡献”、“如何帮助”、“关于”等 - 当然要附加到书籍名称。无论您正在编辑的书籍中将其称为什么，如果它与目录在同一页面上，链接到它会很好。本地风格指南在WB:LMOS中进一步讨论。

导航

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

参考书目

参考书目对于收集书籍中引用的资源、链接到该主题上超越书籍范围的其他有用资源以及包含有助于验证书籍中所写内容的真实性的作品很有用。使用时，此类页面的常见名称为进一步阅读, 参考文献，或类似名称。

词汇表

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

附录

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

示例

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

封面

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

印刷版

有关印刷版的更多信息，请参见 Help:Print versions。它们通常被称为书名/印刷版.

PDF 版

有些书籍有一个文件：书名.pdf用于将整本书一次性放入单个 PDF 文件中。如果有人创建了书籍的 PDF 版本，如果在 Wikibooks:PDF versions 中提到该 PDF 文件，并且在目录中放置了 {{PDF version}} 以链接到该 PDF 文件，那就太好了。

示例

• Control Systems 有一个很棒的介绍，描述了（并链接到一些）本书的先决条件。
• 西班牙语 使用了欢迎页，但目录注释良好且易于访问。
• Haskell 有一个非常好的布局，分为不同级别的受众。

风格

在适当的情况下，首次使用与页面标题类似的词语或短语应以 粗体 标记，当引入新术语时，应以 斜体 标记。

标题

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

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

=== Cats ===
Cats are animals.

=== Dogs ===
Dogs are animals.

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

链接

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

脚注和参考文献

维基教科书针对脚注和参考文献提供了一些非常简单的实现。一种使用 {{note}} 将脚注放置在页面底部，并使用 {{ref}} 在文本中的适当位置引用这些脚注。另一种将参考文献放置在文本中的 <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，则可以通过在公式末尾添加“\,\!”来强制其这样做。

软件

关于计算机软件的书籍，或依赖计算机软件来阐述示例的书籍，应清楚地表明与当前书籍、页面或部分相关的软件版本。可在 Wikibooks:Templates 中找到帮助完成此操作的模板及其使用示例。

颜色

在使用颜色时，请注意维护可访问性。

嵌套

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

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