Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r86738 - in branches/release: . tools tools/quickbook tools/quickbook/doc tools/quickbook/src
From: dnljms_at_[hidden]
Date: 2013-11-17 06:04:36


Author: danieljames
Date: 2013-11-17 06:04:36 EST (Sun, 17 Nov 2013)
New Revision: 86738
URL: http://svn.boost.org/trac/boost/changeset/86738

Log:
Merge documentation and version changes.

Which really should have been merged before the release.

Properties modified:
   branches/release/ (props changed)
   branches/release/tools/ (props changed)
   branches/release/tools/quickbook/ (props changed)
Text files modified:
   branches/release/tools/quickbook/doc/change_log.qbk | 2 +-
   branches/release/tools/quickbook/doc/phrase.qbk | 40 +++++++++++++++++++++++++---------------
   branches/release/tools/quickbook/src/quickbook.cpp | 2 +-
   3 files changed, 27 insertions(+), 17 deletions(-)

Modified: branches/release/tools/quickbook/doc/change_log.qbk
==============================================================================
--- branches/release/tools/quickbook/doc/change_log.qbk Sun Nov 17 05:50:09 2013 (r86737)
+++ branches/release/tools/quickbook/doc/change_log.qbk 2013-11-17 06:04:36 EST (Sun, 17 Nov 2013) (r86738)
@@ -297,7 +297,7 @@
   * Clean up the source map implementation (used to get the correct
     location for error messages in things like templates and snippets).
 
-[heading Version 1.6.0 beta 1 - Boost 1.55 beta]
+[heading Version 1.6.0 - Boost 1.55]
 
 * Remove nested blocks in lists from 1.6, move to 1.7.
   (Can still nest block elements in lists though).

Modified: branches/release/tools/quickbook/doc/phrase.qbk
==============================================================================
--- branches/release/tools/quickbook/doc/phrase.qbk Sun Nov 17 05:50:09 2013 (r86737)
+++ branches/release/tools/quickbook/doc/phrase.qbk 2013-11-17 06:04:36 EST (Sun, 17 Nov 2013) (r86738)
@@ -168,26 +168,36 @@
 [#quickbook.ref.role]
 [section:role Role]
 
-Sometime the basic formatting options aren't enough, and you wish
-to use CSS to style the generated html. For these cases you can
-use the `role` phase element. For example:
+This generates a docbook phrase with a `role` attribute, which can be used
+to classify the phrase. This can be used to mark text for a use that isn't
+covered elsewhere. The docbook `role` will generate a html class, which can
+be used to style text. And the xsl stylesheets can be customized to treat
+certain roles specially when generating pdfs.
+
+The boostbook css stylesheets, and xsl stylesheets
+contain support for a limited number of colours that can be used with
+`role`. For example if you write:
 
     [role red Text content]
 
-Will generate the docbook:
+You'll get red text if you're using the boostbook css (for html) or
+the boostbook xsl for generating pdfs.
 
- <phrase role="red">Text content</phrase>
+The full list of colours that will be available is:
 
-Which will generate html along the lines of:
-
- <span class="red">Text content</span>
-
-And then you can use css to style this however you wish.
-
-[note When generating other formats such as pdfs, your css is not going to
- apply, so this will appear as normal, unstyled text. The docbook
- =role= attribute is meant to be used as a more general mechanism, so
- you might be able to take advantage of it by some other means.]
+* [role red red]
+* [role green green]
+* [role lime lime]
+* [role blue blue]
+* [role navy navy]
+* [role yellow yellow]
+* [role magenta magenta]
+* [role indigo indigo]
+* [role cyan cyan]
+* [role purple purple]
+* [role gold gold]
+* [role silver silver]
+* [role gray gray]
 
 [endsect] [/role]
 

Modified: branches/release/tools/quickbook/src/quickbook.cpp
==============================================================================
--- branches/release/tools/quickbook/src/quickbook.cpp Sun Nov 17 05:50:09 2013 (r86737)
+++ branches/release/tools/quickbook/src/quickbook.cpp 2013-11-17 06:04:36 EST (Sun, 17 Nov 2013) (r86738)
@@ -40,7 +40,7 @@
 #pragma warning(disable:4355)
 #endif
 
-#define QUICKBOOK_VERSION "Quickbook Version 1.6.0 beta 1"
+#define QUICKBOOK_VERSION "Quickbook Version 1.6.0"
 
 namespace quickbook
 {


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