Help:風格

Jump to: navigation, search
內容指引
此 風格規範 涵蓋了如何建立或編輯以確保全篇有統一的外觀與感覺。他是基於類似的 Wikipedia 規範。下列規範包含編輯 openSUSE 文章時的詳細資訊。

一般使用

中性風格

使用中性寫作風格。儘量避免出現"我"、"我們"之類的人稱代名詞。

短而簡潔

當寫作時，想想你將在多短的時間內決定使是否會讀下去。拙劣的寫作與太過囉唆的文章將不會被閱讀。

  • 不要加入無關或冗長的內容。人們喜歡讀簡短而清晰的文章，讓他們能得到所需的資訊。他們會被無關的臃腫內容嚇跑。
  • 從頭到尾使用一貫的、不雜亂的格式。沒人會想讀胡亂分段或顏色的長篇大論。這樣只會拖慢閱讀速度趕走讀者。
  • 要讓你的文章有用且受歡迎， 保持短而簡潔!

參考 Wikipedia 上的文章開發。

結構

標題

  • 標題應該 清楚 及 簡短。參考 壞文章標題的範例
  • 不要使用奇怪的 簡稱, 除非確定他們是眾所週知的。
  • 不要使用 CamelCase(駝峰式大小寫)。請用空白代替。
  • 使用相同的大寫風格，如 Wikipedia。
  • 不要在標題使用冒號(:)，因為在 MediaWiki 他是作為名字空間使用。
  • 避免使用特殊字元。僅使用 [aA-zZ][0-9] 。

段落標題

  • 上方所有的標題規範也適用於段落標題。
  • 段落標題和內文表格分開一點，有助於閱讀與瀏覽。
  • 不要在第一個段落重複文章標題，冗餘不利於後續閱讀。
  • 不要使用 關於 或 介紹 當作第一個段落的名稱。任何文章的第1段本來就是主題的介紹。

內文標題

  • 使用 = 標記會建立一個內文標題。以這種方式會自動由內文標題建立表格，可幫助讀者直接到有興趣的章節。
  • 請由兩個等號 == 開始，而不是一個 =.
Icon-forbidden.png禁止 單一個等號 (=) 會產生和文章標題一樣大小的字體，一般的書寫格式不會用這種風格
  • 不要在內文標題使用連結。以此段落中第一次出現的字詞來做連結。
  • 將非常長的段落分割成數個子段落並使用子段落標題。
  • 使用 ---- 標記建立水平分隔線，放在第2階內文標題(==)之前，這樣可使閱讀文章更順利。
範例:
 ==內文標題 1==
 ===子標題 1.1===
 ===子標題 1.2===
 
 ----
 ==內文標題 2==
 ===子標題 2.2===
 ====子標題 2.2.1====
 =====子標題 2.2.1.1=====

 ----
 ==內文標題 3==

內容

openSUSE 的拼法

  • openSUSE 是唯一正確的拼法。 "OpenSUSE", "openSuSE", OpenSuse" 以及其他的變化都是錯誤的格式。 因為 MediaWiki 軟體無法處理小寫開頭 wiki 頁面標題，當頁面標題的開頭是 "openSUSE" 時，請使用 Template:Lowercase_title 模板。
  • 不必使用商標字元 (像是 © 或 ®) ，這會妨礙文章閱讀。
  • 注意 "SuSE Linux" 和 "SUSE Linux" 現在已不適用。除非是因為歷史因素要明確指出 openSUSE (10.1 以及更早的釋出)舊版本，或 SUSE Linux Enterprise Server (SLES) 或 SUSE Linux Enterprise Desktop (SLED)，請使用 "openSUSE"。

重複

不要重複工作。

簡稱與縮寫

  • 當在文章介紹新的簡稱，在他第一次出現的地方使用它的全名後面接著圓括號內的簡寫格式。例如: 段落標題自動產生 內容的表格(TOC)- table of contents (TOC)。
  • 避免複雜的縮寫，這會讓文章更難閱讀。
  • 永遠使用 標準 及眾所週知的縮寫，因為創新的名詞可能造成誤解。

變數

有時，一個指令是特指使用者的系統，像是一個系統裝置或使用者名稱。 習慣上是這樣寫的:

  • <username>, 例如在路徑指令 /home/<username>
  • sdX 針對某裝置

