boostbook.documenting.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172
  1. <html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>Documenting libraries</title><link rel="stylesheet" href="reference.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.61.3"><link rel="home" href="index.html" title="The Boost C++ Libraries"><link rel="up" href="boostbook.html" title="The BoostBook Documentation Format"><link rel="previous" href="boostbook.getting.started.html" title="Getting Started"><link rel="next" href="boostbook.together.html" title="Bringing Together a BoostBook Document"><link rel="chapter" href="libraries.html" title="The Boost C++ Libraries"><link rel="chapter" href="any.html" title="Boost.Any"><link rel="refentry" href="class.boost.bad_any_cast.html" title="Class bad_any_cast"><link rel="refentry" href="class.boost.any.html" title="Class any"><link rel="refentry" href="id2383300-bb.html" title="Function any_cast"><link rel="chapter" href="array.html" title="Boost.Array"><link rel="refentry" href="class.boost.array.html" title="Class template array"><link rel="chapter" href="function.html" title="Boost.Function"><link rel="refentry" href="class.boost.bad_function_call.html" title="Class bad_function_call"><link rel="refentry" href="class.boost.function_base.html" title="Class function_base"><link rel="refentry" href="class.boost.functionN.html" title="Class template functionN"><link rel="refentry" href="class.boost.function.html" title="Class template function"><link rel="chapter" href="ref.html" title="Boost.Ref"><link rel="refentry" href="class.boost.reference_wrapper.html" title="Class template reference_wrapper"><link rel="refentry" href="class.boost.is_reference_wrapper.html" title="Class template is_reference_wrapper"><link rel="refentry" href="class.boost.unwrap_reference.html" title="Class template unwrap_reference"><link rel="chapter" href="signals.html" title="Boost.Signals"><link rel="refentry" href="class.boost.signalN.html" title="Class template signalN"><link rel="refentry" href="class.boost.signal.html" title="Class template signal"><link rel="refentry" href="class.boost.slot.html" title="Class template slot"><link rel="refentry" href="class.boost.signals.trackable.html" title="Class trackable"><link rel="refentry" href="class.boost.signals.connection.html" title="Class connection"><link rel="refentry" href="class.boost.signals.scoped_connection.html" title="Class scoped_connection"><link rel="refentry" href="id2532119-bb.html" title="Function template visit_each"><link rel="refentry" href="class.boost.last_value.html" title="Class template last_value"><link rel="refentry" href="id2354683-bb.html" title="Class last_value&lt;void&gt;"><link rel="chapter" href="variant.html" title="Boost.Variant"><link rel="refentry" href="BOOST_VARIANT_LIMIT_TYPES.html" title="Macro BOOST_VARIANT_LIMIT_TYPES"><link rel="refentry" href="BOOST_VARIANT_ENUM_PARAMS.html" title="Macro BOOST_VARIANT_ENUM_PARAMS"><link rel="refentry" href="BOOST_VARIANT_ENUM_SHIFTED_PARAMS.html" title="Macro BOOST_VARIANT_ENUM_SHIFTED_PARAMS"><link rel="refentry" href="BOOST_VARIANT_NO_REFERENCE_SUPPORT.html" title="Macro BOOST_VARIANT_NO_REFERENCE_SUPPORT"><link rel="refentry" href="BOOST_VARIANT_NO_TYPE_SEQUENCE_SUPPORT.html" title="Macro BOOST_VARIANT_NO_TYPE_SEQUENCE_SUPPORT"><link rel="refentry" href="BOOST_VARIANT_NO_FULL_RECURSIVE_VARIANT_SUPPORT.html" title="Macro BOOST_VARIANT_NO_FULL_RECURSIVE_VARIANT_SUPPORT"><link rel="refentry" href="class.boost.variant.html" title="Class template variant"><link rel="refentry" href="id2518553-bb.html" title="Function template swap"><link rel="refentry" href="id2524211-bb.html" title="Function template operator&lt;&lt;"><link rel="refentry" href="class.boost.make_variant_over.html" title="Class template make_variant_over"><link rel="refentry" href="class.boost.make_recursive_variant.html" title="Class template make_recursive_variant"><link rel="refentry" href="class.boost.make_recursive_variant_over.html" title="Class template make_recursive_variant_over"><link rel="refentry" href="class.boost.recursive_wrapper.html" title="Class template recursive_wrapper"><link rel="refentry" href="class.boost.is_recursive_wrapper.html" title="Class template is_recursive_wrapper"><link rel="refentry" href="class.boost.unwrap_recursive_wrapper.html" title="Class template unwrap_recursive_wrapper"><link rel="refentry" href="class.boost.apply_visitor_delayed_t.html" title="Class template apply_visitor_delayed_t"><link rel="refentry" href="id2557051-bb.html" title="Function apply_visitor"><link rel="refentry" href="class.boost.bad_get.html" title="Class bad_get"><link rel="refentry" href="id2493238-bb.html" title="Function get"><link rel="refentry" href="class.boost.bad_visit.html" title="Class bad_visit"><link rel="refentry" href="class.boost.static_visitor.html" title="Class template static_visitor"><link rel="refentry" href="class.boost.visitor_ptr_t.html" title="Class template visitor_ptr_t"><link rel="refentry" href="id2544445-bb.html" title="Function template visitor_ptr"><link rel="chapter" href="boostbook.html" title="The BoostBook Documentation Format"><link rel="refentry" href="boostbook.dtd.class-specialization.html" title="
  2. BoostBook element class-specialization"><link rel="refentry" href="boostbook.dtd.link-test.html" title="
  3. BoostBook element link-test"><link rel="refentry" href="boostbook.dtd.link-fail-test.html" title="
  4. BoostBook element link-fail-test"><link rel="refentry" href="boostbook.dtd.typedef.html" title="
  5. BoostBook element typedef"><link rel="refentry" href="boostbook.dtd.static-constant.html" title="
  6. BoostBook element static-constant"><link rel="refentry" href="boostbook.dtd.code.html" title="
  7. BoostBook element code"><link rel="refentry" href="boostbook.dtd.destructor.html" title="
  8. BoostBook element destructor"><link rel="refentry" href="boostbook.dtd.template-type-parameter.html" title="
  9. BoostBook element template-type-parameter"><link rel="refentry" href="boostbook.dtd.description.html" title="
  10. BoostBook element description"><link rel="refentry" href="boostbook.dtd.librarylist.html" title="
  11. BoostBook element librarylist"><link rel="refentry" href="boostbook.dtd.library-reference.html" title="
  12. BoostBook element library-reference"><link rel="refentry" href="boostbook.dtd.boostbook.html" title="
  13. BoostBook element boostbook"><link rel="refentry" href="boostbook.dtd.union.html" title="
  14. BoostBook element union"><link rel="refentry" href="boostbook.dtd.inherit.html" title="
  15. BoostBook element inherit"><link rel="refentry" href="boostbook.dtd.template-varargs.html" title="
  16. BoostBook element template-varargs"><link rel="refentry" href="boostbook.dtd.source.html" title="
  17. BoostBook element source"><link rel="refentry" href="boostbook.dtd.function.html" title="
  18. BoostBook element function"><link rel="refentry" href="boostbook.dtd.postconditions.html" title="
  19. BoostBook element postconditions"><link rel="refentry" href="boostbook.dtd.compile-test.html" title="
  20. BoostBook element compile-test"><link rel="refentry" href="boostbook.dtd.method.html" title="
  21. BoostBook element method"><link rel="refentry" href="boostbook.dtd.snippet.html" title="
  22. BoostBook element snippet"><link rel="refentry" href="boostbook.dtd.constructor.html" title="
  23. BoostBook element constructor"><link rel="refentry" href="boostbook.dtd.namespace.html" title="
  24. BoostBook element namespace"><link rel="refentry" href="boostbook.dtd.if-fails.html" title="
  25. BoostBook element if-fails"><link rel="refentry" href="boostbook.dtd.free-function-group.html" title="
  26. BoostBook element free-function-group"><link rel="refentry" href="boostbook.dtd.functionname.html" title="
  27. BoostBook element functionname"><link rel="refentry" href="boostbook.dtd.librarycategory.html" title="
  28. BoostBook element librarycategory"><link rel="refentry" href="boostbook.dtd.notes.html" title="
  29. BoostBook element notes"><link rel="refentry" href="boostbook.dtd.data-member.html" title="
  30. BoostBook element data-member"><link rel="refentry" href="boostbook.dtd.specialization.html" title="
  31. BoostBook element specialization"><link rel="refentry" href="boostbook.dtd.union-specialization.html" title="
  32. BoostBook element union-specialization"><link rel="refentry" href="boostbook.dtd.throws.html" title="
  33. BoostBook element throws"><link rel="refentry" href="boostbook.dtd.template-arg.html" title="
  34. BoostBook element template-arg"><link rel="refentry" href="boostbook.dtd.method-group.html" title="
  35. BoostBook element method-group"><link rel="refentry" href="boostbook.dtd.requirement.html" title="
  36. BoostBook element requirement"><link rel="refentry" href="boostbook.dtd.precondition.html" title="
  37. BoostBook element precondition"><link rel="refentry" href="boostbook.dtd.paramtype.html" title="
  38. BoostBook element paramtype"><link rel="refentry" href="boostbook.dtd.using-class.html" title="
  39. BoostBook element using-class"><link rel="refentry" href="boostbook.dtd.run-test.html" title="
  40. BoostBook element run-test"><link rel="refentry" href="boostbook.dtd.librarypurpose.html" title="
  41. BoostBook element librarypurpose"><link rel="refentry" href="boostbook.dtd.copy-assignment.html" title="
  42. BoostBook element copy-assignment"><link rel="refentry" href="boostbook.dtd.run-fail-test.html" title="
  43. BoostBook element run-fail-test"><link rel="refentry" href="boostbook.dtd.template.html" title="
  44. BoostBook element template"><link rel="refentry" href="boostbook.dtd.compile-fail-test.html" title="
  45. BoostBook element compile-fail-test"><link rel="refentry" href="boostbook.dtd.returns.html" title="
  46. BoostBook element returns"><link rel="refentry" href="boostbook.dtd.default.html" title="
  47. BoostBook element default"><link rel="refentry" href="boostbook.dtd.parameter.html" title="
  48. BoostBook element parameter"><link rel="refentry" href="boostbook.dtd.signature.html" title="
  49. BoostBook element signature"><link rel="refentry" href="boostbook.dtd.overloaded-function.html" title="
  50. BoostBook element overloaded-function"><link rel="refentry" href="boostbook.dtd.class.html" title="
  51. BoostBook element class"><link rel="refentry" href="boostbook.dtd.librarycategorydef.html" title="
  52. BoostBook element librarycategorydef"><link rel="refentry" href="boostbook.dtd.type.html" title="
  53. BoostBook element type"><link rel="refentry" href="boostbook.dtd.enumvalue.html" title="
  54. BoostBook element enumvalue"><link rel="refentry" href="boostbook.dtd.overloaded-method.html" title="
  55. BoostBook element overloaded-method"><link rel="refentry" href="boostbook.dtd.programlisting.html" title="
  56. BoostBook element programlisting"><link rel="refentry" href="boostbook.dtd.complexity.html" title="
  57. BoostBook element complexity"><link rel="refentry" href="boostbook.dtd.purpose.html" title="
  58. BoostBook element purpose"><link rel="refentry" href="boostbook.dtd.template-nontype-parameter.html" title="
  59. BoostBook element template-nontype-parameter"><link rel="refentry" href="boostbook.dtd.library.html" title="
  60. BoostBook element library"><link rel="refentry" href="boostbook.dtd.librarycategorylist.html" title="
  61. BoostBook element librarycategorylist"><link rel="refentry" href="boostbook.dtd.using-namespace.html" title="
  62. BoostBook element using-namespace"><link rel="refentry" href="boostbook.dtd.struct-specialization.html" title="
  63. BoostBook element struct-specialization"><link rel="refentry" href="boostbook.dtd.struct.html" title="
  64. BoostBook element struct"><link rel="refentry" href="boostbook.dtd.lib.html" title="
  65. BoostBook element lib"><link rel="refentry" href="boostbook.dtd.enum.html" title="
  66. BoostBook element enum"><link rel="refentry" href="boostbook.dtd.requires.html" title="
  67. BoostBook element requires"><link rel="refentry" href="boostbook.dtd.effects.html" title="
  68. BoostBook element effects"><link rel="refentry" href="boostbook.dtd.libraryname.html" title="
  69. BoostBook element libraryname"><link rel="refentry" href="boostbook.dtd.libraryinfo.html" title="
  70. BoostBook element libraryinfo"><link rel="refentry" href="boostbook.dtd.testsuite.html" title="
  71. BoostBook element testsuite"><link rel="refentry" href="boostbook.dtd.header.html" title="
  72. BoostBook element header"><link rel="refentry" href="boostbook.dtd.rationale.html" title="
  73. BoostBook element rationale"><link rel="refentry" href="Assignable.html" title="Concept Assignable"><link rel="refentry" href="InputIterator.html" title="Concept InputIterator"><link rel="refentry" href="OutputIterator.html" title="Concept OutputIterator"><link rel="refentry" href="ForwardIterator.html" title="Concept ForwardIterator"><link rel="refentry" href="BidirectionalIterator.html" title="Concept BidirectionalIterator"><link rel="refentry" href="RandomAccessIterator.html" title="Concept RandomAccessIterator"><link rel="refentry" href="DefaultConstructible.html" title="Concept DefaultConstructible"><link rel="refentry" href="CopyConstructible.html" title="Concept CopyConstructible"><link rel="refentry" href="EqualityComparable.html" title="Concept EqualityComparable"><link rel="refentry" href="LessThanComparable.html" title="Concept LessThanComparable"><link rel="refentry" href="SignedInteger.html" title="Concept SignedInteger"><link rel="subsection" href="boostbook.documenting.html#boostbook.defining" title="Defining a BoostBook library"><link rel="subsection" href="boostbook.documenting.html#id2541037" title="From HTML to BoostBook"><link rel="subsection" href="boostbook.documenting.html#boostbook.sectioning" title="Sectioning in BoostBook"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" border="1" cellpadding="2" bgcolor="#007F7F"><tr><td bgcolor="#FFFFFF"><img src="../../c++boost.gif" alt="c++boost.gif (8819 bytes)" width="277" height="86"></td><td><a href="../../index.htm"><font color="#FFFFFF" size="4" face="Arial">Home</font></a></td><td><a href="libraries.html"><font color="#FFFFFF" size="4" face="Arial">Libraries</font></a></td><td><a href="../../people/people.htm"><font color="#FFFFFF" size="4" face="Arial">People</font></a></td><td><a href="../../more/faq.htm"><font color="#FFFFFF" size="4" face="Arial">FAQ</font></a></td><td><a href="../../more/index.htm"><font color="#FFFFFF" size="4" face="Arial">More</font></a></td></tr></table><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="boostbook.documenting"></a>Documenting libraries</h3></div></div><div></div></div><div class="toc"><dl><dt><a href="boostbook.documenting.html#boostbook.defining">Defining a BoostBook library</a></dt><dt><a href="boostbook.documenting.html#id2541037">From HTML to BoostBook</a></dt><dt><a href="boostbook.documenting.html#boostbook.sectioning">Sectioning in BoostBook</a></dt></dl></div><p>BoostBook is an extension to <a href="http://www.docbook.org" target="_top">DocBook</a>, an XML format for
  74. representing documentation. BoostBook inherits much of its
  75. functionality and many elements from DocBook that are not
  76. redocumented here. When writing BoostBook documentation, please
  77. refer also to <a href="http://docbook.org/tdg/en/index.html" target="_top">DocBook: The Definitive
  78. Guide</a>.</p><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="boostbook.defining"></a>Defining a BoostBook library</h4></div></div><div></div></div><p>BoostBook library documentation is contained entirely within
  79. a &lt;library&gt; XML element. To create a skeletal library, we
  80. need to create a new XML document (call it <tt class="computeroutput">any.xml</tt>)
  81. that contains basic information about the library. The following
  82. <a href="boostbook.documenting.html#boostbook.documenting.skeletal" title="Example 1. A Skeletal BoostBook Library">BoostBook XML
  83. example</a> describes basic information about the <a href="http://www.boost.org/libs/any/index.html" target="_top">Boost.Any</a>
  84. library:</p><div class="example"><a name="boostbook.documenting.skeletal"></a><p class="title"><b>Example 1. A Skeletal BoostBook Library</b></p><pre class="programlisting">
  85. &lt;?xml version="1.0" encoding="utf-8"?&gt;
  86. &lt;!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN"
  87. "http://www.boost.org/tools/boostbook/dtd/boostbook.dtd"&gt;
  88. &lt;library name="Any" dirname="any" xmlns:xi="http://www.w3.org/2001/XInclude"
  89. id="any" last-revision="$Date$"&gt;
  90. &lt;libraryinfo&gt;
  91. &lt;author&gt;
  92. &lt;firstname&gt;Kevlin&lt;/firstname&gt;
  93. &lt;surname&gt;Henney&lt;/surname&gt;
  94. &lt;/author&gt;
  95. &lt;librarypurpose&gt;
  96. Safe, generic container for single values of different value types
  97. &lt;/librarypurpose&gt;
  98. &lt;librarycategory name="category:data-structures"/&gt;
  99. &lt;/libraryinfo&gt;
  100. &lt;/library&gt;
  101. </pre></div><p>The first three lines identify this document as a BoostBook
  102. <a href="http://www.w3.org/XML/" target="_top">XML</a> document. The
  103. DOCTYPE line states that the document conforms to the BoostBook
  104. DTD, and that the top-level element is a BoostBook
  105. &lt;library&gt;.</p><p>The &lt;library&gt; element actually describes the aspects
  106. of BoostBook library documentation. The attributes for the
  107. &lt;library&gt; element are:</p><div class="variablelist"><p class="title"><b>Attributes for the &lt;library&gt; element</b></p><dl><dt><span class="term"><tt class="computeroutput">name</tt></span></dt><dd>The full name of the library, e.g., "Any"</dd><dt><span class="term"><tt class="computeroutput">dirname</tt></span></dt><dd>The name of the directory, relative to
  108. <tt class="computeroutput">boost/libs</tt>, in which the library
  109. resides. This name may be a relative path, such as
  110. <tt class="computeroutput">math/octonion</tt>, using "/" for the directory
  111. separator.</dd><dt><span class="term"><tt class="computeroutput">id</tt></span></dt><dd>A short, unique name for the library. For libraries
  112. with simple directory names (e.g., ones that do not contain
  113. a "/"), this should be the same as the
  114. <tt class="computeroutput">dirname</tt>. This <tt class="computeroutput">id</tt> will be used to
  115. identify libraries and, for HTML output, will be used as the
  116. base name for the HTML file in which the library's
  117. documentation resides, so it should use only lowercase
  118. alphanumeric characters and underscores.</dd><dt><span class="term"><tt class="computeroutput">last-revision</tt></span></dt><dd>Always set to <tt class="computeroutput">$Date$</tt>, which is
  119. expanded by CVS to include the date and time that the file
  120. was last modified.</dd></dl></div><p>Inside the &lt;library&gt; element we have the
  121. &lt;libraryinfo&gt; element, which gives information about the
  122. library itself. It contains the author's name (there may be more
  123. than one &lt;author&gt; element), followed by the purpose of the
  124. library and the list of categorizations. The
  125. &lt;librarypurpose&gt; element should always contain a very short
  126. (single sentence) description of the library's purpose, and should
  127. <span class="emphasis"><em>not</em></span> terminate with a period.</p><p>The list of categories is specified by a set of
  128. &lt;librarycategory&gt; elements. Each &lt;librarycategory&gt;
  129. element has a <tt class="computeroutput">name</tt> element that identifies one of the
  130. categories. The actual list of categories is in the file
  131. <tt class="filename">doc/src/boost.xml</tt>.
  132. </p><p>At this point, we can apply the BoostBook XSL stylesheets to
  133. <tt class="computeroutput">any.xml</tt> (to DocBook) followed by a DocBook XSL
  134. stylesheet to generate HTML output, as described in <a href="boostbook.getting.started.html" title="Getting Started">the section called &#8220;Getting Started&#8221;</a>.</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="id2541037"></a>From HTML to BoostBook</h4></div></div><div></div></div><p>Most library authors are comfortable with writing HTML
  135. documentation. Writing <a href="http://www.docbook.org" target="_top">DocBook</a> documentation (and,
  136. by extension, BoostBook documentation) is quite similar to writing
  137. HTML, except that BoostBook uses different element names from HTML
  138. (see <a href="boostbook.documenting.html#html.to.boostbook" title="Table 2. Converting HTML elements to BoostBook">Table 2</a>) and BoostBook XML is a
  139. much more rigid format than HTML.</p><p>One of the easiest ways to convert HTML documentation into
  140. BoostBook documentation is to use <a href="http://tidy.sourceforge.net/" target="_top">HTML Tidy</a> to transform
  141. your HTML into valid XHTML, which will make sure that all elements
  142. are properly closed, then apply the transformations in <a href="boostbook.documenting.html#html.to.boostbook" title="Table 2. Converting HTML elements to BoostBook">Table 2</a> to the body of the XHTML
  143. document. The following command uses HTML Tidy to transform HTML
  144. into valid XHTML:</p><pre class="programlisting">
  145. tidy -asxhtml input.html &gt; output.xhtml</pre><p>When converting documentation from HTML to BoostBook, note
  146. that some redundant information that has to be manually maintained
  147. in HTML is automatically generated in BoostBook: for instance, the
  148. library categorizations, purpose, and author list described in
  149. <a href="boostbook.documenting.html#boostbook.defining" title="Defining a BoostBook library">the section called &#8220;Defining a BoostBook library&#8221;</a> are used both in the
  150. documentation for the library and to build alphabetical and
  151. categorized lists of known libraries; similarly, tables of
  152. contents are built automatically from the titles of sections in
  153. the BoostBook document.</p><div class="table"><a name="html.to.boostbook"></a><p class="title"><b>Table 2. Converting HTML elements to BoostBook</b></p><table summary="Converting HTML elements to BoostBook" border="1"><colgroup><col><col></colgroup><thead><tr><th align="left">HTML</th><th align="left">BoostBook</th></tr></thead><tbody><tr><td align="left"><p>&lt;h1&gt;, &lt;h2&gt;, etc.</p></td><td align="left"><p>&lt;section&gt;, &lt;title&gt;; See <a href="boostbook.documenting.html#boostbook.sectioning" title="Sectioning in BoostBook">the section called &#8220;Sectioning in BoostBook&#8221;</a></p></td></tr><tr><td align="left"><p>&lt;i&gt;, &lt;em&gt;</p></td><td align="left"><p>&lt;emphasis&gt;</p></td></tr><tr><td align="left"><p>&lt;b&gt;</p></td><td align="left"><p>&lt;emphasis role="bold"&gt;</p></td></tr><tr><td align="left"><p>&lt;ol&gt;</p></td><td align="left"><p>&lt;orderedlist&gt;</p></td></tr><tr><td align="left"><p>&lt;ul&gt;</p></td><td align="left"><p>&lt;itemizedlist&gt;</p></td></tr><tr><td align="left"><p>&lt;li&gt;</p></td><td align="left"><p>&lt;listitem&gt;</p></td></tr><tr><td align="left"><p>&lt;pre&gt;</p></td><td align="left"><p>&lt;programlisting&gt;</p></td></tr><tr><td align="left"><p>&lt;code&gt;</p></td><td align="left"><p>&lt;computeroutput&gt;,&lt;code&gt;</p></td></tr><tr><td align="left"><p>&lt;p&gt;</p></td><td align="left"><p>&lt;para&gt;, &lt;simpara&gt;</p></td></tr><tr><td align="left"><p>&lt;a&gt;</p></td><td align="left"><p>&lt;xref&gt;, &lt;link&gt;, &lt;ulink&gt;;, See <a href="boostbook.together.html#boostbook.linking" title="Linking in BoostBook">the section called &#8220;Linking in BoostBook&#8221;</a></p></td></tr><tr><td align="left"><p>&lt;table&gt;, &lt;tr&gt;, &lt;th&gt;, &lt;td&gt;</p></td><td align="left"><p>&lt;table&gt;, &lt;informaltable&gt;, &lt;tgroup&gt;, &lt;thead&gt;, &lt;tfoot&gt;, &lt;tbody&gt;, &lt;row&gt;, &lt;entry&gt;, &lt;entrytbl&gt;; BoostBook tables are equivalent to DocBook tables, for which there is a good <a href="http://opensource.bureau-cornavin.com/crash-course/tables.html" target="_top">tutorial here</a></p></td></tr></tbody></table></div></div><div class="section" lang="en"><div class="titlepage"><div><div><h4 class="title"><a name="boostbook.sectioning"></a>Sectioning in BoostBook</h4></div></div><div></div></div><p>"Sectioning" refers to organization of a document into separate sections, each with a title, some text, and possibly subsections. Each section is described in BoostBook via a &lt;section&gt; element. An introduction section may look like this:</p><pre class="programlisting">
  154. &lt;section id="any.intro"&gt;
  155. &lt;title&gt;Introduction&lt;/title&gt;
  156. &lt;para&gt;Introduction to a library...&lt;/para&gt;
  157. &lt;section&gt;
  158. &lt;title&gt;A Subsection&lt;/title&gt;
  159. &lt;para&gt;Subsection information...&lt;/para&gt;
  160. &lt;/section&gt;
  161. &lt;/section&gt;
  162. </pre><p>The &lt;section&gt; element contains all information that
  163. should logically be grouped within that section. The title of the
  164. section is placed within the &lt;title&gt; element, and any
  165. paragraphs, programs, lists, tables, or subsections can occur
  166. within the section. The <tt class="computeroutput">id</tt> attribute of the
  167. &lt;section&gt; element gives a unique ID to each section, so that
  168. it may later be identified for linking. It is suggested that all
  169. IDs start with the short name of a library followed by a period,
  170. so that IDs do not conflict between libraries.</p></div></div><table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr><td align="left"><small>Last revised: March 19, 2003 at 20:23:15 GMT</small></td><td align="right"><small>Copyright © 2003 Douglas Gregor</small></td></tr></table><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="boostbook.getting.started.html"><img src="images/prev.png" alt="Prev"></a> </td><td width="20%" align="center"><a accesskey="u" href="boostbook.html"><img src="images/up.png" alt="Up"></a></td><td width="40%" align="right"> <a accesskey="n" href="boostbook.together.html"><img src="images/next.png" alt="Next"></a></td></tr><tr><td width="40%" align="left" valign="top">Getting Started </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a></td><td width="40%" align="right" valign="top"> Bringing Together a BoostBook Document</td></tr></table></div></body></html>
粤ICP备19079148号