突出显示与强调

告诉我们你在哪里！

本章内容

突出基本要点
具体的强调技巧

常见的高亮问题
进一步探索
高亮显示方案

你对本章的评论

搜索！

主索引

高亮显示

技术写作中的一个问题—特别是关于计算机的技术写作—涉及使用各种强调技巧。 不幸的是，一些技术文本在使用这里讨论的各种强调技巧时过火。

高亮显示基础

考虑一些强调的基本原则：

• 几乎任何与常规正文不同的特殊文本效果都可以作为强调手法。诸如斜体, 粗体, 下划线, 全大写, 不同字号, 替代字体, 颜色, 各种图形创意 (如突出显示, 反色, 轮廓字体) 都可以起到强调的作用。
• 如果使用过度, 任何强调手法或多种强调手法的组合都可能失去它们的强调效果, 变得繁杂且分散注意力. 如果使用过度, 任何强调手法或多种强调手法的组合都可能导致读者不愿意阅读一段文字, 甚至完全避免阅读它. 注意在这个示例中, 过度高亮的通知版本是多么难以阅读 弹出窗口; 另请注意，它没有使用在……中推荐的通知类型 通知.
• 当需要强调较长文本时，使用该 特别-通知 格式 (而不是创建全部加粗或全部大写的段落，例如).
• 被强调的文本与所使用的强调手法之间必须存在经过精心规划的功能性关系。
• 强调技巧必须一致地使用，以防读者产生困惑。
• 为了促进一致性，你必须使用风格指南或样式表，它记录并随后规定你关于如何使用强调技巧的所有决定。
• 为帮助读者理解你的突出标注方案，你可以在文档的某处（通常在前言）加入一小节，简要说明你将如何使用这些强调手法。

在下面的讨论中，你会注意到任何强调技巧体系都可能变得相当复杂，且令作者和编辑难以记住。你会注意到存在许多同样有效的强调用法: 例如，在某些情况下，为了简单强调使用加粗还是斜体是任意的。为了解决这个问题，你必须在风格指南中记录你的突出显示准则，供作者和编辑(或仅你)参考。一个 风格指南 只是记录你和你的文档团队关于文档外观所做的决定.

你的读者也需要了解你计划使用的高亮方案。可以在前言中说明：包括一个名为“高亮”或“排版约定”的章节，在其中列出你如何使用斜体、加粗、字体及其他类似效果。举例，请参见有关前言讨论的章节 技术书籍的标准组成部分

具体的强调技巧

下一部分逐一介绍各种强调技巧, 解释常见做法.

注意: 为了保持简单，突出显示问题以 表格, 图表, 标题, 列表, 和 通知 在那些部分中呈现.

加粗

无论你使用哪种技术, 都应在你的文本或相关文本库中始终如一地使用它. 顺便说一下, 读者不太可能区分强调的不同层次: 例如, 使用斜体表示重要内容、使用加粗表示非常重要的内容, 对大多数读者来说可能分辨不出.

如果你想把整段文字都加粗，记住上面讨论的强调原则之一：过度使用强调手法会使这种手法失去效果。不仅如此，过多的强调会让读者不太愿意阅读。读者可能不会仔细阅读整段加粗的文字，反而会完全忽视它！

与其创建一个全粗体的段落，使用 特别-通知 格式. 在其中，一个关键词（例如，重要、注意、危险、小心、警告）被加粗，而其余的文本则保持常规罗马体（即与正文相同的字体和样式）。

在技术文本中合理使用加粗的方式差异很大. 只要你制定的方案与读者的需求和文本（或技术）的特性直接相关，且不会导致过度使用，你的加粗用法就会奏效.

下面是一些常见的、标准的粗体用法：

• 简单的强调。 如前所述，一些技术文本在用于简单强调时使用粗体，而不是传统的斜体。例如，"做 不 在关机前先把电脑关掉."
• 命令. 计算机文本通常在命令中使用粗体，例如，"使用该 移动 "用于重命名 UNIX 文件的命令。" 请参阅关于突出显示计算机文本的章节，以查看完整的强调技巧集。
• 触发命令的按钮。 在图形用户界面中, 有些按钮会触发命令. 例如, "按下 退出 退出应用程序的按钮."
• 字段标签. 虽然一些计算机文本将字段标签加粗, 但这并非普遍做法, 因为它会导致过度高亮. 例如, "在 缩进 对话框的区域, 单击 左." 更常见的是使用屏幕上所示的大小写样式。最好这样写："在对话框的缩进区域，单击 左."
• 图标或键盘或鼠标按钮。 Q 钥匙或者那个 左 鼠标按钮。" 为保持该系统的一致性，也应在图标上使用粗体： "点击 开始 图标."
• 硬件上的标签. 在计算机出版中，另一种常见的做法是将硬件标签的名称加粗。例如，"按下 重置 用于重启计算机的按钮."

