summaryrefslogtreecommitdiff
path: root/doc/html/boostbook/sectioning.html
diff options
context:
space:
mode:
Diffstat (limited to 'doc/html/boostbook/sectioning.html')
-rw-r--r--doc/html/boostbook/sectioning.html60
1 files changed, 60 insertions, 0 deletions
diff --git a/doc/html/boostbook/sectioning.html b/doc/html/boostbook/sectioning.html
new file mode 100644
index 0000000000..a597cf9baa
--- /dev/null
+++ b/doc/html/boostbook/sectioning.html
@@ -0,0 +1,60 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Sectioning in BoostBook</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
+<link rel="start" href="../index.html" title="The Boost C++ Libraries">
+<link rel="up" href="documenting.html" title="Chapter 18. Documenting libraries">
+<link rel="prev" href="documenting/s02.html" title="From HTML to BoostBook">
+<link rel="next" href="together.html" title="Chapter 19. Bringing Together a BoostBook Document">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td>
+<td align="center"><a href="../../../index.htm">Home</a></td>
+<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
+<td align="center"><a href="../../../people/people.htm">People</a></td>
+<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
+<td align="center"><a href="../../../more/index.htm">More</a></td>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="documenting/s02.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="documenting.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="together.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="boostbook.sectioning"></a>Sectioning in BoostBook</h2></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">
+&lt;section id="any.intro"&gt;
+ &lt;title&gt;Introduction&lt;/title&gt;
+
+ &lt;para&gt;Introduction to a library...&lt;/para&gt;
+
+ &lt;section&gt;
+ &lt;title&gt;A Subsection&lt;/title&gt;
+ &lt;para&gt;Subsection information...&lt;/para&gt;
+ &lt;/section&gt;
+&lt;/section&gt;
+</pre>
+<p>The &lt;section&gt; element contains all information that
+ should logically be grouped within that section. The title of the
+ section is placed within the &lt;title&gt; element, and any
+ paragraphs, programs, lists, tables, or subsections can occur
+ within the section. The <code class="computeroutput">id</code> attribute of the
+ &lt;section&gt; element gives a unique ID to each section, so that
+ it may later be identified for linking. It is suggested that all
+ IDs start with the short name of a library followed by a period,
+ so that IDs do not conflict between libraries.</p>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="documenting/s02.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="documenting.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="together.html"><img src="../images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>