File: book.html

package info (click to toggle)
xae 1.0beta6-5
links: PTS
area: main
in suites: sarge
size: 28,184 kB
ctags: 12,210
sloc: java: 27,149; xml: 20,864; lisp: 12,921; perl: 1,054; sh: 237; makefile: 169
file content (797 lines) | stat: -rw-r--r-- 11,156 bytes
parent folder | download | duplicates (2)
<HTML
><HEAD
><TITLE
>Book</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.45"><LINK
REL="HOME"
TITLE="DocBook"
HREF="docbook.html"><LINK
REL="UP"
TITLE="DocBook Element Reference"
HREF="refelem.html"><LINK
REL="PREVIOUS"
TITLE="BlockQuote"
HREF="blockquote.html"><LINK
REL="NEXT"
TITLE="BookBiblio"
HREF="bookbiblio.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="dbtdg.css"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>DocBook: The Definitive Guide</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="blockquote.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="bookbiblio.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
>Book</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN19171"
></A
><H2
>Name</H2
>Book&nbsp;--&nbsp;A book</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN19174"
></A
><H2
>Synopsis</H2
><H3
><SPAN
CLASS="EMPHASIS"
>Content Model</SPAN
></H3
><PRE
CLASS="SYNOPSIS"
>Book ::=
((<A
HREF="title.html"
>Title</A
>,<A
HREF="subtitle.html"
>Subtitle</A
>?,<A
HREF="titleabbrev.html"
>TitleAbbrev</A
>?)?,
 <A
HREF="bookinfo.html"
>BookInfo</A
>?,
 (<A
HREF="dedication.html"
>Dedication</A
>|<A
HREF="toc.html"
>ToC</A
>|<A
HREF="lot.html"
>LoT</A
>|<A
HREF="glossary.html"
>Glossary</A
>|<A
HREF="bibliography.html"
>Bibliography</A
>|<A
HREF="preface.html"
>Preface</A
>|<A
HREF="chapter.html"
>Chapter</A
>|
  <A
HREF="reference.html"
>Reference</A
>|<A
HREF="part.html"
>Part</A
>|<A
HREF="article.html"
>Article</A
>|<A
HREF="appendix.html"
>Appendix</A
>|<A
HREF="index.html"
>Index</A
>|<A
HREF="setindex.html"
>SetIndex</A
>|<A
HREF="colophon.html"
>Colophon</A
>)*)</PRE
><H3
><SPAN
CLASS="EMPHASIS"
>Attributes</SPAN
></H3
><P
><A
HREF="refelem.html#DBRE.X.COMMON"
>Common attributes</A
></P
><TABLE
BORDER="1"
WIDTH="100%"
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
><P
><B
CLASS="EMPHASIS"
>Name</B
></P
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
><P
><B
CLASS="EMPHASIS"
>Type</B
></P
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
><P
><B
CLASS="EMPHASIS"
>Default</B
></P
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
>Label</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
>CDATA</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
><I
CLASS="EMPHASIS"
>None</I
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
>Status</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
>CDATA</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
><I
CLASS="EMPHASIS"
>None</I
></TD
></TR
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
>FPI</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
>CDATA</TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
><I
CLASS="EMPHASIS"
>None</I
></TD
></TR
></TABLE
><H3
><SPAN
CLASS="EMPHASIS"
>Tag Minimization</SPAN
></H3
><P
>The start-tag is required for this element.  The end-tag is optional, if your SGML declaration allows minimization.</P
><H3
><SPAN
CLASS="EMPHASIS"
>Parameter Entities</SPAN
></H3
><TABLE
BORDER="0"
WIDTH="100%"
><TR
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
><A
HREF="pe-class.html#PENT.BOOK.CLASS"
><TT
CLASS="SGMLTAG"
><NOBR
>%book.class;</NOBR
></TT
></A
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
WIDTH="33%"
></TD
></TR
></TABLE
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN19250"
></A
><H2
>Description</H2
><P
>A complete book. This is probably the most common document starting 
point in DocBook documents.  The content model of <A
HREF="book.html"
><TT
CLASS="SGMLTAG"
>Book</TT
></A
> was
made dramatically less restrictive in DocBook <SPAN
CLASS="ACRONYM"
>V3.1</SPAN
>.</P
><DIV
CLASS="REFSECT2"
><A
NAME="AEN19255"
></A
><H3
>Processing expectations</H3
><P
>Formatted as a displayed block. Generally causes a forced page break, restarts
page numbering, and may generate additional front and back
matter (tables of contents and indexes, for example) automatically.
In a <A
HREF="set.html"
><TT
CLASS="SGMLTAG"
>Set</TT
></A
>, <A
HREF="book.html"
><TT
CLASS="SGMLTAG"
>Book</TT
></A
> almost always begins on the
next available recto page.</P
><P
>The input order of major components is taken to be the desired output 
order.</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN19261"
></A
><H3
>Parents</H3
><P
>These elements contain Book:
<A
HREF="set.html"
><TT
CLASS="SGMLTAG"
>Set</TT
></A
>.</P
></DIV
><DIV
CLASS="REFSECT2"
><A
NAME="AEN19268"
></A
><H3
>Children</H3
><P
>The following elements occur in Book:
<A
HREF="appendix.html"
><TT
CLASS="SGMLTAG"
>Appendix</TT
></A
>, <A
HREF="article.html"
><TT
CLASS="SGMLTAG"
>Article</TT
></A
>, <A
HREF="bibliography.html"
><TT
CLASS="SGMLTAG"
>Bibliography</TT
></A
>, <A
HREF="bookinfo.html"
><TT
CLASS="SGMLTAG"
>BookInfo</TT
></A
>, <A
HREF="chapter.html"
><TT
CLASS="SGMLTAG"
>Chapter</TT
></A
>, <A
HREF="colophon.html"
><TT
CLASS="SGMLTAG"
>Colophon</TT
></A
>, <A
HREF="dedication.html"
><TT
CLASS="SGMLTAG"
>Dedication</TT
></A
>, <A
HREF="glossary.html"
><TT
CLASS="SGMLTAG"
>Glossary</TT
></A
>, <A
HREF="index.html"
><TT
CLASS="SGMLTAG"
>Index</TT
></A
>, <A
HREF="lot.html"
><TT
CLASS="SGMLTAG"
>LoT</TT
></A
>, <A
HREF="part.html"
><TT
CLASS="SGMLTAG"
>Part</TT
></A
>, <A
HREF="preface.html"
><TT
CLASS="SGMLTAG"
>Preface</TT
></A
>, <A
HREF="reference.html"
><TT
CLASS="SGMLTAG"
>Reference</TT
></A
>, <A
HREF="setindex.html"
><TT
CLASS="SGMLTAG"
>SetIndex</TT
></A
>, <A
HREF="subtitle.html"
><TT
CLASS="SGMLTAG"
>Subtitle</TT
></A
>, <A
HREF="title.html"
><TT
CLASS="SGMLTAG"
>Title</TT
></A
>, <A
HREF="titleabbrev.html"
><TT
CLASS="SGMLTAG"
>TitleAbbrev</TT
></A
>, <A
HREF="toc.html"
><TT
CLASS="SGMLTAG"
>ToC</TT
></A
>.</P
><P
>In some contexts, the following elements are
allowed anywhere:
<A
HREF="beginpage.html"
><TT
CLASS="SGMLTAG"
>BeginPage</TT
></A
>, <A
HREF="indexterm.html"
><TT
CLASS="SGMLTAG"
>IndexTerm</TT
></A
>.</P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN19334"
></A
><H2
>Attributes</H2
><P
></P
><DL
><DT
><B
>FPI</B
></DT
><DD
><P
><SPAN
CLASS="SGMLTAG"
>FPI</SPAN
> holds the Formal Public Identifier for 
the <A
HREF="book.html"
><TT
CLASS="SGMLTAG"
>Book</TT
></A
>.</P
></DD
><DT
><B
>Label</B
></DT
><DD
><P
><SPAN
CLASS="SGMLTAG"
>Label</SPAN
> specifies an identifying string for presentation purposes. The third <A
HREF="book.html"
><TT
CLASS="SGMLTAG"
>Book</TT
></A
> in a 
<A
HREF="set.html"
><TT
CLASS="SGMLTAG"
>Set</TT
></A
> might be labeled "Volume III", for example.</P
><P
>Generally, an explicit <SPAN
CLASS="SGMLTAG"
>Label</SPAN
> attribute is
used only if the processing system is incapable of generating the label
automatically. If present, the <SPAN
CLASS="SGMLTAG"
>Label</SPAN
> 
is normative; it will used even
if the processing system is capable of automatic labelling.</P
></DD
><DT
><B
>Status</B
></DT
><DD
><P
><SPAN
CLASS="SGMLTAG"
>Status</SPAN
> identifies the editorial or publication 
status of the <A
HREF="book.html"
><TT
CLASS="SGMLTAG"
>Book</TT
></A
>.</P
><P
>Publication status might be used to control formatting (for example, 
printing a <SPAN
CLASS="QUOTE"
>"draft"</SPAN
> watermark on drafts) or processing (perhaps
a document with a status of <SPAN
CLASS="QUOTE"
>"final"</SPAN
> should not include any
components that are not final).</P
></DD
></DL
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN19362"
></A
><H2
>See Also</H2
><P
><A
HREF="appendix.html"
><TT
CLASS="SGMLTAG"
>Appendix</TT
></A
>, <A
HREF="article.html"
><TT
CLASS="SGMLTAG"
>Article</TT
></A
>, <A
HREF="chapter.html"
><TT
CLASS="SGMLTAG"
>Chapter</TT
></A
>, <A
HREF="colophon.html"
><TT
CLASS="SGMLTAG"
>Colophon</TT
></A
>, <A
HREF="dedication.html"
><TT
CLASS="SGMLTAG"
>Dedication</TT
></A
>, <A
HREF="part.html"
><TT
CLASS="SGMLTAG"
>Part</TT
></A
>, <A
HREF="partintro.html"
><TT
CLASS="SGMLTAG"
>PartIntro</TT
></A
>, <A
HREF="preface.html"
><TT
CLASS="SGMLTAG"
>Preface</TT
></A
>, <A
HREF="set.html"
><TT
CLASS="SGMLTAG"
>Set</TT
></A
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN19393"
></A
><H2
>Examples</H2
><DIV
CLASS="example-source"
><PRE
CLASS="PROGRAMLISTING"
>&#60;!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN"&#62;
&#60;book&#62;
&#60;title&#62;An Example Book&#60;/title&#62;
&#60;titleabbrev&#62;Example&#60;/titleabbrev&#62;
&#60;bookinfo&#62;
  &#60;legalnotice&#62;&#60;para&#62;No notice is required.&#60;/para&#62;&#60;/legalnotice&#62;
  &#60;author&#62;&#60;firstname&#62;Norman&#60;/&#62;&#60;surname&#62;Walsh&#60;/&#62;&#60;/author&#62;