你会注意到，前面的讨论并没有提出任何绝对规则。情况就是这样—技术出版实践相当多样。主要思想是制定一个合乎逻辑、受控的突出显示系统，持续一致地使用，并将其记录在风格指南中，以便你和你的文档团队成员查阅它。

斜体

以下是斜体的一些常见用法：

• 简单的强调 不
• 变量 . 在计算机出版中，斜体最常见的用途之一是用于表示变量。例如：
  
  复制 旧文件 新文件
  
  用户知道不要输入 旧文件 或 新文件 但改为使用他们自己的文件名.
• 定义在定义（两栏）列表中. 虽然在双栏列表的左列中粗体更常见, 但也使用斜体. (参见前一节关于粗体的双栏列表的讨论.)
• 术语定义所在的条款. 一个不错的做法是在正文中定义某个词时将其斜体化。

下划线

如果你在技术文本中看到下划线被很好地使用, 它很可能出现在标题设计中.

大写

作为技术写作者，要坚持抵制使用大写字母。大写字母会分散注意力；全部大写的文本令人不舒服且难以阅读。大写字母使文本显得繁杂，传递了许多不必要的信号。传统上，大写字母用于专有名词，例如 Microsoft, Netscape, Gateway, Dell Computers, WordPerfect, 等等。技术出版中的经典准则是将名称首字母大写 可单独订购的产品 仅此而已。然而，组织内部的政治会大大扭曲这条准则。如果一家公司为其新版本中的某个功能感到自豪，例如 EnergyMiser，它就会把它写成大写，即使你无法单独订购它。

以下是一些关于大写的典型指南：

• 对计算机屏幕上显示的消息、菜单或屏幕名称、字段名称、硬件标签等，使用其原有的大小写样式。 (在较旧的界面中，类似字段、菜单和屏幕名称常常使用全大写。 在这些情况下，一种常见做法是在正文中对这些引用使用首字母大写。 这里的原则是：在常规文本中不必要的全大写会分散注意力。)
• 做 不 使用大写字母来表示强调；改用斜体或粗体。
• 不要对任何较长的文本使用全部大写字母；使用 特别-通知 格式 而是.
• 不要将产品的组件或流程的名称首字母大写. 仅将产品的名称首字母大写, 也就是那些可以单独订购的组件.
  
  
  
  但是当你不得不像这样打破规则时, 这些例外需要写入风格指南或样式表.

单引号或双引号

在技术文本中，引号常被错误地用作强调的手段。作为技术写作者，应将引号限制在传统用法，包括引用的话语；表示数字、字母或词语本身。引号像大写字母一样，往往会使文本显得杂乱、分散注意力，因此应尽量避免使用。

双引号的一种合理用途是表示对词语的奇怪、古怪、非标准的用法（被称为 "scare quotes" by 芝加哥风格手册). 例如：

在核心转储中，计算机会把所有数据“吐”到一个文件里。

设计良好的计算机文本相当坚决地避免使用引号。一个主要原因是一些读者可能会错误地以为在输入命令时必须包含引号。

注意： 虽然在某些技术文本中，单引号有明确定义的用途，但一般来说，单引号并没有标准用法，除了传统的引号内再引号规则和古怪用法规则。 当你在技术文本中看到单引号时，通常并没有比双引号更充分的理由。

替代字体

涉及替代字体的最常见样式之一是使用 Courier 或某种类似的等宽、老式打字机风格的字体，以与 标准正文字体（例如 Times New Roman 或 Helvetica）形成对比。您可以在一个 1web 页面中使用类似 <span class="example_text"> 的 CSS 样 安装 安装该程序."

以下是对备用字体常见用途的回顾：

• 示例 文本. 为了表示所示的是示例而非必填项，通常使用 Courier 等替代字体:

例如，如果您想复制一个文件，请键入 复制 yourfile.txt 我的文件.txt. 一个名为的文件 我的文件.txt 将被创建, 其内容将与 相同 你的文件.txt.

• 显示的文本 没有这样的文件或目录." 或者，"当计算机启动时，数字读出窗口将显示 8888."
• 扩展的代码示例. 在计算机编程文本中，较长的程序示例通常以 Courier 字体显示，例如：

#检查是否有恶意黑客 if ($address1 eq "" & $address2 eq "") { &wicked_address (500, "搜索错误", "请输入一个名字."); } elsif ($address1 =~ /[;<>&\*`\|]/ | $address2 =~ /[;<>&\*`\|]/) { &wicked_address (500, "搜索错误", "电子邮件地址格式错误. 请不要摧毁我们可怜、简陋的单间虚拟校舍!."); }

