Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r75361 - in branches/quickbook-dev/libs/math/doc/sf_and_dist: . distributions
From: dnljms_at_[hidden]
Date: 2011-11-06 17:23:09


Author: danieljames
Date: 2011-11-06 17:23:07 EST (Sun, 06 Nov 2011)
New Revision: 75361
URL: http://svn.boost.org/trac/boost/changeset/75361

Log:
Quickbook: Convert some of the math docs to 1.6.

Mainly did this to see how well compatibility-mode works.
Text files modified:
   branches/quickbook-dev/libs/math/doc/sf_and_dist/bessel_ik.qbk | 2 +-
   branches/quickbook-dev/libs/math/doc/sf_and_dist/dist_reference.qbk | 2 +-
   branches/quickbook-dev/libs/math/doc/sf_and_dist/distributions/triangular.qbk | 2 +-
   branches/quickbook-dev/libs/math/doc/sf_and_dist/erf.qbk | 2 +-
   branches/quickbook-dev/libs/math/doc/sf_and_dist/math.qbk | 19 +++++++++++--------
   branches/quickbook-dev/libs/math/doc/sf_and_dist/performance.qbk | 1 -
   branches/quickbook-dev/libs/math/doc/sf_and_dist/policy_tutorial.qbk | 1 +
   branches/quickbook-dev/libs/math/doc/sf_and_dist/references.qbk | 2 +-
   8 files changed, 17 insertions(+), 14 deletions(-)

Modified: branches/quickbook-dev/libs/math/doc/sf_and_dist/bessel_ik.qbk
==============================================================================
--- branches/quickbook-dev/libs/math/doc/sf_and_dist/bessel_ik.qbk (original)
+++ branches/quickbook-dev/libs/math/doc/sf_and_dist/bessel_ik.qbk 2011-11-06 17:23:07 EST (Sun, 06 Nov 2011)
@@ -123,7 +123,7 @@
 
 [equation mbessel17]
 
-In the general case, we first normalize [nu][space] to \[[^0, [inf]])
+In the general case, we first normalize [nu][space] to \[[^0, [infin]])
 with the help of the reflection formulae:
 
 [equation mbessel9]

Modified: branches/quickbook-dev/libs/math/doc/sf_and_dist/dist_reference.qbk
==============================================================================
--- branches/quickbook-dev/libs/math/doc/sf_and_dist/dist_reference.qbk (original)
+++ branches/quickbook-dev/libs/math/doc/sf_and_dist/dist_reference.qbk 2011-11-06 17:23:07 EST (Sun, 06 Nov 2011)
@@ -109,7 +109,7 @@
        InputIterator b,
        typename std::iterator_traits<InputIterator>::value_type expected_mean);
 
-Returns the probability that the data in the sequence [a,b) has the mean
+Returns the probability that the data in the sequence \[a,b) has the mean
 /expected_mean/.
 
 [h4 Integration With Statistical Accumulators]

