From d97836444e51d9d89bd7cbd719a13854a06e97c5 Mon Sep 17 00:00:00 2001 From: Daniel James Date: Mon, 8 Dec 2008 23:35:20 +0000 Subject: [PATCH 01/20] Run the docbook chunker quietly, unless boostbook.verbose is set. [SVN r50213] --- xsl/html.xsl | 2 ++ xsl/xhtml.xsl | 2 ++ 2 files changed, 4 insertions(+) diff --git a/xsl/html.xsl b/xsl/html.xsl index a0ee2f2..02ed0c1 100644 --- a/xsl/html.xsl +++ b/xsl/html.xsl @@ -26,6 +26,7 @@ 1 + 0 @@ -38,6 +39,7 @@ false yes + 2 15 1 + 0 @@ -38,6 +39,7 @@ false yes + 2 15 Date: Tue, 9 Dec 2008 13:52:07 +0000 Subject: [PATCH 02/20] Fix some xsl type errors. [SVN r50222] --- xsl/html.xsl | 4 ++-- xsl/xhtml.xsl | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/xsl/html.xsl b/xsl/html.xsl index 02ed0c1..70c6f40 100644 --- a/xsl/html.xsl +++ b/xsl/html.xsl @@ -26,7 +26,7 @@ 1 - 0 + @@ -39,7 +39,7 @@ false yes - + 2 15 1 - 0 + @@ -39,7 +39,7 @@ false yes - + 2 15 Date: Fri, 12 Dec 2008 15:06:44 +0000 Subject: [PATCH 03/20] Make doxygen command "\throw" work with boostbook. [SVN r50246] --- xsl/doxygen/doxygen2boostbook.xsl | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/xsl/doxygen/doxygen2boostbook.xsl b/xsl/doxygen/doxygen2boostbook.xsl index 3210759..e9f339a 100644 --- a/xsl/doxygen/doxygen2boostbook.xsl +++ b/xsl/doxygen/doxygen2boostbook.xsl @@ -1208,12 +1208,12 @@ Cannot handle memberdef element with kind= - + Will not throw. - + Date: Mon, 26 Jan 2009 23:14:53 +0000 Subject: [PATCH 04/20] Make checking for duplicated names case insensitive. This avoids generating filenames with names that only differ by case as they cause problems on case insensitive file systems. [SVN r50798] --- xsl/annotation.xsl | 5 ++++- xsl/lookup.xsl | 3 ++- xsl/macro.xsl | 3 ++- 3 files changed, 8 insertions(+), 3 deletions(-) diff --git a/xsl/annotation.xsl b/xsl/annotation.xsl index 16e7620..11d9f54 100644 --- a/xsl/annotation.xsl +++ b/xsl/annotation.xsl @@ -8,6 +8,9 @@ --> + + + @@ -17,7 +20,7 @@ - + diff --git a/xsl/lookup.xsl b/xsl/lookup.xsl index 5a4a34c..1dd362d 100644 --- a/xsl/lookup.xsl +++ b/xsl/lookup.xsl @@ -225,7 +225,8 @@ - + diff --git a/xsl/macro.xsl b/xsl/macro.xsl index a792eff..e396295 100644 --- a/xsl/macro.xsl +++ b/xsl/macro.xsl @@ -74,7 +74,8 @@ - + _ From c3be9243b6d2ef057b0060a0b99c7e459f285340 Mon Sep 17 00:00:00 2001 From: John Maddock Date: Sun, 8 Feb 2009 16:59:14 +0000 Subject: [PATCH 05/20] Add Jamfile to build PDF versions of all the docs. Tweaked some existing Jamfiles so that PDF build finds all the necessary image files etc. Tweaked fo.xsl to provide more options by default, and improve formatting. [SVN r51104] --- xsl/fo.xsl | 47 ++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 44 insertions(+), 3 deletions(-) diff --git a/xsl/fo.xsl b/xsl/fo.xsl index 2db6602..625c101 100644 --- a/xsl/fo.xsl +++ b/xsl/fo.xsl @@ -180,7 +180,8 @@ Put a box around admonishments and keep them together: #DCDCDC @@ -190,10 +191,15 @@ and keep the block together if we can: 0.2cm 0.2cm 0.2cm - 1 + 6 + 40 9pt + 0.2cm 0.2cm @@ -205,8 +211,43 @@ and keep the block together if we can: 1 - #DCDCDC + +#DCDCDC #DCDCDC +0pt +0.5in +0.5in +A4 +1 +.svg +no +http://svn.boost.org/svn/boost/trunk/doc/src/images/ +http://svn.boost.org/svn/boost/trunk/doc/src/images/callouts/ +http://svn.boost.org/svn/boost/trunk/doc/html/ + + From 82858e99f6c0d4399e93f7b8ba8f019ced599e07 Mon Sep 17 00:00:00 2001 From: John Maddock Date: Mon, 9 Feb 2009 17:45:10 +0000 Subject: [PATCH 06/20] Change section to chapter: mixing chapters and sections at the top level in a document causes PDF build to fail. [SVN r51147] --- doc/reference.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/reference.xml b/doc/reference.xml index 0a7fc82..2fe9a85 100644 --- a/doc/reference.xml +++ b/doc/reference.xml @@ -1,5 +1,5 @@ -
+ Reference Elements:Element access - Declares an access specification for class membersElement boostbook - Defines a BoostBook bookElement class - Declares a class or class templateElement class-specialization - A specialization (partial or full) of a class templateElement code - Mimics the code tag in HTMLElement compile-fail-test - A testcase that should fail to compileElement compile-test - A testcase that should compile correctlyElement complexity - The time/space/etc. complexity of a functionElement constructor - Declares a constructor of the enclosing classElement copy-assignment - Declares a copy-assignment operatorElement data-member - Declares a data member of a classElement default - The default value of a function or template parameterElement description - Detailed description of a constructElement destructor - Declares a destructor for the enclosing classElement effects - Declares the side effects of a functionElement enum - Declares an enumeration typeElement enumvalue - A single value of an enumerationElement free-function-group - A set of functions that are grouped together under one nameElement function - Declares a functionElement functionname - References a function with the given nameElement header - Declares a C++ header with the given nameElement if-fails - What it means when a testcase failsElement inherit - Declares a base class of the enclosing class or structElement lib - A library dependencyElement library - Top-level element for a libraryElement library-reference - Declares the reference material for a libraryElement librarycategory - Declares that the enclosing library is in this categoryElement librarycategorydef - Defines a new library categoryElement librarycategorylist - Categorized listing of librariesElement libraryinfo - Provides information about a libraryElement librarylist - Placeholder for an alphabetical list of librariesElement libraryname - References a library of the given nameElement librarypurpose - Describes in one short sentence or phrase the purpose of a libraryElement link-fail-test - Declares a test that should compile but fail to linkElement link-test - Declares a test that should compile and linkElement method - Declares a method, i.e., a member functionElement method-group - A set of methods that are grouped together under one nameElement namespace - Declares a namespaceElement notes - Non-normative notes about a function's semanticsElement overloaded-function - An overloaded functionElement overloaded-method - An overloaded methodElement parameter - A function parameterElement paramtype - The type of a function parameterElement postconditions - Conditions that must hold after the function returnsElement precondition - Conditions that must be met prior to executing a functionElement programlisting - A sample of program codeElement purpose - A short description of an entity's useElement rationale - Describes the rationale for a particular function's designElement requirement - A requirement/property in the Jamfile for a testcaseElement requires - Declares the requirements of a functionElement returns - Description of the return value of a functionElement run-fail-test - A testcase that should compile and link, but fail on executionElement run-test - A testcase that should compile, link, and executeElement signature - One signature of an overloaded function or methodElement snippet - Pulls in a code snippet from a programlisting elementElement source - Defines source code for a testElement specialization - Defines the specialization arguments for a class specializationElement static-constant - Declares a static constant, e.g., const int foo = 5;.Element struct - Declares a C++ structElement struct-specialization - A specialization (full or partial) of a struct templateElement template - Declares the template parameters of a class or functionElement template-arg - A template argument in a specializationElement template-nontype-parameter - A nontype template parameterElement template-type-parameter - Declares a template type parameterElement template-varargs - Declares a variable-length list of template parametersElement testsuite - Describes a library testsuiteElement throws - Description of the exceptions thrown by a functionElement type - The type of an element or return type of a functionElement typedef - Declares a typedefElement union - Declares a C++ union or union templateElement union-specialization - A specialization (full or partial) of a union templateElement using-class - Injects the method and function names of a class into the local scopeElement using-namespace - Injects the declared names from a namespace into the local scope @@ -2798,4 +2798,4 @@ -
+ From 2423ae5950004025de315ca46f7acc51c91ea366 Mon Sep 17 00:00:00 2001 From: Daniel James Date: Sun, 15 Feb 2009 19:31:37 +0000 Subject: [PATCH 07/20] Implement the 'boost:' for links relative to boost root. Also, optionally replace links within the boost distribution with links to the the boost site, which is useful for generating pdfs and standalone documentation. Implemented with John Maddock. Fixes #1166. [SVN r51261] --- xsl/docbook.xsl | 46 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/xsl/docbook.xsl b/xsl/docbook.xsl index 98b7d7f..706a7c4 100644 --- a/xsl/docbook.xsl +++ b/xsl/docbook.xsl @@ -20,16 +20,37 @@ - + + + + + + + + / + + + + + + + + + + + + + + @@ -183,6 +204,28 @@ + + + + + + + + + + + + + + + + + + + + + + @@ -496,3 +539,4 @@ Error: XSL template 'link-or-anchor' called with invalid link-type ' + From 837b3eeb29771830e0e1b84c8665fb806c3a99f2 Mon Sep 17 00:00:00 2001 From: John Maddock Date: Mon, 16 Feb 2009 10:39:18 +0000 Subject: [PATCH 08/20] Add default path for callouts. [SVN r51268] --- xsl/html.xsl | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/xsl/html.xsl b/xsl/html.xsl index 70c6f40..e701b1a 100644 --- a/xsl/html.xsl +++ b/xsl/html.xsl @@ -46,9 +46,11 @@ select = "concat($boost.root, '/doc/html/images/')"/> + - + From 7e71c7ad2afd98b0716187f5792ed534fb9e422b Mon Sep 17 00:00:00 2001 From: John Maddock Date: Mon, 16 Feb 2009 10:40:26 +0000 Subject: [PATCH 09/20] Add preliminary HTMLHelp support. [SVN r51269] --- xsl/html-help.xsl | 147 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+) create mode 100644 xsl/html-help.xsl diff --git a/xsl/html-help.xsl b/xsl/html-help.xsl new file mode 100644 index 0000000..9b99789 --- /dev/null +++ b/xsl/html-help.xsl @@ -0,0 +1,147 @@ + + + + + + + + + 1 + + + + + + + + + 15 + no + + + + + + + + + + + + + + + + + + + + + + + + + + January + February + March + April + May + June + July + August + September + October + November + December + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + January + February + March + April + May + June + July + August + September + October + November + December + + + + + + + + + + + + +
+
+ + +

