Boost-Commit :

Date view	Thread view	Subject view	Author view

Subject: [Boost-commit] svn:boost r68356 - in sandbox/tools/auto_index: . build doc doc/html doc/html/autoindex src test
From: john_at_[hidden]
Date: 2011-01-21 13:53:08

Next message: erwann.rogard_at_[hidden]: "[Boost-commit] svn:boost r68357 - sandbox/assign_v2/libs/assign/v2/speed"
Previous message: erwann.rogard_at_[hidden]: "[Boost-commit] svn:boost r68355 - sandbox/assign_v2/boost/assign/v2/ref/wrapper"

Author: johnmaddock
Date: 2011-01-21 13:53:06 EST (Fri, 21 Jan 2011)
New Revision: 68356
URL: http://svn.boost.org/trac/boost/changeset/68356

Log:
Add some notes about including optional auto-index support to the docs.
Add (copy) Jamroot etc files so this directory can be used standalone.
Fix GCC compiler warnings.
Streamline Jamfiles a touch.
Added:
   sandbox/tools/auto_index/Jamroot.jam
      - copied unchanged from r67867, /sandbox/Jamroot.jam
   sandbox/tools/auto_index/boost-build.jam
      - copied unchanged from r68353, /sandbox/boost-build.jam
Text files modified:
   sandbox/tools/auto_index/build/Jamfile.v2 | 9 +++----
   sandbox/tools/auto_index/doc/auto_index.qbk | 15 ++++++++++++++
   sandbox/tools/auto_index/doc/html/autoindex/comm_ref.html | 1
   sandbox/tools/auto_index/doc/html/autoindex/overview.html | 13 ++++++-----
   sandbox/tools/auto_index/doc/html/autoindex/script_ref.html | 41 ++++++++++++++++++++-------------------
   sandbox/tools/auto_index/doc/html/autoindex/tut.html | 41 ++++++++++++++++++++++++++++-----------
   sandbox/tools/auto_index/doc/html/autoindex/xml.html | 1
   sandbox/tools/auto_index/doc/html/index.html | 5 ++-
   sandbox/tools/auto_index/src/auto_index.cpp | 8 +++---
   sandbox/tools/auto_index/test/Jamfile.v2 | 3 -
   10 files changed, 86 insertions(+), 51 deletions(-)

Modified: sandbox/tools/auto_index/build/Jamfile.v2
==============================================================================
--- sandbox/tools/auto_index/build/Jamfile.v2 (original)
+++ sandbox/tools/auto_index/build/Jamfile.v2 2011-01-21 13:53:06 EST (Fri, 21 Jan 2011)
@@ -1,16 +1,14 @@
import quickbook ;
import modules ;

-local boost = [ modules.peek : BOOST ] ;
-
exe auto_index :
 ../src/auto_index.cpp
 ../src/file_scanning.cpp
 ../src/index_generator.cpp
 ../src/tiny_xml.cpp
- $(boost)/libs/regex/build//boost_regex
- $(boost)/libs/filesystem/build//boost_filesystem
- $(boost)/libs/system/build//boost_system
+ /boost//regex
+ /boost//filesystem
+ /boost//system
: <define>BOOST_ALL_NO_LIB=1 <link>static ;

install aii : auto_index : <location>. ;
@@ -28,3 +26,4 @@

+

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 2011-01-21 13:53:06 EST (Fri, 21 Jan 2011)
@@ -184,6 +184,21 @@
]

+It is possible to make the use of auto-index optional in Boost.Build, to allow
+users who do not have auto-index installed to build your documentation. One
+method of setting up optional auto-index support is to place all auto-index
+configuration in a the body of a bjam if statement:
+
+ if --enable-index in [ modules.peek : ARGV ]
+ {
+ using auto-index ;
+ project : requirements
+ <auto-index>on
+ <auto-index-script>index.idx
+ #... other auto-index options here...
+ ;
+ }
+
[h4 Step 3: Add indexes to your documentation]

