華夏公益教科書:樣式指南

華夏公益教科書樣式指南旨在建立良好的結構和風格實踐，以幫助編輯製作更高質量的華夏公益教科書。

華夏公益教科書標題

有關如何命名書籍及其章節的資訊，請參閱 華夏公益教科書：命名政策。

華夏公益教科書應根據其方面命名。這是目標受眾、範圍和書籍深度的組合。關於同一個主題但具有不同方面的書籍可以同時存在。例如，針對普通大眾的木工書籍可能僅名為“木工”，而針對商業學生的數學教科書可能被稱為“商業數學”或“商業數學”，而不是僅僅“數學”。

有些人更喜歡使用 標題大小寫，就像書籍經常做的那樣，而另一些人則更喜歡使用 句子大小寫，就像維基百科一樣。標題大小寫建議用於 書籍標題，因為它減少了標題和書架類別之間的潛在混淆。子頁面名稱 和 節 的大小寫完全是風格問題。無論您對書籍標題、頁面和節使用哪種方案組合，請保持一致，並遵循您正在編輯的書籍的現有風格。

描述章節內容的子頁面名稱——例如，“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 章
• 等等。