Boost-Commit :

Date view	Thread view	Subject view	Author view

From: pbristow_at_[hidden]
Date: 2008-01-17 13:45:31

Next message: eric_at_[hidden]: "[Boost-commit] svn:boost r42836 - in trunk/libs/python: src/object test"
Previous message: pbristow_at_[hidden]: "[Boost-commit] svn:boost r42834 - sandbox/SOC/2007/visualization/libs/svg_plot/doc"

Author: pbristow
Date: 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
New Revision: 42835
URL: http://svn.boost.org/trac/boost/changeset/42835

Log:
Improvements to docs, but still much to do.
Text files modified:
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_full_tutorial.qbk | 33 ++---
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_simple_tutorial.qbk | 26 +++-
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_special_tutorial.qbk | 31 ++++-
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_tutorial.qbk | 2
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/acknowledgements.qbk | 2
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/colors.qbk | 21 ++
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html | 2
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/behavior/behavior_limits.html | 6
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/color.html | 41 +++++--
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/howtouse.html | 31 ++++
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_1d_plot_interface.html | 117 ++++++++++++---------
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_2d_plot_interface.html | 214 +++++++++++++++++++++++++++++++--------
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_boxplot_interface.html | 28 ++--
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_interface.html | 38 +-----
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults/1d_defaults.html | 2
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults/2d_defaults.html | 2
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_boxplot_tutorial/svg_boxplot_tutorial_simple.html | 14 +-
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple/2d_simple_code_example.html | 38 +++++--
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple/2d_special.html | 33 +++--
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple/full_2d_layout.html | 41 +++---
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple/1d_special.html | 4
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple/tutorial_code_1d_example.html | 4
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_stylesheet.html | 2
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/interface.qbk | 179 +++++++++++++++++---------------
   sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_interface.qbk | 10 +
   sandbox/SOC/2007/visualization/libs/svg_plot/test/test_svg.cpp | 38 +++---
   26 files changed, 597 insertions(+), 362 deletions(-)

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_full_tutorial.qbk
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_full_tutorial.qbk (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_full_tutorial.qbk 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -10,39 +10,42 @@
 double f(double x)
 {
 return sqrt(x);
+ // Note: negative values will all return NaN.
 }

 double g(double x)
 {
- return -2 + x*x;
+ return -2 + x * x;
 }

 double h(double x)
 {
- return -1 + 2*x;
+ return -1 + 2 * x;
 }

 int main()
 {
 multimap<double, double> data1, data2, data3;

- for(double i=0; i<=10.; i+=1.)
- {
+ for(double i = 0; i <= 10.; i += 1.)
+ { // Evaluate the functions as demonstration data.
 data1[i] = f(i);
 data2[i] = g(i);
 data3[i] = h(i);
 }

- svg_2d_plot my_plot;
+ svg_2d_plot my_plot; // Construct a new plot.

- // Size/scale settings.
+ // Override a few default settings with our choices:
+
+ // Size of SVG image and X and Y range settings.
 my_plot.image_size(700, 500)
 .x_range(-1, 10)
 .y_range(-5, 100)

 // Text settings.
 my_plot.title("Plot of Mathematical Functions")
- .title_font_size(29)
+ .title_font_size(25)
 .x_label("Time in Months");

 // Commands.
@@ -58,7 +61,7 @@
 .plot_background_color(svg_color(136, 188, 126))
 .title_color(white);

- //X axis settings.
+ // X axis settings.
 my_plot.x_major_interval(2)
 .x_major_tick_length(14)
 .x_major_tick_width(1)
@@ -73,15 +76,11 @@
 // Legend settings.
 my_plot.legend_title_font_size(15);

- my_plot.plot(data1, "Sqrt(x)", blue,
- _point_style = none,
- _show_line = true);
-
- my_plot.plot(data2, "-2 + x^2", orange,
- _show_line = true);
-
- my_plot.plot(data3, "-1 + 2x", red,
- _point_style = square);
+ // Add the 3 data series to the plot, using different markers and line colors.
+ my_plot.plot(data1, "Sqrt(x)").fill_color(red);
+ my_plot.plot(data2, "-2 + x^2").fill_color(orange).size(5);
+ my_plot.plot(data3, "-1 + 2x").fill_color(yellow).bezier_on(true).line_color(blue).shape(square);
+ // Note how the options can be chained.

 my_plot.write("2d_full.svg");

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_simple_tutorial.qbk
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_simple_tutorial.qbk (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_simple_tutorial.qbk 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -43,7 +43,13 @@

   svg_2d_plot my_plot;

-This constructor initializes a new 2D plot. This also sets the many default values.
+This constructor initializes a new 2D plot. This also sets the very many default values.
+
+We could accept all of these and just plot one series of data with
+
+ my_plot.plot(map1, "Series 1"); // Data point marker color is default black.
+
+but we can also add a few optional details:

   my_plot.title("Race Times")
          .legend_on(true)
@@ -53,28 +59,32 @@
All of the setter methods are fairly self-explanatory. To walk through it once,

* The title, which will appear at the top of the graph, will say "Race Times".
-* `legend_on(true)` means that the legend will show up.
+* `legend_on(true)` means that the legend box will show up (by default at top right).
* `x_range(-1, 11)` means that the axis displayed will be between -1 and 11,
as you can see in the above images.
* `background_border_color(black)` sets the border around the image to `black`.
-Ordinarily it is left to be the color of the background
-(and so no border of plot area will be visible).
+Ordinarily it is left to be the color of the whole image background
+(and so no border of the plot area will be visible).

   my_plot.plot(map1, "Series 1", blue);
   my_plot.plot(map2, "Series 2", orange);

This draws `map1` and `map2` to `my_plot`. As many containers as you want can
-be drawn to `my_plot`. Evntually the plot will become cluttered and confusing,
-when I recommend just creating another plot!
+be drawn to `my_plot`. Eventually the plot will become cluttered and confusing,
+when creating other plot(s) becomes sensible!

The name of the series is `"Race times"`, and that
-text will show in the legend. These are the two required parameters for
+text will show in the legend box. These are the two required parameters for
this function call. There are many optional parameters, as seen in the section
[@plot_function Getting More Out of the `plot()` Function]

+Finally
+
   my_plot.write("simple_2d.svg");

-This writes plot `my_plot` to the file "simple_2d.svg".
+writes plot `my_plot` to the file "simple_2d.svg".
+
+You can view this file with most internet browsers, and other programs too.

[endsect] [/section:tutorial_code_simple Simple program]

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_special_tutorial.qbk
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_special_tutorial.qbk (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_special_tutorial.qbk 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -11,7 +11,9 @@
To style it, you could use the following calls:

 my_plot.y_major_grid_color(lightgray) // Darker color for major grid.
- .y_minor_grid_color(whitesmoke); // lighter color for minor grid.
+ .y_minor_grid_color(whitesmoke); // Lighter color for minor grid.
+
+

This will produce the following image:

@@ -22,10 +24,15 @@
 my_plot.x_major_grid_on(true)
 .x_minor_grid_on(true);

-and color it similarly:
+and color it similarly for faint blues like old fashioned graph paper:
+
+ my_plot.y_major_grid_color(svg_color(200, 220, 255)) // Darker color for major grid.
+ .y_minor_grid_color(svg_color(240, 240, 255); // lighter color for minor grid.

- my_plot.y_major_grid_color(lightblue) // Darker color for major grid.
- .y_minor_grid_color(azure); // lighter color for minor grid.
+and to make the major grid much wider than the minor grid:
+
+ my_plot.y_major_grid_width(4)
+ .y_minor_grid_width(1)

[heading External Y Axis Style]

@@ -38,12 +45,12 @@

[heading Fill the area between the plot and the axis]

-When there is a call to the plot() method, define `_area_fill_color`
+When there is a call to the plot() method, define `area_fill_color`

 multimap<double, double> my_data;
 svg_2d_plot my_plot;

- my_plot.plot(my_data, "Data", _area_fill_color(red));
+ my_plot.plot(my_data, "Data", area_fill_color(red));

This produces the following image:

@@ -55,13 +62,21 @@
(rather than the default straight lines joining points),
simply use the following command:

- my_plot.plot(data, "Series 1", _bezier_curve = "true");
+ my_plot.plot(data, "Series 1", bezier_on(true);

This produces something like the following images:

[$images/2d_bezier.png]

-[warning The `_bezier_curve` feature still displays undesired behavior in extreme circumstances. Do not use this feature with curves that have a numeric_limit value (`-NaN`, for example), or with data that has high irregularity in X-Axis spacing (for example, a clump of points between (0, 1) on the X axis, with the next one at 100 on the X axis.)]
+[warning The `_bezier_curve` feature still displays undesired behavior in extreme circumstances.
+Do not use this feature with curves that have a numeric_limit value (`-NaN`, for example),
+or with data that has high irregularity in X-Axis spacing
+(for example, a clump of points between (0, 1) on the X axis,
+with the next one at 100 on the X axis.)
+In general, curves must be reasonably well-behaved to be smoothable.
+In general, using more data points will make smoothing work better,
+but wil increase svg file sizes.
+]

[endsect] [/2d_special Tutorial: 2D Special Features]

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_tutorial.qbk
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_tutorial.qbk (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/2d_tutorial.qbk 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -1,9 +1,7 @@
[section:tutorial_2d_code_simple Tutorial: 2D]

[include 2d_simple_tutorial.qbk]
-
[include 2d_full_tutorial.qbk]
-
[include 2d_special_tutorial.qbk]

[endsect] [/2d_tutorial]

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/acknowledgements.qbk
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/acknowledgements.qbk (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/acknowledgements.qbk 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -17,7 +17,7 @@
[endsect] [/section:acknowledgements]

[/ acknowledgements.qbk
- Copyright 2008 Jake Voytko and Paul A. Bristow.
+ Copyright 2008 Jake Voytko.
   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).

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/colors.qbk
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/colors.qbk (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/colors.qbk 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -13,9 +13,13 @@

Examples of colors are at [@../../../svg_plot/example/svg_colors.cpp svg_colors.cpp].

-The
-[@http://www.w3.org/TR/SVG/types.html#ColorKeywords colors are defined by the SVG standard here].
-The list contains all of your expected colors, such as magenta, pink and red, and many other shades.
+[@http://www.w3.org/TR/SVG/types.html#ColorKeywords Colors are defined by the SVG standard].
+The list contains all your expected colors,
+such as red, blue, green, magenta, cyan, yellow, pink and orange,
+as well as nearly 150 other shades.
+
+You will probably still find that the colors names do not meet your requirements
+and so it is also possible to define any RGB combination.

The list also contains one extra color element, `blank`, defined as `false`,
used when you need to pass a color, but would not like it to be visible.
@@ -41,7 +45,7 @@
``
does not have the desired effect, and nor does
`cout << red << endl;`
-output the expected RGB(255,0,0) but instead 119 the value of the enum!]
+output the expected "RGB(255,0,0)" but instead "119", the value of the enum!]

[h4 `svg_color` interface]

@@ -53,7 +57,9 @@
 // Use a pre-existing color constant.
 svg_color(svg_color_constant);

-[important Any integer value is accepted but negative values are contrained 0, and positive values > 255 are constrained to 255.]
+[important Any integer value is accepted
+but negative values are constrained to 0,
+and positive values > 255 are constrained to 255.]

[h4 Example of using `svg_color`]

@@ -64,6 +70,11 @@

 BOOST_ASSERT(my_white == const_white);

+[note You will find it convenient to use the namespace boost::svg,
+perhaps at local scope,
+to avoid having to fully qualify *every* color that you want to use,
+for example: `using boost::svg::azure;`
+]

[note `svg_color`'s constructor takes in three integer values.
The [@http://www.w3.org/TR/SVG11/types.html SVG 1.1 standard]

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/index.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -95,7 +95,7 @@
</div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left">Last revised: January 15, 2008 at 10:46:54 GMT</td>
+<td align="left">Last revised: January 17, 2008 at 18:41:35 GMT</td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/behavior/behavior_limits.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/behavior/behavior_limits.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/behavior/behavior_limits.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -43,7 +43,7 @@
 whitesmoke</code>. This will become customizable.
 
<a name="svg_plot.behavior.behavior_limits.nan"></a><h5>
-<a name="id689274"></a>
+<a name="id689680"></a>
 <a href="behavior_limits.html#svg_plot.behavior.behavior_limits.nan">NaN</a>
 </h5>

@@ -53,7 +53,7 @@
 user-defined coordinates as 0.
 
<a name="svg_plot.behavior.behavior_limits.infinity"></a><h5>
-<a name="id689333"></a>
+<a name="id689740"></a>
 <a href="behavior_limits.html#svg_plot.behavior.behavior_limits.infinity">Infinity</a>
 </h5>

@@ -70,7 +70,7 @@
 appear at the top of the graph.
 
<a name="svg_plot.behavior.behavior_limits.negative_infinity"></a><h5>
-<a name="id689469"></a>
+<a name="id689876"></a>
 <a href="behavior_limits.html#svg_plot.behavior.behavior_limits.negative_infinity">Negative
 Infinity</a>
 </h5>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/color.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/color.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/color.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -32,7 +32,7 @@
 by the SVG standard</a>.
 
<a name="svg_plot.color._code__phrase_role__identifier__svg_color_constant__phrase___code_"></a><h4>
-<a name="id622212"></a>
+<a name="id622265"></a>
 <a href="color.html#svg_plot.color._code__phrase_role__identifier__svg_color_constant__phrase___code_"><code class="computeroutput">svg_color_constant</code></a>
 </h4>

@@ -46,9 +46,14 @@
 Examples of colors are at svg_colors.cpp.
 

- The <a href="http://www.w3.org/TR/SVG/types.html#ColorKeywords" target="_top">colors are
- defined by the SVG standard here</a>. The list contains all of your expected
- colors, such as magenta, pink and red, and many other shades.
+ <a href="http://www.w3.org/TR/SVG/types.html#ColorKeywords" target="_top">Colors are defined
+ by the SVG standard</a>. The list contains all your expected colors, such
+ as red, blue, green, magenta, cyan, yellow, pink and orange, as well as nearly
+ 150 other shades.
+ 
+
+ You will probably still find that the colors names do not meet your requirements
+ and so it is also possible to define any RGB combination.
 

 The list also contains one extra color element, <code class="computeroutput">blank</code>,
@@ -57,7 +62,7 @@
 for defining defaults for functions, for example.
 
<a name="svg_plot.color.example_of_using__code__phrase_role__identifier__svg_color_constant__phrase___code_"></a><h5>
-<a name="id622335"></a>
+<a name="id622398"></a>
 <a href="color.html#svg_plot.color.example_of_using__code__phrase_role__identifier__svg_color_constant__phrase___code_">Example
 of using <code class="computeroutput">svg_color_constant</code></a>
 </h5>
@@ -92,13 +97,13 @@

 does not have the desired effect, and nor does <code class="computeroutput">cout
 << red
- << endl;</code> output the expected RGB(255,0,0) but instead
- 119 the value of the enum!
+ << endl;</code> output the expected "RGB(255,0,0)"
+ but instead "119", the value of the enum!
 
</td></tr>
</table></div>
<a name="svg_plot.color._code__phrase_role__identifier__svg_color__phrase___code__interface"></a><h5>
-<a name="id678342"></a>
+<a name="id678404"></a>
 <a href="color.html#svg_plot.color._code__phrase_role__identifier__svg_color__phrase___code__interface"><code class="computeroutput">svg_color</code> interface</a>
 </h5>

@@ -118,12 +123,12 @@
<th align="left">Important</th>
</tr>
<tr><td align="left" valign="top">
- Any integer value is accepted but negative values are contrained 0, and positive
- values > 255 are constrained to 255.
+ Any integer value is accepted but negative values are constrained to 0, and
+ positive values > 255 are constrained to 255.
 </td></tr>
</table></div>
<a name="svg_plot.color.example_of_using__code__phrase_role__identifier__svg_color__phrase___code_"></a><h5>
-<a name="id678494"></a>
+<a name="id678556"></a>
 <a href="color.html#svg_plot.color.example_of_using__code__phrase_role__identifier__svg_color__phrase___code_">Example
 of using <code class="computeroutput">svg_color</code></a>
 </h5>
@@ -141,6 +146,18 @@
<th align="left">Note</th>
</tr>
<tr><td align="left" valign="top">
+ You will find it convenient to use the namespace boost::svg, perhaps at local
+ scope, to avoid having to fully qualify every
+ color that you want to use, for example: <code class="computeroutput">using
+ boost::svg::azure;</code>
+ </td></tr>
+</table></div>
+<div class="note"><table border="0" summary="Note">
+<tr>
+<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../../../trunk/doc/html/images/note.png"></td>
+<th align="left">Note</th>
+</tr>
+<tr><td align="left" valign="top">
 <code class="computeroutput">svg_color</code>'s constructor takes
 in three integer values. The <a href="http://www.w3.org/TR/SVG11/types.html" target="_top">SVG
 1.1 standard</a> allows any integer to represent an RGB value, with values
@@ -149,7 +166,7 @@
 </td></tr>
</table></div>
<a name="svg_plot.color.colors_internals_and_rationale"></a><h4>
-<a name="id678730"></a>
+<a name="id678854"></a>
 <a href="color.html#svg_plot.color.colors_internals_and_rationale">Colors Internals
 and Rationale</a>
 </h4>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/howtouse.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/howtouse.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/howtouse.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -137,12 +137,33 @@
 and file format for describing two-dimensional vector graphics.
 

- SVG files (.svg) can be viewed with a browser like Mozilla Firefox (newer version),
- <a href="http://www.adobe.com/products/acrobat/readstep2.htmlAdobe" target="_top">Acrobat
- Reader</a>, many other graphics program, and by Microsoft Internet Explorer,
- provided a suitable <a href="http://www.adobe.com/svg/" target="_top">Adobe SVG Veiwer
- plug-in for SVG files</a> is installed.
+ SVG files (.svg) can be viewed with a internet browser:
 
+<div class="itemizedlist"><ul type="disc">
+<li>
+ Mozilla Firefox (newer versions), <a href="http://www.adobe.com/products/acrobat/readstep2.htmlAdobe" target="_top">Acrobat
+ Reader</a>,
+ </li>
+<li>
+Opera has <a href="http://www.opera.com/docs/specs/svg/" target="_top">svg
+ support</a> but the quality if redering is often not as good as other
+ browsers.
+ </li>
+<li>
+ Microsoft Internet Explorer, provided a suitable <a href="http://www.adobe.com/svg/" target="_top">Adobe
+ SVG Viewer plug-in for SVG files</a> is installed,
+ </li>
+<li>
+<a href="http://www.inkscape.org/" target="_top">Inkscape, a fine Open Source SVG viewer
+ with excellent rendering, full scaling and other editing features. * and
+ by many other graphics programs.</a>[@http:/www.inkscape.org
+ Inkscape, a fine Open Source SVG viewer with excellent rendering, full scaling
+ and other editing features.
+ </li>
+<li>
+ and by many other graphics programs.
+ </li>
+</ul></div>

 The goals of the project are:

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_1d_plot_interface.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_1d_plot_interface.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_1d_plot_interface.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -28,7 +28,7 @@
<a name="svg_plot.interface.svg_1d_plot_interface"></a> svg_1d_plot Public Interface
</h3></div></div></div>
<div class="table">
-<a name="id695552"></a>Table 7. 1D_plot Miscellaneous Functions
+<a name="id696024"></a>Table 7. 1D_plot Miscellaneous Functions
<div class="table-contents"><table class="table" summary="1D_plot Miscellaneous Functions">
<colgroup>
<col>
@@ -133,6 +133,19 @@
<td>
 
 <code class="computeroutput">svg_1d_plot&
+ legend_color(const svg_color& col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color to be used for the legend text.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
 title(const std::string&)</code>
 
 </td>
@@ -159,6 +172,19 @@
<td>
 
 <code class="computeroutput">svg_1d_plot&
+ title_color(const svg_color& col)</code>
+ 
+ </td>
+<td>
+ 
+ Sets the color to be used for the title.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
 write(const std::string&)</code>
 
 </td>
@@ -185,7 +211,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id696238"></a>Table 8. 1D_plot Commands
+<a name="id696862"></a>Table 8. 1D_plot Commands
<div class="table-contents"><table class="table" summary="1D_plot Commands">
<colgroup>
<col>
@@ -301,12 +327,12 @@
<td>
 
 <code class="computeroutput">svg_1d_plot&
- x_major_labels_on(bool)</code>
+ x_major_labels_on(int)</code>
 
 </td>
<td>
 
- sets whether or not the major ticks will be labelled on the X-axis
+ sets whether or not the major ticks will be labelled on the X-axis.
 
 </td>
</tr>
@@ -353,7 +379,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id696927"></a>Table 9. 1D_plot Colors
+<a name="id697550"></a>Table 9. 1D_plot Colors
<div class="table-contents"><table class="table" summary="1D_plot Colors">
<colgroup>
<col>
@@ -376,14 +402,27 @@
<td>
 
 <code class="computeroutput">svg_1d_plot&
+ background_color(const svg_color
+ &col)</code>
+ 
+ </td>
+<td>
+ 
+ Set the background color for the whole image.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg_1d_plot&
 background_border_color(const svg_color
 &col)</code>
 
 </td>
<td>
 
- Set the background border color for the legend as <code class="computeroutput">col</code>,
- an RGB color.
+ Set the background border color for the whole image as <code class="computeroutput">col</code>, an RGB color.
 
 </td>
</tr>
@@ -391,13 +430,13 @@
<td>
 
 <code class="computeroutput">svg_1d_plot&
- background_color(const svg_color
+ background_border_width(const svg_color
 &col)</code>
 
 </td>
<td>
 
- Set the background color for the whole image.
+ Set the background border width for the whole image.
 
 </td>
</tr>
@@ -512,7 +551,7 @@
 </td>
<td>
 
- Sets the color of the major ticks of the x-axis.
+ Sets the color of the major ticks of the X-axis.
 
 </td>
</tr>
@@ -526,7 +565,7 @@
 </td>
<td>
 
- Sets the color of the minor grid of the x-axis
+ Sets the color of the minor grid of the X-axis
 
 </td>
</tr>
@@ -540,7 +579,7 @@
 </td>
<td>
 
- Sets the color of the minor ticks of the x-axis.
+ Sets the color of the minor ticks of the X-axis.
 
 </td>
</tr>
@@ -548,7 +587,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id697913"></a>Table 10. 1D_plot X-Axis Definition
+<a name="id698612"></a>Table 10. 1D_plot X-Axis Definition
<div class="table-contents"><table class="table" summary="1D_plot X-Axis Definition">
<colgroup>
<col>
@@ -576,7 +615,7 @@
 </td>
<td>
 
- Sets the stroke width of the x-axis.
+ Sets the stroke width of the X-axis.
 
 </td>
</tr>
@@ -589,7 +628,7 @@
 </td>
<td>
 
- Sets the label of the x-axis. This does not guarantee that it will
+ Sets the label of the X-axis. This does not guarantee that it will
 be shown. You must call <code class="computeroutput">x_label_on(true)</code> to display.
 
 </td>
@@ -603,7 +642,7 @@
 </td>
<td>
 
- Sets the distance (in Cartesian units) between ticks on the x-axis.
+ Sets the distance (in Cartesian units) between ticks on the X-axis.
 
 </td>
</tr>
@@ -616,7 +655,7 @@
 </td>
<td>
 
- Sets the length (pixels) of the x-axis major ticks.
+ Sets the length (pixels) of the X-axis major ticks.
 
 </td>
</tr>
@@ -629,7 +668,7 @@
 </td>
<td>
 
- Sets the width (pixels) of the major ticks on the x-axis.
+ Sets the width (pixels) of the major ticks on the X-axis.
 
 </td>
</tr>
@@ -642,7 +681,7 @@
 </td>
<td>
 
- Sets the length (pixels) of the x-axis minor tick lengths.
+ Sets the length (pixels) of the X-axis minor tick lengths.
 
 </td>
</tr>
@@ -655,7 +694,7 @@
 </td>
<td>
 
- Sets the width (pixels) of the minor ticks on the x-axis.
+ Sets the width (pixels) of the minor ticks on the X-axis.
 
 </td>
</tr>
@@ -682,7 +721,7 @@
<td>
 
 Sets the scale of the x axis from x1 to x2. Throws an exception if
- x2<=x1.
+ x2<=x1, or if the range is too small to produce a useful plot.
 
 </td>
</tr>
@@ -690,7 +729,7 @@
</table></div>
</div>
 <a name="svg_plot.interface.svg_1d_plot_interface.the_1d_plot__code__phrase_role__identifier__plot__phrase__phrase_role__special______phrase___code__method"></a><h5>
-<a name="id698577"></a>
+<a name="id699275"></a>
 <a href="svg_1d_plot_interface.html#svg_plot.interface.svg_1d_plot_interface.the_1d_plot__code__phrase_role__identifier__plot__phrase__phrase_role__special______phrase___code__method">The
 1D_plot <code class="computeroutput">plot()</code>
 Method</a>
@@ -701,7 +740,7 @@
 named parameters, as well as a deduced parameter.
 
<div class="table">
-<a name="id698635"></a>Table 11. 1D_plot Required parameter
+<a name="id699334"></a>Table 11. 1D_plot Required parameter
<div class="table-contents"><table class="table" summary="1D_plot Required parameter">
<colgroup>
<col>
@@ -764,7 +803,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id698757"></a>Table 12. 1D_plot Deduced parameter
+<a name="id699455"></a>Table 12. 1D_plot Deduced parameter
<div class="table-contents"><table class="table" summary="1D_plot Deduced parameter">
<colgroup>
<col>
@@ -820,7 +859,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id698863"></a>Table 13. 1D_plot Optional Parameters
+<a name="id699562"></a>Table 13. 1D_plot Optional Parameters
<div class="table-contents"><table class="table" summary="1D_plot Optional Parameters">
<colgroup>
<col>
@@ -971,35 +1010,15 @@
 method:
 
<a name="svg_plot.interface.svg_1d_plot_interface.using_1d_plot_fill_and_stroke_colors"></a><h5>
-<a name="id699416"></a>
+<a name="id700114"></a>
 <a href="svg_1d_plot_interface.html#svg_plot.interface.svg_1d_plot_interface.using_1d_plot_fill_and_stroke_colors">Using
 1D_plot fill and stroke colors</a>
 </h5>
<pre class="programlisting">
-my_plot.plot(my_data, "Lions",
-_fill_color = red,
-_stroke_color = black);
-</pre>
-
- This has the same effect as the following:
- 
-<pre class="programlisting">
-my_plot.plot(my_data, "Lions", red, black); // Order is significant:
-// fill is red and stroke is black.
-</pre>
-
- and also the same effect as:
- 
-<pre class="programlisting">
-my_plot.plot(my_data, "Lions",
-_stroke_color = black,
-_fill_color = red);
+my_plot.plot(my_data, "Lions")
+ .fill_color(red).
+ .line_color(black);
</pre>
-
- Since _fill_color is a Boost.Parameter deduced parameter, when two svg_colors
- are used in the same function call, they are always inferred in the following
- order: (fill, stroke).
- 
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_2d_plot_interface.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_2d_plot_interface.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_2d_plot_interface.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -27,7 +27,7 @@
<a name="svg_plot.interface.svg_2d_plot_interface"></a> svg_2d_plot Public Interface
</h3></div></div></div>
<div class="table">
-<a name="id699767"></a>Table 14. 2D_plot Miscellaneous
+<a name="id700268"></a>Table 14. 2D_plot Miscellaneous
<div class="table-contents"><table class="table" summary="2D_plot Miscellaneous">
<colgroup>
<col>
@@ -115,7 +115,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id700124"></a>Table 15. 2D_plot Commands
+<a name="id700626"></a>Table 15. 2D_plot Commands
<div class="table-contents"><table class="table" summary="2D_plot Commands">
<colgroup>
<col>
@@ -217,12 +217,13 @@
<td>
 
 <code class="computeroutput">svg_2d_plot&
- x_major_labels_on(bool)</code>
+ x_major_labels_on(int)</code>
 
 </td>
<td>
 
- sets whether or not the major ticks will be labelled on the x axis.
+ Sets if and how the major ticks will be labelled on the x axis. <
+ 0 means down (default), 0 (false) means none, > 0 means to top)
 
 </td>
</tr>
@@ -269,12 +270,13 @@
<td>
 
 <code class="computeroutput">svg_2d_plot&
- y_major_labels_on(bool)</code>
+ y_major_labels_on(int)</code>
 
 </td>
<td>
 
- sets whether or not the major ticks will be labelled on the Y axis.
+ sets if and how the major ticks will be labelled on the Y axis. <
+ 0 means to left (default), 0 (false) means none, > 0 means to right.
 
 </td>
</tr>
@@ -291,11 +293,146 @@
 
 </td>
</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_value_precision(int)</code>
+ 
+ </td>
+<td>
+ 
+ Determines the iostream precison for value labels on the X axis major
+ ticks will be displayed. Default is 3 (rather than the iostream default
+ of 6).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_value_ioflags(int)</code>
+ 
+ </td>
+<td>
+ 
+ Determines the iostream flags for value labels on the X axis major
+ ticks will be displayed. Default is std::ios::dec. This allows fine
+ control of the value labels using, for example (ios::dec | ios::scientific),
+ or (ios::dec | ios::fixed), particularly in conjunction with precision.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_value_precision(int)</code>
+ 
+ </td>
+<td>
+ 
+ Determines the iostream precison for value labels on the Y axis major
+ ticks will be displayed. Default is 3 (rather than the iostream default
+ of 6).
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_value_ioflags(int)</code>
+ 
+ </td>
+<td>
+ 
+ Determines the iostream flags for value labels on the Y axis major
+ ticks will be displayed. Default is std::ios::dec. This allows fine
+ control of the value labels using, for example (ios::dec | ios::scientific),
+ or (ios::dec | ios::fixed), particularly in conjunction with precision.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ (int)</code>x_major_label_rotation
+ 
+ </td>
+<td>
+ 
+ Determines the direction of writing of value labels from the y axis
+ ticks. <code class="computeroutput">enum rotate_style</code>
+ provides control is 45 degree steps. The default is horizontal.
+ 
+ 
+ `enum rotate_style { / Rotation in degrees from horizontal.
+ horizontal = 0, / normal left to right. uphill = -45, /
+ slope up. upward = -90, / vertical writing up. backup =
+ -135, / slope up backwards. downhill = 45, / slope
+ down. downward = 90, / vertical writing down. backdown =
+ 135, / slope down backwards. upsidedown = 180 // == -180
+ };
+ 
+ 
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ (int)</code>x_major_label_rotation
+ 
+ </td>
+<td>
+ 
+ Determines the direction of writing of value labels from the X axis
+ ticks. <code class="computeroutput">enum rotate_style</code>
+ provides control is 45 degree steps. The default is horizontal.
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ x_label_strip_e0s(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Determines whether or not the X axis value labels for major ticks are
+ stripped of redundant zero, e or E,, and + sign. This can markedly
+ reduce visual clutter, for example, reducing "1.2e+000" to
+ "1.2".
+ 
+ </td>
+</tr>
+<tr>
+<td>
+ 
+ <code class="computeroutput">svg_2d_plot&
+ y_label_strip_e0s(bool)</code>
+ 
+ </td>
+<td>
+ 
+ Determines whether or not the Y axis value labels for major ticks are
+ stripped of redundant zero, e or E,, and + sign. This can markedly
+ reduce visual clutter, for example, reducing "1.2e+000" to
+ "1.2".
+ 
+ </td>
+</tr>
</tbody>
</table></div>
</div>
 <div class="table">
-<a name="id700859"></a>Table 16. 2D_plot Colors
+<a name="id701902"></a>Table 16. 2D_plot Colors
<div class="table-contents"><table class="table" summary="2D_plot Colors">
<colgroup>
<col>
@@ -440,7 +577,7 @@
 </td>
<td>
 
- Sets the color of the major ticks of the x-axis.
+ Sets the color of the major ticks of the X-axis.
 
 </td>
</tr>
@@ -468,7 +605,7 @@
 </td>
<td>
 
- Sets the color of the minor ticks of the x-axis.
+ Sets the color of the minor ticks of the X-axis.
 
 </td>
</tr>
@@ -546,7 +683,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id702148"></a>Table 17. 2D_plot Axis Information
+<a name="id703191"></a>Table 17. 2D_plot Axis Information
<div class="table-contents"><table class="table" summary="2D_plot Axis Information">
<colgroup>
<col>
@@ -574,7 +711,7 @@
 </td>
<td>
 
- Sets the stroke width (pixels) of the x-axis.
+ Sets the line or stroke width (pixels) of the X-axis.
 
 </td>
</tr>
@@ -587,7 +724,7 @@
 </td>
<td>
 
- Sets the label of the x-axis. You must set <code class="computeroutput">x_label(true)</code> to display the label.
+ Sets the label of the X-axis. You must set <code class="computeroutput">x_label(true)</code> to display the label.
 
 </td>
</tr>
@@ -600,7 +737,7 @@
 </td>
<td>
 
- Sets the distance (Cartesian units) between ticks on the x-axis.
+ Sets the distance (Cartesian units) between ticks on the X-axis.
 
 </td>
</tr>
@@ -613,7 +750,7 @@
 </td>
<td>
 
- Sets the length (pixels) of the x-axis major ticks.
+ Sets the length (pixels) of the X-axis major ticks.
 
 </td>
</tr>
@@ -626,7 +763,7 @@
 </td>
<td>
 
- Sets the width (pixels) of the major ticks on the x-axis.
+ Sets the width (pixels) of the major ticks on the X-axis.
 
 </td>
</tr>
@@ -639,7 +776,7 @@
 </td>
<td>
 
- Sets the length (pixels) of the x-axis minor ticks.
+ Sets the length (pixels) of the X-axis minor ticks.
 
 </td>
</tr>
@@ -652,7 +789,7 @@
 </td>
<td>
 
- Sets the length (pixels) of the x-axis minor tick lengths.
+ Sets the length (pixels) of the X-axis minor tick lengths.
 
 </td>
</tr>
@@ -665,7 +802,7 @@
 </td>
<td>
 
- Sets the width (pixels) of the minor ticks on the x-axis.
+ Sets the width (pixels) of the minor ticks on the X-axis.
 
 </td>
</tr>
@@ -705,7 +842,7 @@
 </td>
<td>
 
- Sets the stroke width of the x-axis.
+ Sets the stroke width of the X-axis.
 
 </td>
</tr>
@@ -831,10 +968,12 @@
</table></div>
</div>
 
- (Note: Getters omitted for now. TODO)
+ Accessor get functions are also provided for all the above set functions.
+ These allow one to check the current value (default if not changed by the
+ preceeding code).
 
<a name="svg_plot.interface.svg_2d_plot_interface.the__code__phrase_role__identifier__plot__phrase__phrase_role__special______phrase___code__method"></a><h5>
-<a name="id703548"></a>
+<a name="id704593"></a>
 <a href="svg_2d_plot_interface.html#svg_plot.interface.svg_2d_plot_interface.the__code__phrase_role__identifier__plot__phrase__phrase_role__special______phrase___code__method">The
 <code class="computeroutput">plot()</code>
 Method</a>
@@ -845,7 +984,7 @@
 named parameters, as well as a deduced parameter.
 
<div class="table">
-<a name="id703608"></a>Table 18. 2D_plot Required parameter
+<a name="id704653"></a>Table 18. 2D_plot Required parameter
<div class="table-contents"><table class="table" summary="2D_plot Required parameter">
<colgroup>
<col>
@@ -908,7 +1047,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id703730"></a>Table 19. 2D_plot Deduced parameter
+<a name="id704775"></a>Table 19. 2D_plot Deduced parameter
<div class="table-contents"><table class="table" summary="2D_plot Deduced parameter">
<colgroup>
<col>
@@ -964,7 +1103,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id703830"></a>Table 20. 2D_plot Optional Parameters
+<a name="id704875"></a>Table 20. 2D_plot Optional Parameters
<div class="table-contents"><table class="table" summary="2D_plot Optional Parameters">
<colgroup>
<col>
@@ -1199,34 +1338,15 @@
 Here are some examples of correct uses:
 
<a name="svg_plot.interface.svg_2d_plot_interface.using_fill_and_stroke_colors"></a><h4>
-<a name="id704635"></a>
+<a name="id705680"></a>
 <a href="svg_2d_plot_interface.html#svg_plot.interface.svg_2d_plot_interface.using_fill_and_stroke_colors">Using
 fill and stroke colors</a>
 </h4>
<pre class="programlisting">
-my_plot.(my_data, "Lions",
-_fill_color = red,
-_stroke_color = black);
-</pre>
-
- This has the same effect as the following:
- 
-<pre class="programlisting">
-my_plot.plot(my_data, "Lions", red, black);
+my_plot.(my_data, "Lions")
+.fill_color(red)
+.stroke_color(black);
</pre>
-
- and also the same effect as:
- 
-<pre class="programlisting">
-my_plot.plot(my_data, "Lions",
-_stroke_color = black,
-_fill_color = red);
-</pre>
-
- Since _fill_color is a deduced parameter, when two svg_colors are used in
- the same function call, they are always inferred in the following order:
- (fill, stroke).
- 
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_boxplot_interface.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_boxplot_interface.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_boxplot_interface.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -27,7 +27,7 @@
<a name="svg_plot.interface.svg_boxplot_interface"></a> svg_boxplot Public Interface
</h3></div></div></div>
<div class="table">
-<a name="id704963"></a>Table 21. Boxplot Miscellaneous
+<a name="id705824"></a>Table 21. Boxplot Miscellaneous
<div class="table-contents"><table class="table" summary="Boxplot Miscellaneous">
<colgroup>
<col>
@@ -102,7 +102,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id705257"></a>Table 22. Boxplot Commands
+<a name="id706118"></a>Table 22. Boxplot Commands
<div class="table-contents"><table class="table" summary="Boxplot Commands">
<colgroup>
<col>
@@ -190,7 +190,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id705587"></a>Table 23. Boxplot Colors
+<a name="id706447"></a>Table 23. Boxplot Colors
<div class="table-contents"><table class="table" summary="Boxplot Colors">
<colgroup>
<col>
@@ -341,7 +341,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id706319"></a>Table 24. Boxplot Axis Information
+<a name="id707180"></a>Table 24. Boxplot Axis Information
<div class="table-contents"><table class="table" summary="Boxplot Axis Information">
<colgroup>
<col>
@@ -515,7 +515,7 @@
<td>
 
 Sets the scale of the Y-axis from y1 to y2. Throws an exception if
- y2 <= y1.
+ y2 <= y1, or if the range is too small to produce a useful plot.
 
 </td>
</tr>
@@ -523,22 +523,24 @@
</table></div>
</div>
 
- (Note: Getters omitted for now - TODO)
+ Accessor get functions are also provided for all the above set functions.
+ These allow one to check the current value (default if not changed by the
+ preceeding code).
 
<a name="svg_plot.interface.svg_boxplot_interface.the__code__phrase_role__identifier__plot__phrase__phrase_role__special______phrase___code__method"></a><h5>
-<a name="id707221"></a>
+<a name="id708084"></a>
 <a href="svg_boxplot_interface.html#svg_plot.interface.svg_boxplot_interface.the__code__phrase_role__identifier__plot__phrase__phrase_role__special______phrase___code__method">The
 <code class="computeroutput">plot()</code>
 Method</a>
 </h5>

 The <code class="computeroutput">plot()</code>
- method is defined using Boost.Parameter. As such, it supports a few extra
- named parameters, as well as a deduced parameter.
+ method allows data series parameters and further chained functions to control
+ their display.
 
<div class="table">
-<a name="id707281"></a>Table 25. Required parameter
-<div class="table-contents"><table class="table" summary="Required parameter">
+<a name="id708144"></a>Table 25. Required parameters
+<div class="table-contents"><table class="table" summary="Required parameters">
<colgroup>
<col>
<col>
@@ -600,8 +602,8 @@
</table></div>
</div>
 <div class="table">
-<a name="id707403"></a>Table 26. Optional Parameters
-<div class="table-contents"><table class="table" summary="Optional Parameters">
+<a name="id708265"></a>Table 26. Optional Functions
+<div class="table-contents"><table class="table" summary="Optional Functions">
<colgroup>
<col>
<col>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_interface.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_interface.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/interface/svg_interface.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -30,7 +30,7 @@
 Public Interface</a>
</h3></div></div></div>
<div class="table">
-<a name="id692220"></a>Table 3. class `svg` Standard
+<a name="id692627"></a>Table 3. class `svg` Standard
 C++ Methods
<div class="table-contents"><table class="table" summary="class `svg` Standard
 C++ Methods">
@@ -56,8 +56,7 @@
 
 </th>
</tr></thead>
-<tbody>
-<tr>
+<tbody><tr>
<td>
 
 <code class="computeroutput">svg()</code>
@@ -73,29 +72,11 @@
 Default image size (pixels) is (400, 400).
 
 </td>
-</tr>
-<tr>
-<td>
- 
- <code class="computeroutput">svg()</code>
- 
- </td>
-<td>
- 
- Constructor
- 
- </td>
-<td>
- 
- Default image size (pixels) is (400, 400).
- 
- </td>
-</tr>
-</tbody>
+</tr></tbody>
</table></div>
</div>
 <div class="table">
-<a name="id692352"></a>Table 4. `svg` shapes
+<a name="id692717"></a>Table 4. `svg` shapes
<div class="table-contents"><table class="table" summary="`svg` shapes">
<colgroup>
<col>
@@ -153,8 +134,8 @@
<pre class="programlisting">
path_element& my_path = image.path();

-my_path.M(3, 3).l(150, 150);
-</pre>
+my_path.M(3, 3).l(150, 150).m(5, 6).l(7, 8).l(9, 10); // and so
on.
+</pre>

 
 </td>
@@ -282,7 +263,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id693378"></a>Table 5. `svg` Copyright
+<a name="id693843"></a>Table 5. `svg` Copyright
<div class="table-contents"><table class="table" summary="`svg` Copyright">
<colgroup>
<col>
@@ -577,7 +558,7 @@
</table></div>
</div>
 <div class="table">
-<a name="id694671"></a>Table 6. `svg` document settings and writing
+<a name="id695136"></a>Table 6. `svg` document settings and writing
<div class="table-contents"><table class="table" summary="`svg` document settings and writing">
<colgroup>
<col>
@@ -629,7 +610,8 @@
 </td>
<td>
 
- Sets title for the SVG XML document (not the plot)
+ Sets title for the SVG XML document (not the
+ plot)
 
 </td>
<td>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults/1d_defaults.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults/1d_defaults.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults/1d_defaults.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -35,7 +35,7 @@
of the plotting.

<div class="table">
-<a name="id690182"></a>Table 1. Default Values
+<a name="id690589"></a>Table 1. Default Values
<div class="table-contents"><table class="table" summary="Default Values">
<colgroup>
<col>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults/2d_defaults.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults/2d_defaults.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/plot_defaults/2d_defaults.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -35,7 +35,7 @@
beginning of the plotting. Here is a table of the defaults:

<div class="table">
-<a name="id691126"></a>Table 2. Default Values
+<a name="id691533"></a>Table 2. Default Values
<div class="table-contents"><table class="table" summary="Default Values">
<colgroup>
<col>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_boxplot_tutorial/svg_boxplot_tutorial_simple.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_boxplot_tutorial/svg_boxplot_tutorial_simple.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/svg_boxplot_tutorial/svg_boxplot_tutorial_simple.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -83,7 +83,7 @@
}
</pre>
<a name="svg_plot.svg_boxplot_tutorial.svg_boxplot_tutorial_simple.image_boxplot_simple_svg"></a><h5>
-<a name="id688429"></a>
+<a name="id688836"></a>
 <a href="svg_boxplot_tutorial_simple.html#svg_plot.svg_boxplot_tutorial.svg_boxplot_tutorial_simple.image_boxplot_simple_svg">Image
 boxplot_simple.svg</a>
 </h5>
@@ -91,7 +91,7 @@
 <img src="../../images/boxplot_simple.png" alt="boxplot_simple">
 
<a name="svg_plot.svg_boxplot_tutorial.svg_boxplot_tutorial_simple.basic_example_breakdown"></a><h5>
-<a name="id688477"></a>
+<a name="id688883"></a>
 <a href="svg_boxplot_tutorial_simple.html#svg_plot.svg_boxplot_tutorial.svg_boxplot_tutorial_simple.basic_example_breakdown">Basic
 Example Breakdown</a>
 </h5>
@@ -99,7 +99,7 @@
 Let's examine what this does.
 
<a name="svg_plot.svg_boxplot_tutorial.svg_boxplot_tutorial_simple.initializing_a_new_boxplot"></a><h5>
-<a name="id688508"></a>
+<a name="id688915"></a>
 <a href="svg_boxplot_tutorial_simple.html#svg_plot.svg_boxplot_tutorial.svg_boxplot_tutorial_simple.initializing_a_new_boxplot">Initializing
 a new boxplot</a>
 </h5>
@@ -108,7 +108,7 @@
 svg_boxplot my_plot;
 
<a name="svg_plot.svg_boxplot_tutorial.svg_boxplot_tutorial_simple.setting_a_color"></a><h5>
-<a name="id688542"></a>
+<a name="id688949"></a>
 <a href="svg_boxplot_tutorial_simple.html#svg_plot.svg_boxplot_tutorial.svg_boxplot_tutorial_simple.setting_a_color">Setting
 a color</a>
 </h5>
@@ -120,7 +120,7 @@
my_plot.background_border_color(black);
</pre>
<a name="svg_plot.svg_boxplot_tutorial.svg_boxplot_tutorial_simple.setting_strings_in_the_plot"></a><h5>
-<a name="id688615"></a>
+<a name="id689022"></a>
 <a href="svg_boxplot_tutorial_simple.html#svg_plot.svg_boxplot_tutorial.svg_boxplot_tutorial_simple.setting_strings_in_the_plot">Setting
 strings in the plot</a>
 </h5>
@@ -135,7 +135,7 @@
 .y_label("Population Size");
</pre>
<a name="svg_plot.svg_boxplot_tutorial.svg_boxplot_tutorial_simple.setting_axis_information"></a><h4>
-<a name="id688744"></a>
+<a name="id689151"></a>
 <a href="svg_boxplot_tutorial_simple.html#svg_plot.svg_boxplot_tutorial.svg_boxplot_tutorial_simple.setting_axis_information">Setting
 axis information</a>
 </h4>
@@ -151,7 +151,7 @@
 .y_major_interval(20);
 
<a name="svg_plot.svg_boxplot_tutorial.svg_boxplot_tutorial_simple.writing_to_a_file"></a><h5>
-<a name="id688788"></a>
+<a name="id689194"></a>
 <a href="svg_boxplot_tutorial_simple.html#svg_plot.svg_boxplot_tutorial.svg_boxplot_tutorial_simple.writing_to_a_file">Writing
 to a file</a>
 </h5>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple/2d_simple_code_example.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple/2d_simple_code_example.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple/2d_simple_code_example.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -65,7 +65,7 @@
}
</pre>
<a name="svg_plot.tutorial_2d_code_simple.2d_simple_code_example.resulting_simple_2d_example_image"></a><h5>
-<a name="id683752"></a>
+<a name="id683876"></a>
 <a href="2d_simple_code_example.html#svg_plot.tutorial_2d_code_simple.2d_simple_code_example.resulting_simple_2d_example_image">Resulting
 Simple_2D Example Image</a>
 </h5>
@@ -73,7 +73,7 @@
 <img src="../../images/2d_simple.png" alt="2d_simple">
 
<a name="svg_plot.tutorial_2d_code_simple.2d_simple_code_example.simple_2d_example_breakdown"></a><h5>
-<a name="id683799"></a>
+<a name="id683923"></a>
 <a href="2d_simple_code_example.html#svg_plot.tutorial_2d_code_simple.2d_simple_code_example.simple_2d_example_breakdown">Simple_2D
 Example Breakdown</a>
 </h5>
@@ -84,8 +84,17 @@
svg_2d_plot my_plot;
</pre>

- This constructor initializes a new 2D plot. This also sets the many default
- values.
+ This constructor initializes a new 2D plot. This also sets the very many
+ default values.
+ 
+
+ We could accept all of these and just plot one series of data with
+ 
+<pre class="programlisting">
+my_plot.plot(map1, "Series 1"); // Data point marker color is default black.
+</pre>
+
+ but we can also add a few optional details:
 
<pre class="programlisting">
my_plot.title("Race Times")
@@ -104,7 +113,7 @@
 </li>
<li>
<code class="computeroutput">legend_on(true)</code> means
- that the legend will show up.
+ that the legend box will show up (by default at top right).
 </li>
<li>
<code class="computeroutput">x_range(-1, 11)</code> means that the axis displayed will be
@@ -112,7 +121,8 @@
 </li>
<li>
<code class="computeroutput">background_border_color(black)</code> sets the border around the image to <code class="computeroutput">black</code>. Ordinarily it is left to be the
- color of the background (and so no border of plot area will be visible).
+ color of the whole image background (and so no border of the plot area
+ will be visible).
 </li>
</ul></div>
<pre class="programlisting">
@@ -122,22 +132,28 @@

 This draws <code class="computeroutput">map1</code> and <code class="computeroutput">map2</code> to <code class="computeroutput">my_plot</code>.
 As many containers as you want can be drawn to <code class="computeroutput">my_plot</code>.
- Evntually the plot will become cluttered and confusing, when I recommend
- just creating another plot!
+ Eventually the plot will become cluttered and confusing, when creating other
+ plot(s) becomes sensible!
 

 The name of the series is <code class="computeroutput">"Race times"</code>,
- and that text will show in the legend. These are the two required parameters
+ and that text will show in the legend box. These are the two required parameters
 for this function call. There are many optional parameters, as seen in the
 section <a href="../../plot_function" target="_top">Getting More Out of the <code class="computeroutput">plot()</code>
 Function</a>
 
+
+ Finally
+ 
<pre class="programlisting">
my_plot.write("simple_2d.svg");
</pre>

- This writes plot <code class="computeroutput">my_plot</code>
- to the file "simple_2d.svg".
+ writes plot <code class="computeroutput">my_plot</code> to the
+ file "simple_2d.svg".
+ 
+
+ You can view this file with most internet browsers, and other programs too.
 
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple/2d_special.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple/2d_special.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple/2d_special.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -31,7 +31,7 @@
 2D Special Features</a>
</h3></div></div></div>
<a name="svg_plot.tutorial_2d_code_simple.2d_special.y_axis_grid_lines"></a><h5>
-<a name="id686467"></a>
+<a name="id686734"></a>
 <a href="2d_special.html#svg_plot.tutorial_2d_code_simple.2d_special.y_axis_grid_lines">Y-Axis
 Grid Lines</a>
 </h5>
@@ -48,7 +48,7 @@
 
<pre class="programlisting">
my_plot.y_major_grid_color(lightgray) // Darker color for major grid.
- .y_minor_grid_color(whitesmoke); // lighter color for minor grid.
+ .y_minor_grid_color(whitesmoke); // Lighter color for minor grid.
</pre>

 This will produce the following image:
@@ -64,14 +64,21 @@
 .x_minor_grid_on(true);
</pre>

- and color it similarly:
+ and color it similarly for faint blues like old fashioned graph paper:
 
<pre class="programlisting">
-my_plot.y_major_grid_color(lightblue) // Darker color for major grid.
- .y_minor_grid_color(azure); // lighter color for minor grid.
+my_plot.y_major_grid_color(svg_color(200, 220, 255)) // Darker color for major grid.
+ .y_minor_grid_color(svg_color(240, 240, 255); // lighter color for minor grid.
</pre>
+
+ and to make the major grid much wider than the minor grid:
+ 
+<pre class="programlisting">
+my_plot.y_major_grid_width(4)
+ .y_minor_grid_width(1)
+</pre>
<a name="svg_plot.tutorial_2d_code_simple.2d_special.external_y_axis_style"></a><h5>
-<a name="id686845"></a>
+<a name="id687250"></a>
 <a href="2d_special.html#svg_plot.tutorial_2d_code_simple.2d_special.external_y_axis_style">External
 Y Axis Style</a>
 </h5>
@@ -92,18 +99,18 @@
 </td></tr>
</table></div>
<a name="svg_plot.tutorial_2d_code_simple.2d_special.fill_the_area_between_the_plot_and_the_axis"></a><h5>
-<a name="id686980"></a>
+<a name="id687386"></a>
 <a href="2d_special.html#svg_plot.tutorial_2d_code_simple.2d_special.fill_the_area_between_the_plot_and_the_axis">Fill
 the area between the plot and the axis</a>
 </h5>

- When there is a call to the plot() method, define <code class="computeroutput">_area_fill_color</code>
+ When there is a call to the plot() method, define <code class="computeroutput">area_fill_color</code>
 
<pre class="programlisting">
multimap<double, double> my_data;
svg_2d_plot my_plot;

-my_plot.plot(my_data, "Data", _area_fill_color(red));
+my_plot.plot(my_data, "Data", area_fill_color(red));
</pre>

 This produces the following image:
@@ -112,7 +119,7 @@
 <img src="../../images/2d_area_fill.png" alt="2d_area_fill">
 
<a name="svg_plot.tutorial_2d_code_simple.2d_special.curve_interpolation"></a><h5>
-<a name="id687184"></a>
+<a name="id687590"></a>
 <a href="2d_special.html#svg_plot.tutorial_2d_code_simple.2d_special.curve_interpolation">Curve
 Interpolation</a>
 </h5>
@@ -122,7 +129,7 @@
 simply use the following command:
 
<pre class="programlisting">
-my_plot.plot(data, "Series 1", _bezier_curve = "true");
+my_plot.plot(data, "Series 1", bezier_on(true);
</pre>

 This produces something like the following images:
@@ -141,7 +148,9 @@
 this feature with curves that have a numeric_limit value (<code class="computeroutput">-NaN</code>,
 for example), or with data that has high irregularity in X-Axis spacing
 (for example, a clump of points between (0, 1) on the X axis, with the
- next one at 100 on the X axis.)
+ next one at 100 on the X axis.) In general, curves must be reasonably well-behaved
+ to be smoothable. In general, using more data points will make smoothing
+ work better, but wil increase svg file sizes.
 </td></tr>
</table></div>
</div>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple/full_2d_layout.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple/full_2d_layout.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_2d_code_simple/full_2d_layout.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -42,39 +42,42 @@
double f(double x)
{
 return sqrt(x);
-}
+ // Note: negative values will all return NaN.
+}

double g(double x)
{
- return -2 + x*x;
+ return -2 + x * x;
}

double h(double x)
{
- return -1 + 2*x;
+ return -1 + 2 * x;
}

int main()
{
 multimap<double, double> data1, data2, data3;

- for(double i=0; i<=10.; i+=1.)
- {
- data1[i] = f(i);
+ for(double i = 0; i <= 10.; i += 1.)
+ { // Evaluate the functions as demonstration data.
+ data1[i] = f(i);
 data2[i] = g(i);
 data3[i] = h(i);
 }

- svg_2d_plot my_plot;
-
- // Size/scale settings.
+ svg_2d_plot my_plot; // Construct a new plot.
+
+ // Override a few default settings with our choices:
+
+ // Size of SVG image and X and Y range settings.
 my_plot.image_size(700, 500)
 .x_range(-1, 10)
 .y_range(-5, 100)

 // Text settings.
 my_plot.title("Plot of Mathematical Functions")
- .title_font_size(29)
+ .title_font_size(25)
 .x_label("Time in Months");

 // Commands.
@@ -90,7 +93,7 @@
 .plot_background_color(svg_color(136, 188, 126))
 .title_color(white);

- //X axis settings.
+ // X axis settings.
 my_plot.x_major_interval(2)
 .x_major_tick_length(14)
 .x_major_tick_width(1)
@@ -105,16 +108,12 @@
 // Legend settings.
 my_plot.legend_title_font_size(15);

- my_plot.plot(data1, "Sqrt(x)", blue,
- _point_style = none,
- _show_line = true);
-
- my_plot.plot(data2, "-2 + x^2", orange,
- _show_line = true);
-
- my_plot.plot(data3, "-1 + 2x", red,
- _point_style = square);
-
+ // Add the 3 data series to the plot, using different markers and line colors.
+ my_plot.plot(data1, "Sqrt(x)").fill_color(red);
+ my_plot.plot(data2, "-2 + x^2").fill_color(orange).size(5);
+ my_plot.plot(data3, "-1 + 2x").fill_color(yellow).bezier_on(true).line_color(blue).shape(square);
+ // Note how the options can be chained.
+
 my_plot.write("2d_full.svg");

 return 0;

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple/1d_special.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple/1d_special.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple/1d_special.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -31,7 +31,7 @@
 1D Special Features</a>
</h3></div></div></div>
<a name="svg_plot.tutorial_code_1d_simple.1d_special.x_axis_grid_lines"></a><h5>
-<a name="id682506"></a>
+<a name="id682629"></a>
 <a href="1d_special.html#svg_plot.tutorial_code_1d_simple.1d_special.x_axis_grid_lines">X-Axis
 Grid Lines</a>
 </h5>
@@ -57,7 +57,7 @@
 <img src="../../images/1d_x_grid.png" alt="1d_x_grid">
 
<a name="svg_plot.tutorial_code_1d_simple.1d_special.x_axis_external_style"></a><h5>
-<a name="id682728"></a>
+<a name="id682851"></a>
 <a href="1d_special.html#svg_plot.tutorial_code_1d_simple.1d_special.x_axis_external_style">X-Axis
 External Style</a>
 </h5>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple/tutorial_code_1d_example.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple/tutorial_code_1d_example.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_code_1d_simple/tutorial_code_1d_example.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -66,7 +66,7 @@
 <img src="../../images/1d_simple.png" alt="1d_simple">
 
<a name="svg_plot.tutorial_code_1d_simple.tutorial_code_1d_example.a_note_on_syntax"></a><h5>
-<a name="id679596"></a>
+<a name="id679720"></a>
 <a href="tutorial_code_1d_example.html#svg_plot.tutorial_code_1d_simple.tutorial_code_1d_example.a_note_on_syntax">A
 Note On Syntax</a>
 </h5>
@@ -101,7 +101,7 @@
 code to read more clearly!
 
<a name="svg_plot.tutorial_code_1d_simple.tutorial_code_1d_example.simple_1d_example_breakdown"></a><h5>
-<a name="id680006"></a>
+<a name="id680130"></a>
 <a href="tutorial_code_1d_example.html#svg_plot.tutorial_code_1d_simple.tutorial_code_1d_example.simple_1d_example_breakdown">Simple
 1D Example Breakdown</a>
 </h5>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_stylesheet.html
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_stylesheet.html (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/html/svg_plot/tutorial_stylesheet.html 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -47,7 +47,7 @@
 </li>
</ul></div>
<a name="svg_plot.tutorial_stylesheet.using_the_stylesheet"></a><h5>
-<a name="id689041"></a>
+<a name="id689448"></a>
 <a href="tutorial_stylesheet.html#svg_plot.tutorial_stylesheet.using_the_stylesheet">Using the
 stylesheet</a>
 </h5>

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/interface.qbk
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/interface.qbk (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/interface.qbk 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -13,10 +13,13 @@
<desc>My Document description</desc>]]

 [[`svg_1d_plot& legend_title_font_size(unsigned int)`] [Sets the font size for the legend title.]]
+ [[`svg_1d_plot& legend_color(const svg_color& col)`] [Sets the color to be used for the legend text.]]
 [[`svg_1d_plot& title(const std::string&)`] [Sets the string to be used for the title.]]
 [[`svg_1d_plot& title_font_size(unsigned int)`] [Sets the font size for the title.]]
+ [[`svg_1d_plot& title_color(const svg_color& col)`] [Sets the color to be used for the title.]]
 [[`svg_1d_plot& write(const std::string&)`] [Writes the plot to the file passed as a parameter.]]
- [[`svg_1d_plot& write(ostream&)`] [Writes the plot to a stream passed as a parameter.]]]
+ [[`svg_1d_plot& write(ostream&)`] [Writes the plot to a stream passed as a parameter.]]
+] [/ table 1D_plot Miscellaneous Functions]

[table 1D_plot Commands
 [[Signature] [Description]]
@@ -27,15 +30,17 @@
 [[`svg_1d_plot& x_axis_on(bool)`] [Determines whether or not the X-axis is displayed.]]
 [[`svg_1d_plot& x_external_style_on(bool)`] [Determines whether or not the axis is inside or outside of the plot. Defaults is `false`.]]
 [[`svg_1d_plot& x_label_on(bool)`] [Sets whether or not the X-axis label will show]]
- [[`svg_1d_plot& x_major_labels_on(bool)`] [sets whether or not the major ticks will be labelled on the X-axis]]
+ [[`svg_1d_plot& x_major_labels_on(int)`] [sets whether or not the major ticks will be labelled on the X-axis. ]]
 [[`svg_1d_plot& x_major_grid_on(bool)`] [Determines whether or not the major grid on the X axis will be displayed.]]
 [[`svg_1d_plot& x_minor_grid_on(bool)`] [Determines whether or not the minor grid on the X axis will be displayed.]]
- [[`svg_1d_plot& y_axis_on(bool)`] [Determines whether or not the Y axis is displayed.]]]
+ [[`svg_1d_plot& y_axis_on(bool)`] [Determines whether or not the Y axis is displayed.]]
+ ] [/ table 1D_plot Commands]

[table 1D_plot Colors
 [[Signature] [Description]]
- [[`svg_1d_plot& background_border_color(const svg_color &col)`] [Set the background border color for the legend as `col`, an RGB color.]]
 [[`svg_1d_plot& background_color(const svg_color &col)`] [Set the background color for the whole image.]]
+ [[`svg_1d_plot& background_border_color(const svg_color &col)`] [Set the background border color for the whole image as `col`, an RGB color.]]
+ [[`svg_1d_plot& background_border_width(const svg_color &col)`] [Set the background border width for the whole image.]]
 [[`svg_1d_plot& legend_background_color(const svg_color &col)`] [Set the background color for the legend as `col`, an RGB color.]]
 [[`svg_1d_plot& legend_border_color(const svg_color &col)`] [Set the border color for the legend as `col`, an RGB color.]]
 [[`svg_1d_plot& plot_background_color(const svg_color &col)`] [Set the color of the plot area. Note: this only goes into effect if plot_area(true) has been called.]]
@@ -43,23 +48,24 @@
 [[`svg_1d_plot& x_axis_color(const svg_color &col)`] [Sets the color of the lines that form the axis.]]
 [[`svg_1d_plot& x_label_color(const svg_color &col)`] [Sets the color of the labels that go along the X axis.]]
 [[`svg_1d_plot& x_major_grid_color(const svg_color &col)`] [Sets the color of the grid that runs perpindicular to the X axis.]]
- [[`svg_1d_plot& x_major_tick_color(const svg_color &col)`] [Sets the color of the major ticks of the x-axis.]]
- [[`svg_1d_plot& x_minor_grid_color(const svg_color &col)`] [Sets the color of the minor grid of the x-axis]]
- [[`svg_1d_plot& x_minor_tick_color(const svg_color &col)`] [Sets the color of the minor ticks of the x-axis.]]
- ]
+ [[`svg_1d_plot& x_major_tick_color(const svg_color &col)`] [Sets the color of the major ticks of the X-axis.]]
+ [[`svg_1d_plot& x_minor_grid_color(const svg_color &col)`] [Sets the color of the minor grid of the X-axis]]
+ [[`svg_1d_plot& x_minor_tick_color(const svg_color &col)`] [Sets the color of the minor ticks of the X-axis.]]
+] [/ table 1D_plot Colors]

[table 1D_plot X-Axis Definition
 [[Signature] [Description]]
- [[`svg_1d_plot& x_axis_width(unsigned int)`] [Sets the stroke width of the x-axis.] ]
- [[`svg_1d_plot& x_label(const std::string&)`] [Sets the label of the x-axis. This does not guarantee that it will be shown. You must call `x_label_on(true)` to display.] ]
- [[`svg_1d_plot& x_major_interval(double)`] [Sets the distance (in Cartesian units) between ticks on the x-axis.] ]
- [[`svg_1d_plot& x_major_tick_length(int)`] [Sets the length (pixels) of the x-axis major ticks.] ]
- [[`svg_1d_plot& x_major_tick_width(unsigned int)`] [Sets the width (pixels) of the major ticks on the x-axis.] ]
- [[`svg_1d_plot& x_minor_tick_length(int)`] [Sets the length (pixels) of the x-axis minor tick lengths.] ]
- [[`svg_1d_plot& x_minor_tick_width(unsigned int)`] [Sets the width (pixels) of the minor ticks on the x-axis.] ]
+ [[`svg_1d_plot& x_axis_width(unsigned int)`] [Sets the stroke width of the X-axis.] ]
+ [[`svg_1d_plot& x_label(const std::string&)`] [Sets the label of the X-axis. This does not guarantee that it will be shown. You must call `x_label_on(true)` to display.] ]
+ [[`svg_1d_plot& x_major_interval(double)`] [Sets the distance (in Cartesian units) between ticks on the X-axis.] ]
+ [[`svg_1d_plot& x_major_tick_length(int)`] [Sets the length (pixels) of the X-axis major ticks.] ]
+ [[`svg_1d_plot& x_major_tick_width(unsigned int)`] [Sets the width (pixels) of the major ticks on the X-axis.] ]
+ [[`svg_1d_plot& x_minor_tick_length(int)`] [Sets the length (pixels) of the X-axis minor tick lengths.] ]
+ [[`svg_1d_plot& x_minor_tick_width(unsigned int)`] [Sets the width (pixels) of the minor ticks on the X-axis.] ]
 [[`svg_1d_plot& x_num_minor_ticks(int)`] [Sets the number of minor ticks between each major tick.] ]
- [[`svg_1d_plot& x_range(double x1, double x2)`] [Sets the scale of the x axis from x1 to x2. Throws an exception if x2<=x1. ] ]
-]
+ [[`svg_1d_plot& x_range(double x1, double x2)`] [Sets the scale of the x axis from x1 to x2. Throws an exception if x2<=x1, or if the range is too small to produce a useful plot. ] ]
+] [/table 1D_plot X-Axis Definition]
+

[heading The 1D_plot `plot()` Method]
The `plot()` method is defined using Boost.Parameter. As such, it supports a
@@ -68,11 +74,13 @@
[table 1D_plot Required parameter
[[ID] [Type (* is a wildcard)] [Description]]
[[_container] [*] [Any object that can return an iterator with begin() and end()]]
-[[_title] [`std::string`] [The name of this data series.]]]
+[[_title] [`std::string`] [The name of this data series.]]
+] [/ table 1D_plot Required parameter]

[table 1D_plot Deduced parameter
[[ID] [Type] [Description] [Default]]
-[[_fill_color] [`svg_color`] [Color that shows *inside the circle* being drawn.] [white] ]]
+[[_fill_color] [`svg_color`] [Color that shows *inside the circle* being drawn.] [white]]
+] [/ table 1D_plot Deduced parameter]

[table 1D_plot Optional Parameters
[[ID] [Type] [Description] [Default]]
@@ -97,28 +105,16 @@
``
][
`boost_default_convert` is sufficient in all cases where the data stored in
-the container can be directly cast to a `double`.]]]
+the container can be directly cast to a `double`.]]
+] [/ table 1D_plot Optional Parameters]

Here are some examples of using of the 1D_plot `plot` method:
[h4 Using 1D_plot fill and stroke colors]

- my_plot.plot(my_data, "Lions",
- _fill_color = red,
- _stroke_color = black);
-
-This has the same effect as the following:
-
- my_plot.plot(my_data, "Lions", red, black); // Order is significant:
- // fill is red and stroke is black.
+ my_plot.plot(my_data, "Lions")
+ .fill_color(red).
+ .line_color(black);

-and also the same effect as:
-
- my_plot.plot(my_data, "Lions",
- _stroke_color = black,
- _fill_color = red);
-
-Since _fill_color is a Boost.Parameter deduced parameter, when two svg_colors are used in the same function call, they are always inferred in the following order:
-(fill, stroke).
[endsect] [/svg_1d_plot_interface]

[section:svg_2d_plot_interface `svg_2d_plot` Public Interface]
@@ -128,7 +124,8 @@
 [[`svg_2d_plot& image_size(unsigned int, unsigned int)`] [Sets the size (pixels) of the plot image produced.]]
 [[`svg_2d_plot& title(const std::string&)`] [Sets the string to be used for the title.]]
 [[`svg_2d_plot& title_font_size(unsigned int)`] [Sets the font size for the title.]]
- [[`svg_2d_plot& legend_title_font_size(unsigned int)`] [Sets the font size for the legend title.]]]
+ [[`svg_2d_plot& legend_title_font_size(unsigned int)`] [Sets the font size for the legend title.]]
+ ] [/ table 2D_plot Miscellaneous]

[table 2D_plot Commands
 [[Signature] [Description]]
@@ -138,12 +135,36 @@
 [[`svg_2d_plot& title_on(bool)`] [Determines whether or not the image title is displayed.]]
 [[`svg_2d_plot& x_label_on(bool)`] [Sets whether or not the X axis label will show.]]
 [[`svg_2d_plot& x_major_grid_on(bool)`] [Determines whether or not the major grid on the X axis will be displayed.]]
- [[`svg_2d_plot& x_major_labels_on(bool)`] [sets whether or not the major ticks will be labelled on the x axis.]]
+ [[`svg_2d_plot& x_major_labels_on(int)`] [Sets if and how the major ticks will be labelled on the x axis.
+< 0 means down (default), 0 (false) means none, > 0 means to top)]]
 [[`svg_2d_plot& x_minor_grid_on(bool)`] [Determines whether or not the minor grid on the X axis will be displayed.]]
 [[`svg_2d_plot& y_label_on(bool)`] [Sets whether or not the Y axis label will show.]]
 [[`svg_2d_plot& y_major_grid_on(bool)`] [Determines whether or not the major grid on the Y axis will be displayed.]]
- [[`svg_2d_plot& y_major_labels_on(bool)`] [sets whether or not the major ticks will be labelled on the Y axis.]]
- [[`svg_2d_plot& y_minor_grid_on(bool)`] [Determines whether or not the minor grid on the Y axis will be displayed.]]]
+ [[`svg_2d_plot& y_major_labels_on(int)`] [sets if and how the major ticks will be labelled on the Y axis.
+ < 0 means to left (default), 0 (false) means none, > 0 means to right.]]
+ [[`svg_2d_plot& y_minor_grid_on(bool)`] [Determines whether or not the minor grid on the Y axis will be displayed.]]
+ [[`svg_2d_plot& x_value_precision(int)`] [Determines the iostream precison for value labels on the X axis major ticks will be displayed. Default is 3 (rather than the iostream default of 6).]]
+ [[`svg_2d_plot& x_value_ioflags(int)`] [Determines the iostream flags for value labels on the X axis major ticks will be displayed. Default is std::ios::dec. This allows fine control of the value labels using, for example (ios::dec | ios::scientific), or (ios::dec | ios::fixed), particularly in conjunction with precision.]]
+ [[`svg_2d_plot& y_value_precision(int)`] [Determines the iostream precison for value labels on the Y axis major ticks will be displayed. Default is 3 (rather than the iostream default of 6).]]
+ [[`svg_2d_plot& y_value_ioflags(int)`] [Determines the iostream flags for value labels on the Y axis major ticks will be displayed. Default is std::ios::dec. This allows fine control of the value labels using, for example (ios::dec | ios::scientific), or (ios::dec | ios::fixed), particularly in conjunction with precision.]]
+ [[`svg_2d_plot& (int)`x_major_label_rotation] [Determines the direction of writing of value labels from the y axis ticks. `enum rotate_style` provides control is 45 degree steps. The default is horizontal.
+
+ `enum rotate_style { // Rotation in degrees from horizontal. horizontal = 0, // normal left to right.
+ uphill = -45, // slope up.
+ upward = -90, // vertical writing up.
+ backup = -135, // slope up backwards.
+ downhill = 45, // slope down.
+ downward = 90, // vertical writing down.
+ backdown = 135, // slope down backwards.
+ upsidedown = 180 // == -180
+ };
+
+ ]]
+ [[`svg_2d_plot& (int)`x_major_label_rotation] [Determines the direction of writing of value labels from the X axis ticks. `enum rotate_style` provides control is 45 degree steps. The default is horizontal.]]
+ [[`svg_2d_plot& x_label_strip_e0s(bool)`] [Determines whether or not the X axis value labels for major ticks are stripped of redundant zero, e or E,, and + sign. This can markedly reduce visual clutter, for example, reducing "1.2e+000" to "1.2".]]
+ [[`svg_2d_plot& y_label_strip_e0s(bool)`] [Determines whether or not the Y axis value labels for major ticks are stripped of redundant zero, e or E,, and + sign. This can markedly reduce visual clutter, for example, reducing "1.2e+000" to "1.2".]]
+
+] [/ table 2D_plot Commands]

[table 2D_plot Colors
 [[Signature] [Description]]
@@ -155,9 +176,9 @@
 [[`svg_2d_plot& plot_background_color(const svg_color &col)`] [Set the color of the plot area. Note: this only goes into effect if plot_area(true) has been called.]]
 [[`svg_2d_plot& x_axis_color(const svg_color &col)`] [Sets the color of the lines that form the axis.]]
 [[`svg_2d_plot& x_label_color(const svg_color &col)`] [Sets the color of the labels that go along the X axis.]]
- [[`svg_2d_plot& x_major_tick_color(const svg_color &col)`] [Sets the color of the major ticks of the x-axis.]]
+ [[`svg_2d_plot& x_major_tick_color(const svg_color &col)`] [Sets the color of the major ticks of the X-axis.]]
 [[`svg_2d_plot& x_major_grid_color(const svg_color &col)`] [Sets the color of the grid that runs perpindicular to the X axis]]
- [[`svg_2d_plot& x_minor_tick_color(const svg_color &col)`] [Sets the color of the minor ticks of the x-axis.]]
+ [[`svg_2d_plot& x_minor_tick_color(const svg_color &col)`] [Sets the color of the minor ticks of the X-axis.]]
 [[`svg_2d_plot& y_axis_color(const svg_color &col)`] [Sets the color of the lines that form the Y axis.]]
 [[`svg_2d_plot& y_label_color(const svg_color &col)`] [Sets the color of the labels that go along the Y axis.]]
 [[`svg_2d_plot& y_major_tick_color(const svg_color &col)`] [Sets the color of the major ticks of the Y-axis.]]
@@ -167,17 +188,17 @@

[table 2D_plot Axis Information
 [[Signature] [Description]]
- [[`svg_2d_plot& x_axis_width(unsigned int)`] [Sets the stroke width (pixels) of the x-axis.] ]
- [[`svg_2d_plot& x_label(const std::string&)`] [Sets the label of the x-axis. You must set `x_label(true)` to display the label.] ]
- [[`svg_2d_plot& x_major_interval(double)`] [Sets the distance (Cartesian units) between ticks on the x-axis.] ]
- [[`svg_2d_plot& x_major_tick_length(int)`] [Sets the length (pixels) of the x-axis major ticks.] ]
- [[`svg_2d_plot& x_major_tick_width(unsigned int)`] [Sets the width (pixels) of the major ticks on the x-axis.] ]
- [[`svg_2d_plot& x_minor_tick(unsigned int)`] [Sets the length (pixels) of the x-axis minor ticks.] ]
- [[`svg_2d_plot& x_minor_tick_length(int)`] [Sets the length (pixels) of the x-axis minor tick lengths.] ]
- [[`svg_2d_plot& x_minor_tick_width(unsigned int)`] [Sets the width (pixels) of the minor ticks on the x-axis.] ]
+ [[`svg_2d_plot& x_axis_width(unsigned int)`] [Sets the line or stroke width (pixels) of the X-axis.] ]
+ [[`svg_2d_plot& x_label(const std::string&)`] [Sets the label of the X-axis. You must set `x_label(true)` to display the label.] ]
+ [[`svg_2d_plot& x_major_interval(double)`] [Sets the distance (Cartesian units) between ticks on the X-axis.] ]
+ [[`svg_2d_plot& x_major_tick_length(int)`] [Sets the length (pixels) of the X-axis major ticks.] ]
+ [[`svg_2d_plot& x_major_tick_width(unsigned int)`] [Sets the width (pixels) of the major ticks on the X-axis.] ]
+ [[`svg_2d_plot& x_minor_tick(unsigned int)`] [Sets the length (pixels) of the X-axis minor ticks.] ]
+ [[`svg_2d_plot& x_minor_tick_length(int)`] [Sets the length (pixels) of the X-axis minor tick lengths.] ]
+ [[`svg_2d_plot& x_minor_tick_width(unsigned int)`] [Sets the width (pixels) of the minor ticks on the X-axis.] ]
 [[`svg_2d_plot& x_num_minor_ticks(int)`] [Sets the number of minor ticks between each major tick.] ]
 [[`svg_2d_plot& x_range(double x1, double x2)`] [Sets the scale of the x axis from x1 to x2. Throws an exception if x2 <= x1.] ]
- [[`svg_2d_plot& y_axis_width(unsigned int)`] [Sets the stroke width of the x-axis.] ]
+ [[`svg_2d_plot& y_axis_width(unsigned int)`] [Sets the stroke width of the X-axis.] ]
 [[`svg_2d_plot& y_label(const std::string&)`] [Sets the label of the Y-axis. You must set `x_label(true)` to display the label.] ]
 [[`svg_2d_plot& y_major_tick(double)`] [Sets the distance (in Cartesian units) between ticks on the Y axis] ]
 [[`svg_2d_plot& y_major_tick_length(int)`] [Sets the length (pixels) of the Y axis major ticks.] ]
@@ -189,7 +210,7 @@
 [[`svg_2d_plot& y_scale(double y1, double y2)`] [Sets the scale of the Y axis from y1 to y2. Throws an exception if y2 <= y1.] ]
]

-(Note: Getters omitted for now. TODO)
+Accessor get functions are also provided for all the above set functions. These allow one to check the current value (default if not changed by the preceeding code).

[heading The `plot()` Method]
The `plot()` method is defined using Boost.Parameter. As such, it supports a
@@ -198,12 +219,14 @@
[table 2D_plot Required parameter
[[ID] [Type (* is a wildcard)] [Description]]
[[_container] [*] [Any object that can return an iterator with begin() and end()]]
-[[_title] [`std::string`] [The name of this series]]]
+[[_title] [`std::string`] [The name of this series]]
+] [/ table 2D_plot Required parameter]

[table 2D_plot Deduced parameter
[[ID] [Type] [Description] [Default]]
[[_fill_color] [`svg_color`] [This is the color that shows up inside of the circle that is
-being drawn] [white] ]]
+being drawn] [white]]
+] [/ table 2D_plot Deduced parameter]

[table 2D_plot Optional Parameters
[[ID] [Type] [Description] [Default]]
@@ -232,28 +255,16 @@
``
][
`boost_default_2d_convert` (the default) is sufficient in all cases where the data stored in
-the container can be directly cast to a double.]]]
+the container can be directly cast to a double.]]
+] [/ table 2D_plot Optional Parameters]

Here are some examples of correct uses:
[h3 Using fill and stroke colors]

- my_plot.(my_data, "Lions",
- _fill_color = red,
- _stroke_color = black);
-
-This has the same effect as the following:
+ my_plot.(my_data, "Lions")
+ .fill_color(red)
+ .stroke_color(black);

- my_plot.plot(my_data, "Lions", red, black);
-
-and also the same effect as:
-
- my_plot.plot(my_data, "Lions",
- _stroke_color = black,
- _fill_color = red);
-
-Since _fill_color is a deduced parameter, when two svg_colors are used in the
-same function call, they are always inferred in the following order: (fill,
-stroke).
[endsect] [/section:svg_2d_plot_interface]

[section:svg_boxplot_interface `svg_boxplot` Public Interface]
@@ -262,7 +273,8 @@
 [[`svg_boxplot()`] [See the defaults section for further details.]]
 [[`svg_boxplot& image_size(unsigned int, unsigned int)`] [Sets the size (pixels) of the plot image produced.]]
 [[`svg_boxplot& title(const std::string&)`] [Sets the string to be used for the plot title.]]
- [[`svg_boxplot& title_size(unsigned int)`] [Sets the font size for the plot title.]]]
+ [[`svg_boxplot& title_size(unsigned int)`] [Sets the font size for the plot title.]]
+] [/ table Boxplot Miscellaneous]

[table Boxplot Commands
 [[Signature] [Description]]
@@ -270,7 +282,8 @@
 [[`svg_boxplot& x_label_on(bool)`] [Sets whether or not the X-axis label will show.]]
 [[`svg_boxplot& x_labels_on(bool)`] [sets whether or not the major ticks will be labelled on the x axis.]]
 [[`svg_boxplot& y_label_on(bool)`] [Sets whether or not the Y-axis label will show.]]
- [[`svg_boxplot& y_major_labels_on(bool)`] [sets whether or not the major ticks will be labelled on the Y axis.]]]
+ [[`svg_boxplot& y_major_labels_on(bool)`] [sets whether or not the major ticks will be labelled on the Y axis.]]
+] [/ table Boxplot Commands]