To add a single index to a BoostBook\/Docbook document, then add

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 2011-01-21 13:53:06 EST (Fri, 21 Jan 2011)
@@ -1,3 +1,4 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">

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 2011-01-21 13:53:06 EST (Fri, 21 Jan 2011)
@@ -1,3 +1,4 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
@@ -26,7 +27,7 @@

 Traditionally, in order to index a Docbook document you would have to manually
 add a large amount of <code class="computeroutput"><indexterm></code> markup: in fact one <code class="computeroutput"><indexterm></code>
- for each occurance of each term to be indexed.
+ for each occurrence of each term to be indexed.
 

 Instead AutoIndex will scan one or more C/C++ header files and extract all
@@ -35,7 +36,7 @@
 then insert the <code class="computeroutput"><indexterm></code>'s into the XML document for you.
 

- AutoIndex creates index entries as follows - for each occurance of each search
+ AutoIndex creates index entries as follows - for each occurrence of each search
 term, it creates two index entries - one has the search term as the primary
 index key and the title of the section it appears in as a subterm, the other
 has the section title as the main index entry and the search term as the subentry.
@@ -73,7 +74,7 @@
 AutoIndex also supports multiple indexes (as does Docbook), and since it knows
 which search terms are function, class,
 macro or typedef names, it can add
- the necessary attritubes to the XML so that you can have separate indexes for
+ the necessary attribubes to the XML so that you can have separate indexes for
 each of these different types. These specialised indexes only contain entries
 for the function, class, macro
 or typedef names, section names are
@@ -86,7 +87,7 @@
 use section titles in place of page numbers... but as AutoIndex uses section
 titles as index entries this leads to a lot of repetition, so as an alternative
 AutoIndex can be instructed to construct the index itself. This is faster than
- using the XSL stylesheets, and now each index entry is a hyperlink to the approprate
+ using the XSL stylesheets, and now each index entry is a hyperlink to the appropriate
 section:
 

@@ -102,8 +103,8 @@

 Finally, you can choose what kind of XML container wraps an internally generated
 index - this defaults to <code class="computeroutput"><section>...</section></code>
- but you can use either command line options or bjam Jamfile features, to select
- an alternative wrapper - for example "appendix" or "chapter"
+ but you can use either command line options or Boost.Build 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
 off index generation by the XSL stylesheets, for example by setting the following

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 2011-01-21 13:53:06 EST (Fri, 21 Jan 2011)
@@ -1,3 +1,4 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
@@ -23,7 +24,7 @@
 The following elements can occur in a script:
 
<a name="autoindex.script_ref.comments_and_blank_lines"></a><h5>
-<a name="id978209"></a>
+<a name="id981834"></a>
 <a class="link" href="script_ref.html#autoindex.script_ref.comments_and_blank_lines">Comments and
 blank lines</a>
 </h5>
@@ -32,7 +33,7 @@
 with a '#'.
 
<a name="autoindex.script_ref.simple_inclusions"></a><h5>
-<a name="id978226"></a>
+<a name="id981851"></a>
 <a class="link" href="script_ref.html#autoindex.script_ref.simple_inclusions">Simple Inclusions</a>
 </h5>
<pre class="programlisting">term [regular-expression1 [regular-expression2 [category]]]
@@ -50,12 +51,12 @@
<dt>regular-expression1</dt>
<dd>

- An optional regular expression: each occurance of the regular expression
+ An optional regular expression: each occurrence of the regular expression
 in the text of the document will result in one index term being emitted.
 

 If the regular expression is omitted or is "", then the term
- itself will be used as the search text - and only occurance of whole
+ itself will be used as the search text - and only occurrence of whole
 words matching term will be indexed.
 
</dd>
@@ -64,7 +65,7 @@

 A constraint that specifies which sections are indexed for term:
 only if the ID of the section matches regular-expression2
- exactly will that section be indexed for occurances of term.
+ exactly will that section be indexed for occurrences of term.
 

 For example:
@@ -74,7 +75,7 @@
 "mylib.examples.*"</code>
 

- Will index occurances of "myclass" as a whole word only in
+ Will index occurrences of "myclass" as a whole word only in
 sections whose ID begins "mylib.examples", while:
 

@@ -82,8 +83,8 @@
 "(?!mylib.introduction.*).*"</code>
 

