mirror of
https://github.com/boostorg/boostbook.git
synced 2025-05-09 23:13:58 +00:00
Merge most of the recent changes to quickbook and boostbook.
Left out doxygen changes: [51323],[51324],[51680] And a quickbook change which might be a breaking change: [51403] Fixes #1977, #1170, #1213, #2701. Refs #2153, #2771. Merged revisions 51268-51269,51319-51321,51370-51372,51388-51389,51401-51402,51405-51406,51508,51647,51696 via svnmerge from https://svn.boost.org/svn/boost/trunk ........ r51268 | johnmaddock | 2009-02-16 10:39:18 +0000 (Mon, 16 Feb 2009) | 1 line Add default path for callouts. ........ r51269 | johnmaddock | 2009-02-16 10:40:26 +0000 (Mon, 16 Feb 2009) | 1 line Add preliminary HTMLHelp support. ........ r51319 | danieljames | 2009-02-18 21:22:37 +0000 (Wed, 18 Feb 2009) | 1 line Remove long out of date warning. ........ r51320 | danieljames | 2009-02-18 21:23:13 +0000 (Wed, 18 Feb 2009) | 1 line Write out the quickbook options when the file is missing. ........ r51321 | danieljames | 2009-02-18 21:23:35 +0000 (Wed, 18 Feb 2009) | 1 line Add default path for callouts to xhtml. ........ r51370 | danieljames | 2009-02-21 18:50:00 +0000 (Sat, 21 Feb 2009) | 4 lines Regenerate boostbook reference documentation and merge with existing documentation. Ref #2153 ........ r51371 | danieljames | 2009-02-21 18:50:14 +0000 (Sat, 21 Feb 2009) | 1 line Fix links in standalone boostbook documentation. ........ r51372 | danieljames | 2009-02-21 18:50:25 +0000 (Sat, 21 Feb 2009) | 3 lines Change license in boostbook docs to boost license. Douglas Gregor is listed in the blanket permissions file. ........ r51388 | danieljames | 2009-02-22 11:54:01 +0000 (Sun, 22 Feb 2009) | 1 line This DTD isn't stable, so I'm calling it a 'development' version. Which is probably wrong, but there you go. ........ r51389 | danieljames | 2009-02-22 11:54:18 +0000 (Sun, 22 Feb 2009) | 2 lines Support the alt tag in headername and macroname. Also make headername and macroname valid. Refs #1977 ........ r51401 | danieljames | 2009-02-22 23:47:51 +0000 (Sun, 22 Feb 2009) | 8 lines Add a purpose for macroname, headername, enumname, globalname. Ref #2153: There's still no documentation for methodname and classname. These are actually defined in the docbook DTD for a different purpose so I'm not sure how to deal with them. http://www.docbook.org/tdg/en/html/methodname.html http://www.docbook.org/tdg/en/html/classname.html ........ r51402 | danieljames | 2009-02-22 23:48:37 +0000 (Sun, 22 Feb 2009) | 7 lines Generate slightly more valid boostbook. For document types other than library: * Don't generate name or dirname for document types. * Put title before document info. Ref #2771 ........ r51405 | danieljames | 2009-02-22 23:49:21 +0000 (Sun, 22 Feb 2009) | 3 lines Print out unexpected characters as errors. Ref #1170 ........ r51406 | danieljames | 2009-02-22 23:49:36 +0000 (Sun, 22 Feb 2009) | 1 line Better handling of errors without line numbers. ........ r51508 | danieljames | 2009-03-01 14:16:44 +0000 (Sun, 01 Mar 2009) | 3 lines Try to make anchor and link usage a little clearer. Refs #1213, #2701 ........ r51647 | danieljames | 2009-03-08 09:45:51 +0000 (Sun, 08 Mar 2009) | 1 line Display text purposes in function reference. ........ r51696 | johnmaddock | 2009-03-11 10:22:42 +0000 (Wed, 11 Mar 2009) | 1 line Set margins to 0pt so they line up with surrounding text rather than appearing outside it - prevents margins from overlapping other content. ........ [SVN r51774]
This commit is contained in:
Daniel James
commit
6425f26f09
@ -7,5 +7,10 @@
|
||||
project boost/doc ;
|
||||
import boostbook : boostbook ;
|
||||
|
||||
boostbook boostbook : boostbook.xml ;
|
||||
boostbook boostbook : boostbook.xml :
|
||||
<xsl:param>html.stylesheet=../../../../doc/html/boostbook.css
|
||||
<xsl:param>boost.root=../../../..
|
||||
<xsl:param>boost.libraries=../../../../libs/libraries.htm
|
||||
<xsl:param>navig.graphics=1
|
||||
;
|
||||
|
||||
|
||||
@ -24,16 +24,10 @@
|
||||
</copyright>
|
||||
|
||||
<legalnotice>
|
||||
<para>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. </para>
|
||||
|
||||
<para> This software is provided "as is" without express or
|
||||
implied warranty, and with no claim as to its suitability for
|
||||
any purpose. </para>
|
||||
<para>Distributed under the Boost Software License, Version 1.0.
|
||||
(See accompanying file LICENSE_1_0.txt or copy at
|
||||
<ulink url="http://www.boost.org/LICENSE_1_0.txt">http://www.boost.org/LICENSE_1_0.txt</ulink>).
|
||||
</para>
|
||||
</legalnotice>
|
||||
</partinfo>
|
||||
|
||||
|
||||
@ -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"
|
||||
>
|
||||
<attpurpose name="id">A global identifier for this element</attpurpose>
|
||||
<attpurpose name="last-revision">Set to $Date: 2003/04/13 14:46:07 $ to keep "last revised" information in sync with CVS changes</attpurpose>
|
||||
@ -23,7 +23,10 @@
|
||||
type="param"
|
||||
>
|
||||
<text-expanded>template?, inherit*, purpose?, description?,
|
||||
(access|%boost.class.mix;)*</text-expanded>
|
||||
(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)*</text-expanded>
|
||||
<text>template?, inherit*, purpose?, description?,
|
||||
(access|%boost.class.mix;)*</text>
|
||||
</entity>
|
||||
@ -104,15 +107,18 @@
|
||||
struct-specialization|union|union-specialization</text-expanded>
|
||||
<text>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</text>
|
||||
</entity>
|
||||
|
||||
<entity name="boost.class.mix"
|
||||
type="param"
|
||||
>
|
||||
<text-expanded>free-function-group|function|overloaded-function|%boost.class.members;</text-expanded>
|
||||
<text>free-function-group|function|overloaded-function|%boost.class.members;</text>
|
||||
<text-expanded>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</text-expanded>
|
||||
<text>%boost.class.members;|free-function-group|function|overloaded-function</text>
|
||||
</entity>
|
||||
|
||||
<entity name="boost.testsuite.tests"
|
||||
@ -154,8 +160,8 @@
|
||||
<entity name="local.tech.char.class"
|
||||
type="param"
|
||||
>
|
||||
<text-expanded>|functionname|libraryname|code</text-expanded>
|
||||
<text>|functionname|libraryname|code</text>
|
||||
<text-expanded>|functionname|libraryname|enumname|headername|macroname|code</text-expanded>
|
||||
<text>|functionname|libraryname|enumname|headername|macroname|code</text>
|
||||
</entity>
|
||||
|
||||
<entity name="function.module"
|
||||
@ -199,7 +205,10 @@
|
||||
type="param"
|
||||
>
|
||||
<text-expanded>template?, specialization?, inherit?, purpose?, description?,
|
||||
(access|%boost.class.mix;)*</text-expanded>
|
||||
(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)*</text-expanded>
|
||||
<text>template?, specialization?, inherit?, purpose?, description?,
|
||||
(access|%boost.class.mix;)*</text>
|
||||
</entity>
|
||||
@ -830,7 +839,7 @@
|
||||
|
||||
<attlist name="inherit">
|
||||
<attdecl>
|
||||
access CDATA #REQUIRED
|
||||
access CDATA #IMPLIED
|
||||
pack CDATA #IMPLIED
|
||||
%boost.common.attrib;</attdecl>
|
||||
<attribute name="last-revision"
|
||||
@ -838,7 +847,7 @@
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="access"
|
||||
type="#REQUIRED"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default="">
|
||||
<purpose>The access specifier ("public", "private", or "protected") of the inheritance.</purpose>
|
||||
@ -1040,6 +1049,39 @@
|
||||
default=""/>
|
||||
</attlist>
|
||||
|
||||
<element name="macroname"
|
||||
content-type="mixed">
|
||||
<content-model-expanded>
|
||||
<sequence-group>
|
||||
<pcdata/>
|
||||
</sequence-group>
|
||||
</content-model-expanded>
|
||||
<content-model>
|
||||
<sequence-group>
|
||||
<pcdata/>
|
||||
</sequence-group>
|
||||
</content-model>
|
||||
<purpose>References a macro with the given name</purpose>
|
||||
</element>
|
||||
|
||||
<attlist name="macroname">
|
||||
<attdecl>
|
||||
alt CDATA #IMPLIED
|
||||
%boost.common.attrib;</attdecl>
|
||||
<attribute name="last-revision"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="alt"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="id"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
</attlist>
|
||||
|
||||
<element name="postconditions"
|
||||
content-type="element">
|
||||
<content-model-expanded>
|
||||
@ -1339,6 +1381,39 @@
|
||||
</description>
|
||||
</element>
|
||||
|
||||
<element name="headername"
|
||||
content-type="mixed">
|
||||
<content-model-expanded>
|
||||
<sequence-group>
|
||||
<pcdata/>
|
||||
</sequence-group>
|
||||
</content-model-expanded>
|
||||
<content-model>
|
||||
<sequence-group>
|
||||
<pcdata/>
|
||||
</sequence-group>
|
||||
</content-model>
|
||||
<purpose>References a C++ header with the given name</purpose>
|
||||
</element>
|
||||
|
||||
<attlist name="headername">
|
||||
<attdecl>
|
||||
alt CDATA #IMPLIED
|
||||
%boost.common.attrib;</attdecl>
|
||||
<attribute name="last-revision"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="alt"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="id"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
</attlist>
|
||||
|
||||
<element name="free-function-group"
|
||||
content-type="element">
|
||||
<content-model-expanded>
|
||||
@ -1404,11 +1479,17 @@
|
||||
</element>
|
||||
|
||||
<attlist name="functionname">
|
||||
<attdecl> %boost.common.attrib;</attdecl>
|
||||
<attdecl>
|
||||
alt CDATA #IMPLIED
|
||||
%boost.common.attrib;</attdecl>
|
||||
<attribute name="last-revision"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="alt"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="id"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
@ -1508,12 +1589,17 @@
|
||||
|
||||
<attlist name="data-member">
|
||||
<attdecl>
|
||||
name CDATA #REQUIRED
|
||||
name CDATA #REQUIRED
|
||||
specifiers CDATA #IMPLIED
|
||||
%boost.common.attrib;</attdecl>
|
||||
<attribute name="last-revision"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="specifiers"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="name"
|
||||
type="#REQUIRED"
|
||||
value="CDATA"
|
||||
@ -1692,6 +1778,39 @@
|
||||
default=""/>
|
||||
</attlist>
|
||||
|
||||
<element name="globalname"
|
||||
content-type="mixed">
|
||||
<content-model-expanded>
|
||||
<sequence-group>
|
||||
<pcdata/>
|
||||
</sequence-group>
|
||||
</content-model-expanded>
|
||||
<content-model>
|
||||
<sequence-group>
|
||||
<pcdata/>
|
||||
</sequence-group>
|
||||
</content-model>
|
||||
<purpose>References a global with the given name</purpose>
|
||||
</element>
|
||||
|
||||
<attlist name="globalname">
|
||||
<attdecl>
|
||||
alt CDATA #IMPLIED
|
||||
%boost.common.attrib;</attdecl>
|
||||
<attribute name="last-revision"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="alt"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="id"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
</attlist>
|
||||
|
||||
<element name="method-group"
|
||||
content-type="element">
|
||||
<content-model-expanded>
|
||||
@ -1902,6 +2021,10 @@
|
||||
<element-name name="functionname"/>
|
||||
<element-name name="methodname"/>
|
||||
<element-name name="classname"/>
|
||||
<element-name name="macroname"/>
|
||||
<element-name name="headername"/>
|
||||
<element-name name="enumname"/>
|
||||
<element-name name="globalname"/>
|
||||
</or-group>
|
||||
</content-model-expanded>
|
||||
<content-model>
|
||||
@ -1912,6 +2035,10 @@
|
||||
<element-name name="functionname"/>
|
||||
<element-name name="methodname"/>
|
||||
<element-name name="classname"/>
|
||||
<element-name name="macroname"/>
|
||||
<element-name name="headername"/>
|
||||
<element-name name="enumname"/>
|
||||
<element-name name="globalname"/>
|
||||
</or-group>
|
||||
</content-model>
|
||||
<purpose>Describes in one short sentence or phrase the purpose of a library</purpose>
|
||||
@ -2167,12 +2294,14 @@
|
||||
<sequence-group>
|
||||
<element-name name="paramtype"/>
|
||||
<element-name name="default" occurrence="?"/>
|
||||
<element-name name="description" occurrence="?"/>
|
||||
</sequence-group>
|
||||
</content-model-expanded>
|
||||
<content-model>
|
||||
<sequence-group>
|
||||
<element-name name="paramtype"/>
|
||||
<element-name name="default" occurrence="?"/>
|
||||
<element-name name="description" occurrence="?"/>
|
||||
</sequence-group>
|
||||
</content-model>
|
||||
<purpose>A function parameter</purpose>
|
||||
@ -2301,59 +2430,59 @@
|
||||
default=""/>
|
||||
</attlist>
|
||||
|
||||
<element name="access"
|
||||
content-type="element">
|
||||
<content-model-expanded>
|
||||
<or-group occurrence="+">
|
||||
<element-name name="static-constant"/>
|
||||
<element-name name="typedef"/>
|
||||
<element-name name="enum"/>
|
||||
<element-name name="copy-assignment"/>
|
||||
<element-name name="constructor"/>
|
||||
<element-name name="destructor"/>
|
||||
<element-name name="method-group"/>
|
||||
<element-name name="method"/>
|
||||
<element-name name="overloaded-method"/>
|
||||
<element-name name="data-member"/>
|
||||
<element-name name="class"/>
|
||||
<element-name name="class-specialization"/>
|
||||
<element-name name="struct"/>
|
||||
<element-name name="struct-specialization"/>
|
||||
<element-name name="union"/>
|
||||
<element-name name="union-specialization"/>
|
||||
</or-group>
|
||||
</content-model-expanded>
|
||||
<content-model>
|
||||
<sequence-group occurrence="+">
|
||||
<parament-name name="boost.class.members"/>
|
||||
</sequence-group>
|
||||
</content-model>
|
||||
<element name="access"
|
||||
content-type="element">
|
||||
<content-model-expanded>
|
||||
<or-group occurrence="+">
|
||||
<element-name name="static-constant"/>
|
||||
<element-name name="typedef"/>
|
||||
<element-name name="enum"/>
|
||||
<element-name name="copy-assignment"/>
|
||||
<element-name name="constructor"/>
|
||||
<element-name name="destructor"/>
|
||||
<element-name name="method-group"/>
|
||||
<element-name name="method"/>
|
||||
<element-name name="overloaded-method"/>
|
||||
<element-name name="data-member"/>
|
||||
<element-name name="class"/>
|
||||
<element-name name="class-specialization"/>
|
||||
<element-name name="struct"/>
|
||||
<element-name name="struct-specialization"/>
|
||||
<element-name name="union"/>
|
||||
<element-name name="union-specialization"/>
|
||||
</or-group>
|
||||
</content-model-expanded>
|
||||
<content-model>
|
||||
<sequence-group occurrence="+">
|
||||
<parament-name name="boost.class.members"/>
|
||||
</sequence-group>
|
||||
</content-model>
|
||||
<purpose>Declares an access specification for class members</purpose>
|
||||
|
||||
<description>
|
||||
<para>The access specifications of class members (public, private, or protected) may be determined by enclosing them in an <access> element.</para>
|
||||
</description>
|
||||
</element>
|
||||
</element>
|
||||
|
||||
<attlist name="access">
|
||||
<attdecl>
|
||||
name CDATA #REQUIRED
|
||||
%boost.common.attrib;</attdecl>
|
||||
<attribute name="last-revision"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="name"
|
||||
type="#REQUIRED"
|
||||
value="CDATA"
|
||||
default="">
|
||||
<purpose>The name of the access specification, e.g. "public", "private", or "protected".</purpose>
|
||||
</attribute>
|
||||
<attribute name="id"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
</attlist>
|
||||
<attlist name="access">
|
||||
<attdecl>
|
||||
name CDATA #REQUIRED
|
||||
%boost.common.attrib;</attdecl>
|
||||
<attribute name="last-revision"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="name"
|
||||
type="#REQUIRED"
|
||||
value="CDATA"
|
||||
default="">
|
||||
<purpose>The name of the access specification, e.g. "public", "private", or "protected".</purpose>
|
||||
</attribute>
|
||||
<attribute name="id"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
</attlist>
|
||||
|
||||
<element name="class"
|
||||
content-type="element">
|
||||
@ -2546,6 +2675,8 @@
|
||||
<content-model>
|
||||
<sequence-group>
|
||||
<element-name name="default" occurrence="?"/>
|
||||
<element-name name="purpose" occurrence="?"/>
|
||||
<element-name name="description" occurrence="?"/>
|
||||
</sequence-group>
|
||||
</content-model>
|
||||
<purpose>A single value of an enumeration</purpose>
|
||||
@ -2890,6 +3021,39 @@
|
||||
default=""/>
|
||||
</attlist>
|
||||
|
||||
<element name="enumname"
|
||||
content-type="mixed">
|
||||
<content-model-expanded>
|
||||
<sequence-group>
|
||||
<pcdata/>
|
||||
</sequence-group>
|
||||
</content-model-expanded>
|
||||
<content-model>
|
||||
<sequence-group>
|
||||
<pcdata/>
|
||||
</sequence-group>
|
||||
</content-model>
|
||||
<purpose>References an enumeration type with the given name</purpose>
|
||||
</element>
|
||||
|
||||
<attlist name="enumname">
|
||||
<attdecl>
|
||||
alt CDATA #IMPLIED
|
||||
%boost.common.attrib;</attdecl>
|
||||
<attribute name="last-revision"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="alt"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
<attribute name="id"
|
||||
type="#IMPLIED"
|
||||
value="CDATA"
|
||||
default=""/>
|
||||
</attlist>
|
||||
|
||||
<element name="struct-specialization"
|
||||
content-type="element">
|
||||
<content-model-expanded>
|
||||
|
||||
File diff suppressed because one or more lines are too long
@ -1,5 +1,5 @@
|
||||
<!--
|
||||
BoostBook DTD version 1.1
|
||||
BoostBook DTD - development version
|
||||
|
||||
For further information, see: http://www.crystalclearsoftware.com/cgi-bin/boost_wiki/wiki.pl?Boost_Documentation_Format
|
||||
|
||||
@ -11,7 +11,7 @@
|
||||
(See accompanying file LICENSE_1_0.txt or copy at
|
||||
http://www.boost.org/LICENSE_1_0.txt)
|
||||
|
||||
This DTD module is identified by the PUBLIC and SYSTEM identifiers:
|
||||
The latest stable DTD module is identified by the PUBLIC and SYSTEM identifiers:
|
||||
|
||||
PUBLIC "-//Boost//DTD BoostBook XML V1.1//EN"
|
||||
SYSTEM "http://www.boost.org/tools/boostbook/dtd/1.1/boostbook.dtd"
|
||||
@ -313,10 +313,14 @@
|
||||
%boost.common.attrib;>
|
||||
|
||||
<!ELEMENT macroname (#PCDATA)>
|
||||
<!ATTLIST macroname %boost.common.attrib;>
|
||||
<!ATTLIST macroname
|
||||
alt CDATA #IMPLIED
|
||||
%boost.common.attrib;>
|
||||
|
||||
<!ELEMENT headername (#PCDATA)>
|
||||
<!ATTLIST headername %boost.common.attrib;>
|
||||
<!ATTLIST headername
|
||||
alt CDATA #IMPLIED
|
||||
%boost.common.attrib;>
|
||||
|
||||
<!ELEMENT globalname (#PCDATA)>
|
||||
<!ATTLIST globalname
|
||||
@ -415,7 +419,7 @@
|
||||
name CDATA #IMPLIED>
|
||||
|
||||
<!--========== Customize the DocBook DTD ==========-->
|
||||
<!ENTITY % local.tech.char.class "|functionname|libraryname|enumname|code">
|
||||
<!ENTITY % local.tech.char.class "|functionname|libraryname|enumname|headername|macroname|code">
|
||||
<!ENTITY % local.para.class
|
||||
"|using-namespace|using-class|librarylist|librarycategorylist">
|
||||
<!ENTITY % local.descobj.class "|libraryinfo">
|
||||
|
||||
@ -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: ] )
|
||||
|
||||
16
test/Jamfile.v2
Normal file
16
test/Jamfile.v2
Normal file
@ -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 :
|
||||
<xsl:param>html.stylesheet=../../../../doc/html/boostbook.css
|
||||
<xsl:param>boost.root=../../../..
|
||||
<xsl:param>boost.libraries=../../../../libs/libraries.htm
|
||||
<xsl:param>navig.graphics=1
|
||||
;
|
||||
|
||||
40
test/alt.xml
Normal file
40
test/alt.xml
Normal file
@ -0,0 +1,40 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE library PUBLIC "-//Boost//DTD BoostBook XML//EN"
|
||||
"http://www.boost.org/tools/boostbook/dtd/boostbook.dtd">
|
||||
|
||||
<!--
|
||||
xmllint:
|
||||
|
||||
XML_CATALOG_FILES=../../../bin.v2/boostbook_catalog.xml xmllint -noout -valid alt.xml
|
||||
|
||||
-->
|
||||
|
||||
<library name="Example" id="test.alt" dirname="test/alt">
|
||||
<libraryinfo>
|
||||
<author>
|
||||
<firstname>Daniel</firstname>
|
||||
<surname>James</surname>
|
||||
</author>
|
||||
<librarypurpose>Fictional example</librarypurpose>
|
||||
</libraryinfo>
|
||||
|
||||
<title>Fictional example library, for testing</title>
|
||||
|
||||
<section id="test.alt.tests">
|
||||
<title>Alt Tests</title>
|
||||
|
||||
<para><headername alt="example.hpp">Example header</headername></para>
|
||||
<para>Example header: <headername>example.hpp</headername></para>
|
||||
|
||||
<para><macroname alt="EXAMPLE">Example macro</macroname></para>
|
||||
<para>Example macro: <macroname>EXAMPLE</macroname></para>
|
||||
</section>
|
||||
|
||||
<library-reference>
|
||||
<header name="example.hpp">
|
||||
<macro name="EXAMPLE" kind="functionlike">
|
||||
<purpose>Example macro</purpose>
|
||||
</macro>
|
||||
</header>
|
||||
</library-reference>
|
||||
</library>
|
||||
@ -271,7 +271,16 @@
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="macroname" mode="annotation">
|
||||
<xsl:param name="name" select="text()"/>
|
||||
<xsl:param name="name">
|
||||
<xsl:choose>
|
||||
<xsl:when test="@alt">
|
||||
<xsl:value-of select="@alt"/>
|
||||
</xsl:when>
|
||||
<xsl:otherwise>
|
||||
<xsl:value-of select="string(.)"/>
|
||||
</xsl:otherwise>
|
||||
</xsl:choose>
|
||||
</xsl:param>
|
||||
|
||||
<xsl:variable name="node" select="key('macros', $name)"/>
|
||||
<xsl:choose>
|
||||
@ -291,7 +300,7 @@
|
||||
<xsl:with-param name="node" select="$node"/>
|
||||
</xsl:call-template>
|
||||
</xsl:with-param>
|
||||
<xsl:with-param name="text" select="$name"/>
|
||||
<xsl:with-param name="text" select="string(.)"/>
|
||||
</xsl:call-template>
|
||||
</xsl:when>
|
||||
|
||||
@ -307,7 +316,16 @@
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="headername" mode="annotation">
|
||||
<xsl:param name="name" select="text()"/>
|
||||
<xsl:variable name="name">
|
||||
<xsl:choose>
|
||||
<xsl:when test="@alt">
|
||||
<xsl:value-of select="@alt"/>
|
||||
</xsl:when>
|
||||
<xsl:otherwise>
|
||||
<xsl:value-of select="string(.)"/>
|
||||
</xsl:otherwise>
|
||||
</xsl:choose>
|
||||
</xsl:variable>
|
||||
|
||||
<xsl:variable name="node" select="key('headers', $name)"/>
|
||||
<xsl:choose>
|
||||
@ -327,7 +345,7 @@
|
||||
<xsl:with-param name="node" select="$node"/>
|
||||
</xsl:call-template>
|
||||
</xsl:with-param>
|
||||
<xsl:with-param name="text" select="$name"/>
|
||||
<xsl:with-param name="text" select="string(.)"/>
|
||||
</xsl:call-template>
|
||||
</xsl:when>
|
||||
|
||||
|
||||
@ -176,6 +176,8 @@ Put a box around admonishments and keep them together:
|
||||
<xsl:attribute name="padding-top">0.2cm</xsl:attribute>
|
||||
<xsl:attribute name="padding-bottom">0.2cm</xsl:attribute>
|
||||
<xsl:attribute name="keep-together.within-page">1</xsl:attribute>
|
||||
<xsl:attribute name="margin-left">0pt</xsl:attribute>
|
||||
<xsl:attribute name="margin-right">0pt</xsl:attribute>
|
||||
</xsl:attribute-set>
|
||||
|
||||
<!--
|
||||
@ -200,6 +202,8 @@ symbol is used as the hyphenation character:
|
||||
<xsl:attribute name="hyphenate">true</xsl:attribute>
|
||||
<xsl:attribute name="wrap-option">wrap</xsl:attribute>
|
||||
<xsl:attribute name="hyphenation-character">↵</xsl:attribute>
|
||||
<xsl:attribute name="margin-left">0pt</xsl:attribute>
|
||||
<xsl:attribute name="margin-right">0pt</xsl:attribute>
|
||||
</xsl:attribute-set>
|
||||
|
||||
<xsl:param name="hyphenate.verbatim" select="1"></xsl:param>
|
||||
|
||||
@ -746,7 +746,7 @@
|
||||
<xsl:param name="namespace-reference" select="false()"/>
|
||||
|
||||
<xsl:if test="$namespace-reference=false()">
|
||||
<xsl:apply-templates select="purpose/*"/>
|
||||
<xsl:apply-templates select="purpose/*|purpose/text()"/>
|
||||
</xsl:if>
|
||||
|
||||
<xsl:apply-templates select="description/*"/>
|
||||
|
||||
147
xsl/html-help.xsl
Normal file
147
xsl/html-help.xsl
Normal file
@ -0,0 +1,147 @@
|
||||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!--
|
||||
Copyright (c) 2002 Douglas Gregor <doug.gregor -at- gmail.com>
|
||||
|
||||
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)
|
||||
-->
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
|
||||
xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision"
|
||||
version="1.0">
|
||||
|
||||
<!-- Import the HTML chunking stylesheet -->
|
||||
<xsl:import
|
||||
href="http://docbook.sourceforge.net/release/xsl/current/htmlhelp/htmlhelp.xsl"/>
|
||||
|
||||
<xsl:param name="admon.style"/>
|
||||
<xsl:param name="admon.graphics">1</xsl:param>
|
||||
<xsl:param name="boostbook.verbose" select="0"/>
|
||||
<xsl:param name="html.stylesheet" select="'boostbook.css'"/>
|
||||
<xsl:param name="chapter.autolabel" select="1"/>
|
||||
<xsl:param name="use.id.as.filename" select="1"/>
|
||||
<xsl:param name="refentry.generate.name" select="0"/>
|
||||
<xsl:param name="refentry.generate.title" select="1"/>
|
||||
<xsl:param name="make.year.ranges" select="1"/>
|
||||
<xsl:param name="generate.manifest" select="1"/>
|
||||
<xsl:param name="callout.graphics.number.limit">15</xsl:param>
|
||||
<xsl:param name="draft.mode">no</xsl:param>
|
||||
<xsl:param name="admon.graphics" select="1"/>
|
||||
|
||||
<xsl:template name="format.cvs.revision">
|
||||
<xsl:param name="text"/>
|
||||
|
||||
<!-- Remove the "$Date: " -->
|
||||
<xsl:variable name="text.noprefix"
|
||||
select="substring-after($text, '$Date: ')"/>
|
||||
|
||||
<!-- Grab the year -->
|
||||
<xsl:variable name="year" select="substring-before($text.noprefix, '/')"/>
|
||||
<xsl:variable name="text.noyear"
|
||||
select="substring-after($text.noprefix, '/')"/>
|
||||
|
||||
<!-- Grab the month -->
|
||||
<xsl:variable name="month" select="substring-before($text.noyear, '/')"/>
|
||||
<xsl:variable name="text.nomonth"
|
||||
select="substring-after($text.noyear, '/')"/>
|
||||
|
||||
<!-- Grab the year -->
|
||||
<xsl:variable name="day" select="substring-before($text.nomonth, ' ')"/>
|
||||
<xsl:variable name="text.noday"
|
||||
select="substring-after($text.nomonth, ' ')"/>
|
||||
|
||||
<!-- Get the time -->
|
||||
<xsl:variable name="time" select="substring-before($text.noday, ' ')"/>
|
||||
|
||||
<xsl:variable name="month.name">
|
||||
<xsl:choose>
|
||||
<xsl:when test="$month=1">January</xsl:when>
|
||||
<xsl:when test="$month=2">February</xsl:when>
|
||||
<xsl:when test="$month=3">March</xsl:when>
|
||||
<xsl:when test="$month=4">April</xsl:when>
|
||||
<xsl:when test="$month=5">May</xsl:when>
|
||||
<xsl:when test="$month=6">June</xsl:when>
|
||||
<xsl:when test="$month=7">July</xsl:when>
|
||||
<xsl:when test="$month=8">August</xsl:when>
|
||||
<xsl:when test="$month=9">September</xsl:when>
|
||||
<xsl:when test="$month=10">October</xsl:when>
|
||||
<xsl:when test="$month=11">November</xsl:when>
|
||||
<xsl:when test="$month=12">December</xsl:when>
|
||||
</xsl:choose>
|
||||
</xsl:variable>
|
||||
|
||||
<xsl:value-of select="concat($month.name, ' ', $day, ', ', $year, ' at ',
|
||||
$time, ' GMT')"/>
|
||||
</xsl:template>
|
||||
|
||||
|
||||
<xsl:template name="format.svn.revision">
|
||||
<xsl:param name="text"/>
|
||||
|
||||
<!-- Remove the "$Date: " -->
|
||||
<xsl:variable name="text.noprefix"
|
||||
select="substring-after($text, '$Date: ')"/>
|
||||
|
||||
<!-- Grab the year -->
|
||||
<xsl:variable name="year" select="substring-before($text.noprefix, '-')"/>
|
||||
<xsl:variable name="text.noyear"
|
||||
select="substring-after($text.noprefix, '-')"/>
|
||||
|
||||
<!-- Grab the month -->
|
||||
<xsl:variable name="month" select="substring-before($text.noyear, '-')"/>
|
||||
<xsl:variable name="text.nomonth"
|
||||
select="substring-after($text.noyear, '-')"/>
|
||||
|
||||
<!-- Grab the year -->
|
||||
<xsl:variable name="day" select="substring-before($text.nomonth, ' ')"/>
|
||||
<xsl:variable name="text.noday"
|
||||
select="substring-after($text.nomonth, ' ')"/>
|
||||
|
||||
<!-- Get the time -->
|
||||
<xsl:variable name="time" select="substring-before($text.noday, ' ')"/>
|
||||
<xsl:variable name="text.notime"
|
||||
select="substring-after($text.noday, ' ')"/>
|
||||
|
||||
<!-- Get the timezone -->
|
||||
<xsl:variable name="timezone" select="substring-before($text.notime, ' ')"/>
|
||||
|
||||
<xsl:variable name="month.name">
|
||||
<xsl:choose>
|
||||
<xsl:when test="$month=1">January</xsl:when>
|
||||
<xsl:when test="$month=2">February</xsl:when>
|
||||
<xsl:when test="$month=3">March</xsl:when>
|
||||
<xsl:when test="$month=4">April</xsl:when>
|
||||
<xsl:when test="$month=5">May</xsl:when>
|
||||
<xsl:when test="$month=6">June</xsl:when>
|
||||
<xsl:when test="$month=7">July</xsl:when>
|
||||
<xsl:when test="$month=8">August</xsl:when>
|
||||
<xsl:when test="$month=9">September</xsl:when>
|
||||
<xsl:when test="$month=10">October</xsl:when>
|
||||
<xsl:when test="$month=11">November</xsl:when>
|
||||
<xsl:when test="$month=12">December</xsl:when>
|
||||
</xsl:choose>
|
||||
</xsl:variable>
|
||||
|
||||
<xsl:value-of select="concat($month.name, ' ', $day, ', ', $year, ' at ',
|
||||
$time, ' ', $timezone)"/>
|
||||
</xsl:template>
|
||||
|
||||
<!-- We don't want refentry's to show up in the TOC because they
|
||||
will merely be redundant with the synopsis. -->
|
||||
<xsl:template match="refentry" mode="toc"/>
|
||||
|
||||
<!-- override the behaviour of some DocBook elements for better
|
||||
rendering facilities -->
|
||||
|
||||
<xsl:template match = "programlisting[ancestor::informaltable]">
|
||||
<pre class = "table-{name(.)}"><xsl:apply-templates/></pre>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match = "refsynopsisdiv">
|
||||
<h2 class = "{name(.)}-title">Synopsis</h2>
|
||||
<div class = "{name(.)}">
|
||||
<xsl:apply-templates/>
|
||||
</div>
|
||||
</xsl:template>
|
||||
|
||||
</xsl:stylesheet>
|
||||
@ -46,9 +46,11 @@
|
||||
select = "concat($boost.root, '/doc/html/images/')"/>
|
||||
<xsl:param name = "navig.graphics.path"
|
||||
select = "concat($boost.root, '/doc/html/images/')"/>
|
||||
<xsl:param name = "callout.graphics.path"
|
||||
select = "concat($boost.root, '/doc/src/images/callouts/')"/>
|
||||
|
||||
|
||||
<xsl:param name="admon.style">
|
||||
<xsl:param name="admon.style">
|
||||
<!-- Remove the style. Let the CSS do the styling -->
|
||||
</xsl:param>
|
||||
|
||||
|
||||
@ -46,9 +46,11 @@
|
||||
select = "concat($boost.root, '/doc/xhtml/images/')"/>
|
||||
<xsl:param name = "navig.graphics.path"
|
||||
select = "concat($boost.root, '/doc/xhtml/images/')"/>
|
||||
<xsl:param name = "callout.graphics.path"
|
||||
select = "concat($boost.root, '/doc/src/images/callouts/')"/>
|
||||
|
||||
|
||||
<xsl:param name="admon.style">
|
||||
<xsl:param name="admon.style">
|
||||
<!-- Remove the style. Let the CSS do the styling -->
|
||||
</xsl:param>
|
||||
|
||||
@ -75,6 +77,7 @@ section toc
|
||||
set toc,title
|
||||
</xsl:param>
|
||||
|
||||
|
||||
<xsl:template name="format.cvs.revision">
|
||||
<xsl:param name="text"/>
|
||||
|
||||
@ -307,4 +310,3 @@ set toc,title
|
||||
</xsl:template>
|
||||
|
||||
</xsl:stylesheet>
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user