| 1 | <html> |
|---|
| 2 | <head> |
|---|
| 3 | <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"> |
|---|
| 4 | <title>Sectioning in BoostBook</title> |
|---|
| 5 | <link rel="stylesheet" href="../boostbook.css" type="text/css"> |
|---|
| 6 | <meta name="generator" content="DocBook XSL Stylesheets V1.69.1"> |
|---|
| 7 | <link rel="start" href="../index.html" title="The Boost C++ Libraries"> |
|---|
| 8 | <link rel="up" href="documenting.html" title="Chapter 18. Documenting libraries"> |
|---|
| 9 | <link rel="prev" href="documenting/s02.html" title="From HTML to BoostBook"> |
|---|
| 10 | <link rel="next" href="together.html" title="Chapter 19. Bringing Together a BoostBook Document"> |
|---|
| 11 | </head> |
|---|
| 12 | <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
|---|
| 13 | <table cellpadding="2" width="100%"> |
|---|
| 14 | <td valign="top"><img alt="boost.png (6897 bytes)" width="277" height="86" src="../../../boost.png"></td> |
|---|
| 15 | <td align="center"><a href="../../../index.htm">Home</a></td> |
|---|
| 16 | <td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> |
|---|
| 17 | <td align="center"><a href="../../../people/people.htm">People</a></td> |
|---|
| 18 | <td align="center"><a href="../../../more/faq.htm">FAQ</a></td> |
|---|
| 19 | <td align="center"><a href="../../../more/index.htm">More</a></td> |
|---|
| 20 | </table> |
|---|
| 21 | <hr> |
|---|
| 22 | <div class="spirit-nav"> |
|---|
| 23 | <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> |
|---|
| 24 | </div> |
|---|
| 25 | <div class="section" lang="en"> |
|---|
| 26 | <div class="titlepage"><div><div><h2 class="title" style="clear: both"> |
|---|
| 27 | <a name="boostbook.sectioning"></a>Sectioning in BoostBook</h2></div></div></div> |
|---|
| 28 | <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 <section> element. An introduction section may look like this:</p> |
|---|
| 29 | <pre class="programlisting"> |
|---|
| 30 | <section id="any.intro"> |
|---|
| 31 | <title>Introduction</title> |
|---|
| 32 | |
|---|
| 33 | <para>Introduction to a library...</para> |
|---|
| 34 | |
|---|
| 35 | <section> |
|---|
| 36 | <title>A Subsection</title> |
|---|
| 37 | <para>Subsection information...</para> |
|---|
| 38 | </section> |
|---|
| 39 | </section> |
|---|
| 40 | </pre> |
|---|
| 41 | <p>The <section> element contains all information that |
|---|
| 42 | should logically be grouped within that section. The title of the |
|---|
| 43 | section is placed within the <title> element, and any |
|---|
| 44 | paragraphs, programs, lists, tables, or subsections can occur |
|---|
| 45 | within the section. The <code class="computeroutput">id</code> attribute of the |
|---|
| 46 | <section> element gives a unique ID to each section, so that |
|---|
| 47 | it may later be identified for linking. It is suggested that all |
|---|
| 48 | IDs start with the short name of a library followed by a period, |
|---|
| 49 | so that IDs do not conflict between libraries.</p> |
|---|
| 50 | </div> |
|---|
| 51 | <table width="100%"><tr> |
|---|
| 52 | <td align="left"></td> |
|---|
| 53 | <td align="right"><small>Copyright © 2003-2005 Douglas Gregor</small></td> |
|---|
| 54 | </tr></table> |
|---|
| 55 | <hr> |
|---|
| 56 | <div class="spirit-nav"> |
|---|
| 57 | <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> |
|---|
| 58 | </div> |
|---|
| 59 | </body> |
|---|
| 60 | </html> |
|---|
