華夏公益教科書:風格指南

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

華夏公益教科書標題

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

華夏公益教科書的標題應基於其方面。這包括書籍的目標受眾、範圍和深度。同一主題但方面不同的書籍可以同時存在。例如，一本面向普通大眾的木工書可以簡單地命名為“木工”，而一本面向商業專業的數學教材可以叫做“商業數學”或“商業數學”，而不是簡單地叫做“數學”。

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

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