Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r63411 - in sandbox/tools/auto_index: . build doc doc/html doc/html/autoindex example/integer example/integer/doc example/integer/doc/html example/integer/doc/html/boost_integer example/math/doc/sf_and_dist src
From: john_at_[hidden]
Date: 2010-06-28 14:00:23

Next message: bdawes_at_[hidden]: "[Boost-commit] svn:boost r63412 - in trunk/libs/filesystem: v2/test v3/test"
Previous message: marshall_at_[hidden]: "[Boost-commit] svn:boost r63410 - in branches/release: boost libs/array/doc libs/array/test"

Author: johnmaddock
Date: 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
New Revision: 63411
URL: http://svn.boost.org/trac/boost/changeset/63411

Log:
Add a couple of new features plus the integer docs as another example.
Added:
   sandbox/tools/auto_index/example/integer/
   sandbox/tools/auto_index/example/integer/doc/
      - copied from r63126, /trunk/libs/integer/doc/
   sandbox/tools/auto_index/example/integer/doc/index.idx (contents, props changed)
   sandbox/tools/auto_index/example/integer/doc/integer.pdf (contents, props changed)
Binary files modified:
   sandbox/tools/auto_index/example/math/doc/sf_and_dist/math.pdf
Text files modified:
   sandbox/tools/auto_index/auto-index.jam | 2
   sandbox/tools/auto_index/build/Jamfile.v2 | 4
   sandbox/tools/auto_index/doc/auto_index.qbk | 101 ++++++++++--
   sandbox/tools/auto_index/doc/html/autoindex/comm_ref.html | 56 +++---
   sandbox/tools/auto_index/doc/html/autoindex/overview.html | 13 +
   sandbox/tools/auto_index/doc/html/autoindex/script_ref.html | 312 ++++++++++++++++++++++++++++++---------
   sandbox/tools/auto_index/doc/html/autoindex/tut.html | 129 +++++++++-------
   sandbox/tools/auto_index/doc/html/index.html | 8
   sandbox/tools/auto_index/example/integer/doc/Jamfile.v2 | 19 ++
   sandbox/tools/auto_index/example/integer/doc/html/boost_integer/cstdint.html | 105 ++++++++-----
   sandbox/tools/auto_index/example/integer/doc/html/boost_integer/history.html | 82 ++++-----
   sandbox/tools/auto_index/example/integer/doc/html/boost_integer/integer.html | 55 +++---
   sandbox/tools/auto_index/example/integer/doc/html/boost_integer/log2.html | 45 ++---
   sandbox/tools/auto_index/example/integer/doc/html/boost_integer/mask.html | 35 +--
   sandbox/tools/auto_index/example/integer/doc/html/boost_integer/minmax.html | 29 +--
   sandbox/tools/auto_index/example/integer/doc/html/boost_integer/traits.html | 27 +--
   sandbox/tools/auto_index/example/integer/doc/html/index.html | 29 +--
   sandbox/tools/auto_index/example/integer/doc/integer.qbk | 12 +
   sandbox/tools/auto_index/example/math/doc/sf_and_dist/Jamfile.v2 | 2
   sandbox/tools/auto_index/src/auto_index.cpp | 7
   sandbox/tools/auto_index/src/file_scanning.cpp | 99 ++++++++++++
   21 files changed, 769 insertions(+), 402 deletions(-)

Modified: sandbox/tools/auto_index/auto-index.jam
==============================================================================
--- sandbox/tools/auto_index/auto-index.jam (original)
+++ sandbox/tools/auto_index/auto-index.jam 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -14,6 +14,7 @@
feature.feature auto-index-script : : free ;
feature.feature auto-index-prefix : : free ;
feature.feature auto-index-type : : free ;
+feature.feature auto-index-section-names : "on" off ;

toolset.flags auto-index.auto-index FLAGS <auto-index-internal>on : --internal-index ;
toolset.flags auto-index.auto-index SCRIPT <auto-index-script> ;
@@ -21,6 +22,7 @@
toolset.flags auto-index.auto-index INDEX_TYPE <auto-index-type> ;
toolset.flags auto-index.auto-index FLAGS <auto-index-verbose>on : --verbose ;
toolset.flags auto-index.auto-index FLAGS <auto-index-no-duplicates>on : --no-duplicates ;
+toolset.flags auto-index.auto-index FLAGS <auto-index-section-names>off : --no-section-names ;

# <auto-index-binary> shell command to run AutoIndex
# <auto-index-binary-dependencies> targets to build AutoIndex from sources.

Modified: sandbox/tools/auto_index/build/Jamfile.v2
==============================================================================
--- sandbox/tools/auto_index/build/Jamfile.v2 (original)
+++ sandbox/tools/auto_index/build/Jamfile.v2 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -13,7 +13,9 @@
$(boost)/libs/system/build//boost_system
: <define>BOOST_ALL_NO_LIB=1 <link>static ;

-install bin : auto_index ;
+install aii : auto_index : <location>. ;
+install ai2 : ../auto-index.jam : <location>$(boost)/tools/build/v2/tools ;
+

Modified: sandbox/tools/auto_index/doc/auto_index.qbk
==============================================================================
--- sandbox/tools/auto_index/doc/auto_index.qbk (original)
+++ sandbox/tools/auto_index/doc/auto_index.qbk 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -31,7 +31,9 @@
a subterm, the other has the section title as the main index entry and the
search term as the subentry. Thus the user has two chances to find what their
looking for, based upon either the section name or the ['function], ['class], ['macro]
-or ['typedef] name.
+or ['typedef] name. Note that this behaviour can be changed so that only one
+index entry is created - using the search term as the key - and not using the
+section name except as a sub-entry of the search term.

So for example in Boost.Math the class name `students_t_distribution` has a primary
entry that lists all sections it appears in:
@@ -115,8 +117,8 @@

Also note that Windows users must use forward slashes in the paths in user-config.jam]

-Finally copy `tools/auto_index/auto-index.jam` into the same directory as the rest of the Boost.Build tools
-(under `tools/build/v2/tools` in your main Boost tree): this is a temporary requirement that will go away
+Finally note that `tools/auto_index/auto-index.jam` gets copied into the same directory as the rest of the Boost.Build tools
+(under `tools/build/v2/tools` in your main Boost tree): this is a temporary fix that will go away
if the tool is accepted into Boost.

[h4 Step 2: Configure Boost.Build]
@@ -170,6 +172,10 @@
[[<auto-index-no-duplicates>off/on][When "on" AutoIndex will only index a term
once in any given section, otherwise (the default) multiple index entries per
term may be created if the term occurs more than once in the section.]]
+[[<auto-index-section-names>off/on][When "on" AutoIndex will use create two
+index entries for each term found - one uses the term itself as the primary
+index key, the other uses the enclosing section name. When off the index
+entry that uses the section title is not created. Defaults to "on"]]
[[<auto-index-verbose>off/on][Defaults to "off". When turned on AutoIndex
prints progress information - generally useful only for debugging purposes.]]
[[<auto-index-prefix>filename][Specifies a directory to apply as a prefix to all relative file paths in the script file.]]
@@ -193,23 +199,28 @@

[pre
<index type\="class_name">
-<title>Class Index</title>
-</index>
+<title>Class Index<\/title>
+<\/index>

<index type\="typedef_name">
-<title>Typedef Index</title>
-</index>
+<title>Typedef Index<\/title>
+<\/index>

<index type\="function_name">
-<title>Function Index</title>
-</index>
+<title>Function Index<\/title>
+<\/index>

<index type\="macro_name">
-<title>Macro Index</title>
-</index>
+<title>Macro Index<\/title>
+<\/index>

-<index/>
+<index\/>
]
+
+[note Multiple indexes like this only work correctly if you tell the XSL stylesheets
+to honor the "type" attribute on each index as by default [/[*they do not do this]].
+You can turn the feature on by adding `<xsl:param>index.on.type=1` to your projects
+requirements in the Jamfile.]

In quickbook, you add the same markup but enclose it in an escape:

@@ -226,7 +237,7 @@
You can also place the index inside an `<index>` block if you prefer, in which case the index
does not appear in on a page of it's own, but after the TOC in the HTML output.

-You control the type of XML block used by setting the `<auto-index-type>element-name`
+You control the type of XML block used by setting the =<auto-index-type>element-name=
attribute in the Jamfile, or via the `index-type=element-name` command line option to
auto-index itself. For example, to place the index in an appendix your Jamfile might
look like:
@@ -250,6 +261,8 @@
         <auto-index-script>index.idx
         # Set the XML wrapper for HML Indexes to "appendix":
         <format>html:<auto-index-type>appendix
+ # Turn on multiple index support:
+ <xsl:param>index.on.type=1
]

[h4 Step 4: Create the script file]
@@ -363,6 +376,10 @@

The following elements can occur in a script:

+[h4 Comments and blank lines]
+
+Blank lines consisting of only whitespace are ignored, so are lines that start with a '#'.
+
[h4 Simple Inclusions]

    term [regular-expression1 [regular-expression2 [category]]]
@@ -396,7 +413,9 @@
    `myclass "" "(?!mylib.introduction.*).*"`

will index occurances of "myclass" in any section, except those whose
-ID's begin "mylib.introduction".]]
+ID's begin "mylib.introduction".
+
+If this field is omitted or is "", then all sections are indexed for this term.]]