[table Boxplot Colors
 [[Signature] [Description]]
@@ -283,7 +296,7 @@
 [[`svg_boxplot& y_label_color(const svg_color &col)`] [Sets the color of the labels that go along the X-axis.]]
 [[`svg_boxplot& y_major_tick_color(const svg_color &col)`] [Sets the color of the major ticks of the Y-axis.]]
 [[`svg_boxplot& y_minor_tick_color(const svg_color &col)`] [Sets the color of the minor ticks of the Y-axis.]]
- ]
+] [/ table Boxplot Colors]

[table Boxplot Axis Information
 [[Signature] [Description]]
@@ -298,22 +311,22 @@
 [[`svg_boxplot& y_major_tick_length(int)`] [Sets the length (pixels) of the Y-axis minor tick lengths.] ]
 [[`svg_boxplot& y_minor_tick_width(unsigned int)`] [Sets the width (pixels) of the minor ticks on the Y-axis.] ]
 [[`svg_boxplot& y_num_minor_ticks(int)`] [Sets the number of minor ticks between each major tick.] ]
- [[`svg_boxplot& y_range(double y1, double y2)`] [Sets the scale of the Y-axis from y1 to y2. Throws an exception if y2 <= y1.] ]
-]
+ [[`svg_boxplot& y_range(double y1, double y2)`] [Sets the scale of the Y-axis from y1 to y2. Throws an exception if y2 <= y1, or if the range is too small to produce a useful plot.] ]
+] [/table Boxplot Axis Information]

