Difference between revisions of "Help:Style (简体中文)"

From ArchWiki
Jump to: navigation, search
(Update translation)
(update translation)
Line 8: Line 8:
 
{{Article summary heading|相关}}
 
{{Article summary heading|相关}}
 
{{Article summary wiki|Help:Editing (简体中文)}}
 
{{Article summary wiki|Help:Editing (简体中文)}}
{{Article summary wiki|Help:Reading (简体中文)}}
+
{{Article summary wiki|Help:Reading}}
 
{{Article summary end}}
 
{{Article summary end}}
 
{{TranslationStatus (简体中文)|Help:Style|2013-04-07|253095}}
 
{{TranslationStatus (简体中文)|Help:Style|2013-04-07|253095}}
Line 62: Line 62:
 
*[[:Category:Template#Article_status_templates|文章状态模板]] 可以放在分类(或语言间链接)和文章摘要之间。
 
*[[:Category:Template#Article_status_templates|文章状态模板]] 可以放在分类(或语言间链接)和文章摘要之间。
 
*文章状态模板也可以用于文章的某个段落。
 
*文章状态模板也可以用于文章的某个段落。
*讨论页面应该包含文章状态模板的解释说明。
+
*每个状态模版都应该包含简要的说明,如果需要,可以在讨论页面进行讨论。
  
 
===摘要===
 
===摘要===
Line 86: Line 86:
  
 
===代码格式模板===
 
===代码格式模板===
*使用 {{ic|<nowiki>{{ic|code}}</nowiki>}} 格式化嵌入的短代码、文件名、命令名、变量名等。例如: <br> foo {{ic|code}} bar.
+
*使用 {{ic|<nowiki>{{ic|code}}</nowiki>}} 格式化嵌入的短代码、文件名、命令名、变量名等。例如: <br> 在终端运行{{ic|sh ./hello_world.sh}}
 
*使用 {{ic|<nowiki>{{bc|code}}</nowiki>}} 格式化当行或多行代码(命令行输入或输出代码和文件内容) 例如:
 
*使用 {{ic|<nowiki>{{bc|code}}</nowiki>}} 格式化当行或多行代码(命令行输入或输出代码和文件内容) 例如:
{{bc|# iwconfig}}
+
{{bc|$ sh ./hello_world.sh}}
{{bc|1=lo no wireless extensions.
+
{{bc|Hello World}}
eth0 no wireless extensions.
+
wlan0    unassociated  ESSID:""
+
        Mode:Managed  Channel=0  Access Point: Not-Associated
+
        Bit Rate:0 kb/s  Tx-Power=20 dBm  Sensitivity=8/0
+
        Retry limit:7  RTS thr:off  Fragment thr:off
+
        Power Management:off
+
        Link Quality:0  Signal level:0  Noise level:0
+
        Rx invalid nwid:0  Rx invalid crypt:0  Rx invalid frag:0
+
        Tx excessive retries:0  Invalid misc:0  Missed beacon:0}}
+
 
{{bc|#!/bin/sh
 
{{bc|#!/bin/sh
  
Line 105: Line 96:
 
*短代码可以在行首加入空格替代 {{ic|<nowiki>{{bc|code}}</nowiki>}} (参见 [[Help:Editing (简体中文)|编辑帮助]])。
 
*短代码可以在行首加入空格替代 {{ic|<nowiki>{{bc|code}}</nowiki>}} (参见 [[Help:Editing (简体中文)|编辑帮助]])。
 
*使用 {{ic|<nowiki>{{hc|input|output}}</nowiki>}} 同时显示命令行及其输出,例如:
 
*使用 {{ic|<nowiki>{{hc|input|output}}</nowiki>}} 同时显示命令行及其输出,例如:
{{hc|# iwconfig|<nowiki>lo no wireless extensions.
+
{{hc|$ sh ./hello_world.sh|Hello World}}
eth0 no wireless extensions.
+
wlan0    unassociated  ESSID:""
+
        Mode:Managed  Channel=0  Access Point: Not-Associated
+
        Bit Rate:0 kb/s  Tx-Power=20 dBm  Sensitivity=8/0
+
        Retry limit:7  RTS thr:off  Fragment thr:off
+
        Power Management:off
+
        Link Quality:0  Signal level:0  Noise level:0
+
        Rx invalid nwid:0  Rx invalid crypt:0  Rx invalid frag:0
+
        Tx excessive retries:0  Invalid misc:0  Missed beacon:0</nowiki>}}
+
 
*需要显示文件内容时,可以使用 {{ic|<nowiki>{{hc|filename|content}}</nowiki>}} 明确内容属于哪个文件,例如:
 
*需要显示文件内容时,可以使用 {{ic|<nowiki>{{hc|filename|content}}</nowiki>}} 明确内容属于哪个文件,例如:
 
{{hc|~/hello_world.sh|<nowiki>
 
{{hc|~/hello_world.sh|<nowiki>
Line 159: Line 141:
 
====官方软件包====
 
====官方软件包====
 
* 请避免使用从官方软件仓库安装软件包的 pacman 命令示例:这样既简单(每个 Arch 用户都应该记住如何使用 [[pacman (简体中文)|pacman]])又可以避免{{Ic|pacman -Sy package}} 之类的错误,还可以避免 {{Ic|pacman -S package}} 和 {{Ic|pacman -Syu package}} 孰好孰坏的争论。所以也不要建议使用 pacman 前端或图形界面。<br> 请使用类似下面这样的简单语句:安装说明应该使用: <br/> <span style="margin:0 1em;">[[pacman (简体中文)|安装]]位于[[Official Repositories (简体中文)|官方软件仓库]]的 {{Pkg|package}}。 <br> Wiki 文字是 {{Ic|<nowiki>[[pacman (简体中文)|安装]]位于[[Official Repositories (简体中文)|官方软件仓库]]的 {{Pkg|package}}</nowiki>}} <br> 安装一系列软件包的说明应该是: <br> <span style="margin:0 1em;">[[pacman (简体中文)|安装]]位于[[Official Repositories (简体中文)|官方软件仓库]]的  {{Pkg|package1}}、{{Pkg|package2}} 和 {{Pkg|package3}}。<br>可以根据需要对词句进行修改。
 
* 请避免使用从官方软件仓库安装软件包的 pacman 命令示例:这样既简单(每个 Arch 用户都应该记住如何使用 [[pacman (简体中文)|pacman]])又可以避免{{Ic|pacman -Sy package}} 之类的错误,还可以避免 {{Ic|pacman -S package}} 和 {{Ic|pacman -Syu package}} 孰好孰坏的争论。所以也不要建议使用 pacman 前端或图形界面。<br> 请使用类似下面这样的简单语句:安装说明应该使用: <br/> <span style="margin:0 1em;">[[pacman (简体中文)|安装]]位于[[Official Repositories (简体中文)|官方软件仓库]]的 {{Pkg|package}}。 <br> Wiki 文字是 {{Ic|<nowiki>[[pacman (简体中文)|安装]]位于[[Official Repositories (简体中文)|官方软件仓库]]的 {{Pkg|package}}</nowiki>}} <br> 安装一系列软件包的说明应该是: <br> <span style="margin:0 1em;">[[pacman (简体中文)|安装]]位于[[Official Repositories (简体中文)|官方软件仓库]]的  {{Pkg|package1}}、{{Pkg|package2}} 和 {{Pkg|package3}}。<br>可以根据需要对词句进行修改。
* 必须用[[Template:Pkg]]模板给出软件包的链接,例如{{Ic|<nowiki>{{Pkg|package}}</nowiki>}}. <br> 上例中同时给出了 [[pacman (简体中文)|pacman]] 的隐性链接({{ic|<nowiki>[[pacman (简体中文)|安装]]</nowiki> ...}}) 和 [[Official Repositories (简体中文)|官方软件仓库]]的链接({{ic|<nowiki>[[official repositories]]</nowiki>}}): 建议至少在文章的第一个安装指令中使用这些链接,特别是 Arch 新手经常访问的页面。
+
* 必须用[[Template:Pkg]]模板给出软件包的链接,例如{{Ic|<nowiki>{{Pkg|package}}</nowiki>}}.
 +
* 上例中同时给出了 [[pacman (简体中文)|pacman]] 的隐性链接({{ic|<nowiki>[[pacman (简体中文)|安装]]</nowiki> ...}}) 和 [[Official Repositories (简体中文)|官方软件仓库]]的链接({{ic|<nowiki>[[official repositories]]</nowiki>}}): 建议至少在文章的第一个安装指令中使用这些链接,特别是 Arch 新手经常访问的页面。
 
* 在[[Beginners' Guide (简体中文)|新手指南]]及其子页面中推荐使用 pacman 命令,新用户还不太会 pacman。
 
* 在[[Beginners' Guide (简体中文)|新手指南]]及其子页面中推荐使用 pacman 命令,新用户还不太会 pacman。
 
*不要给出软件包是在 [core]、[extra] 或 [community],因为一个软件包可能在不同源之间切换。如果软件包位于 [multilib],请使用:<br> <span style="margin:0 1em;">[[pacman (简体中文)|安装]]位于[[Official Repositories (简体中文)|官方软件仓库]]的 {{Pkg|package}},需要开启 [[multilib]]。<br>
 
*不要给出软件包是在 [core]、[extra] 或 [community],因为一个软件包可能在不同源之间切换。如果软件包位于 [multilib],请使用:<br> <span style="margin:0 1em;">[[pacman (简体中文)|安装]]位于[[Official Repositories (简体中文)|官方软件仓库]]的 {{Pkg|package}},需要开启 [[multilib]]。<br>
Line 166: Line 149:
 
*安装 AUR 软件包的语句应该类似:<br> <span style="margin:0 1em;"></span> 安装 [[Arch User Repository (简体中文)|AUR]] 中的 {{AUR|package}}。<br> Wiki 文字为 {{Ic|<nowiki> 安装 [[Arch User Repository (简体中文)|AUR]] 中的 {{AUR|package}}。</nowiki>}} <br> 可以适当修改以适应具体文章,但是请明确指出软件包并非官方支持。
 
*安装 AUR 软件包的语句应该类似:<br> <span style="margin:0 1em;"></span> 安装 [[Arch User Repository (简体中文)|AUR]] 中的 {{AUR|package}}。<br> Wiki 文字为 {{Ic|<nowiki> 安装 [[Arch User Repository (简体中文)|AUR]] 中的 {{AUR|package}}。</nowiki>}} <br> 可以适当修改以适应具体文章,但是请明确指出软件包并非官方支持。
 
*不要给出如何安装 AUR 软件包的示例:每一个安装非官方软件包的用户都应该阅读 [[Arch User Repository (简体中文)|Arch 用户仓库]],并了解使用这些包会给系统带来的影响。
 
*不要给出如何安装 AUR 软件包的示例:每一个安装非官方软件包的用户都应该阅读 [[Arch User Repository (简体中文)|Arch 用户仓库]],并了解使用这些包会给系统带来的影响。
*[[Beginners' Guide (简体中文)|新手指南]] 及其子页面是唯一例外.
+
*到软件包的链接应该使用 [[Template:AUR]] 模版,例如{{Ic|<nowiki>{{AUR|package}}</nowiki>}}.
  
 
===内核模块操作===
 
===内核模块操作===
*修改 {{ic|/etc/rc.conf}},添加模块到 {{Ic|MODULES}} 数组的方法已经过时:标准的方法是列出要用的模块,说明依赖模块和冲突模块,然后链接到[[Kernel modules (简体中文)|内核模块一文]]。
+
*给出装入、删除、屏蔽等模块基本操作的方式已经过时,标准方法是描述要执行的动作,说明依赖模块和冲突模块,然后链接到[[Kernel modules (简体中文)|内核模块一文]]。
*给出装入、删除、屏蔽等模块基本操作的方式已经过时,标准方法是描述要执行的动作,然后转到[[Kernel modules (简体中文)|内核模块一文]]
+
*[[Beginners' Guide|新手指南]]和子页是唯一的例外。
  
 
===守护进程操作===
 
===守护进程操作===
*给出添加守护进程到 {{ic|/etc/rc.conf}} 的 {{Ic|DAEMONS}} 数组的方法已经过时:标准的方法应该是列出需要的守护进程以及它们的依赖关系、相互冲突,然后给出到 [[Daemon (简体中文)| Daemon]] 的链接。
+
*给出 ''start''、 ''restart'' 或 ''stop'' 守护进程示例的方法已经过时:标准的方法应该是列出需要的守护进程以及它们的依赖关系、相互冲突,然后给出到 [[Daemon (简体中文)| Daemon]] 的链接。
*给出 ''start''、 ''restart'' 或 ''stop'' 守护进程示例的方法已经过时:标准方法是描述要执行的动作,然后给出到 [[Daemon (简体中文)| Daemon]] 的链接。<br> 然而,如果需要的动作不是这几个标准操作,可以给出示例。
+
 
*[[Beginners' Guide (简体中文)|新手指南]] 及其子页面是唯一例外.
 
*[[Beginners' Guide (简体中文)|新手指南]] 及其子页面是唯一例外.
 +
 +
===代码规范===
 +
* 添加命令或脚本时,请保持代码风格一致,可以参考其它的相关文章,并遵守所用代码语言的一般规范。
 +
* 避免使用过时的语言功能和风格,例如推荐使用 {{ic|$()}} 做命令执行,而不是{{ic|``}}.
  
 
===注意, 警告, 技巧===
 
===注意, 警告, 技巧===
Line 264: Line 250:
 
==一般规则==
 
==一般规则==
 
===编辑摘要===
 
===编辑摘要===
*一些专职人员和志愿者每天都会检查所有的修改,你应该帮助他们,给每个修改添加摘要。
+
*一些[[ArchWiki:Maintenance Team|专职人员]]和志愿者每天都会检查所有的修改,你应该帮助他们,给每个修改添加摘要。
 
**如果编辑是 [[Wikipedia:Help:Minor edit|小改动]],例如语法或词句的修改,请标记为小改动并简单描述。
 
**如果编辑是 [[Wikipedia:Help:Minor edit|小改动]],例如语法或词句的修改,请标记为小改动并简单描述。
 
**如果进行大改动,例如添加、移动、删除或修改内容,除了提供摘要外,应该解释修改的'''原因''',如果有相关的 wiki 页面或论坛帖子,请提供链接。
 
**如果进行大改动,例如添加、移动、删除或修改内容,除了提供摘要外,应该解释修改的'''原因''',如果有相关的 wiki 页面或论坛帖子,请提供链接。

Revision as of 02:46, 8 June 2013

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary wiki Template:Article summary wiki Template:Article summary end

翻译状态: 本文是英文页面 Help:Style翻译,最后翻译时间:2013-04-07,点击这里可以查看翻译后英文页面的改动。

这些风格约定鼓励简约、有条理和视觉一致的文章。请在编辑 ArchWiki 时尽量遵守本文的指导。

文章页面

标题

  • 使用全名而不是缩写。如果您认为两者都很常用,创建一个从缩写到全名的重定向 。不要用括号包含缩写。
  • 参见 文章命名指导

布局

ArchWiki 上的文章应该分为两部分:前言主体。大部分文章遵循如下顺序:

  • 前言:由分类、i18n、文章状态、概览和简介
  • 主体内容: 介绍、安装、配置、技巧、问题解决和更多资源
  • 文章各部分的排列顺序应该为:
  1. #特殊字段 (可选)
  2. 分类
  3. 语言间链接
  4. 文章状态模板 (可选)
  5. 文章摘要 (可选)
  6. 前言或介绍
  7. 目录 (自动生成)
  8. 文章特有的部分

特殊字段

  • 特殊字段会修改文章的显示或行为,但是不会向文章添加内容。这些字段应该位于文章的最开始
    特别是如下两个:{{DISPLAYTITLE:title}}Template:Lowercase title,要放到文章的开始。

分类

  • 每个文章至少应该属于一个分类。
  • 一个文章可以属于多个分类,只要分类间没有包含关系。
  • 分类必须放在文章的顶部,特殊字段之后。
注意: 这点和其它 MediaWiki 项目可能不同,它们经常把分类放在文章末尾。
  • 分类和语言间链接或第一行文字之间不应该有空格,否则文章顶部会有多余的空白。
  • 参见 重新归类文章
提示:
  • 由于分类页面中,MediaWiki会把相同首字母的页面归到一栏中,对于中文标题的页面,会把每个起始汉字归到一类,导致页面很混乱。因此在为名称由中文起始的页面,添加分类时请同时添加汉语拼音的首字母,如官方安装指南可以添加如下分类:[[Category:简体中文|G]],这样该页面就会归类到字母G一栏的最上方。
  • 不要添加多个字母(如:[[Category:简体中文|GFAZZN]]),否则会出现分类中中英文页面顺序混排的现象,使页面不便于查找。

语言间链接

  • 如果文章有其他语言的翻译,必须在分类和第一段文字直接加上语言间链接。它们将显示在页面的左边。
  • 添加语言间链接时应该修改所有语言的翻译。
  • 语言间链接和第一行文字之间不应该有空格,否则文章顶部会有多余的空白。
  • 一个语言的语言间链接应只有一个。
  • 不要加入当前语言的语言间链接。
  • 语言间链接需要根据语言标签按字母表顺序排列,不要按语言名顺序排列。
  • 参见 Help:i18nWikipedia:Help:Interlanguage links.

文章状态模板

  • 文章状态模板 可以放在分类(或语言间链接)和文章摘要之间。
  • 文章状态模板也可以用于文章的某个段落。
  • 每个状态模版都应该包含简要的说明,如果需要,可以在讨论页面进行讨论。

摘要

  • 描述文章的结构和所包含的内容
  • 可以放在分类、语言间链接和文章状态模板后面。
  • 参见 Writing Article Overviews

前言或介绍

  • 描述文章的话题。
    不要自己给软件下评论,一般可以访问项目主页,使用作者自己的描述。MediaTomb 是一个范例。
  • 紧随文章摘要放置
  • 不要另外加上 ==Introduction====Preface== 说明:直接在第一段开始时写入即可。如果文章有足够多的段落,在前言和第一段直接会自动加入目录。
  • 参见 撰写文章介绍

段落标题

  • 段落标题应该从第二级开始(==), 因为第一级保留给文章标题使用。
  • 使用子标题时不要跳过级别,所以二级标题下面应该是三级标题。
  • 避免在标题中使用链接,它们会影响样式的一致性。
    同样避免使用任何 html 或 wiki 标记代码,包括 代码格式模板
  • 参见 有效使用标题

空行

代码格式模板

  • 使用 {{ic|code}} 格式化嵌入的短代码、文件名、命令名、变量名等。例如:
    在终端运行sh ./hello_world.sh
  • 使用 {{bc|code}} 格式化当行或多行代码(命令行输入或输出代码和文件内容) 例如:
$ sh ./hello_world.sh
Hello World
#!/bin/sh

# Demo
echo "Hello World"
  • 短代码可以在行首加入空格替代 {{bc|code}} (参见 编辑帮助)。
  • 使用 {{hc|input|output}} 同时显示命令行及其输出,例如:
$ sh ./hello_world.sh
Hello World
  • 需要显示文件内容时,可以使用 {{hc|filename|content}} 明确内容属于哪个文件,例如:
~/hello_world.sh
#!/bin/sh

# Demo
echo "Hello World"

命令行文字

  • 使用 $ 作为一般用户权限命令的提示符;使用 # 作为 root 命令的提示符。
    注意: 因为 # 也用来表示文本文件中的命令,应该明确说明是运行命令还是编辑文件以避免误解。
  • 引入命令的句子应该总是以 : 结尾。
  • 建议使用 # command 而不是 $ sudo command
  • 不要假定用户会使用 sudo 或其它权限获取工具(例如 gksukdesu)。
  • 应该避免使用# sudo command,唯一的例外是用sudo-u选项修改用户,这时提示符可以与其它命令一致,默认使用$
  • 不要在同一个框中使用两个命令行,例如# pacman -S foo #Install package foo
  • 避免写太长的代码行:尽可能使用换行。

需要文件编辑

  • 除非必要,请不要指定某个编辑器(nano, vim, emacs, ...)。
  • 除非必要,请不要使用隐含的编辑命令,例如 $ echo -e "clear\nreset" >> ~/.bash_logout 应该写成:
将下行附加到 ~/.bash_logout:
clear
reset

键盘按键

软件包管理

官方软件包

  • 请避免使用从官方软件仓库安装软件包的 pacman 命令示例:这样既简单(每个 Arch 用户都应该记住如何使用 pacman)又可以避免pacman -Sy package 之类的错误,还可以避免 pacman -S packagepacman -Syu package 孰好孰坏的争论。所以也不要建议使用 pacman 前端或图形界面。
    请使用类似下面这样的简单语句:安装说明应该使用:
    安装位于官方软件仓库package
    Wiki 文字是 [[pacman (简体中文)|安装]]位于[[Official Repositories (简体中文)|官方软件仓库]]的 {{Pkg|package}}
    安装一系列软件包的说明应该是:
    安装位于官方软件仓库package1package2package3
    可以根据需要对词句进行修改。
  • 必须用Template:Pkg模板给出软件包的链接,例如{{Pkg|package}}.
  • 上例中同时给出了 pacman 的隐性链接([[pacman (简体中文)|安装]] ...) 和 官方软件仓库的链接([[official repositories]]): 建议至少在文章的第一个安装指令中使用这些链接,特别是 Arch 新手经常访问的页面。
  • 新手指南及其子页面中推荐使用 pacman 命令,新用户还不太会 pacman。
  • 不要给出软件包是在 [core]、[extra] 或 [community],因为一个软件包可能在不同源之间切换。如果软件包位于 [multilib],请使用:
    安装位于官方软件仓库package,需要开启 multilib

AUR 软件包

  • 安装 AUR 软件包的语句应该类似:
    安装 AUR 中的 packageAUR
    Wiki 文字为 安装 [[Arch User Repository (简体中文)|AUR]] 中的 {{AUR|package}}。
    可以适当修改以适应具体文章,但是请明确指出软件包并非官方支持。
  • 不要给出如何安装 AUR 软件包的示例:每一个安装非官方软件包的用户都应该阅读 Arch 用户仓库,并了解使用这些包会给系统带来的影响。
  • 到软件包的链接应该使用 Template:AUR 模版,例如{{AUR|package}}.

内核模块操作

  • 给出装入、删除、屏蔽等模块基本操作的方式已经过时,标准方法是描述要执行的动作,说明依赖模块和冲突模块,然后链接到内核模块一文
  • 新手指南和子页是唯一的例外。

守护进程操作

  • 给出 startrestartstop 守护进程示例的方法已经过时:标准的方法应该是列出需要的守护进程以及它们的依赖关系、相互冲突,然后给出到 Daemon 的链接。
  • 新手指南 及其子页面是唯一例外.

代码规范

  • 添加命令或脚本时,请保持代码风格一致,可以参考其它的相关文章,并遵守所用代码语言的一般规范。
  • 避免使用过时的语言功能和风格,例如推荐使用 $() 做命令执行,而不是``.

注意, 警告, 技巧

  • 注意 应该用在用户预料不到的地方。包括与文章关系不大的细节知识、软件包名称更改等。
    注意也可以用来强调容易被用户忽略的信息。
  • 警告 用来指出需要特别注意的地方,比如无法恢复的修改、可能损害系统等。警告应该指出最坏的情况,并给出避免这些情况的方法。
  • 小贴士 用来给出一个有用的小技巧,一般与系统直接关系不大,可以安全。
  • 如果多个注意、警告、技巧连用,最好组合到单一模板中,除非相互毫无关系。例如:
提示:
  • Tip example #1.
  • Tip example #2.

Shells

  • 除非必要情况,不要假定用户使用的 shell:编辑文章时请尽量做到 shell 无关性。

超级链接

  • 尽最大可能增加页面间的链接
  • 系统调用 之类的文章 ArchWiki 没有介绍,直接链接到 Wikipedia 页面。
  • 链接到 wiki 中其它页面时,不要使用完整地址,使用 wiki 间链接语法:[[Wiki Article]]。 wiki 引擎可以跟踪 wiki 间链接,更容易维护。
    更多 wiki 间链接内容参见 Help:Editing (简体中文)#链接
  • 除极个别情况外,页面不应该是死页面(没有任何到其它页面的链接)和孤立页面(没有其它文章链接到它).
  • 添加内容时,首先检查是不是已经有文章描述了详细内容,如果有,请链接到它而不是重复内容。
  • 如果上游的文档完善且维护良好,请只写 Arch 特有的部分,并提供到一般信息的链接。
  • 不要在同一语言的链接中用 wiki 间链接,它们无法在 Special:WhatLinksHere 页面正确显示。例如在简体中文页面中不应该使用 [[:zh-CN:Main Page]],而应该使用 [[Main Page (简体中文)]]
    在不同语言间则应该使用这种链接,因为这样将他们移动到外部站点时会更加简单。
    注意这些链接和#语言间链接是不同的,语言间链接前面没有冒号。

"提示与技巧" 段落

  • 高级技巧或使用软件的示例
  • 标准标题是 提示与技巧
  • 用子段落分别介绍不同的技巧

"问题解决" 段落

  • 软件常见问题的解决方法(与 #"已知问题" 段落 不同)。
  • 标准标题是 问题解决
  • 可以提供绕过已知 bug 的临时解决方法,但是请务必提供 bug 的链接地址,如果尚未报告,请报告 bug,这样更容易被修复。
    增加 bug 链接对读者和编辑有如下好处:
    • 对读者来说,Wiki 不是终止:他们可以访问链接,获取更多信息。
    • 对 Wiki 编辑来说,更容易判断 bug 是否已经解决,清理更加容易;如果读者发现新的信息,他们也可以自主编辑。

"已知问题" 段落

  • 已知的 bug 或者使用问题,暂时还没有解决方法(与#"问题解决" 段落相反)。
  • 标准标题是已知问题.
  • 如果这个问题已经报告了 bug,请提供链接;如果没有报告,请报告它,这样会提高问题解决的概率。

"参见" 段落

  • 列出参考文档和额外信息.
  • 应该是个列表,每行都以 * 开头。
  • 一般使用 "参见" 作为标题,应该避免使用"外部链接","更多资源" 等。

不相关内容

  • 请不要署名,不要把文章归功于自己:ArchWiki 是社区的工作,每个文章的历史已经足够说明个人贡献。
    鼓励记录信息的来源:可以用 "参见" 段落实现。
  • 一般用户没有上传文件的权限,而且不允许用户使用图片。作为替代,可以给出外部链接或者用 ASCII 编辑器如Asciiflow 等绘制简单图形。原因:
    • 维护性: Arch 是滚动发行,图片会加大更新文章的难度。
    • 必要性: Arch 不开发或维护图形程序,所以不需要显示截图。
    • 监控: 允许自行上传图片需要更多的时间删除重复和不合适的图片。
    • 访问性: 有些用户的网络很慢,纯文字页面更加简单和清晰,加快浏览速度。
    • 有效性:图片会浪费服务器的带宽和存储空间。

语域用词

  • 文章应该使用正式,专业和精确的用语
  • 编写时,请注意不光回答怎么样,还要回答为什么? 解释说明可以比单纯的指导更好的传递信息。
  • 避免不必要的缩写词。
  • 不要加入个人评论,个人评论应该放到讨论页面,一般不要用第一人称

讨论页面

  • 在讨论页面最后面增加一个新话题并提供合适的标题。也可以使用讨论页面顶部的 + 标签。
  • 用冒号缩进每个回答。
  • 不要编辑别人已经回复的讨论,否则将会改变讨论的过程,其他人很难进一步讨论。只允许添加删除线(使用<s> tags) 而且必须提供相应的解释。
  • 所有编辑都加上签名(~~~~).
  • 讨论页面不应该有分类。
  • 如果话题结束,可以给讨论内容加上删除线 <s> 标记。
    结束的话题过一段时间后应该删除。
  • 参见 Help:Editing (简体中文)#讨论页面.

分类页面

重定向页面

  • 重定向页面应该只包含重定向链接,没有其他任何内容。
  • 只重定向到内部 Wiki 页面,不要重定向到外部页面。

模板页面

用户页面

  • 用户页面不应该分类(除非极个别管理员允许的特例)。

一般规则

编辑摘要

  • 一些专职人员和志愿者每天都会检查所有的修改,你应该帮助他们,给每个修改添加摘要。
    • 如果编辑是 小改动,例如语法或词句的修改,请标记为小改动并简单描述。
    • 如果进行大改动,例如添加、移动、删除或修改内容,除了提供摘要外,应该解释修改的原因,如果有相关的 wiki 页面或论坛帖子,请提供链接。
    • 讨论页面中加入内容并不需要解释,因为原因很明显
      而删除讨论时,应该提供一些说明(例如"closed discussion," "fixed,"等.) 同时给出讨论的标题以方便历史查询和重新打开。
提示: 查看 最近更改 中的摘要可以学习其他人是如何做的,但是请注意并不是所有人都遵循这些准则。
  • 执行大的改动时,最好将其分到多个编辑操作中,根据逻辑步骤一步一步完成。
    特别是在文章中或文章之间移动段落时,应该避免在同一个编辑中进行内容修改,否则很难查看修改的具体内容。

HTML 标签

  • 尽量不要使用 HTML 标签:尽量使用 wiki 标记和模板,参见 编辑帮助
  • 使用 <pre>code</pre> 的地方都改成 {{bc|code}}。使用 <tt>text</tt><code>text</code> 的地方,都改用 {{ic|text}}
  • 特别是避免 HTML 注释(<!-- comment -->): 一般使用 HTML 注释的文字都可以放到讨论页面。
    可以加入适当的 文章状态模板
  • 仅在必要时才使用 <br>:要开启新段落时,用后面的空行实现。
    一个例外是作为一个列表的子项目时,或者在一个模板当中,这时必须使用<br>换行。