- will index occurances of "myclass" in any section, except those
- whose ID's begin "mylib.introduction".
+ will index occurrences of "myclass" in any section, except
+ those whose ID's begin "mylib.introduction".
 

 If this field is omitted or is "", then all sections are indexed
@@ -92,14 +93,14 @@
</dd>
<dt>category</dt>
<dd>
- Optionally an index category to place occurances of term
+ Optionally an index category to place occurrences of term
 in. If you have multiple indexes then this is the name assigned to the
 indexes "type" attribute.
 </dd>
</dl>
</div>
<a name="autoindex.script_ref.source_file_scanning"></a><h5>
-<a name="id978434"></a>
+<a name="id982060"></a>
 <a class="link" href="script_ref.html#autoindex.script_ref.source_file_scanning">Source File Scanning</a>
 </h5>
<pre class="programlisting">!scan source-file-name
@@ -120,7 +121,7 @@
</tr>
<tr><td align="left" valign="top">
 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
+ occurrence 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 define-scanner command for information
@@ -128,7 +129,7 @@
 </td></tr>
</table></div>
<a name="autoindex.script_ref.directory_and_source_file_scanning"></a><h5>
-<a name="id978512"></a>
+<a name="id982138"></a>
 <a class="link" href="script_ref.html#autoindex.script_ref.directory_and_source_file_scanning">Directory
 and Source File Scanning</a>
 </h5>
@@ -150,14 +151,14 @@
 </dd>
<dt>recurse</dt>
<dd>
- An optional boolian value - either "true" or "false"
+ An optional boolean value - either "true" or "false"
 - that indicates whether to recurse into subdirectories. This defaults
 to "false"
 </dd>
</dl>
</div>
<a name="autoindex.script_ref.excluding_terms"></a><h5>
-<a name="id978637"></a>
+<a name="id982263"></a>
 <a class="link" href="script_ref.html#autoindex.script_ref.excluding_terms">Excluding Terms</a>
 </h5>
<pre class="programlisting">!exclude term-list
@@ -170,7 +171,7 @@
 of things to index.
 
<a name="autoindex.script_ref.rewriting_section_names"></a><h5>
-<a name="id978692"></a>
+<a name="id982318"></a>
 <a class="link" href="script_ref.html#autoindex.script_ref.rewriting_section_names">Rewriting Section
 Names</a>
 </h5>
@@ -217,7 +218,7 @@
 all index entries - thus preventing lots of entries under "The" etc!
 
<a name="autoindex.script_ref.defining_or_changing_the_file_scanners"></a><h5>
-<a name="id978845"></a>
+<a name="id982470"></a>
 <a class="link" href="script_ref.html#autoindex.script_ref.defining_or_changing_the_file_scanners">Defining
 or Changing the File Scanners</a>
 </h5>
@@ -252,7 +253,7 @@
 A regular expression format string that extracts the salient information
 from whatever matched the file-search-expression
 in the source file, and creates a new regular expression
- that will be used to search the document being indexed for occurances
+ that will be used to search the document being indexed for occurrences
 of this index term.
 </dd>
<dt>term-formatter</dt>
@@ -264,7 +265,7 @@
 </dd>
<dt>id-filter</dt>
<dd>
- Optional. A regular expression that resticts the section-id's that are
+ Optional. A regular expression that restricts the section-id's that are
 searched in the document being indexed: only sections whose ID attribute
 matches this expression exactly will be considered for indexing terms
 found by this scanner.
@@ -316,11 +317,11 @@
<pre class="programlisting">!define-scanner class_name "^[[:space:]]*(template[[:space:]]*<[^;:{]+>[[:space:]]*)?(class|struct)[[:space:]]*(\<\w+\>([[:blank:]]*$[^)]*$)?[[:space:]]*)*(\<\w*\>)[[:space:]]*(<[^;:{]+>)?[[:space:]]*(\{|:[^;\{()]*\{)" "\\<\5\\>" \5
</pre>

- Will look for any occurance of whatever class names the
+ Will look for any occurrence of whatever class names the
 scanner may find in the documentation.
 
