Help:Editing (简体中文)
ArchWiki 使用的 MediaWiki是一个用 PHP 写成的软件包,最早用于 Wikipedia。本文是编辑 ArchWiki 的简短教学文章。更深入的帮助请查看 MediaWiki 帮助 和 Wikipedia 帮助.
本文仅介绍编辑和创建页面的方法和页面语法,在编辑或创建页面之前,请阅读ArchWiki:Contributing (简体中文), 样式 和 阅读帮助,了解一下现有文章的语言、布局和样式,在后续的编辑中请尽量保持统一。请使用 沙盒 进行编辑尝试。这里有一个关于 wiki 标记符的概览。
创建账号
创建账号后方可编辑内容。要回答账号创建时的问题,需要一个Arch Linux 环境。我们也鼓励非 Arch 用户参与 wiki 贡献,请 下载 最新的安装环境,在 Live 系统中就可以获得问题的答案。创建账号后,登录 系统。
编辑
要开始编辑一个页面,点击页面顶端的 编辑 标签。用户也可以通过点击章节头部的 编辑 链接编辑文章的特定部分。点击后将会显示 编辑 页,包含如下元素:
- 编辑工具栏 (可选)
- 编辑框
- 编辑总结
- “保存本页”, “显示预览”, “显示更改”和“取消”链接
编辑框包含页面或章节最新版本的 wiki文字 (服务器可以生成实际页面的源代码) 。进行编辑:
- 按需编辑 wiki 内容(详情参见下面的#格式).
- 在 摘要 框中解释所作修改(例如 : "错字更正" 或是 "新增关于 xyz 的信息")。注意: 所有的编辑都应该附有描述性的摘要,以方便其他用户的审查。更多信息参见三个基本原则。
- 使用 显示预览 按钮在保存前检查页面的排版与格式。
- 如果修改没有太多实质性内容,请通过点击 这是一个小修改 将编辑标记为 小修改。
- 通过 保存页面 按钮保存。如果不满意,可以点击 取消 (或继续完善)。
撤销编辑
如果页面编辑错误,可以采用如下步骤将文章回溯到上一个版本。要撤销单个编辑:
- 点击要修改页面顶部的 历史 标签(在 编辑 标签旁边),将显示版本列表。
- 点击错误修改右边的 撤销 链接,将显示编辑预览,左侧显示当前版本,右侧显示要保存的版本。
- 记录撤销的原因
- 如果满足要求,点击页面底部的 保存页面 按钮。
Wiki 页面将回到原始状态。
有时需要同时撤销多个编辑,要回溯到以前的版本:
- 点击要修改页面顶部的 历史 标签(在 编辑 标签旁边),将显示版本列表。
- 通过点击相应的时间戳查看需要的版本(即最后的 好 版本),将显示那个版本。
- 记录时间戳和回退到之前状态的原因。
- 如果满足要求,点击页面底部的 编辑 标签,将显示警告: 您正在修改过期版本。 只需要点击 保存页面 就可以回到这个版本。
创建页面
创建新页面前,请考虑如下内容:
- 您的话题是否和 Arch Linux 相关? 无关和没什么帮助的文章将被删除。
- 别人是否对您的话题感兴趣? 不仅考虑您想写什么,还要考虑别人想读什么。 个人信息应该放在你的 用户 页面。
- 您的话题是否值得增加单独页面? 在 wiki 中查找相似文章,如果已经存在,可以考虑完善它或者新增一个章节。
- 您是否愿意贡献足够的内容? 请避免仅添加话题,除非计划很快就会扩展和完善它。
创建新页面要求选择一个描述性的标题 和合适的分类。
- 标题应该包含大小写:使用Title for New Page;而不是 Title for new page。
- 不要包含 "Arch Linux" 之类的修饰。这是 Arch Linux wiki;所有的文章都与 Arch Linux 相关(例如使用 Installing Openbox; 而不是 Installing Openbox in Arch Linux)。
访问目录列表选择一个合适的类别。 文章可以属于多个类别。
要在某个分类中添加新文章,(例如添加 "My New Page" 到 "Some Category"),您只需要:
- 通过浏览 My new page 创建一个页面(别忘了替换 "My_new_page"!)
- 在您页面的顶端 添加[[Category:Some Category]]
这些页面目前还是 孤立页面,请花些时间将其与其它页面链接起来,这样用户更容易找到它,并贡献内容。
格式
大部分的文字显示格式都可以用 wiki 內建的 markup 语法来实现,你不需要学习使用 HTML。常用的工作可以通过模板实现,模板 页面包含模板使用的相关信息。ArchWiki Cheatsheet 整理了常用的格式选项。
标题与子标题
标题和子标题是提高文章的组织结构的常用方法。如果讨论了两个或两个以上的主题,可以在文章內为每个章节添加一个标题。请阅读有效使用标题 获取更多信息。
标题创建:
==一级标题== ===二级标题=== ====三级标题==== =====四级标题=====
- 标题的大小写遵照句子规范 而不是 标题规范,使用 My new heading 而不是 My New Heading。
- 不应该跳过标题级别,也就是说,没有在二级标题之内就不要使用三级标题。
如果一篇文章使用四个以上的标题,系统会自动生成内容列表 (TOC)。如果不想使用内容列表,你可以在页面中添加 __NOTOC__。 请试着在 沙盒 內建立几个标题,然后看看他们对内容列表的影响。
换行
重要格式提示: 布局中单个换行是没有效果的,所以
这句话 被分成 三行。
...将显示为:
这句话 被分成 三行。
空行将新起一个段落,例如:
这是第一段。 这是第二段。
...将显示为:
这是第一段。
这是第二段。
HTML <br> 也可以实现手动换行,但是应该避免这么做。手动换行还会在其他格式元素中使用, 例如列表(后面会详细讲解列表):
* 这个点 <br> 扩展到多行 * 这个点 结束列表
...将显示为:
- 这个点
扩展到多行 - 这个点
结束列表
粗体与斜体
文字放在数个单引号 (') 之间将表现出 Bold - 粗体 和 italics - 斜体 的效果:
- ''italics - 斜体'' 显示为 italics - 斜体. (前后加上两个单引号)
- '''bold - 粗体''' 显示为 bold - 粗体. (前后加上三个单引号)
- '''''bolded italics - 粗体斜体字''''' 显示为 bolded italics - 粗体斜体字. (前后加上 2 + 3 = 五个单引号)
删除线
用删除线表示文字已经没有作用或者无关。
例如:
<s>删除的文字</s>
...显示为
删除的文字
要点列表
请使用星号 (*
)插入一个新要点。插入星号越多,缩进越多。
例如:
*第一条 *第二条 **第二条的子项 *有趣吗?
显示为 :
- 第一条
- 第二条
- 第二条的子项
- 有趣吗?
编号列表
要建立编号列表,请使用数字符号或是井字号 (#
)。多个井字号 #
将增加缩进层次。
例如:
# 第一条 # 第二条 ## 子条目 # 第三条
...将显示为:
- 第一条
- 第二条
- 子条目
- 第三条
编号列表可以和要点列表混合使用,例如:
# 第一条 # 第二条 #* 子条目 # 第三条
...将显示为:
- 第一条
- 第二条
- 子条目
- 第三条
定义列表
可以通过在行首使用分号(;
) + 定义名称 + 冒号(:
) + 定义说明 生成定义列表。
例如:
; Apple: Fruit with red or yellow or green skin and sweet to tart crisp whitish flesh ; Banana: Elongated crescent-shaped yellow fruit with soft sweet flesh
...将显示为:
- Apple
- Fruit with red or yellow or green skin and sweet to tart crisp whitish flesh
- Banana
- Elongated crescent-shaped yellow fruit with soft sweet flesh
可以使用多个冒号将定义分成多行。
例如:
; Term: First line of definition : Second line of definition : Third line of definition
...将显示为:
- Term
- First line of definition
- Second line of definition
- Third line of definition
缩进
要缩进文字,请在行首插入冒号 (:
) 。插入冒号越多,文字就缩进越多。新行(按下 Enter 或是 Return 后) 将结束整段文字的缩进。
例如 :
这行靠最左对齐。 :这行稍微缩进。 ::这行缩进更多
显示为:
这行靠最左对齐。
- 这行稍微缩进。
- 这行缩进更多。
在内容页面中,仅在必须时再使用缩进。在讨论页中,请用缩进区分回复。
代码
在 wiki 页面使用代码格式非常简单 : 你只需要在每一行文字前加上一个空格。然而请注意行宽,因为代码不会自动断行。
参见 代码格式模板.
表格
有效使用表格可以帮助组织和汇总大量数据。高级表格语法和格式请查看 Help:Table.
例如:
{| border="1" |+ 表格数据 ! 水果!! 颜色 |- | 苹果 || 红色 |- | 橘子 || 橙色 |- | 香蕉|| 黄色 |}
...将被显示为:
水果 | 颜色 |
---|---|
苹果 | 红 |
橘子 | 橙 |
香蕉 | 黄 |
{| class="wikitable" border="1" cellpadding="5" cellspacing="0" ! RAID 级别 !! 数据 !! 使用!! 读 !! 写!! 稀疏!! 最大!! 最小 |- | 0 || 否 || 100% || 好 || 好|| No || 1 || 16 |- | 1 || 是|| 50% || 非常高 || 非常高 || No || 2 || 2 |}
显示为:
RAID 级别 | 数据 | 使用 | 读 | 写 | 稀疏 | 最大 | 最小 |
---|---|---|---|---|---|---|---|
0 | 否 | 100% | 好 | 好 | No | 1 | 16 |
1 | 是 | 50% | 非常高 | 非常高 | No | 2 | 2 |
链接
链接是用帮助使用者浏览网站的关键。编辑者应该确保每篇文章都包含到其它文章的链接(避免断链页面)并被其它文章引用。 (链入页面可以用来显示链入的页面)。
內部链接
你可以大量应用内部链接交叉引用 Wiki 页面。链接目标可以是已经存在的标题,或是之后应该存在的标题。
在同一 wiki 內,要链接一个页面,只需要用双中括号包含要链接页面的标题。
例如,如果你想要设定个链接到文章 pacman,只需要:
[[pacman]]
如果希望使用页面标题以外的文字作为链接的标题,可以通过在链接和要使用的名字间插入 "|" 分隔符实现(在英文键盘上,使用Shift
+ \
打出 "|")。
例如
查看 [[Arch Linux (简体中文)|这篇]] 文章...
...将显示为:
- 查看 这篇 文章...
如果希望在链接的页面名称后面加上复数 (或是任何后缀文字),可以把要加的文字直接放在包着链接页面的中括号后面。
例如:
makepkg is used in conjunction with [[PKGBUILD]]s.
...将显示为:
makepkg is used in conjunction with PKGBUILDs.
到文档章节的链接
要链接到文章的某个章节,只需要添加 #
加章节标题。
例如:
[[ArchWiki Tutorial (简体中文)#到文档章节的链接]]
...将显示为:
- 如果链接到同页面的章节,可以省略文档名(例如,
[[#到文档章节的链接]]
)。 - 如果有相同名称的章节,又想链接到第二个该名称的章节,可以在章节名后添加下划线加数字,例如: [[ArchWiki Tutorial (简体中文)#到文档章节的链接_2]]。
多国语言链接
请访问 语言间链接。
Wiki 间链接
Wiki 间链接 可以链接到其他 Wiki 文章,例如 Wikipedia。这种链接的语法格式为双中括号 Wiki 名称加冒号加要链接的文章。
要链接到文章 Wikipedia:Arch Linux,可以使用:
[[Wikipedia:Arch Linux]]
通过管道可以用新的名字显示链接。例如到 Arch Linux Wikipedia article 的链接:
[[Wikipedia:Arch Linux|Arch Linux Wikipedia article]]
参见: Wikipedia:InterWikimedia links
站外链接
要链接到外部网站,请直接写出目标网页的完整 URL。
http://www.google.com/
在很多时候,我们都会给链接的 URL 设定含意比较清楚的名称。 把链接的 URL 放在中括号內,然后在 URL 后加上一个 空格 (不是 pipe)。要显示, Google search engine ,可以使用:
[http://www.google.com/ Google search engine]
重定向
要把一个页面自动跳转到另一个,请使用 #REDIRECT
这个指令,同时把新转过去的网页名称放在括号內。
例如,你可以设定把 "Cats" 这个页面自动转向 "Cat":
#REDIRECT [[Cat]]
这样,不管使用者在搜索里输入的是哪一个,他们都会进入 "Cat" 这个页面。
重定向之后的文字都不会被显示,然而类别标签仍然会起作用,以保证重定向会包含在类别列表中。
- 不应该重定向到其它网站
- 分类页面 不支持重定向.
- 重定向是服务器内部解析,不会影响页面的打开速度。
Wiki 变量、特殊字符和模板 (templates)
MediaWiki 识别一些改变标准行为的特殊字符串。例如,在文章任意位置加入 __NOTOC__ 将不会生成内容列表。而 __TOC__ 将改变内容列表的位置。详情参见 [mw:Help:Magic words]]。
模板和变量为事先定义的 wiki 文字,加入文章后会增加格式化的内容。
变量由系统定义,用来显示当前页面的信息,wiki 或者日期。例如,使用 {{SITENAME}} 显示 Wiki 网站的名字(本 Wiki 为 ArchWiki)。要为页面设置新标题,可以使用变量:{{DISPLAYTITLE:新标题}} (仅允许大小写更改)。
模板则为用户定义。任意 页面的内容都可以被其它页面引用,只需要加在文章中加入 {{名称空间:页面名称}} 。但是除 Template 名称空间之外,这个功能很少被使用。(如果忽略名称空间,默认为Template。) 例如, Template:注意,可以通过在文章中加入如下内容引用:
{{注意|这是个注释。}}
...将显示为:
更多信息请查看 Help:Template。