[Boost-commit] svn:boost r74060 - in sandbox/SOC/2011/checks/libs/checks/doc: . html

Subject: [Boost-commit] svn:boost r74060 - in sandbox/SOC/2011/checks/libs/checks/doc: . html
From: pbristow_at_[hidden]
Date: 2011-08-25 15:03:33

Author: pbristow
Date: 2011-08-25 15:03:32 EDT (Thu, 25 Aug 2011)
New Revision: 74060
URL: http://svn.boost.org/trac/boost/changeset/74060

Log:
Pass 2 changes to docs
Binary files modified: 
   sandbox/SOC/2011/checks/libs/checks/doc/checks.pdf
Text files modified: 
   sandbox/SOC/2011/checks/libs/checks/doc/checks.qbk                 |    47 ++++++++++++++-------------             
   sandbox/SOC/2011/checks/libs/checks/doc/html/checks_reference.html |    10 ++--                                    
   sandbox/SOC/2011/checks/libs/checks/doc/html/index.html            |    67 +++++++++++++++++++-------------------- 
   sandbox/SOC/2011/checks/libs/checks/doc/jamfile                    |    21 ++++--------                            
   4 files changed, 69 insertions(+), 76 deletions(-)

Modified: sandbox/SOC/2011/checks/libs/checks/doc/checks.pdf
==============================================================================
Binary files. No diff available.

