Osmo 文档本地样式指南

这是本地样式指南的开头。有关日常帮助，请参阅书籍页面构成。在 OSMO 文档书籍中，将其链接到与目录相同的页面上。

根据 2013 年 3 月关于用户手册或用户指南的维基百科文章，用户手册的章节通常包括

封面
标题页和版权页
前言，包含相关文档的详细信息以及如何浏览用户指南的信息
目录页
有关如何使用系统至少主要功能的指南
故障排除部分，详细说明可能发生的错误或问题，以及如何解决这些问题
一个FAQ（常见问题解答）
在哪里可以找到更多帮助以及联系方式
一个术语表，对于较大的文档，还有一个索引

章节样式

以下样式建议改编自选定的维基教科书建议，可以针对 Osmo 文档项目进行更具体的调整。

首页和封面样式

范围摘要
目标受众摘要
包含目录的书籍布局

首页布局主要为完整的目录，以及其他模板项目，例如类别模板、完成阶段模板 {{状态}}、作者信息模板、{{主题}} 模板、可打印版本、跨语言链接等。

目录样式

目录位于首页。

引言样式

该引言页面更深入地探讨了首页或封面页面上总结的主题。这些包括书籍的目的和目标；书籍旨在教授什么，目标受众是谁，书籍的范围是什么，书籍涵盖哪些主题，主题的历史，学习主题的原因以及书籍中使用的任何约定。

参考文献样式

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

术语表样式

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

附录样式

一个附录包含不适合书籍流程的重要信息。例如，广泛的软件版本说明或代码示例。本书可能有多个附录。命名附录的常见方法示例为附录/关键字和附录：公式.

软件版本和代码样式

此附录部分包含比文档文本主要部分可能更广泛的软件信息。“操作方法”部分和“常见问题解答”可以参考此附录。

与书籍、页面或手头的部分相关的完整软件版本说明可以使用维基教科书：模板中提供的模板。

脚注和参考文献样式

脚注和参考文献的实现：使用 {{注释}} 将注释放置在页面底部，并使用 {{引用}} 在文本中的适当位置引用这些注释。其他地方在 <ref> 和 </ref> 标记之间放置参考文献，然后使用 {{引用列表}} 或 <references /> 自动生成这些参考文献的列表在页面底部。

另请参阅：帮助：编辑#参考文献

Osmo 文档项目的其他格式样式

链接

深层子页面层次结构导航链接可帮助读者在文本中找到自己的位置。使用模板以保持一致性，包括必要页面上的导航辅助工具。

另请参阅：帮助：编辑#链接

另请参阅：维基教科书：模板/导航

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

字体样式

页面标题类似的单词或短语第一次使用时用粗体标记，当引入新术语时，则用斜体表示。

打印版和PDF版样式

打印版本通常命名为书籍名称/打印版本。在前后放置标记文件：Bookname.pdf用于将整本书一次性放在单个PDF文件中。当有人创建书籍的PDF版本时，请在Wikibooks:PDF版本中提及该PDF文件，并在目录中放置{{PDF版本}}以链接到该PDF文件。有关打印版本的更多信息，请参见帮助：打印版本。