帮助:笔记本电脑页面指南

来自 ArchWiki

本文统一了所有笔记本电脑页面的样式和布局,并引入了指南和标准,以确保笔记本电脑页面保持高质量。这确保了页面不会演变成仅仅是 lspci/lsusb 输出或用户关于其设备的个人笔记的堆砌。

通用

向页面添加一个合适的分类,例如 Category:Dell。如果您的供应商没有类别,请创建一个。

页面名称应为“供应商 型号”,例如“Lenovo ThinkPad X1 Carbon”。

不要创建仅省略供应商名称的重定向,例如“X1 Carbon”或“ThinkPad X1 Carbon”。

提示:如果您不知道您的页面应该是什么样子,Dell Latitude 3500Lenovo ThinkPad T14/T14s (Intel) Gen 2 是遵循这些指南的示例页面。

不要复制通用 笔记本电脑 指南中的内容。一个仅包含例如“此设备的网络摄像头工作正常”的章节对任何人都没有帮助,因此如果没有针对它的特殊说明,请不要添加章节。还要避免提及桌面环境或窗口管理器特定的内容。这也适用于 ArchWiki 中记录的其他内容,例如,不要包含关于如何将 archiso 刷写到 USB 驱动器的说明,只需链接到包含说明的页面即可。这将减少所需的维护。

在描述笔记本电脑受影响的任何问题时,请务必详尽和详细。请提供指向其他用户遇到相同问题报告和其他适当来源的链接。

添加硬件信息

警告
  • 保持所有行尽可能短,因为宽表格难以阅读,并使页面看起来杂乱无章。
  • 确保表格位于前言或引言之上,否则表格的位置将发生变化。

在页面最开始添加一个带有 style="float: right;" 的表格,其中包含以下列

  1. 硬件
    1. 它应该包含部件的简称,如“蓝牙”或“指纹识别器”。
    2. 仅当部件超过一个时,才将供应商名称附加到部件名称。一个常见的例子是多个 GPU(见下表)。
    3. 考虑运行 hw-probe,使完整的硬件集为 Linux 硬件数据库 所知。
  2. PCI/USB ID
    1. 它应该包含部件的 PCI 或 USB ID(如果可用)。这很重要,因为某些笔记本电脑可能具有不同的硬件。
    2. lsusb 默认显示 USB ID,但必须使用 -nn 运行 lspci 才能获得设备的 PCI ID。
      1. 如果存在没有名称的 PCI/USB ID,请考虑将该部件贡献给 PCI ID 仓库USB ID 仓库
    3. 如果此设备没有适用的 PCI/USB ID,请将该列留空。不要在列中放置 Template:-、破折号或任何其他内容。
  3. 工作?
    1. 它应该包含 Template:YesTemplate:No。如果这些不适用,请使用 Template:Y 和一个合适的简短状态描述,如“未测试”或“部分”。
      1. 当部件在应用修改后仍然无法正常工作时,使用“部分”。
    2. 即使您需要安装外部驱动程序,或者使用特定于设备的参数配置它会增强其功能,也请使用 Template:Yes
提示:如果任何部件需要特殊说明,我们鼓励您专门为此部件添加一个章节。不幸的是,当使用 某些标准章节 时,它会使页面显得杂乱,因此避免使用“已知问题”、“故障排除”和“技巧与窍门”。

内核模块信息

不要将内核模块信息放入表格或部件的单独章节中。这通常是毫无意义的,因为此部件只有一个模块。如果存在不同的驱动程序可供选择,则不适用此规则,但这必须在部件的章节中指定,而不是在表格中。

示例表格

以下代码将显示为右侧的示例

{| class="wikitable" style="float: right;"
|-
! Hardware !! PCI/USB ID !! Working?
|-
| Bluetooth || {{ic|1234:abcd}} || {{Yes}}
|-
| Webcam || {{ic|abcd:1234}} || {{No}}
|-
| GPU (Intel) || {{ic|8086:0000}} || {{Yes}}
|-
| GPU (NVIDIA) || {{ic|10de:1111}} || {{No}}
|-
| Other part || {{ic|0000:aaaa}} || {{Y|Untested}}
|}
硬件 PCI/USB ID 工作?
蓝牙 1234:abcd
网络摄像头 abcd:1234
GPU (Intel) 8086:0000
GPU (NVIDIA) 10de:1111
其他部件 0000:aaaa 未测试

常用部件列表

  • 蓝牙
  • 网络摄像头
  • 以太网
  • Wi-Fi
  • GPU
  • 触摸板
  • 键盘
  • TPM
  • 指纹识别器
  • SD 卡读卡器
  • 扬声器
  • 麦克风
  • 环境光传感器
注意
  • 如果任何端口(USB、HDMI、以太网)或关键硬件(如风扇控制)无法开箱即用,请为其添加一个章节,并将其添加到表格中。确保不包含任何桌面环境/窗口管理器特定的说明。这些章节应位于“固件”和“功能键”章节之间。
  • 不要将“Fn 键”、“挂起”/“休眠”或“电源管理”放入表格中。

相关文章

由于所有笔记本电脑页面都应包含一个右浮动的硬件表格,因此 Template:Related 的使用(如 Help:Style#Related articles box 中所述)被替换为使用 “参见”章节 或相关章节内的直接链接,以避免右浮动元素彼此冲突。

“安装”章节

本节应包含在此设备上安装 Arch Linux 所必需的信息。这包括但不限于

  • 内核参数
  • 重要的固件设置(另请参见 “固件”章节
    • 这不包括明显的设置,例如更改启动设备。
    • 我们鼓励链接到论坛中的相关帖子,例如 这个示例帖子,重点关注 Dell 设备的问题。
  • 如果设备需要特殊的固件才能安装,例如用于网络连接的 AUR 软件包,请突出显示该要求。

如果没有需要解决的怪癖,请省略本节。

“辅助功能”章节

警告:向笔记本电脑页面添加本节是强制性的。由于该信息对于残疾用户决定是否可以在没有帮助的情况下在此类设备上安装 Arch Linux 至关重要,因此本节不是可选的。

为了帮助残疾用户在设备上安装 Arch Linux,请添加一些辅助功能信息。这包括但不限于

  • 固件的外观。考虑为了启动官方 Arch Linux 安装介质而需要更改的设置。
    • 较新的固件界面可能更难以使用手机上的 OCR 软件解析,而盲人用户经常使用手机作为日常工具。如果可以选择将默认设计恢复为“经典”设计,请添加相关说明。
    • 某些固件甚至需要使用鼠标和/或过于复杂。如果无法在没有视力的情况下更改设置,请添加说明此情况的注释。例如
      注意:盲人用户应请求视力正常的人员帮助更改固件设置。
    • 某些固件界面可能会大量使用单选按钮和紧密排列的菜单,这可能会阻止患有帕金森病的用户更改某些设置。
  • 请参阅设备官方手册的相关章节(参见“参见”章节),其中包含导航固件和触发某些操作(如更改启动设备)所需的所有快捷键列表。
    • 如果不存在此类手册,您可以改为在本节中添加列表。
  • 某些设备可能具有诊断 LED,它可以可视化蜂鸣代码。这对听力障碍用户很有用。
    • 如果只有诊断 LED,但没有蜂鸣代码,请添加注释。

本文或章节需要扩充。

原因:如果手册对于盲人用户来说不够易于访问(扫描质量差,图像过多等)怎么办?此列表还需要更多内容。(在Help talk:Laptop page guidelines#Accessibility中讨论)

“固件”章节

页面应包含简短的注释,描述此设备的 fwupd 支持情况。

当用户应注意特殊的行为时,页面应包含固件章节。这包括但不限于以下内容

  • 某些可选的固件设置,可以增强此设备的兼容性
  • 可能影响安装的固件怪癖
  • 缺少 UEFI。设备使用哪种启动方法,UEFI 可以添加到现有的启动过程中吗?
  • 安全启动信息
    • 自定义密钥在此设备上是否运行良好?
    • 是否需要为此更改任何特殊的固件设置?
    • 用户应该注意哪些其他特殊性?
  • 固件是否将恢复映像或日志存储在特殊路径中?这在选择 EFI 系统分区 的大小时很重要。
  • 有时更新固件至关重要,因为它修复了关键错误。如果有任何重要的固件更新,请在本节中提及。
  • 缺少 ACPI 或 Linux 中不支持 ACPI。

“功能键”章节

注意:可能存在未标记的按键绑定。在最坏的情况下,您可能会碰到一个未标记的按键绑定,它会发出 XF86Sleep,使您的设备挂起并吓到您,因为屏幕突然变黑,或者一个发出 XF86RFKill 的按键绑定。这两种可能性都略有破坏性,但并不危险。

按住 Fn 并按下键盘上的每个键,同时按照 #捕获功能键 中的描述捕获结果。

添加一个包含以下列的表格

注意:请记住遵循 键盘按键的样式指南
  1. 按键
    1. 需要按下的按键。它们通常以 Fn 开头
  2. 可见?
    1. 使用 Template:YesTemplate:No,取决于 xev 等工具是否可以看到此键。
  3. 已标记?
    1. 使用 Template:YesTemplate:No,取决于物理按键上是否有符号描述其功能。
  4. 效果
    1. 通常,功能键会发出一个键,或者固件在按下该键时会执行某些操作。
    2. 当发出键时,指定键,例如 XF86MonBrightnessDown
    3. 按键可能具有特殊效果,应提及,例如硬阻止网络设备。
    4. 不要添加桌面环境/窗口管理器特定的说明。
    5. 有些键将默认由 systemd-logind 绑定,应标记(见下表)。

捕获功能键

可以使用 xev (xorg-xev) 或 wev (wev) 捕获功能键。还有 libinput debug-events,但由于许多 Wayland 合成器使用 xkbcommon,因此首选 Xorg 特定的名称。

桌面环境 甚至一些 窗口管理器 可能带有默认配置,该配置会吞噬所有功能键,因为它自己处理它们。如果出现这种情况,请临时使用最小化的窗口管理器(如 Openbox)来捕获按键。

某些功能键(例如 XF86Sleep)可能绑定到 systemd-logind,这意味着默认情况下无法使用任何工具捕获它们。使用 systemd-inhibit 临时暂停处理某些键

# systemd-inhibit --what=handle-suspend-key sleep 1h

只要此命令正在运行,systemd-logind 将忽略这些按钮按下,并且可以正确捕获按钮按下。

注意:如果按键仍然不可见,则可能是固件绑定的,或者内核模块正在处理它。

示例表格

按键 可见?1 已标记?2 效果
Fn+Esc 切换 Fn 锁定
Fn+F1 XF86AudioMute
Fn+F2 XF86AudioLowerVolume
Fn+F3 3 XF86Sleep
... 合适的描述
  1. 按键对 xev 和类似工具可见。
  2. 物理按键上有符号描述其功能。
  3. systemd-logind 默认处理此项。

“参见”章节

本节应包含有用的链接,包括但不限于以下内容

  • 相关的其他外部 wiki 页面,例如 ThinkWiki。
  • 制造商提供的官方手册页面,这在调试固件问题时可能很有帮助。
  • certification.ubuntu.com 页面,这可能是 PCI/USB ID 和硬件变体的有用来源。
  • 指向 Linux 硬件数据库探测 的链接,该链接提供有关兼容性和 PCI/USB ID 的信息。