排版约定

在正文中会有一些诸如程序代码、系统命令或是屏幕输出一类的信息,为了能清晰地展示各种元素,本手册遵守下列排版约定。

  1. 字体约定,在正文中嵌入的一些系统命令、文件名、函数或是参数等使用有别于正文的字体:

    1. 等宽字体:程序片段、正文中出现的配置选项、变量、函数名等,我们采用等宽字体,样式如下:serverip

    2. 等宽微粗字体:表示由用户输入的系统命令。例如,在linux下,我们查网络接口信息的命令:ifconfig eth0

    3. 等宽斜体:表示由用户输入的值或是一些需要设定的参数的值,例如,用户在浏览器里输入的一个url,用如下的样式显示:http://docboon.io

    4. 等宽微粗斜体字体:表示文件名、数据库名及新的术语等。例如,文件的名称用如下的样式来显示:myfirst.xml

  2. 提示、告诫类信息(admonitions),有一些内容是正文的补充或是对用户的一种提醒。为了能清晰地展示这部分内容,采用独立的“信息块”来呈现。一共有5种,分别为:

    • [提示]提示

      可以使用apt-get upgrade来升级您的ubuntu或debian Linux系统。

    • [注意]注意

      在运行apt-get upgrade之前,需要先运行用apt-get update命令。

    • [重要]重要

      请及时升级系统补丁程序,这是保证系统处于安全状态的好方法。

    • [小心]小心

      如果系统升级还没有完成,请不要重新启动您的电脑。

    • [警告]警告

      在系统升级过程中千万不要关闭电源。

  3. 屏幕内容围栏及程序代码围栏

    • 屏幕内容围栏,有时候我们需要整块显示在屏幕上输出的内容,或者是键入的命令。例如,在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 ?>