請注意:

  • 使用這種約定俗成的寫法通常需要去註明一下，例如: "用正確的裝置/使用者名稱 (sda, sdb, hda, 等) 來取代 sdX的位置"。
  • 如果多個裝置在一起討論，習慣寫成 sdX, sdY, sdZ。 如果多於3個裝置需要被標記，就由裝置 sdN 開始，其中N 是上一個 N 依照字母順序排列。

新手安全

警告 當遇到有些指引必須使用 root 權限執行某些指令，像是 dd, rm, fdisk, 請務必特別小心，如果不了解的話，可能會造成極大的損害。新手經常不了解而僅是複製與貼上指令:
  • 不要使用直接複製貼上會造成大災難的指令來當作範例。例如這個指令:
# dd if=openSUSE-11.2-KDE4-LiveCD-i686.iso of=/dev/sda

如果直接複製到指令行將覆蓋使用者的第一個硬碟。 /dev/sda 是第一個硬碟，他存在於每一台電腦中。使用下面指令代替: 

# dd if=openSUSE-11.2-KDE4-LiveCD-i686.iso of=/dev/sdX

會較安全，因為有極大的可能 /dev/sdX 並不會存在，所以會發生錯誤訊息並跳出 (這比覆蓋 sda 好多了)。

影像

位置

參閱 影像標示 了解建議的標示方式。 如何放置影像的概念與範例，請參閱 圖片教學。

格式

  • 繪圖、圖示與其他類似影像 (基本上這些都有大塊、簡單與連續的色塊) 應該使用 PNG 格式。
  • 照掭應使用 JPEG 格式。
  • 動畫應該使用動畫 GIF 格式。
請注意舊版本的文章無法顯示對應的舊版本影像，而是最新版影像, 除非影像檔案名稱已變更。


顏色

如果您想要加上顏色，請參考 使用說明:顏色 的顏色表，這是用在標準的 openSUSE 發行版本及網站顏色。

評論

  • 不要將文章內容和評論/問題混在一起。您可以使用文章討論頁面。
  • 如果您想和其他編輯者溝通，加上評論標籤，讓一般的讀者看不見。
 <!-- 這是一個看不見的評論。  -->

需要的頁面

要標示有需要撰寫某些文章，在既存的頁面建立所需文章的連結。 如果有兩個以上連結到同樣的不存在頁面，他將被列到 待撰頁面, 這可以當成許多新的 wiki 作者靈感的來源。然而並不是裏面的每一篇都是真的需要的，您的嘗試與經驗會告訴你如何由這些列表中選擇。

元件

當寫作時，記得使用下面的慣例。

Wiki 標記

對於可以使用 HTML 標籤 格式化的頁面，改用 MediaWiki 標示 將使原始碼文字更容易閱讀與編輯。 您也可以參考 Wiki 參考卡片 或一些文章的原始碼。

指令鍵

F5 以及 Tab

  • 程式碼: <code>Button to press</code>
  • 描述: 鍵盤上的按鍵。
  • 何處: 任何地方

指令路徑

/usr/src/linux 以及 /etc/SuSE-release

  • 程式碼: <tt>/path/to/directory/or/file</tt>
  • 描述: 目錄或檔案路徑描述。
  • 何處: 任何地方

指令輸入

$ user command
# root command
  • 程式碼: {{Shell|$ user command}}, {{Shell|# root command}} or <div class="shell">$ user/# root command</div>
  • 描述: 要輸入的指令。
  • 何處: 任何地方

指令輸出

output text
  • 程式碼: (空白)短輸出文字 或 <pre>長輸出文字</pre>
  • 描述: 描述輸入一個指令的結果。
  • 何處: 任何地方

會議副本

... 內容 ...
  • 程式碼: <div class="minutes"> ... 內容 ... </div>
  • 描述: 顯示會議副本。
  • 何處: 任何地方

表格

標題 1 標題 2 標題 3 標題 4 標題 5 標題 6
高亮度文字 高亮度文字 高亮度文字 文字 文字 高亮度文字
文字 文字 文字 文字 文字 高亮度文字
文字 文字 文字 文字 文字 高亮度文字
  • 程式碼: 看頁面原始碼。
  • 描述: 顯示一個表格(選項：高亮度文字)。
  • 何處: 任何地方

模板

參考 模板規範.

請參閱

外部連結

Retrieved from "https://zh-tw.opensuse.org/index.php?title=Help:風格&oldid=3944"