-(Note: Getters omitted for now - TODO)
+Accessor get functions are also provided for all the above set functions. These allow one to check the current value (default if not changed by the preceeding code).

[heading The `plot()` Method]

-The `plot()` method is defined using Boost.Parameter. As such, it supports a
-few extra named parameters, as well as a deduced parameter.
+The `plot()` method allows data series parameters and further chained functions to control their display.

-[table Required parameter
+[table Required parameters
[[ID] [Type (* is a wildcard)] [Description]]
[[ctr] [*] [Any object that can return an iterator with begin() and end().]]
-[[name] [`std::string`] [The name of this data series.]]]
+[[name] [`std::string`] [The name of this data series.]]
+] [/ table Required parameter]

-[table Optional Parameters
+[table Optional Functions
[[ID] [Type] [Description] [Default]]
[[box_style] [`const svg_style&`] [Styles the box of the boxplot.] [`svg_style(white, black, 1)`.]]
[[median_style] [`const svg_style&`] [Styles the median of the boxplot.] [`svg_style(white, black, 1)`.]]
@@ -342,7 +355,7 @@
plot(my_data, "People", functor = my_functor());
``]
[`boost_default_convert` (default) is sufficient in all cases where the data stored in the container can be directly cast to a double.]]
-] [/ table Required parameter]
+] [/ table Optional Functions]
[endsect] [/section:svg_2d_plot_interface]
[endsect] [/section:interface]

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_interface.qbk
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_interface.qbk (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/doc/svg_interface.qbk 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -70,14 +70,14 @@

 [[`const std::string& author()`] [Returns the author of the document.] [The default is the copyright_holder.]]

-][/Copyright table]
+] [/ Copyright table]