Synopsis

+
+ +
+
+ +
From e272daa32e5d1ec25cd9871e70873f6f34a970e1 Mon Sep 17 00:00:00 2001 From: Daniel James Date: Wed, 18 Feb 2009 21:22:37 +0000 Subject: [PATCH 10/20] Remove long out of date warning. [SVN r51319] --- setup_boostbook.py | 6 ------ 1 file changed, 6 deletions(-) diff --git a/setup_boostbook.py b/setup_boostbook.py index 64e7249..575f5ff 100644 --- a/setup_boostbook.py +++ b/setup_boostbook.py @@ -288,12 +288,6 @@ def setup_boostbook( tools_directory ): print "Done! Execute \"bjam --v2\" in a documentation directory to generate" print "documentation with BoostBook. If you have not already, you will need" print "to compile Boost.Jam." - print "" - print "WARNING FOR WIN32: please obtain a patched version of xsltproc " - print "from http://engineering.meta-comm.com/xsltproc-win32.zip if you" - print "are running BoostBook build on Win32 system (this patched version" - print "solves the long-standing xsltproc problem with " - print "creating directories for output files)." def main(): ( tools_directory ) = accept_args( sys.argv[ 1: ] ) From 05343b86e42dfbc531a7c706dbcf67c75598ccb9 Mon Sep 17 00:00:00 2001 From: Daniel James Date: Wed, 18 Feb 2009 21:23:35 +0000 Subject: [PATCH 11/20] Add default path for callouts to xhtml. [SVN r51321] --- xsl/xhtml.xsl | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/xsl/xhtml.xsl b/xsl/xhtml.xsl index bd2a264..e268717 100644 --- a/xsl/xhtml.xsl +++ b/xsl/xhtml.xsl @@ -46,9 +46,11 @@ select = "concat($boost.root, '/doc/xhtml/images/')"/> + - + @@ -75,6 +77,7 @@ section toc set toc,title + @@ -307,4 +310,3 @@ set toc,title - From 4cb40a7e092c5e23fc27d5c51e048736cc63f7ad Mon Sep 17 00:00:00 2001 From: Daniel James Date: Wed, 18 Feb 2009 21:24:36 +0000 Subject: [PATCH 12/20] More information in error messages in the doxygen2boostbook script. [SVN r51323] --- xsl/doxygen/doxygen2boostbook.xsl | 49 ++++++++++++++++++++++++------- 1 file changed, 38 insertions(+), 11 deletions(-) diff --git a/xsl/doxygen/doxygen2boostbook.xsl b/xsl/doxygen/doxygen2boostbook.xsl index e9f339a..e4ae057 100644 --- a/xsl/doxygen/doxygen2boostbook.xsl +++ b/xsl/doxygen/doxygen2boostbook.xsl @@ -53,6 +53,23 @@ + + + + + + + + + + + + + + + + + @@ -131,9 +148,9 @@
- -Cannot handle compounddef with kind= - + + +
@@ -471,8 +488,9 @@ Cannot handle compounddef with kind= - Cannot handle toplevel memberdef element with - kind= + + + @@ -666,6 +684,15 @@ Cannot handle compounddef with kind= + + + + + + + + + @@ -699,9 +726,9 @@ Cannot handle compounddef with kind= - -Cannot handle sectiondef with kind= - + + + @@ -783,9 +810,9 @@ Cannot handle sectiondef with kind= - -Cannot handle memberdef element with kind= - + + + From b55c27558f5b4a145564698ab6ee25eaefb2f11f Mon Sep 17 00:00:00 2001 From: Daniel James Date: Wed, 18 Feb 2009 21:25:12 +0000 Subject: [PATCH 13/20] Deal with top level enums from doxygen. [SVN r51324] --- xsl/doxygen/doxygen2boostbook.xsl | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/xsl/doxygen/doxygen2boostbook.xsl b/xsl/doxygen/doxygen2boostbook.xsl index e4ae057..ee73005 100644 --- a/xsl/doxygen/doxygen2boostbook.xsl +++ b/xsl/doxygen/doxygen2boostbook.xsl @@ -487,6 +487,10 @@ + + + + From eac7e37f0a343c67fbb86c7cf29323c519d2d3fd Mon Sep 17 00:00:00 2001 From: John Maddock Date: Thu, 19 Feb 2009 13:33:22 +0000 Subject: [PATCH 14/20] Fix FO XSL customisation layer to improve formatting - use widow and orphan control rather than "keep-together", make sure formatting is applied consistently across all elements, and allow code block to line wrap with hyphenation. [SVN r51328] --- xsl/fo.xsl | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/xsl/fo.xsl b/xsl/fo.xsl index 625c101..a7ce43e 100644 --- a/xsl/fo.xsl +++ b/xsl/fo.xsl @@ -175,13 +175,16 @@ Put a box around admonishments and keep them together: 0.2cm 0.2cm 0.2cm - 1 + 1 #DCDCDC @@ -194,8 +197,18 @@ and orphans controls: 6 40 9pt + true + wrap + + + + + + 9pt + + - 1 + 6 + 40 + + + 6 + 40 + 9pt @@ -225,12 +226,10 @@ together on one page if possible: results for very large tables than a simple "keep-together" instruction--> - 6 - 40 + 1 - 6 - 40 + 1 - + diff --git a/test/Jamfile.v2 b/test/Jamfile.v2 new file mode 100644 index 0000000..14cf420 --- /dev/null +++ b/test/Jamfile.v2 @@ -0,0 +1,16 @@ +# Copyright (c) 2009 Daniel James +# +# 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) + +project boost/test ; +import boostbook : boostbook ; + +boostbook alt : alt.xml : + html.stylesheet=../../../../doc/html/boostbook.css + boost.root=../../../.. + boost.libraries=../../../../libs/libraries.htm + navig.graphics=1 + ; + diff --git a/test/alt.xml b/test/alt.xml new file mode 100644 index 0000000..48c6ee6 --- /dev/null +++ b/test/alt.xml @@ -0,0 +1,40 @@ + + + + + + + + + Daniel + James + + Fictional example + + + Fictional example library, for testing + +
+ Alt Tests + + Example header + Example header: example.hpp + + Example macro + Example macro: EXAMPLE +
+ + +
+ + Example macro + +
+
+
\ No newline at end of file diff --git a/xsl/annotation.xsl b/xsl/annotation.xsl index 11d9f54..7d471a5 100644 --- a/xsl/annotation.xsl +++ b/xsl/annotation.xsl @@ -271,7 +271,16 @@ - + + + + + + + + + + @@ -291,7 +300,7 @@
- +
@@ -307,7 +316,16 @@ - + + + + + + + + + + @@ -327,7 +345,7 @@ - +