跳轉到內容

幫助:本地樣式手冊

This page is semi-protected.
來自華夏公益教科書

與維基百科或維基詞典不同——它們本質上是具有單個樣式手冊的非常大的書籍——華夏公益教科書中發現的各個書籍可以根據主題的需要和作者的喜好,以截然不同的風格撰寫。

  1. 有一個通用的 Wikibooks:樣式手冊,在為新書撰寫本地樣式手冊之前,應該閱讀該手冊。
  2. 強烈建議您在開始之前考慮 書籍結構,或以 使用者頁面 的子頁面形式建立草稿。
  3. 如果書籍應該具有獨特的重複出現的 樣式元素,例如用於練習或軼事的方框,這些元素應該作為 模板 提供,並在本地樣式手冊中列出並說明。
  4. 如果書籍應該制定 內容分組導航 策略,則應在本地樣式手冊中說明該策略。
  5. 如果書籍應該對建立進一步的 藝術品或圖片 提出某些要求,則應在本地樣式手冊中提及這些要求。
  6. 如果書籍有多位作者,那麼如果一些作者同意某種 寫作風格,而其他作者沒有遵循這種風格,書籍就會變得不一致。應在本地樣式手冊中描述具體的寫作風格。
  7. 旨在遵循某種教學方法的書籍可能需要來自貢獻編輯的特殊考慮。應在本地樣式手冊中詳細說明教學方法。

目的

華夏公益教科書通常是許多貢獻者的產物,為了保持單一的“聲音”和風格,以便在使用該作品時為使用者提供一致的體驗,這變得極為重要。這在它成為協作的負擔和作品整體質量的決定性因素之前,就應該考慮進去。

雖然 Wikibooks:樣式手冊 有些技巧適用於所有書籍,但每本華夏公益教科書通常都有自己的本地樣式手冊,該手冊試圖描述所需的“聲音”,並解釋如何使用特定於書籍的模板和其他僅適用於該書籍的有用工具。

語言

在可能的情況下,書籍應該儘量做到對所有英語使用者保持中立,不要依賴於特定於某個地區的習慣用語或語言。書籍需要一致使用語言,因此,在其演變過程中,需要做出決定,即書籍是依賴於英式英語還是美式英語,或者是否使用其中任何一種語言的簡單子集(如兒童用的小詞,簡體英語,或 E-Prime 等)。

基本結構

扁平結構 (書/章節)

扁平結構通常是首選,因為它更容易保持組織並進行連結。“扁平”意味著只有一級子頁面 (書/章節1,書/章節2)。

優點
允許在書籍內部以及從其他書籍和專案中輕鬆連結。
  • 從主頁,可以使用 [[/章節/]] 連結到章節。
  • 在書籍內部,可以使用 [[../章節名稱/]] 形式相互連結章節,而不是使用完整的標題。
  • 從其他書籍和專案,如果只需要輸入一個變數,模板會簡單得多,例如 {{參見 [[書/{{1}}]]}} 等。
缺點
頁面頂部的自動標題僅指向主書籍頁面,而不是指向小節標題。

深層結構 (書/章節/子章節/子子章節/等等)

深層結構具有更強的內在組織。“深層”意味著有多級子頁面 (書/章節1,書/章節1/小節2,書/章節2/小節5/頁面9)。

優點
組織結構是“內建”的,因此子章節會自動連結到主章節,從而簡化書籍內的導航。
缺點
在章節、其他書籍和其他專案之間進行連結可能變得更加費力。
更改書籍中章節的位置比對主書籍頁面進行單個編輯要困難得多。參見 元維基:意外連結和硬編碼的分類方案
打印出來時,看起來並不那麼“整潔”。

示例

命名約定

使用 "本節名稱","小節名稱"

大多數書籍(包括華夏公益教科書和印刷書籍)都將所有單詞的首字母大寫,除了冠詞和介詞。

優點
打印出來時看起來更好,因為它遵循大多數出版書籍的標準。
缺點
可能難以連結。

使用 "章節名稱","小節名稱"

一些書籍(包括華夏公益教科書和印刷書籍)只將書籍和章節標題的第一個字母大寫。

優點
更熟悉的“維基”式命名方式,如維基百科中所確立的。
缺點
不符合正常的書籍出版風格。

示例

頁面長度限制

限制頁面長度

有些書籍可能對頁面長度有限制(例如,維基百科人試圖限制文章的頁面長度)。MediaWiki 軟體定義的每頁絕對限制為 2,097,152 位元組 (2,048 kB)。

優點
限制頁面長度將使章節更容易下載,尤其對連線速度慢的使用者來說。
設定頁面長度的任意限制可能有助於使書籍更具一致性。
缺點
可能導致一些原本沒有必要的任意分節。

模板

使用 模板 為每個章節或頁面建立一致的結構通常很有用。模板可以使用標題、資訊框和其他功能建立大綱,使書籍的每個章節都相似。

優點
使書籍更具一致性。
修改模板比手動編輯每個頁面快得多。
缺點
可能會限制。
使新貢獻者更難參與。

所有章節都遵循一個模板嗎?

有些書籍可能從使用標準化的章節模板中獲益。

