LDP
/
old-www
1
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity
old-www/LDP/LDP-Author-Guide/html/writing-docbook.html

1783 lines
22 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML
><HEAD
><TITLE
>General Tips and Tricks</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
REL="HOME"
TITLE="LDP Author Guide"
HREF="index.html"><LINK
REL="UP"
TITLE="DocBook: Sample Markup"
HREF="using-docbook.html"><LINK
REL="PREVIOUS"
TITLE="DocBook: Sample Markup"
HREF="using-docbook.html"><LINK
REL="NEXT"
TITLE="section and sectN: what's the difference?"
HREF="section.html"></HEAD
><BODY
CLASS="section"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>LDP Author Guide</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="using-docbook.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Appendix D. DocBook: Sample Markup</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="section.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="writing-docbook"
></A
>D.1. General Tips and Tricks</H1
><P
>&#13; For a general overview of what markup is all about, please read <A
HREF="ag-markup.html"
>Chapter 5</A
>
</P
><P
></P
><UL
><LI
><P
>An editor capable of inserting elements according to the
<SPAN
CLASS="acronym"
>DTD</SPAN
> will help a lot since it will enforce
the DTD.
This way you can be sure that no invalid elements were added
anywhere in your document.</P
></LI
><LI
><P
>In order to ensure that future changes are as easy as possible,
authors should try to keep compatibility with
the <SPAN
CLASS="acronym"
>XML</SPAN
> version of the DocBook DTD. This means
keeping element names in lower case, using double quotes in all
attributes, and not omitting end tags. Most tools that
automatically insert elements (like psgml+emacs) follow these
rules automatically or with some fine tuning.</P
></LI
><LI
><P
>Each type of document created has a specific structure. This
document is in <SPAN
CLASS="QUOTE"
>"book"</SPAN
> format. Most authors, however, will
want to use the shorter <SPAN
CLASS="QUOTE"
>"article"</SPAN
> format instead.
Templates are available from <A
HREF="templates.html"
>Appendix A</A
>.
</P
></LI
></UL
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="useful-markup"
></A
>D.1.1. Useful markup</H2
><P
><A
HREF="writing-docbook.html#table-useful-markup"
>Table D-1</A
> shows some markup that
is useful for generating generic documents. Remember that some
elements are valid only on some contexts.</P
><DIV
CLASS="tip"
><P
></P
><TABLE
CLASS="tip"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/tip.gif"
HSPACE="5"
ALT="Tip"></TD
><TH
ALIGN="LEFT"
VALIGN="CENTER"
><B
>Check several formats</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Sometimes the appearance of a particular tag changes
from one conversion format to another. As a beginner in DocBook writing,
you may wish to see how your document looks in several formats
before you publish them. You are advised to look at how your document is presented in HTML, PDF and PostScript, since these formats will be made available by TLDP once you publish your document.</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TH
ALIGN="LEFT"
VALIGN="CENTER"
><B
>Better too much than not enough</B
></TH
></TR
><TR
><TD
>&nbsp;</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>Since the formatting depends on the output style chosen, it's
recommended to use as much markup as possible. Even if the appearance
of the output doesn't seem to change with the standard output
style, there may be specific output formats that will make
these tags stand out.</P
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="table"
><A
NAME="table-useful-markup"
></A
><P
><B
>Table D-1. Useful markup</B
></P
><TABLE
BORDER="1"
CLASS="CALSTABLE"
><THEAD
><TR
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
>Description</TH
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
>Sample markup</TH
><TH
ALIGN="LEFT"
VALIGN="MIDDLE"
>Result</TH
></TR
></THEAD
><TBODY
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>E-mail address</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="sgmltag"
>&#60;email&#62;</TT
>address@domain<TT
CLASS="sgmltag"
>&#60;/email&#62;</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="email"
>&#60;<A
HREF="mailto:address@domain"
>address@domain</A
>&#62;</TT
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>About the author</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="sgmltag"
>&#60;author&#62;</TT
>...<TT
CLASS="sgmltag"
>&#60;/author&#62;</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>(see example below)</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Author's name</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;firstname&#62;</TT
>Mary<TT
CLASS="sgmltag"
>&#60;/firstname&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;othername&#62;</TT
>Margaret<TT
CLASS="sgmltag"
>&#60;/othername&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;surname&#62;</TT
>O'Hara<TT
CLASS="sgmltag"
>&#60;/surname&#62;</TT
>
</PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Mary Margaret O'Hara</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Keys' name (printings on the keyboard)</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="sgmltag"
>&#60;keycap&#62;</TT
>F1<TT
CLASS="sgmltag"
>&#60;/keycap&#62;</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><B
CLASS="keycap"
>F1</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Symbol represented by the keys</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="sgmltag"
>&#60;keysym&#62;</TT
>KEY_F1<TT
CLASS="sgmltag"
>&#60;/keysym&#62;</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><SPAN
CLASS="keysym"
>KEY_F1</SPAN
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Key's code</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="sgmltag"
>&#60;keycode&#62;</TT
>0x3B<TT
CLASS="sgmltag"
>&#60;/keycode&#62;</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><SPAN
CLASS="keycode"
>0x3B</SPAN
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Combinations or sequences of keys</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;keycombo&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;keycap&#62;</TT
>Ctrl<TT
CLASS="sgmltag"
>&#60;/keycap&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;keycap&#62;</TT
>S<TT
CLASS="sgmltag"
>&#60;/keycap&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/keycombo&#62;</TT
>
</PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><B
CLASS="keycap"
>Ctrl</B
>-<B
CLASS="keycap"
>S</B
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Program Menus</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="sgmltag"
>&#60;guimenu&#62;</TT
>File<TT
CLASS="sgmltag"
>&#60;/guimenu&#62;</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><SPAN
CLASS="guimenu"
>File</SPAN
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Menu Items</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="sgmltag"
>&#60;guimenuitem&#62;</TT
>Save<TT
CLASS="sgmltag"
>&#60;/guimenuitem&#62;</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><SPAN
CLASS="guimenuitem"
>Save</SPAN
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Menu Sequences</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;menuchoice&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;shortcut&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;keycombo&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;keycap&#62;</TT
>Ctrl<TT
CLASS="sgmltag"
>&#60;/keycap&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;keycap&#62;</TT
>S<TT
CLASS="sgmltag"
>&#60;/keycap&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/keycombo&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/shortcut&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;guimenu&#62;</TT
>File<TT
CLASS="sgmltag"
>&#60;/guimenu&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;guimenuitem&#62;</TT
>Save<TT
CLASS="sgmltag"
>&#60;/guimenuitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/menuchoice&#62;</TT
>
</PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><SPAN
CLASS="guimenu"
>File</SPAN
>-&gt;<SPAN
CLASS="guimenuitem"
>Save</SPAN
> (<B
CLASS="shortcut"
><B
CLASS="keycap"
>Ctrl</B
>-<B
CLASS="keycap"
>S</B
></B
>)</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Mouse Button</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="sgmltag"
>&#60;mousebutton&#62;</TT
>left<TT
CLASS="sgmltag"
>&#60;/mousebutton&#62;</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><SPAN
CLASS="mousebutton"
>left</SPAN
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Application Names</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="sgmltag"
>&#60;application&#62;</TT
>application<TT
CLASS="sgmltag"
>&#60;/application&#62;</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><SPAN
CLASS="application"
>application</SPAN
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Text Bibliographical Reference</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="sgmltag"
>&#60;citation&#62;</TT
>reference<TT
CLASS="sgmltag"
>&#60;/citation&#62;</TT
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>[<SPAN
CLASS="citation"
>reference</SPAN
>]</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Quote</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;blockquote&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;attribution&#62;</TT
>Text Author<TT
CLASS="sgmltag"
>&#60;/attribution&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;para&#62;</TT
>Quote Text.<TT
CLASS="sgmltag"
>&#60;/para&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/blockquote&#62;</TT
>
</PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><P
><A
NAME="AEN2742"
></A
><TABLE
BORDER="0"
WIDTH="100%"
CELLSPACING="0"
CELLPADDING="0"
CLASS="BLOCKQUOTE"
><TR
><TD
WIDTH="10%"
VALIGN="TOP"
>&nbsp;</TD
><TD
WIDTH="80%"
VALIGN="TOP"
><P
>Quote Text.</P
></TD
><TD
WIDTH="10%"
VALIGN="TOP"
>&nbsp;</TD
></TR
><TR
><TD
COLSPAN="2"
ALIGN="RIGHT"
VALIGN="TOP"
>--<SPAN
CLASS="attribution"
>Text Author</SPAN
></TD
><TD
WIDTH="10%"
>&nbsp;</TD
></TR
></TABLE
></P
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Index</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>(NA)</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>See <A
HREF="encoding-index.html"
>Section D.4</A
>.</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>File Names</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;filename&#62;</TT
>file<TT
CLASS="sgmltag"
>&#60;/filename&#62;</TT
></PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="filename"
>file</TT
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Directories</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;filename id="directory"&#62;</TT
>directory<TT
CLASS="sgmltag"
>&#60;/filename&#62;</TT
></PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TT
CLASS="filename"
>directory/</TT
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Emphasize Text<A
NAME="AEN2768"
HREF="#FTN.AEN2768"
><SPAN
CLASS="footnote"
>[a]</SPAN
></A
>
</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;emphasis&#62;</TT
>text<TT
CLASS="sgmltag"
>&#60;/emphasis&#62;</TT
></PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><EM
>text</EM
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Footnotes</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;footnote&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;para&#62;</TT
>Footnote text<TT
CLASS="sgmltag"
>&#60;/para&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/footnote&#62;</TT
></PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>(See note at the end of this table for an example)</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>URLs</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;ulink url="http://www.conectiva.com"&#62;</TT
>Conectiva S.A.<TT
CLASS="sgmltag"
>&#60;/&#62;</TT
></PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><A
HREF="http://www.conectiva.com"
TARGET="_top"
>Conectiva S.A.</A
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Itemized (unnumbered) List</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;itemizedlist&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;listitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;para&#62;</TT
>item<TT
CLASS="sgmltag"
>&#60;/para&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/listitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;listitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;para&#62;</TT
>item<TT
CLASS="sgmltag"
>&#60;/para&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/listitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/itemizedlist&#62;</TT
>
</PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><P
></P
><UL
><LI
><P
>item</P
></LI
><LI
><P
>item</P
></LI
></UL
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Ordered (numbered) List</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;orderedlist&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;listitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;para&#62;</TT
>item<TT
CLASS="sgmltag"
>&#60;/para&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/listitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;listitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;para&#62;</TT
>item<TT
CLASS="sgmltag"
>&#60;/para&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/listitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/orderedlist&#62;</TT
>
</PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><P
></P
><OL
TYPE="1"
><LI
><P
>item</P
></LI
><LI
><P
>item</P
></LI
></OL
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Segmented List</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;segmentedlist&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;title&#62;</TT
>Binary to decimal conversion<TT
CLASS="sgmltag"
>&#60;/title&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;segtitle&#62;</TT
>Binary<TT
CLASS="sgmltag"
>&#60;/segtitle&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;segtitle&#62;</TT
>Decimal<TT
CLASS="sgmltag"
>&#60;/segtitle&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/seglistitem&#62;</TT
><TT
CLASS="sgmltag"
>&#60;seg&#62;</TT
>00<TT
CLASS="sgmltag"
>&#60;/seg&#62;</TT
><TT
CLASS="sgmltag"
>&#60;seg&#62;</TT
>0<TT
CLASS="sgmltag"
>&#60;/seg&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/seglistitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;seglistitem&#62;</TT
><TT
CLASS="sgmltag"
>&#60;seg&#62;</TT
>01<TT
CLASS="sgmltag"
>&#60;/seg&#62;</TT
><TT
CLASS="sgmltag"
>&#60;seg&#62;</TT
>1<TT
CLASS="sgmltag"
>&#60;/seg&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/seglistitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;seglistitem&#62;</TT
><TT
CLASS="sgmltag"
>&#60;seg&#62;</TT
>10<TT
CLASS="sgmltag"
>&#60;/seg&#62;</TT
><TT
CLASS="sgmltag"
>&#60;seg&#62;</TT
>2<TT
CLASS="sgmltag"
>&#60;/seg&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/seglistitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/segmentedlist&#62;</TT
>
</PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><P
><B
>Binary to Decimal Conversion</B
></P
><P
><B
>Binary: </B
>00</P
><P
><B
>Decimal: </B
>0</P
><P
><B
>Binary: </B
>01</P
><P
><B
>Decimal: </B
>1</P
><P
><B
>Binary: </B
>10</P
><P
><B
>Decimal: </B
>2</P
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Variable List</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;variablelist&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;varlistentry&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;term&#62;</TT
>Entry 1<TT
CLASS="sgmltag"
>&#60;/term&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;listitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;para&#62;</TT
>Description<TT
CLASS="sgmltag"
>&#60;/para&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/listitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/varlistentry&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;varlistentry&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;term&#62;</TT
>Entry 2<TT
CLASS="sgmltag"
>&#60;/term&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;listitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;para&#62;</TT
>Description<TT
CLASS="sgmltag"
>&#60;/para&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/listitem&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/varlistentry&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/variablelist&#62;</TT
>
</PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><P
></P
><DIV
CLASS="variablelist"
><DL
><DT
>Entry 1</DT
><DD
><P
>Description</P
></DD
><DT
>Entry 2</DT
><DD
><P
>Description</P
></DD
></DL
></DIV
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Simple Lists</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;simplelist type="horiz" columns="3"&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;member&#62;</TT
>1<TT
CLASS="sgmltag"
>&#60;/member&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;member&#62;</TT
>2<TT
CLASS="sgmltag"
>&#60;/member&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;member&#62;</TT
>3<TT
CLASS="sgmltag"
>&#60;/member&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;member&#62;</TT
>4<TT
CLASS="sgmltag"
>&#60;/member&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;member&#62;</TT
>5<TT
CLASS="sgmltag"
>&#60;/member&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;member&#62;</TT
>6<TT
CLASS="sgmltag"
>&#60;/member&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/simplelist&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;simplelist type="inline"&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;member&#62;</TT
>A<TT
CLASS="sgmltag"
>&#60;/member&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;member&#62;</TT
>B<TT
CLASS="sgmltag"
>&#60;/member&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;member&#62;</TT
>C<TT
CLASS="sgmltag"
>&#60;/member&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;member&#62;</TT
>D<TT
CLASS="sgmltag"
>&#60;/member&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;member&#62;</TT
>E<TT
CLASS="sgmltag"
>&#60;/member&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;member&#62;</TT
>F<TT
CLASS="sgmltag"
>&#60;/member&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/simplelist&#62;</TT
>
</PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>1</TD
><TD
>2</TD
><TD
>3</TD
></TR
><TR
><TD
>4</TD
><TD
>5</TD
><TD
>6</TD
></TR
></TBODY
></TABLE
><P
></P
>A, B, C, D, E, F</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Pictures</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>(NA)</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>See <A
HREF="inserting-pictures.html"
>Section D.5</A
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Glossary</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;glossentry&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;glossterm&#62;</TT
>Term<TT
CLASS="sgmltag"
>&#60;/glossterm&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;glossdef&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;para&#62;</TT
>Definition<TT
CLASS="sgmltag"
>&#60;/para&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/glossdef&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;/glossentry&#62;</TT
></PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>(See the glossary at the end of this document)</TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>Crossed References</TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="programlisting"
>&#13;<TT
CLASS="sgmltag"
>&#60;section id="secao"&#62;</TT
>
...
<TT
CLASS="sgmltag"
>&#60;/section&#62;</TT
>
<TT
CLASS="sgmltag"
>&#60;section id="reference the other section"&#62;</TT
>
...
<TT
CLASS="sgmltag"
>&#60;para&#62;</TT
>Please, see<TT
CLASS="sgmltag"
>&#60;xref linkend="secao" /&#62;</TT
> for more information.</PRE
></FONT
></TD
></TR
></TABLE
></TD
><TD
ALIGN="LEFT"
VALIGN="MIDDLE"
>(NA)</TD
></TR
></TBODY
><TR
><TD
COLSPAN="3"
>Notes:<BR><A
NAME="FTN.AEN2768"
>a. </A
>Text can be emphasized in a few ways. The most
common ways are italics and bold. DocBook, however, supports only
italics. The use of bold requires additional settings on the
style sheet used.<BR></TD
></TR
></TABLE
></DIV
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="using-docbook.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="section.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>DocBook: Sample Markup</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="using-docbook.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><TT
CLASS="sgmltag"
>&#60;section&#62;</TT
> and <TT
CLASS="sgmltag"
>&#60;sectN&#62;</TT
>: what's the difference?</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
Reference in New Issue View Git Blame Copy Permalink