[[category][Optionally an index category to place occurances of
['term] in. If you have multiple indexes then this is the name
@@ -416,19 +435,28 @@
on how they were seen in the source file. These may then be included
in a specialised index whose "type" attribute has the same category name.

+[important
+When actually indexing a document, the scanner will not index just any old occurance of the
+terms found in the source files. Instead it searches for class definitions or function or
+typedef declarations. This reduces the number of spurious matches placed in the index, but
+may also miss some legitimate terms: refer to the /set-regex/ command for information on how to
+change this.
+]
+
[h4 Directory and Source File Scanning]

    !scan-path directory-name file-name-regex [recurse]

[variablelist
[[directory-name][The directory to scan: this should be a path relative
-to the script file and should use all forward slashes in it's file name.]]
+to the script file (or to the path specified with the prefix=path option on the command line)
+and should use all forward slashes in it's file name.]]

[[file-name-regex][A regular expression: any file in the directory whose name
matches the regular expression will be scanned for terms to index.]]

[[recurse][An optional boolian value - either "true" or "false" - that
-indicates whether to recurse into subdirectories.]]
+indicates whether to recurse into subdirectories. This defaults to "false"]]
]

[h4 Excluding Terms]
@@ -437,11 +465,12 @@

Excludes all the terms in whitespace separated ['term-list] from being indexed.
This should be placed /after/ any ['!scan] or ['!scan-path] rules which may
-result in the terms becoming included.
+result in the terms becoming included. In other words this removes terms from
+the scanners internal list of things to index.

[h4 Rewriting Section Names]

- !rewrite-id regular-expression new-name
+[pre !rewrite-id regular-expression new-name]

[variablelist
[[regular-expression][A regular expression: all section ID's that match
@@ -461,6 +490,41 @@
[[format-text][The Perl-style format string used to reformat the title.]]
]

+[h4 Changing the regular expressions used when scanning]
+
+ !set-regex type prefix suffix
+
+When a class, function, typedef or macro name is found as a result of scanning a source file
+the scanner constructs a regular expression from that name that is used to actually perform
+the search of the text for occurances of the name. This regular expression is constructed by
+joining together 3 parts - a prefix, the name of the class, function, typedef or macro, and a
+suffix. By default the regular expressions constructed in this way are designed to narrow
+the number of occurences of the term found - so for example given a class "myclass" only a
+synopsis of that class that looks like:
+
+ class myclass
+ {
+ // details...
+ };
+
+will be found by the scanner and indexed. The default regular expression prefix and suffix terms are:
+
+[table
+[[Type][Prefix][Suffix]]
+[[class]["class[^;{]+\\<"]["\\>[^;{]+\\{"]]
+[[function]["\\<\\w+\\>\\s+\\<"]["\\>\\s\*\$\[^;{\]\*\$\\s\*\[;{\]"]]
+[[typedef]["typedef\[^;\]+\\<"]["\\>\\s\*;"]]
+[[macro]["\\<"]["\\>"]]
+]
+
+The arguments to the set-regex rule as follows:
+
+[variablelist
+[[type][One of "class", "function", "typedef" or "macro".]]
+[[prefix][The prefix regular expression, or "" to reset to the default.]]
+[[suffix][The suffix regular expression, or "" to reset to the default.]]
+]
+
[endsect]

[section:comm_ref Command Line Reference]
@@ -478,6 +542,7 @@
[[--internal-index][Specifies that auto_index should generate the actual
indexes rather than inserting `<indexterm>`'s and leaving index generation
to the XSL stylesheets.]]
+[[--no-section-names][Prevents auto_index from using section names as index entries.]]
[[prefix=pathname][Specifies a directory to apply as a prefix to all relative file paths in the script file.]]
[[index-type=element-name][Specifies the name of the XML element to enclose internally generated indexes in:
         defaults to "section", but could equally be "appendix" or "chapter" or some other block level element that has a formal title.]]

Modified: sandbox/tools/auto_index/doc/html/autoindex/comm_ref.html
==============================================================================
--- sandbox/tools/auto_index/doc/html/autoindex/comm_ref.html (original)
+++ sandbox/tools/auto_index/doc/html/autoindex/comm_ref.html 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -12,7 +12,7 @@
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="script_ref.html"><img src="../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/html/images/home.png" alt="Home"></a>
+<a accesskey="p" href="script_ref.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a>
</div>
<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -26,44 +26,48 @@
<dl>
<dt><span class="term">in=infilename</span></dt>
<dd><p>
- Specifies the name of the XML input file to be indexed.
- </p></dd>
+ Specifies the name of the XML input file to be indexed.
+ </p></dd>
<dt><span class="term">out=outfilename</span></dt>
<dd><p>
- Specifies the name of the new XML file to create.
- </p></dd>
+ Specifies the name of the new XML file to create.
+ </p></dd>
<dt><span class="term">scan=source-filename</span></dt>
<dd><p>
- Specifies that <span class="emphasis"><em>source-filename</em></span> should be scanned for
- terms to index.
- </p></dd>
+ Specifies that <span class="emphasis"><em>source-filename</em></span> should be scanned
+ for terms to index.
+ </p></dd>
<dt><span class="term">script=script-filename</span></dt>
<dd><p>
- Specifies the name of the script file to process.
- </p></dd>
+ Specifies the name of the script file to process.
+ </p></dd>
<dt><span class="term">--no-duplicates</span></dt>
<dd><p>
- If a term occurs more than once in the same section, then include only
- one index entry.
- </p></dd>
+ If a term occurs more than once in the same section, then include only
+ one index entry.
+ </p></dd>
<dt><span class="term">--internal-index</span></dt>
<dd><p>
- Specifies that auto_index should generate the actual indexes rather than
- inserting <code class="computeroutput"><span class="special"><</span><span class="identifier">indexterm</span><span class="special">></span></code>'s and leaving index generation to the
- XSL stylesheets.
- </p></dd>
+ Specifies that auto_index should generate the actual indexes rather than
+ inserting <code class="computeroutput"><span class="special"><</span><span class="identifier">indexterm</span><span class="special">></span></code>'s and leaving index generation to
+ the XSL stylesheets.
+ </p></dd>
+<dt><span class="term">--no-section-names</span></dt>
+<dd><p>
+ Prevents auto_index from using section names as index entries.
+ </p></dd>
<dt><span class="term">prefix=pathname</span></dt>
<dd><p>
- Specifies a directory to apply as a prefix to all relative file paths in
- the script file.
- </p></dd>
+ Specifies a directory to apply as a prefix to all relative file paths
+ in the script file.
+ </p></dd>
<dt><span class="term">index-type=element-name</span></dt>
<dd><p>
- Specifies the name of the XML element to enclose internally generated indexes
- in: defaults to "section", but could equally be "appendix"
- or "chapter" or some other block level element that has a formal
- title.
- </p></dd>
+ Specifies the name of the XML element to enclose internally generated
+ indexes in: defaults to "section", but could equally be "appendix"
+ or "chapter" or some other block level element that has a formal
+ title.
+ </p></dd>
</dl>
</div>
</div>
@@ -77,7 +81,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="script_ref.html"><img src="../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/html/images/home.png" alt="Home"></a>
+<a accesskey="p" href="script_ref.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a>
</div>
</body>
</html>

Modified: sandbox/tools/auto_index/doc/html/autoindex/overview.html
==============================================================================
--- sandbox/tools/auto_index/doc/html/autoindex/overview.html (original)
+++ sandbox/tools/auto_index/doc/html/autoindex/overview.html 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -13,7 +13,7 @@
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../index.html"><img src="../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tut.html"><img src="../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../index.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="tut.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">
@@ -41,7 +41,10 @@
       has the section title as the main index entry and the search term as the subentry.
       Thus the user has two chances to find what their looking for, based upon either
       the section name or the <span class="emphasis"><em>function</em></span>, <span class="emphasis"><em>class</em></span>,
- <span class="emphasis"><em>macro</em></span> or <span class="emphasis"><em>typedef</em></span> name.
+ <span class="emphasis"><em>macro</em></span> or <span class="emphasis"><em>typedef</em></span> name. Note that
+ this behaviour can be changed so that only one index entry is created - using
+ the search term as the key - and not using the section name except as a sub-entry
+ of the search term.
     </p>
<p>
       So for example in Boost.Math the class name <code class="computeroutput"><span class="identifier">students_t_distribution</span></code>
@@ -63,7 +66,7 @@
       few entries where the section name used as an index entry is less than ideal.
       So AutoIndex provides some powerful regular expression based rules that allow
       you to add, remove, constrain, or rewrite entries. Normally just a few lines
- in AutoIndex's script file are enough to tailor the output to match the authors
+ in AutoIndex's script file are enough to tailor the output to match the author's
       expectations.
     </p>
<p>
@@ -99,7 +102,7 @@
<p>
       Finally, you can choose what kind of XML container wraps an internally generated
       index - this defaults to <code class="computeroutput"><span class="special"><</span><span class="identifier">section</span><span class="special">>...</</span><span class="identifier">section</span><span class="special">></span></code>
- but you can use either command line options or bjam Jamfile features, so select
+ but you can use either command line options or bjam Jamfile features, to select
       an alternative wrapper - for example "appendix" or "chapter"
       would be good choices, whatever fits best into the flow of the document. You
       can even set the container wrapper to type "index" provided you turn
@@ -121,7 +124,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../index.html"><img src="../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="tut.html"><img src="../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../index.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="tut.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/tools/auto_index/doc/html/autoindex/script_ref.html
==============================================================================
--- sandbox/tools/auto_index/doc/html/autoindex/script_ref.html (original)
+++ sandbox/tools/auto_index/doc/html/autoindex/script_ref.html 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -13,7 +13,7 @@
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="tut.html"><img src="../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="comm_ref.html"><img src="../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="tut.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="comm_ref.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">
@@ -22,8 +22,17 @@
<p>
       The following elements can occur in a script:
     </p>
+<a name="autoindex.script_ref.comments_and_blank_lines"></a><h5>
+<a name="id911500"></a>
+ <a class="link" href="script_ref.html#autoindex.script_ref.comments_and_blank_lines">Comments and
+ blank lines</a>
+ </h5>
+<p>
+ Blank lines consisting of only whitespace are ignored, so are lines that start
+ with a '#'.
+ </p>
<a name="autoindex.script_ref.simple_inclusions"></a><h5>
-<a name="id981349"></a>
+<a name="id911517"></a>
       <a class="link" href="script_ref.html#autoindex.script_ref.simple_inclusions">Simple Inclusions</a>
     </h5>
<pre class="programlisting"><span class="identifier">term</span> <span class="special">[</span><span class="identifier">regular</span><span class="special">-</span><span class="identifier">expression1</span> <span class="special">[</span><span class="identifier">regular</span><span class="special">-</span><span class="identifier">expression2</span> <span class="special">[</span><span class="identifier">category</span><span class="special">]]]</span>
@@ -33,60 +42,64 @@
<dl>
<dt><span class="term">term</span></dt>
<dd><p>
- The term to index: this will form a primary entry in the Index with the
- section title(s) containing the term as secondary entries, and also will
- be used as a secondary entry beneath each of the section titles that the
- term occurs in.
- </p></dd>
+ The term to index: this will form a primary entry in the Index with the
+ section title(s) containing the term as secondary entries, and also will
+ be used as a secondary entry beneath each of the section titles that
+ the term occurs in.
+ </p></dd>
<dt><span class="term">regular-expression1</span></dt>
<dd>
<p>
- An optional regular expression: each occurance of the regular expression
- in the text of the document will result in one index term being emitted.
- </p>
-<p>
- If the regular expression is omitted or is "", then the <span class="emphasis"><em>term</em></span>
- itself will be used as the search text - and only occurance of whole words
- matching <span class="emphasis"><em>term</em></span> will be indexed.
- </p>
+ An optional regular expression: each occurance of the regular expression
+ in the text of the document will result in one index term being emitted.
+ </p>
+<p>
+ If the regular expression is omitted or is "", then the <span class="emphasis"><em>term</em></span>
+ itself will be used as the search text - and only occurance of whole
+ words matching <span class="emphasis"><em>term</em></span> will be indexed.
+ </p>
</dd>
<dt><span class="term">regular-expression2</span></dt>
<dd>
<p>
- A constraint that specifies which sections are indexed for <span class="emphasis"><em>term</em></span>:
- only if the ID of the section matches <span class="emphasis"><em>regular-expression2</em></span>
- exactly will that section be indexed for occurances of <span class="emphasis"><em>term</em></span>.
- </p>
-<p>
- For example:
- </p>
-<p>
- <code class="computeroutput"><span class="identifier">myclass</span> <span class="string">""</span>
- <span class="string">"mylib.examples.*"</span></code>
- </p>
-<p>
- Will index occurances of "myclass" as a whole word only in sections
- whose ID begins "mylib.examples", while:
- </p>
-<p>
- <code class="computeroutput"><span class="identifier">myclass</span> <span class="string">""</span>
- <span class="string">"(?!mylib.introduction.*).*"</span></code>
- </p>
-<p>
- will index occurances of "myclass" in any section, except those
- whose ID's begin "mylib.introduction".
- </p>
+ A constraint that specifies which sections are indexed for <span class="emphasis"><em>term</em></span>:
+ only if the ID of the section matches <span class="emphasis"><em>regular-expression2</em></span>
+ exactly will that section be indexed for occurances of <span class="emphasis"><em>term</em></span>.
+ </p>
+<p>
+ For example:
+ </p>
+<p>
+ <code class="computeroutput"><span class="identifier">myclass</span> <span class="string">""</span>
+ <span class="string">"mylib.examples.*"</span></code>
+ </p>
+<p>
+ Will index occurances of "myclass" as a whole word only in
+ sections whose ID begins "mylib.examples", while:
+ </p>
+<p>
+ <code class="computeroutput"><span class="identifier">myclass</span> <span class="string">""</span>
+ <span class="string">"(?!mylib.introduction.*).*"</span></code>
+ </p>
+<p>
+ will index occurances of "myclass" in any section, except those
+ whose ID's begin "mylib.introduction".
+ </p>
+<p>
+ If this field is omitted or is "", then all sections are indexed
+ for this term.
+ </p>
</dd>
<dt><span class="term">category</span></dt>
<dd><p>
- Optionally an index category to place occurances of <span class="emphasis"><em>term</em></span>
- in. If you have multiple indexes then this is the name assigned to the
- indexes "type" attribute.
- </p></dd>
+ Optionally an index category to place occurances of <span class="emphasis"><em>term</em></span>
+ in. If you have multiple indexes then this is the name assigned to the
+ indexes "type" attribute.
+ </p></dd>
</dl>
</div>
<a name="autoindex.script_ref.source_file_scanning"></a><h5>
-<a name="id981550"></a>
+<a name="id911726"></a>
       <a class="link" href="script_ref.html#autoindex.script_ref.source_file_scanning">Source File Scanning</a>
     </h5>
<pre class="programlisting"><span class="special">!</span><span class="identifier">scan</span> <span class="identifier">source</span><span class="special">-</span><span class="identifier">file</span><span class="special">-</span><span class="identifier">name</span>
@@ -100,8 +113,22 @@
       seen in the source file. These may then be included in a specialised index
       whose "type" attribute has the same category name.
     </p>
+<div class="important"><table border="0" summary="Important">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../images/important.png"></td>
+<th align="left">Important</th>
+</tr>
+<tr><td align="left" valign="top"><p>
+ When actually indexing a document, the scanner will not index just any old
+ occurance of the terms found in the source files. Instead it searches for
+ class definitions or function or typedef declarations. This reduces the number
+ of spurious matches placed in the index, but may also miss some legitimate
+ terms: refer to the <span class="emphasis"><em>set-regex</em></span> command for information
+ on how to change this.
+ </p></td></tr>
+</table></div>
<a name="autoindex.script_ref.directory_and_source_file_scanning"></a><h5>
-<a name="id981616"></a>
+<a name="id911804"></a>
       <a class="link" href="script_ref.html#autoindex.script_ref.directory_and_source_file_scanning">Directory
       and Source File Scanning</a>
     </h5>
@@ -112,23 +139,25 @@
<dl>
<dt><span class="term">directory-name</span></dt>
<dd><p>
- The directory to scan: this should be a path relative to the script file
- and should use all forward slashes in it's file name.
- </p></dd>
+ The directory to scan: this should be a path relative to the script file
+ (or to the path specified with the prefix=path option on the command
+ line) and should use all forward slashes in it's file name.
+ </p></dd>
<dt><span class="term">file-name-regex</span></dt>
<dd><p>
- A regular expression: any file in the directory whose name matches the
- regular expression will be scanned for terms to index.
- </p></dd>
+ A regular expression: any file in the directory whose name matches the
+ regular expression will be scanned for terms to index.
+ </p></dd>
<dt><span class="term">recurse</span></dt>
<dd><p>
- An optional boolian value - either "true" or "false"
- - that indicates whether to recurse into subdirectories.
- </p></dd>
+ An optional boolian value - either "true" or "false"
+ - that indicates whether to recurse into subdirectories. This defaults
+ to "false"
+ </p></dd>
</dl>
</div>
<a name="autoindex.script_ref.excluding_terms"></a><h5>
-<a name="id981737"></a>
+<a name="id911929"></a>
       <a class="link" href="script_ref.html#autoindex.script_ref.excluding_terms">Excluding Terms</a>
     </h5>
<pre class="programlisting"><span class="special">!</span><span class="identifier">exclude</span> <span class="identifier">term</span><span class="special">-</span><span class="identifier">list</span>
@@ -137,28 +166,28 @@
       Excludes all the terms in whitespace separated <span class="emphasis"><em>term-list</em></span>
       from being indexed. This should be placed <span class="emphasis"><em>after</em></span> any <span class="emphasis"><em>!scan</em></span>
       or <span class="emphasis"><em>!scan-path</em></span> rules which may result in the terms becoming
- included.
+ included. In other words this removes terms from the scanners internal list
+ of things to index.
     </p>
<a name="autoindex.script_ref.rewriting_section_names"></a><h5>
-<a name="id981793"></a>
+<a name="id911984"></a>
       <a class="link" href="script_ref.html#autoindex.script_ref.rewriting_section_names">Rewriting Section
       Names</a>
     </h5>
-<pre class="programlisting"><span class="special">!</span><span class="identifier">rewrite</span><span class="special">-</span><span class="identifier">id</span> <span class="identifier">regular</span><span class="special">-</span><span class="identifier">expression</span> <span class="keyword">new</span><span class="special">-</span><span class="identifier">name</span>
-</pre>
+<pre class="programlisting">!rewrite-id regular-expression new-name</pre>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">regular-expression</span></dt>
<dd><p>
- A regular expression: all section ID's that match the expression exactly
- will have index entries <span class="emphasis"><em>new-name</em></span> instead of their
- title(s).
- </p></dd>
+ A regular expression: all section ID's that match the expression exactly
+ will have index entries <span class="emphasis"><em>new-name</em></span> instead of their
+ title(s).
+ </p></dd>
<dt><span class="term">new-name</span></dt>
<dd><p>
- The name that the section will appear under in the index.
- </p></dd>
+ The name that the section will appear under in the index.
+ </p></dd>
</dl>
</div>
<pre class="programlisting"><span class="special">!</span><span class="identifier">rewrite</span><span class="special">-</span><span class="identifier">name</span> <span class="identifier">regular</span><span class="special">-</span><span class="identifier">expression</span> <span class="identifier">format</span><span class="special">-</span><span class="identifier">text</span>
@@ -168,14 +197,155 @@
<dl>
<dt><span class="term">regular-expression</span></dt>
<dd><p>
- A regular expression: all sections whose titles match the regular expression
- exactly, will have index entries composed of the regular expression match
- combined with the regex format string <span class="emphasis"><em>format-text</em></span>.
- </p></dd>
+ A regular expression: all sections whose titles match the regular expression
+ exactly, will have index entries composed of the regular expression match
+ combined with the regex format string <span class="emphasis"><em>format-text</em></span>.
+ </p></dd>
<dt><span class="term">format-text</span></dt>
<dd><p>
- The Perl-style format string used to reformat the title.
- </p></dd>
+ The Perl-style format string used to reformat the title.
+ </p></dd>
+</dl>
+</div>
+<a name="autoindex.script_ref.changing_the_regular_expressions_used_when_scanning"></a><h5>
+<a name="id912122"></a>
+ <a class="link" href="script_ref.html#autoindex.script_ref.changing_the_regular_expressions_used_when_scanning">Changing
+ the regular expressions used when scanning</a>
+ </h5>
+<pre class="programlisting"><span class="special">!</span><span class="identifier">set</span><span class="special">-</span><span class="identifier">regex</span> <span class="identifier">type</span> <span class="identifier">prefix</span> <span class="identifier">suffix</span>
+</pre>
+<p>
+ When a class, function, typedef or macro name is found as a result of scanning
+ a source file the scanner constructs a regular expression from that name that
+ is used to actually perform the search of the text for occurances of the name.
+ This regular expression is constructed by joining together 3 parts - a prefix,
+ the name of the class, function, typedef or macro, and a suffix. By default
+ the regular expressions constructed in this way are designed to narrow the
+ number of occurences of the term found - so for example given a class "myclass"
+ only a synopsis of that class that looks like:
+ </p>
+<pre class="programlisting"><span class="keyword">class</span> <span class="identifier">myclass</span>
+<span class="special">{</span>
+ <span class="comment">// details...
+</span><span class="special">};</span>
+</pre>
+<p>
+ will be found by the scanner and indexed. The default regular expression prefix
+ and suffix terms are:
+ </p>
+<div class="informaltable"><table class="table">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ Type
+ </p>
+ </th>
+<th>
+ <p>
+ Prefix
+ </p>
+ </th>
+<th>
+ <p>
+ Suffix
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ class
+ </p>
+ </td>
+<td>
+ <p>
+ "class<code class="literal">;{</code>+\<"
+ </p>
+ </td>
+<td>
+ <p>
+ "\><code class="literal">;{</code>+\{"
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ function
+ </p>
+ </td>
+<td>
+ <p>
+ "\<\w+\>\s+\<"
+ </p>
+ </td>
+<td>
+ <p>
+ "\>\s*$[^;{]*$\s*[;{]"
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ typedef
+ </p>
+ </td>
+<td>
+ <p>
+ "typedef[^;]+\<"
+ </p>
+ </td>
+<td>
+ <p>
+ "\>\s*;"
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ macro
+ </p>
+ </td>
+<td>
+ <p>
+ "\<"
+ </p>
+ </td>
+<td>
+ <p>
+ "\>"
+ </p>
+ </td>
+</tr>
+</tbody>
+</table></div>
+<p>
+ The arguments to the set-regex rule as follows:
+ </p>
+<div class="variablelist">
+<p class="title"><b></b></p>
+<dl>
+<dt><span class="term">type</span></dt>
+<dd><p>
+ One of "class", "function", "typedef" or
+ "macro".
+ </p></dd>
+<dt><span class="term">prefix</span></dt>
+<dd><p>
+ The prefix regular expression, or "" to reset to the default.
+ </p></dd>
+<dt><span class="term">suffix</span></dt>
+<dd><p>
+ The suffix regular expression, or "" to reset to the default.
+ </p></dd>
</dl>
</div>
</div>
@@ -189,7 +359,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="tut.html"><img src="../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="comm_ref.html"><img src="../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="tut.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="comm_ref.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/tools/auto_index/doc/html/autoindex/tut.html
==============================================================================
--- sandbox/tools/auto_index/doc/html/autoindex/tut.html (original)
+++ sandbox/tools/auto_index/doc/html/autoindex/tut.html 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -13,25 +13,16 @@
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="overview.html"><img src="../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="script_ref.html"><img src="../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="overview.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="script_ref.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="autoindex.tut"></a><a class="link" href="tut.html" title="Getting Started and Tutorial"> Getting Started and Tutorial</a>
</h2></div></div></div>
<a name="autoindex.tut.step_1__build_the_tool"></a><h5>
-<a name="id972429"></a>
+<a name="id902662"></a>
       <a class="link" href="tut.html#autoindex.tut.step_1__build_the_tool">Step 1: Build the tool</a>
     </h5>
-<div class="note"><table border="0" summary="Note">
-<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../doc/html/images/note.png"></td>
-<th align="left">Note</th>
-</tr>
-<tr><td align="left" valign="top"><p>
- This step is strictly optional, but can speed up build times.
- </p></td></tr>
-</table></div>
<p>
       cd into <code class="computeroutput"><span class="identifier">tools</span><span class="special">/</span><span class="identifier">auto_index</span><span class="special">/</span><span class="identifier">build</span></code> and invoke bjam as:
     </p>
@@ -50,7 +41,7 @@
</pre>
<div class="note"><table border="0" summary="Note">
<tr>
-<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../doc/html/images/note.png"></td>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
@@ -64,12 +55,14 @@
</td></tr>
</table></div>
<p>
- Finally copy <code class="computeroutput"><span class="identifier">tools</span><span class="special">/</span><span class="identifier">auto_index</span><span class="special">/</span><span class="keyword">auto</span><span class="special">-</span><span class="identifier">index</span><span class="special">.</span><span class="identifier">jam</span></code> into
- the same directory as the rest of the Boost.Build tools (under <code class="computeroutput"><span class="identifier">tools</span><span class="special">/</span><span class="identifier">build</span><span class="special">/</span><span class="identifier">v2</span><span class="special">/</span><span class="identifier">tools</span></code> in your main Boost tree): this is a
- temporary requirement that will go away if the tool is accepted into Boost.
+ Finally note that <code class="computeroutput"><span class="identifier">tools</span><span class="special">/</span><span class="identifier">auto_index</span><span class="special">/</span><span class="keyword">auto</span><span class="special">-</span><span class="identifier">index</span><span class="special">.</span><span class="identifier">jam</span></code> gets
+ copied into the same directory as the rest of the Boost.Build tools (under
+ <code class="computeroutput"><span class="identifier">tools</span><span class="special">/</span><span class="identifier">build</span><span class="special">/</span><span class="identifier">v2</span><span class="special">/</span><span class="identifier">tools</span></code> in
+ your main Boost tree): this is a temporary fix that will go away if the tool
+ is accepted into Boost.
     </p>
<a name="autoindex.tut.step_2__configure_boost_build"></a><h5>
-<a name="id972601"></a>
+<a name="id902826"></a>
       <a class="link" href="tut.html#autoindex.tut.step_2__configure_boost_build">Step 2: Configure
       Boost.Build</a>
     </h5>
@@ -116,46 +109,53 @@
<dl>
<dt><span class="term"><auto-index>off/on</span></dt>
<dd><p>
- Turns indexing of the document on, defaults to "off", so be sure
- to set this if you want AutoIndex invoked!
- </p></dd>
+ Turns indexing of the document on, defaults to "off", so be
+ sure to set this if you want AutoIndex invoked!
+ </p></dd>
<dt><span class="term"><auto-index-internal>off/on</span></dt>
<dd><p>
- Chooses whether AutoIndex creates the index itself (feature on), or whether
- it simply inserts the necessary DocBook markup so that the DocBook XSL
- stylesheets can create the index.
- </p></dd>
+ Chooses whether AutoIndex creates the index itself (feature on), or whether
+ it simply inserts the necessary DocBook markup so that the DocBook XSL
+ stylesheets can create the index. Defaults to "off".
+ </p></dd>
<dt><span class="term"><auto-index-script>filename</span></dt>
<dd><p>
- Specifies the name of the script to load.
- </p></dd>
+ Specifies the name of the script to load.
+ </p></dd>
<dt><span class="term"><auto-index-no-duplicates>off/on</span></dt>
<dd><p>
- When "on" AutoIndex will only index a term once in any given
- section, otherwise (the default) multiple index entries per term may be
- created if the term occurs more than once in the section.
- </p></dd>
+ When "on" AutoIndex will only index a term once in any given
+ section, otherwise (the default) multiple index entries per term may
+ be created if the term occurs more than once in the section.
+ </p></dd>
+<dt><span class="term"><auto-index-section-names>off/on</span></dt>
+<dd><p>
+ When "on" AutoIndex will use create two index entries for each
+ term found - one uses the term itself as the primary index key, the other
+ uses the enclosing section name. When off the index entry that uses the
+ section title is not created. Defaults to "on"
+ </p></dd>
<dt><span class="term"><auto-index-verbose>off/on</span></dt>
<dd><p>
- Defaults to "off". When turned on the AutoIndex prints progress
- information - generally useful only for debugging purposes.
- </p></dd>
+ Defaults to "off". When turned on AutoIndex prints progress
+ information - generally useful only for debugging purposes.
+ </p></dd>
<dt><span class="term"><auto-index-prefix>filename</span></dt>
<dd><p>
- Specifies a directory to apply as a prefix to all relative file paths in
- the script file.
- </p></dd>
+ Specifies a directory to apply as a prefix to all relative file paths
+ in the script file.
+ </p></dd>
<dt><span class="term">auto-index-type=element-name</span></dt>
<dd><p>
- Specifies the name of the XML element to enclose internally generated indexes
- in: defaults to "section", but could equally be "appendix"
- or "chapter" or some other block level element that has a formal
- title.
- </p></dd>
+ Specifies the name of the XML element to enclose internally generated
+ indexes in: defaults to "section", but could equally be "appendix"
+ or "chapter" or some other block level element that has a formal
+ title.
+ </p></dd>
</dl>
</div>
<a name="autoindex.tut.step_3__add_indexes_to_your_documentation"></a><h5>
-<a name="id972742"></a>
+<a name="id902989"></a>
       <a class="link" href="tut.html#autoindex.tut.step_3__add_indexes_to_your_documentation">Step
       3: Add indexes to your documentation</a>
     </h5>
@@ -185,10 +185,22 @@

<index type="macro_name">
<title>Macro Index</title>
-<<span class="emphasis"><em>index>
+</index>

-<index</em></span>>
+<index/>
</pre>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top"><p>
+ Multiple indexes like this only work correctly if you tell the XSL stylesheets
+ to honor the "type" attribute on each index as by default . You
+ can turn the feature on by adding <code class="computeroutput"><span class="special"><</span><span class="identifier">xsl</span><span class="special">:</span><span class="identifier">param</span><span class="special">></span><span class="identifier">index</span><span class="special">.</span><span class="identifier">on</span><span class="special">.</span><span class="identifier">type</span><span class="special">=</span><span class="number">1</span></code>
+ to your projects requirements in the Jamfile.
+ </p></td></tr>
+</table></div>
<p>
       In quickbook, you add the same markup but enclose it in an escape:
     </p>
@@ -211,10 +223,9 @@
       output.
     </p>
<p>
- You control the type of XML block used by setting the <code class="computeroutput"><span class="special"><</span><span class="keyword">auto</span><span class="special">-</span><span class="identifier">index</span><span class="special">-</span><span class="identifier">type</span><span class="special">></span><span class="identifier">element</span><span class="special">-</span><span class="identifier">name</span></code> attribute in the Jamfile, or via the
- <code class="computeroutput"><span class="identifier">index</span><span class="special">-</span><span class="identifier">type</span><span class="special">=</span><span class="identifier">element</span><span class="special">-</span><span class="identifier">name</span></code> command
- line option to auto-index itself. For example, to place the index in an appendix
- your Jamfile might look like:
+ You control the type of XML block used by setting the <code class="literal"><auto-index-type>element-name</code>
+ attribute in the Jamfile, or via the <code class="computeroutput"><span class="identifier">index</span><span class="special">-</span><span class="identifier">type</span><span class="special">=</span><span class="identifier">element</span><span class="special">-</span><span class="identifier">name</span></code> command line option to auto-index itself.
+ For example, to place the index in an appendix your Jamfile might look like:
     </p>
<pre class="programlisting">using quickbook ;
using auto-index ;
@@ -234,9 +245,11 @@
         <auto-index-script>index.idx
         # Set the XML wrapper for HML Indexes to "appendix":
         <format>html:<auto-index-type>appendix
+ # Turn on multiple index support:
+ <xsl:param>index.on.type=1
</pre>
<a name="autoindex.tut.step_4__create_the_script_file"></a><h5>
-<a name="id980810"></a>
+<a name="id910948"></a>
       <a class="link" href="tut.html#autoindex.tut.step_4__create_the_script_file">Step 4: Create
       the script file</a>
     </h5>
@@ -309,7 +322,7 @@
<pre class="programlisting"><span class="special">!</span><span class="identifier">rewrite</span><span class="special">-</span><span class="identifier">name</span> <span class="string">"(?i)(?:A|The)\s+(.*)"</span> <span class="string">"\1"</span>
</pre>
<a name="autoindex.tut.step_5__add_manual_index_entries___optional"></a><h5>
-<a name="id981068"></a>
+<a name="id911206"></a>
       <a class="link" href="tut.html#autoindex.tut.step_5__add_manual_index_entries___optional">Step
       5: Add Manual Index Entries - Optional</a>
     </h5>
@@ -325,7 +338,7 @@
       index itself, with the exception of the "type" attribute.
     </p>
<a name="autoindex.tut.step_6__build_the_your_docs"></a><h5>
-<a name="id981188"></a>
+<a name="id911326"></a>
       <a class="link" href="tut.html#autoindex.tut.step_6__build_the_your_docs">Step 6: Build the
       Your Docs</a>
     </h5>
@@ -352,7 +365,7 @@
       If you don't see that, or if it's indexing 0 terms then something is wrong!
     </p>
<a name="autoindex.tut.step_7__iterate"></a><h5>
-<a name="id981298"></a>
+<a name="id911437"></a>
       <a class="link" href="tut.html#autoindex.tut.step_7__iterate">Step 7: Iterate</a>
     </h5>
<p>
@@ -362,14 +375,14 @@
     </p>
<div class="itemizedlist"><ul type="disc">
<li>
- What's missing.
- </li>
+ What's missing.
+ </li>
<li>
- What's been included that shouldn't be.
- </li>
+ What's been included that shouldn't be.
+ </li>
<li>
- What's been included under a poor name.
- </li>
+ What's been included under a poor name.
+ </li>
</ul></div>
<p>
       Further rules can then be added to the script to handle these cases and the
@@ -386,7 +399,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="overview.html"><img src="../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="script_ref.html"><img src="../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="overview.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="script_ref.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/tools/auto_index/doc/html/index.html
==============================================================================
--- sandbox/tools/auto_index/doc/html/index.html (original)
+++ sandbox/tools/auto_index/doc/html/index.html 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -10,7 +10,7 @@
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
-<div class="spirit-nav"><a accesskey="n" href="autoindex/overview.html"><img src="../../doc/html/images/next.png" alt="Next"></a></div>
+<div class="spirit-nav"><a accesskey="n" href="autoindex/overview.html"><img src="images/next.png" alt="Next"></a></div>
<div class="article" lang="en">
<div class="titlepage">
<div>
@@ -21,7 +21,7 @@
</h3></div></div></div>
<div><p class="copyright">Copyright © 2008 John Maddock</p></div>
<div><div class="legalnotice">
-<a name="id972141"></a><p>
+<a name="id902374"></a><p>
         Distributed under the Boost Software License, Version 1.0. (See accompanying
         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
       </p>
@@ -40,10 +40,10 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: June 09, 2010 at 17:47:00 GMT</small></p></td>
+<td align="left"><p><small>Last revised: June 28, 2010 at 17:45:04 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
-<div class="spirit-nav"><a accesskey="n" href="autoindex/overview.html"><img src="../../doc/html/images/next.png" alt="Next"></a></div>
+<div class="spirit-nav"><a accesskey="n" href="autoindex/overview.html"><img src="images/next.png" alt="Next"></a></div>
</body>
</html>

Modified: sandbox/tools/auto_index/example/integer/doc/Jamfile.v2
==============================================================================
--- /trunk/libs/integer/doc/Jamfile.v2 (original)
+++ sandbox/tools/auto_index/example/integer/doc/Jamfile.v2 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -4,13 +4,28 @@
# subject to the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

+local boost = [ modules.peek : BOOST ] ;
+
using quickbook ;
+using auto-index ;

xml integer : integer.qbk ;
boostbook standalone
     :
         integer
     :
+ # this one turns on indexing:
+ <auto-index>on
+ # choose indexing method for pdf's:
+ <format>pdf:<auto-index-internal>off
+ # choose indexing method for html:
+ <format>html:<auto-index-internal>on
+ # set the name of the script file to use:
+ <auto-index-script>index.idx
+ # where to find the files to scan:
+ <auto-index-prefix>$(boost)
+ <auto-index-verbose>on
+ <auto-index-section-names>off
         # HTML options first:
         # Use graphics not text for navigation:
         <xsl:param>navig.graphics=1
@@ -52,8 +67,10 @@
         <format>pdf:<xsl:param>admon.graphics.extension=".svg"
         <format>pdf:<xsl:param>admon.graphics.path=$(boost-images)/
         <format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/regex/doc/html
+ <format>pdf:<xsl:param>index.on.type=1
     ;

-install pdf-install : standalone : <location>. <install-type>PDF ;
+install pdf-install : standalone : <location>. <install-type>PDF <name>integer.pdf ;
+

Modified: sandbox/tools/auto_index/example/integer/doc/html/boost_integer/cstdint.html
==============================================================================
--- /trunk/libs/integer/doc/html/boost_integer/cstdint.html (original)
+++ sandbox/tools/auto_index/example/integer/doc/html/boost_integer/cstdint.html 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -3,26 +3,19 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Standard Integer Types</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../index.html" title="Boost.Integer">
<link rel="up" href="../index.html" title="Boost.Integer">
<link rel="prev" href="../index.html" title="Boost.Integer">
<link rel="next" href="traits.html" title="Integer Traits">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../index.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="traits.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../index.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="traits.html"><img src="../images/next.png" alt="Next"></a>
</div>
-<div class="section" title="Standard Integer Types">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_integer.cstdint"></a><a class="link" href="cstdint.html" title="Standard Integer Types"> Standard Integer Types</a>
</h2></div></div></div>
@@ -41,7 +34,7 @@
<dt><span class="section"><a href="cstdint.html#boost_integer.cstdint.integer_constant_macros">Integer
       Constant Macros</a></span></dt>
</dl></div>
-<div class="section" title="Overview">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.cstdint.overview"></a><a class="link" href="cstdint.html#boost_integer.cstdint.overview" title="Overview">Overview</a>
</h3></div></div></div>
@@ -62,7 +55,7 @@
         a test program.
       </p>
</div>
-<div class="section" title="Rationale">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.cstdint.rationale"></a><a class="link" href="cstdint.html#boost_integer.cstdint.rationale" title="Rationale"> Rationale</a>
</h3></div></div></div>
@@ -82,7 +75,7 @@
         conventions rather than C++ Standard Library header naming conventions.
       </p>
</div>
-<div class="section" title="Caveat emptor">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.cstdint.ce"></a><a class="link" href="cstdint.html#boost_integer.cstdint.ce" title="Caveat emptor"> <span class="emphasis"><em>Caveat emptor</em></span></a>
</h3></div></div></div>
@@ -99,7 +92,7 @@
         Use the respective names in namespace <code class="literal">boost</code> instead.
       </p>
</div>
-<div class="section" title="Exact-width integer types">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.cstdint.exact_width_integer_types"></a><a class="link" href="cstdint.html#boost_integer.cstdint.exact_width_integer_types" title="Exact-width integer types">Exact-width
       integer types</a>
@@ -119,7 +112,7 @@
         The absence of int64_t and uint64_t is indicated by the macro <code class="computeroutput"><span class="identifier">BOOST_NO_INT64_T</span></code>.
       </p>
</div>
-<div class="section" title="Minimum-width integer types">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.cstdint.minimum_width_integer_types"></a><a class="link" href="cstdint.html#boost_integer.cstdint.minimum_width_integer_types" title="Minimum-width integer types">Minimum-width
       integer types</a>
@@ -137,27 +130,43 @@
<p>
         The following minimum-width integer types are provided for all platforms:
       </p>
-<div class="itemizedlist"><ul class="itemizedlist" type="disc">
-<li class="listitem"><code class="literal">int_least8_t</code></li>
-<li class="listitem"><code class="literal">int_least16_t</code></li>
-<li class="listitem"><code class="literal">int_least32_t</code></li>
-<li class="listitem"><code class="literal">uint_least8_t</code></li>
-<li class="listitem"><code class="literal">uint_least16_t</code></li>
-<li class="listitem"><code class="literal">uint_least32_t</code></li>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ <code class="literal">int_least8_t</code>
+ </li>
+<li>
+ <code class="literal">int_least16_t</code>
+ </li>
+<li>
+ <code class="literal">int_least32_t</code>
+ </li>
+<li>
+ <code class="literal">uint_least8_t</code>
+ </li>
+<li>
+ <code class="literal">uint_least16_t</code>
+ </li>
+<li>
+ <code class="literal">uint_least32_t</code>
+ </li>
</ul></div>
<p>
         The following types are available only if, after including <boost/cstdint.hpp>,
         the macro BOOST_NO_INT64_T is not defined:
       </p>
-<div class="itemizedlist"><ul class="itemizedlist" type="disc">
-<li class="listitem"><code class="literal">int_least64_t</code></li>
-<li class="listitem"><code class="literal">uint_least64_t</code></li>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ <code class="literal">int_least64_t</code>
+ </li>
+<li>
+ <code class="literal">uint_least64_t</code>
+ </li>
</ul></div>
<p>
         All other minimum-width integer types are optional.
       </p>
</div>
-<div class="section" title="Fastest minimum-width integer types">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.cstdint.fastest_minimum_width_integer_types"></a><a class="link" href="cstdint.html#boost_integer.cstdint.fastest_minimum_width_integer_types" title="Fastest minimum-width integer types">Fastest
       minimum-width integer types</a>
@@ -175,27 +184,43 @@
<p>
         The following fastest minimum-width integer types are provided for all platforms:
       </p>
-<div class="itemizedlist"><ul class="itemizedlist" type="disc">
-<li class="listitem"><code class="literal">int_fast8_t</code></li>
-<li class="listitem"><code class="literal">int_fast16_t</code></li>
-<li class="listitem"><code class="literal">int_fast32_t</code></li>
-<li class="listitem"><code class="literal">uint_fast8_t</code></li>
-<li class="listitem"><code class="literal">uint_fast16_t</code></li>
-<li class="listitem"><code class="literal">uint_fast32_t</code></li>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ <code class="literal">int_fast8_t</code>
+ </li>
+<li>
+ <code class="literal">int_fast16_t</code>
+ </li>
+<li>
+ <code class="literal">int_fast32_t</code>
+ </li>
+<li>
+ <code class="literal">uint_fast8_t</code>
+ </li>
+<li>
+ <code class="literal">uint_fast16_t</code>
+ </li>
+<li>
+ <code class="literal">uint_fast32_t</code>
+ </li>
</ul></div>
<p>
         The following types are available only if, after including <boost/cstdint.hpp>,
         the macro BOOST_NO_INT64_T is not defined:
       </p>
-<div class="itemizedlist"><ul class="itemizedlist" type="disc">
-<li class="listitem"><code class="literal">int_fast64_t</code></li>
-<li class="listitem"><code class="literal">uint_fast64_t</code></li>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ <code class="literal">int_fast64_t</code>
+ </li>
+<li>
+ <code class="literal">uint_fast64_t</code>
+ </li>
</ul></div>
<p>
         All other fastest minimum-width integer types are optional.
       </p>
</div>
-<div class="section" title="Greatest-width integer types">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.cstdint.greatest_width_integer_types"></a><a class="link" href="cstdint.html#boost_integer.cstdint.greatest_width_integer_types" title="Greatest-width integer types">Greatest-width
       integer types</a>
@@ -212,7 +237,7 @@
         These types are provided for all platforms.
       </p>
</div>
-<div class="section" title="Integer Constant Macros">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.cstdint.integer_constant_macros"></a><a class="link" href="cstdint.html#boost_integer.cstdint.integer_constant_macros" title="Integer Constant Macros">Integer
       Constant Macros</a>
@@ -251,7 +276,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="../index.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="traits.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="../index.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="traits.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/tools/auto_index/example/integer/doc/html/boost_integer/history.html
==============================================================================
--- /trunk/libs/integer/doc/html/boost_integer/history.html (original)
+++ sandbox/tools/auto_index/example/integer/doc/html/boost_integer/history.html 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -3,67 +3,61 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>History</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../index.html" title="Boost.Integer">
<link rel="up" href="../index.html" title="Boost.Integer">
<link rel="prev" href="minmax.html" title="Compile time min/max calculation">
+<link rel="next" href="../index/s09.html" title="Class Index">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="minmax.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a>
+<a accesskey="p" href="minmax.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="../index/s09.html"><img src="../images/next.png" alt="Next"></a>
</div>
-<div class="section" title="History">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_integer.history"></a><a class="link" href="history.html" title="History"> History</a>
</h2></div></div></div>
<a name="boost_integer.history.1_42_0"></a><h5>
-<a name="id560880"></a>
+<a name="id909235"></a>
       <a class="link" href="history.html#boost_integer.history.1_42_0">1.42.0</a>
     </h5>
-<div class="itemizedlist"><ul class="itemizedlist" type="disc">
-<li class="listitem">
- Reverted Trunk to release branch state (i.e. a "known good state").
- </li>
-<li class="listitem">
- Fixed issues: 653,
- 3084,
- 3177,
- 3180,
- 3568,
- 3657,
- 2134.
- </li>
-<li class="listitem">
- Added long long support to <code class="literal">boost::static_log2</code>, <code class="literal">boost::static_signed_min</code>,
- <code class="literal">boost::static_signed_max</code>, <code class="literal">boost::static_unsigned_min</code><code class="literal">boost::static_unsigned_max</code>,
- when available.
- </li>
-<li class="listitem">
- The argument type and the result type of <code class="literal">boost::static_signed_min</code>
- etc are now typedef'd. Formerly, they were hardcoded as <code class="literal">unsigned
- long</code> and <code class="literal">int</code> respectively. Please, use the provided
- typedefs in new code (and update old code as soon as possible).
- </li>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Reverted Trunk to release branch state (i.e. a "known good state").
+ </li>
+<li>
+ Fixed issues: 653,
+ 3084,
+ 3177,
+ 3180,
+ 3568,
+ 3657,
+ 2134.
+ </li>
+<li>
+ Added long long support to <code class="literal">boost::static_log2</code>, <code class="literal">boost::static_signed_min</code>,
+ <code class="literal">boost::static_signed_max</code>, <code class="literal">boost::static_unsigned_min</code><code class="literal">boost::static_unsigned_max</code>,
+ when available.
+ </li>
+<li>
+ The argument type and the result type of <code class="literal">boost::static_signed_min</code>
+ etc are now typedef'd. Formerly, they were hardcoded as <code class="literal">unsigned
+ long</code> and <code class="literal">int</code> respectively. Please, use the
+ provided typedefs in new code (and update old code as soon as possible).
+ </li>
</ul></div>
<a name="boost_integer.history.1_32_0"></a><h5>
-<a name="id560998"></a>
+<a name="id909352"></a>
       <a class="link" href="history.html#boost_integer.history.1_32_0">1.32.0</a>
     </h5>
-<div class="itemizedlist"><ul class="itemizedlist" type="disc"><li class="listitem">
- The argument type and the result type of <code class="literal">boost::static_log2</code>
- are now typedef'd. Formerly, they were hardcoded as <code class="literal">unsigned long</code>
- and <code class="literal">int</code> respectively. Please, use the provided typedefs
- in new code (and update old code as soon as possible).
- </li></ul></div>
+<div class="itemizedlist"><ul type="disc"><li>
+ The argument type and the result type of <code class="literal">boost::static_log2</code>
+ are now typedef'd. Formerly, they were hardcoded as <code class="literal">unsigned long</code>
+ and <code class="literal">int</code> respectively. Please, use the provided typedefs
+ in new code (and update old code as soon as possible).
+ </li></ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
@@ -76,7 +70,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="minmax.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a>
+<a accesskey="p" href="minmax.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="../index/s09.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/tools/auto_index/example/integer/doc/html/boost_integer/integer.html
==============================================================================
--- /trunk/libs/integer/doc/html/boost_integer/integer.html (original)
+++ sandbox/tools/auto_index/example/integer/doc/html/boost_integer/integer.html 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -3,26 +3,19 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Integer Type Selection</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../index.html" title="Boost.Integer">
<link rel="up" href="../index.html" title="Boost.Integer">
<link rel="prev" href="traits.html" title="Integer Traits">
<link rel="next" href="mask.html" title="Integer Masks">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="traits.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="mask.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="traits.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="mask.html"><img src="../images/next.png" alt="Next"></a>
</div>
-<div class="section" title="Integer Type Selection">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_integer.integer"></a><a class="link" href="integer.html" title="Integer Type Selection"> Integer Type Selection</a>
</h2></div></div></div>
@@ -44,7 +37,7 @@
       characteristics such as number of bits or maximum value. This facility is particularly
       useful for solving generic programming problems.
     </p>
-<div class="section" title="Synopsis">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.integer.synopsis"></a><a class="link" href="integer.html#boost_integer.integer.synopsis" title="Synopsis"> Synopsis</a>
</h3></div></div></div>
@@ -102,7 +95,7 @@
<span class="special">}</span> <span class="comment">// namespace boost
</span></pre>
</div>
-<div class="section" title="Easiest-to-Manipulate Types">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.integer.easiest"></a><a class="link" href="integer.html#boost_integer.integer.easiest" title="Easiest-to-Manipulate Types"> Easiest-to-Manipulate
       Types</a>
@@ -126,7 +119,7 @@
         the input type.
       </p>
</div>
-<div class="section" title="Sized Types">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.integer.sized"></a><a class="link" href="integer.html#boost_integer.integer.sized" title="Sized Types"> Sized Types</a>
</h3></div></div></div>
@@ -341,7 +334,7 @@
</div>
<br class="table-break">
</div>
-<div class="section" title="Example">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.integer.example"></a><a class="link" href="integer.html#boost_integer.integer.example" title="Example">Example</a>
</h3></div></div></div>
@@ -363,7 +356,7 @@
<span class="special">}</span>
</pre>
</div>
-<div class="section" title="Demonstration Program">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.integer.demonstration_program"></a><a class="link" href="integer.html#boost_integer.integer.demonstration_program" title="Demonstration Program">Demonstration
       Program</a>
@@ -374,27 +367,27 @@
         of the sized type class templates.
       </p>
</div>
-<div class="section" title="Rationale">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.integer.rationale"></a><a class="link" href="integer.html#boost_integer.integer.rationale" title="Rationale">Rationale</a>
</h3></div></div></div>
<p>
         The rationale for the design of the templates in this header includes:
       </p>
-<div class="itemizedlist"><ul class="itemizedlist" type="disc">
-<li class="listitem">
- Avoid recursion because of concern about C++'s limited guaranteed recursion
- depth (17).
- </li>
-<li class="listitem">
- Avoid macros on general principles.
- </li>
-<li class="listitem">
- Try to keep the design as simple as possible.
- </li>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Avoid recursion because of concern about C++'s limited guaranteed recursion
+ depth (17).
+ </li>
+<li>
+ Avoid macros on general principles.
+ </li>
+<li>
+ Try to keep the design as simple as possible.
+ </li>
</ul></div>
</div>
-<div class="section" title="Alternative">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.integer.alternative"></a><a class="link" href="integer.html#boost_integer.integer.alternative" title="Alternative">Alternative</a>
</h3></div></div></div>
@@ -403,7 +396,7 @@
         to use the types supplied in <boost/cstdint.hpp>.
       </p>
</div>
-<div class="section" title="Credits">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.integer.credits"></a><a class="link" href="integer.html#boost_integer.integer.credits" title="Credits">Credits</a>
</h3></div></div></div>
@@ -426,7 +419,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="traits.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="mask.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="traits.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="mask.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/tools/auto_index/example/integer/doc/html/boost_integer/log2.html
==============================================================================
--- /trunk/libs/integer/doc/html/boost_integer/log2.html (original)
+++ sandbox/tools/auto_index/example/integer/doc/html/boost_integer/log2.html 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -3,26 +3,19 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Compile Time log2 Calculation</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../index.html" title="Boost.Integer">
<link rel="up" href="../index.html" title="Boost.Integer">
<link rel="prev" href="mask.html" title="Integer Masks">
<link rel="next" href="minmax.html" title="Compile time min/max calculation">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="mask.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="minmax.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="mask.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="minmax.html"><img src="../images/next.png" alt="Next"></a>
</div>
-<div class="section" title="Compile Time log2 Calculation">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_integer.log2"></a><a class="link" href="log2.html" title="Compile Time log2 Calculation"> Compile Time log2 Calculation</a>
</h2></div></div></div>
@@ -39,7 +32,7 @@
       determines the position of the highest bit in a given value. This facility
       is useful for solving generic programming problems.
     </p>
-<div class="section" title="Synopsis">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.log2.synopsis"></a><a class="link" href="log2.html#boost_integer.log2.synopsis" title="Synopsis">Synopsis</a>
</h3></div></div></div>
@@ -66,7 +59,7 @@
<span class="special">}</span> <span class="comment">// namespace boost
</span></pre>
</div>
-<div class="section" title="Usage">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.log2.usage"></a><a class="link" href="log2.html#boost_integer.log2.usage" title="Usage">Usage</a>
</h3></div></div></div>
@@ -85,18 +78,18 @@
<p>
         Note:
       </p>
-<div class="itemizedlist"><ul class="itemizedlist" type="disc">
-<li class="listitem">
-<code class="literal">static_log2_argument_type</code> is an <span class="emphasis"><em>unsigned integer
- type</em></span> (C++ standard, 3.9.1p3).
- </li>
-<li class="listitem">
-<code class="literal">static_log2_result_type</code> is an <span class="emphasis"><em>integer type</em></span>
- (C++ standard, 3.9.1p7).
- </li>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ <code class="literal">static_log2_argument_type</code> is an <span class="emphasis"><em>unsigned
+ integer type</em></span> (C++ standard, 3.9.1p3).
+ </li>
+<li>
+ <code class="literal">static_log2_result_type</code> is an <span class="emphasis"><em>integer type</em></span>
+ (C++ standard, 3.9.1p7).
+ </li>
</ul></div>
</div>
-<div class="section" title="Demonstration Program">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.log2.demonstration_program"></a><a class="link" href="log2.html#boost_integer.log2.demonstration_program" title="Demonstration Program">Demonstration
       Program</a>
@@ -107,7 +100,7 @@
         of the binary logarithm class template.
       </p>
</div>
-<div class="section" title="Rationale">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.log2.rationale"></a><a class="link" href="log2.html#boost_integer.log2.rationale" title="Rationale">Rationale</a>
</h3></div></div></div>
@@ -120,7 +113,7 @@
         to be available statically (<span class="emphasis"><em>i.e.</em></span> at compile-time).
       </p>
</div>
-<div class="section" title="Credits">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.log2.credits"></a><a class="link" href="log2.html#boost_integer.log2.credits" title="Credits">Credits</a>
</h3></div></div></div>
@@ -145,7 +138,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="mask.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="minmax.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="mask.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="minmax.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/tools/auto_index/example/integer/doc/html/boost_integer/mask.html
==============================================================================
--- /trunk/libs/integer/doc/html/boost_integer/mask.html (original)
+++ sandbox/tools/auto_index/example/integer/doc/html/boost_integer/mask.html 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -3,26 +3,19 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Integer Masks</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../index.html" title="Boost.Integer">
<link rel="up" href="../index.html" title="Boost.Integer">
<link rel="prev" href="integer.html" title="Integer Type Selection">
<link rel="next" href="log2.html" title="Compile Time log2 Calculation">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="integer.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="log2.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="integer.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="log2.html"><img src="../images/next.png" alt="Next"></a>
</div>
-<div class="section" title="Integer Masks">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_integer.mask"></a><a class="link" href="mask.html" title="Integer Masks"> Integer Masks</a>
</h2></div></div></div>
@@ -41,7 +34,7 @@
<dt><span class="section">Rationale</span></dt>
<dt><span class="section">Credits</span></dt>
</dl></div>
-<div class="section" title="Overview">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.mask.overview"></a><a class="link" href="mask.html#boost_integer.mask.overview" title="Overview">Overview</a>
</h3></div></div></div>
@@ -52,7 +45,7 @@
         type selection templates</a> header.
       </p>
</div>
-<div class="section" title="Synopsis">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.mask.synopsis"></a><a class="link" href="mask.html#boost_integer.mask.synopsis" title="Synopsis">Synopsis</a>
</h3></div></div></div>
@@ -90,7 +83,7 @@
<span class="special">}</span> <span class="comment">// namespace boost
</span></pre>
</div>
-<div class="section" title="Single Bit-Mask Class Template">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.mask.single_bit_mask_class_template"></a><a class="link" href="mask.html#boost_integer.mask.single_bit_mask_class_template" title="Single Bit-Mask Class Template">Single
       Bit-Mask Class Template</a>
@@ -191,7 +184,7 @@
</div>
<br class="table-break">
</div>
-<div class="section" title="Group Bit-Mask Class Template">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.mask.group_bit_mask_class_template"></a><a class="link" href="mask.html#boost_integer.mask.group_bit_mask_class_template" title="Group Bit-Mask Class Template">Group
       Bit-Mask Class Template</a>
@@ -292,7 +285,7 @@
</div>
<br class="table-break">
</div>
-<div class="section" title="Implementation Notes">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.mask.implementation_notes"></a><a class="link" href="mask.html#boost_integer.mask.implementation_notes" title="Implementation Notes">Implementation
       Notes</a>
@@ -304,7 +297,7 @@
         bit counts.
       </p>
</div>
-<div class="section" title="Example">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.mask.example"></a><a class="link" href="mask.html#boost_integer.mask.example" title="Example">Example</a>
</h3></div></div></div>
@@ -328,7 +321,7 @@
</span><span class="special">}</span>
</pre>
</div>
-<div class="section" title="Demonstration Program">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.mask.demonstration_program"></a><a class="link" href="mask.html#boost_integer.mask.demonstration_program" title="Demonstration Program">Demonstration
       Program</a>
@@ -339,7 +332,7 @@
         of the bit mask class templates.
       </p>
</div>
-<div class="section" title="Rationale">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.mask.rationale"></a><a class="link" href="mask.html#boost_integer.mask.rationale" title="Rationale">Rationale</a>
</h3></div></div></div>
@@ -351,7 +344,7 @@
         bits. This prevents contamination of values by the higher, unused bits.
       </p>
</div>
-<div class="section" title="Credits">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.mask.credits"></a><a class="link" href="mask.html#boost_integer.mask.credits" title="Credits">Credits</a>
</h3></div></div></div>
@@ -372,7 +365,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="integer.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="log2.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="integer.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="log2.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/tools/auto_index/example/integer/doc/html/boost_integer/minmax.html
==============================================================================
--- /trunk/libs/integer/doc/html/boost_integer/minmax.html (original)
+++ sandbox/tools/auto_index/example/integer/doc/html/boost_integer/minmax.html 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -3,26 +3,19 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Compile time min/max calculation</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../index.html" title="Boost.Integer">
<link rel="up" href="../index.html" title="Boost.Integer">
<link rel="prev" href="log2.html" title="Compile Time log2 Calculation">
<link rel="next" href="history.html" title="History">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="log2.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="history.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="log2.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="history.html"><img src="../images/next.png" alt="Next"></a>
</div>
-<div class="section" title="Compile time min/max calculation">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_integer.minmax"></a><a class="link" href="minmax.html" title="Compile time min/max calculation"> Compile time min/max calculation</a>
</h2></div></div></div>
@@ -40,7 +33,7 @@
       provide a compile-time evaluation of the minimum or maximum of two integers.
       These facilities are useful for generic programming problems.
     </p>
-<div class="section" title="Synopsis">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.minmax.synopsis"></a><a class="link" href="minmax.html#boost_integer.minmax.synopsis" title="Synopsis">Synopsis</a>
</h3></div></div></div>
@@ -65,7 +58,7 @@
<span class="special">}</span>
</pre>
</div>
-<div class="section" title="Usage">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.minmax.usage"></a><a class="link" href="minmax.html#boost_integer.minmax.usage" title="Usage">Usage</a>
</h3></div></div></div>
@@ -77,7 +70,7 @@
         which is set to the respective minimum or maximum of the template's parameters.
       </p>
</div>
-<div class="section" title="Example">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.minmax.example"></a><a class="link" href="minmax.html#boost_integer.minmax.example" title="Example">Example</a>
</h3></div></div></div>
@@ -112,7 +105,7 @@
</span><span class="special">}</span>
</pre>
</div>
-<div class="section" title="Demonstration Program">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.minmax.demonstration_program"></a><a class="link" href="minmax.html#boost_integer.minmax.demonstration_program" title="Demonstration Program">Demonstration
       Program</a>
