From: az_sw_dude_at_[hidden]
Date: 2007-05-26 19:03:16
Author: az_sw_dude
Date: 2007-05-26 19:03:14 EDT (Sat, 26 May 2007)
New Revision: 4292
URL: http://svn.boost.org/trac/boost/changeset/4292
Log:
add first generation of explore docs
Added:
sandbox/explore/libs/explore/doc/
sandbox/explore/libs/explore/doc/Jamfile.v2
sandbox/explore/libs/explore/doc/dependencies_platforms.qbk
sandbox/explore/libs/explore/doc/design.qbk
sandbox/explore/libs/explore/doc/explore.qbk
sandbox/explore/libs/explore/doc/html/
sandbox/explore/libs/explore/doc/html/HTML.manifest
sandbox/explore/libs/explore/doc/html/boost_explore/
sandbox/explore/libs/explore/doc/html/boost_explore/dependencies_platforms.html
sandbox/explore/libs/explore/doc/html/boost_explore/design.html
sandbox/explore/libs/explore/doc/html/boost_explore/tutorial.html
sandbox/explore/libs/explore/doc/html/boostbook.css
sandbox/explore/libs/explore/doc/html/index.html
sandbox/explore/libs/explore/doc/tutorial.qbk
Added: sandbox/explore/libs/explore/doc/Jamfile.v2
==============================================================================
--- (empty file)
+++ sandbox/explore/libs/explore/doc/Jamfile.v2 2007-05-26 19:03:14 EDT (Sat, 26 May 2007)
@@ -0,0 +1,35 @@
+#
+# Copyright (c) 2007 Jeff Garland (jeff at crystalclearsoftware dot com)
+#
+# 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)
+#
+
+import quickbook ;
+
+xml explore
+ :
+ explore.qbk
+ ;
+
+boostbook standalone
+ :
+ explore
+ :
+ <xsl:param>boost.root=../../../..
+ <xsl:param>boost.libraries=../../../../libs/libraries.htm
+ <xsl:param>navig.graphics.path="../../../../doc/html/images/ "
+ <xsl:param>chapter.autolabel=0
+ <xsl:param>chunk.section.depth=8
+ <xsl:param>chunk.first.sections=1
+ <xsl:param>toc.section.depth=2
+ <xsl:param>toc.max.depth=1
+ <xsl:param>generate.section.toc.level=1
+ <xsl:param>generate.toc="\"chapter toc,title section toc,title\""
+ ;
+
+
+install html
+ :
+ /boost//doc/html/boostbook.css
+ ;
Added: sandbox/explore/libs/explore/doc/dependencies_platforms.qbk
==============================================================================
--- (empty file)
+++ sandbox/explore/libs/explore/doc/dependencies_platforms.qbk 2007-05-26 19:03:14 EDT (Sat, 26 May 2007)
@@ -0,0 +1,28 @@
+[/
+ / Copyright (c) 2007 Jeff Garland (jeff at crystalclearsoftware.com)
+ /
+ / 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)
+ /]
+
+[section:dependencies_platforms Dependencies and Platforms]
+
+[h2 Dependencies]
+
+The following libraries must be available in order to use Boost.explore
+
+* mpl - various meta programming tools
+* utility - for enable_if
+* foreach
+* range - for range iterator
+* parameter (tbd in future for parameter based interface)
+
+[h2 Supported Platforms]
+
+The following platforms and compilers have been tested:
+
+ * g++-4.0 Linux
+ * vc7.1, 8.0 WinXp
+
+
+[endsect]
Added: sandbox/explore/libs/explore/doc/design.qbk
==============================================================================
--- (empty file)
+++ sandbox/explore/libs/explore/doc/design.qbk 2007-05-26 19:03:14 EDT (Sat, 26 May 2007)
@@ -0,0 +1,26 @@
+[/
+ / Copyright (c) 2007 Jeff Garland (jeff at crystalclearsoftware.com)
+ /
+ / 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)
+ /]
+
+[section:design Design Notes]
+
+[h2 Rationale]
+
+The explore library is intended primarily as a debugging tool although
+in some cases it may prove sufficiently capable to provide output good
+enough for other applications.
+
+* [*Ease of use.] The interfaces to the library should be as simple
+as possible reflecting good defaults while allowing more sophisticated
+options with a small amount of customization.
+* [*Support user defined types.] Since collections can support user
+defined types explore should be capable of printing containers
+with thoes types.
+* [*Portability.] The library should work with a variety of compilers
+and platforms.
+
+
+[endsect]
Added: sandbox/explore/libs/explore/doc/explore.qbk
==============================================================================
--- (empty file)
+++ sandbox/explore/libs/explore/doc/explore.qbk 2007-05-26 19:03:14 EDT (Sat, 26 May 2007)
@@ -0,0 +1,83 @@
+[/
+ / Copyright (c) 2007 Jeff Garland
+ /
+ / 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)
+ /]
+
+[library Boost.Explore
+ [quickbook 1.4]
+ [copyright 2007 Jeff Garland]
+ [purpose Library to output Collections]
+ [license
+ 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])
+ ]
+ [category template]
+ [category generic]
+ [last-revision $Date: 2007/05/27 15:50:13 $]
+]
+
+
+[/=============================================================================]
+
+Boost.Explore is a cross-platform C++ library for printing of containers.
+
+
+[h2 Getting Started]
+
+Boost.explore is a library that provides for the output of data from containers
+or ranges.
+
+The following are some simple usage examples:
+
+ //explore supports output for all stl container types
+ std::vector<int> vi += {1,2,3}; //boost assign!
+ std::cout << vi << std::endl; //prints [1, 2, 3]
+ std::stringstream ss;
+ print(vi, ss); //prints [1, 2, 3]
+ //lets do some containers in containers
+ std::vector<std::vector<int> > vvi;
+ vvi.push_back(vi);
+ vvi.push_back(vi);
+ std::cout << vi << std::endl; //prints [[1, 2, 3], [1, 2, 3]]
+ std::map<std::string, int> si_map;
+ si_map["hello"] = 1;
+ si_map["world"] = 2;
+ std::cout << si_map << std::endl; //prints [hello:1, world:2]
+ std::list<date> dl; //date from boost::gregorian
+ dl.push_back(date(2007, Jan, 1));
+ dl.push_back(date(2007, Jan, 3));
+ //printing of user defined types uses the types operator<< if available
+ std::cout << dl << std::endl; //prints [2007-Jan-1, 2007-Jan-3]
+ //how about some boost container types:
+ boost::array<std::string, 2> sa2;
+ sa2[0] = "one";
+ sa2[1] = "two";
+
+
+
+The [link boost_explore.tutorial tutorial] shows more details on using explore.
+
+While explore is powerful and flexible, it is not infinitely flexible.
+The reasons for this are discussed in the [link boost_explore.design design]
+section.For very complex output custom methods or a template output system should
+be considered.
+
+[include tutorial.qbk]
+[include dependencies_platforms.qbk]
+[include design.qbk]
+
+
+[h2 Acknowledgements]
+
+Most of the major concepts and interfaces for this library were developed
+at BoostCon 2007. There were many participants in the 8:00 am sessions
+that developed the interfaces and concepts. Notably Hartmut Kaiser,
+Joao ???, and Joel De Guzman for discussing Karma and doing some initial
+prototypes.
+
+[/these sections t.b.d.]
+[/include requirements.qbk]
+[/include reference.qbk]
Added: sandbox/explore/libs/explore/doc/html/HTML.manifest
==============================================================================
--- (empty file)
+++ sandbox/explore/libs/explore/doc/html/HTML.manifest 2007-05-26 19:03:14 EDT (Sat, 26 May 2007)
@@ -0,0 +1,4 @@
+index.html
+boost_explore/tutorial.html
+boost_explore/dependencies_platforms.html
+boost_explore/design.html
Added: sandbox/explore/libs/explore/doc/html/boost_explore/dependencies_platforms.html
==============================================================================
--- (empty file)
+++ sandbox/explore/libs/explore/doc/html/boost_explore/dependencies_platforms.html 2007-05-26 19:03:14 EDT (Sat, 26 May 2007)
@@ -0,0 +1,73 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Dependencies and Platforms</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
+<link rel="start" href="../index.html" title="Boost.Explore">
+<link rel="up" href="../index.html" title="Boost.Explore">
+<link rel="prev" href="tutorial.html" title=" Tutorial">
+<link rel="next" href="design.html" title=" Design Notes">
+</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="tutorial.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="design.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="boost_explore.dependencies_platforms"></a> Dependencies and Platforms</h2></div></div></div>
+<a name="boost_explore.dependencies_platforms.dependencies"></a><h2>
+<a name="id317595"></a>
+ Dependencies
+ </h2>
+<p>
+ The following libraries must be available in order to use Boost.explore
+ </p>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ mpl - various meta programming tools
+ </li>
+<li>
+ utility - for enable_if
+ </li>
+<li>
+ foreach
+ </li>
+<li>
+ range - for range iterator
+ </li>
+<li>
+ parameter (tbd in future for parameter based interface)
+ </li>
+</ul></div>
+<a name="boost_explore.dependencies_platforms.supported_platforms"></a><h2>
+<a name="id317633"></a>
+ Supported Platforms
+ </h2>
+<p>
+ The following platforms and compilers have been tested:
+ </p>
+<pre class="programlisting">
+<span class="special">*</span> <span class="identifier">g</span><span class="special">++-</span><span class="number">4.0</span> <span class="identifier">Linux</span>
+<span class="special">*</span> <span class="identifier">vc7</span><span class="special">.</span><span class="number">1</span><span class="special">,</span> <span class="number">8.0</span> <span class="identifier">WinXp</span>
+</pre>
+</div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Jeff Garland</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="tutorial.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="design.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/explore/libs/explore/doc/html/boost_explore/design.html
==============================================================================
--- (empty file)
+++ sandbox/explore/libs/explore/doc/html/boost_explore/design.html 2007-05-26 19:03:14 EDT (Sat, 26 May 2007)
@@ -0,0 +1,62 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Design Notes</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
+<link rel="start" href="../index.html" title="Boost.Explore">
+<link rel="up" href="../index.html" title="Boost.Explore">
+<link rel="prev" href="dependencies_platforms.html" title=" Dependencies and Platforms">
+</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="dependencies_platforms.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="boost_explore.design"></a> Design Notes</h2></div></div></div>
+<a name="boost_explore.design.rationale"></a><h2>
+<a name="id317724"></a>
+ Rationale
+ </h2>
+<p>
+ The explore library is intended primarily as a debugging tool although in some
+ cases it may prove sufficiently capable to provide output good enough for other
+ applications.
+ </p>
+<div class="itemizedlist"><ul type="disc">
+<li>
+<span class="bold"><strong>Ease of use.</strong></span> The interfaces to the library
+ should be as simple as possible reflecting good defaults while allowing more
+ sophisticated options with a small amount of customization.
+ </li>
+<li>
+<span class="bold"><strong>Support user defined types.</strong></span> Since collections
+ can support user defined types explore should be capable of printing containers
+ with thoes types.
+ </li>
+<li>
+<span class="bold"><strong>Portability.</strong></span> The library should work with
+ a variety of compilers and platforms.
+ </li>
+</ul></div>
+</div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Jeff Garland</small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav">
+<a accesskey="p" href="dependencies_platforms.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/explore/libs/explore/doc/html/boost_explore/tutorial.html
==============================================================================
--- (empty file)
+++ sandbox/explore/libs/explore/doc/html/boost_explore/tutorial.html 2007-05-26 19:03:14 EDT (Sat, 26 May 2007)
@@ -0,0 +1,74 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title> Tutorial</title>
+<link rel="stylesheet" href="../boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
+<link rel="start" href="../index.html" title="Boost.Explore">
+<link rel="up" href="../index.html" title="Boost.Explore">
+<link rel="prev" href="../index.html" title="Boost.Explore">
+<link rel="next" href="dependencies_platforms.html" title=" Dependencies and Platforms">
+</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="../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="dependencies_platforms.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="boost_explore.tutorial"></a> Tutorial</h2></div></div></div>
+<a name="boost_explore.tutorial.basic_container_printing"></a><h2>
+<a name="id317437"></a>
+ Basic Container Printing
+ </h2>
+<p>
+ All of the explore library can be used by simply including the <code class="computeroutput"><span class="string">"explore.hpp"</span></code> header file.
+ </p>
+<pre class="programlisting">
+<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">explore</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span>
+<span class="keyword">using</span> <span class="keyword">namespace</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">explore</span><span class="special">;</span>
+</pre>
+<p>
+ More granular headers are also available under boost/explore.
+ </p>
+<a name="boost_explore.tutorial.customizing_delimiters"></a><h2>
+<a name="id317542"></a>
+ Customizing Delimiters
+ </h2>
+<p>
+ When printing a container explore users user several delimeters:
+ </p>
+<div class="itemizedlist"><ul type="disc">
+<li>
+ opening - printed at the start of the container default: '['
+ </li>
+<li>
+ closing - printed at the end of the container default: ']'
+ </li>
+<li>
+ delimiter - printed between each element default: ', '
+ </li>
+</ul></div>
+<a name="boost_explore.tutorial.printing_of_contained_items"></a><h2>
+<a name="id317573"></a>
+ Printing of Contained Items
+ </h2>
+</div>
+<table width="100%"><tr>
+<td align="left"></td>
+<td align="right"><small>Copyright © 2007 Jeff Garland</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="dependencies_platforms.html"><img src="../../../../../doc/html/images/next.png" alt="Next"></a>
+</div>
+</body>
+</html>
Added: sandbox/explore/libs/explore/doc/html/boostbook.css
==============================================================================
--- (empty file)
+++ sandbox/explore/libs/explore/doc/html/boostbook.css 2007-05-26 19:03:14 EDT (Sat, 26 May 2007)
@@ -0,0 +1,519 @@
+/*=============================================================================
+ Copyright (c) 2004 Joel de Guzman
+ http://spirit.sourceforge.net/
+
+ Distributed under the Boost Software License, Version 1.0. (See accompany-
+ ing file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+=============================================================================*/
+
+/*=============================================================================
+ Body defaults
+=============================================================================*/
+
+ body
+ {
+ margin: 1em;
+ font-family: sans-serif;
+ }
+
+/*=============================================================================
+ Paragraphs
+=============================================================================*/
+
+ p
+ {
+ text-align: left;
+ font-size: 10pt;
+ line-height: 1.15;
+ }
+
+/*=============================================================================
+ Program listings
+=============================================================================*/
+
+ /* Code on paragraphs */
+ p tt.computeroutput
+ {
+ font-size: 9pt;
+ }
+
+ pre.synopsis
+ {
+ font-size: 90%;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ .programlisting,
+ .screen
+ {
+ font-size: 9pt;
+ display: block;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ /* Program listings in tables don't get borders */
+ td .programlisting,
+ td .screen
+ {
+ margin: 0pc 0pc 0pc 0pc;
+ padding: 0pc 0pc 0pc 0pc;
+ }
+
+/*=============================================================================
+ Headings
+=============================================================================*/
+
+ h1, h2, h3, h4, h5, h6
+ {
+ text-align: left;
+ margin: 1em 0em 0.5em 0em;
+ font-weight: bold;
+ }
+
+ h1 { font: 140% }
+ h2 { font: bold 140% }
+ h3 { font: bold 130% }
+ h4 { font: bold 120% }
+ h5 { font: italic 110% }
+ h6 { font: italic 100% }
+
+ /* Top page titles */
+ title,
+ h1.title,
+ h2.title
+ h3.title,
+ h4.title,
+ h5.title,
+ h6.title,
+ .refentrytitle
+ {
+ font-weight: bold;
+ margin-bottom: 1pc;
+ }
+
+ h1.title { font-size: 140% }
+ h2.title { font-size: 140% }
+ h3.title { font-size: 130% }
+ h4.title { font-size: 120% }
+ h5.title { font-size: 110% }
+ h6.title { font-size: 100% }
+
+ .section h1
+ {
+ margin: 0em 0em 0.5em 0em;
+ font-size: 140%;
+ }
+
+ .section h2 { font-size: 140% }
+ .section h3 { font-size: 130% }
+ .section h4 { font-size: 120% }
+ .section h5 { font-size: 110% }
+ .section h6 { font-size: 100% }
+
+ /* Code on titles */
+ h1 tt.computeroutput { font-size: 140% }
+ h2 tt.computeroutput { font-size: 140% }
+ h3 tt.computeroutput { font-size: 130% }
+ h4 tt.computeroutput { font-size: 120% }
+ h5 tt.computeroutput { font-size: 110% }
+ h6 tt.computeroutput { font-size: 100% }
+
+/*=============================================================================
+ Author
+=============================================================================*/
+
+ h3.author
+ {
+ font-size: 100%
+ }
+
+/*=============================================================================
+ Lists
+=============================================================================*/
+
+ li
+ {
+ font-size: 10pt;
+ line-height: 1.3;
+ }
+
+ /* Unordered lists */
+ ul
+ {
+ text-align: left;
+ }
+
+ /* Ordered lists */
+ ol
+ {
+ text-align: left;
+ }
+
+/*=============================================================================
+ Links
+=============================================================================*/
+
+ a
+ {
+ text-decoration: none; /* no underline */
+ }
+
+ a:hover
+ {
+ text-decoration: underline;
+ }
+
+/*=============================================================================
+ Spirit style navigation
+=============================================================================*/
+
+ .spirit-nav
+ {
+ text-align: right;
+ }
+
+ .spirit-nav a
+ {
+ color: white;
+ padding-left: 0.5em;
+ }
+
+ .spirit-nav img
+ {
+ border-width: 0px;
+ }
+
+/*=============================================================================
+ Table of contents
+=============================================================================*/
+
+ .toc
+ {
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.1pc 1pc 0.1pc 1pc;
+ font-size: 80%;
+ line-height: 1.15;
+ }
+
+ .boost-toc
+ {
+ float: right;
+ padding: 0.5pc;
+ }
+
+/*=============================================================================
+ Tables
+=============================================================================*/
+
+ .table-title,
+ div.table p.title
+ {
+ margin-left: 4%;
+ padding-right: 0.5em;
+ padding-left: 0.5em;
+ }
+
+ .informaltable table,
+ .table table
+ {
+ width: 92%;
+ margin-left: 4%;
+ margin-right: 4%;
+ }
+
+ div.informaltable table,
+ div.table table
+ {
+ padding: 4px;
+ }
+
+ /* Table Cells */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ padding: 0.5em;
+ text-align: left;
+ font-size: 9pt;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ padding: 0.5em 0.5em 0.5em 0.5em;
+ border: 1pt solid white;
+ font-size: 80%;
+ }
+
+/*=============================================================================
+ Blurbs
+=============================================================================*/
+
+ div.note,
+ div.tip,
+ div.important,
+ div.caution,
+ div.warning,
+ p.blurb
+ {
+ font-size: 9pt; /* A little bit smaller than the main text */
+ line-height: 1.2;
+ display: block;
+ margin: 1pc 4% 0pc 4%;
+ padding: 0.5pc 0.5pc 0.5pc 0.5pc;
+ }
+
+ p.blurb img
+ {
+ padding: 1pt;
+ }
+
+/*=============================================================================
+ Variable Lists
+=============================================================================*/
+
+ /* Make the terms in definition lists bold */
+ div.variablelist dl dt,
+ span.term
+ {
+ font-weight: bold;
+ font-size: 10pt;
+ }
+
+ div.variablelist table tbody tr td
+ {
+ text-align: left;
+ vertical-align: top;
+ padding: 0em 2em 0em 0em;
+ font-size: 10pt;
+ margin: 0em 0em 0.5em 0em;
+ line-height: 1;
+ }
+
+ div.variablelist dl dt
+ {
+ margin-bottom: 0.2em;
+ }
+
+ div.variablelist dl dd
+ {
+ margin: 0em 0em 0.5em 2em;
+ font-size: 10pt;
+ }
+
+ div.variablelist table tbody tr td p,
+ div.variablelist dl dd p
+ {
+ margin: 0em 0em 0.5em 0em;
+ line-height: 1;
+ }
+
+/*=============================================================================
+ Misc
+=============================================================================*/
+
+ /* Title of books and articles in bibliographies */
+ span.title
+ {
+ font-style: italic;
+ }
+
+ span.underline
+ {
+ text-decoration: underline;
+ }
+
+ span.strikethrough
+ {
+ text-decoration: line-through;
+ }
+
+ /* Copyright, Legal Notice */
+ div div.legalnotice p
+ {
+ text-align: left
+ }
+
+/*=============================================================================
+ Colors
+=============================================================================*/
+
+ @media screen
+ {
+ /* Links */
+ a
+ {
+ color: #005a9c;
+ }
+
+ a:visited
+ {
+ color: #9c5a9c;
+ }
+
+ h1 a, h2 a, h3 a, h4 a, h5 a, h6 a,
+ h1 a:hover, h2 a:hover, h3 a:hover, h4 a:hover, h5 a:hover, h6 a:hover,
+ h1 a:visited, h2 a:visited, h3 a:visited, h4 a:visited, h5 a:visited, h6 a:visited
+ {
+ text-decoration: none; /* no underline */
+ color: #000000;
+ }
+
+ /* Syntax Highlighting */
+ .keyword { color: #0000AA; }
+ .identifier { color: #000000; }
+ .special { color: #707070; }
+ .preprocessor { color: #402080; }
+ .char { color: teal; }
+ .comment { color: #800000; }
+ .string { color: teal; }
+ .number { color: teal; }
+ .white_bkd { background-color: #FFFFFF; }
+ .dk_grey_bkd { background-color: #999999; }
+
+ /* Copyright, Legal Notice */
+ .copyright
+ {
+ color: #666666;
+ font-size: small;
+ }
+
+ div div.legalnotice p
+ {
+ color: #666666;
+ }
+
+ /* Program listing */
+ pre.synopsis
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ .programlisting,
+ .screen
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ td .programlisting,
+ td .screen
+ {
+ border: 0px solid #DCDCDC;
+ }
+
+ /* Blurbs */
+ div.note,
+ div.tip,
+ div.important,
+ div.caution,
+ div.warning,
+ p.blurb
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ /* Table of contents */
+ .toc
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ /* Tables */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ border: 1px solid #DCDCDC;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ background-color: #F0F0F0;
+ border: 1px solid #DCDCDC;
+ }
+
+ /* Misc */
+ span.highlight
+ {
+ color: #00A000;
+ }
+ }
+
+ @media print
+ {
+ /* Links */
+ a
+ {
+ color: black;
+ }
+
+ a:visited
+ {
+ color: black;
+ }
+
+ .spirit-nav
+ {
+ display: none;
+ }
+
+ /* Program listing */
+ pre.synopsis
+ {
+ border: 1px solid gray;
+ }
+
+ .programlisting,
+ .screen
+ {
+ border: 1px solid gray;
+ }
+
+ td .programlisting,
+ td .screen
+ {
+ border: 0px solid #DCDCDC;
+ }
+
+ /* Table of contents */
+ .toc
+ {
+ border: 1px solid gray;
+ }
+
+ .informaltable table,
+ .table table
+ {
+ border: 1px solid gray;
+ border-collapse: collapse;
+ }
+
+ /* Tables */
+ div.informaltable table tr td,
+ div.table table tr td
+ {
+ border: 1px solid gray;
+ }
+
+ div.informaltable table tr th,
+ div.table table tr th
+ {
+ border: 1px solid gray;
+ }
+
+ /* Misc */
+ span.highlight
+ {
+ font-weight: bold;
+ }
+ }
+
+/*=============================================================================
+ Images
+=============================================================================*/
+
+ span.inlinemediaobject img
+ {
+ vertical-align: middle;
+ }
\ No newline at end of file
Added: sandbox/explore/libs/explore/doc/html/index.html
==============================================================================
--- (empty file)
+++ sandbox/explore/libs/explore/doc/html/index.html 2007-05-26 19:03:14 EDT (Sat, 26 May 2007)
@@ -0,0 +1,108 @@
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
+<title>Boost.Explore</title>
+<link rel="stylesheet" href="boostbook.css" type="text/css">
+<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
+<link rel="start" href="index.html" title="Boost.Explore">
+<link rel="next" href="boost_explore/tutorial.html" title=" Tutorial">
+</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="n" href="boost_explore/tutorial.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="boost_explore"></a>Boost.Explore</h2></div>
+<div><p class="copyright">Copyright © 2007 Jeff Garland</p></div>
+<div><div class="legalnotice">
+<a name="id308141"></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"> Tutorial</span></dt>
+<dt><span class="section"> Dependencies and Platforms</span></dt>
+<dt><span class="section"> Design Notes</span></dt>
+</dl>
+</div>
+<p>
+ Boost.Explore is a cross-platform C++ library for printing of containers.
+ </p>
+<a name="boost_explore..getting_started"></a><h2>
+<a name="id276942"></a>
+ Getting Started
+ </h2>
+<p>
+ Boost.explore is a library that provides for the output of data from containers
+ or ranges.
+ </p>
+<p>
+ The following are some simple usage examples:
+ </p>
+<pre class="programlisting">
+<span class="comment">//explore supports output for all stl container types
+</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="identifier">vi</span> <span class="special">+=</span> <span class="special">{</span><span class="number">1</span><span class="special">,</span><span class="number">2</span><span class="special">,</span><span class="number">3</span><span class="special">};</span> <span class="comment">//boost assign!
+</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">vi</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> <span class="comment">//prints [1, 2, 3]
+</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">stringstream</span> <span class="identifier">ss</span><span class="special">;</span>
+<span class="identifier">print</span><span class="special">(</span><span class="identifier">vi</span><span class="special">,</span> <span class="identifier">ss</span><span class="special">);</span> <span class="comment">//prints [1, 2, 3]
+</span><span class="comment">//lets do some containers in containers
+</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">vector</span><span class="special"><</span><span class="keyword">int</span><span class="special">></span> <span class="special">></span> <span class="identifier">vvi</span><span class="special">;</span>
+<span class="identifier">vvi</span><span class="special">.</span><span class="identifier">push_back</span><span class="special">(</span><span class="identifier">vi</span><span class="special">);</span>
+<span class="identifier">vvi</span><span class="special">.</span><span class="identifier">push_back</span><span class="special">(</span><span class="identifier">vi</span><span class="special">);</span>
+<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">vi</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> <span class="comment">//prints [[1, 2, 3], [1, 2, 3]]
+</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">map</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="keyword">int</span><span class="special">></span> <span class="identifier">si_map</span><span class="special">;</span>
+<span class="identifier">si_map</span><span class="special">[</span><span class="string">"hello"</span><span class="special">]</span> <span class="special">=</span> <span class="number">1</span><span class="special">;</span>
+<span class="identifier">si_map</span><span class="special">[</span><span class="string">"world"</span><span class="special">]</span> <span class="special">=</span> <span class="number">2</span><span class="special">;</span>
+<span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">si_map</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> <span class="comment">//prints [hello:1, world:2]
+</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">list</span><span class="special"><</span><span class="identifier">date</span><span class="special">></span> <span class="identifier">dl</span><span class="special">;</span> <span class="comment">//date from boost::gregorian
+</span><span class="identifier">dl</span><span class="special">.</span><span class="identifier">push_back</span><span class="special">(</span><span class="identifier">date</span><span class="special">(</span><span class="number">2007</span><span class="special">,</span> <span class="identifier">Jan</span><span class="special">,</span> <span class="number">1</span><span class="special">));</span>
+<span class="identifier">dl</span><span class="special">.</span><span class="identifier">push_back</span><span class="special">(</span><span class="identifier">date</span><span class="special">(</span><span class="number">2007</span><span class="special">,</span> <span class="identifier">Jan</span><span class="special">,</span> <span class="number">3</span><span class="special">));</span>
+<span class="comment">//printing of user defined types uses the types operator<< if available
+</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">dl</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> <span class="comment">//prints [2007-Jan-1, 2007-Jan-3]
+</span><span class="comment">//how about some boost container types:
+</span><span class="identifier">boost</span><span class="special">::</span><span class="identifier">array</span><span class="special"><</span><span class="identifier">std</span><span class="special">::</span><span class="identifier">string</span><span class="special">,</span> <span class="number">2</span><span class="special">></span> <span class="identifier">sa2</span><span class="special">;</span>
+<span class="identifier">sa2</span><span class="special">[</span><span class="number">0</span><span class="special">]</span> <span class="special">=</span> <span class="string">"one"</span><span class="special">;</span>
+<span class="identifier">sa2</span><span class="special">[</span><span class="number">1</span><span class="special">]</span> <span class="special">=</span> <span class="string">"two"</span><span class="special">;</span>
+</pre>
+<p>
+ The tutorial shows more details
+ on using explore.
+ </p>
+<p>
+ While explore is powerful and flexible, it is not infinitely flexible. The reasons
+ for this are discussed in the design
+ section.For very complex output custom methods or a template output system should
+ be considered.
+ </p>
+<a name="boost_explore..acknowledgements"></a><h2>
+<a name="id317776"></a>
+ Acknowledgements
+ </h2>
+<p>
+ Most of the major concepts and interfaces for this library were developed at
+ BoostCon 2007. There were many participants in the 8:00 am sessions that developed
+ the interfaces and concepts. Notably Hartmut Kaiser, Joao ???, and Joel De Guzman
+ for discussing Karma and doing some initial prototypes.
+ </p>
+</div>
+<table width="100%"><tr>
+<td align="left"><small><p>Last revised: May 27, 2007 at 15:50:13 GMT</p></small></td>
+<td align="right"><small></small></td>
+</tr></table>
+<hr>
+<div class="spirit-nav"><a accesskey="n" href="boost_explore/tutorial.html"><img src="../../../../doc/html/images/next.png" alt="Next"></a></div>
+</body>
+</html>
Added: sandbox/explore/libs/explore/doc/tutorial.qbk
==============================================================================
--- (empty file)
+++ sandbox/explore/libs/explore/doc/tutorial.qbk 2007-05-26 19:03:14 EDT (Sat, 26 May 2007)
@@ -0,0 +1,41 @@
+[/
+ / Copyright (c) 2007 Jeff Garland (jeff at crystalclearsoftware dot com)
+ /
+ / 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)
+ /]
+
+[section:tutorial Tutorial]
+
+[h2 Basic Container Printing]
+
+
+All of the explore library can be used by simply including the `"explore.hpp"`
+header file.
+
+ ``''''''``#include <boost/explore.hpp>
+ ``''''''``using namespace boost::explore;
+
+
+More granular headers are also available under boost/explore.
+
+
+
+[h2 Customizing Delimiters]
+
+When printing a container explore users user several delimeters:
+
+* opening - printed at the start of the container default: '\['
+* closing - printed at the end of the container default: '\]'
+* delimiter - printed between each element default: ', '
+
+
+[h2 Printing of Contained Items]
+
+
+
+
+
+
+
+[endsect]
\ No newline at end of file