diff options
Diffstat (limited to 'doc/html/boostbook/documenting.html')
| -rw-r--r-- | doc/html/boostbook/documenting.html | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/html/boostbook/documenting.html b/doc/html/boostbook/documenting.html index fc9a5a1cab..a1d9635ac3 100644 --- a/doc/html/boostbook/documenting.html +++ b/doc/html/boostbook/documenting.html @@ -4,9 +4,9 @@ <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"> <title>Documenting libraries</title> <link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> -<meta name="generator" content="DocBook XSL Stylesheets V1.76.1"> +<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> <link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> -<link rel="up" href="../boostbook.html" title="Chapter 43. The BoostBook Documentation Format"> +<link rel="up" href="../boostbook.html" title="Chapter 44. The BoostBook Documentation Format"> <link rel="prev" href="getting/started.html" title="Getting Started"> <link rel="next" href="together.html" title="Bringing Together a BoostBook Document"> </head> @@ -26,9 +26,9 @@ <div class="section"> <div class="titlepage"><div><div><h2 class="title" style="clear: both"> <a name="boostbook.documenting"></a>Documenting libraries</h2></div></div></div> -<div class="toc"><dl> +<div class="toc"><dl class="toc"> <dt><span class="section"><a href="documenting.html#boostbook.defining">Defining a BoostBook library</a></span></dt> -<dt><span class="section"><a href="documenting.html#idp513930992">From HTML to BoostBook</a></span></dt> +<dt><span class="section"><a href="documenting.html#idm45927675048256">From HTML to BoostBook</a></span></dt> <dt><span class="section"><a href="documenting.html#boostbook.sectioning">Sectioning in BoostBook</a></span></dt> </dl></div> <p>BoostBook is an extension to <a href="http://www.docbook.org" target="_top">DocBook</a>, an XML format for @@ -44,11 +44,11 @@ a <library> XML element. To create a skeletal library, we need to create a new XML document (call it <code class="computeroutput">any.xml</code>) that contains basic information about the library. The following - <a class="link" href="documenting.html#boostbook.documenting.skeletal" title="Example 43.1. A Skeletal BoostBook Library">BoostBook XML + <a class="link" href="documenting.html#boostbook.documenting.skeletal" title="Example 44.1. A Skeletal BoostBook Library">BoostBook XML example</a> describes basic information about the <a href="http://www.boost.org/libs/any/index.html" target="_top">Boost.Any</a> library:</p> <div class="example"> -<a name="boostbook.documenting.skeletal"></a><p class="title"><b>Example 43.1. A Skeletal BoostBook Library</b></p> +<a name="boostbook.documenting.skeletal"></a><p class="title"><b>Example 44.1. A Skeletal BoostBook Library</b></p> <div class="example-contents"><pre class="programlisting"> <?xml version="1.0" encoding="utf-8"?> <!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML V1.0//EN" @@ -78,7 +78,7 @@ <library> element are:</p> <div class="variablelist"> <p class="title"><b>Attributes for the <library> element</b></p> -<dl> +<dl class="variablelist"> <dt><span class="term"><code class="computeroutput">name</code></span></dt> <dd>The full name of the library, e.g., "Any"</dd> <dt><span class="term"><code class="computeroutput">dirname</code></span></dt> @@ -122,17 +122,17 @@ </div> <div class="section"> <div class="titlepage"><div><div><h3 class="title"> -<a name="idp513930992"></a>From HTML to BoostBook</h3></div></div></div> +<a name="idm45927675048256"></a>From HTML to BoostBook</h3></div></div></div> <p>Most library authors are comfortable with writing HTML documentation. Writing <a href="http://www.docbook.org" target="_top">DocBook</a> documentation (and, by extension, BoostBook documentation) is quite similar to writing HTML, except that BoostBook uses different element names from HTML - (see <a class="xref" href="documenting.html#html.to.boostbook" title="Table 43.2. Converting HTML elements to BoostBook">Table 43.2, “Converting HTML elements to BoostBook”</a>) and BoostBook XML is a + (see <a class="xref" href="documenting.html#html.to.boostbook" title="Table 44.2. Converting HTML elements to BoostBook">Table 44.2, “Converting HTML elements to BoostBook”</a>) and BoostBook XML is a much more rigid format than HTML.</p> <p>One of the easiest ways to convert HTML documentation into BoostBook documentation is to use <a href="http://tidy.sourceforge.net/" target="_top">HTML Tidy</a> to transform your HTML into valid XHTML, which will make sure that all elements - are properly closed, then apply the transformations in <a class="xref" href="documenting.html#html.to.boostbook" title="Table 43.2. Converting HTML elements to BoostBook">Table 43.2, “Converting HTML elements to BoostBook”</a> to the body of the XHTML + are properly closed, then apply the transformations in <a class="xref" href="documenting.html#html.to.boostbook" title="Table 44.2. Converting HTML elements to BoostBook">Table 44.2, “Converting HTML elements to BoostBook”</a> to the body of the XHTML document. The following command uses HTML Tidy to transform HTML into valid XHTML:</p> <pre class="programlisting"> @@ -147,7 +147,7 @@ contents are built automatically from the titles of sections in the BoostBook document.</p> <div class="table"> -<a name="html.to.boostbook"></a><p class="title"><b>Table 43.2. Converting HTML elements to BoostBook</b></p> +<a name="html.to.boostbook"></a><p class="title"><b>Table 44.2. Converting HTML elements to BoostBook</b></p> <div class="table-contents"><table class="table" summary="Converting HTML elements to BoostBook"> <colgroup> <col> |