前言

1. 排版约定
2. 相关资源

1. 排版约定

本手册使用下列排版约定。

字体约定，为了更为清晰地、区别于正文地展示一些系统命令、程序代码等文档元素，对这些内容采用与正文有区别的字体样式：
1. 等宽字体：表示程序片段，以及正文中出现的配置选项、变量、函数名等，我们采用如下的样式显示：serverip。
2. 等宽加粗字体：表示由用户输入的系统命令。例如，用户创建一个目录的命令，用如下的样式来显示：mkdir mybook。
3. 等宽斜体：表示由用户输入的值或是一些需要设定的参数的值，例如，用户设定一个ip地址，用如下的样式显示：192.168.1.2。
4. 等宽加粗斜体字体：表示文件名、数据库名及新的术语等。例如，文件的名称用如下的样式来显示：myfirst.xml。
提示、告诫类信息（admonitions），一共有5种，分别为：
- 提示
  这种样式表示一种提示类的信息。
- 注意
  这种样式代表一种技巧或是小窍门。
- 重要
  这种样式代表重要的信息。
- 小心
  这种样式代表需要仔细注意的信息。
- 警告
  这种样式代表警告信息。

	提示
这种样式表示一种提示类的信息。

	注意
这种样式代表一种技巧或是小窍门。

	重要
这种样式代表重要的信息。

	小心
这种样式代表需要仔细注意的信息。

	警告
这种样式代表警告信息。

程序代码及屏幕内容：

有时候我们需要整块显示在屏幕上输出的内容，或者是键入的命令。例如，在linux下，我们使用ifconfig eth0命令来查网络接口信息：

$ ifconfig eth0
eth0: flags=4099<UP,BROADCAST,MULTICAST>  mtu 1500
        ether 98:fa:9b:db:b9:9f  txqueuelen 1000  (以太网)
        RX packets 0  bytes 0 (0.0 B)
        RX errors 0  dropped 0  overruns 0  frame 0
        TX packets 0  bytes 0 (0.0 B)
        TX errors 0  dropped 0 overruns 0  carrier 0  collisions 0
        device interrupt 16  memory 0xea300000-ea320000

对于一些程序代码，使用带有序号的样式来展示，例如，一段php代码：

  1 <?php
  2   class SimpleBook {
  3     private $title;
  4     
  5     function __construct($title_in) {
  6       $this->title  = $title_in;
  7     }
  8 
  9     function getTitle() {return $this->title;}
 10   }
 11 ?>


DocBook简要参考手册		2. 相关资源