@@ -123,7 +116,7 @@
         extrema class templates.
       </p>
</div>
-<div class="section" title="Rationale">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.minmax.rationale"></a><a class="link" href="minmax.html#boost_integer.minmax.rationale" title="Rationale">Rationale</a>
</h3></div></div></div>
@@ -133,7 +126,7 @@
         another class template.
       </p>
</div>
-<div class="section" title="Credits">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.minmax.credits"></a><a class="link" href="minmax.html#boost_integer.minmax.credits" title="Credits">Credits</a>
</h3></div></div></div>
@@ -154,7 +147,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="log2.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="history.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="log2.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="history.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/tools/auto_index/example/integer/doc/html/boost_integer/traits.html
==============================================================================
--- /trunk/libs/integer/doc/html/boost_integer/traits.html (original)
+++ sandbox/tools/auto_index/example/integer/doc/html/boost_integer/traits.html 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -3,26 +3,19 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Integer Traits</title>
<link rel="stylesheet" href="../../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../index.html" title="Boost.Integer">
<link rel="up" href="../index.html" title="Boost.Integer">
<link rel="prev" href="cstdint.html" title="Standard Integer Types">
<link rel="next" href="integer.html" title="Integer Type Selection">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="cstdint.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="integer.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="cstdint.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="integer.html"><img src="../images/next.png" alt="Next"></a>
</div>
-<div class="section" title="Integer Traits">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_integer.traits"></a><a class="link" href="traits.html" title="Integer Traits"> Integer Traits</a>
</h2></div></div></div>
@@ -33,7 +26,7 @@
<dt><span class="section">Test Program</span></dt>
<dt><span class="section">Acknowledgements</span></dt>
</dl></div>
-<div class="section" title="Motivation">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.traits.motivation"></a><a class="link" href="traits.html#boost_integer.traits.motivation" title="Motivation">Motivation</a>
</h3></div></div></div>
@@ -62,7 +55,7 @@
         The template class <code class="literal">integer_traits</code> addresses this problem.
       </p>
