[Boost-commit] svn:boost r48732 - sandbox/SOC/2008/graphs/trunk/libs/graphs/doc

Subject: [Boost-commit] svn:boost r48732 - sandbox/SOC/2008/graphs/trunk/libs/graphs/doc
From: asutton_at_[hidden]
Date: 2008-09-11 08:48:47

Author: asutton
Date: 2008-09-11 08:48:47 EDT (Thu, 11 Sep 2008)
New Revision: 48732
URL: http://svn.boost.org/trac/boost/changeset/48732

Log:
Still working on the build
Added:
   sandbox/SOC/2008/graphs/trunk/libs/graphs/doc/graphs.qbk
      - copied, changed from r48390, /sandbox/SOC/2008/graphs/trunk/libs/graphs/doc/graph.qbk
Removed:
   sandbox/SOC/2008/graphs/trunk/libs/graphs/doc/graph.qbk
Text files modified: 
   sandbox/SOC/2008/graphs/trunk/libs/graphs/doc/Jamfile    |    94 ++++++++++++++++++++++----------------- 
   sandbox/SOC/2008/graphs/trunk/libs/graphs/doc/graphs.qbk |    18 +++++-                                  
   2 files changed, 67 insertions(+), 45 deletions(-)

Modified: sandbox/SOC/2008/graphs/trunk/libs/graphs/doc/Jamfile
==============================================================================
--- sandbox/SOC/2008/graphs/trunk/libs/graphs/doc/Jamfile	(original)
+++ sandbox/SOC/2008/graphs/trunk/libs/graphs/doc/Jamfile	2008-09-11 08:48:47 EDT (Thu, 11 Sep 2008)
@@ -1,46 +1,58 @@
+# (C) Copyright 2008 Andrew Sutton
+# Distributed under the Boost Software License, Version 1.0.
 
+# Import a couple of modules (i.e., quickbook)
 using quickbook ;
+using boostbook ;
 
-# path-constant images_location : html ;
+# If not set, explicitly (at least on my system), these will cause
+# BoostBook to complain loudly. These can be passed directly to the
+# using statement above, but this keeps the Jamfile a little bit
+# cleaner.
+#
+# export DOCBOOK_XSL_DIR=/usr/share/xml/docbook/stylesheet/nwalsh
+# export DOCBOOK_DTD_DIR=/usr/share/xml/docbook/schema/dtd/4.5
 
-xml graph : graph.qbk ;
+path-constant images_location : html ;
 
-# boostbook standalone
-#     :
-#         graph
-#     :
-#         # Paths
-#         <xsl:param>boost.root=$(boost-root)
-#         <xsl:param>boost.libraries=$(boost-root)/libs/libraries.htm
-#         <xsl:param>html.stylesheet=$(boost-root)/doc/html/boostbook.css
-# 
-#         # General style settings:
-#         <xsl:param>table.footnote.number.format=1
-#         <xsl:param>footnote.number.format=1
-# 
-#         # HTML options
-#         <xsl:param>navig.graphics=1
-#         <xsl:param>chunk.section.depth=10
-#         <xsl:param>chunk.first.sections=1
-#         <xsl:param>toc.section.depth=10
-#         <xsl:param>toc.max.depth=4
-#         <xsl:param>generate.section.toc.level=10
-#         #<xsl:param>root.filename="sf_dist_and_tools"
-# 
-#         # PDF options
-#         <xsl:param>fop1.extensions=0
-#         <xsl:param>admon.graphics=1
-#         <format>pdf:<xsl:param>xep.extensions=1
-#         <format>pdf:<xsl:param>fop.extensions=0
-#         <format>pdf:<xsl:param>body.start.indent=0pt
-#         <format>pdf:<xsl:param>page.margin.inner=0.5in
-#         <format>pdf:<xsl:param>page.margin.inner=0.5in
-#         <format>pdf:<xsl:param>page.margin.outer=0.5in
-#         <format>pdf:<xsl:param>paper.type=A4
-#         <format>pdf:<xsl:param>admon.graphics.extension=".svg"
-#         <format>pdf:<xsl:param>use.role.for.mediaobject=1
-#         <format>pdf:<xsl:param>preferred.mediaobject.role=print
-#         <format>pdf:<xsl:param>img.src.path=$(images_location)/
-#         <format>pdf:<xsl:param>admon.graphics.path=$(images_location)/images/
-#         <format>pdf:<xsl:param>draft.mode="no"
-#     ;
\ No newline at end of file
+# Build the XML document using quickbook
+xml graphs : graph.qbk ;
+
+# Build the library documentation
+boostbook standalone : graphs
+    :
+        # Paths
+        <xsl:param>boost.root=$(boost-root)
+        <xsl:param>boost.libraries=$(boost-root)/libs/libraries.htm
+        <xsl:param>html.stylesheet=$(boost-root)/doc/html/boostbook.css
+
+        # General style settings:
+        <xsl:param>table.footnote.number.format=1
+        <xsl:param>footnote.number.format=1
+
+        # HTML options
+        <xsl:param>navig.graphics=1
+        <xsl:param>chunk.section.depth=10
+        <xsl:param>chunk.first.sections=1
+        <xsl:param>toc.section.depth=10
+        <xsl:param>toc.max.depth=4
+        <xsl:param>generate.section.toc.level=10
+        #<xsl:param>root.filename="sf_dist_and_tools"
+
+        # PDF options
+        <xsl:param>fop1.extensions=0
+        <xsl:param>admon.graphics=1
+        <format>pdf:<xsl:param>xep.extensions=1
+        <format>pdf:<xsl:param>fop.extensions=0
+        <format>pdf:<xsl:param>body.start.indent=0pt
+        <format>pdf:<xsl:param>page.margin.inner=0.5in
+        <format>pdf:<xsl:param>page.margin.inner=0.5in
+        <format>pdf:<xsl:param>page.margin.outer=0.5in
+        <format>pdf:<xsl:param>paper.type=A4
+        <format>pdf:<xsl:param>admon.graphics.extension=".svg"
+        <format>pdf:<xsl:param>use.role.for.mediaobject=1
+        <format>pdf:<xsl:param>preferred.mediaobject.role=print
+        <format>pdf:<xsl:param>img.src.path=$(images_location)/
+        <format>pdf:<xsl:param>admon.graphics.path=$(images_location)/images/
+        <format>pdf:<xsl:param>draft.mode="no"
+    ;

Deleted: sandbox/SOC/2008/graphs/trunk/libs/graphs/doc/graph.qbk
==============================================================================
--- sandbox/SOC/2008/graphs/trunk/libs/graphs/doc/graph.qbk	2008-09-11 08:48:47 EDT (Thu, 11 Sep 2008)
+++ (empty file)
@@ -1,122 +0,0 @@
-[article Graph Library
-    [quickbook 1.4]
-    [version 0.1]
-    [authors [Andrew Sutton]]
-    [copyright 2008 Andrew Sutton]
-]
-
-[def DefaultConstructible `DefaultConstructible]
-[def CopyConstructible `CopyConstructible`]
-[def LessThanComparable `LessThanComparable`]
-[def Hashable `Hashable`]
-
-This graph library...
-
-[include descriptors.qbk]
-
-[section Adjacency Lists]
-One of the most common and flexible graph data structures is the adjacency list.
-The adjacenct list component of this library provides implementations for both
-directed and undirected graphs. Adjacency list types can be defined as follows,
-depending on whether you want directed or undirected graphs.
-
-``
-typedef undirected_graph<VertexLabel, EdgeLabel, VertexSet, EdgeSet, Policies> Graph;
-typedef directed_graph<VertexLabel, EdgeLabel, VertexSet, EdgeSet, Policies> Graph;
-``
-
-Several graph types are provided to encapsulate common implementations.
-
-``
-typedef graph<VertexLabel, EdgeLabel> Graph;        // A simple undirected graph
-typedef digraph<VertexLabel, EdgeLabel> Graph;      // A simple directed graph
-``
-
-[section Vertex and Edge Labels]
-Vertex and Edge labels allow you to attach data to the vertices and edges of the
-graph in much the same manner as creating standard containers. In general, you
-can use almost any type as a label for vertices or edges, although they are
-required to be [DefaultConstructible] and [CopyConstructible] at a minimum. To
-explicitly specify the absence of type, you can use `none` as a value for that
-type.
-
-The choice of the `VertexSet` can also impose additional requirements on the
-vertex labels in your graph. If you choose `vertex_set` then the `VertexLabel`
-type must also be [LessThanComparable]. If you choose `vertex_unordered_set`,
-then the `VertexLabel` type must be [Hashable].
-
-Vertex properties are accessible via the `properties()` function:
-
-``
-vertex_label& Graph::properties(vertex_descriptor v);
-vertex_label const& Graph::properties(vertex_descriptor v) const;
-``
-
-[endsect]
-
-[section The Vertex Set]
-The vertex set component of the graph is responsible for the storage of vertices
-within the graph. In fact, The selection of `VertexSet` type helps to define the
-overall interface of the graph, based on the properties of the underlying container.
-
-There are a number of aspects to consider when selecting the vertex set for your
-graph: mutability, labels, queries, and performance. Here, mutabilty
-refers to the operations available for modifying the graph. Some vertex sets have
-restricted mutability due to performance constraints. Labeling refers to any
-additional constraints placed on the the `VertexLabel`. Specifically, labels can
-be unique via comparability or hashing. Some vertex sets disallow the use of the
-`none` type as a `VertexLabel`. Queryability is the ability to find vertices based
-on their labels. The performance profile describes the relative "classes" of
-performance for insert, remove, and find operations.
-
-There are essentially four distinct types of sets that can be selected: vector,
-list, set, and map. Each type vertex set has different profiles with respect to
-these aspects. There are multiple implementations of each.
-
-[heading Vertex Vector]
-``
-    vertex_vector<Allocator = std::allocator>
-``
-
-* ['mutability] - Add only
-* ['labels] - Not unique, Allows `none`.
-* ['query] - Find first
-* ['performance] - Constant add, Linear find
-
-[heading Vertex List]
-``
-    vertex_list<Allocator = std::allocator>
-``
-
-* ['mutability] - Add and Remove
-* ['labels] - Not unique, Allows `none`.
-* ['query] - Find first
-* ['performance] - Constant add and remove, Linear find
-
-[heading Vertex Set]
-``
-    vertex_set<Comparator = std::less, Allocator = std::allocator>
-``
-
-* ['mutability] - Add and Remove
-* ['labels] - Sorted on [LessThanComparable], Not `none`.
-* ['query] - Find unique
-* ['performance] - Logarithmic add, remove, and find
-
-[heading Vertex Map]
-``
-    vertex_map<Key, Comparator = st::less, Allocator = std::allocator>
-``
-* ['mutability] - Add and Remove
-* ['labels] - Mapped on [LessThanComparable] key, Not `none`
-* ['query] - Find unique
-* ['performance] - Logarithmic add, remove, and find
-
-[endsect]
-
-[section The Edge Set]
-The edge set component of the graph is responsible for defining how edges are
-stored in the graph.
-[endsect]
-
-[endsect]
\ No newline at end of file

Copied: sandbox/SOC/2008/graphs/trunk/libs/graphs/doc/graphs.qbk (from r48390, /sandbox/SOC/2008/graphs/trunk/libs/graphs/doc/graph.qbk)
==============================================================================
--- /sandbox/SOC/2008/graphs/trunk/libs/graphs/doc/graph.qbk	(original)
+++ sandbox/SOC/2008/graphs/trunk/libs/graphs/doc/graphs.qbk	2008-09-11 08:48:47 EDT (Thu, 11 Sep 2008)
@@ -1,8 +1,18 @@
-[article Graph Library
-    [quickbook 1.4]
-    [version 0.1]
-    [authors [Andrew Sutton]]
+[library Boost.Graph
+    [quickbook 1.3]
+    [authors [Sutton, Andrew]]
     [copyright 2008 Andrew Sutton]
+    [category graph]
+    [id graph]
+    [dirname graph]
+    [purpose
+        Graph data structures and algorithms.
+    ]
+    [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])
+    ]
 ]
 
 [def DefaultConstructible `DefaultConstructible]