[Boost-commit] svn:boost r86364 - trunk/tools/quickbook/doc/boost-doc-tools

Subject: [Boost-commit] svn:boost r86364 - trunk/tools/quickbook/doc/boost-doc-tools
From: dnljms_at_[hidden]
Date: 2013-10-19 12:53:12

Author: danieljames
Date: 2013-10-19 12:53:12 EDT (Sat, 19 Oct 2013)
New Revision: 86364
URL: http://svn.boost.org/trac/boost/changeset/86364

Log:
List some docbook/boostbook parameters that might need documenting.

Text files modified: 
   trunk/tools/quickbook/doc/boost-doc-tools/parameters.qbk |   111 ++++++++++++++++++++++++++++++++++++++++
   1 files changed, 111 insertions(+), 0 deletions(-)

Modified: trunk/tools/quickbook/doc/boost-doc-tools/parameters.qbk
==============================================================================
--- trunk/tools/quickbook/doc/boost-doc-tools/parameters.qbk	Sat Oct 19 12:14:35 2013	(r86363)
+++ trunk/tools/quickbook/doc/boost-doc-tools/parameters.qbk	2013-10-19 12:53:12 EDT (Sat, 19 Oct 2013)	(r86364)
@@ -28,10 +28,36 @@
 the best source of information is the XSL source code at
 [@boost:tools/boostbook/xsl/ `tools/boostbook/xsl/`].
 
+[/TODO:
+    use.id.as.filename
+    boost.include.libraries
+    Look at fo.xsl
+    caramel
+    boost.section.class.add.id
+    boost.max.id.part.length
+    boost.syntax.highlight
+]
+
 [heading:toc Table of Contents settings]
 
 [/TODO: Quick description of docbook parameters?]
 
+[/ Variables used by Boost.Math:]
+[variablelist
+    [[chunk.section.depth]
+        [???]]
+    [[chunk.first.sections]
+        [???]]
+    [[toc.section.depth]
+        [???]]
+    [[toc.max.dpeth]
+        [???]]
+    [[generate.section.toc.level]
+        [???]]
+    [[index.on.type]
+        [???]]
+]
+
 BoostBook adds an extra parameter, `boost.noexpand.chapter.toc`, to the DocBook
 parameters for generating the table of contents for a book. This adjusts a
 book's table of contents so they don't show the contents of chapters,
@@ -41,6 +67,69 @@
 large books so that the top level table of contents aren't overwhelmed by
 the individual chapeter contents.
 
+[heading:link_locations Link Locations]
+
+[variablelist
+    [[boost.root]
+        [Path to root of boost (or module) from destination directory]]
+    [[boost.url.prefix]
+        [???]]
+    [[boost.header.root]
+        [???]]
+]
+
+[variablelist
+    [[img.src.path]
+        [(Docbook parameter) Path that image links are relative to, from the
+        destination directory]]
+    [[boost.graphics.root]
+        [???]]
+    [/ Not sure if it's worth mentioning these docbook parameters:
+    [[admon.graphics.path]
+        [???]]
+    [[navig.graphics.path]
+        [???]]
+    [[callout.graphics.path]
+        [???]]
+    ]
+]
+
+[heading:style Style Parameters]
+
+[variablelist
+    [[boost.defaults]
+        [???]]
+    [[html.stylesheet]
+        [??? (should it be under directory locations?)]]
+    [[admon.style]
+        [???]]
+    [[admon.graphics]
+        [???]]
+    [[navig.graphics]
+        [???]]
+    [[navig.graphics.extension]
+        [???]]
+]
+
+[heading:reference Reference Documentation Parameters]
+
+[variablelist
+    [[boostbook.verbose]
+        [???]]
+    [[boost.compact.function]
+        [???]]
+    [[boost.short.result.type]
+        [???]]
+    [[boost.compact.enum]
+        [???]]
+    [[boost.compact.typedef]
+        [???]]
+    [[max-columns]
+        [???]]
+    [[tempalte.param.brief]
+        [???]]
+]
+
 [heading:mathjax MathJax parameters]
 
 BoostBook has experimental support for MathJax, an open source JavaScript
@@ -48,3 +137,25 @@
 by setting the `boost.mathjax` parameter to 1, and the location can be set
 using `boost.mathjax.script`.
 
+[heading:navbar Navbar]
+
+[variablelist
+    [[nav.layout]
+        [???]]
+    [[nav.border]
+        [???]]
+    [[nav.flow]
+        [???]]
+    [[boost.website]
+        [???]]
+    [[boost.image.src]
+        [???]]
+    [[boost.image.alt]
+        [???]]
+    [[boost.image.w]
+        [???]]
+    [[boost.image.h]
+        [???]]
+    [[boost.libraries]
+        [???]]
+]