跳转至内容

Help:编辑

来自 ArchWiki

ArchWiki 由 MediaWiki 提供支持。MediaWiki 是一款用 PHP 编写的免费开源 wiki 软件包,最初专为维基百科设计。更深入的帮助请参阅 MediaWiki 上的帮助内容维基百科上的帮助内容

这是一篇关于编辑 ArchWiki 的简短教程。在编辑或创建页面之前,建议用户先熟悉现有文章的总体语气、布局和风格。应努力保持整个 wiki 的一致性。有关通用惯例的概述,请参阅 ArchWiki:贡献Help:阅读Help:格式指南

要进行编辑实验,请使用沙盒。有关 wiki 标记的概述,请参阅 Help:备忘单

创建账号

在注册之前,请先熟悉我们的行为准则。为了能够编辑 ArchWiki 文章,你必须创建一个 ArchWiki 账号并确认用于注册的电子邮箱地址。回答验证码问题需要一个最新的 Arch Linux 环境:非常欢迎非 Arch 用户为 wiki 做出贡献,为了回答问题,他们可以采取例如通过最新的安装镜像引导进入 Arch 实时系统,使用 pacman-staticAUR(提供预编译二进制文件),或者直接使用利用 Docker 等工具的容器镜像。

拥有账号后,请从 Special:UserLogin 登录。

注意 通过 accounts.archlinux.org 实现的单点登录(SSO)尚未实现。参见 archlinux/infrastructure#38

编辑

要开始编辑页面,请点击页面顶部的“编辑源代码”选项卡。或者,用户也可以通过点击章节标题右侧的“编辑源代码”链接来编辑文章的特定章节。随后将显示“正在编辑:页面名称”或“正在编辑:页面名称(章节)”页面,其中包含以下元素:

  • 编辑工具栏(可选)
  • 编辑框
  • 编辑摘要框
  • 保存更改”或“保存页面”、“显示预览”、“显示更改”以及“取消”链接

