跳轉到內容

幫助:本地風格手冊

This page is semi-protected.
來自華夏公益教科書,為開放世界提供開放書籍
(重定向自 Wikibooks:LMOS)

與維基百科或維基詞典不同 - 它們本質上是具有單一風格手冊的非常大的書籍 - 在華夏公益教科書上找到的各個書籍可以以截然不同的風格編寫,根據主題的需求和作者的偏好。

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

目的

華夏公益教科書通常是由許多貢獻者建立的,他們維護著單一的 "聲音" 和風格,為了為使用者提供一致的使用體驗,這變得極其重要。這在它成為協作的負擔和決定作品整體質量的決定性因素之前,應該加以考慮。

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

語言

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

基本結構

扁平結構(書籍/章節)

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

優點
允許在書內以及從其他書籍和專案中輕鬆連結。
  • 從主頁,可以使用 [[/Chapter/]] 連結到章節。
  • 在書內,可以使用 [[../Chaptername/]] 連結到章節,而不是使用完整的標題。
  • 從其他書籍和專案,如果只需要輸入一個變數,模板就會簡單得多,例如 {{See also [[Book/{{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)。這樣,印刷版本就可以生成自己的目錄。

華夏公益教科書