<a name="autoindex.script_ref.debugging"></a><h5>
-<a name="id979348"></a>
+<a name="id983118"></a>
 <a class="link" href="script_ref.html#autoindex.script_ref.debugging">Debugging</a>
 </h5>

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 2011-01-21 13:53:06 EST (Fri, 21 Jan 2011)
@@ -1,3 +1,4 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
@@ -20,7 +21,7 @@
<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="id969292"></a>
+<a name="id972655"></a>
 <a class="link" href="tut.html#autoindex.tut.step_1__build_the_tool">Step 1: Build the tool</a>
 </h5>

@@ -62,7 +63,7 @@
 is accepted into Boost.
 
<a name="autoindex.tut.step_2__configure_boost_build"></a><h5>
-<a name="id969457"></a>
+<a name="id972819"></a>
 <a class="link" href="tut.html#autoindex.tut.step_2__configure_boost_build">Step 2: Configure
 Boost.Build</a>
 </h5>
@@ -154,8 +155,24 @@
 </dd>
</dl>
</div>
+
+ It is possible to make the use of auto-index optional in Boost.Build, to allow
+ users who do not have auto-index installed to build your documentation. One
+ method of setting up optional auto-index support is to place all auto-index
+ configuration in a the body of a bjam if statement:
+ 
+<pre class="programlisting">if --enable-index in [ modules.peek : ARGV ]
+{
+ using auto-index ;
+ project : requirements
+ <auto-index>on
+ <auto-index-script>index.idx
+ #... other auto-index options here...
+ ;
+}
+</pre>
<a name="autoindex.tut.step_3__add_indexes_to_your_documentation"></a><h5>
-<a name="id969620"></a>
+<a name="id980968"></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>
@@ -207,7 +224,7 @@
<pre class="programlisting">'''<index/>'''
</pre>

- If you are using auto-index's internal index generation (usually recomended
+ If you are using auto-index's internal index generation (usually recommended
 for HTML output) then you can also decide what kind of XML wrapper the generated
 index is placed in. By default this is a <code class="computeroutput"><section>...</section></code>
 XML block (this replaces the original <code class="computeroutput"><index>...</index></code>
@@ -249,7 +266,7 @@
 <xsl:param>index.on.type=1
</pre>
<a name="autoindex.tut.step_4__create_the_script_file"></a><h5>
-<a name="id977645"></a>
+<a name="id981270"></a>
 <a class="link" href="tut.html#autoindex.tut.step_4__create_the_script_file">Step 4: Create
 the script file</a>
 </h5>
@@ -288,7 +305,7 @@
<pre class="programlisting">foobar
</pre>

- will index occurances of "foobar" and:
+ will index occurrences of "foobar" and:
 
<pre class="programlisting">foobar \<\w*(foo|bar)\w*\>
</pre>
@@ -300,16 +317,16 @@
<pre class="programlisting">reflex
</pre>

- Will only index occurances of "reflex" as a whole word, but:
+ Will only index occurrences of "reflex" as a whole word, but:
 
<pre class="programlisting">reflex \<reflex\w*\>
</pre>

- will index occurances of "reflex", reflexing" and "reflexed"
+ will index occurrences of "reflex", reflexing" and "reflexed"
 all under the same entry reflex.
 

- This inclusion rule can also restict the term to certain sections, and add
+ This inclusion rule can also restrict the term to certain sections, and add
 an index category that the term should belong to (so it only appears in certain
 indexes).
 
@@ -322,7 +339,7 @@
<pre class="programlisting">!rewrite-name "(?i)(?:A|The)\s+(.*)" "\1"
</pre>
<a name="autoindex.tut.step_5__add_manual_index_entries___optional"></a><h5>
-<a name="id977899"></a>
+<a name="id981525"></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>
@@ -338,7 +355,7 @@
 index itself, with the exception of the "type" attribute.
 
<a name="autoindex.tut.step_6__build_the_docs"></a><h5>
-<a name="id978019"></a>
+<a name="id981645"></a>
 <a class="link" href="tut.html#autoindex.tut.step_6__build_the_docs">Step 6: Build the Docs</a>
 </h5>

@@ -364,7 +381,7 @@
 If you don't see that, or if it's indexing 0 terms then something is wrong!
 
<a name="autoindex.tut.step_7__iterate"></a><h5>
-<a name="id978130"></a>
+<a name="id981755"></a>
 <a class="link" href="tut.html#autoindex.tut.step_7__iterate">Step 7: Iterate</a>
 </h5>

Modified: sandbox/tools/auto_index/doc/html/autoindex/xml.html
==============================================================================
--- sandbox/tools/auto_index/doc/html/autoindex/xml.html (original)
+++ sandbox/tools/auto_index/doc/html/autoindex/xml.html 2011-01-21 13:53:06 EST (Fri, 21 Jan 2011)
@@ -1,3 +1,4 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">

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 2011-01-21 13:53:06 EST (Fri, 21 Jan 2011)
@@ -1,3 +1,4 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
@@ -21,7 +22,7 @@
</h3></div></div></div>
<div>Copyright © 2008 John Maddock</div>
<div><div class="legalnotice">
-<a name="id969004"></a>
+<a name="id972367"></a>
 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)
 