Modified: branches/quickbook-dev/libs/math/doc/sf_and_dist/distributions/triangular.qbk
==============================================================================
--- branches/quickbook-dev/libs/math/doc/sf_and_dist/distributions/triangular.qbk (original)
+++ branches/quickbook-dev/libs/math/doc/sf_and_dist/distributions/triangular.qbk 2011-11-06 17:23:07 EST (Sun, 06 Nov 2011)
@@ -151,7 +151,7 @@
 
 * [@http://en.wikipedia.org/wiki/Triangular_distribution Wikpedia triangular distribution]
 * [@http://mathworld.wolfram.com/TriangularDistribution.html Weisstein, Eric W. "Triangular Distribution." From MathWorld--A Wolfram Web Resource.]
-* Evans, M.; Hastings, N.; and Peacock, B. "Triangular Distribution." Ch. 40 in Statistical Distributions, 3rd ed. New York: Wiley, pp. 187-188, 2000, ISBN - 0471371246]
+* Evans, M.; Hastings, N.; and Peacock, B. "Triangular Distribution." Ch. 40 in Statistical Distributions, 3rd ed. New York: Wiley, pp. 187-188, 2000, ISBN - 0471371246
 * [@http://www.brighton-webs.co.uk/distributions/triangular.asp Brighton Webs Ltd. BW D-Calc 1.0 Distribution Calculator]
 * [@http://www.worldscibooks.com/mathematics/etextbook/5720/5720_chap1.pdf The Triangular Distribution including its history.]
 * [@http://www.measurement.sk/2002/S1/Wimmer2.pdf Gejza Wimmer, Viktor Witkovsky and Tomas Duby,

Modified: branches/quickbook-dev/libs/math/doc/sf_and_dist/erf.qbk
==============================================================================
--- branches/quickbook-dev/libs/math/doc/sf_and_dist/erf.qbk (original)
+++ branches/quickbook-dev/libs/math/doc/sf_and_dist/erf.qbk 2011-11-06 17:23:07 EST (Sun, 06 Nov 2011)
@@ -180,7 +180,7 @@
 region is very low: the last bit is incorrect in only a very small number of
 cases.
 
-For `z > 0.5` we observe that over a small interval [a, b) then:
+For `z > 0.5` we observe that over a small interval \[a, b) then:
 
    erfc(z) * exp(z*z) * z ~ c
    

Modified: branches/quickbook-dev/libs/math/doc/sf_and_dist/math.qbk
==============================================================================
--- branches/quickbook-dev/libs/math/doc/sf_and_dist/math.qbk (original)
+++ branches/quickbook-dev/libs/math/doc/sf_and_dist/math.qbk 2011-11-06 17:23:07 EST (Sun, 06 Nov 2011)
@@ -1,5 +1,6 @@
 [article Math Toolkit
- [quickbook 1.5]
+ [quickbook 1.6]
+ [compatibility-mode 1.5]
     [copyright 2006, 2007, 2008, 2009, 2010 John Maddock, Paul A. Bristow, Hubert Holin, Xiaogang Zhang, Bruno Lalande, Johan RÃ¥de, Gautam Sewani and Thijs van den Berg]
     [/purpose ISBN 0-9504833-2-X 978-0-9504833-2-0, Classification 519.2-dc22]
     [license
@@ -13,6 +14,8 @@
 
 [/ \u00E5 = Latin small letter A with ring above doesn't seem to work in authors with Quickbook 1.5]
 
+[template para[text] '''<para>'''[text]'''</para>''']
+
 [template equation[name] '''<inlinemediaobject>
 <imageobject role="html">
 <imagedata fileref="../equations/'''[name]'''.png"></imagedata>
@@ -31,13 +34,13 @@
 </imageobject>
 </inlinemediaobject>''']
 
-[include html4_symbols.qbk]
-[/include math_symbols.qbk]
+[import html4_symbols.qbk]
+[/import math_symbols.qbk]
 
-[/include latin1_symbols.qbk] [/ just for testing]
-[include common_overviews.qbk] [/ overviews that appear in more than one place!]
-[include tr1.qbk] [/tr1 docs also appear in more than one place!]
-[include roadmap.qbk] [/ for history]
+[/import latin1_symbols.qbk] [/ just for testing]
+[import common_overviews.qbk] [/ overviews that appear in more than one place!]
+[import tr1.qbk] [/tr1 docs also appear in more than one place!]
+[import roadmap.qbk] [/ for history]
 
 [def __effects [*Effects: ]]
 [def __formula [*Formula: ]]
@@ -498,7 +501,7 @@
 
 [endsect] [/section:status Status and Roadmap]
 
-[include ../../../../tools/auto_index/include/auto_index_helpers.qbk]
+[import ../../../../tools/auto_index/include/auto_index_helpers.qbk]
 [named_index function_name Function Index]
 [named_index class_name Class Index]
 [named_index typedef_name Typedef Index]

Modified: branches/quickbook-dev/libs/math/doc/sf_and_dist/performance.qbk
==============================================================================
--- branches/quickbook-dev/libs/math/doc/sf_and_dist/performance.qbk (original)
+++ branches/quickbook-dev/libs/math/doc/sf_and_dist/performance.qbk 2011-11-06 17:23:07 EST (Sun, 06 Nov 2011)
@@ -1,5 +1,4 @@
 [template perf[name value] [value]]
-[template para[text] '''<para>'''[text]'''</para>''']
 
 [section:perf Performance]
 

Modified: branches/quickbook-dev/libs/math/doc/sf_and_dist/policy_tutorial.qbk
==============================================================================
--- branches/quickbook-dev/libs/math/doc/sf_and_dist/policy_tutorial.qbk (original)
+++ branches/quickbook-dev/libs/math/doc/sf_and_dist/policy_tutorial.qbk 2011-11-06 17:23:07 EST (Sun, 06 Nov 2011)
@@ -1,3 +1,4 @@
+[import ../../example/error_handling_example.cpp]
 
 [section:pol_tutorial Policy Tutorial]
 

Modified: branches/quickbook-dev/libs/math/doc/sf_and_dist/references.qbk
==============================================================================
--- branches/quickbook-dev/libs/math/doc/sf_and_dist/references.qbk (original)
+++ branches/quickbook-dev/libs/math/doc/sf_and_dist/references.qbk 2011-11-06 17:23:07 EST (Sun, 06 Nov 2011)
@@ -103,7 +103,7 @@
 Robert Demming & Daniel J. Duffy, Introduction to the C++ Boost Libraries - Volume I - Foundations
 and Volume II ISBN 978-94-91028-01-4, Advanced Libraries and Applications, ISBN 978-94-91028-02-1
 (to be published in 2011).
-discusses application of Boost.Math, especially in finance.]
+discusses application of Boost.Math, especially in finance.
 
 [endsect] [/section:references References]
 [/


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