Modified: sandbox/SOC/2011/checks/libs/checks/doc/checks.qbk
==============================================================================
--- sandbox/SOC/2011/checks/libs/checks/doc/checks.qbk	(original)
+++ sandbox/SOC/2011/checks/libs/checks/doc/checks.qbk	2011-08-25 15:03:32 EDT (Thu, 25 Aug 2011)
@@ -1,4 +1,4 @@
-[article Boost_Checks
+[article Checks
     [quickbook 1.5]
     [copyright 2011 Pierre Talbot]
     [license
@@ -17,11 +17,8 @@
 [/Note too that it can't be used for images.]
 [def __boostlicense [@http://www.boost.org/LICENSE_1_0.txt Boost License]]
 
-[def __GSOC [@http://code.google.com/soc/2011/boost/about.html Google Summer of Code project (2011)]]
-
-
 [def __CHECKS__HIERARCHY__ [$images/checks/check_hierarchy.png]]
-[def __EXTENDS__LIBRARY__ [link boost_checks.checks.tutorial.extending_the_library extending the library]]
+[def __EXTENDS__LIBRARY__ [link checks.checks.tutorial.extending_the_library extending the library]]
 
 [def __BASIC__CHECK__FILE__ [@../../../../boost/checks/basic_checks.hpp basic_checks.hpp]]
 [def __WEIGHTED__SUM__FILE__ [@../../../../boost/checks/weighted_sum.hpp weighted_sum.hpp]]
@@ -30,6 +27,7 @@
 [def __CHECKS__TUTO__FILE__ [@../../example/checks_tutorial.cpp checks_tutorial.cpp]]
 [def __CHECKS__EXAMPLE__FILE__ [@../../example/checks_examples.cpp checks_examples.cpp]]
 
+[def __GSOC [@http://code.google.com/soc/2011/boost/about.html Google Summer of Code project (2011)]]
 [def __VISA [@http://en.wikipedia.org/wiki/Visa_credit_card Visa credit card]]
 [def __MASTERCARD [@http://en.wikipedia.org/wiki/Mastercard Mastercard credit card]]
 [def __AMEX [@http://en.wikipedia.org/wiki/American_Express  American Express]]
@@ -41,27 +39,26 @@
 [def __CODE39 [@http://en.wikipedia.org/wiki/Code_39 Code 39]]
 [def __EAN [@http://en.wikipedia.org/wiki/European_Article_Number International Article Number (EAN)]]
 
-[def __types_of_errors [link boost_checks.checks.errors types of error]]
-[def __overview [link boost_checks.checks.overview Overview]]
+[def __types_of_errors [link checks.checks.errors types of error]]
+[def __overview [link checks.checks.overview Overview]]
 
 [def __spaces '''  '''] [/ two spaces - useful for an indent.]
 
-[section:checks Boost.Checks]
+[section:checks Checks]
 
 [section:preface Preface]
 
-The checks are required in numerous domains such as the distribution chain (bar codes), 
+Checks are required on alphanumeric identifiers in numerous domains
+such as the distribution chain (product bar codes), 
 banking (bank account, credit cards, fidelity cards, ...) and many others.
-These codes and numbers are often copied or scanned by humans or machines;
+These codes and numbers are often typed, copied or scanned by humans or machines;
 and both make errors. We need a way to detect errors and this 
-is why check digits have been designed. A check digit aimes to control the validity of a number 
-and catch the as many changes as possible.
-(__types_of_errors discuss possible alterations and their detection).
-
+is why check digits have been designed.
 
-[endsect] [/section:preface Preface]
+A check digit aims to control the validity of a alphanumeric string 
+and catch the as many changes as possible.
+(__types_of_errors discuss possible alterations and the efficiency of their detection).
 
-[section:overview Overview]
 This library provides a collection of functions for validating and creating check digits.
 
 Scott McMurray has identifed four fairly distinct types of check:
@@ -71,22 +68,27 @@
 # checksums like CRC32, for catching data transmission errors.
 # and cryptographic hash functions, the only ones useful against malicious adversaries.
 
-These are primarily for the first category : catching human-entry errors
+The functions in this Boost.Checks library are primarily for the first category :
+catching human-entry errors
 (though it obviously also provides against a mis-scan or mis-transmit 
 by a device like a bar code or card reader.) 
 
 This library supports four families of check : Modulus 10, Modulus 11, Modulus 97-10 
 and Verhoeff. A lot of other check systems are inherited from these families.
 
-The following diagram shows the hierachy used in Boost.Checks:
+The following diagram shows the hierarchy used in Boost.Checks:
 
 __CHECKS__HIERARCHY__
 
 Numerous check algorithms are in use worldwide,
 and this is why this library is designed to help you to cater
-for these less common checks, and even to create your own check systems.
+for less common checks, and even to create your own check systems.
 If you are interested, see __EXTENDS__LIBRARY__.
 
+[endsect] [/section:preface Preface]
+
+[section:status Status]
+
 [important This is not (yet) an official Boost library. It was a __GSOC
 whose mentor organization was Boost. It remains a library under construction,
 the code is quite functional, but interfaces, library structure, and names
@@ -97,14 +99,13 @@
 [*https://svn.boost.org/svn/boost/sandbox/SOC/2011/checks/libs/checks/doc/html/index.html HTML documentation.]
 
 [*https://svn.boost.org/svn/boost/sandbox/SOC/2011/checks/boost/checks/boost/ Boost Sandbox checks source code.]
-]
+] [/important]
 
 [note Comments and suggestions (even bugs!) to Pierre Talbot pierre.talbot.6114 (at) herslibramont (dot) be]
 
-[include conventions.qbk]
-
-[endsect] [/section:overview Overview]
+[endsect] [/section:status Status]
 
+[include conventions.qbk]
 [include tutorial.qbk]
 [include algorithm.qbk]
 [include errors.qbk]

Modified: sandbox/SOC/2011/checks/libs/checks/doc/html/checks_reference.html
==============================================================================
--- sandbox/SOC/2011/checks/libs/checks/doc/html/checks_reference.html	(original)
+++ sandbox/SOC/2011/checks/libs/checks/doc/html/checks_reference.html	2011-08-25 15:03:32 EDT (Thu, 25 Aug 2011)
@@ -4,9 +4,9 @@
 <title>Checks Reference</title>
 <link rel="stylesheet" href="./boostbook.css" type="text/css">
 <meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
-<link rel="home" href="index.html" title="Boost_Checks">
-<link rel="up" href="index.html" title="Boost_Checks">
-<link rel="prev" href="boost_checks/checks/version_id.html" title="Version Info">
+<link rel="home" href="index.html" title="Checks">
+<link rel="up" href="index.html" title="Checks">
+<link rel="prev" href="checks/checks/version_id.html" title="Version Info">
 <link rel="next" href="header/boost/checks/amex_hpp.html" title="Header &lt;boost/checks/amex.hpp&gt;">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
@@ -20,7 +20,7 @@
 </tr></table>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="boost_checks/checks/version_id.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="header/boost/checks/amex_hpp.html"><img src="images/next.png" alt="Next"></a>
+<a accesskey="p" href="checks/checks/version_id.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="header/boost/checks/amex_hpp.html"><img src="images/next.png" alt="Next"></a>
 </div>
 <div class="section" lang="en">
 <div class="titlepage"><div><div><h2 class="title" style="clear: both">
@@ -57,7 +57,7 @@
 </tr></table>
 <hr>
 <div class="spirit-nav">
-<a accesskey="p" href="boost_checks/checks/version_id.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="header/boost/checks/amex_hpp.html"><img src="images/next.png" alt="Next"></a>
+<a accesskey="p" href="checks/checks/version_id.html"><img src="images/prev.png" alt="Prev"></a><a accesskey="u" href="index.html"><img src="images/up.png" alt="Up"></a><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home"></a><a accesskey="n" href="header/boost/checks/amex_hpp.html"><img src="images/next.png" alt="Next"></a>
 </div>
 </body>
 </html>

Modified: sandbox/SOC/2011/checks/libs/checks/doc/html/index.html
==============================================================================
--- sandbox/SOC/2011/checks/libs/checks/doc/html/index.html	(original)
+++ sandbox/SOC/2011/checks/libs/checks/doc/html/index.html	2011-08-25 15:03:32 EDT (Thu, 25 Aug 2011)
@@ -1,11 +1,11 @@
 <html>
 <head>
 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
-<title>Boost_Checks</title>
+<title>Checks</title>
 <link rel="stylesheet" href="./boostbook.css" type="text/css">
 <meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
-<link rel="home" href="index.html" title="Boost_Checks">
-<link rel="next" href="boost_checks/checks.html" title="Boost.Checks">
+<link rel="home" href="index.html" title="Checks">
+<link rel="next" href="checks/checks.html" title="Checks">
 </head>
 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 <table cellpadding="2" width="100%"><tr>
@@ -17,18 +17,18 @@
 <td align="center">More</td>
 </tr></table>
 <hr>
-<div class="spirit-nav"><a accesskey="n" href="boost_checks/checks.html"><img src="images/next.png" alt="Next"></a></div>
+<div class="spirit-nav"><a accesskey="n" href="checks/checks.html"><img src="images/next.png" alt="Next"></a></div>
 <div class="article" lang="en">
 <div class="titlepage">
 <div>
 <div><h2 class="title">
-<a name="boost_checks"></a>Boost_Checks</h2></div>
+<a name="checks"></a>Checks</h2></div>
 <div><div class="authorgroup"><div class="author"><h3 class="author">
 <span class="firstname">Pierre</span> <span class="surname">Talbot</span>
 </h3></div></div></div>
 <div><p class="copyright">Copyright &#169; 2011 Pierre Talbot</p></div>
 <div><div class="legalnotice">
-<a name="id894649"></a><p>
+<a name="id876939"></a><p>
         Distributed under the Boost Software License, Version 1.0. (See accompanying
         file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
       </p>
@@ -39,40 +39,39 @@
 <div class="toc">
 <p><b>Table of Contents</b></p>
 <dl>
-<dt><span class="section">Boost.Checks</span></dt>
+<dt><span class="section">Checks</span></dt>
 <dd><dl>
-<dt><span class="section">Preface</span></dt>
-<dt><span class="section">Overview</span></dt>
-<dd><dl><dt><span class="section"><a href="boost_checks/checks/overview/conventions.html">Document
-        Conventions</a></span></dt></dl></dd>
-<dt><span class="section">Tutorial</span></dt>
+<dt><span class="section">Preface</span></dt>
+<dt><span class="section">Status</span></dt>
+<dt><span class="section">Document Conventions</span></dt>
+<dt><span class="section">Tutorial</span></dt>
 <dd><dl>
-<dt><span class="section">Starting with Checks</span></dt>
-<dt><span class="section"><a href="boost_checks/checks/tutorial/extending_the_library.html">Extending
+<dt><span class="section">Starting with Checks</span></dt>
+<dt><span class="section"><a href="checks/checks/tutorial/extending_the_library.html">Extending
         the library</a></span></dt>
 </dl></dd>
-<dt><span class="section">Common check algorithms</span></dt>
-<dt><span class="section">Type of errors</span></dt>
+<dt><span class="section">Common check algorithms</span></dt>
+<dt><span class="section">Type of errors</span></dt>
 <dd><dl>
-<dt><span class="section">Alteration</span></dt>
-<dt><span class="section">Transposition</span></dt>
-<dt><span class="section">Length</span></dt>
-<dt><span class="section">Shift</span></dt>
-<dt><span class="section">Phonetic</span></dt>
+<dt><span class="section">Alteration</span></dt>
+<dt><span class="section">Transposition</span></dt>
+<dt><span class="section">Length</span></dt>
+<dt><span class="section">Shift</span></dt>
+<dt><span class="section">Phonetic</span></dt>
 </dl></dd>
-<dt><span class="section">Modular sum algorithms</span></dt>
+<dt><span class="section">Modular sum algorithms</span></dt>
 <dd><dl>
-<dt><span class="section">Luhn algorithm</span></dt>
-<dt><span class="section">Modulus 10 algorithm</span></dt>
-<dt><span class="section">Modulus 11 algorithm</span></dt>
-<dt><span class="section">Summary of Algorithms</span></dt>
+<dt><span class="section">Luhn algorithm</span></dt>
+<dt><span class="section">Modulus 10 algorithm</span></dt>
+<dt><span class="section">Modulus 11 algorithm</span></dt>
+<dt><span class="section">Summary of Algorithms</span></dt>
 </dl></dd>
-<dt><span class="section">Acknowledgements</span></dt>
-<dt><span class="section">FAQs</span></dt>
-<dt><span class="section">References</span></dt>
-<dt><span class="section">Rationale</span></dt>
-<dt><span class="section">History</span></dt>
-<dt><span class="section">Version Info</span></dt>
+<dt><span class="section">Acknowledgements</span></dt>
+<dt><span class="section">FAQs</span></dt>
+<dt><span class="section">References</span></dt>
+<dt><span class="section">Rationale</span></dt>
+<dt><span class="section">History</span></dt>
+<dt><span class="section">Version Info</span></dt>
 </dl></dd>
 <dt><span class="section">Checks Reference</span></dt>
 <dd><dl>
@@ -105,10 +104,10 @@
 </div>
 </div>
 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: August 23, 2011 at 17:41:23 GMT</small></p></td>
+<td align="left"><p><small>Last revised: August 24, 2011 at 12:10:49 GMT</small></p></td>
 <td align="right"><div class="copyright-footer"></div></td>
 </tr></table>
 <hr>
-<div class="spirit-nav"><a accesskey="n" href="boost_checks/checks.html"><img src="images/next.png" alt="Next"></a></div>
+<div class="spirit-nav"><a accesskey="n" href="checks/checks.html"><img src="images/next.png" alt="Next"></a></div>
 </body>
 </html>

Modified: sandbox/SOC/2011/checks/libs/checks/doc/jamfile
==============================================================================
--- sandbox/SOC/2011/checks/libs/checks/doc/jamfile	(original)
+++ sandbox/SOC/2011/checks/libs/checks/doc/jamfile	2011-08-25 15:03:32 EDT (Thu, 25 Aug 2011)
@@ -16,7 +16,6 @@
 
 using quickbook ;  # Required if you want to use Quickbook.
 using doxygen ;  # Required if you want to use Doxygen.
-#using auto-index ; # Required if you want to use autoindexing.
 
 import modules ;
 import path ;
@@ -41,7 +40,7 @@
 
 path-constant nav_images : html/images/ ; # png and svg images for home, next, note, tip...
 # path-constant images_location : ../doc/html/images ; # location of Checks images referenced by Quickbook.
-#  MIght like some fancy pictures of credit cards etc...
+#path-constant images_location : html/images ; # location of SVG and PNG images referenced by Quickbook.
 path-constant images_location : html/images ; # location of SVG and PNG images referenced by Quickbook.
 
 echo "images_location" $(images_location) ; 
@@ -213,10 +212,10 @@
   <xsl:param>boost.root=../../../../../../../boost_trunk # OK but link to I:/boost_trunk/boost.png
 
   # Also control links to admonitions, so need to set separately.
-  #<xsl:param>boost.root=../../../../../../../boost_1_46_0 # OK file:///I:/boost_1_46_0/boost.png
+  #<xsl:param>boost.root=../../../../../../../boost_1_46_0 # OK file:///I:/boost_1_48_0/boost.png
   # Quickbook [@boost:/boost/units/detail/utility.hpp] should make it relative to xsl parameter boost.root.
 
-  # [@boost:boost.png Boost logo]  # xsl parameter boost.root, for example I:/boost_1_45_0/boost.png
+  # [@boost:boost.png Boost logo]  # xsl parameter boost.root, for example I:/boost_1_48_0/boost.png
 
   # Path for libraries index:
   <xsl:param>boost.libraries=../../../../../../../boost_1_46_0/libs/libraries.htm
@@ -253,13 +252,11 @@
   <xsl:param>toc.max.depth=4  # Max depth in each TOC.
   <xsl:param>generate.section.toc.level=10  # How far down we go with TOCs.
                            
-  #<format>html:<xsl:param>img.src.path=$(images_location)/ # Path of image (.png) files. (Note trailing /) 
-  # This doesn't work??? 
-  
   #<format>html:<xsl:param>admon.graphics.extension=".png"  # default type for admonitions (important, warning, note ...)
   #<format>html:<xsl:param>admon.graphics.path=$(nav-images)/ # path to admonition (warning, note...) image (.png) files.
   
   # <xsl:param name="draft.watermark.image">http://docbook.sourceforge.net/release/images/draft.png>
+  # but use a local copy of draft.png.
 
   # PDF Options:
   # -----------
@@ -287,20 +284,16 @@
   # Yes, we want graphics for admonishments:
   <xsl:param>admon.graphics=1
   # Set these one for PDF generation *only*:
-  #
   # In PDF format, default PNG graphics are awful, so better use SVG images (type .svg) instead.
   <format>pdf:<xsl:param>admon.graphics.extension=".svg"  #
   <format>pdf:<xsl:param>use.role.for.mediaobject=1 # Use print role on next line.
   <format>pdf:<xsl:param>preferred.mediaobject.role=print # pdf role is to be printed.
-  <format>pdf:<xsl:param>img.src.path=$(images_location)/ # Path of image (.svg) files. (Note trailing /) ? //
-  #<format>pdf:<xsl:param>img.src.path=../ # alternative location of images.
+  # <format>pdf:<xsl:param>img.src.path=$(images_location)/ # Path of image (.svg) files. (Note trailing /) ? 
+  <format>pdf:<xsl:param>img.src.path=./images/ # Path of image (.svg) files. (Note trailing /)
   <format>pdf:<xsl:param>admon.graphics.path=$(nav_images)/ # path to admonition (warning, note...) image (.svg) files.
   <format>pdf:<xsl:param>draft.mode="yes" # Yes if draft watermark wanted!
-  #<format>pdf:<xsl:param>draft.watermark.image="draft.png" # Watermark.
+  #<format>pdf:<xsl:param>draft.watermark.image="draft.png" # Watermark (local copy).
   #<format>pdf:<xsl:param>draft.watermark.image=http://docbook.sourceforge.net/release/images/draft.png # Watermark.
-	#<format>pdf:<xsl:param>boost.url.prefix=I:/boost-sandbox/tools/checks/libs/checks/doc/html
-	# is absolute reference!
-	#<format>pdf:<xsl:param>boost.url.prefix=I:/boost-sandbox/tools/checks/libs/checks/doc/html
         
   <dependency>autodoc # Doxygen  reference section
   # <dependency>pdf-install # final pdf