跳轉到內容

幫助:本地風格手冊

This page is semi-protected.
來自華夏公益教科書,開放的世界,開放的書籍

維基百科或維基詞典不同 - 它們本質上是具有單一風格手冊的非常大的書籍 - 華夏公益教科書上發現的個別書籍可以用完全不同的風格編寫,根據主題的需要和作者的偏好。

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

目的

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

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

語言

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

基本結構

扁平結構(書籍/章節)

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

優勢
允許在書籍內部以及從其他書籍和專案中進行輕鬆連結。
  • 從主頁面,可以使用[[/Chapter/]]連結到章節。
  • 在書籍內部,可以使用[[../Chaptername/]]在章節之間進行互聯,而不是使用完整的標題。
  • 從其他書籍和專案,如果只需要輸入一個變數,模板就會簡單得多,例如{{See also [[Book/{{1}}]]}},等等。
劣勢
頁面頂部的自動標題只會指向主書籍頁面,而不是指向章節標題。

深度結構(書籍/章節/子章節/子子章節/等等)

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

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

示例

命名約定

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

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

優勢
列印時看起來更好,因為它遵循大多數出版書籍的標準。
劣勢
連結到可能更難。

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

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

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

示例

頁面長度限制

限制頁面長度

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

優勢
限制頁面長度將使連線速度慢的使用者更容易下載章節。
為書籍設定頁面長度的任意限制可能有助於使書籍具有更一致的感覺。
劣勢
可能會產生否則可能不合理的任意章節斷裂。

模板

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

優勢
讓整本書保持一致的感覺。
在模板中進行更改比手動編輯每個頁面快得多。
劣勢
可能有限制。
使新貢獻者更難參與。

所有章節都遵循模板嗎?

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

優勢
便於確保每個章節都遵循相同的格式。
劣勢
根據模板的不同,可能難以在各個頁面之間建立多樣性。
使新貢獻者更難參與。

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

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

優勢
允許對討論一般主題型別的頁面進行更加定製(但仍然一致)的樣式。
劣勢
可能使新貢獻者難以習慣這本書。

複雜的模板?

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

優勢
吸引人且靈活。
劣勢
缺乏經驗的作者難以使用。

示例

維基連結

僅使用書內管道連結?

將連結限制為僅限於書籍的章節,使書籍“自成一體”。

優勢
使書籍保持一致,無需依賴外部來源。
劣勢
需要為每個術語建立一個新頁面。

使用跨專案連結?

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

優勢
允許輕鬆解釋術語。
劣勢
使書籍依賴於其他專案。如果使用這種型別的連結,作者應定期檢查以確保目標頁面未被移動。

限制連結?

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

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

優勢
使書籍相對自成一體,因此即使書籍被印刷或使用者沒有網際網路連線,它仍然有用。
劣勢
與包含在書籍正文中的連結相比,頁面或部分末尾的連結不容易被讀者找到。

使用導航模板?

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

優勢
使用模板來建立專業質量的導航功能比嘗試重新發明輪子更容易。
劣勢
使新貢獻者更難參與。

使用索引?

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

優勢
便於讀者找到他們想要的資訊。
劣勢
索引必須根據書籍中的資訊進行編譯,並隨著資訊的新增或刪除進行維護。

圖片

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

合理使用

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

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

僅限維基共享資源?

維基共享資源託管的媒體要麼是公有領域,要麼是授權由版權所有者免費供任何人重新使用。

優勢
透過僅使用維基共享資源上的圖片,可以更輕鬆地跨維基書籍(例如,如果德語維基百科想要進行翻譯,他們可以將其複製過來,而無需對每張圖片進行法律上的合理說明)。
這些圖片通常在維基共享資源的畫廊類別中進行組織,這有助於找到與書籍相關的或更好的圖片。
劣勢
維基共享資源不允許使用合理使用圖片。

使用縮圖?

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

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

類別

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

優勢
使整本書“集中在一個地方”,便於跟蹤頁面。
劣勢
由於 MediaWiki 軟體的限制,類別一次最多顯示 200 個同類頁面,每個組之間都有連結。對於包含 200 多個頁面的較大型書籍來說,這可能是一個限制,因為連結指向前一個或下一個組。可以透過使用類似 {{CategoryTOC}} 的模板來緩解這種情況,以便在類別中進行更輕鬆的導航。

在書籍中使用子類別?

優勢
有助於將特定書籍的相關部分分組在一起。
劣勢
使難以一次看到所有章節。

數學公式

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

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

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

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

華夏公益教科書