Osmo 文件本地樣式指南

這是本地樣式指南的開頭。有關日常幫助，請參閱書籍頁面構成。在 OSMO 文件書籍中，將其連結到與目錄相同的頁面上。

根據 2013 年 3 月關於使用者手冊或使用者指南的維基百科文章，使用者手冊的章節通常包括

封面
標題頁和版權頁
前言，包含相關文件的詳細資訊以及如何瀏覽使用者指南的資訊
目錄頁
有關如何使用系統至少主要功能的指南
故障排除部分，詳細說明可能發生的錯誤或問題，以及如何解決這些問題
一個FAQ（常見問題解答）
在哪裡可以找到更多幫助以及聯絡方式
一個術語表，對於較大的文件，還有一個索引

章節樣式

以下樣式建議改編自選定的華夏公益教科書建議，可以針對 Osmo 文件專案進行更具體的調整。

首頁和封面樣式

範圍摘要
目標受眾摘要
包含目錄的書籍佈局

首頁佈局主要為完整的目錄，以及其他模板專案，例如類別模板、完成階段模板 {{狀態}}、作者資訊模板、{{主題}} 模板、可列印版本、跨語言連結等。

目錄樣式

目錄位於首頁。

引言樣式

該引言頁面更深入地探討了首頁或封面頁面上總結的主題。這些包括書籍的目的和目標；書籍旨在教授什麼，目標受眾是誰，書籍的範圍是什麼，書籍涵蓋哪些主題，主題的歷史，學習主題的原因以及書籍中使用的任何約定。

參考文獻樣式

一個參考文獻對於收集書籍中引用的資源、連結到主題上的其他有用資源（超出書籍範圍）以及包含有助於驗證書籍中所寫內容的事實準確性的作品很有用。使用時，此類頁面通常命名為進一步閱讀, 參考文獻，或類似的名稱。

術語表樣式

一個術語表列出特定知識領域中的術語及其定義。術語表完全可選，在針對該領域新手學習的書籍中最有用。術語表應始終用於此類頁面。

附錄樣式

一個附錄包含不適合書籍流程的重要資訊。例如，廣泛的軟體版本說明或程式碼示例。本書可能有多個附錄。命名附錄的常見方法示例為附錄/關鍵字和附錄：公式.

軟體版本和程式碼樣式

此附錄部分包含比文件文字主要部分可能更廣泛的軟體資訊。“操作方法”部分和“常見問題解答”可以參考此附錄。

與書籍、頁面或手頭的部分相關的完整軟體版本說明可以使用華夏公益教科書：模板中提供的模板。

腳註和參考文獻樣式

腳註和參考文獻的實現：使用 {{註釋}} 將註釋放置在頁面底部，並使用 {{引用}} 在文字中的適當位置引用這些註釋。其他地方在 <ref> 和 </ref> 標記之間放置參考文獻，然後使用 {{引用列表}} 或 <references /> 自動生成這些參考文獻的列表在頁面底部。

另請參閱：幫助：編輯#參考文獻

Osmo 文件專案的其他格式樣式

連結

深層子頁面層次結構導航連結可幫助讀者在文字中找到自己的位置。使用模板以保持一致性，包括必要頁面上的導航輔助工具。

另請參閱：幫助：編輯#連結

另請參閱：華夏公益教科書：模板/導航

導航輔助工具是指頁面上包含的連結，用於方便讀者在頁面之間導航。導航輔助工具可以幫助讀者更輕鬆地閱讀書籍，但也可能使書籍的維護和貢獻變得更加困難。大多數網路瀏覽器可以回溯已訪問過的頁面，並且維基軟體還會新增連結，用於在使用斜槓約定命名頁面且書籍的主頁是建議的目錄的情況下，導航回目錄。使用特定於書籍的模板來儲存導航輔助工具（而不是複製貼上到書籍的每個頁面上）可以幫助減少一些維護問題，因為如果內容發生變化，只需要編輯該模板即可。導航輔助工具沒有標準。由於其潛在的缺點，導航輔助工具是可選的。

字型樣式

頁面標題類似的單詞或短語第一次使用時用粗體標記，當引入新術語時，則用斜體表示。

列印版和PDF版樣式

列印版本通常命名為書籍名稱/列印版本。在前後放置標記檔案：Bookname.pdf用於將整本書一次性放在單個PDF檔案中。當有人建立書籍的PDF版本時，請在Wikibooks:PDF版本中提及該PDF檔案，並在目錄中放置{{PDF版本}}以連結到該PDF檔案。有關列印版本的更多資訊，請參見幫助：列印版本。