@@ -41,7 +42,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: December 23, 2010 at 18:06:09 GMT</td>
+<td align="left">Last revised: January 21, 2011 at 18:33:36 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

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 2011-01-21 13:53:06 EST (Fri, 21 Jan 2011)
@@ -164,7 +164,7 @@
bool can_contain_indexterm(const char* name)
{
 static const boost::array<const char*, 257> names =
- {
+ { {
 "abbrev", "accel", "ackno", "acronym", "action", "answer", "appendix", "appendixinfo", "application",
 "article", "articleinfo", "artpagenums", "attribution", "authorinitials", "bibliocoverage", "bibliodiv",
 "biblioentry", "bibliography", "bibliographyinfo", "biblioid", "bibliomisc", "bibliomixed", "bibliomset",
@@ -194,7 +194,7 @@
 "table", "task", "taskprerequisites", "taskrelated", "tasksummary", "td", "term", "termdef", "th", "tip", /*"title",*/
 "titleabbrev", "tocback", "tocentry", "tocfront", "token", "type", "ulink", "uri", "userinput", "variablelist",
 "varname", "volumenum", "warning", "wordasword", "year"
- };
+ } };
 static std::set<const char*, string_cmp> permitted;

 if(permitted.empty())
@@ -218,7 +218,7 @@
 // In other words basically anything at the level of a paragraph/table/listing etc.
 //
 static const boost::array<const char*, 57> names =
- {
+ { {
 "title", "subtitle", "titleabbrev",
 "toc", "lot", "glossary", "bibliography",
 /*"calloutlist", "glosslist", "bibliolist", "itemizedlist", "orderedlist",
@@ -234,7 +234,7 @@
 "bridgehead", "remark", "highlights", "abstract", "authorblurb", "epigraph"
 /*"biblioentry", "bibliomixed", "callout", "glossentry", "listitem", "seg", "seglistitem", "member",
 "term", */
- };
+ } };
 static std::set<const char*, string_cmp> terminals;

 if(terminals.empty())

Modified: sandbox/tools/auto_index/test/Jamfile.v2
==============================================================================
--- sandbox/tools/auto_index/test/Jamfile.v2 (original)
+++ sandbox/tools/auto_index/test/Jamfile.v2 2011-01-21 13:53:06 EST (Fri, 21 Jan 2011)
@@ -8,8 +8,6 @@
import toolset ;
import type ;

-local boost = [ modules.peek : BOOST ] ;
-
path-constant local-boost-root : [ modules.peek : BOOST ] ;

alias line_compare_tool : $(local-boost-root)/tools/quickbook/test//line-compare-tool ;
@@ -68,3 +66,4 @@

+

Next message: erwann.rogard_at_[hidden]: "[Boost-commit] svn:boost r68357 - sandbox/assign_v2/libs/assign/v2/speed"
Previous message: erwann.rogard_at_[hidden]: "[Boost-commit] svn:boost r68355 - sandbox/assign_v2/boost/assign/v2/ref/wrapper"

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