優點
使確保每個章節都遵循相同格式變得更容易。
缺點
根據模板的不同,跨頁面建立多樣性可能更難。
使新貢獻者更難參與。

不同型別的章節使用不同的模板嗎?

有些書籍可能對不同型別的頁面使用不同的模板。例如,食譜 對食譜、配料等使用不同的模板。

優點
允許對討論一般型別主題的頁面進行更定製化(但一致)的樣式。
缺點
可能使新貢獻者難以適應書籍。

複雜的模板?

一些非常有用且吸引人的模板可以使用解析器功能建立。

優點
吸引人且靈活。
缺點
對於沒有經驗的作者來說很難使用。

示例

維基連結

只使用書內管道連結嗎?

將連結限制在書籍的章節內,可以使書籍“自成一體”。

優點
將書籍保持在一起,無需依賴外部來源。
缺點
需要為每個術語建立一個新頁面。

使用跨專案連結嗎?

可以使用方括號內的字首在維基媒體專案之間建立連結。w: 指向維基百科,wikt: 指向維基詞典,等等。

優點
允許輕鬆解釋術語。
缺點
使書籍依賴於其他專案。如果進行了這種連結,作者應該定期檢查以確保目標頁面沒有被移動。

限制連結?

書籍可能只在某些情況下使用維基連結,例如連結到的資訊超出了書籍的範圍。

許多書籍將書籍外的連結限制在每頁的“進一步閱讀”部分。有些書籍更進一步,將書籍外的連結限制在單個“參考書目和資源”頁面。

優點
使書籍相對自成一體,因此即使書籍被印刷或使用者沒有網路連線,它仍然有用。
缺點
頁面或章節末尾的連結不像文字中包含的連結那樣容易被讀者發現。

使用導航模板嗎?

可以使用 導航模板 建立索引、目錄或其他書籍功能。

優點
使用模板建立專業的導航功能比重新發明輪子更容易。
缺點
使新貢獻者更難參與。

使用索引嗎?

索引是書籍中特定資訊的詳細列表,通常按字母順序排列。

優點
使讀者更容易找到他們要尋找的資訊。
缺點
必須根據書籍中的資訊來編譯索引,並在新增或刪除內容時維護它。

圖片

維基百科中使用的圖片儲存在 檔案:名稱空間 中,位於維基百科或維基共享資源上,維基共享資源是一個獨立但密切相關的維基。

合理使用

“合理使用”圖片是受版權保護的作品,根據美國法律,在某些情況下允許使用。這些圖片儲存在維基百科上,並且必須為每次使用提供法律依據。

優點
允許使用比不接受合理使用圖片的書籍更多的圖片。
缺點
這是法律中的灰色地帶,尤其影響從美國以外地區訪問維基百科的人,因為使用此類材料可能違反當地法律。

僅使用維基共享資源嗎?

維基共享資源託管著 公共領域 或由版權持有者 授權 供任何人免費重新使用的媒體。

優點
透過只使用維基共享資源上的圖片,更容易進行 跨維基(例如,如果德語維基百科想進行翻譯,他們可以複製它,而無需為每張圖片提供法律依據)。
這些圖片通常在維基共享資源的 畫廊類別 中組織,這有助於定位與書籍相關的或更好的圖片。
缺點
維基共享資源不允許使用合理使用圖片。

使用縮圖嗎?

縮圖是圖片的小版本,可以透過點選進行擴充套件。

優點
允許在頁面上放置許多圖片,而不會佔用太多空間或頻寬。
缺點
縮圖通常太小,不適合印刷版本。

類別

對所有書籍章節使用一個類別嗎?

優點
將整本書“放在一個地方”,以便於跟蹤頁面。
缺點
類別一次最多顯示 200 個相同型別的頁面,並在每個組之間新增連結,這是 MediaWiki 軟體的限制。對於超過 200 頁的大型書籍來說,這可能是一個限制,因為連結是到前面或後面的組。可以使用像 {{CategoryTOC}} 這樣的模板來緩解這個問題,以便更容易地在類別中導航。

在書籍中使用子類別嗎?

優點
有助於將特定書籍的相關部分分組在一起。
缺點
使一次檢視所有章節變得更困難。

數學公式

許多書籍,例如數學、科學和工程類書籍,包含數學公式,並使用特殊符號來顯示數學概念。當使用這些公式或符號時,它們應該在整本書中保持一致。例如,有些書籍的 LMOS 建議使用 2+3i 向量符號,而其他書籍的 LMOS 建議使用 2+3j 向量符號。

另請參見:幫助:印刷版本使用維基百科/印刷版本和 PDF

書籍可以有一個或多個可列印版本,並且可以包含 PDF 版本,以便於閱讀和下載。印刷版本應該使用 頁面轉包,以便所有對主書籍頁面的更新都會自動反映在印刷版本文字中。PDF 版本應定期更新,以保持與主書籍頁面的一致性。

有一些專門的模板和 魔術詞 可用於印刷版本和 PDF 版本。例如,印刷版本可以使用 __NOTOC__ 來抑制書籍中自動生成的目錄 (TOC)。這樣,印刷版本就可以生成自己的目錄。

華夏公益教科書