颜色

技术文档中使用彩色但成本高昂且在出版流程中难以管理.

然而, 颜色在在线信息中很容易使用. 例如, 常见的是看到超文本链接使用颜色. 在线帮助通常使用绿色, 而网页通常将新链接显示为蓝色, 用户已浏览的链接则为紫色.

如果你想使用颜色, 请仔细规划。不要指望读者记住红色表示一种意思, 蓝色表示另一种意思, 绿色又表示第三种意思。只使用一种颜色即可。一般来说, 避免在大段文本中使用颜色。不要把整条警告通知都设为红色, 只把警告标签设为红色, 并将警告正文保留为常规正体（像正文那样的常规字体文本）。

更好的是，阅读一些技术传播领域中关于色彩的权威文献。存在一般的设计问题和国际性问题：

• 使用颜色. 由美国网页设计系统（USWDS）提供。
• 营销与广告中色彩使用的国际指南. 不同的含义，例如红色在国际上所具有的含义. 看看它的 国际色彩象征图表. 来源: Six Degrees, LLC
• 请记住, 根据一个 文章

前述各项的组合

一般来说, 把强调手法混合使用并不是一个好主意, 例如同时使用加粗和斜体。在非专业的技术文本中, 你会看到诸如全部大写的加粗斜体或带双引号的全部大写加粗斜体等刺眼组合。避免这些!

一种合理的组合是将斜体与替代字体结合使用。例如，当你显示命令的语法时，你希望整段文本使用 Courier 字体，但同时希望变量使用斜体：

复制 旧文件名 新文件名

字符样式和标签的功能性名称

如果你曾经接触过出版行业，你可能遇到过所谓的 语义标记. 这意味着根据文本在文档中所扮演的结构性角色来命名文本的各个部分—例如, 标题. 读者看不到这些名称，但它们在文档的格式化和可重用性方面起着重要作用。

同样的想法也适用于文本中短语里的单词。 例如，在网页的 HTML 中，你可以使用 <b>加粗的词</b> 标签用于使单词加粗. 但加粗并不表示该词或短语的功能. 相反, 命令 会或 界面_标签 会这样。因此在使用 HTML 和 CSS 的语义化标记中，如果事物看起来像这样，会更实用： <span class="command">加粗的词</span>.

使用 HTML 和 CSS 的文件通常会被转换为其他媒体，例如 PDF, 甚至可以与 XML 相互转换. 使用 在功能上 命名的高亮样式, 如上方所述, 可以大大简化转换过程.

进一步探索

读完前文后，接下来做的一件好事是查阅技术刊物，看看它们采用了哪些高亮方案。注意诸如加粗、斜体、大写、替代字体以及其他类似效果的使用方式。很可能，你会看到与这里所述截然不同的用法。在你探索时，思考这些被使用的强调技术的逻辑；试着归纳作者们似乎在使用的规则；留意高亮使用中的不一致之处；并批判性地思考你所看到的用法—它合逻辑吗？过犹不及吗？"不够吗？"

在你像这样做了一些探索之后，下一步合乎逻辑的是阅读关于 风格指南, 如果你还没有这样做的话. 高亮方案必须记录在样式指南中，以免你忘记它们，并且你的文档团队成员可以参考它们.

高亮方案

如果之前讨论的所有选项和替代方案让你不知所措, 考虑使用下列高亮方案. 它基于你会在许多 UNIX, Windows,and Linux 文档中看到的高亮.

备注:

1. 常规 罗马体 是指正文使用的任意字体和字号.
3. 如果你向用户展示如何输入命令并包含示例文本，请不要将示例文本中的命令加粗：

使用该 移动 用于更改文件名称或位置的命令，例如：
移动 thisfile.txt thatfile.txt.

4. 如果你向用户展示如何输入包含示例文本的命令, 并在示例文本中包含变量, 请对这些变量使用斜体.

使用该 移动 用于更改文件名或位置的命令：
移动 我的_文件.txt 你的_文件.txt.

5. 如果你只是指代某个未被点击且不会触发任何事件的屏幕或菜单的名称，请对屏幕使用首字母大写样式，对菜单使用常规罗马体。
6. 有些样式会将用户应采取的操作加粗 (例如, 按, 进入, 删除). 那当然是一个选择，但对我来说这太过显眼。

用户指南通常在序言中放置一张图表，说明用于突出显示的字体、颜色和排版的含义：

我会很感激您对本章的想法、反应和批评： 你的回复.