&#60;/bookinfo&#62;
&#60;dedication&#62;
&#60;para&#62;
This book is dedicated to you.
&#60;/para&#62;
&#60;/dedication&#62;
&#60;preface&#62;&#60;title&#62;Forword&#60;/title&#62;
&#60;para&#62;
Some content is always required.
&#60;/para&#62;
&#60;/preface&#62;
&#60;chapter&#62;&#60;title&#62;Required Chapter&#60;/title&#62;
&#60;para&#62;
At least one chapter, reference, part, or article is required in a book.
&#60;/para&#62;
&#60;/chapter&#62;
&#60;appendix&#62;&#60;title&#62;Optional Appendix&#60;/title&#62;
&#60;para&#62;
Appendixes are optional.
&#60;/para&#62;
&#60;/appendix&#62;
&#60;/book&#62;</PRE
></DIV
><P
>For additional examples, see also <A
HREF="appendix.html"
><TT
CLASS="SGMLTAG"
>Appendix</TT
></A
>,
<A
HREF="collab.html"
><TT
CLASS="SGMLTAG"
>Collab</TT
></A
>,
<A
HREF="set.html"
><TT
CLASS="SGMLTAG"
>Set</TT
></A
>,
<A
HREF="xref.html"
><TT
CLASS="SGMLTAG"
>XRef</TT
></A
>.</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="blockquote.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="docbook.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="bookbiblio.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>BlockQuote</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="refelem.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>BookBiblio</TD
></TR
></TABLE
></DIV
><P
><A
HREF="ln41.html"
>Copyright</A
> &copy; 1999 O'Reilly &amp; Associates, Inc. All rights reserved.</P
></BODY
></HTML
>