编辑框将包含当前页面或章节版本的 wikitext(服务器用来生成网页的可编辑源代码)。要执行编辑:

  1. 根据需要修改 wikitext(详见下文 #格式化)。
  2. 摘要框中说明本次编辑(例如“修复错别字”或“添加关于 xyz 的信息”)。
    注意 所有编辑都应附带描述性摘要,以便其他用户审阅。更多信息请参见 ArchWiki:贡献#三条基本规则
  3. 在保存之前,使用“显示预览”按钮来方便校对并验证格式。
  4. 如果编辑是表面性的且无争议的,请通过勾选“这是一个小修改”框将编辑标记为小修改
  5. 点击“保存更改”以保存修改。如果不满意,请点击“取消”(或重复上述过程直至满意)。
注意 文章不应署名,因为它们是共同创作的作品;不应将某一位编辑者置于其他编辑者之上。

撤销编辑

如果页面编辑有误,以下步骤描述了如何将文章恢复到之前的版本。要撤销单次编辑:

  1. 点击要修改页面顶部的“查看历史”选项卡(在“编辑源代码”选项卡旁边)。系统将显示修订版本列表。
  2. 点击不想要的那次编辑右侧的“撤销”链接。系统将显示编辑预览,左侧为当前版本,右侧为即将保存的文本。
  3. 在编辑摘要字段中写下撤销此编辑的原因。
  4. 如果满意,点击页面底部的“保存更改”按钮。

现在该 wiki 页面应该已经回到了原始状态。

有时需要一次性撤销最后几次编辑。要将文章恢复到之前的某个版本:

  1. 点击要修改页面顶部的“查看历史”选项卡(在“编辑源代码”选项卡旁边)。系统将显示修订版本列表。
  2. 点击相应的时间戳查看所需的修订版本(即最后一个“完好”的版本)。随后将显示该版本。
  3. 点击页面顶部的“编辑源代码”选项卡。系统会显示警告:“你正在编辑本页的一个旧版本”
  4. 在编辑摘要字段中写下该版本的修订时间戳(显示在页面顶部)以及将页面状态恢复到此版本的原因。
  5. 如果满意,只需点击“保存更改”按钮即可恢复到此版本。
  • 避免将撤销操作与新编辑合并。先撤销编辑,然后再进行额外的更改;不要直接编辑修订预览。
  • 执行撤销操作时,请考虑使用特别详细和冗长的编辑摘要,以防止产生冗长的讨论。

创建页面

在创建新页面之前,请考虑以下事项:

  • 你的主题是否与 Arch Linux 相关?无关或无用的文章将被删除。
  • 你的主题是否他人也感兴趣?不仅要考虑你想写什么,还要考虑别人可能想读什么。个人笔记应放在你的用户页面上。
  • 你的主题值得创建一个新页面吗?在 wiki 中搜索类似的文章。如果已存在,请考虑改进现有文章或在其中添加一个章节。
  • 你的贡献是否有意义?除非计划在不久后进行扩充,否则请避免创建存废(stub)页面。

创建新页面需要选择一个描述性的标题和合适的分类

有关文章命名建议,请阅读 Help:文章命名指南Help:格式指南#标题。不要在页面标题中包含 "Arch Linux" 或其变体。这是 Arch Linux wiki;默认所有文章都与 Arch Linux 相关(例如,“安装 Openbox”;而不是“在 Arch Linux 中安装 Openbox”)。

访问目录以帮助选择合适的分类。文章可以属于多个分类,只要其中一个分类不是另一个分类的父分类(参见 Help:格式指南#分类)。

要将新页面添加到某个分类(例如将“我的新页面”添加到“某个分类”),你需要:

  1. 通过访问 https://wiki.archlinux.org.cn/title/My_new_page 以你的新标题创建页面(记得将 "My_new_page" 替换为预定的标题!)
  2. 在页面的顶部添加 [[Category:某个分类]]
注意 不要创建未分类的页面。所有页面必须至少属于一个分类。如果你找不到合适的分类,请考虑创建一个新分类。

在此阶段,新文章仍被视为孤立页面。为了完成工作,请花一点额外时间从其他文章中链接到这篇新文章:这将提高其知名度,并鼓励更多用户为其做出贡献。可能的候选位置包括相关软件的文章、更通用的概述页面,甚至是简单的列表页面,如 应用列表

在某些情况下,创建子页面(即另一个页面的子节点)可能更有意义:子页面标题与父页面标题之间用 "/" 符号(斜杠)分隔。这对于在自己的用户页面下准备草稿非常有用,例如 https://wiki.archlinux.org.cn/title/User:Myself/My_new_subpage

格式化

只要有可能,文本格式化都通过 wiki 标记完成;不需要学习 HTML。还有各种模板可用于常见的格式化任务;有关模板的信息,请参见 Help:模板Help:备忘单 总结了最常用的格式化选项。

标题和副标题

标题和副标题是改进文章组织的简便方法。如果你看到正在讨论不同的主题,可以通过为每个章节插入标题来拆分文章。有关风格信息,请参阅 Help:格式指南#章节标题Help:有效使用标题

标题必须从二级开始,可以像这样创建:

== Second-level heading ==

=== Third-level heading ===

==== Fourth-level heading ====

===== Fifth-level heading =====

====== Sixth-level heading ======
注意 不允许使用一级标题,它们的格式预留给文章标题。

如果一篇文章至少有四个标题,系统将自动生成目录 (TOC)。如果不希望生成目录,请在文章中放置 __NOTOC__。尝试在沙盒中创建一些标题,看看对目录的影响。

换行

空行用于开始新段落,而单个换行在常规段落中没有效果。

HTML 的 <br> 标签可以用来手动插入换行,但应尽量避免。在与其他格式元素(如列表)配合使用时,手动换行可能是合理的。

wikitext 渲染效果
This sentence
is broken into
three lines.

这句话被分成了三行。

This is paragraph number one.

This is paragraph number two.

这是第一段。

这是第二段。

* This point <br> spans multiple lines
* This point
ends the list
  • 这一点
    跨越了多行
  • 这一点

结束了列表

有关正确使用空格字符的信息,请参阅 Help:格式指南/空白

加粗和斜体

加粗斜体是通过在单词或短语周围添加两个、三个或五个撇号 (') 来实现的

wikitext 渲染效果

''斜体''

斜体

'''加粗'''

加粗

'''''加粗且斜体'''''

加粗且斜体

删除线

使用删除线文本来表示该文本不再适用或不再具有相关性。

wikitext 渲染效果
<s>Strike-out text</s>

删除线文本

列表

请记住,wiki 语法不支持多行列表项;每个换行符都会结束列表项定义。要在列表项内开始新行,请使用 <br> 标签。要在列表项内输入多行代码块,请使用 Template:bc 并使用 <nowiki> 标签对内容进行转义。另见 Help:格式指南/空白Help:模板

无序列表

无序列表的项目没有明显的顺序。

要插入项目符号,请使用星号 (*)。多个 * 将增加缩进级别。

wikitext 渲染效果
* First item
* Second item
** Sub-item
* Third item
  • 第一项
  • 第二项
    • 子项
  • 第三项

有序列表

有序列表引入了编号,从而对列表项进行排序。只要项目出现的顺序不是首要考虑的问题,通常应该使用无序列表。

要创建有序列表,请使用井号 (#)。多个 # 将增加缩进级别。

wikitext 渲染效果
# First item
# Second item
## Sub-item
# Third item
  1. 第一项
  2. 第二项
    1. 子项
  3. 第三项
# First item
# Second item
#* Sub-item
# Third item
  1. 第一项
  2. 第二项
    • 子项
  3. 第三项

定义列表

定义(又称 说明)列表以分号 (;) 开头,术语后跟冒号 (:)。

wikitext 渲染效果
Definition lists:

; Keyboard: Input device with buttons or keys
; Mouse: Pointing device for two-dimensional input

or

; Keyboard
: Input device with buttons or keys
; Mouse
: Pointing device for two-dimensional input

定义列表

键盘
带有按钮或按键的输入设备
鼠标
用于二维输入的指示设备

或者

键盘
带有按钮或按键的输入设备
鼠标
用于二维输入的指示设备
Use additional colons if a term has multiple definitions:

; Term
: First definition
: Second definition

如果一个术语有多个定义,请使用额外的冒号

术语
第一个定义
第二个定义
注意 定义列表不得仅用于格式化。参见 Wikipedia:Help:Wikitext#Description lists说明列表可访问性

列表项中的代码块

列表中包含代码块的示例

wikitext 渲染效果
# First item
# Second item: {{bc|<nowiki>
code1
code2
code3
</nowiki>}}
# Third item
  1. 第一项
  2. 第二项
    code1
    code2
    code3
    
  3. 第三项

缩进

要缩进文本,请在行首放置冒号 (:),: 后的空格是可选的。冒号越多,文本缩进就越深。换行符标志着缩进段落的结束。

wikitext 渲染效果
This is not indented at all.
: This is indented slightly.
:: This is indented more.

完全没有缩进。

稍微缩进。
缩进更多。
  • 仅在获得所需布局绝对必要时才使用缩进。
  • 在讨论页中,使用它来缩进回复(参见 Help:讨论)。

代码

要在 wiki 中添加代码,请使用代码格式化模板之一。或者,只需在每行开头加一个空格字符,例如:

 $ echo Hello World

另见 Help:格式指南#代码格式化

表格

提示 请参阅 Mediawiki 表格生成器 以自动生成表格。

如果能有效使用,表格可以帮助组织和总结大量数据。有关高级表格语法和格式,请参阅 Wikipedia:Help:Table

wikitext 渲染效果
{| class="wikitable"
|+ Tabular data
! Distro !! Color
|-
| Arch || Blue
|-
| Gentoo || Purple
|-
| Ubuntu || Orange
|}
表格数据
发行版 颜色
Arch 蓝色
Gentoo 紫色
Ubuntu 橙色
{| class="wikitable"
! Filesystem !! Size !! Used !! Avail !! Use% !! Mounted on
|-
| rootfs || 922G || 463G || 413G || 53% || /
|-
| /dev || 1.9G || 0 || 1.9G || 0% || /dev
|}
文件系统 大小 已用 可用 已用% 挂载点
rootfs 922G 463G 413G 53% /
/dev 1.9G 0 1.9G 0% /dev

链接对于帮助读者导航网站至关重要。总的来说,编辑者应确保每篇文章都包含指向其他文章的出站链接(避免断头页面),并被来自其他文章的入站链接所引用(可以使用 链入页面 特殊页面来显示入站链接)。另见 Help:格式指南/格式与标点#首次出现

你可以利用内部链接在现有的 wiki 页面之间进行广泛的相互引用。要链接到同一个 wiki 上的另一个页面,只需将标题放在双方括号中。

例如,如果你想做一个链接到,比如,pacman 文章,请使用:

[[pacman]]
注意 如果目标页面不存在,结果将是一个红链,根据 Help:格式指南#超文本隐喻,应当避免红链。

如果你想使用文章标题以外的词作为链接文本,可以在管道符号 ("|") 后使用标签来提供替代文本。

例如:

The [[ArchWiki:About|ArchWiki]] is the primary documentation source for Arch Linux.

...渲染效果为:

ArchWiki 是 Arch Linux 的主要文档来源。
提示 管道符号 ("|"),又称竖线符号,在英文键盘布局及类似布局上可以通过 Shift+\ 输入。

当你想为链接使用文章标题的复数形式(或添加任何其他后缀)时,可以直接在双方括号外添加额外的字母。

例如:

makepkg is used in conjunction with [[PKGBUILD]]s.

...渲染效果为:

makepkg 与 PKGBUILDs 结合使用。

要创建指向文档某个章节的链接,只需添加一个 #,后跟该章节的标题。

例如:

[[Help:Editing#Section links]]

...渲染效果为:

Help:编辑#章节链接
提示 如果链接到同一页面内的某个章节,可以省略页面名称(例如 [[#章节链接]])。

管道技巧

在某些情况下,可以使用管道技巧来节省编写 wiki 链接标签的时间。ArchWiki 上最常用到的情况有:

  1. 在文章标题中,它允许隐藏语言后缀。例如,[[Main page (Česky)|]] 会变为 Main page
  2. 在指向不同命名空间或 wiki 的链接中,管道技巧会隐藏前缀。例如,[[ArchWiki:About|]] 会变为 About,而 [[wikipedia:Help:Pipe trick|]] 会变为 Help:Pipe trick

保存页面时,管道技巧将自动生成链接标签并相应地更改 wikitext。

参见 Help:i18n#跨语言链接

所谓的跨 wiki 链接可用于方便地链接到其他外部 Wiki(如维基百科)中的文章。此类链接的语法是 wiki 名称后跟一个冒号,再加上要链接的文章,并封装在双方括号中。

如果你想创建指向 Wikipedia:Arch Linux 文章的链接,可以使用以下内容:

[[Wikipedia:Arch Linux]]

或者你可以创建一个带有链接标签的管道链接到 Arch Linux 维基百科文章

[[Wikipedia:Arch Linux|Arch Linux Wikipedia article]]
注意 使用带标签的管道链接应仅用于缩短较长的 URL。

参见 mw:Help:Links#跨 Wiki 链接

ArchWiki 上所有可用的跨 wiki 链接列表可以在 Special:Interwiki 查看或通过 API 获取。

提示 默认情况下,所有指向维基百科页面的跨 wiki 链接都被视为指向英语页面。如果你想链接到另一种语言的页面,可以在页面名称前添加语言前缀。例如,要链接到俄语页面,请在名称前加 ru:
[[Wikipedia:ru:Arch Linux]]

结果为 Wikipedia:ru:Arch Linux

请注意,这取决于目标 wiki 的跨 wiki 配置,因此并非对所有 wiki 都有效。不过它对维基百科是有效的。

如果你想链接到外部站点,只需键入要链接页面的完整 URL。

https://archlinux.org.cn/

为链接提供一个替代标签,通常比显示完整的 URL 更有用。与#内部链接不同,带有标签的外部链接使用单方括号,且目标 URL 与标签之间由空格不是管道符)分隔。例如,要让链接显示为 Arch Linux,只需键入:

[https://archlinux.org.cn/ Arch Linux]

也可以通过简单地用单括号括住 URL 来生成自动编号的标签。相比于“点击这里”之类的短语,这种方式通常更受青睐。要生成短语“参见 [1]”(其中数字将根据链接在页面上的顺序而变化),只需键入:

see [https://archlinux.org.cn/]

重定向

本文章或章节需要扩充。

原因:应拆分为子章节,以清楚地描述 1) 什么是重定向,2) 何时/为什么要重定向页面,3) 如何重定向页面。(在 Help talk:编辑 中讨论)

要自动从一个页面重定向到另一个页面,请在页面开头添加 #REDIRECT 以及指向目标页面的内部链接。

例如,你可以通过以下方式将 "Penguins" 重定向到 "Penguin":

#REDIRECT [[Penguin]]

这样,任何在搜索框中输入其中一个版本的人都会自动跳转到 "Penguin"。

重定向还允许跟踪建立链接的原因,例如在“链入页面”中对它们进行分组,并在章节更名时快速更新链接片段。缺点是重定向不会在浏览器中显示最终的链接目标。

在创建重定向之前,你可以进行搜索以检查现有的兼容重定向。例如:Xorg

另见 Help:格式指南#重定向页面Help:规程#将页面重定向到另一个页面后处理讨论页

Wiki 变量、魔术字和模板

MediaWiki 能识别文章中某些特殊的字符串,这些字符串可以改变标准行为。例如,在文章任何位置添加单词 __NOTOC__ 都会阻止生成目录。类似地,单词 __TOC__ 可用于更改目录的默认位置。详见 Help:魔术字

模板和变量是预定义的 wikitext 片段,可以插入到文章中以辅助格式化内容。

变量由系统定义,可用于显示有关当前页面、wiki 或日期的信息。例如,使用 {{SITENAME}} 显示 wiki 的站点名称(这里显示为 "ArchWiki")。要为当前页面设置替代标题,可以使用另一个 wiki 变量:{{DISPLAYTITLE:新标题}}。(但这受很大限制:你只被允许将首字母更改为小写并将空格替换为下划线——标准化后的标题字符串必须与真实页面名称匹配,否则将不起作用;请使用 {{Lowercase title}} 模板将标题首字母显示为小写)。

另一方面,模板是用户定义的。通过在文章中添加 {{命名空间:页面名称}},可以将被引用页面的内容包含在另一个页面中,但这在“模板”命名空间之外的页面中很少使用。(如果省略命名空间,则默认为“模板”。)例如,Template:Note 模板,可以通过以下 wikitext 包含在文章中:

{{Note|This is a note.}}

...渲染效果为:

注意 这是一个提示。

有关更多信息和可用模板列表(如 Template:TipTemplate:Warning),请参见 Help:模板