diff --git a/doc/Jamfile.v2 b/doc/Jamfile.v2 index 0e4911a..efd855d 100644 --- a/doc/Jamfile.v2 +++ b/doc/Jamfile.v2 @@ -7,5 +7,10 @@ project boost/doc ; import boostbook : boostbook ; -boostbook boostbook : boostbook.xml ; +boostbook boostbook : boostbook.xml : + html.stylesheet=../../../../doc/html/boostbook.css + boost.root=../../../.. + boost.libraries=../../../../libs/libraries.htm + navig.graphics=1 + ; diff --git a/doc/boostbook.xml b/doc/boostbook.xml index 2a521f3..6421d66 100644 --- a/doc/boostbook.xml +++ b/doc/boostbook.xml @@ -24,16 +24,10 @@ - Permission to copy, use, sell and distribute this software - is granted provided this copyright notice appears in all copies. - Permission to modify the code and to distribute modified code is - granted provided this copyright notice appears in all copies, - and a notice that the code was modified is included with the - copyright notice. - - This software is provided "as is" without express or - implied warranty, and with no claim as to its suitability for - any purpose. + 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). + diff --git a/doc/reference.dtdxml b/doc/reference.dtdxml index b013579..35267e8 100644 --- a/doc/reference.dtdxml +++ b/doc/reference.dtdxml @@ -7,8 +7,8 @@ system-id="boostbook.dtd" public-id="" declaration="" - created-by="DTDParse V2.0beta6" - created-on="Sat Mar 29 16:11:38 2003" + created-by="DTDParse V2.00" + created-on="Wed Feb 18 23:39:45 2009" > A global identifier for this element Set to $Date: 2003/04/13 14:46:07 $ to keep "last revised" information in sync with CVS changes @@ -23,7 +23,10 @@ type="param" > template?, inherit*, purpose?, description?, - (access|%boost.class.mix;)* + (static-constant|typedef|enum| + copy-assignment|constructor|destructor|method-group| + method|overloaded-method|data-member|class|class-specialization|struct| + struct-specialization|union|union-specialization|free-function-group|function|overloaded-function|access)* template?, inherit*, purpose?, description?, (access|%boost.class.mix;)* @@ -104,15 +107,18 @@ struct-specialization|union|union-specialization static-constant|typedef|enum| copy-assignment|constructor|destructor|method-group| - |method|overloaded-method|data-member|class|class-specialization|struct| + method|overloaded-method|data-member|class|class-specialization|struct| struct-specialization|union|union-specialization -free-function-group|function|overloaded-function|%boost.class.members; -free-function-group|function|overloaded-function|%boost.class.members; +static-constant|typedef|enum| + copy-assignment|constructor|destructor|method-group| + method|overloaded-method|data-member|class|class-specialization|struct| + struct-specialization|union|union-specialization|free-function-group|function|overloaded-function +%boost.class.members;|free-function-group|function|overloaded-function -|functionname|libraryname|code -|functionname|libraryname|code +|functionname|libraryname|enumname|headername|macroname|code +|functionname|libraryname|enumname|headername|macroname|code template?, specialization?, inherit?, purpose?, description?, - (access|%boost.class.mix;)* + (static-constant|typedef|enum| + copy-assignment|constructor|destructor|method-group| + method|overloaded-method|data-member|class|class-specialization|struct| + struct-specialization|union|union-specialization|free-function-group|function|overloaded-function|access)* template?, specialization?, inherit?, purpose?, description?, (access|%boost.class.mix;)* @@ -830,7 +839,7 @@ - access CDATA #REQUIRED + access CDATA #IMPLIED pack CDATA #IMPLIED %boost.common.attrib; The access specifier ("public", "private", or "protected") of the inheritance. @@ -1040,6 +1049,39 @@ default=""/> + + + + + + + + + + + +References a macro with the given name + + + + + alt CDATA #IMPLIED + %boost.common.attrib; + + + + + @@ -1339,6 +1381,39 @@ + + + + + + + + + + + +References a C++ header with the given name + + + + + alt CDATA #IMPLIED + %boost.common.attrib; + + + + + @@ -1404,11 +1479,17 @@ - %boost.common.attrib; + + alt CDATA #IMPLIED + %boost.common.attrib; + - name CDATA #REQUIRED + name CDATA #REQUIRED + specifiers CDATA #IMPLIED %boost.common.attrib; + + + + + + + + + + + + +References a global with the given name + + + + + alt CDATA #IMPLIED + %boost.common.attrib; + + + + + @@ -1902,6 +2021,10 @@ + + + + @@ -1912,6 +2035,10 @@ + + + + Describes in one short sentence or phrase the purpose of a library @@ -2167,12 +2294,14 @@ + + A function parameter @@ -2301,59 +2430,59 @@ default=""/> - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + Declares an access specification for class members The access specifications of class members (public, private, or protected) may be determined by enclosing them in an <access> element. - + - - - name CDATA #REQUIRED - %boost.common.attrib; - - - The name of the access specification, e.g. "public", "private", or "protected". - - - + + + name CDATA #REQUIRED + %boost.common.attrib; + + + The name of the access specification, e.g. "public", "private", or "protected". + + + @@ -2546,6 +2675,8 @@ + + A single value of an enumeration @@ -2890,6 +3021,39 @@ default=""/> + + + + + + + + + + + +References an enumeration type with the given name + + + + + alt CDATA #IMPLIED + %boost.common.attrib; + + + + + diff --git a/doc/reference.xml b/doc/reference.xml index 2fe9a85..730b68c 100644 --- a/doc/reference.xml +++ b/doc/reference.xml @@ -1,7 +1,7 @@ - +
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 + 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 enumname - References an enumeration type with the given nameElement 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 globalname - References a global with the given nameElement header - Declares a C++ header with the given nameElement headername - References 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 macroname - References a macro with the given nameElement 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 @@ -549,7 +549,7 @@ last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes -access#REQUIREDCDATAThe access specifier ("public", "private", or "protected") of the inheritance. +access#IMPLIEDCDATAThe access specifier ("public", "private", or "protected") of the inheritance. id#IMPLIEDCDATAA global identifier for this element pack#IMPLIEDCDATASet to '1' if this is a pack exapansion. xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -715,6 +715,41 @@ name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes + + + + + + + + + BoostBook element macroname + 9 + + + macroname + + + macroname ::= + (#PCDATA) + + + Attributes + + + + + Name + Type + Value + Purpose + + + + +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +alt#IMPLIEDCDATA +id#IMPLIEDCDATAA global identifier for this element @@ -981,6 +1016,41 @@ + + + + BoostBook element headername + 9 + + + headername + + + headername ::= + (#PCDATA) + + + Attributes + + + + + Name + Type + Value + Purpose + + + + +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +alt#IMPLIEDCDATA +id#IMPLIEDCDATAA global identifier for this element + + + + + @@ -1053,6 +1123,7 @@ last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +alt#IMPLIEDCDATA id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1159,6 +1230,7 @@ last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +specifiers#IMPLIEDCDATAThe specifiers for this function, e.g., inline, static, etc. name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes @@ -1304,6 +1376,41 @@ id#IMPLIEDCDATAA global identifier for this element pack#IMPLIEDCDATASet to '1' if this is a pack exapansion. xml:base#IMPLIEDCDATAImplementation detail used by XIncludes + + + + + + + + + BoostBook element globalname + 9 + + + globalname + + + globalname ::= + (#PCDATA) + + + Attributes + + + + + Name + Type + Value + Purpose + + + + +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +alt#IMPLIEDCDATA +id#IMPLIEDCDATAA global identifier for this element @@ -1538,7 +1645,7 @@ Describes in one short sentence or phrase the purpose of a library librarypurpose ::= - (#PCDATA| code| ulink| functionname| methodname| classname)* + (#PCDATA| code| ulink| functionname| methodname| classname| macroname| headername| enumname| globalname)* Attributes @@ -1792,7 +1899,7 @@ A function parameter parameter ::= - (paramtype, default?) + (paramtype, default?, description?) Attributes @@ -1913,8 +2020,8 @@ Declares an access specification for class members access ::= - (static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| method| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)+ - + (static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| method| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)+ + Description The access specifications of class members (public, private, or protected) may be determined by enclosing them in an <access> element. @@ -1931,11 +2038,11 @@ - - last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes - name#REQUIREDCDATAThe name of the access specification, e.g. "public", "private", or "protected". - id#IMPLIEDCDATAA global identifier for this element - + +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +name#REQUIREDCDATAThe name of the access specification, e.g. "public", "private", or "protected". +id#IMPLIEDCDATAA global identifier for this element + @@ -2422,6 +2529,41 @@ name#REQUIREDCDATAThe name of the element being declared to referenced id#IMPLIEDCDATAA global identifier for this element xml:base#IMPLIEDCDATAImplementation detail used by XIncludes + + + + + + + + + BoostBook element enumname + 9 + + + enumname + + + enumname ::= + (#PCDATA) + + + Attributes + + + + + Name + Type + Value + Purpose + + + + +last-revision#IMPLIEDCDATASet to $Date$ to keep "last revised" information in sync with CVS changes +alt#IMPLIEDCDATA +id#IMPLIEDCDATAA global identifier for this element @@ -2798,4 +2940,4 @@ - +
diff --git a/dtd/boostbook.dtd b/dtd/boostbook.dtd index 9805ec7..bd4c3f8 100644 --- a/dtd/boostbook.dtd +++ b/dtd/boostbook.dtd @@ -1,5 +1,5 @@ - + 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: ] ) 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 @@ - + diff --git a/xsl/fo.xsl b/xsl/fo.xsl index 5f12bb2..423b6d0 100644 --- a/xsl/fo.xsl +++ b/xsl/fo.xsl @@ -176,6 +176,8 @@ Put a box around admonishments and keep them together: 0.2cm 0.2cm 1 + 0pt + 0pt + + + + + + + 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

+
+ +
+ + + 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/')"/> + - + 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 -