D.1. 通用技巧和诀窍

要大致了解什么是标记,请阅读第 5 章

D.1.1. 有用的标记

表 D-1 显示了一些用于生成通用文档的有用标记。 请记住,某些元素仅在某些上下文中有效。

Tip检查多种格式
 

有时,特定标记的外观会因转换格式而异。 作为 DocBook 写作的初学者,您可能希望在发布文档之前查看文档在几种格式下的外观。 建议您查看文档在 HTML、PDF 和 PostScript 中的呈现方式,因为 TLDP 将在您发布文档后提供这些格式。

Note宁可多不可少
 

由于格式取决于选择的输出样式,因此建议尽可能多地使用标记。 即使使用标准输出样式时输出的外观似乎没有变化,也可能存在特定的输出格式,这些格式会使这些标记突出显示。

表 D-1. 有用的标记

描述示例标记结果
电子邮件地址<email>address@domain</email>
关于作者<author>...</author>(见下例)
作者姓名
<firstname>Mary</firstname>
<othername>Margaret</othername>
<surname>O'Hara</surname>
              
Mary Margaret O'Hara
按键名称(键盘上的印刷字符)<keycap>F1</keycap>F1
按键代表的符号<keysym>KEY_F1</keysym>KEY_F1
按键代码<keycode>0x3B</keycode>0x3B
按键组合或序列
<keycombo>
   <keycap>Ctrl</keycap>
   <keycap>S</keycap>
</keycombo>
              
Ctrl-S
程序菜单<guimenu>File</guimenu>File
菜单项<guimenuitem>Save</guimenuitem>Save
菜单序列
<menuchoice>
   <shortcut>
      <keycombo>
         <keycap>Ctrl</keycap>
         <keycap>S</keycap>
      </keycombo>
   </shortcut>
   <guimenu>File</guimenu>
   <guimenuitem>Save</guimenuitem>
</menuchoice>
              
File->Save (Ctrl-S)
鼠标按钮<mousebutton>left</mousebutton>left
应用程序名称<application>application</application>application
文本参考文献<citation>reference</citation>[reference]
引用
<blockquote>
   <attribution>Text Author</attribution>
   <para>Quote Text.</para>
</blockquote>
              

 

引用文本。

 
--Text Author 

索引(不适用)参见第 D.4 节
文件名
<filename>file</filename>
file
目录
<filename id="directory">directory</filename>
directory/
强调文本[a]
<emphasis>text</emphasis>
text
脚注
<footnote>
   <para>Footnote text</para>
</footnote>
(有关示例,请参阅本表末尾的注释)
URL
<ulink url="http://www.conectiva.com">Conectiva S.A.</>
Conectiva S.A.
无序列表
<itemizedlist>
   <listitem>
      <para>item</para>
   </listitem>
   <listitem>
      <para>item</para>
   </listitem>
</itemizedlist>

  • item

  • item

有序列表
<orderedlist>
   <listitem>
      <para>item</para>
   </listitem>
   <listitem>
      <para>item</para>
   </listitem>
</orderedlist>

  1. item

  2. item

分段列表
<segmentedlist>
   <title>Binary to decimal conversion</title>
   <segtitle>Binary</segtitle>
   <segtitle>Decimal</segtitle>
   </seglistitem><seg>00</seg><seg>0</seg>
   </seglistitem>
   <seglistitem><seg>01</seg><seg>1</seg>
   </seglistitem>
   <seglistitem><seg>10</seg><seg>2</seg>
   </seglistitem>
</segmentedlist>

二进制到十进制转换

二进制00

十进制0

二进制01

十进制1

二进制10

十进制2

变量列表
<variablelist>
   <varlistentry>
      <term>Entry 1</term>
      <listitem>
         <para>Description</para>
      </listitem>
   </varlistentry>
   <varlistentry>
      <term>Entry 2</term>
      <listitem>
         <para>Description</para>
      </listitem>
   </varlistentry>
</variablelist>

Entry 1

描述

Entry 2

描述

简单列表
<simplelist type="horiz" columns="3">
   <member>1</member>
   <member>2</member>
   <member>3</member>
   <member>4</member>
   <member>5</member>
   <member>6</member>
</simplelist>
<simplelist type="inline">
   <member>A</member>
   <member>B</member>
   <member>C</member>
   <member>D</member>
   <member>E</member>
   <member>F</member>
</simplelist>

123
456

A, B, C, D, E, F
图片(不适用)参见第 D.5 节
术语表
<glossentry>
   <glossterm>Term</glossterm>
   <glossdef>
      <para>Definition</para>
   </glossdef>
</glossentry>
(请参阅本文档末尾的术语表)
交叉引用
<section id="secao">
...
</section>
<section id="reference the other section">
...
<para>Please, see<xref linkend="secao" /> for more information.
(不适用)
注释
a. 文本可以通过几种方式强调。 最常见的方式是斜体和粗体。 然而,DocBook 仅支持斜体。 使用粗体需要在使用的样式表上进行额外的设置。