diff --git a/build/Jamfile.v2 b/build/Jamfile.v2
index 2c229f2..28848b5 100644
--- a/build/Jamfile.v2
+++ b/build/Jamfile.v2
@@ -1,5 +1,21 @@
+#==============================================================================
+# Copyright (c) 2015 Rene Rivera
+#
+# Use, modification and distribution is 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)
+#==============================================================================
+
import quickbook ;
import modules ;
+import boostcpp ;
+import path ;
+import option ;
+
+local DIST_DIR = [ option.get distdir ] ;
+DIST_DIR ?= [ path.join $(BOOST_ROOT) dist ] ;
+DIST_DIR = [ path.root $(DIST_DIR) [ path.pwd ] ] ;
+local DIST_BIN = [ path.join $(DIST_DIR) bin ] ;
exe auto_index :
../src/auto_index.cpp
@@ -13,21 +29,6 @@ exe auto_index :
:
-
Specifies the name of the XML input file to be indexed. diff --git a/doc/html/boost_autoindex/overview.html b/doc/html/boost_autoindex/overview.html index 658ac7e..39144f1 100644 --- a/doc/html/boost_autoindex/overview.html +++ b/doc/html/boost_autoindex/overview.html @@ -3,7 +3,7 @@
The following elements can occur in a script:
-@@ -46,16 +46,16 @@ You can't append # comments onto the end of a line!
term [regular-expression1 [regular-expression2 [category]]]
-
@@ -87,7 +87,6 @@ For example:
-
foobar
@@ -96,7 +95,6 @@ will index occurrences of "foobar" in any section, but
-
foobar \<\w*(foo|bar)\w*\>
@@ -107,7 +105,6 @@ related words under one entry.
-
reflex
@@ -116,7 +113,6 @@ will only index occurrences of "reflex" as a whole word, but:
-
reflex \<reflex\w*\>
@@ -144,7 +140,6 @@ section (but not sub-sections below):
-
myclass "" "mylib\.examples"
@@ -154,7 +149,6 @@ sub-sections below:
-
myclass "" "mylib\.examples.*"
@@ -165,7 +159,6 @@ "mylib.examples", while
-
myclass "\<myclass\w*\>" "mylib\.examples.*"
@@ -177,7 +170,6 @@ and:
-
myclass "" "(?!mylib\.introduction).*"
@@ -190,7 +182,6 @@ Finally, two (or more) sections can be excluded by OR'ing them together:
-
myclass "" "(?!mylib\.introduction|mylib\.reference).*"
@@ -231,7 +222,7 @@
You can have an index term appear more than once in the script file:
-myterm (?:search_expression1|search_expression1) (?:constrait_expression2|constrait_expression2) mycategory-
!scan source-file-name@@ -288,16 +279,16 @@ on how to change this.
!scan-path directory-name file-name-regex [recurse]
-
The directory to scan: this should be a path relative to the script file @@ -317,9 +308,10 @@
!exclude term-list@@ -330,15 +322,15 @@ included. In other words this removes terms from the scanners internal list of things to index. -
!rewrite-id regular-expression new-name
-
A regular expression: all section ID's that match the expression exactly @@ -355,7 +347,7 @@
-
A regular expression: all sections whose titles match the regular expression @@ -377,9 +369,9 @@ Will remove any leading "A", "An" or "The" from all index entries - thus preventing lots of entries under "The" etc!
-!define-scanner type file-search-expression xml-regex-formatter term-formatter id-filter filename-filter @@ -394,7 +386,7 @@-
+
- type
The type to which items found using this rule will @@ -446,10 +438,10 @@ or "function_name", then the defaults are installed. These are equivalent to:
-!define-scanner class_name "^[[:space:]]*(template[[:space:]]*<[^;:{]+>[[:space:]]*)?(class|struct)[[:space:]]*(\<\w+\>([[:blank:]]*\([^)]*\))?[[:space:]]*)*(\<\w*\>)[[:space:]]*(<[^;:{]+>)?[[:space:]]*(\{|:[^;\{()]*\{)" "(?:class|struct)[^;{]+\\<\5\\>[^;{]+\\{" \5 -!define-scanner typedef_name "typedef[^;{}#]+?(\w+)\s*;" "typedef[^;]+\\<\1\\>\\s*;" "\1" -!define-scanner "macro_name" "^\s*#\s*define\s+(\w+)" "\\<\1\\>" "\1" -!define-scanner "function_name" "\w+(?:\s*<[^>]>)?[\s&*]+?(\w+)\s*(?:BOOST_[[:upper:]_]+\s*)?\([^\)]*\)\s*[;{]" "\\<\\w+\\>(?:\\s+<[^>]*>)?[\\s&*]+\\<\1\\>\\s*\\([^;{]*\\)" "\1" +!define-scanner class_name "^[[:space:]]*(template[[:space:]]*<[^;:{]+>[[:space:]]*)?(class|struct)[[:space:]]*(\<\w+\>([[:blank:]]*\([^)]*\))?[[:space:]]*)*(\<\w*\>)[[:space:]]*(<[^;:{]+>)?[[:space:]]*(\{|:[^;\{()]*\{)" "(?:class|struct)[^;{]+\<\5\>[^;{]+\{" \5 +!define-scanner typedef_name "typedef[^;{}#]+?(\w+)\s*;" "typedef[^;]+\<\1\>\s*;" "\1" +!define-scanner "macro_name" "^\s*#\s*define\s+(\w+)" "\<\1\>" "\1" +!define-scanner "function_name" "\w++(?:\s*+<[^>]++>)?[\s&*]+?(\w+)\s*(?:BOOST_[[:upper:]_]+\s*)?\([^;{}]*\)\s*[;{]" "\\<\\w+\\>(?:\\s+<[^>]*>)*[\\s&*]+\\<\1\\>\\s*\\([^;{]*\\)" "\1"Note that these defaults are not installed if you have provided your own versions @@ -474,15 +466,16 @@ above in your script file, and change the xml-regex-formatter field to something more permissive, for example:
-!define-scanner class_name "^[[:space:]]*(template[[:space:]]*<[^;:{]+>[[:space:]]*)?(class|struct)[[:space:]]*(\<\w+\>([[:blank:]]*\([^)]*\))?[[:space:]]*)*(\<\w*\>)[[:space:]]*(<[^;:{]+>)?[[:space:]]*(\{|:[^;\{()]*\{)" "\\<\5\\>" \5 +diff --git a/doc/html/boost_autoindex/tut/build.html b/doc/html/boost_autoindex/tut/build.html index a5815d9..b3b848b 100644 --- a/doc/html/boost_autoindex/tut/build.html +++ b/doc/html/boost_autoindex/tut/build.html @@ -3,7 +3,7 @@!define-scanner class_name "^[[:space:]]*(template[[:space:]]*<[^;:{]+>[[:space:]]*)?(class|struct)[[:space:]]*(\<\w+\>([[:blank:]]*\([^)]*\))?[[:space:]]*)*(\<\w*\>)[[:space:]]*(<[^;:{]+>)?[[:space:]]*(\{|:[^;\{()]*\{)" "\<\5\>" \5Will look for any occurrence of whatever class names the scanner may find in the documentation.
-- - Debugging scanning +
+ + Debugging + scanning
If you see a term in the index, and you don't understand why it's there, add diff --git a/doc/html/boost_autoindex/tut.html b/doc/html/boost_autoindex/tut.html index 646e441..3c3bba1 100644 --- a/doc/html/boost_autoindex/tut.html +++ b/doc/html/boost_autoindex/tut.html @@ -3,7 +3,7 @@
Getting Started and Tutorial - + diff --git a/doc/html/boost_autoindex/tut/add_indexes.html b/doc/html/boost_autoindex/tut/add_indexes.html index d2fff87..8363f2f 100644 --- a/doc/html/boost_autoindex/tut/add_indexes.html +++ b/doc/html/boost_autoindex/tut/add_indexes.html @@ -3,7 +3,7 @@Step 3: Add indexes to your documentation - + @@ -139,20 +139,20 @@ boostbook standalone mylibrary : # auto-indexing is on: - <auto-index>on - + <auto-index>on + # PDFs rely on the XSL stylesheets to generate the index: - <format>pdf:<auto-index-internal>off - + <format>pdf:<auto-index-internal>off + # HTML output uses auto-index to generate the index: <format>html:<auto-index-internal>on - + # Name of script file to use: <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=1Step 1: Build the AutoIndex tool - + @@ -55,7 +55,7 @@ Now open up youruser-config.jam
file and at the end of the file add the line: -using auto-index : full-path-to-boost-tree/tools/auto_index/build/auto-index.exe ; +using auto-index : full-path-to-boost-tree/tools/auto_index/build/auto-index.exe ;
diff --git a/doc/html/boost_autoindex/tut/build_docs.html b/doc/html/boost_autoindex/tut/build_docs.html index d87ec8b..6558277 100644 --- a/doc/html/boost_autoindex/tut/build_docs.html +++ b/doc/html/boost_autoindex/tut/build_docs.html @@ -3,7 +3,7 @@ Step 7: Build the Docs - + diff --git a/doc/html/boost_autoindex/tut/configure.html b/doc/html/boost_autoindex/tut/configure.html index 451d32a..51e31cd 100644 --- a/doc/html/boost_autoindex/tut/configure.html +++ b/doc/html/boost_autoindex/tut/configure.html @@ -3,7 +3,7 @@Step 2: Configure Boost.Build jamfile to use AutoIndex - + @@ -57,26 +57,26 @@ mylibrary : # Build requirements go here: - + # <auto-index>on (or off) one turns on (or off) indexing: <auto-index>on - + # Turns on (or off) auto-index-verbose for diagnostic info. # This is highly recommended until you have got all the many details correct! - <auto-index-verbose>on - + <auto-index-verbose>on + # Choose the indexing method (separately for html and PDF) - see manual. # Choose indexing method for PDFs: <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 (index.idx is popular): <auto-index-script>index.idx # Commands in the script file should all use RELATIVE PATHS # otherwise the script will not be portable to other machines. - # Relative paths are normally taken as relative to the location + # Relative paths are normally taken as relative to the location # of the script file, but we can add a prefix to all # those relative paths using the <auto-index-prefix> feature. # The path specified by <auto-index-prefix> may be either relative or @@ -86,7 +86,7 @@ # Tell Quickbook that it should enable indexing. <quickbook-define>enable_index ; - + ;-diff --git a/doc/html/boost_autoindex/tut/configure/optional.html b/doc/html/boost_autoindex/tut/configure/optional.html index 510144a..1e93c77 100644 --- a/doc/html/boost_autoindex/tut/configure/optional.html +++ b/doc/html/boost_autoindex/tut/configure/optional.html @@ -3,7 +3,7 @@
Making AutoIndex optional - + @@ -50,7 +50,7 @@ project : requirements <auto-index>on <auto-index-script>index.idx - + ... other AutoIndex options here... # And tell Quickbook that it should enable indexing. diff --git a/doc/html/boost_autoindex/tut/configure/options.html b/doc/html/boost_autoindex/tut/configure/options.html index b28501b..0062223 100644 --- a/doc/html/boost_autoindex/tut/configure/options.html +++ b/doc/html/boost_autoindex/tut/configure/options.html @@ -3,7 +3,7 @@Available Indexing Options - + @@ -32,7 +32,7 @@-
+
- <auto-index>off/on
Turns indexing of the document on, defaults to "off", so diff --git a/doc/html/boost_autoindex/tut/entries.html b/doc/html/boost_autoindex/tut/entries.html index 82dcc8f..854583b 100644 --- a/doc/html/boost_autoindex/tut/entries.html +++ b/doc/html/boost_autoindex/tut/entries.html @@ -3,7 +3,7 @@
Step 5: Add Manual Index Entries to Docbook XML - Optional - + diff --git a/doc/html/boost_autoindex/tut/pis.html b/doc/html/boost_autoindex/tut/pis.html index e937fee..7b57bb4 100644 --- a/doc/html/boost_autoindex/tut/pis.html +++ b/doc/html/boost_autoindex/tut/pis.html @@ -3,7 +3,7 @@Step 6: Using XML processing instructions to control what gets indexed. - + diff --git a/doc/html/boost_autoindex/tut/refine.html b/doc/html/boost_autoindex/tut/refine.html index 3299dcb..df2248a 100644 --- a/doc/html/boost_autoindex/tut/refine.html +++ b/doc/html/boost_autoindex/tut/refine.html @@ -3,7 +3,7 @@Step 8: Iterate - to refine your index - + @@ -32,7 +32,7 @@ to add a header scanning rule to the script file and then generate the documentation and see: -+
- What's missing.
@@ -58,9 +58,9 @@ directive to the script file.- - Restricting +
+ + Restricting which Sections are indexed for a particular term
diff --git a/doc/html/boost_autoindex/tut/script.html b/doc/html/boost_autoindex/tut/script.html index cd272f2..7d2f06b 100644 --- a/doc/html/boost_autoindex/tut/script.html +++ b/doc/html/boost_autoindex/tut/script.html @@ -3,7 +3,7 @@
Step 4: Create the .idx script file - to control what to terms to index - + @@ -91,7 +91,7 @@ You could also scan any examples (.cpp) files, typically in folder/mylibrary/lib/example
.# All example source files, assuming no sub-folders. -!scan-path "libs/mylibrary/example" ".*\.cpp" +!scan-path "libs/mylibrary/example" ".*.cpp"Often the scan or scan-path rules diff --git a/doc/html/boost_autoindex/workflow.html b/doc/html/boost_autoindex/workflow.html index 6d08b28..5106d80 100644 --- a/doc/html/boost_autoindex/workflow.html +++ b/doc/html/boost_autoindex/workflow.html @@ -3,7 +3,7 @@
Understanding The AutoIndex Workflow - + diff --git a/doc/html/boost_autoindex/xml.html b/doc/html/boost_autoindex/xml.html index aee7e6c..07a3a2d 100644 --- a/doc/html/boost_autoindex/xml.html +++ b/doc/html/boost_autoindex/xml.html @@ -3,7 +3,7 @@XML Handling - + @@ -29,7 +29,7 @@AutoIndex is rather simplistic in its handling of XML:
-+
- When indexing a document, all block content at the paragraph level gets collapsed into a single string for matching against the regular expressions diff --git a/doc/html/index.html b/doc/html/index.html index 80b3224..9c85050 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -3,7 +3,7 @@
Boost.AutoIndex - + @@ -28,7 +28,7 @@Copyright © 2008, 2011 John Maddock
-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)
@@ -74,7 +74,7 @@
- + Last revised: July 14, 2011 at 15:55:33 GMT
Last revised: November 09, 2015 at 18:29:43 GMT
diff --git a/doc/html/index/s08.html b/doc/html/index/s08.html index 929b206..0505ff0 100644 --- a/doc/html/index/s08.html +++ b/doc/html/index/s08.html @@ -3,7 +3,7 @@Index - + @@ -23,16 +23,16 @@A B C D F H I J L M O P Q S T U V X
-+
- A
-+
appendix
-+
- @@ -42,7 +42,7 @@
AutoIndex
-+
- @@ -62,7 +62,7 @@
Available Indexing Options
-+
- @@ -84,10 +84,10 @@
- B
-+
bjam
-+
- @@ -95,11 +95,11 @@
Boost.AutoIndex
- +Boost.Build
-+
- @@ -108,7 +108,7 @@
Boostbook
-+
- @@ -120,10 +120,10 @@
- C
-+
C++
-+
- @@ -132,7 +132,7 @@
Step 4: Create the .idx script file - to control what to terms to index
chapter
-+
- @@ -142,7 +142,7 @@
class
-+
- @@ -151,7 +151,7 @@
Command Line Reference
-+
- @@ -168,10 +168,10 @@
- D
-+
debug
-+
- @@ -180,7 +180,7 @@
Docbook
-+
- @@ -192,7 +192,7 @@
Doxygen
-+
- @@ -203,9 +203,9 @@
Step 4: Create the .idx script file - to control what to terms to index
- F
-
- +
function
-+
- @@ -214,10 +214,10 @@
- H
-+
html
-+
- @@ -227,15 +227,15 @@
hyperlink
- +- I
-
- +
index
-+
- @@ -257,9 +257,9 @@
- J
-
- +
jamfile
-+
- @@ -270,9 +270,9 @@
- L
-
- +
log file
-+
- @@ -282,10 +282,10 @@
- M
-+
macro
-+
- @@ -293,7 +293,7 @@
Making AutoIndex optional
-+
- @@ -308,15 +308,15 @@
MSVC
- +- O
-
- +
Overview
-+
- @@ -348,10 +348,10 @@
- P
-+
page
-+
- @@ -359,7 +359,7 @@
+
- @@ -368,7 +368,7 @@
plural
-+
- @@ -378,10 +378,10 @@
Step 4: Create the .idx script file - to control what to terms to index
- Q
-+
Quickbook
-+
- @@ -396,7 +396,7 @@
Quickbook Support
-