我们使用四种排版约定突出特定用词和短语。这些约定及其使用环境如下。
单行粗体
用来突出系统输入,其中包括 shell 命令、文件名以及路径。还可用来突出按键以及组合键。例如:
要看到文件您当前工作目录中文件 my_next_bestselling_novel
的内容,请在 shell 提示符后输入 cat my_next_bestselling_novel
命令并按 Enter 键执行该命令。
以上内容包括一个文件名,一个 shell 命令以及一个按键,它们都以固定粗体形式出现,且全部与上下文有所区别。
按键组合与单独按键之间的区别是按键组合是使用加号将各个按键连在一起。例如:
按 Enter 执行该命令。
按 Ctrl+Alt+F2 切换到虚拟终端。
第一个示例突出的是要按的特定按键。第二个示例突出了按键组合:一组要同时按下的三个按键。
如果讨论的是源码、等级名称、方法、功能、变量名称以及在段落中提到的返回的数值,那么都会以上述形式出现,即固定粗体
。例如:
与文件相关的等级包括用于文件系统的 filesystem
、用于文件的 file
以及用于目录的 dir
。每个等级都有其自身相关的权限。
比例粗体
这是指在系统中遇到的文字或者短语,其中包括应用程序名称、对话框文本、标记的按钮、复选框以及单选按钮标签、菜单标题以及子菜单标题。例如:
在主菜单条中选择 → → 启动 鼠标首选项。在「按钮」标签中点击「惯用左手鼠标」 复选框并点击 关闭切换到主鼠标按钮从左向右(让鼠标适合左手使用)。
要在 gedit 文件中插入特殊字符,请在主菜单栏中选择 → → 。接下来选择从 Character Map 菜单中选择 → ,在「搜索」字段输入字符名称并点击「下一个」按钮。此时会在「字符映射表」中突出您搜索的字符。双击突出的字符将其放在「要复制的文本」字段中,然后点击「复制」按钮。现在返回您的文档,并选择 gedit 菜单中的 → 。
以上文本包括应用程序名称、系统范围菜单名称及项目、应用程序特定菜单名称以及按钮和 GUI 界面中的文本,所有都以比例粗体出现并与上下文区别。
固定粗斜体
或者 比例粗斜体
无论固定粗体或者比例粗体,附加的斜体表示是可替换或者变量文本。斜体表示那些不直接输入的文本或者那些根据环境改变的文本。例如:
要使用 ssh 连接到远程机器,请在 shell 提示符后输入 ssh username
@domain.name
。如果远程机器是 example.com
且您在该其机器中的用户名为 john,请输入 ssh john@example.com
。
mount -o remount file-system
命令会重新挂载命名的文件系统。例如:要重新挂载 /home
文件系统,则命令为 mount -o remount /home
。
要查看目前安装的软件包版本,请使用 rpm -q package
命令。它会返回以下结果:package-version-release
。
请注意上述使用黑斜体的文字 -- username、domain.name、file-system、package、version 和 release。每个字都是一个站位符,可用作您执行命令时输入的文本,也可作为该系统显示的文本。
不考虑工作中显示标题的标准用法,斜体表示第一次使用某个新且重要的用语。例如:
Publican 是一个 DocBook 发布系统。
终端输出和源代码列表要与周围文本明显分开。
将发送到终端的输出设定为 Mono-spaced Roman
并显示为:
books Desktop documentation drafts mss photos stuff svn
books_tests Desktop1 downloads images notes scripts svgs
源码列表也设为 Mono-spaced Roman
,但添加下面突出的语法:
package org.jboss.book.jca.ex1;
import javax.naming.InitialContext;
public class ExClient
{
public static void main(String args[])
throws Exception
{
InitialContext iniCtx = new InitialContext();
Object ref = iniCtx.lookup("EchoBean");
EchoHome home = (EchoHome) ref;
Echo echo = home.create();
System.out.println("Created Echo");
System.out.println("Echo.echo('Hello') = " + echo.echo("Hello"));
}
}