boost_mirror/auto_index
1
0
Fork 0
mirror of https://github.com/boostorg/auto_index.git synced 2025-05-09 23:24:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update instructions, tweak Jamfile.v2.

Browse Source 
[SVN r50969]
This commit is contained in:
John Maddock 2009-02-02 17:06:20 +00:00
parent 990e977ae5
commit 677b1920d8
7 changed files with 53 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
build/Jamfile.v2
View File

@ -11,7 +11,8 @@ exe auto_index :
: release
;
install dist : auto_index ;
install . : auto_index ;

13
doc/auto_index.qbk
View File

@ -90,12 +90,21 @@ Optionally pass the name of the compiler toolset you want to use to bjam as well
bjam release gcc
Now open up your user-config.jam file and add the line:
Now open up your user-config.jam file and at the end add the line:
[pre
using auto-index : ['path-to-executable] ;
using auto-index : ['full-path-to-executable] ;
]
[note
This declaration must go towards the end of user-config.jam, or in any case after the Boostbook initialisation.
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
if the tool is accepted into Boost.
[h4 Step 2: Configure Boost.Build]
Assuming you have a Jamfile for building your documentation that looks

2
doc/html/autoindex/comm_ref.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Command Line Reference</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot_8125">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../index.html" title="AutoIndex">
<link rel="up" href="../index.html" title="AutoIndex">
<link rel="prev" href="script_ref.html" title="Script File Reference">

2
doc/html/autoindex/overview.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Overview</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot_8125">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../index.html" title="AutoIndex">
<link rel="up" href="../index.html" title="AutoIndex">
<link rel="prev" href="../index.html" title="AutoIndex">

12
doc/html/autoindex/script_ref.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Script File Reference</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot_8125">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../index.html" title="AutoIndex">
<link rel="up" href="../index.html" title="AutoIndex">
<link rel="prev" href="tut.html" title="Getting Started and Tutorial">
@ -30,7 +30,7 @@
The following elements can occur in a script:
</p>
<a name="autoindex.script_ref.simple_inclusions"></a><h5>
<a name="id490329"></a>
<a name="id744637"></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>
@ -93,7 +93,7 @@
</dl>
</div>
<a name="autoindex.script_ref.source_file_scanning"></a><h5>
<a name="id490575"></a>
<a name="id744839"></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>
@ -108,7 +108,7 @@
whose "type" attribute has the same category name.
</p>
<a name="autoindex.script_ref.directory_and_source_file_scanning"></a><h5>
<a name="id490663"></a>
<a name="id744905"></a>
<a class="link" href="script_ref.html#autoindex.script_ref.directory_and_source_file_scanning">Directory
and Source File Scanning</a>
</h5>
@ -135,7 +135,7 @@
</dl>
</div>
<a name="autoindex.script_ref.excluding_terms"></a><h5>
<a name="id541811"></a>
<a name="id745026"></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>
@ -147,7 +147,7 @@
included.
</p>
<a name="autoindex.script_ref.rewriting_section_names"></a><h5>
<a name="id541882"></a>
<a name="id745081"></a>
<a class="link" href="script_ref.html#autoindex.script_ref.rewriting_section_names">Rewriting Section
Names</a>
</h5>

38
doc/html/autoindex/tut.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>Getting Started and Tutorial</title>
<link rel="stylesheet" href="../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot_8125">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="../index.html" title="AutoIndex">
<link rel="up" href="../index.html" title="AutoIndex">
<link rel="prev" href="overview.html" title="Overview">
@ -27,7 +27,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="id473472"></a>
<a name="id736077"></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">
@ -51,12 +51,32 @@
<pre class="programlisting"><span class="identifier">bjam</span> <span class="identifier">release</span> <span class="identifier">gcc</span>
</pre>
<p>
Now open up your user-config.jam file and add the line:
Now open up your user-config.jam file and at the end add the line:
</p>
<pre class="programlisting">using auto-index : <span class="emphasis"><em>path-to-executable</em></span> ;
<pre class="programlisting">using auto-index : <span class="emphasis"><em>full-path-to-executable</em></span> ;
</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>
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
<p>
This declaration must go towards the end of user-config.jam, or in any case
after the Boostbook initialisation.
</p>
<p>
Also note that Windows users must use forward slashes in the paths in user-config.jam
</p>
</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.
</p>
<a name="autoindex.tut.step_2__configure_boost_build"></a><h5>
<a name="id473590"></a>
<a name="id736248"></a>
<a class="link" href="tut.html#autoindex.tut.step_2__configure_boost_build">Step 2: Configure
Boost.Build</a>
</h5>
@ -130,7 +150,7 @@
</dl>
</div>
<a name="autoindex.tut.step_3__add_indexes_to_your_documentation"></a><h5>
<a name="id473741"></a>
<a name="id744124"></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>
@ -170,7 +190,7 @@
<pre class="programlisting"><span class="char">''</span><span class="char">'&lt;index/&gt;'</span><span class="char">''</span>
</pre>
<a name="autoindex.tut.step_4__create_the_script_file"></a><h5>
<a name="id475177"></a>
<a name="id744221"></a>
<a class="link" href="tut.html#autoindex.tut.step_4__create_the_script_file">Step 4: Create
the script file</a>
</h5>
@ -243,7 +263,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__build_the_your_docs"></a><h5>
<a name="id490121"></a>
<a name="id744477"></a>
<a class="link" href="tut.html#autoindex.tut.step_5__build_the_your_docs">Step 5: Build the
Your Docs</a>
</h5>
@ -270,7 +290,7 @@
If you don't see that, or if it's indexing 0 terms then something is wrong!
</p>
<a name="autoindex.tut.step_6__iterate"></a><h5>
<a name="id490268"></a>
<a name="id744587"></a>
<a class="link" href="tut.html#autoindex.tut.step_6__iterate">Step 6: Iterate</a>
</h5>
<p>

6
doc/html/index.html
View File

@ -3,7 +3,7 @@
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>AutoIndex</title>
<link rel="stylesheet" href="boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot_8125">
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
<link rel="home" href="index.html" title="AutoIndex">
<link rel="next" href="autoindex/overview.html" title="Overview">
</head>
@ -28,7 +28,7 @@
</h3></div></div></div>
<div><p class="copyright">Copyright © 2008 John Maddock</p></div>
<div><div class="legalnotice">
<a name="id485631"></a><p>
<a name="id735815"></a><p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
</p>
@ -47,7 +47,7 @@
</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: November 29, 2008 at 18:49:02 GMT</small></p></td>
<td align="left"><p><small>Last revised: February 02, 2009 at 17:03:47 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>