帮助:格式

tagline: 来自openSUSE

编写条目时请遵照本篇约定,以使维基有有统一的风格感受。其他格式可以参考维基百科的格式手册

文章内容格式要求

安全性

  • 凡可能带来非预期后果的操作均需注明可能后果。
  • 请勿使用可能造成严重后果的命令作为范例,若非用不可,请变更某些参数,以防不知情者因此而招致损失。
如以“# 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"等。
  • 如果讨论多个设备,习惯上写成 sdXsdYsdZ 等。

页面代码格式要求

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
  • 程式码: 看页面原始码
  • 描述: 显示一个表格