</div>
-<div class="section" title="Synopsis">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.traits.synopsis"></a><a class="link" href="traits.html#boost_integer.traits.synopsis" title="Synopsis">Synopsis</a>
</h3></div></div></div>
@@ -82,7 +75,7 @@
<span class="special">}</span>
</pre>
</div>
-<div class="section" title="Description">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.traits.description"></a><a class="link" href="traits.html#boost_integer.traits.description" title="Description">Description</a>
</h3></div></div></div>
@@ -179,7 +172,7 @@
         unless boost::integer_traits is also specialized.
       </p>
</div>
-<div class="section" title="Test Program">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.traits.test_program"></a><a class="link" href="traits.html#boost_integer.traits.test_program" title="Test Program">Test Program</a>
</h3></div></div></div>
@@ -188,7 +181,7 @@
         exercises the <code class="literal">integer_traits</code> class.
       </p>
</div>
-<div class="section" title="Acknowledgements">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h3 class="title">
<a name="boost_integer.traits.acknowledgements"></a><a class="link" href="traits.html#boost_integer.traits.acknowledgements" title="Acknowledgements">Acknowledgements</a>
</h3></div></div></div>
@@ -209,7 +202,7 @@
</tr></table>
<hr>
<div class="spirit-nav">
-<a accesskey="p" href="cstdint.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../../../../../doc/html/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../../../doc/html/images/home.png" alt="Home"></a><a accesskey="n" href="integer.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+<a accesskey="p" href="cstdint.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="integer.html"><img src="../images/next.png" alt="Next"></a>
</div>
</body>
</html>

Modified: sandbox/tools/auto_index/example/integer/doc/html/index.html
==============================================================================
--- /trunk/libs/integer/doc/html/index.html (original)
+++ sandbox/tools/auto_index/example/integer/doc/html/index.html 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -3,22 +3,15 @@
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>Boost.Integer</title>
<link rel="stylesheet" href="../../../../doc/html/boostbook.css" type="text/css">
-<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
+<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="index.html" title="Boost.Integer">
<link rel="next" href="boost_integer/cstdint.html" title="Standard Integer Types">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
-<table cellpadding="2" width="100%"><tr>
-<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
-<td align="center">Home</td>
-<td align="center">Libraries</td>
-<td align="center">People</td>
-<td align="center">FAQ</td>
-<td align="center">More</td>
-</tr></table>
+<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
<hr>
-<div class="spirit-nav"><a accesskey="n" href="boost_integer/cstdint.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
-<div class="article" title="Boost.Integer">
+<div class="spirit-nav"><a accesskey="n" href="boost_integer/cstdint.html"><img src="images/next.png" alt="Next"></a></div>
+<div class="article" lang="en">
<div class="titlepage">
<div>
<div><h2 class="title">
@@ -39,8 +32,8 @@
</div></div>
<div><p class="copyright">Copyright © 2001 -2009 Beman Dawes, Daryle Walker, Gennaro Prota,
       John Maddock</p></div>
