帮助:样式/格式和标点

出自 ArchWiki

相关文章

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

通用规则

这些通用规则始终优先于#特定情况。对于本指南未涵盖的情况，Wikipedia:Manual of Style 是权威参考。

  • 除非这些规则明确允许，否则不要混合使用多种高亮显示方法。
    此规则也适用于某些格式已由 CSS 规则设置的情况，例如定义列表术语中的粗体。如果预设的 CSS 格式在受影响的项目上是不允许的（例如#文件名和路径上的粗体），那么您必须使用不同的兼容 Wiki 标记（例如，使用项目符号而不是定义列表）。
  • 不要使用本手册中定义的以外的其他高亮显示方法； 这包括但不限于下划线、闪烁、全词大写、颜色、星号、感叹号、表情符号、带有 style 属性的 HTML 标签。

首次出现

  • 如果认为文章中首次相关的术语或名称（例如，可执行文件名）值得特别关注（考虑到文章的主题或特定章节），则可以高亮显示（见下文）。首次“相关”出现可能不是名称的绝对首次出现：其选择留给编辑者。
  • 高亮显示名称的首选方法是使用链接，链接到 Wiki 中密切相关的文章或外部页面，例如 Wikipedia 或 man page。如果没有可能的关联链接，则可以使用粗体作为备用解决方案。
软件包和软件包组名称必须使用 Template:Pkg、Template:AUR 或 Template:Grp，只要相关模板允许链接到目标。
  • 如果名称已经由文章标题或章节标题引入，则其在正文中的首次相关出现只能用作链接锚点，而不能简单地以粗体高亮显示，除非在 #名称/术语列表 的情况下。
  • 首次出现高亮显示只能应用于明确允许的#特定情况。

链接

  • 不应将任何格式应用于链接的锚文本。

名称/术语列表

  • 允许（非强制性）在名称或术语列表中保持一致的格式，即使通常并非所有项目都需要格式化。例如，这可能涉及全部大写的术语（本身不应斜体化）或列表中的名称，其中大多数项目根据 #首次出现 进行格式化。
    “列表”应以广义理解，因此例如一系列后续段落的所有首词也可以被认为形成术语列表。

按格式/标点分类的情况

标有 1 的情况受 #首次出现 的影响。标有 m 的情况适用于等宽文本。

斜体

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

粗体

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

等宽字体

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

引号

使用打字机引号 "引用的文本" 而不是单引号 '引用的文本' 或印刷体引号 “引用的文本”。

特定情况

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

首字母缩略词/缩写词展开

使用斜体。

示例
  • Pacman 是 Arch Linux 的 package manager（软件包管理器）。
  • cat (catenate，连接) 是一个标准的 Unix 实用程序，用于连接和列出文件。

CLI 行

使用 等宽字体。必须是内联命令示例，而不是简单提及 #可执行文件/应用程序名称。也包括控制台输出和可能对粘贴到终端中有用的文本。

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

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

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

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

示例
  • 默认情况下，键盘布局设置为 us。
  • [...] 其中 layout 可以是 fr、uk、dvorak、be-latin1 等。
  • 从 v197 开始，udev 不再根据 wlanX 和 ethX 命名方案分配网络接口名称。
  • 在此示例中，以太网接口是 enp2s0f0。
  • 如果您不确定，您的以太网接口很可能以字母“e”开头，并且不太可能是 lo 或以字母“w”开头。
  • 目前，您最多可以包含三个 nameserver 行。
  • 您需要创建一个额外的 BIOS 启动分区，大小为 1007 KiB，类型代码为 EF02。
  • 所有文件都应具有 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 数组中的内容。
  • 如果您正在运行专用网络，则可以安全地对您的 IP 地址使用 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 声卡。

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

使用斜体，但仅适用于全小写名称。受 #首次出现 的影响。

请注意，此规则仅适用于可执行文件代表应用程序/文件本身时，而不是在 #CLI 行 中使用时。尤其要注意通常在没有任何参数的情况下运行的可执行文件。另请参阅 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 文本

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

示例
  • 然后，从菜单中选择启动 Arch Linux，然后按 Enter 以开始安装。
  • 当使用 Gparted 时，选择创建新分区表的选项默认会给出 msdos 分区表。如果您打算遵循创建 GPT 分区表的建议，则需要选择高级，然后从下拉菜单中选择 gpt。
  • 输入 yes 并选择退出（或按 Q）以退出而不做任何更改。
  • 为了更新插件，您应该检查是否在窗口 > 首选项 > 安装/更新 > 可用软件站点中启用了它们的更新仓库。

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

使用粗体。由于这些内容本身就是代码，因此当在模板外部引用时，应保留 等宽字体。

示例
  • # 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。当不格式化为链接时（例如，在引用非官方仓库中的软件包时），使用斜体。

示例

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

使用斜体。当在模板外部提及变量时，应保留 等宽字体。

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

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

示例
  • # loadkeys keyboard_layout
[...] 其中 keyboard_layout 可以是 fr、uk、dvorak、be-latin1 等。
  • 使用 ip link set interface up 启动接口。
  • 您可以使用以下命令连接到网络
# wifi-menu interface_name
其中 interface_name 是您的无线芯片组的接口。

引用

对于内联引用，请使用“打字机引号”。对于块引用，请使用行首冒号进行缩进，而无需任何额外的标点符号或格式。

示例
X.Org 项目提供了 X Window 系统的开源实现。开发工作是与 freedesktop.org 社区合作完成的。X.Org 基金会是教育性非营利公司，其董事会为此工作服务，其成员领导这项工作。

对标题、标题等的引用...

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

示例
  • “dm-crypt +/- LUKS”列表示 dm-crypt 对于 LUKS (“+”) 和纯文本 (“-”) 加密模式的功能。如果特定功能需要使用 LUKS，则用“(with LUKS)”表示。同样，“(without LUKS)”表示使用 LUKS 对于实现该功能会适得其反，应使用纯文本模式。

仓库名称

仓库名称使用斜体。受 #首次出现 的影响。

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

强调/强调用词或陈述

对于句子中重要性不被识别的词语，请使用斜体；通常，如果大声朗读，它们会以强调的方式发音。

但是，当需要特别注意时，像“not”、“only”、“exactly”、“strongly”、“before”等词语可以用粗体高亮显示。

对于不能放在单独的警告或注意中的非常重要的陈述，因为它们是章节本身的重要组成部分，也是如此。

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

技术术语

使用斜体，但全大写术语（通常是首字母缩略词）除外。受 #首次出现 的影响。

示例
  • 建议您输入 man command 以阅读任何命令的 man 手册页。
  • 本文讨论了 GNU/Linux 系统上所谓的核心实用程序。
  • 主分区可以是可启动的，并且每个磁盘或 RAID 卷限制为四个分区。
  • 默认情况下，这已经是一个单独的分区，因为它被 systemd 挂载为 tmpfs。
  • 您必须在 POST（Power On Self-Test，开机自检）阶段按下一个键（通常是 Delete、F1、F2、F11 或 F12）。

作为纯粹“文本实体”引用的词语/字母

使用“打字机引号”。

示例
  • 但是，当需要特别注意时，像“not”、“only”、“exactly”、“strongly”、“before”等词语可以用粗体高亮显示。
  • 如果您不确定，您的以太网接口很可能以字母“e”开头，并且不太可能是 lo 或以字母“w”开头。
已从“https://wiki.archlinux.org.cn/index.php?title=Help:Style/Formatting_and_punctuation&oldid=825826”检索