Help:格式
编写条目时请遵照本篇约定,以使维基有有統一的风格感受。其他格式可以参考维基百科的格式手册。
目录
文章内容格式要求
安全性
- 凡可能带来非预期后果的操作均需注明可能后果。
- 请勿使用可能造成严重后果的命令作为范例,若非用不可,请变更某些参数,以防不知情者因此而招致损失。
如以“# dd if=openSUSE-11.2-KDE4-LiveCD-i686.iso of=/dev/sdX”替代“# dd if=openSUSE-11.2-KDE4-LiveCD-i686.iso of=/dev/sda”命令。
openSUSE 的拼法
- openSUSE 是唯一正確的拼法,OpenSUSE、openSuSE、OpenSuse 或其他拼法均是错误的。
因為 MediaWiki 軟體無法處理小寫開頭 wiki 頁面標題,當頁面標題的開頭是 "openSUSE" 時,請使用 Template:Lowercase_title 模板。
- "SuSE Linux" 和 "SUSE Linux" 現已不再適用,除非特意使用,否则请使用 "openSUSE"。
簡稱與縮寫
- 當文章中使用简称时,在其后面标明全称。如,TOC (table of contents)。
- 使用標準及眾所週知的縮寫。
中英文混排
- 英文和数字使用半角字符
- 中文文字之间不加空格
- 中文文字与英文、阿拉伯数字及 @ # $ % ^ & * . ( ) 等符号之间加空格
- 中文标点之间不加空格
- 中文标点与前后字符(无论全角或半角)之间不加空格
- 如果括号内有中文,则使用中文括号,如果括号中的内容全部都是英文,则使用半角英文括号
- 当半角符号 / 表示“或者”之意时,与前后的字符之间均不加空格
变量
有时命令需要指定系统设备或用户名,可以遵照以下方式处理:
- 以 <username> 代指用户名, 如 /home/<username>。
- 以 sdX 代指系统设备。
- 通常该情况下需要註明如"用正確的设备名稱替代 sdX"等。
- 如果讨论多個设备,習慣上寫成 sdX、sdY、sdZ 等。
页面代码格式要求
Wiki 標記
對於可以使用 HTML 標籤 格式化的頁面,改用 MediaWiki 標示 將使原始碼文字更容易閱讀與編輯。
鍵盤按鍵
[Alt+F5]
、[Enter]
- Code:
<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}}
或<div class="shell">$ user/# root command</div>
- 描述: 要輸入的指令
命令輸出
output text
output text line
- 程式碼:
輸出文字
或<pre>輸出文字</pre>
- 描述: 描述輸入一個指令的結果
习惯上也用于命令输入。
會議副本
... 內容 ...
- 程式碼:
<div class="minutes"> ... 內容 ... </div>
- 描述: 顯示會議副本
表格
標題 1 | 標題 2 | 標題 3 |
---|---|---|
1 | 2 | 3 |
4 | 5 | 6 |
- 程式碼: 看頁面原始碼
- 描述: 顯示一個表格