我们知识库的一大亮点功能是能够显示针对操作系统(Windows、Mac 等)和 Firefox 版本定制的说明。例如,我们可以指定帮助文章的某个段落“仅适用于” Windows 用户,而 Mac 和 Linux 用户将不会看到它。该功能旨在无形中发挥作用。当有人打开帮助文章时,我们会自动检测他们使用的操作系统和 Firefox 版本,并显示相应的说明。本文详细介绍了如何在知识库文章中使用 {for}。
目录
如何为不同操作系统或 Firefox 版本切换说明
为了学习本文中的示例,您需要将文章选择器切换到不同的操作系统和 Firefox 版本。它位于文章右侧面板的编辑工具下方。
基本语法与行为
操作系统
以下语法用于显示仅适用于 Windows 10 的图片:
- {for win10}[[Image:Windows Logo]]{/for}
- 将选择器切换到 Windows 10 即可看到该图片:
- 如果您将选择器切换到 Windows XP、Windows 7、Windows 8、Windows 11、Mac 或 Linux,上面的图片将不会显示,因为它并非“适用于”这些系统。
虽然不存在通用的 Windows 选择器,但您可以编写适用于所有 Windows 版本的说明:
- {for win}[[Image:Image:vista.jpg]]{/for}
- 将选择器切换到 Windows XP、Windows 7/Vista、Windows 8、Windows 10 或 Windows 11 即可看到该图片:
- 如果您将选择器切换到 Mac 或 Linux,上面的图片将不会显示,因为它并非“适用于”这些系统。
Firefox 版本
以下语法用于显示仅适用于 Firefox 115 及更高版本的内容:
- {for fx115}[[Image:Firefox Quantum Logo]]{/for}
- 将选择器切换到 Firefox 115 或更高版本即可看到该图片:
- 如果您将选择器切换到 Firefox 114 或更低版本,上面的消息将消失,因为它并非“适用于”这些版本。
仅显示适用于一个特定 Firefox 版本的说明
要显示仅适用于 Firefox 115 的说明,请使用 “=” 运算符:
- {for =fx115}[[Image:Firefox Quantum Logo]]{/for}
- 现在,只有当您将选择器切换到 Firefox 115 时才会显示该图片:
组合操作系统和 Firefox 版本
您可以通过逗号分隔来同时指定操作系统和 Firefox 版本:
- {for win,fx115}[[Image:Windows Logo]][[Image:Quantum Logo]]{/for}
- 将选择器切换到 Windows 和 Firefox 115 或更高版本即可看到图片:
更复杂的情况(带有隐含的“适用条件”)可以这样写:
- {for mac, win10, win11, =fx113, fx115}[[Image:Windows Logo]][[Image:macos.jpg]][[Image:Firefox Quantum Logo]]{/for}
- 将选择器切换到 Mac 或 Windows 10 或 Windows 11,并且是 Firefox 113 或 Firefox 115 及更高版本即可看到图片:
否定条件
您可以在条件前加上 not 来否定一个条件。被否定的条件仅在原条件为假时为真。例如,条件
- not fx115
在 Firefox 版本低于 115 时为真。
利用 {for} 标签进行高级版本控制
随着 Firefox 频繁的更新和功能发布,for 标签在针对性内容管理方面起着关键作用,使我们能够根据用户使用的特定 Firefox 版本向其提供相关信息。这些标签的主要应用包括:
- 面向 Nightly 和 Beta 用户的早期访问: 它允许我们向 Nightly 和 Beta 渠道的用户展示即将推出的功能或变更,让他们提前了解可能发现的变化。这确保了我们最积极和技术水平最高的用户可以在更广泛的社区之前开始探索新功能。
- 发布前的本地化: for 标签允许我们在即将发布的版本公开发布之前发布相关内容。这使得我们的本地化社区能够提前准备翻译,保证新版本在正式上线时立即提供多语言支持。
- 避免普通受众混淆: 使用 for 标签,我们可以策略性地避免向普通受众暴露不成熟的信息,从而防止他们对当前 Firefox 版本中可用的功能产生混淆。
内容显示的条件
严格来说,{for} 和 {/for} 之间的标记将在同时满足以下两个条件时显示:
- {for} 没有操作系统 (OS) 条件,或者它至少有一个 OS 条件对于用户正在运行(或已手动选择)的 OS 为真。
- {for} 没有 Firefox 版本条件,或者它至少有一个 Firefox 版本条件对于用户正在运行(或已手动选择)的 Firefox 版本为真。
否则,{for}…{/for} 的内容将不会显示。
其他需要注意的事项:
- 逗号后的空格是可选的。
- {for} 和其他维基标记在文章搜索摘要中不起作用。
- 被 {for} 块隐藏的标题不会出现在页面的目录 (TOC) 中。如果用户通过手动选择正确的操作系统/浏览器组合使其显示,目录条目会立即出现。
操作系统和产品缩写
以下是可用于 {for} 的操作系统和产品缩写:
- win (Windows)
- winxp (Windows XP/2000/Server 2003)
- win7 (Windows 7/Vista/Server 2008)
- win8 (Windows 8/8.1/Server 2012)
- win10 (Windows 10)
- win11 (Windows 11)
- mac (macOS)
- linux (Linux)
- fxN 其中 N = Firefox (桌面版) 版本号,例如 fx115, fx116, fx117 等。
- mN 其中 N = Firefox for Android (移动版) 版本号,例如 m115, m116, m117 等。
- tbN 其中 N = Thunderbird 版本号,例如 tb91, tb102, tb115 等。
您必须在 Firefox 支持文章中使用 fxN,在 Firefox for Android 支持文章中使用 mN,在 Thunderbird 支持文章中使用 tbN。
行内和块级上下文
{for} 可以同时用于行内和块级上下文(在 HTML 意义上)。行内形式在文本行内起作用:
这是 {for win}行内用法{/for}。
块级形式用于包裹整个段落、有序列表、标题等。唯一的注意事项是,在使用块级形式时,{for} 和 {/for} 应各自独占一行。否则,它可能会被视为相邻段落的一部分并产生意外结果。
- {for win}
- 这是块级用法。
- *项目一
- *项目二
- {/for}
在文章中使用 {for} 的最佳实践
在为不同操作系统编写说明时,最好为每个操作系统/Firefox 版本编写完整的句子和段落,即使这意味着内容重复。这使得文章更易于理解、维护和本地化。例如,当需要删除 Firefox 115 及以下版本的特定说明时,可以直接删除这些部分,而不需要从较大的章节中移除。
- 错误使用 {for} 的方式:
- #{for not fx115}{for win,linux}在 Firefox 窗口顶部{/for}{for mac}在菜单栏上{/for}, 点击 {/for}{for fx115}点击菜单按钮,转到 {menu History} 菜单{/for}{for winxp,mac,linux,not fx115}{menu Tools} 菜单{/for}{for win7,win8,not fx115}{menu Firefox} 菜单,转到 {menu History} 菜单{/for} 然后选择 {menu Clear Recent History…}
- 正确使用 {for} 的方式:
- {for not fx115}
- #{for win7,win8}在 Firefox 窗口顶部,点击 {menu Firefox} 菜单,转到 {menu History} 菜单,然后选择 {menu Clear Recent History…}{/for}{for mac}在菜单栏上,点击 {menu Tools} 菜单,然后选择 {menu Clear Recent History…}{/for}{for winxp,linux}在 Firefox 窗口顶部,点击 {menu Tools} 菜单,然后选择 {menu Clear Recent History…}{/for}
- {/for}
- {for fx115}
- #点击菜单按钮,转到 {menu History} 菜单,然后选择 {menu Clear Recent History…}
- {/for}
在以下示例中,我们将 Firefox 113 及以下、Firefox 114/115 和 Firefox 116 及以上视为三组不同的说明。这种情况很常见,但随着我们每四周更改一次 Firefox,我们会在更高版本中看到更多变化。它们看起来会像这样:
- {for not fx114}
- #旧版说明。
- {/for}
- {for =fx114,=fx115}
- #新版说明。
- {/for}
- {for fx116}
- #更新的新版说明。
- {/for}
完整的知识库指南
请参阅 此处了解更多关于知识库贡献的指南。