[table `svg` document settings and writing
 [[Signature] [Description] [Notes & Examples]]

 [[`svg& coord_precision(int)`] [Sets the precision output for coordinates (decimal digits)][default 3, but for mobiles, 2 might suffice.]]

- [[`svg& document_title(const std::string)`] [Sets title for the SVG XML document (not the plot)][<title>My Document title</title>]]
+ [[`svg& document_title(const std::string)`] [Sets title for the SVG XML document (*not the plot*)][<title>My Document title</title>]]

 [[`int document_size()`] [Returns the number of elements in the root of the document] [] ]

@@ -96,8 +96,10 @@

 [[`svg& write(const std::string&)`] [Writes the document to the file represented by the argument.][Opens the file stream itself and tries to call `write(std::ostream&)`. Throws `std::runtime_exception` if it can not open the file.]]

- [[`svg& write(std::ostream&)`] [Writes the document to the stream represented by the argument.][]]
-]
+ [[`svg& write(std::ostream&)`] [Writes the document to the stream represented by the argument.][]
+ ]
+] [/table `svg` document settings and writing]
+
[endsect] [/section:svg_interface]

Modified: sandbox/SOC/2007/visualization/libs/svg_plot/test/test_svg.cpp
==============================================================================
--- sandbox/SOC/2007/visualization/libs/svg_plot/test/test_svg.cpp (original)
+++ sandbox/SOC/2007/visualization/libs/svg_plot/test/test_svg.cpp 2008-01-17 13:45:28 EST (Thu, 17 Jan 2008)
@@ -1,5 +1,3 @@
-NEEDS REDOING TO USE STYLES
-
// test_svg.cpp