-<div><div class="legalnotice" title="Legal Notice">
-<a name="id554213"></a><p>
+<div><div class="legalnotice">
+<a name="id892987"></a><p>
         Distributed under the Boost Software License, Version 1.0. (See accompanying
         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
       </p>
@@ -59,9 +52,13 @@
<dt><span class="section"> Compile Time log2 Calculation</span></dt>
<dt><span class="section"> Compile time min/max calculation</span></dt>
<dt><span class="section"> History</span></dt>
+<dt><span class="section">Class Index</span></dt>
+<dt><span class="section">Typedef Index</span></dt>
+<dt><span class="section">Macro Index</span></dt>
+<dt><span class="section">Index</span></dt>
</dl>
</div>
-<div class="section" title="Overview">
+<div class="section" lang="en">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="boost_integer.overview"></a><a class="link" href="index.html#boost_integer.overview" title="Overview"> Overview</a>
</h2></div></div></div>
@@ -237,10 +234,10 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: April 05, 2010 at 07:20:03 GMT</small></p></td>
+<td align="left"><p><small>Last revised: June 28, 2010 at 16:51:51 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
-<div class="spirit-nav"><a accesskey="n" href="boost_integer/cstdint.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
+<div class="spirit-nav"><a accesskey="n" href="boost_integer/cstdint.html"><img src="images/next.png" alt="Next"></a></div>
</body>
</html>

Added: sandbox/tools/auto_index/example/integer/doc/index.idx
==============================================================================
--- (empty file)
+++ sandbox/tools/auto_index/example/integer/doc/index.idx 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -0,0 +1,18 @@
+
+#
+# The Boost.Integer docs do not include full
+# declarations for the types described, as a
+# result we end up indexing nothing unless we
+# use more permissive scanning rules for the types
+# we find in the headers:
+!set-regex class "\<" "\>"
+!set-regex function "\<" "\>"
+!set-regex typedef "\<" "\>"
+
+!scan-dir boost/intreger true
+!scan boost/cstdint.hpp
+!scan boost/integer.hpp
+!scan boost/integer_fwd.hpp
+!scan boost/integer_traits.hpp
+!exclude BOOST_NO_INT64_T
+!exclude Synopsis type

Added: sandbox/tools/auto_index/example/integer/doc/integer.pdf
==============================================================================
Binary file. No diff available.

Modified: sandbox/tools/auto_index/example/integer/doc/integer.qbk
==============================================================================
--- /trunk/libs/integer/doc/integer.qbk (original)
+++ sandbox/tools/auto_index/example/integer/doc/integer.qbk 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -838,3 +838,15 @@

[endsect]

+'''
+ <index type="class_name">
+ <title>Class Index</title>
+ </index>
+ <index type="typedef_name">
+ <title>Typedef Index</title>
+ </index>
+ <index type="macro_name">
+ <title>Macro Index</title>
+ </index>
+ <index/>
+'''

Modified: sandbox/tools/auto_index/example/math/doc/sf_and_dist/Jamfile.v2
==============================================================================
--- sandbox/tools/auto_index/example/math/doc/sf_and_dist/Jamfile.v2 (original)
+++ sandbox/tools/auto_index/example/math/doc/sf_and_dist/Jamfile.v2 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -22,6 +22,7 @@
         <format>html:<auto-index-internal>on
         <auto-index-script>index.idx
         <auto-index-prefix>$(local-boost-root)
+ <auto-index-verbose>on
         # Path for links to Boost:
         <xsl:param>boost.root=http://svn.boost.org/svn/boost/trunk
         # Path for libraries index:
@@ -79,3 +80,4 @@
install pdf-install : standalone : <install-type>PDF <location>. <name>math.pdf ;

+

Modified: sandbox/tools/auto_index/example/math/doc/sf_and_dist/math.pdf
==============================================================================
Binary files. No diff available.

Modified: sandbox/tools/auto_index/src/auto_index.cpp
==============================================================================
--- sandbox/tools/auto_index/src/auto_index.cpp (original)
+++ sandbox/tools/auto_index/src/auto_index.cpp 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -15,6 +15,7 @@
std::set<std::pair<std::string, std::string> > found_terms;
bool no_duplicates = false;
bool verbose = false;
+bool use_section_names = true;
index_entry_set index_entries;
boost::tiny_xml::element_list indexes;
std::list<id_rewrite_rule> id_rewrite_list;
@@ -317,7 +318,7 @@
                // We have something to index!
                found_terms.insert(item_index);

- if(simple_title != i->term)
+ if(use_section_names && (simple_title != i->term))
                {
                   //
                   // First off insert index entry with primary term
@@ -522,6 +523,10 @@
       {
          no_duplicates = true;
       }
+ else if(std::strcmp(argv[i], "--no-section-names") == 0)
+ {
+ use_section_names = false;
+ }
       else if(std::strcmp(argv[i], "--internal-index") == 0)
       {
          internal_indexes = true;

Modified: sandbox/tools/auto_index/src/file_scanning.cpp
==============================================================================
--- sandbox/tools/auto_index/src/file_scanning.cpp (original)
+++ sandbox/tools/auto_index/src/file_scanning.cpp 2010-06-28 14:00:17 EDT (Mon, 28 Jun 2010)
@@ -8,6 +8,27 @@
#include "auto_index.hpp"

//
+// The regexes we will be using to search for class/function/typedef
+// names that we locate in source files. So for example when we
+// scan the xml for class names we'll use
+// class_prefix_regex + class_name + class_suffix_regex
+// as the regular expression. These have defaults but can be changed
+// in the script file.
+//
+const char* default_class_prefix_regex = "class[^;{]+\\<";
+const char* default_class_suffix_regex = "\\>[^;{]+\\{";
+const char* default_function_prefix_regex = "\\<\\w+\\>\\s+\\<";
+const char* default_function_suffix_regex = "\\>\\s*\$[^;{]*\$\\s*[;{]";
+const char* default_typedef_prefix_regex = "typedef[^;]+\\<";
+const char* default_typedef_suffix_regex = "\\>\\s*;";
+std::string class_prefix_regex = default_class_prefix_regex;
+std::string class_suffix_regex = default_class_suffix_regex;
+std::string function_prefix_regex = default_function_prefix_regex;
+std::string function_suffix_regex = default_function_suffix_regex;
+std::string typedef_prefix_regex = default_typedef_prefix_regex;
+std::string typedef_suffix_regex = default_typedef_suffix_regex;
+
+//
// Helper to dump file contents into a std::string:
//
void load_file(std::string& s, std::istream& is)
@@ -63,7 +84,7 @@
       {
          index_info info;
          info.term = i->str();
- info.search_text = "class[^;{]+\\<" + i->str() + "\\>[^;{]+\\{";
+ info.search_text = class_prefix_regex + i->str() + class_suffix_regex;
          info.category = "class_name";
          if(index_terms.count(info) == 0)
          {
@@ -88,7 +109,7 @@
       {
          index_info info;
          info.term = i->str();
- info.search_text = "typedef[^;]+\\<" + i->str() + "\\>\\s*;";
+ info.search_text = typedef_prefix_regex + i->str() + typedef_suffix_regex;
          info.category = "typedef_name";
          if(index_terms.count(info) == 0)
          {
@@ -139,7 +160,7 @@
       {
          index_info info;
          info.term = i->str();
- info.search_text = "\\<\\w+\\>\\s+\\<" + i->str() + "\\>\\s*\$[^;{]*\$\\s*[;{]";
+ info.search_text = function_prefix_regex + i->str() + function_suffix_regex;
          info.category = "function_name";
          if(index_terms.count(info) == 0)
          {
@@ -191,6 +212,9 @@
//
void process_script(const char* script)
{
+ static const boost::regex comment_parser(
+ "\\s*(?:#.*)?$"
+ );
    static const boost::regex scan_parser(
       "!scan[[:space:]]+"
       "([^\"[:space:]]+|\"(?:[^\"\\\\]|\\\\.)+\")"
@@ -225,6 +249,12 @@
       "([^\"[:space:]]+|\"(?:[^\"\\\\]|\\\\.)+\")\\s+"
       "([^\"[:space:]]+|\"(?:[^\"\\\\]|\\\\.)+\")"
       );
+ static const boost::regex set_regex_parser(
+ "!set-regex\\s+(?:(class)|(function)|(typedef)|(macro))\\s+"
+ "(?<prefix>[^\"[:space:]]+|\"(?:[^\"\\\\]|\\\\.)+\")\\s+"
+ "(?<suffix>[^\"[:space:]]+|\"(?:[^\"\\\\]|\\\\.)+\")"
+ );
+
    if(verbose)
       std::cout << "Processing script " << script << std::endl;
    boost::smatch what;
@@ -236,7 +266,11 @@
    }
    while(std::getline(is, line).good())
    {
- if(regex_match(line, what, scan_parser))
+ if(regex_match(line, what, comment_parser))
+ {
+ // Nothing to do here...
+ }
+ else if(regex_match(line, what, scan_parser))
       {
          std::string f = unquote(what[1].str());
          if(!boost::filesystem::path(f).is_complete())
@@ -301,6 +335,63 @@
             ++i;
          }
       }
+ else if(regex_match(line, what, set_regex_parser))
+ {
+ // what[1|2|3|4] indicates which regex we are setting.
+ // what["prefix"] and what["suffix"] are the prefix and suffix regexes
+ // for the expression we're setting.
+ const char* prefix_default = 0;
+ const char* suffix_default;
+ std::string* p_prefix_string;
+ std::string* p_suffix_string;
+ if(what[1].matched)
+ {
+ if(verbose)
+ std::cout << "Changing the regexes used for class name scanning" << std::endl;
+ prefix_default = default_class_prefix_regex;
+ suffix_default = default_class_suffix_regex;
+ p_prefix_string = &class_prefix_regex;
+ p_suffix_string = &class_suffix_regex;
+ }
+ else if(what[2].matched)
+ {
+ if(verbose)
+ std::cout << "Changing the regexes used for function name scanning" << std::endl;
+ prefix_default = default_function_prefix_regex;
+ suffix_default = default_function_suffix_regex;
+ p_prefix_string = &function_prefix_regex;
+ p_suffix_string = &function_suffix_regex;
+ }
+ else if(what[3].matched)
+ {
+ if(verbose)
+ std::cout << "Changing the regexes used for typedef name scanning" << std::endl;
+ prefix_default = default_typedef_prefix_regex;
+ suffix_default = default_typedef_suffix_regex;
+ p_prefix_string = &typedef_prefix_regex;
+ p_suffix_string = &typedef_suffix_regex;
+ }
+ else if(what[4].matched)
+ {
+ std::cout << "WARNING: Changing the regexes used for macro name scanning is not supported yet." << std::endl;
+ }
+ else
+ {
+ std::cerr << "ERROR: We should never get here." << std::endl;
+ abort();
+ }
+ if(prefix_default)
+ {
+ if(what["prefix"].length())
+ *p_prefix_string = unquote(what["prefix"]);
+ else
+ *p_prefix_string = prefix_default;
+ if(what["suffix"].length())
+ *p_suffix_string = unquote(what["suffix"]);
+ else
+ *p_suffix_string = suffix_default;
+ }
+ }
       else if(regex_match(line, what, entry_parser))
       {
          // what[1] is the Index entry

Next message: bdawes_at_[hidden]: "[Boost-commit] svn:boost r63412 - in trunk/libs/filesystem: v2/test v3/test"
Previous message: marshall_at_[hidden]: "[Boost-commit] svn:boost r63410 - in branches/release: boost libs/array/doc libs/array/test"

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk