帮助:格式与标点规范

相关文章

• Help:Editing#Formatting
• Help:Style#Formatting

以下指南定义了如何通过格式或标点突出显示文章内容的不同部分。

通用规则

这些通用规则始终优先于#具体情况。对于本指南未涵盖的情况，以 Wikipedia:格式手册为权威参考。

• 除非这些规则明确允许，否则请勿混用多种突出显示方法。
  此规则也适用于某些格式已由 CSS 规则设置的情况，例如定义列表项中的加粗。如果受影响的项目不允许预设的 CSS 格式（例如#文件名和路径不允许加粗），则必须改用不同的、兼容的维基标记（例如使用项目符号代替定义列表）。
• 请勿使用本手册定义之外的突出显示方法；这包括但不限于下划线、闪烁、全单词大写、颜色、星号、感叹号、表情符号、带有 style 属性的 HTML 标签。

首个实例

• 如果考虑到文章的主题或特定章节，认为术语或名称（例如可执行文件名称）在文章中首次相关出现时值得特别关注，则可以对其进行突出显示（见下文）。“相关”出现的首个位置可能不是该名称绝对意义上的首次出现：其选择权交给编辑者。
• 突出显示名称的首选方式是使用指向本维基内密切相关的文章或外部页面（如 Wikipedia 或 man 页面）的链接。如果没有相关的相关链接，可以使用加粗作为备选方案。

只要相关模板允许链接到目标，软件包和软件包组名称必须使用 Template:Pkg、Template:AUR 或 Template:Grp。

• 如果该名称已经由文章标题或章节标题引入，则其在正文中的首次相关出现只能用作链接锚点，而不能简单地加粗，除非是在#名称/术语列表中。
• 首个实例突出显示仅适用于明确允许它的#具体情况。

链接

• 不得对链接的锚文本应用任何格式。

名称/术语列表

• 在名称或术语列表中保持格式一致是允许的，但非强制性的，即使通常并非所有项都需要格式化。这可以包括例如全大写术语（其本身不应斜体化），或者列表中的名称（其中大多数项已根据#首个实例进行了格式化）。
  “列表”应从广义上理解，因此例如一系列后续段落的所有起始词也可以被视为构成术语列表。

按格式/标点分类的情况

标记为 ¹ 的情况受#首个实例的影响。标记为 ^m 的情况适用于等宽文本。

斜体

使用 MediaWiki 语法 ''斜体文本'' 而不是 <i> 标签。

• #可执行文件/应用程序名称¹
• #文件扩展名
• #仓库名称¹
• #软件包和组名称
• #文件/命令行内容中的伪变量^m
• #GUI/TUI 文本
• #技术术语¹
• #强调/强力词汇或陈述
• #首字母缩写/缩写词展开

加粗

使用 MediaWiki 语法 '''加粗文本''' 而不是 <b> 标签。

• #文件/命令行内容的重要部分^m
• #强调/强力词汇或陈述
• #首个实例

等宽

对于代码块之外的文本，使用 Template:ic {{ic|等宽文本}} 而不是 <code> 标签。

• #文件名和路径
• #守护进程/服务、内核模块
• #配置参数、变量、选项、属性...
• #命令行
• #文件内容
• #键盘按键

引号

使用直引号 "引号文本"，而不是单引号 '引号文本' 或全角/排版引号 “引号文本”。

• #对标题、章节头的引用...
• #被视为纯“文本实体”的词语/字母
• #以不当或存疑方式使用的通用词汇
• #引用

具体情况

通用规则始终优先于以下规则。

首字母缩写/缩写词展开

使用斜体。

示例

• Pacman is the Arch Linux package manager.
• cat (catenate) 是一个标准的 Unix 工具，用于连接并列出文件。

命令行

使用 等宽。必须是行内命令示例，而不能只是简单提及#可执行文件/应用程序名称。也包括控制台输出以及能够合理地用于粘贴到终端中的文本。

示例

• 鼓励您键入 man command 以阅读任何命令的 man 页面。
• 您可以使用命令 ip link 来发现接口的名称。
• 如果您遇到 ping: unknown host 错误，请先检查您的电缆或无线信号强度是否存在问题。
• 键入 yes 并选择 Quit（或按 q）以退出而不进行任何进一步更改。
• 以 root 权限执行 pacman -Syu。

配置参数、变量、选项、属性...

使用 等宽。也影响命令选项、用户组、IP 地址、环境变量和一般的变量。

当必须同时表示命令选项的短形式和长形式时，使用不带空格的“/”符号分隔，例如 -a/--anything。

示例

• 默认情况下，键盘布局设置为 us。
• [...] 其中 layout 可以是 fr、uk、dvorak、be-latin1 等。
• 从 v197 开始，udev 不再根据 wlanX 和 ethX 命名方案分配网络接口名称。
• 在此示例中，以太网接口为 enp2s0f0。
• 如果您不确定，您的以太网接口很可能以字母“e”开头，而不可能是 lo 或以字母“w”开头。
• 目前，您最多可以包含三行 nameserver。
• 您将需要创建一个额外的大小为 1007 KiB 且类型代码为 EF02 的 BIOS 启动分区。
• 所有文件都应具有 644 权限和 root:root 所有权。
• 如果您希望安装 base-devel 组中的每个软件包而无需提示，可以省略 -i 开关。
• 对于 systemd 的大多数用例，没有必要将您的用户添加到用户组（sys、disk、lp、network、video、audio、optical、storage、scanner、power 等）。
• 如果您位于代理服务器后面，则需要导出 http_proxy 和 ftp_proxy 环境变量。
• 要将其他区域设置用于其他 LC_* 变量，请运行 locale 查看可用选项并将其添加到 locale.conf。不建议设置 LC_ALL 变量。有关高级示例，请参阅 Locale#设置系统区域设置。
• [...] 这大致等同于您包含在 DAEMONS 数组中的内容。
• 如果您运行的是专用网络，可以安全地将 192.168.*.* 用于您的 IP 地址，子网掩码为 255.255.255.0，广播地址为 192.168.*.255。网关通常是 192.168.*.1 或 192.168.*.254。
• 通过为 QEMU 提供 -net nic 参数，它将默认分配给虚拟机一个链路层地址为 52:54:00:12:34:56 的网络接口。

守护进程/服务、内核模块

使用 等宽。在内核模块名称中使用下划线 (_)。

示例

• dhcpcd.service 为所有网络接口启动守护进程。
• 某些单元名称包含 @ 符号（例如 name@string.service）。
• 通用的蓝牙驱动程序是 btusb 内核模块。
• snd_usb_audio 模块用于 USB 声卡。

可执行文件/应用程序名称

使用斜体，但仅限于全小写名称。受#首个实例影响。

请注意，此规则仅在可执行文件代表应用程序/文件本身时适用，在#命令行中使用时不适用。特别要注意通常不带任何参数运行的可执行文件。另请参阅 Help:Style#拼写。

示例

• 取消 /etc/locale.gen 中所选区域设置的注释，并使用 locale-gen 工具生成它。
• 取消 /etc/locale.gen 中所选区域设置的注释，并使用 locale-gen 生成它。
• 从 v197 开始，udev 不再根据 wlanX 和 ethX 命名方案分配网络接口名称。
• Arch Linux 安装介质包含以下分区工具：fdisk、gdisk、cfdisk、cgdisk、parted。
• 如果 pacman 验证软件包失败，请使用 cal 检查系统时间。
• 使用 passwd 设置 root 密码。

文件内容

对于可以在文件中读取或写入的内容，或者能够合理地用于从文本编辑器复制或粘贴到文本编辑器的内容，使用 等宽。

示例

• 在字符串末尾键入 nomodeset 并按 Enter。或者，尝试 video=SVIDEO-1:d，如果有效，它将不会禁用内核模式设置。
• 从 /etc/locale.gen 中删除您想要的区域设置前面的 #。

文件扩展名

使用斜体。

示例

• Pacman 是用 C 编程语言编写的，并使用 .pkg.tar.zst 软件包格式。

文件名和路径

使用 等宽。设备名称和带有通配符的名称也受影响。不过，#文件扩展名的处理方式不同。

示例

• 要测试是否已启动进入 UEFI 模式，请检查是否已创建目录 /sys/firmware/efi。
• 所有文件和目录都显示在根目录 / 下，即使它们存储在不同的物理设备上。
• 编辑 /etc/resolv.conf，替换您的名称服务器的 IP 地址和您的本地域名。
• 在安装之前，您可能需要编辑 mirrorlist 文件并将您首选的镜像放在第一位。
• 为了使内核模块在引导期间加载，请在 /etc/modules-load.d/ 中放置一个名称基于使用它们的程序的 .conf 文件。
• 每个分区都由一个数字后缀标识。例如，sda1 指定第一个驱动器的第一个分区，而 sda 指定整个驱动器。

以不当或存疑方式使用的通用词汇

使用“直引号”。

示例

• 被视为纯“文本实体”的词语/字母。

GUI/TUI 文本

使用斜体。例如用于菜单项。表示菜单中的导航时，请使用“>”符号（仍为斜体）来分隔项目。

示例

• 然后，从菜单中选择 Boot Arch Linux 并按 Enter 以开始安装。
• 使用 Gparted 时，选择创建新分区表的选项默认会给出一个 msdos 分区表。如果您打算遵循创建 GPT 分区表的建议，则需要选择 Advanced，然后从下拉菜单中选择 gpt。
• 键入 yes 并选择 Quit（或按 Q）以退出而不进行任何进一步更改。
• 为了更新插件，您应该检查是否在 Window > Preferences > Install/Update > Available Software Sites 中启用了它们的更新仓库。

