From: srajko_at_[hidden]
Date: 2007-06-25 17:16:03
Author: srajko
Date: 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
New Revision: 7149
URL: http://svn.boost.org/trac/boost/changeset/7149
Log:
add built HTML docs
Added:
sandbox/template_under_construction/file_template/libs/file_template/doc/html/HTML.manifest (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/acknowledgements.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/license.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/changes.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/documentation.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/options.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/outside_docs.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/reference/
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/reference.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/reference/documentation.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/reference/options.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/reference/substitutions.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/start.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/substitutions.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/tools.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/use.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/changes.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/merges.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/options.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/phases/
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/phases.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/phases/examination.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/phases/invocation.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/phases/processing.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference/
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference/options.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference/results.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference/substitutions.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference/template.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/substitutions.html (contents, props changed)
sandbox/template_under_construction/file_template/libs/file_template/doc/html/index.html (contents, props changed)
Text files modified:
sandbox/template_under_construction/README | 2 +-
sandbox/template_under_construction/file_template/libs/file_template/build/xcodeide/file_template.xcodeproj/project.pbxproj | 2 ++
sandbox/template_under_construction/file_template/libs/file_template/doc/file_template.qbk | 2 +-
3 files changed, 4 insertions(+), 2 deletions(-)
Modified: sandbox/template_under_construction/README
==============================================================================
--- sandbox/template_under_construction/README (original)
+++ sandbox/template_under_construction/README 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -5,7 +5,7 @@
To make a new sandbox project from the template, try running:
-python make_template.py sandbox
+python file_template.py sandbox
in this directory.
Modified: sandbox/template_under_construction/file_template/libs/file_template/build/xcodeide/file_template.xcodeproj/project.pbxproj
==============================================================================
--- sandbox/template_under_construction/file_template/libs/file_template/build/xcodeide/file_template.xcodeproj/project.pbxproj (original)
+++ sandbox/template_under_construction/file_template/libs/file_template/build/xcodeide/file_template.xcodeproj/project.pbxproj 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -53,6 +53,7 @@
08B512580C2CDC9C00E85405 /* simple_template.py */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = text.script.python; path = simple_template.py; sourceTree = "<group>"; };
08B5125A0C2CDC9C00E85405 /* file.xyz */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = text; path = file.xyz; sourceTree = "<group>"; };
08DE94EA0C2C87B700E3D69A /* xcode_elements.py */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = text.script.python; name = xcode_elements.py; path = $template_library$.xcodeproj/xcode_elements.py; sourceTree = "<group>"; };
+ 08EFC18E0C30654000C730EC /* README */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = text; name = README; path = ../../../../../README; sourceTree = SOURCE_ROOT; };
08F005DD0C2B888F00093576 /* $template_library$.hpp */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.cpp.h; path = $template_library$.hpp; sourceTree = "<group>"; };
08F005DE0C2B888F00093576 /* $template_library$.hpp */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.cpp.h; path = $template_library$.hpp; sourceTree = "<group>"; };
08F005DF0C2B888F00093576 /* boost-build.jam */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.jam; path = "boost-build.jam"; sourceTree = "<group>"; };
@@ -114,6 +115,7 @@
isa = PBXGroup;
children = (
08F062730C283EA9005301DA /* file_template.py */,
+ 08EFC18E0C30654000C730EC /* README */,
0818EB840C26438D00DB816F /* test */,
0839351C0C23D9C700716EE7 /* doc */,
08F005D90C2B888F00093576 /* sandbox */,
Modified: sandbox/template_under_construction/file_template/libs/file_template/doc/file_template.qbk
==============================================================================
--- sandbox/template_under_construction/file_template/libs/file_template/doc/file_template.qbk (original)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/file_template.qbk 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -1,6 +1,6 @@
[library FileTemplate
[quickbook 1.4]
- [version 0.93]
+ [version 0.94]
[authors [Rajko, Stjepan]]
[copyright 2007 Stjepan Rajko]
[purpose generates file and directory trees from templates]
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/HTML.manifest
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/HTML.manifest 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,24 @@
+index.html
+filetemplate/sandbox.html
+filetemplate/sandbox/tools.html
+filetemplate/sandbox/use.html
+filetemplate/sandbox/outside_docs.html
+filetemplate/sandbox/reference.html
+filetemplate/sandbox/reference/options.html
+filetemplate/sandbox/reference/substitutions.html
+filetemplate/sandbox/reference/documentation.html
+filetemplate/sandbox/changes.html
+filetemplate/templates.html
+filetemplate/templates/phases.html
+filetemplate/templates/phases/invocation.html
+filetemplate/templates/phases/examination.html
+filetemplate/templates/phases/processing.html
+filetemplate/templates/merges.html
+filetemplate/templates/reference.html
+filetemplate/templates/reference/options.html
+filetemplate/templates/reference/substitutions.html
+filetemplate/templates/reference/template.html
+filetemplate/templates/reference/results.html
+filetemplate/templates/changes.html
+filetemplate/acknowledgements.html
+filetemplate/license.html
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/acknowledgements.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/acknowledgements.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,43 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Acknowledgements</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="prev" href="templates/changes.html" title=" Version History and
+ Proposed changes">
+<link rel="next" href="license.html" title=" License">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="templates/changes.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="license.html"><img src="../../../doc/html/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="filetemplate.acknowledgements"></a> Acknowledgements</h2></div></div></div>
+<p>
+ Thanks for Rene Rivera and Stefan Seefeld for their suggestions on the development
+ of FileTemplate.
+ </p>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="templates/changes.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="license.html"><img src="../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/license.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/license.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,41 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> License</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="prev" href="acknowledgements.html" title=" Acknowledgements">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="acknowledgements.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>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h2 class="title" style="clear: both">
+<a name="filetemplate.license"></a> License</h2></div></div></div>
+<p>
+ Copyright 2007 Stjepan Rajko. 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>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="acknowledgements.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>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,114 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Boost sandbox template</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="prev" href="../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="next" href="sandbox/tools.html" title=" Configuring the tools and
+ checking out the Boost sandbox">
+</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>
+<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="sandbox/tools.html"><img src="../../../doc/html/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="filetemplate.sandbox"></a> Boost sandbox template</h2></div></div></div>
+<div class="toc"><dl>
+<dt><span class="section"><a href="sandbox/tools.html"> Configuring the tools and
+ checking out the Boost sandbox</a></span></dt>
+<dt><span class="section"> Use Cases</span></dt>
+<dt><span class="section"><a href="sandbox/outside_docs.html"> Links to helpful
+ outside documentation</a></span></dt>
+<dt><span class="section"> Reference</span></dt>
+<dd><dl>
+<dt><span class="section"> Options</span></dt>
+<dt><span class="section"><a href="sandbox/reference/substitutions.html"> Substitution
+ templates</a></span></dt>
+<dt><span class="section"><a href="sandbox/reference/documentation.html"> Documentation
+ formats</a></span></dt>
+</dl></dd>
+<dt><span class="section"><a href="sandbox/changes.html"> Version History and Proposed
+ Changes</a></span></dt>
+</dl></div>
+<p>
+ The sandbox template is a template for Boost sandbox projects. Given some information
+ about the project (e.g., library name and author), it will generate the following:
+ </p>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ a directory tree for the library
+ </li>
+<li>
+ commonly used source, documentation and build files
+ </li>
+<li>
+ optionally, projects for several IDEs (currently, Xcode and MSVC)
+ </li>
+</ul></div>
+<p>
+ The content in the generated project contains a fill-in-the-blanks documentation,
+ and an implementation of a small class.
+ </p>
+<p>
+ If you need to download the tools required to build everything in the created
+ sandbox project, and/or you need to download the Boost sandbox, see the <a href="sandbox/tools.html" title=" Configuring the tools and
+ checking out the Boost sandbox">configuring and download</a> section.
+ </p>
+<p>
+ If you'd like some more information using the <a href="sandbox.html" title=" Boost sandbox template">sandbox
+ template</a>, please read the documentation on <a href="sandbox/use.html" title=" Use Cases">sandbox
+ use cases</a>.
+ </p>
+<p>
+ If you'd just like to try the sandbox template, go to the Boost subversion
+ and type <code class="literal">sandbox/template-under-construction</code> directory and
+ execute:
+ </p>
+<pre class="programlisting">python file_template.py sandbox
+</pre>
+<p>
+ The script will ask you some questions and create a project with the information
+ you specified.
+ </p>
+<div class="caution"><table border="0" summary="Caution">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../../../doc/html/images/caution.png"></td>
+<th align="left">Caution</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ The sandbox template is in very early stages of development. At this point,
+ it is likely <span class="bold"><strong>not</strong></span> a good starting point
+ for a boost sandbox project. It has not been verified that the projects
+ it generates adhere to Boost guidelines.
+ </p>
+<p>
+ </p>
+</td></tr>
+</table></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></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="sandbox/tools.html"><img src="../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/changes.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/changes.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,70 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Version History and Proposed
+ Changes</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../sandbox.html" title=" Boost sandbox template">
+<link rel="prev" href="reference/documentation.html" title=" Documentation
+ formats">
+<link rel="next" href="../templates.html" title=" FileTemplate templates">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reference/documentation.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="../templates.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.sandbox.changes"></a><a href="changes.html" title=" Version History and Proposed
+ Changes"> Version History and Proposed
+ Changes</a></h3></div></div></div>
+<a name="filetemplate.sandbox.changes.version_history"></a><h4>
+<a name="id904831"></a>
+ Version History
+ </h4>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ started supporting Xcode IDE generation
+ </li>
+<li>
+ the author option and template substitutions changed to authors to match
+ the quickbook syntax
+ </li>
+<li>
+ changed $template_cpp_copyright$ and $template_py_copyright$ to just $template_copyright$.
+ </li>
+</ul></div>
+<a name="filetemplate.sandbox.changes.proposed_changes"></a><h4>
+<a name="id904870"></a>
+ Proposed Changes
+ </h4>
+<div class="itemizedlist"><ul type="disc"><li>
+ In the MSVC projects, the Rebuild action is mapped to a <code class="literal">bjam -a</code>
+ invocation. This causes all projects required to be rebuilt, and might
+ not be the most common use case (i.e., if you want to rebuild the documentation,
+ you most likely don't want to rebuild quickbook). It might be better to
+ perform a clean followed by a build. However, this has the downside of
+ not being to be able to access <code class="literal">bjam -a</code> from the IDE.
+ </li></ul></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reference/documentation.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="../templates.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/documentation.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/documentation.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,80 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Documentation formats</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.92">
+<link rel="up" href="../sandbox.html" title=" Boost sandbox template">
+<link rel="prev" href="substitutions.html" title=" Substitution templates">
+<link rel="next" href="changes.html" title=" Proposed Changes">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<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>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="substitutions.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="changes.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.sandbox.documentation"></a> Documentation formats</h3></div></div></div>
+<p>
+ The sandbox template supports multiple documentation formats, specified through
+ the <code class="literal">docs</code> option. You can use:
+ </p>
+<div class="itemizedlist"><ul type="disc">
+<li>
+<code class="literal">qb</code>: Quickbook / docbook documentation only
+ </li>
+<li>
+<code class="literal">qb+doxyref</code>: Quickbook / docbook documentation with a
+ reference section generated by Doxygen (default).
+ </li>
+<li>
+<code class="literal">qb+doxy</code>: Quickbook / docbook documentation with a link
+ to the entire HTML documentation generated by Doxygen.
+ </li>
+</ul></div>
+<p>
+ The first two options are the most consistent with the documentation format
+ used in recent Boost libraries.
+ </p>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../doc/html/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ The <code class="literal">qb+doxy</code> option is a work in progress. It has been
+ added because it provides access to all documentation generated by Doxygen
+ (main and related pages, todo and bug lists, modules...), and not just
+ a subset of the reference. At this moment, using this option generates
+ two bodies of documentation which are not well connected visually and
+ navigationally. You should probably <span class="bold"><strong>not</strong></span>
+ use it
+ </p>
+<p>
+ </p>
+</td></tr>
+</table></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="substitutions.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="changes.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/options.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/options.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,137 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Options</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.92">
+<link rel="up" href="../sandbox.html" title=" Boost sandbox template">
+<link rel="prev" href="outside_docs.html" title=" Links to helpful
+ outside documentation">
+<link rel="next" href="substitutions.html" title=" Substitution templates">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<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>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="outside_docs.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="substitutions.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.sandbox.options"></a> Options</h3></div></div></div>
+<p>
+ The sandbox template allows the following options to be specified:
+ </p>
+<div class="table">
+<a name="id903994"></a><p class="title"><b>Table 1.1. Options used by the sandbox template</b></p>
+<table class="table" summary="Options used by the sandbox template">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ option
+ </p>
+ </th>
+<th>
+ <p>
+ desctiption
+ </p>
+ </th>
+<th>
+ <p>
+ default value
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ library
+ </p>
+ </td>
+<td>
+ <p>
+ Name of the library
+ </p>
+ </td>
+<td class="auto-generated"> </td>
+</tr>
+<tr>
+<td>
+ <p>
+ authors
+ </p>
+ </td>
+<td>
+ <p>
+ Comma separated list of authors
+ </p>
+ </td>
+<td class="auto-generated"> </td>
+</tr>
+<tr>
+<td>
+ <p>
+ docs
+ </p>
+ </td>
+<td>
+ <p>
+ Documentation format
+ - one of qb, qb+doxyref, qb+doxy
+ </p>
+ </td>
+<td>
+ <p>
+ qb+doxyref
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ vc8ide
+ </p>
+ </td>
+<td>
+ <p>
+ Specifies whether the IDE projects for MSVC 8.0 should be generated
+ </p>
+ </td>
+<td>
+ <p>
+ n
+ </p>
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+<p>
+ For more information about template options, and for other options provided
+ by FileTemplate, see the <a href="../templates/options.html" title=" Options">FileTemplate
+ options</a> documentation.
+ </p>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="outside_docs.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="substitutions.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/outside_docs.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/outside_docs.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,66 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Links to helpful
+ outside documentation</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../sandbox.html" title=" Boost sandbox template">
+<link rel="prev" href="use.html" title=" Use Cases">
+<link rel="next" href="reference.html" title=" Reference">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="use.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="reference.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.sandbox.outside_docs"></a><a href="outside_docs.html" title=" Links to helpful
+ outside documentation"> Links to helpful
+ outside documentation</a></h3></div></div></div>
+<p>
+ Some other information that might come in handy as you start working on your
+ project:
+ </p>
+<div class="itemizedlist"><ul type="disc">
+<li>
+<a href="http://www.boost.org/more/lib_guide.htm#Directory_structure" target="_top">Boost
+ library directory structure</a> - explains the suggested directory
+ structure for Boost libraries.
+ </li>
+<li>
+<a href="http://www.stack.nl/~dimitri/doxygen/commands.html" target="_top">Doxygen
+ command reference</a> - if you'd like to use Doxygen.
+ </li>
+<li>
+<a href="http://www.boost-consulting.com/boost/tools/quickbook/doc/html/index.html" target="_top">Quickbook
+ reference</a> - syntax usable in quickbok <code class="literal">.qbk</code> documentation
+ files.
+ </li>
+<li>
+<a href="http://docbook.sourceforge.net/release/xsl/current/doc/" target="_top">Docbook
+ XSL reference</a> - among other things, this explains some of the parameters
+ used in Jamfiles to customize the documentation generated through Quickbook/Docbook.
+ </li>
+</ul></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="use.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="reference.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/reference.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/reference.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,46 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Reference</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../sandbox.html" title=" Boost sandbox template">
+<link rel="prev" href="outside_docs.html" title=" Links to helpful
+ outside documentation">
+<link rel="next" href="reference/options.html" title=" Options">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="outside_docs.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="reference/options.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.sandbox.reference"></a> Reference</h3></div></div></div>
+<div class="toc"><dl>
+<dt><span class="section"> Options</span></dt>
+<dt><span class="section"><a href="reference/substitutions.html"> Substitution
+ templates</a></span></dt>
+<dt><span class="section"><a href="reference/documentation.html"> Documentation
+ formats</a></span></dt>
+</dl></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="outside_docs.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="reference/options.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/reference/documentation.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/reference/documentation.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,85 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Documentation
+ formats</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../reference.html" title=" Reference">
+<link rel="prev" href="substitutions.html" title=" Substitution
+ templates">
+<link rel="next" href="../changes.html" title=" Version History and Proposed
+ Changes">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="substitutions.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="../changes.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="filetemplate.sandbox.reference.documentation"></a><a href="documentation.html" title=" Documentation
+ formats"> Documentation
+ formats</a></h4></div></div></div>
+<p>
+ The sandbox template supports multiple documentation formats, specified
+ through the <code class="literal">docs</code> option. You can use:
+ </p>
+<div class="itemizedlist"><ul type="disc">
+<li>
+<code class="literal">qb</code>: Quickbook / docbook documentation only.
+ </li>
+<li>
+<code class="literal">qb+doxyref</code>: Quickbook / docbook documentation with
+ a reference section generated by Doxygen (default).
+ </li>
+<li>
+<code class="literal">qb+doxy</code>: Quickbook / docbook documentation with a
+ link to the entire HTML documentation generated by Doxygen.
+ </li>
+</ul></div>
+<p>
+ The first two options are the most consistent with the documentation format
+ used in recent Boost libraries.
+ </p>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../../doc/html/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ The <code class="literal">qb+doxy</code> option is a work in progress. It has
+ been added because it provides access to all documentation generated
+ by Doxygen (main and related pages, todo and bug lists, modules...),
+ and not just a subset of the reference. At this moment, using this
+ option generates two bodies of documentation which are not well connected
+ visually and navigationally. You should probably <span class="bold"><strong>not</strong></span>
+ use it.
+ </p>
+<p>
+ </p>
+</td></tr>
+</table></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="substitutions.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="../changes.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/reference/options.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/reference/options.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,155 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Options</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../reference.html" title=" Reference">
+<link rel="prev" href="../reference.html" title=" Reference">
+<link rel="next" href="substitutions.html" title=" Substitution
+ templates">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../reference.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="substitutions.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="filetemplate.sandbox.reference.options"></a> Options</h4></div></div></div>
+<p>
+ The sandbox template allows the following options to be specified:
+ </p>
+<div class="table">
+<a name="id904164"></a><p class="title"><b>Table 1.1. Options used by the sandbox template</b></p>
+<table class="table" summary="Options used by the sandbox template">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ option
+ </p>
+ </th>
+<th>
+ <p>
+ desctiption
+ </p>
+ </th>
+<th>
+ <p>
+ default value
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ library
+ </p>
+ </td>
+<td>
+ <p>
+ Name of the library
+ </p>
+ </td>
+<td class="auto-generated"> </td>
+</tr>
+<tr>
+<td>
+ <p>
+ authors
+ </p>
+ </td>
+<td>
+ <p>
+ Comma separated list of authors
+ </p>
+ </td>
+<td class="auto-generated"> </td>
+</tr>
+<tr>
+<td>
+ <p>
+ docs
+ </p>
+ </td>
+<td>
+ <p>
+ <a href="documentation.html" title=" Documentation
+ formats">Documentation
+ format</a> - one of qb, qb+doxyref, qb+doxy
+ </p>
+ </td>
+<td>
+ <p>
+ qb+doxyref
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ xcodeide
+ </p>
+ </td>
+<td>
+ <p>
+ Specifies whether the IDE projects for Xcode should be generated
+ </p>
+ </td>
+<td>
+ <p>
+ n
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ vc8ide
+ </p>
+ </td>
+<td>
+ <p>
+ Specifies whether the IDE projects for MSVC 8.0 should be generated
+ </p>
+ </td>
+<td>
+ <p>
+ n
+ </p>
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+<p>
+ For more information about template options, and for other options provided
+ by FileTemplate, see the <a href="../../templates/reference/options.html" title=" Options">template
+ options</a> documentation.
+ </p>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../reference.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="substitutions.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/reference/substitutions.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/reference/substitutions.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,298 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Substitution
+ templates</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../reference.html" title=" Reference">
+<link rel="prev" href="options.html" title=" Options">
+<link rel="next" href="documentation.html" title=" Documentation
+ formats">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="options.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="documentation.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="filetemplate.sandbox.reference.substitutions"></a><a href="substitutions.html" title=" Substitution
+ templates"> Substitution
+ templates</a></h4></div></div></div>
+<p>
+ The following substitutions are defined for file and directory names:
+ </p>
+<div class="table">
+<a name="id904359"></a><p class="title"><b>Table 1.2. File and directory name substitutions used by
+ the sandbox template</b></p>
+<table class="table" summary="File and directory name substitutions used by
+ the sandbox template">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ substitution template
+ </p>
+ </th>
+<th>
+ <p>
+ substituted text
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ $template_library$
+ </p>
+ </td>
+<td>
+ <p>
+ The library name specified by the user
+ </p>
+ </td>
+</tr></tbody>
+</table>
+</div>
+<div class="table">
+<a name="id904414"></a><p class="title"><b>Table 1.3. File content substitutions used by the
+ sandbox template</b></p>
+<table class="table" summary="File content substitutions used by the
+ sandbox template">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ substitution template
+ </p>
+ </th>
+<th>
+ <p>
+ substituted text
+ </p>
+ </th>
+<th>
+ <p>
+ extensions
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ $template_library$
+ </p>
+ </td>
+<td>
+ <p>
+ The library_name specified by the user
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_Library$
+ </p>
+ </td>
+<td>
+ <p>
+ Capitalized Library Name
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_LibraryConcat$
+ </p>
+ </td>
+<td>
+ <p>
+ Concatenated, capitalized LibraryName
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_LIBRARY$
+ </p>
+ </td>
+<td>
+ <p>
+ Uppercase LIBRARY_NAME
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_Boost_Library$
+ </p>
+ </td>
+<td>
+ <p>
+ The full Boost.Library Name name of the library
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_copyright$
+ </p>
+ </td>
+<td>
+ <p>
+ Python-style commented copyright block
+ </p>
+ </td>
+<td>
+ <p>
+ Jamfile,.jam,.v2,.qbk,.py
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_copyright$
+ </p>
+ </td>
+<td>
+ <p>
+ C++-style commented copyright block
+ </p>
+ </td>
+<td>
+ <p>
+ .hpp, .cpp
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_qbk_copyright$
+ </p>
+ </td>
+<td>
+ <p>
+ Copyright block with quickbook-style link
+ </p>
+ </td>
+<td>
+ <p>
+ .qbk
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_authors_reversed$
+ </p>
+ </td>
+<td>
+ <p>
+ Bracketed list of authors, last name first
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_authors$
+ </p>
+ </td>
+<td>
+ <p>
+ list of authors, as specified by the user
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_year$
+ </p>
+ </td>
+<td>
+ <p>
+ Current year
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="options.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="documentation.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/start.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/start.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,126 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Getting Started</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.91">
+<link rel="up" href="../sandbox.html" title=" Boost sandbox template">
+<link rel="prev" href="../sandbox.html" title=" Boost sandbox template">
+<link rel="next" href="options.html" title=" Options">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<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>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../sandbox.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="options.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.sandbox.start"></a> Getting Started</h3></div></div></div>
+<div class="important"><table border="0" summary="Important">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../doc/html/images/important.png"></td>
+<th align="left">Important</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ Some parts of the generated projects might not work with versions of
+ Boost older than CVS HEAD.
+ </p>
+<p>
+ </p>
+</td></tr>
+</table></div>
+<p>
+ To use the project created by the sandbox template fully, you will need a
+ few things.
+ </p>
+<p>
+ First of all, you should familiarize yourself with Boost. A good starting
+ point for this is <a href="http://www.boost.org/more/getting_started/index.html" target="_top">the
+ getting started page</a>. In particular, make sure you have installed
+ a recent version of Boost, and have a working bjam executable.
+ </p>
+<p>
+ Second, you will need to download some additional tools to build the documentation.
+ Instructions for this part can be found in the <a href="http://www.boost.org/doc/html/boostbook.html" target="_top">Boostbook
+ documentation</a> and the <a href="http://www.boost-consulting.com/boost/tools/quickbook/doc/html/quickbook/install.html" target="_top">Quickbook
+ documentation</a>. The projects generated by file_template rely on xsltproc,
+ DocBook XSL and DTD distributions, and Doxygen. The sandbox template does
+ not currently use Apache FOP.
+ </p>
+<div class="caution"><table border="0" summary="Caution">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../../../../doc/html/images/caution.png"></td>
+<th align="left">Caution</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ Make sure you download docbook-xsl and not docbook5-xsl.
+ </p>
+<p>
+ </p>
+</td></tr>
+</table></div>
+<p>
+ Finally, you will need access to the sandbox in the <a href="http://svn.boost.org/trac/boost/wiki/BoostSubversion" target="_top">Boost
+ subversion</a>. Follow the directions in the <a href="http://svn.boost.org/trac/boost/wiki/BoostSubversion" target="_top">Boost
+ subversion wiki</a>.
+ </p>
+<p>
+ Once you have all this in place, go to the template-under-construction folder
+ of the sandbox. Run the make_template.py script, and follow the instructions.
+ </p>
+<p>
+ You can also use the <a href="../templates/phases/invocation.html#filetemplate.templates.phases.invocation.command_line" title="
+ Command line">command
+ line</a> line to specify the options.
+ </p>
+<p>
+ Some other information that might come in handy as you start working on your
+ project:
+ </p>
+<div class="itemizedlist"><ul type="disc">
+<li>
+<a href="http://www.boost.org/more/lib_guide.htm#Directory_structure" target="_top">Boost
+ library directory structure</a> - explains the suggested directory
+ structure for Boost libraries.
+ </li>
+<li>
+<a href="http://www.stack.nl/~dimitri/doxygen/commands.html" target="_top">Doxygen
+ command reference</a> - if you'd like to use Doxygen.
+ </li>
+<li>
+<a href="http://www.boost-consulting.com/boost/tools/quickbook/doc/html/index.html" target="_top">Quickbook
+ reference</a> - syntax usable in quickbok <code class="literal">.qbk</code> documentation
+ files.
+ </li>
+<li>
+<a href="http://docbook.sourceforge.net/release/xsl/current/doc/" target="_top">Docbook
+ XSL reference</a> - among other things, this specifies parameters used
+ in Jamfiles to customize the documentation generated through Quickbook/Docbook.
+ </li>
+</ul></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../sandbox.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="options.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/substitutions.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/substitutions.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,294 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Substitution templates</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.92">
+<link rel="up" href="../sandbox.html" title=" Boost sandbox template">
+<link rel="prev" href="options.html" title=" Options">
+<link rel="next" href="documentation.html" title=" Documentation formats">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<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>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="options.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="documentation.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.sandbox.substitutions"></a> Substitution templates</h3></div></div></div>
+<p>
+ The following substitutions are defined for file and directory names:
+ </p>
+<div class="table">
+<a name="id904163"></a><p class="title"><b>Table 1.2. File and directory name substitutions used by the
+ sandbox template</b></p>
+<table class="table" summary="File and directory name substitutions used by the
+ sandbox template">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ substitution template
+ </p>
+ </th>
+<th>
+ <p>
+ substituted text
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ $template_library$
+ </p>
+ </td>
+<td>
+ <p>
+ The library name specified by the user
+ </p>
+ </td>
+</tr></tbody>
+</table>
+</div>
+<div class="table">
+<a name="id904217"></a><p class="title"><b>Table 1.3. File content substitutions used by the
+ sandbox template</b></p>
+<table class="table" summary="File content substitutions used by the
+ sandbox template">
+<colgroup>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ substitution template
+ </p>
+ </th>
+<th>
+ <p>
+ substituted text
+ </p>
+ </th>
+<th>
+ <p>
+ extensions
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ $template_library$
+ </p>
+ </td>
+<td>
+ <p>
+ The library_name specified by the user
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_Library$
+ </p>
+ </td>
+<td>
+ <p>
+ Capitalized Library Name
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_LibraryConcat$
+ </p>
+ </td>
+<td>
+ <p>
+ Concatenated, capitalized LibraryName
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_LIBRARY$
+ </p>
+ </td>
+<td>
+ <p>
+ Uppercase LIBRARY_NAME
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_Boost_Library$
+ </p>
+ </td>
+<td>
+ <p>
+ The full Boost.Library Name name of the library
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_copyright$
+ </p>
+ </td>
+<td>
+ <p>
+ Python-style commented copyright block
+ </p>
+ </td>
+<td>
+ <p>
+ Jamfile,.jam,.v2
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_copyright$
+ </p>
+ </td>
+<td>
+ <p>
+ C++-style commented copyright block
+ </p>
+ </td>
+<td>
+ <p>
+ .hpp, .cpp
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_qbk_copyright$
+ </p>
+ </td>
+<td>
+ <p>
+ Copyright block with quickbook-style link
+ </p>
+ </td>
+<td>
+ <p>
+ .qbk
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_authors_reversed$
+ </p>
+ </td>
+<td>
+ <p>
+ Bracketed list of authors, last name first
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_authors$
+ </p>
+ </td>
+<td>
+ <p>
+ list of authors, as specified by the user
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ $template_year$
+ </p>
+ </td>
+<td>
+ <p>
+ Current year
+ </p>
+ </td>
+<td>
+ <p>
+ general
+ </p>
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="options.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="documentation.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/tools.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/tools.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,108 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Configuring the tools and
+ checking out the Boost sandbox</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../sandbox.html" title=" Boost sandbox template">
+<link rel="prev" href="../sandbox.html" title=" Boost sandbox template">
+<link rel="next" href="use.html" title=" Use Cases">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../sandbox.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="use.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.sandbox.tools"></a><a href="tools.html" title=" Configuring the tools and
+ checking out the Boost sandbox"> Configuring the tools and
+ checking out the Boost sandbox</a></h3></div></div></div>
+<div class="important"><table border="0" summary="Important">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Important]" src="../../../../doc/html/images/important.png"></td>
+<th align="left">Important</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ Some parts of the generated projects might not work with versions of
+ Boost older than CVS HEAD.
+ </p>
+<p>
+ </p>
+</td></tr>
+</table></div>
+<p>
+ To use the project created by the sandbox template fully, you will need a
+ few things.
+ </p>
+<p>
+ First of all, you should familiarize yourself with Boost. A good starting
+ point for this is <a href="http://www.boost.org/more/getting_started/index.html" target="_top">the
+ getting started page</a>. In particular, make sure you have installed
+ a recent version of Boost, and have a working bjam executable.
+ </p>
+<p>
+ Second, you will need to download some additional tools to build the documentation.
+ Instructions for this part can be found in the <a href="http://www.boost.org/doc/html/boostbook.html" target="_top">Boostbook
+ documentation</a> and the <a href="http://www.boost-consulting.com/boost/tools/quickbook/doc/html/quickbook/install.html" target="_top">Quickbook
+ documentation</a>. The projects generated by file_template rely on xsltproc,
+ DocBook XSL and DTD distributions, and (optionally) Doxygen. The sandbox
+ template does not currently use Apache FOP.
+ </p>
+<div class="caution"><table border="0" summary="Caution">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="../../../../doc/html/images/caution.png"></td>
+<th align="left">Caution</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ Make sure you download docbook-xsl and not docbook5-xsl.
+ </p>
+<p>
+ </p>
+</td></tr>
+</table></div>
+<p>
+ Also, you will need access to the sandbox in the <a href="http://svn.boost.org/trac/boost/wiki/BoostSubversion" target="_top">Boost
+ subversion</a>. Follow the directions in the <a href="http://svn.boost.org/trac/boost/wiki/BoostSubversion" target="_top">Boost
+ subversion wiki</a>.
+ </p>
+<p>
+ Finally, you will need a python interpreter.
+ if you don't have one already. FileTemplate is compatibile with python
+ version 2.3, but the sandbox template
+ Xcode and MSVC IDE project generators require the <a href="http://cheeseshop.python.org/pypi/uuid" target="_top">UUID
+ module</a> which started shipping only with version 2.5 (although it
+ works with 2.3).
+ </p>
+<p>
+ Once you have all this in place, you can go to the template-under-construction
+ folder of the sandbox, and try the FileTemplate script. The <a href="use.html" title=" Use Cases">sandbox
+ use cases</a> section provides some common examples.
+ </p>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../sandbox.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="use.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/use.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/sandbox/use.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,302 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Use Cases</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../sandbox.html" title=" Boost sandbox template">
+<link rel="prev" href="tools.html" title=" Configuring the tools and
+ checking out the Boost sandbox">
+<link rel="next" href="outside_docs.html" title=" Links to helpful
+ outside documentation">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tools.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="outside_docs.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.sandbox.use"></a> Use Cases</h3></div></div></div>
+<p>
+ The following examples illustrate a few tasks you can achieve using the sandbox
+ template by executing the <code class="computeroutput"><span class="identifier">file_template</span><span class="special">.</span><span class="identifier">py</span></code> script
+ from the <code class="computeroutput"><span class="identifier">template</span><span class="special">-</span><span class="identifier">under</span><span class="special">-</span><span class="identifier">construction</span></code> directory of the <a href="tools.html" title=" Configuring the tools and
+ checking out the Boost sandbox">Boost
+ Sandbox</a>.
+ </p>
+<p>
+ <span class="bold"><strong>To start a new sandbox project (the script will ask
+ you for any required information):</strong></span>
+ </p>
+<pre class="programlisting">
+<span class="identifier">python</span> <span class="identifier">file_template</span><span class="special">.</span><span class="identifier">py</span> <span class="identifier">sandbox</span>
+</pre>
+<p>
+ <code class="literal">sandbox</code> specifies the root directory of the template.
+ </p>
+<p>
+ <span class="bold"><strong>To start a new sandbox project and provide the required
+ information in the <a href="../templates/phases/invocation.html#filetemplate.templates.phases.invocation.command_line" title="
+ Command line">command
+ line</a>:</strong></span>
+ </p>
+<pre class="programlisting">python file_template.py sandbox library=my_library "authors=John J. Doe"
+</pre>
+<p>
+ <code class="literal">library</code> and <code class="literal">authors</code> are <a href="reference/options.html" title=" Options">sandbox
+ options</a>.
+ </p>
+<div class="tip"><table border="0" summary="Tip">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../doc/html/images/tip.png"></td>
+<th align="left">Tip</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ To include an author with multiple last names, use the <code class="literal">_</code>
+ character instead of spaces (e.g., "authors=Jan De_Man")
+ </p>
+<p>
+ </p>
+</td></tr>
+</table></div>
+<p>
+ <span class="bold"><strong>To place the result in a particular destination directory:</strong></span>
+ </p>
+<pre class="programlisting">python file_template.py destination=/boost_sandbox sandbox
+</pre>
+<p>
+ <code class="literal">destination</code> is a <a href="../templates/reference/options.html" title=" Options">global
+ option</a>, and specifies where the result is constructed.
+ </p>
+<div class="warning"><table border="0" summary="Warning">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Warning]" src="../../../../doc/html/images/warning.png"></td>
+<th align="left">Warning</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ The following use cases are works in progress, and will produce half-baked
+ results. In, particular, generated Xcode IDE projects should contain
+ the correct Targets to invoke bjam on docs, tests, and examples, but
+ they will not reference any of the source files in the project. Also,
+ any existing code integrated into the template (last listed use case)
+ will be intelligently recognized by only some parts of the <a href="../sandbox.html" title=" Boost sandbox template">sandbox
+ template</a>.
+ </p>
+<p>
+ </p>
+</td></tr>
+</table></div>
+<p>
+ <span class="bold"><strong>To start a new sandbox project with the optional Xcode
+ and MSVC IDE projects and a non-default documentation format:</strong></span>
+ </p>
+<pre class="programlisting">python file_template.py sandbox library=file_template "authors=Stjepan Rajko" docs=qb xcodeide=y vc8ide=y
+</pre>
+<p>
+ <code class="literal">docs</code>, <code class="literal">xcodeide</code> and <code class="literal">vc8ide</code>
+ are sandbox options.
+ </p>
+<p>
+ <span class="bold"><strong>To integrate existing code into a new sandbox project:</strong></span>
+ </p>
+<pre class="programlisting">python file_template.py sandbox library=my_library "authors=John Doe,Jane Dough" fignore=.hpp fignore=.cpp
+ (...) /path/to/existing/my_library into=my_library
+</pre>
+<p>
+ <code class="literal">fignore</code> is a <a href="../templates/reference/options.html" title=" Options">template
+ option</a> which will cause the processor to ignore any files in the
+ sandbox template with the specified
+ suffix. <code class="literal">into</code> specifies that the existing my_library code
+ should go into the my_library directory of the destination tree.
+ </p>
+<p>
+ This assumes that any content under =/path/to/existing/my_library has a structure
+ compatibile with the sandbox template,
+ i.e. something like:
+ </p>
+<pre class="programlisting">/boost
+ /my_library
+ /libs
+ /my_library
+ /doc
+ /test
+ ...
+</pre>
+<p>
+ If <code class="literal">my_library</code> was the only thing inside <code class="literal">/path/to/existing</code>,
+ we chould just use <code class="literal">/path/to/existing</code> as the template,
+ and omit the <code class="literal">into</code> <a href="../templates/reference/options.html" title=" Options">template
+ option</a>.
+ </p>
+<a name="filetemplate.sandbox.use.for_more_information___"></a><h4>
+<a name="id903927"></a>
+ <a href="use.html#filetemplate.sandbox.use.for_more_information___">For more
+ information...</a>
+ </h4>
+<div class="itemizedlist"><ul type="disc">
+<li>
+sandbox options
+ reference
+ </li>
+<li>
+<a href="reference/substitutions.html" title=" Substitution
+ templates">sandbox substitution
+ templates</a> reference
+ </li>
+<li><a href="outside_docs.html" title=" Links to helpful
+ outside documentation">links to helpful outside
+ documentation</a></li>
+</ul></div>
+<a name="filetemplate.sandbox.use.output_of_a_sample_session"></a><h4>
+<a name="id903991"></a>
+ <a href="use.html#filetemplate.sandbox.use.output_of_a_sample_session">Output
+ of a sample session</a>
+ </h4>
+<pre class="programlisting">python.exe file_template.py <span class="bold"><strong>sandbox</strong></span>
+/-------------------------------------------
+| Processing template sandbox with options:
++---
+|| {'ignore': set([]), 'template': 'sandbox'}
+|/-------------------------------------------
+|| Examining the template project tree...
+|+---
+|||
+||/-------------------------------------------
+||| Welcome to the Boost Sandbox template.
+||+---
+||/-------------------------------------------
+||| <span class="bold"><strong>Enter value for option library:</strong></span>
+||+---
+||| <span class="bold"><strong>(all lowercase, use underscores to separate words, e.g. "my_library"): my_library</strong></span>
+||/-------------------------------------------
+||| <span class="bold"><strong>Enter value for option authors:
+||+---
+||| (comma separated, no spaces outside names, e.g., "My Name,Notmy R. Name": Stjepan Rajko</strong></span>
+||| $template_library$
+||| $template_library$/boost
+||| $template_library$/boost/$template_library$
+||| $template_library$/libs
+||| $template_library$/libs/$template_library$
+||| $template_library$/libs/$template_library$/build
+||| $template_library$/libs/$template_library$/test
+||| $template_library$/libs/$template_library$/doc
+||| $template_library$/libs/$template_library$/doc\html
+||| $template_library$/libs/$template_library$/doc/html/images
+||| $template_library$/libs/$template_library$/src
+||| $template_library$/libs/$template_library$/example
+/-------------------------------------------
+| Preparing destination tree...
++---
+|/-------------------------------------------
+|| Directories:
+|+---
+|| my_library
+|| my_library/boost
+|| my_library/libs
+|| my_library/boost/my_library
+|| my_library/libs/my_library
+|| my_library/libs/my_library/build
+|| my_library/libs/my_library/test
+|| my_library/libs/my_library/doc
+|| my_library/libs/my_library/src
+|| my_library/libs/my_library/example
+|| my_library/libs/my_library/doc/html
+|| my_library/libs/my_library/doc/html/images
+|/-------------------------------------------
+|| Files:
+|+---
+|| my_library/LICENSE_1_0.txt
+|| my_library/boost-build.jam
+|| my_library/Jamfile.v2
+|| my_library/project-root.jam
+|| my_library/boost/my_library.hpp
+|| my_library/boost/my_library/my_library.hpp
+|| my_library/libs/my_library/test/test.cpp
+|| my_library/libs/my_library/test/Jamfile.v2
+|| my_library/libs/my_library/doc/html/reference.css
+|| my_library/libs/my_library/doc/html/boostbook.css
+|| my_library/libs/my_library/doc/html/images/prev.png
+|| my_library/libs/my_library/doc/html/images/tip.png
+|| my_library/libs/my_library/doc/html/images/important.png
+|| my_library/libs/my_library/doc/html/images/next.png
+|| my_library/libs/my_library/doc/html/images/toc-minus.png
+|| my_library/libs/my_library/doc/html/images/draft.png
+|| my_library/libs/my_library/doc/html/images/caution.png
+|| my_library/libs/my_library/doc/html/images/Thumbs.db
+|| my_library/libs/my_library/doc/html/images/up.png
+|| my_library/libs/my_library/doc/html/images/note.png
+|| my_library/libs/my_library/doc/html/images/warning.png
+|| my_library/libs/my_library/doc/html/images/toc-plus.png
+|| my_library/libs/my_library/doc/html/images/blank.png
+|| my_library/libs/my_library/doc/html/images/home.png
+|| my_library/libs/my_library/doc/html/images/toc-blank.png
+|| my_library/libs/my_library/example/example.cpp
+|| my_library/libs/my_library/example/Jamfile.v2
+|| my_library/libs/my_library/doc/my_library.qbk
+|| my_library/libs/my_library/doc/Jamfile.v2
+/-------------------------------------------
+| Creating file tree from template...
++---
+|/-------------------------------------------
+|| Python files...
+|+---
+||| ./my_library/libs/my_library/doc/my_library.qbk
+||| ./my_library/libs/my_library/doc/Jamfile.v2
+|/-------------------------------------------
+|| Files...
+|+---
+||| ./my_library/LICENSE_1_0.txt
+||| ./my_library/boost-build.jam
+||| ./my_library/Jamfile.v2
+||| ./my_library/project-root.jam
+||| ./my_library/boost/my_library.hpp
+||| ./my_library/boost/my_library/my_library.hpp
+||| ./my_library/libs/my_library/test/test.cpp
+||| ./my_library/libs/my_library/test/Jamfile.v2
+||| ./my_library/libs/my_library/doc/html/reference.css
+||| ./my_library/libs/my_library/doc/html/boostbook.css
+||| ./my_library/libs/my_library/doc/html/images/prev.png
+||| ./my_library/libs/my_library/doc/html/images/tip.png
+||| ./my_library/libs/my_library/doc/html/images/important.png
+||| ./my_library/libs/my_library/doc/html/images/next.png
+||| ./my_library/libs/my_library/doc/html/images/toc-minus.png
+||| ./my_library/libs/my_library/doc/html/images/draft.png
+||| ./my_library/libs/my_library/doc/html/images/caution.png
+||| ./my_library/libs/my_library/doc/html/images/Thumbs.db
+||| ./my_library/libs/my_library/doc/html/images/up.png
+||| ./my_library/libs/my_library/doc/html/images/note.png
+||| ./my_library/libs/my_library/doc/html/images/warning.png
+||| ./my_library/libs/my_library/doc/html/images/toc-plus.png
+||| ./my_library/libs/my_library/doc/html/images/blank.png
+||| ./my_library/libs/my_library/doc/html/images/home.png
+||| ./my_library/libs/my_library/doc/html/images/toc-blank.png
+||| ./my_library/libs/my_library/example/example.cpp
+||| ./my_library/libs/my_library/example/Jamfile.v2
+</pre>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tools.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../sandbox.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="outside_docs.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,85 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> FileTemplate templates</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="prev" href="sandbox/changes.html" title=" Version History and Proposed
+ Changes">
+<link rel="next" href="templates/phases.html" title=" Processing phases">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="sandbox/changes.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="templates/phases.html"><img src="../../../doc/html/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="filetemplate.templates"></a> FileTemplate templates</h2></div></div></div>
+<div class="toc"><dl>
+<dt><span class="section"> Processing phases</span></dt>
+<dd><dl>
+<dt><span class="section"> Invocation</span></dt>
+<dd><dl><dt><span class="section"><a href="templates/phases/invocation.html#filetemplate.templates.phases.invocation.command_line">
+ Command line</a></span></dt></dl></dd>
+<dt><span class="section"><a href="templates/phases/examination.html"> Examination
+ of the template tree</a></span></dt>
+<dd><dl><dt><span class="section"><a href="templates/phases/examination.html#filetemplate.templates.phases.examination.template_script">
+ Template scripts</a></span></dt></dl></dd>
+<dt><span class="section"><a href="templates/phases/processing.html"> Producing
+ the resulting file tree</a></span></dt>
+<dd><dl><dt><span class="section"><a href="templates/phases/processing.html#filetemplate.templates.phases.processing.python_file">
+ Python generated files</a></span></dt></dl></dd>
+</dl></dd>
+<dt><span class="section"> Template merges</span></dt>
+<dt><span class="section"> Reference</span></dt>
+<dd><dl>
+<dt><span class="section"> Options</span></dt>
+<dt><span class="section"><a href="templates/reference/substitutions.html"> Substitution
+ templates and special templates</a></span></dt>
+<dt><span class="section"><a href="templates/reference/template.html"> Template
+ object</a></span></dt>
+<dt><span class="section"><a href="templates/reference/results.html"> Results
+ object</a></span></dt>
+</dl></dd>
+<dt><span class="section"><a href="templates/changes.html"> Version History and
+ Proposed changes</a></span></dt>
+</dl></div>
+<p>
+ The FileTemplate processor offers basic functionality when dealing with file
+ / directory templates. It copies a template directory tree into a new location,
+ renaming files where applicable, substituting the contents where specified,
+ and processing scripts embedded in the template tree.
+ </p>
+<p>
+ To get a general idea of how this is done, please read the <a href="templates/phases.html" title=" Processing phases">processing
+ phases</a> documentation.
+ </p>
+<p>
+ To learn about creating new templates or extending existing templates, you
+ should also read about <a href="templates/reference/options.html" title=" Options">template
+ options</a> and <a href="templates/reference/substitutions.html" title=" Substitution
+ templates and special templates">substitution
+ templates</a>.
+ </p>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="sandbox/changes.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="templates/phases.html"><img src="../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/changes.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/changes.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,78 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Version History and
+ Proposed changes</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../templates.html" title=" FileTemplate templates">
+<link rel="prev" href="reference/results.html" title=" Results
+ object">
+<link rel="next" href="../acknowledgements.html" title=" Acknowledgements">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reference/results.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../templates.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="../acknowledgements.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.templates.changes"></a><a href="changes.html" title=" Version History and
+ Proposed changes"> Version History and
+ Proposed changes</a></h3></div></div></div>
+<a name="filetemplate.templates.changes.version_history"></a><h4>
+<a name="id908124"></a>
+ Version History
+ </h4>
+<p>
+ <span class="bold"><strong>version 0.94</strong></span>
+ </p>
+<div class="itemizedlist"><ul type="disc">
+<li>
+<code class="literal">make_template.py</code> changed to <code class="literal">file_template.py</code>
+</li>
+<li>
+<code class="computeroutput"><span class="identifier">template</span><span class="special">.</span><span class="identifier">all_content_replacement</span></code> changed to <code class="computeroutput"><span class="identifier">template</span><span class="special">.</span><span class="identifier">general_content_replacement</span></code>
+</li>
+<li>
+ added <code class="computeroutput"><span class="identifier">template</span><span class="special">.</span><span class="identifier">ignore</span></code> function which can ignore any
+ file/directory in the source tree (available as <code class="literal">ignore=</code>
+ command line option)
+ </li>
+<li>
+ added testing
+ </li>
+<li>
+ made to work on non-windows and on Python 2.3
+ </li>
+</ul></div>
+<a name="filetemplate.templates.changes.proposed_changes"></a><h4>
+<a name="id908254"></a>
+ <a href="changes.html#filetemplate.templates.changes.proposed_changes">Proposed
+ Changes</a>
+ </h4>
+<div class="itemizedlist"><ul type="disc"><li>
+ a <code class="literal">no-scripts</code> option should be introduced to disallow
+ processing of in-template scripts (in case a template should be copied
+ verbatim with minor processing to make another template)
+ </li></ul></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="reference/results.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../templates.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="../acknowledgements.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/merges.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/merges.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,52 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Template merges</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../templates.html" title=" FileTemplate templates">
+<link rel="prev" href="phases/processing.html" title=" Producing
+ the resulting file tree">
+<link rel="next" href="reference.html" title=" Reference">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="phases/processing.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../templates.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="reference.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.templates.merges"></a> Template merges</h3></div></div></div>
+<p>
+ FileTemplate can be used to merge results created by several templates. If
+ a template uses the <a href="reference/results.html" title=" Results
+ object">results
+ object</a> to customize its output based on files created by all processed
+ templates, this can be used to seamlessly integrate additional files in the
+ template results.
+ </p>
+<p>
+ The sandbox template uses this
+ to allow additional files (e.g., existing source code) to be integrated in
+ the newly created Boost sandbox library project.
+ </p>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="phases/processing.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../templates.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="reference.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/options.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/options.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,347 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Options</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.92">
+<link rel="up" href="../templates.html" title=" FileTemplate templates">
+<link rel="prev" href="phases/processing.html" title=" Producing
+ the resulting file tree">
+<link rel="next" href="substitutions.html" title=" Substitution templates
+ and special templates">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<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>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="phases/processing.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../templates.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="substitutions.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.templates.options"></a> Options</h3></div></div></div>
+<p>
+ Options are used to fine-tune the behavior of the FileTemplate template processor
+ as well as the behavior of the template.
+ </p>
+<a name="filetemplate.templates.options.global_options"></a><h4>
+<a name="id905417"></a>
+ Global options
+ </h4>
+<p>
+ <span class="emphasis"><em>Global options</em></span> govern the behavior of the template processor.
+ </p>
+<div class="table">
+<a name="id905439"></a><p class="title"><b>Table 1.5. Global options</b></p>
+<table class="table" summary="Global options">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ option
+ </p>
+ </th>
+<th>
+ <p>
+ desctiption
+ </p>
+ </th>
+<th>
+ <p>
+ valid values
+ </p>
+ </th>
+<th>
+ <p>
+ default value
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ destination
+ </p>
+ </td>
+<td>
+ <p>
+ Destination directory where the results will be constructed.
+ </p>
+ </td>
+<td>
+ <p>
+ valid directory path (will be created if it does not exist)
+ </p>
+ </td>
+<td>
+ <p>
+ current directory
+ </p>
+ </td>
+</tr></tbody>
+</table>
+</div>
+<a name="filetemplate.templates.options.template_options"></a><h4>
+<a name="id905525"></a>
+ <a href="options.html#filetemplate.templates.options.template_options">Template
+ options</a>
+ </h4>
+<p>
+ <span class="emphasis"><em>Template options</em></span> can be used to specify how a particular
+ template is processed. Templates may use additional, template-specific options,
+ as is the case with <a href="../sandbox/reference/options.html" title=" Options">sandbox
+ options</a>.
+ </p>
+<div class="table">
+<a name="id905558"></a><p class="title"><b>Table 1.6. Template options</b></p>
+<table class="table" summary="Template options">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ option
+ </p>
+ </th>
+<th>
+ <p>
+ desctiption
+ </p>
+ </th>
+<th>
+ <p>
+ valid values
+ </p>
+ </th>
+<th>
+ <p>
+ default value
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ template
+ </p>
+ </td>
+<td>
+ <p>
+ Template directory
+ </p>
+ </td>
+<td>
+ <p>
+ valid directory
+ </p>
+ </td>
+<td>
+ <p>
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ into
+ </p>
+ </td>
+<td>
+ <p>
+ Determines where the output of the template will be placed inside the
+ resulting tree
+ </p>
+ </td>
+<td>
+ <p>
+ valid directoy in resulting tree
+ </p>
+ </td>
+<td>
+ <p>
+ root of the resulting tree
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ ignore
+ </p>
+ </td>
+<td>
+ <p>
+ Ignores a directory of the source template tree
+ </p>
+ </td>
+<td>
+ <p>
+ directory in source template tree
+ </p>
+ </td>
+<td>
+ <p>
+ </p>
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+<p>
+ Options can be specified using the command line. See the <a href="phases/invocation.html" title=" Invocation">invocation
+ phase</a> reference for more information. If an option is not specified
+ in the command line, and it has no default value, the user will be prompted
+ for the value.
+ </p>
+<p>
+ This is the output of a sample session:
+ </p>
+<pre class="programlisting">python.exe make_template.py <span class="bold"><strong>sandbox</strong></span>
+/-------------------------------------------
+| Processing template sandbox with options:
++---
+|| {'ignore': set([]), 'template': 'sandbox'}
+|/-------------------------------------------
+|| Examining the template project tree...
+|+---
+|||
+||/-------------------------------------------
+||| Welcome to the Boost Sandbox template.
+||+---
+||/-------------------------------------------
+||| <span class="bold"><strong>Enter value for option library:</strong></span>
+||+---
+||| <span class="bold"><strong>(all lowercase, use underscores to separate words, e.g. "my_library"): my_library</strong></span>
+||/-------------------------------------------
+||| <span class="bold"><strong>Enter value for option authors:
+||+---
+||| (comma separated, no spaces outside names, e.g., "My Name,Notmy R. Name": Stjepan Rajko</strong></span>
+||| $template_library$
+||| $template_library$/boost
+||| $template_library$/boost/$template_library$
+||| $template_library$/libs
+||| $template_library$/libs/$template_library$
+||| $template_library$/libs/$template_library$/build
+||| $template_library$/libs/$template_library$/test
+||| $template_library$/libs/$template_library$/doc
+||| $template_library$/libs/$template_library$/doc\html
+||| $template_library$/libs/$template_library$/doc/html/images
+||| $template_library$/libs/$template_library$/src
+||| $template_library$/libs/$template_library$/example
+/-------------------------------------------
+| Preparing destination tree...
++---
+|/-------------------------------------------
+|| Directories:
+|+---
+|| my_library
+|| my_library/boost
+|| my_library/libs
+|| my_library/boost/my_library
+|| my_library/libs/my_library
+|| my_library/libs/my_library/build
+|| my_library/libs/my_library/test
+|| my_library/libs/my_library/doc
+|| my_library/libs/my_library/src
+|| my_library/libs/my_library/example
+|| my_library/libs/my_library/doc/html
+|| my_library/libs/my_library/doc/html/images
+|/-------------------------------------------
+|| Files:
+|+---
+|| my_library/LICENSE_1_0.txt
+|| my_library/boost-build.jam
+|| my_library/Jamfile.v2
+|| my_library/project-root.jam
+|| my_library/boost/my_library.hpp
+|| my_library/boost/my_library/my_library.hpp
+|| my_library/libs/my_library/test/test.cpp
+|| my_library/libs/my_library/test/Jamfile.v2
+|| my_library/libs/my_library/doc/html/reference.css
+|| my_library/libs/my_library/doc/html/boostbook.css
+|| my_library/libs/my_library/doc/html/images/prev.png
+|| my_library/libs/my_library/doc/html/images/tip.png
+|| my_library/libs/my_library/doc/html/images/important.png
+|| my_library/libs/my_library/doc/html/images/next.png
+|| my_library/libs/my_library/doc/html/images/toc-minus.png
+|| my_library/libs/my_library/doc/html/images/draft.png
+|| my_library/libs/my_library/doc/html/images/caution.png
+|| my_library/libs/my_library/doc/html/images/Thumbs.db
+|| my_library/libs/my_library/doc/html/images/up.png
+|| my_library/libs/my_library/doc/html/images/note.png
+|| my_library/libs/my_library/doc/html/images/warning.png
+|| my_library/libs/my_library/doc/html/images/toc-plus.png
+|| my_library/libs/my_library/doc/html/images/blank.png
+|| my_library/libs/my_library/doc/html/images/home.png
+|| my_library/libs/my_library/doc/html/images/toc-blank.png
+|| my_library/libs/my_library/example/example.cpp
+|| my_library/libs/my_library/example/Jamfile.v2
+|| my_library/libs/my_library/doc/my_library.qbk
+|| my_library/libs/my_library/doc/Jamfile.v2
+/-------------------------------------------
+| Creating file tree from template...
++---
+|/-------------------------------------------
+|| Python files...
+|+---
+||| ./my_library/libs/my_library/doc/my_library.qbk
+||| ./my_library/libs/my_library/doc/Jamfile.v2
+|/-------------------------------------------
+|| Files...
+|+---
+||| ./my_library/LICENSE_1_0.txt
+||| ./my_library/boost-build.jam
+||| ./my_library/Jamfile.v2
+||| ./my_library/project-root.jam
+||| ./my_library/boost/my_library.hpp
+||| ./my_library/boost/my_library/my_library.hpp
+||| ./my_library/libs/my_library/test/test.cpp
+||| ./my_library/libs/my_library/test/Jamfile.v2
+||| ./my_library/libs/my_library/doc/html/reference.css
+||| ./my_library/libs/my_library/doc/html/boostbook.css
+||| ./my_library/libs/my_library/doc/html/images/prev.png
+||| ./my_library/libs/my_library/doc/html/images/tip.png
+||| ./my_library/libs/my_library/doc/html/images/important.png
+||| ./my_library/libs/my_library/doc/html/images/next.png
+||| ./my_library/libs/my_library/doc/html/images/toc-minus.png
+||| ./my_library/libs/my_library/doc/html/images/draft.png
+||| ./my_library/libs/my_library/doc/html/images/caution.png
+||| ./my_library/libs/my_library/doc/html/images/Thumbs.db
+||| ./my_library/libs/my_library/doc/html/images/up.png
+||| ./my_library/libs/my_library/doc/html/images/note.png
+||| ./my_library/libs/my_library/doc/html/images/warning.png
+||| ./my_library/libs/my_library/doc/html/images/toc-plus.png
+||| ./my_library/libs/my_library/doc/html/images/blank.png
+||| ./my_library/libs/my_library/doc/html/images/home.png
+||| ./my_library/libs/my_library/doc/html/images/toc-blank.png
+||| ./my_library/libs/my_library/example/example.cpp
+||| ./my_library/libs/my_library/example/Jamfile.v2
+</pre>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="phases/processing.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../templates.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="substitutions.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/phases.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/phases.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,51 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Processing phases</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../templates.html" title=" FileTemplate templates">
+<link rel="prev" href="../templates.html" title=" FileTemplate templates">
+<link rel="next" href="phases/invocation.html" title=" Invocation">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../templates.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../templates.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="phases/invocation.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.templates.phases"></a> Processing phases</h3></div></div></div>
+<div class="toc"><dl>
+<dt><span class="section"> Invocation</span></dt>
+<dd><dl><dt><span class="section"><a href="phases/invocation.html#filetemplate.templates.phases.invocation.command_line">
+ Command line</a></span></dt></dl></dd>
+<dt><span class="section"><a href="phases/examination.html"> Examination
+ of the template tree</a></span></dt>
+<dd><dl><dt><span class="section"><a href="phases/examination.html#filetemplate.templates.phases.examination.template_script">
+ Template scripts</a></span></dt></dl></dd>
+<dt><span class="section"><a href="phases/processing.html"> Producing
+ the resulting file tree</a></span></dt>
+<dd><dl><dt><span class="section"><a href="phases/processing.html#filetemplate.templates.phases.processing.python_file">
+ Python generated files</a></span></dt></dl></dd>
+</dl></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../templates.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../templates.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="phases/invocation.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/phases/examination.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/phases/examination.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,73 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Examination
+ of the template tree</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../phases.html" title=" Processing phases">
+<link rel="prev" href="invocation.html" title=" Invocation">
+<link rel="next" href="processing.html" title=" Producing
+ the resulting file tree">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="invocation.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../phases.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="processing.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="filetemplate.templates.phases.examination"></a><a href="examination.html" title=" Examination
+ of the template tree"> Examination
+ of the template tree</a></h4></div></div></div>
+<p>
+ After the startup script has been executed, the template processor will
+ perform a top-down traversal of the template tree. By default, it will
+ record the names of all directories and files located in the tree, which
+ will then be copied / processed in the next phase.
+ </p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="filetemplate.templates.phases.examination.template_script"></a><a href="examination.html#filetemplate.templates.phases.examination.template_script" title="
+ Template scripts">
+ Template scripts</a></h5></div></div></div>
+<p>
+ To customize what information is to be copied, and to specify additional
+ customization possibilites (e.g., via <a href="../reference/substitutions.html" title=" Substitution
+ templates and special templates">substitution
+ templates</a>), template scripts may be inserted in the template tree.
+ </p>
+<p>
+ Template scripts are python files which begin with the following text
+ on their first line:
+ </p>
+<pre class="programlisting">
+<span class="comment"># template script
+</span></pre>
+<p>
+ Every script found during the transversal will be executed. The script
+ can interact with the template processor through the <a href="../reference/template.html" title=" Template
+ object">template
+ object</a>.
+ </p>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="invocation.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../phases.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="processing.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/phases/invocation.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/phases/invocation.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,204 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Invocation</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../phases.html" title=" Processing phases">
+<link rel="prev" href="../phases.html" title=" Processing phases">
+<link rel="next" href="examination.html" title=" Examination
+ of the template tree">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../phases.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../phases.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="examination.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="filetemplate.templates.phases.invocation"></a> Invocation</h4></div></div></div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="filetemplate.templates.phases.invocation.command_line"></a><a href="invocation.html#filetemplate.templates.phases.invocation.command_line" title="
+ Command line">
+ Command line</a></h5></div></div></div>
+<p>
+ The template processor begins by processing the command line for template options.
+ The options are specified via
+ <em class="replaceable"><code>
+ option=value
+ </code></em>
+ arguments. In simple cases, such as when using only one template, the
+ ordering of the command line arguments should not affect the output.
+ However, when multiple templates are used symoultaneously for a template merge, the order
+ matters. The order is as follows.
+ </p>
+<div class="orderedlist"><ol type="1">
+<li>
+global options
+ can be specified at any point, but are recommended to be placed at
+ the beginning for consistency.
+ </li>
+<li>
+template options
+ that should be applied to all templates are specified before any template
+ is listed.
+ </li>
+<li>
+template options
+ that should be applied to an individual template only should be specified
+ after listing the template (and before the next template is listed).
+ </li>
+</ol></div>
+<div class="tip"><table border="0" summary="Tip">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../doc/html/images/tip.png"></td>
+<th align="left">Tip</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ The template can be specified without explicitly using <code class="literal">template\</code>=.
+ E.g., you can run <code class="literal">python file_template.py sandbox</code>
+ instead of <code class="literal">python file_template.py template=sandbox</code>
+ </p>
+<p>
+ </p>
+</td></tr>
+</table></div>
+<p>
+ The following examples illustrates this structure:
+ </p>
+<div class="table">
+<a name="id905134"></a><p class="title"><b>Table 1.4. Command line structure examples:</b></p>
+<table class="table" summary="Command line structure examples:">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ invocation
+ </p>
+ </th>
+<th>
+ <p>
+ global options
+ </p>
+ </th>
+<th>
+ <p>
+ options for all templates
+ </p>
+ </th>
+<th>
+ <p>
+ first template
+ </p>
+ </th>
+<th>
+ <p>
+ second template
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ <code class="literal">python file_template.py</code>
+ </p>
+ </td>
+<td>
+ <p>
+ </p>
+ </td>
+<td>
+ <p>
+ </p>
+ </td>
+<td>
+ <p>
+ sandbox
+ </p>
+ </td>
+<td>
+ <p>
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ <code class="literal">python file_template.py</code>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="literal">destination=/boost_sandbox</code>
+ </p>
+ </td>
+<td>
+ <p>
+ </p>
+ </td>
+<td>
+ <p>
+ <code class="literal">sandbox library=boostified_library vc8ide=y ignore=$template_library$/boost</code>
+ </p>
+ </td>
+<td>
+ <p>
+ /old_library/include/old_library into=boostified_library/boost/boostified_library
+ </p>
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+<p>
+ Some <a href="../reference/options.html" title=" Options">template
+ options</a>, such as <code class="literal">ignore</code> and <code class="literal">fignore</code>,
+ can be specified multiple times for the same template.
+ </p>
+</div>
+<p>
+ After processing the command line, or prompting the user if necessary,
+ the template processor will initialize each <a href="../reference/template.html" title=" Template
+ object">template
+ object</a> (which processes the template and can be used by any in-template
+ <a href="examination.html#filetemplate.templates.phases.examination.template_script" title="
+ Template scripts">template
+ script</a> to customize the behavior of the template) and the global
+ template options.
+ </p>
+<p>
+ The template processor will then <a href="examination.html" title=" Examination
+ of the template tree">examine
+ the template tree</a>.
+ </p>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../phases.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../phases.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="examination.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/phases/processing.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/phases/processing.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,89 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Producing
+ the resulting file tree</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../phases.html" title=" Processing phases">
+<link rel="prev" href="examination.html" title=" Examination
+ of the template tree">
+<link rel="next" href="../merges.html" title=" Template merges">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="examination.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../phases.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="../merges.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="filetemplate.templates.phases.processing"></a><a href="processing.html" title=" Producing
+ the resulting file tree"> Producing
+ the resulting file tree</a></h4></div></div></div>
+<p>
+ Finally, the template processor will produce the resulting file tree from
+ the template. Different kinds of files will be processed as follows:
+ </p>
+<a name="filetemplate.templates.phases.processing.verbatim_file_copies"></a><h4>
+<a name="id905479"></a>
+ <a href="processing.html#filetemplate.templates.phases.processing.verbatim_file_copies">Verbatim
+ file copies</a>
+ </h4>
+<p>
+ A file for which no specific substitution templates are specified will
+ be copied verbatim.
+ </p>
+<a name="filetemplate.templates.phases.processing.processed_file_content"></a><h4>
+<a name="id905508"></a>
+ <a href="processing.html#filetemplate.templates.phases.processing.processed_file_content">Processed
+ file content</a>
+ </h4>
+<p>
+ A file for which at least one specific <a href="../reference/substitutions.html" title=" Substitution
+ templates and special templates">substitution
+ template</a> is specified will be processed for both global <a href="../reference/substitutions.html" title=" Substitution
+ templates and special templates">substitution
+ templates</a> and specific <a href="../reference/substitutions.html" title=" Substitution
+ templates and special templates">substitution
+ templates</a>.
+ </p>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h5 class="title">
+<a name="filetemplate.templates.phases.processing.python_file"></a><a href="processing.html#filetemplate.templates.phases.processing.python_file" title="
+ Python generated files">
+ Python generated files</a></h5></div></div></div>
+<p>
+ A file of the name <span class="emphasis"><em>filename</em></span><code class="literal">.py</code>
+ can be used to generate the file <span class="emphasis"><em>filename</em></span>. To do
+ so, it must begin with
+ </p>
+<pre class="programlisting">
+<span class="comment"># template file
+</span></pre>
+<p>
+ When the script generates the content, it supplies it to the template
+ processor via the <code class="computeroutput"><span class="identifier">template</span><span class="special">.</span><span class="identifier">submit_content</span><span class="special">(</span><span class="identifier">content</span><span class="special">)</span></code> or <code class="computeroutput"><span class="identifier">template</span><span class="special">.</span><span class="identifier">append_content</span><span class="special">(</span><span class="identifier">content</span><span class="special">)</span></code> commands (see the <a href="../reference/template.html" title=" Template
+ object">template
+ object</a> reference).
+ </p>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="examination.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../phases.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="../merges.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,47 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Reference</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../templates.html" title=" FileTemplate templates">
+<link rel="prev" href="merges.html" title=" Template merges">
+<link rel="next" href="reference/options.html" title=" Options">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="merges.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../templates.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="reference/options.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.templates.reference"></a> Reference</h3></div></div></div>
+<div class="toc"><dl>
+<dt><span class="section"> Options</span></dt>
+<dt><span class="section"><a href="reference/substitutions.html"> Substitution
+ templates and special templates</a></span></dt>
+<dt><span class="section"><a href="reference/template.html"> Template
+ object</a></span></dt>
+<dt><span class="section"><a href="reference/results.html"> Results
+ object</a></span></dt>
+</dl></div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="merges.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../templates.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="reference/options.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference/options.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference/options.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,246 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Options</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../reference.html" title=" Reference">
+<link rel="prev" href="../reference.html" title=" Reference">
+<link rel="next" href="substitutions.html" title=" Substitution
+ templates and special templates">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../reference.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="substitutions.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="filetemplate.templates.reference.options"></a> Options</h4></div></div></div>
+<p>
+ Options are used to fine-tune the behavior of the FileTemplate template
+ processor as well as the behavior of the template.
+ </p>
+<a name="filetemplate.templates.reference.options.global_options"></a><h4>
+<a name="id905778"></a>
+ <a href="options.html#filetemplate.templates.reference.options.global_options">Global
+ options</a>
+ </h4>
+<p>
+ <span class="emphasis"><em>Global options</em></span> govern the behavior of the template
+ processor.
+ </p>
+<div class="table">
+<a name="id905801"></a><p class="title"><b>Table 1.5. Global options</b></p>
+<table class="table" summary="Global options">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ option
+ </p>
+ </th>
+<th>
+ <p>
+ desctiption
+ </p>
+ </th>
+<th>
+ <p>
+ valid values
+ </p>
+ </th>
+<th>
+ <p>
+ default value
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ destination
+ </p>
+ </td>
+<td>
+ <p>
+ Destination directory where the results will be constructed.
+ </p>
+ </td>
+<td>
+ <p>
+ valid directory path (will be created if it does not exist)
+ </p>
+ </td>
+<td>
+ <p>
+ current directory
+ </p>
+ </td>
+</tr></tbody>
+</table>
+</div>
+<a name="filetemplate.templates.reference.options.template_options"></a><h4>
+<a name="id905888"></a>
+ <a href="options.html#filetemplate.templates.reference.options.template_options">Template
+ options</a>
+ </h4>
+<p>
+ <span class="emphasis"><em>Template options</em></span> can be used to specify how a particular
+ template is processed. Templates may use additional, template-specific
+ options, as is the case with <a href="../../sandbox/reference/options.html" title=" Options">sandbox
+ options</a>.
+ </p>
+<div class="table">
+<a name="id905923"></a><p class="title"><b>Table 1.6. Template options</b></p>
+<table class="table" summary="Template options">
+<colgroup>
+<col>
+<col>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ option
+ </p>
+ </th>
+<th>
+ <p>
+ desctiption
+ </p>
+ </th>
+<th>
+ <p>
+ valid values
+ </p>
+ </th>
+<th>
+ <p>
+ default value
+ </p>
+ </th>
+</tr></thead>
+<tbody>
+<tr>
+<td>
+ <p>
+ template
+ </p>
+ </td>
+<td>
+ <p>
+ Template directory
+ </p>
+ </td>
+<td>
+ <p>
+ valid directory
+ </p>
+ </td>
+<td>
+ <p>
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ into
+ </p>
+ </td>
+<td>
+ <p>
+ Determines where the output of the template will be placed inside
+ the resulting tree
+ </p>
+ </td>
+<td>
+ <p>
+ valid directoy in resulting tree
+ </p>
+ </td>
+<td>
+ <p>
+ root of the resulting tree
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ ignore
+ </p>
+ </td>
+<td>
+ <p>
+ Ignores a file or directory of the source template tree
+ </p>
+ </td>
+<td>
+ <p>
+ file or directory in source template tree
+ </p>
+ </td>
+<td>
+ <p>
+ </p>
+ </td>
+</tr>
+<tr>
+<td>
+ <p>
+ fignore
+ </p>
+ </td>
+<td>
+ <p>
+ Ignores all files in the source template tree that have the specified
+ suffix
+ </p>
+ </td>
+<td>
+ <p>
+ file suffix
+ </p>
+ </td>
+<td>
+ <p>
+ </p>
+ </td>
+</tr>
+</tbody>
+</table>
+</div>
+<p>
+ Options can be specified using the command line. See the <a href="../phases/invocation.html" title=" Invocation">invocation
+ phase</a> reference for more information. If an option is not specified
+ in the command line, and it has no default value, the user will be prompted
+ for the value.
+ </p>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="../reference.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="substitutions.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference/results.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference/results.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,94 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Results
+ object</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../reference.html" title=" Reference">
+<link rel="prev" href="template.html" title=" Template
+ object">
+<link rel="next" href="../changes.html" title=" Version History and
+ Proposed changes">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="template.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="../changes.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="filetemplate.templates.reference.results"></a><a href="results.html" title=" Results
+ object"> Results
+ object</a></h4></div></div></div>
+<p>
+ The results object holds information about the files and directories which
+ will be generated by the template processor. It includes files and directories
+ from <span class="bold"><strong>all</strong></span> templates being processed, and
+ can therefore be used to allow seamless integration of templates.
+ </p>
+<p>
+ For example, if a template includes a file whose contents depend on the
+ directory tree below a certain directory, you can <code class="literal">walk</code>
+ the results object and extract the directory tree. The following example
+ does so to include all non-detail include directories for the <a href="../../sandbox.html" title=" Boost sandbox template">sandbox
+ template</a>:
+ </p>
+<pre class="programlisting">
+<span class="identifier">doxy_source_files</span> <span class="special">=</span> <span class="identifier">list</span><span class="special">()</span>
+<span class="keyword">for</span> <span class="identifier">root</span><span class="special">,</span> <span class="identifier">dirs</span><span class="special">,</span> <span class="identifier">files</span> <span class="keyword">in</span> <span class="identifier">results</span><span class="special">.</span><span class="identifier">walk</span><span class="special">(</span>
+ <span class="comment"># we want the returned root to be relative to $template_library$
+</span> <span class="identifier">template</span><span class="special">.</span><span class="identifier">replace_name</span><span class="special">(</span><span class="string">'$template_library$'</span><span class="special">),</span>
+ <span class="comment"># and want to walk the boost/$template_library$ directory underneath that
+</span> <span class="identifier">template</span><span class="special">.</span><span class="identifier">replace_name</span><span class="special">(</span><span class="string">'boost/$template_library$'</span><span class="special">)):</span>
+ <span class="keyword">if</span> <span class="identifier">os</span><span class="special">.</span><span class="identifier">path</span><span class="special">.</span><span class="identifier">basename</span><span class="special">(</span><span class="identifier">root</span><span class="special">)</span> <span class="special">!=</span> <span class="string">'detail'</span><span class="special">:</span>
+ <span class="identifier">doxy_source_files</span><span class="special">.</span><span class="identifier">append</span><span class="special">(</span>
+ <span class="identifier">template</span><span class="special">.</span><span class="identifier">replace_name</span><span class="special">(</span><span class="identifier">os</span><span class="special">.</span><span class="identifier">path</span><span class="special">.</span><span class="identifier">join</span><span class="special">(</span><span class="identifier">os</span><span class="special">.</span><span class="identifier">path</span><span class="special">.</span><span class="identifier">join</span><span class="special">(</span><span class="string">'../../..'</span><span class="special">,</span>
+ <span class="identifier">root</span><span class="special">),</span> <span class="string">'*.hpp'</span><span class="special">).</span><span class="identifier">replace</span><span class="special">(</span><span class="string">'\\'</span><span class="special">,</span><span class="string">'/'</span><span class="special">)))</span>
+</pre>
+<p>
+ A similar example uses the <code class="literal">files_in</code> and <code class="literal">directories_in</code>
+ functions of the result object to construct the list of files and filters
+ for a MSVC IDE:
+ </p>
+<pre class="programlisting">
+ <span class="keyword">def</span> <span class="identifier">vc_list_files</span><span class="special">(</span><span class="identifier">level</span><span class="special">,</span> <span class="identifier">output_base</span><span class="special">,</span> <span class="identifier">destination_base</span><span class="special">,</span> <span class="identifier">directory</span><span class="special">):</span>
+ <span class="identifier">tabs</span> <span class="special">=</span> <span class="string">''</span><span class="special">.</span><span class="identifier">join</span><span class="special">([</span><span class="string">'\t'</span> <span class="keyword">for</span> <span class="identifier">x</span> <span class="keyword">in</span> <span class="identifier">range</span><span class="special">(</span><span class="identifier">level</span><span class="special">)])</span>
+ <span class="identifier">output_base_directory</span> <span class="special">=</span> <span class="identifier">os</span><span class="special">.</span><span class="identifier">path</span><span class="special">.</span><span class="identifier">join</span><span class="special">(</span><span class="identifier">output_base</span><span class="special">,</span> <span class="identifier">directory</span><span class="special">)</span>
+ <span class="identifier">destination_base_directory</span> <span class="special">=</span> <span class="identifier">os</span><span class="special">.</span><span class="identifier">path</span><span class="special">.</span><span class="identifier">join</span><span class="special">(</span><span class="identifier">destination_base</span><span class="special">,</span> <span class="identifier">directory</span><span class="special">)</span>
+ <span class="keyword">for</span> <span class="identifier">name</span> <span class="keyword">in</span> <span class="identifier">results</span><span class="special">.</span><span class="identifier">files_in</span><span class="special">(</span><span class="identifier">destination_base_directory</span><span class="special">):</span>
+ <span class="identifier">template</span><span class="special">.</span><span class="identifier">append_content</span><span class="special">(</span><span class="string">"""
+"""</span> <span class="special">+</span> <span class="identifier">tabs</span> <span class="special">+</span> <span class="string">"""<File
+"""</span> <span class="special">+</span> <span class="identifier">tabs</span> <span class="special">+</span> <span class="string">'\tRelativePath="'</span><span class="special">+</span><span class="identifier">os</span><span class="special">.</span><span class="identifier">path</span><span class="special">.</span><span class="identifier">join</span><span class="special">(</span><span class="identifier">output_base_directory</span><span class="special">,</span><span class="identifier">name</span><span class="special">)+</span><span class="string">""""
+"""</span> <span class="special">+</span> <span class="identifier">tabs</span> <span class="special">+</span> <span class="string">"""\t>
+"""</span> <span class="special">+</span> <span class="identifier">tabs</span> <span class="special">+</span> <span class="string">"""</File>"""</span><span class="special">)</span>
+
+ <span class="keyword">for</span> <span class="identifier">name</span> <span class="keyword">in</span> <span class="identifier">results</span><span class="special">.</span><span class="identifier">directories_in</span><span class="special">(</span><span class="identifier">destination_base_directory</span><span class="special">):</span>
+ <span class="identifier">template</span><span class="special">.</span><span class="identifier">append_content</span><span class="special">(</span><span class="string">"""
+"""</span> <span class="special">+</span> <span class="identifier">tabs</span> <span class="special">+</span> <span class="string">"""<Filter
+"""</span> <span class="special">+</span> <span class="identifier">tabs</span> <span class="special">+</span> <span class="string">'\tName="'</span><span class="special">+</span><span class="identifier">name</span><span class="special">+</span><span class="string">""""
+"""</span> <span class="special">+</span> <span class="identifier">tabs</span> <span class="special">+</span> <span class="string">"""\t>"""</span><span class="special">)</span>
+ <span class="identifier">vc_list_files</span><span class="special">(</span><span class="identifier">level</span><span class="special">+</span><span class="number">1</span><span class="special">,</span> <span class="identifier">output_base_directory</span><span class="special">,</span> <span class="identifier">destination_base_directory</span><span class="special">,</span> <span class="identifier">name</span><span class="special">)</span>
+ <span class="identifier">template</span><span class="special">.</span><span class="identifier">append_content</span><span class="special">(</span><span class="string">"""
+"""</span> <span class="special">+</span> <span class="identifier">tabs</span> <span class="special">+</span> <span class="string">"""</Filter>"""</span><span class="special">)</span>
+</pre>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="template.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="../changes.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference/substitutions.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference/substitutions.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,127 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Substitution
+ templates and special templates</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../reference.html" title=" Reference">
+<link rel="prev" href="options.html" title=" Options">
+<link rel="next" href="template.html" title=" Template
+ object">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="options.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="template.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="filetemplate.templates.reference.substitutions"></a><a href="substitutions.html" title=" Substitution
+ templates and special templates"> Substitution
+ templates and special templates</a></h4></div></div></div>
+<a name="filetemplate.templates.reference.substitutions.substitution_templates"></a><h4>
+<a name="id906133"></a>
+ <a href="substitutions.html#filetemplate.templates.reference.substitutions.substitution_templates">Substitution
+ templates</a>
+ </h4>
+<p>
+ Substitution templates are the simplest form of template customization.
+ For specified file extensions, the template processor will replace each
+ occurence of a substitution template with the substituted text. For some
+ examples, see the substitutions
+ of the sandbox template.
+ </p>
+<p>
+ Substitution templates are divided into two categories - <span class="emphasis"><em>specific</em></span>
+ and <span class="emphasis"><em>general</em></span>. Specific substitution templates are only
+ applied to specific file extensions. General substitution templates are
+ applied to any file extension that has <span class="bold"><strong>at least one</strong></span>
+ specific substitution defined. Files with no specific substitution templates
+ will be copied verbatim.
+ </p>
+<div class="tip"><table border="0" summary="Tip">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../../doc/html/images/tip.png"></td>
+<th align="left">Tip</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ Substitutions are applied in the order they are specified in the template
+ scripts, so substituted text for one substitution template can include
+ substitution templates specified after it. For example, in the sandbox
+ template $template_copyright$ expands into text which includes $template_authors$.
+ </p>
+<p>
+ </p>
+</td></tr>
+</table></div>
+<a name="filetemplate.templates.reference.substitutions.special_templates"></a><h4>
+<a name="id906215"></a>
+ <a href="substitutions.html#filetemplate.templates.reference.substitutions.special_templates">Special
+ templates</a>
+ </h4>
+<p>
+ There are also <span class="emphasis"><em>special</em></span> templates, which are also applied
+ whenever substitution templates are applied (i.e., for file extensions
+ with at least one specific extension defined). The FileTemplate processor
+ uses one special template:
+ </p>
+<div class="table">
+<a name="id906243"></a><p class="title"><b>Table 1.7. Special templates used by the FileTemplate template
+ processor</b></p>
+<table class="table" summary="Special templates used by the FileTemplate template
+ processor">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ special template
+ </p>
+ </th>
+<th>
+ <p>
+ desctiption
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ $template_start$
+ </p>
+ </td>
+<td>
+ <p>
+ Everything up to the line of the file containing the first occurrence
+ of this special template will be ignored.
+ </p>
+ </td>
+</tr></tbody>
+</table>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="options.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="template.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference/template.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/reference/template.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,124 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Template
+ object</title>
+<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../../index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="up" href="../reference.html" title=" Reference">
+<link rel="prev" href="substitutions.html" title=" Substitution
+ templates and special templates">
+<link rel="next" href="results.html" title=" Results
+ object">
+</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>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="substitutions.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="results.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h4 class="title">
+<a name="filetemplate.templates.reference.template"></a><a href="template.html" title=" Template
+ object"> Template
+ object</a></h4></div></div></div>
+<p>
+ The template object contains several functions which can be used from template
+ scripts to customize template behavior.
+ </p>
+<p>
+ The following examples quickly illustrate some of the use:
+ </p>
+<p>
+ To get a user-specified option:
+ </p>
+<pre class="programlisting">
+<span class="identifier">docs</span> <span class="special">=</span> <span class="identifier">template</span><span class="special">.</span><span class="identifier">options</span><span class="special">.</span><span class="identifier">get</span><span class="special">(</span><span class="string">'docs'</span><span class="special">)</span>
+</pre>
+<p>
+ To get a user-specified option verified against a regular expression and
+ with a default value:
+ </p>
+<pre class="programlisting">
+<span class="identifier">template</span><span class="special">.</span><span class="identifier">options</span><span class="special">.</span><span class="identifier">get</span><span class="special">(</span><span class="string">'docs'</span><span class="special">,</span> <span class="identifier">re</span><span class="special">.</span><span class="identifier">compile</span><span class="special">(</span><span class="identifier">r</span><span class="string">'(qb|qb\+doxyref|qb\+doxy)$'</span><span class="special">),</span> <span class="string">'qb+doxyref'</span><span class="special">)</span>
+</pre>
+<p>
+ To get a boolean (y/n) user specified option with a default value:
+ </p>
+<pre class="programlisting">
+<span class="identifier">template</span><span class="special">.</span><span class="identifier">options</span><span class="special">.</span><span class="identifier">get_boolean</span><span class="special">(</span><span class="string">'vc8ide'</span><span class="special">,</span> <span class="identifier">False</span><span class="special">):</span>
+</pre>
+<p>
+ To set up a substitution template for file names:
+ </p>
+<pre class="programlisting">
+<span class="identifier">template</span><span class="special">.</span><span class="identifier">name_replacement</span><span class="special">(</span><span class="string">'$template_library$'</span><span class="special">,</span> <span class="identifier">library_name</span><span class="special">)</span>
+</pre>
+<p>
+ To set up a specific <a href="substitutions.html" title=" Substitution
+ templates and special templates">substitution
+ template</a>:
+ </p>
+<pre class="programlisting">
+<span class="identifier">template</span><span class="special">.</span><span class="identifier">content_replacement</span><span class="special">([</span><span class="string">'.hpp'</span><span class="special">,</span> <span class="string">'.cpp'</span><span class="special">],</span> <span class="string">'$template_created$'</span><span class="special">,</span> <span class="string">'// Created in $template_year$'</span><span class="special">)</span>
+</pre>
+<p>
+ To set up a general <a href="substitutions.html" title=" Substitution
+ templates and special templates">substitution
+ template</a>:
+ </p>
+<pre class="programlisting">
+<span class="identifier">template</span><span class="special">.</span><span class="identifier">general_content_replacement</span><span class="special">(</span><span class="string">'$template_year$'</span><span class="special">,</span> <span class="identifier">str</span><span class="special">(</span><span class="identifier">time</span><span class="special">.</span><span class="identifier">localtime</span><span class="special">().</span><span class="identifier">tm_year</span><span class="special">))</span>
+</pre>
+<p>
+ To ignore (not process) an entire subdirectory in the same directory as
+ the script:
+ </p>
+<pre class="programlisting">
+<span class="identifier">template</span><span class="special">.</span><span class="identifier">ignore_subdirectory</span><span class="special">(</span><span class="string">'vc8ide'</span><span class="special">)</span>
+</pre>
+<p>
+ To ignore (not process) a file in the same directory as the script:
+ </p>
+<pre class="programlisting">
+<span class="identifier">template</span><span class="special">.</span><span class="identifier">ignore_subfile</span><span class="special">(</span><span class="string">'boostbook_doxygen.css'</span><span class="special">)</span>
+</pre>
+<p>
+ To submit python-generated file content from a python template file:
+ </p>
+<pre class="programlisting">
+<span class="identifier">content</span><span class="special">=</span><span class="string">"""
+This is a script-generated file."""</span>
+<span class="identifier">content</span> <span class="special">+=</span> <span class="string">"""
+Yes it is."""</span>
+
+<span class="identifier">template</span><span class="special">.</span><span class="identifier">submit_content</span><span class="special">(</span><span class="identifier">content</span><span class="special">)</span>
+</pre>
+<p>
+ or
+ </p>
+<pre class="programlisting">
+<span class="identifier">template</span><span class="special">.</span><span class="identifier">append_content</span><span class="special">(</span><span class="string">"""
+This is a script-generated file."""</span><span class="special">)</span>
+<span class="identifier">template</span><span class="special">.</span><span class="identifier">append_content</span><span class="special">(</span><span class="string">"""
+Yes it is."""</span><span class="special">)</span>
+</pre>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="substitutions.html"><img src="../../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reference.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="results.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/substitutions.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/filetemplate/templates/substitutions.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,126 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Substitution templates
+ and special templates</title>
+<link rel="stylesheet" href="../../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="../../index.html" title="Chapter 1. FileTemplate 0.92">
+<link rel="up" href="../templates.html" title=" FileTemplate templates">
+<link rel="prev" href="options.html" title=" Options">
+<link rel="next" href="merges.html" title=" Template merges">
+</head>
+<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
+<table cellpadding="2" width="100%">
+<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>
+</table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="options.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../templates.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="merges.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+<div class="section" lang="en">
+<div class="titlepage"><div><div><h3 class="title">
+<a name="filetemplate.templates.substitutions"></a><a href="substitutions.html" title=" Substitution templates
+ and special templates"> Substitution templates
+ and special templates</a></h3></div></div></div>
+<a name="filetemplate.templates.substitutions.substitution_templates"></a><h4>
+<a name="id905781"></a>
+ <a href="substitutions.html#filetemplate.templates.substitutions.substitution_templates">Substitution
+ templates</a>
+ </h4>
+<p>
+ Substitution templates are the simplest form of template customization. For
+ specified file extensions, the template processor will replace each occurence
+ of a substitution template with the substituted text. For some examples,
+ see the substitutions
+ of the sandbox template.
+ </p>
+<p>
+ Substitution templates are divided into two categories - <span class="emphasis"><em>specific</em></span>
+ and <span class="emphasis"><em>general</em></span>. Specific substitution templates are only
+ applied to specific file extensions. General substitution templates are applied
+ to any file extension that has <span class="bold"><strong>at least one</strong></span>
+ specific substitution defined. Files with no specific substitution templates
+ will be copied verbatim.
+ </p>
+<div class="tip"><table border="0" summary="Tip">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="../../../../doc/html/images/tip.png"></td>
+<th align="left">Tip</th>
+</tr>
+<tr><td colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ Substitutions are applied in the order they are specified in the template
+ scripts, so substituted text for one substitution template can include
+ substitution templates specified after it. For example, in the sandbox
+ template $template_cpp_copyright$ expands into text which includes $template_authors$.
+ </p>
+<p>
+ </p>
+</td></tr>
+</table></div>
+<a name="filetemplate.templates.substitutions.special_templates"></a><h4>
+<a name="id905860"></a>
+ <a href="substitutions.html#filetemplate.templates.substitutions.special_templates">Special
+ templates</a>
+ </h4>
+<p>
+ There are also <span class="emphasis"><em>special</em></span> templates, which are also applied
+ whenever substitution templates are applied (i.e., for file extensions with
+ at least one specific extension defined). The FileTemplate processor uses
+ one special template:
+ </p>
+<div class="table">
+<a name="id905886"></a><p class="title"><b>Table 1.7. Special templates used by the FileTemplate template
+ processor</b></p>
+<table class="table" summary="Special templates used by the FileTemplate template
+ processor">
+<colgroup>
+<col>
+<col>
+</colgroup>
+<thead><tr>
+<th>
+ <p>
+ special template
+ </p>
+ </th>
+<th>
+ <p>
+ desctiption
+ </p>
+ </th>
+</tr></thead>
+<tbody><tr>
+<td>
+ <p>
+ $template_start$
+ </p>
+ </td>
+<td>
+ <p>
+ Everything up to the line of the file containing the first occurrence
+ of this special template will be ignored.
+ </p>
+ </td>
+</tr></tbody>
+</table>
+</div>
+</div>
+<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Stjepan Rajko</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="options.html"><img src="../../../../doc/html/images/prev.png" alt="Prev"></a><a accesskey="u" href="../templates.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="merges.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/template_under_construction/file_template/libs/file_template/doc/html/index.html
==============================================================================
--- (empty file)
+++ sandbox/template_under_construction/file_template/libs/file_template/doc/html/index.html 2007-06-25 17:15:59 EDT (Mon, 25 Jun 2007)
@@ -0,0 +1,153 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Chapter 1. FileTemplate 0.94</title>
+<link rel="stylesheet" href="boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.67.2">
+<link rel="start" href="index.html" title="Chapter 1. FileTemplate 0.94">
+<link rel="next" href="filetemplate/sandbox.html" title=" Boost sandbox template">
+</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>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="filetemplate/sandbox.html"><img src="../../doc/html/images/next.png" alt="Next"></a></div>
+<div class="chapter" lang="en">
+<div class="titlepage"><div>
+<div><h2 class="title">
+<a name="filetemplate"></a>Chapter 1. FileTemplate 0.94</h2></div>
+<div><p class="copyright">Copyright © 2007 Stjepan Rajko</p></div>
+<div><div class="legalnotice">
+<a name="id903098"></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>
+</div></div>
+</div></div>
+<div class="toc">
+<p><b>Table of Contents</b></p>
+<dl>
+<dt><span class="section"> Boost sandbox template</span></dt>
+<dd><dl>
+<dt><span class="section"><a href="filetemplate/sandbox/tools.html"> Configuring the tools and
+ checking out the Boost sandbox</a></span></dt>
+<dt><span class="section"> Use Cases</span></dt>
+<dt><span class="section"><a href="filetemplate/sandbox/outside_docs.html"> Links to helpful
+ outside documentation</a></span></dt>
+<dt><span class="section"> Reference</span></dt>
+<dd><dl>
+<dt><span class="section"> Options</span></dt>
+<dt><span class="section"><a href="filetemplate/sandbox/reference/substitutions.html"> Substitution
+ templates</a></span></dt>
+<dt><span class="section"><a href="filetemplate/sandbox/reference/documentation.html"> Documentation
+ formats</a></span></dt>
+</dl></dd>
+<dt><span class="section"><a href="filetemplate/sandbox/changes.html"> Version History and Proposed
+ Changes</a></span></dt>
+</dl></dd>
+<dt><span class="section"> FileTemplate templates</span></dt>
+<dd><dl>
+<dt><span class="section"> Processing phases</span></dt>
+<dd><dl>
+<dt><span class="section"> Invocation</span></dt>
+<dd><dl><dt><span class="section"><a href="filetemplate/templates/phases/invocation.html#filetemplate.templates.phases.invocation.command_line">
+ Command line</a></span></dt></dl></dd>
+<dt><span class="section"><a href="filetemplate/templates/phases/examination.html"> Examination
+ of the template tree</a></span></dt>
+<dd><dl><dt><span class="section"><a href="filetemplate/templates/phases/examination.html#filetemplate.templates.phases.examination.template_script">
+ Template scripts</a></span></dt></dl></dd>
+<dt><span class="section"><a href="filetemplate/templates/phases/processing.html"> Producing
+ the resulting file tree</a></span></dt>
+<dd><dl><dt><span class="section"><a href="filetemplate/templates/phases/processing.html#filetemplate.templates.phases.processing.python_file">
+ Python generated files</a></span></dt></dl></dd>
+</dl></dd>
+<dt><span class="section"> Template merges</span></dt>
+<dt><span class="section"> Reference</span></dt>
+<dd><dl>
+<dt><span class="section"> Options</span></dt>
+<dt><span class="section"><a href="filetemplate/templates/reference/substitutions.html"> Substitution
+ templates and special templates</a></span></dt>
+<dt><span class="section"><a href="filetemplate/templates/reference/template.html"> Template
+ object</a></span></dt>
+<dt><span class="section"><a href="filetemplate/templates/reference/results.html"> Results
+ object</a></span></dt>
+</dl></dd>
+<dt><span class="section"><a href="filetemplate/templates/changes.html"> Version History and
+ Proposed changes</a></span></dt>
+</dl></dd>
+<dt><span class="section"> Acknowledgements</span></dt>
+<dt><span class="section"> License</span></dt>
+</dl>
+</div>
+<p>
+ </p>
+<p>
+ FileTemplate is a template processor for files and directories. This could be
+ useful in the following scenarios:
+ </p>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ There is a generic starting point for a certain type of project. The user can
+ specify information to fine-tune their particular starting point.
+ </li>
+<li>
+ The user would like to integrate their existing files into a new project for
+ which there is a template. The user can perform a <a href="filetemplate/templates/merges.html" title=" Template merges">template
+ merge</a> between the template for the new project, and the existing files
+ (acting as a second template). If the template is implemented appropriately,
+ it will integrate the user's existing files.
+ </li>
+</ul></div>
+<p>
+ FileTemplate is being developed to help constructing new projects for the Boost
+ Sandbox. The sandbox template, which
+ is used for this purpose, is currently the only template developed using FileTemplate.
+ </p>
+<p>
+ <span class="bold"><strong>See the <a href="filetemplate/sandbox/use.html" title=" Use Cases">sandbox
+ use cases</a> documentation for some examples of how to use the <a href="filetemplate/sandbox.html" title=" Boost sandbox template">sandbox
+ template</a>.</strong></span>
+ </p>
+<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 colspan="2" align="left" valign="top">
+<p>
+ </p>
+<p>
+ FileTemplate is not an official part or tool of the Boost libraries.
+ </p>
+<p>
+ </p>
+</td></tr>
+</table></div>
+<p>
+ If you are interested in creating a template for a setting other than the Boost
+ sandbox, FileTemplate provides a basic framework which makes producing templated
+ file/directory trees relatively easy. The philosophy behind the development of
+ the framework is that simple things should be simple, and more complicated things
+ should be doable. By being implemented in Python, and allowing template-specific
+ python scripts to be placed in a template, FileTemplate provides a reasonable
+ degree of flexibility.
+ </p>
+<p>
+ <span class="bold"><strong>See the templates
+ documentation for more information about creating and customizing templates.</strong></span>
+ </p>
+</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 25, 2007 at 21:12:22 GMT</small></p></td>
+<td align="right"><small></small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="filetemplate/sandbox.html"><img src="../../doc/html/images/next.png" alt="Next"></a></div>
+</body>
+</html>