Trainz/本地風格手冊
“Trainz”的目標是作為學習工具和參考。我們的受眾包括希望填補手冊空白的新使用者。另一方面,我們也有希望提升技能的經驗豐富的使用者。如此廣泛的受眾可能會帶來挑戰。
我們採用了類似教科書的結構。我們引導讀者從他們通常的起點逐步學習越來越高階的主題。作者應牢記,每個部分都應以類似的方式進行。此外,作者不應假設讀者擁有本書以外的任何先驗知識。
華夏公益教科書由許多作者編寫。每本書都應該具有統一的“聲音”和風格。這為讀者提供了使用本書的一致體驗。本文件的其餘部分提供指南,幫助作者和編輯建立面向所有 Trainz 使用者的連貫且有價值的資源。
書籍要求一致地使用語言。至少目前,可以使用英國英語或美國英語。無論如何,貢獻者必須記住,英語不是許多 Trainz 使用者的母語。使用樸素語言原則,尤其是在詞語選擇和句子結構方面。在可能的情況下,貢獻者應嘗試對所有英語使用者保持中立,而不是依賴於特定地區的習慣用語或語言。
Trainz 將計算機軟體和鐵路運輸結合在一起。每個領域都有其自己的術語。作者不應假設讀者已經掌握了這兩個領域的術語。在第一次使用時定義專業術語,並在詞彙表中列出。
深層結構具有更強的內在組織性。“深層”意味著存在多個子頁面級別。“Trainz”使用深層結構,但貢獻者應避免定義超過四級的頁面(章節、部分、小節、主題)。
大多數書籍(包括華夏公益教科書和印刷版)都將所有單詞的首字母大寫,除了冠詞和介詞。不要在標題中使用“章節”、“部分”、“小節”或“主題”等詞。
有些書籍可能對頁面長度有限制(例如,維基百科人試圖限制文章的頁面長度)。
- 優點
- 限制頁面長度將使連線速度較慢的使用者更容易下載章節。
- 可能有助於為頁面長度設定任意限制,以使書籍更加一致。
- 缺點
- 可能會導致不必要的任意部分劃分。
使用模板為每個章節或頁面建立一致的結構通常很有幫助。模板可以使用標題、資訊框和其他功能來建立大綱,使書籍的每個章節都類似於其他章節。
有些書籍可能受益於使用標準化的章節模板。
- 優點
- 使書籍更加一致。
- 缺點
- 可能具有限制性。
- 使新貢獻者更難上手。
有些書籍可能對不同型別的頁面使用不同的模板。例如,《食譜》使用不同的模板來顯示食譜、食材等。
- 優點
- 允許為討論一般主題型別的頁面提供更定製(但一致)的風格。
- 缺點
- 可能會使新貢獻者難以上手。
一些非常有用且美觀的模板可以使用解析器功能來建立。
- 優點
- 美觀且靈活。
- 缺點
- 缺乏經驗的作者難以使用。
將連結限制在書籍的章節內,會使書籍“自成一體”。
- 優點
- 使書籍保持完整,無需依賴外部資源。
- 缺點
- 需要為每個術語建立一個新頁面
可以使用方括號內的字首在維基媒體專案之間建立連結。w: 指向維基百科,wikt: 指向維基詞典,等等。
- 優點
- 允許對術語進行簡單解釋
- 缺點
- 使書籍依賴於其他專案。如果進行了這種連結,作者應該定期檢查以確保目標頁面沒有被移動。
書籍可能只在某些情況下使用維基連結,當連結到的資訊遠遠超出書籍的範圍時。
- 優點
- 缺點
- 關於
- 優點
- 缺點
- 關於
- 優點
- 缺點
"合理使用" 影像是指那些受版權保護,但被認為是公眾使用範圍內的影像。
- 優點
- 允許使用比不接受合理使用影像的書籍更多的影像。
- 缺點
- 這絕對是法律上的灰色地帶,也許最好乾脆避免使用這些影像。
在華夏公益教科書中使用的影像可以儲存在華夏公益教科書影像名稱空間中,也可以儲存在維基共享資源中。
- 優點
- 透過僅使用維基共享資源上的影像,可以更容易地將書籍進行跨維基轉存(例如,如果德語華夏公益教科書想要進行翻譯,他們可以將它複製過來,而不需要追查影像)。
- 這些影像可能會在維基共享資源上被組織到相簿或分類中,這可能會引導作者找到與書籍相關或更適合的影像。
- 缺點
- 維基共享資源不允許使用合理使用影像。
縮圖是影像的小版本,可以透過點選進行展開。
- 優點
- 允許在頁面上放置許多影像,而不會佔用太多空間或頻寬。
- 缺點
- 縮圖通常太小,在印刷版本中無法使用。
- 優點
- 將整本書“放在一個地方”,因此易於跟蹤。
- 缺點
- 對於包含超過 200 頁的較大型書籍,分類頁面將被分解。
- 限制了書籍的組織方式
- 優點
- 有助於組織特定書籍的相關部分
- 缺點
- 使得難以一次看到所有章節。
- 優點
- 使書籍更“可見”,對於使用分類系統進行導航或查詢其他書籍的源材料的讀者而言。
- 缺點
- 可能會用很長的分類列表弄亂頁面底部。
數學、科學和工程類書架中的許多書籍都使用了數學公式。此外,這些書籍還經常依賴各種符號來表示不同的數學概念。只要書籍使用這些公式或符號,就應該在整本書中保持一致。
- 在所有頁面上使用 __NOTOC__ 嗎?(這在印刷版本中看起來更好)
許多書籍都有可列印版本,有些書籍甚至有多個可列印版本。許多書籍還包含 PDF 版本,便於閱讀和下載。印刷版本應使用頁面轉錄,以便主書籍頁面上的所有更新自動反映在印刷版本文字中。PDF 版本可能需要定期更新,以保持與文字的一致性。
有一些專門的模板可用於印刷版本和 PDF 版本。有關更多資訊,請參閱 幫助:印刷版本。
印刷版本通常可能希望使用 __NOTOC__ 魔術詞來抑制書籍中自動生成的 TOC。這樣,印刷版本就可以生成自己的 TOC。[[category:Trainz Admin|*風格指南}}