// Copyright Jacob Voytko 2007
@@ -15,14 +13,12 @@
//#if defined (BOOST_MSVC) // requires a prior Boost include, so use MSC_VER instead.

#if defined (_MSC_VER)
-# pragma warning(disable : 4267) // '=' : conversion from 'size_t' to 'unsigned int'
-# pragma warning(disable : 4172) // returning address of local variable or temporary
-// in spirit
-// TODO delete when Boost.Parameter goes.
+//# pragma warning(disable : 4267) // '=' : conversion from 'size_t' to 'unsigned int'
+//# pragma warning(disable : 4172) // returning address of local variable or temporary

# pragma warning(disable : 4310) // cast truncates constant value
# pragma warning(disable : 4512) // assignment operator could not be generated
-# pragma warning(disable : 4702) // unreachable code
+//# pragma warning(disable : 4702) // unreachable code

#endif

@@ -115,18 +111,18 @@
 BOOST_CHECK_EQUAL(my_point.size(), 10);

 plot_line_style my_plot_line(svg_color(black), false, false);
- BOOST_CHECK_EQUAL(my_plot_line.color, svg_color(black));
- BOOST_CHECK_EQUAL(my_plot_line.area_fill, blank);
- BOOST_CHECK_EQUAL(my_plot_line.line_on, false);
- BOOST_CHECK_EQUAL(my_plot_line.bezier_on, false);
+ BOOST_CHECK_EQUAL(my_plot_line.color(), svg_color(black));
+ BOOST_CHECK_EQUAL(my_plot_line.area_fill(), blank);
+ BOOST_CHECK_EQUAL(my_plot_line.line_on(), true);
+ BOOST_CHECK_EQUAL(my_plot_line.bezier_on(), false);
 plot_line_style my_plot_line2(svg_color(red), true, true);