文件/命令行内容的重要部分

使用加粗。由于这些内容本身就是代码，当在模板之外引用时，应保留 等宽 格式。

示例

• # ln -s /usr/src/linux-$(uname -r)/include/generated/uapi/linux/version.h /usr/src/linux-$(uname -r)/include/linux/

您可以用任何当前未运行的内核替换 $(uname -r)。

键盘按键

根据 Help:Style#键盘按键 使用 等宽。

示例

• 您必须在 POST 期间按下一个键（通常是 Delete、F1、F2、F11 或 F12）。
• 使用 Ctrl+Alt+b 快速在后台发送命令，并丢弃其所有输出。

软件包和组名称

根据 Help:Style#软件包管理说明 使用 Template:Pkg、Template:AUR 或 Template:Grp。如果未格式化为链接（例如在引用非官方仓库中的软件包时），请使用斜体。

示例

• 安装 foobar 软件包。
• 安装 foobar^AUR 软件包。
• 安装 foobar 组。
• 从 example 仓库安装 foobar 软件包。

文件/命令行内容中的伪变量

使用斜体。在模板之外提及变量时，应保留 等宽 格式。

确保变量不包含任何空格：应使用下划线代替空格。

确保与文章其余部分的一致性，文章可能已经使用了伪变量。例如，如果已经使用了 keyboard_layout，请不要引入新的 keyboardlayout 变量。

示例

• # loadkeys keyboard_layout

[...] 其中 keyboard_layout 可以是 fr、uk、dvorak、be-latin1 等。

• 使用 ip link set interface up 启动接口。
• 您可以使用以下命令连接到网络

# wifi-menu interface_name

其中 interface_name 是无线芯片组的接口。

引用

对于行内引用，使用“直引号”。对于块引用，通过行首冒号进行缩进，无需任何额外的标点或格式。

示例

• "All your data belongs to us" – Google
• 来自 https://www.x.org/wiki/

X.Org 项目提供了 X Window System 的开源实现。开发工作是与 freedesktop.org 社区共同完成的。X.Org 基金会是一个教育性非营利组织，其董事会服务于这项工作，其成员领导这项工作。

对标题、章节头的引用...

使用“直引号”。但在引用章节标题时，请使用内部锚点链接 ([[#章节]])。

示例

• “dm-crypt +/- LUKS”列表示 dm-crypt 在 LUKS（“+”）和普通（“-”）加密模式下的功能。如果特定功能需要使用 LUKS，则由“(with LUKS)”指示。同样，“(without LUKS)”表示使用 LUKS 对于实现该功能适得其反，应使用普通模式。

仓库名称

对仓库名称使用斜体。受#首个实例影响。

示例

• 要启用 core-testing 仓库，您必须取消 /etc/pacman.conf 中 [core-testing] 章节的注释。
• 如果您启用 core-testing 仓库，则还必须启用 extra-testing 仓库。

强调/强力词汇或陈述

对于如果朗读会以重音发音的词语，即那些在赋予句子含义方面具有重要意义的词语，使用斜体。

然而，当需要特别注意时，像“不”、“仅”、“正是”、“强烈”、“在...之前”之类的词可以用加粗突出显示。

对于无法放在单独的“警告”或“注意”中（因为它们是章节本身的重要部分）的非常重要的陈述，也是如此。

示例

• 选择最适合您需求的环境。
• 此命令可以同步仓库数据库并更新系统软件包。
• 如果屏幕没有变黑且启动过程卡住。
• [...] 所以请完全按照您看到的样子输入它。
• 如果您愿意，可以通过清除其他所有内容来使其成为唯一可用的镜像。
• 分区可能会损坏数据。强烈建议并忠告您在继续之前备份任何关键数据。
• 在升级系统之前，请及时了解 Arch Linux 中需要人工干预的变化。
• 执行系统更新时，用户必须阅读 pacman 输出的所有信息并运用常识。
• 这意味着不支持部分升级。

技术术语

使用斜体，全大写术语（通常是缩写词）除外。受#首个实例影响。

示例

• 鼓励您键入 man command 以阅读任何命令的 man page。
• 本文讨论 GNU/Linux 系统上所谓的核心工具。
• 主分区可以是可引导的，并且每个磁盘或 RAID 卷限制为四个分区。
• 由于被 systemd 挂载为 tmpfs，默认情况下这已经是一个单独的分区。
• 您必须在 POST（上电自检）阶段按下一个键（通常是 Delete、F1、F2、F11 或 F12）。

被视为纯“文本实体”的词语/字母

使用“直引号”。

示例

• 然而，当需要特别注意时，像“不”、“仅”、“正是”、“强烈”、“在...之前”之类的词可以用加粗突出显示。
• 如果您不确定，您的以太网接口很可能以字母“e”开头，而不可能是 lo 或以字母“w”开头。