- my_plot_line2.area_fill = green;
+ my_plot_line2.area_fill(green);
 // Note 1: it is a color constant, nor a svg_color.
 // Note 2:
- BOOST_CHECK_EQUAL(my_plot_line2.color, svg_color(red));
- BOOST_CHECK_EQUAL(my_plot_line2.area_fill, green);
- BOOST_CHECK_EQUAL(my_plot_line2.line_on, true);
- BOOST_CHECK_EQUAL(my_plot_line2.bezier_on, false);
+ BOOST_CHECK_EQUAL(my_plot_line2.color(), svg_color(red));
+ BOOST_CHECK_EQUAL(my_plot_line2.area_fill(), green);
+ BOOST_CHECK_EQUAL(my_plot_line2.line_on(), true);
+ BOOST_CHECK_EQUAL(my_plot_line2.bezier_on(), false);

 // Test the class svg_style.

@@ -289,7 +285,6 @@
 oss << ppp;
 BOOST_CHECK_EQUAL(oss.str().c_str(), "(1, 2)");

-
 polygon_element my_polygon(0, 0);
 my_polygon.P(50, 50);
 my_polygon.P(0, 100);
@@ -315,6 +310,7 @@

Output:

+------ Build started: Project: test_svg, Configuration: Debug Win32 ------
Compiling...
test_svg.cpp
Linking...
@@ -339,8 +335,14 @@
<title>Document Title</title>
</svg>
rect_element my_rect2(1, 2, 3, 4); = rect(1, 2, 3, 4)
+poly_path_point ppp(1, 2) (1, 2)
+my_polygon (0, 0)(50, 50)(0, 100)(100, 100)
+(1, 2)(3, 4)(5, 6)
*** No errors detected
-Build Time 0:13
+Build Time 0:04
+Build log was saved at "file://j:\Cpp\SVG\test_svg\Debug\BuildLog.htm"
+test_svg - 0 error(s), 0 warning(s)
+========== Build: 1 succeeded, 0 failed, 0 up-to-date, 0 skipped ==========

Next message: eric_at_[hidden]: "[Boost-commit] svn:boost r42836 - in trunk/libs/python: src/object test"
Previous message: pbristow_at_[hidden]: "[Boost-commit] svn:boost r42834 - sandbox/SOC/2007/visualization/libs/svg_plot/doc"

Date view	Thread view	Subject view	Author view

Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk