Boost logo

Boost-Commit :

Subject: [Boost-commit] svn:boost r76971 - trunk/tools/quickbook/doc
From: dnljms_at_[hidden]
Date: 2012-02-11 07:33:47

Author: danieljames
Date: 2012-02-11 07:33:46 EST (Sat, 11 Feb 2012)
New Revision: 76971

Quickbook: Some explicit section ids.
Text files modified:
   trunk/tools/quickbook/doc/block.qbk | 88 ++++++++++++++++++++--------------------
   trunk/tools/quickbook/doc/phrase.qbk | 80 ++++++++++++++++++------------------
   trunk/tools/quickbook/doc/syntax.qbk | 4
   3 files changed, 86 insertions(+), 86 deletions(-)

Modified: trunk/tools/quickbook/doc/block.qbk
--- trunk/tools/quickbook/doc/block.qbk (original)
+++ trunk/tools/quickbook/doc/block.qbk 2012-02-11 07:33:46 EST (Sat, 11 Feb 2012)
@@ -14,7 +14,7 @@
     [source-mode teletype]
-[section xinclude]
+[section:xinclude xinclude]
 You can include another XML file with:
@@ -27,7 +27,7 @@
 [endsect] [/xinclude]
-[section Paragraphs]
+[section:paragraphs Paragraphs]
 Paragraphs start left-flushed and are terminated by two or more newlines. No
 markup is needed for paragraphs. QuickBook automatically detects paragraphs from
@@ -36,10 +36,10 @@
  [/ <-- There's a space here. Don't remove. this is intentianal, for testing]
 This is a new paragraph...
-[endsect] [/Paragraphs]
+[endsect] [/paragraphs]
-[section Lists]
-[section Ordered lists]
+[section:lists Lists]
+[section:ordered_lists Ordered lists]
 # One
@@ -53,8 +53,8 @@
 # Two
 # Three
-[endsect] [/Ordered lists]
-[section List Hierarchies]
+[endsect] [/ordered_lists]
+[section:list_hierarchies List Hierarchies]
 List hierarchies are supported. Example:
@@ -86,8 +86,8 @@
         # Four.a.ii
 # Five
-[endsect] [/List Hierarchies]
-[section Long List Lines]
+[endsect] [/list_hierarchies]
+[section:long_list_lines Long List Lines]
 Long lines will be wrapped appropriately. Example:
@@ -109,8 +109,8 @@
   A very long item. A very long item. A very long item.
 # A short item.
-[endsect] [/Long list lines]
-[section Unordered lists]
+[endsect] [/long_list_lines]
+[section:unordered_lists Unordered lists]
 * First
@@ -124,8 +124,8 @@
 * Second
 * Third
-[endsect] [/Unordered lists]
-[section Mixed lists]
+[endsect] [/unordered_lists]
+[section:mixed_lists Mixed lists]
 Mixed lists (ordered and unordered) are supported. Example:
@@ -181,10 +181,10 @@
             * 2.b.2.a
             * 2.b.2.b
-[endsect] [/Mixed lists]
-[endsect] [/Lists]
+[endsect] [/mixed_lists]
+[endsect] [/lists]
-[section Code]
+[section:code Code]
 Preformatted code starts with a space or a tab. The code will be
 syntax highlighted according to the current __source_mode__:
@@ -227,7 +227,7 @@
     using __boost__::__array__;
-[endsect] [/Code]
+[endsect] [/code]
 [section:escape_back Escaping Back To QuickBook]
@@ -252,9 +252,9 @@
 When escaping from code to QuickBook, only phrase level markups are
 allowed. Block level markups like lists, tables etc. are not allowed.
-[endsect] [/Escaping back to quickbook]
+[endsect] [/escaping_back_to_quickbook]
-[section Preformatted]
+[section:preformatted Preformatted]
 Sometimes, you don't want some preformatted text to be parsed as source code. In such
 cases, use the [^\[pre ... \]] markup block.
@@ -288,9 +288,9 @@
 Notice that unlike Code, phrase markup such as font style is still permitted
 inside =pre= blocks.
-[endsect] [/Preformatted]
+[endsect] [/preformatted]
-[section Blockquote]
+[section:blockquote Blockquote]
@@ -298,9 +298,9 @@
 [:Indents the paragraph. This applies to one paragraph only.]
-[endsect] [/Blockquote]
+[endsect] [/blockquote]
-[section Admonitions]
+[section:admonitions Admonitions]
 [note This is a note]
@@ -322,9 +322,9 @@
 for example [^\[information This is some information\]] is unlikely
 to produce the desired effect.
-[endsect] [/Admonitions]
+[endsect] [/admonitions]
-[section Headings]
+[section:headings Headings]
 [h1 Heading 1]
@@ -356,9 +356,9 @@
 to link to them. See __anchor_links__ and __section__ for more info.
-[endsect] [/Headings]
+[endsect] [/headings]
-[section Generic Heading]
+[section:generic_heading Generic Heading]
 In cases when you don't want to care about the heading level (1 to 6), you
 can use the /Generic Heading/:
@@ -402,9 +402,9 @@
 with /section/ and /heading/, you have all you need. /h1/../h6/ becomes
 redundant. /h1/../h6/ might be deprecated in the future.
-[endsect] [/Generic Heading]
+[endsect] [/generic_heading]
-[section Macros]
+[section:macros Macros]
 [def macro_identifier some text]
@@ -455,9 +455,9 @@
 Hi __spirit__ :-)
-[endsect] [/Macros]
+[endsect] [/macros]
-[section Predefined Macros]
+[section:predefined_macros Predefined Macros]
 Quickbook has some predefined macros that you can already use.
@@ -468,9 +468,9 @@
     [[[^\__FILENAME__]][Quickbook source filename] [__FILENAME__]]
-[endsect] [/Predefined Macros]
+[endsect] [/predefined_macros]
-[section Templates]
+[section:templates Templates]
 Templates provide a more versatile text substitution mechanism. Templates
 come in handy when you need to create parameterizable, multi-line,
@@ -748,9 +748,9 @@
-[endsect] [/Templates]
+[endsect] [/templates]
-[section Blurbs]
+[section:blurbs Blurbs]
 [blurb ``\:-)`` [*An eye catching advertisement or note...]
@@ -775,9 +775,9 @@
 [note Prefer [link quickbook.syntax.block.admonitions admonitions] wherever
-[endsect] [/Blurbs]
+[endsect] [/blurbs]
-[section Tables]
+[section:tables Tables]
 [table:id A Simple Table
@@ -899,9 +899,9 @@
-[endsect] [/Tables]
+[endsect] [/tables]
-[section Variable Lists]
+[section:variable_lists Variable Lists]
 [variablelist A Variable List
@@ -932,9 +932,9 @@
 the second column contains the definitions. Those familiar with HTML
 will recognize this as a "definition list".
-[endsect] [/Variable Lists]
+[endsect] [/variable_lists]
-[section Include]
+[section:include Include]
 You can include one QuickBook file from another. The syntax is simply:
@@ -963,9 +963,9 @@
 named anchor for that section will be "someid.intro", and you can link to
 it with [^\[link someid.intro The Intro\]].
-[endsect] [/Include]
+[endsect] [/include]
-[section Import]
+[section:import Import]
 When documenting code, you'd surely need to present code from actual source
 files. While it is possible to copy some code and paste them in your QuickBook
@@ -1110,4 +1110,4 @@
 See the actual code here: [@boost:/tools/quickbook/test/stub.cpp]
-[endsect] [/Import]
+[endsect] [/import]

Modified: trunk/tools/quickbook/doc/phrase.qbk
--- trunk/tools/quickbook/doc/phrase.qbk (original)
+++ trunk/tools/quickbook/doc/phrase.qbk 2012-02-11 07:33:46 EST (Sat, 11 Feb 2012)
@@ -14,7 +14,7 @@
     [source-mode teletype]
-[section Font Styles]
+[section:font_styles Font Styles]
 ['italic], [*bold], [_underline], [^teletype], [-strikethrough]
@@ -34,9 +34,9 @@
-[endsect] [/Font Styles]
+[endsect] [/font_styles]
-[section Replaceable]
+[section:replaceable Replaceable]
 When you want content that may or must be replaced by the user, use the syntax:
@@ -48,9 +48,9 @@
-[endsect] [/Replaceable]
+[endsect] [/replaceable]
-[section Quotations]
+[section:quotations Quotations]
 ["A question that sometimes drives me hazy: am I or are the others crazy?]--Einstein
@@ -76,9 +76,9 @@
 ["Here's the rule for bargains: ["Do other men, for they would do you.]
 That's the true business precept.]
-[endsect] [/Quotations]
+[endsect] [/quotations]
-[section Simple formatting]
+[section:simple_formatting Simple formatting]
 Simple markup for formatting text, common in many applications, is now supported:
@@ -159,9 +159,9 @@
 One for the master, one for the dame,
 And one for the little boy who lives down the lane.
-[endsect] [/Simple Formatting]
+[endsect] [/simple_formatting]
-[section Inline code]
+[section:inline_code Inline code]
 Inlining code in paragraphs is quite common when writing C++ documentation. We
 provide a very simple markup for this. For example, this:
@@ -179,9 +179,9 @@
 single quote: `"'"`. Note too that [^\`some code\`] is preferred over
 `[^some code]`. ]
-[endsect] [/Inline Code]
+[endsect] [/inline_code]
-[section Code blocks]
+[section:code_blocks Code blocks]
 Preformatted code simply starts with a space or a tab (See __code__).
 However, such a simple syntax cannot be used as phrase elements in lists
@@ -235,9 +235,9 @@
-[endsect] [/Code blocks]
+[endsect] [/code_blocks]
-[section Source Mode]
+[section:source_mode Source Mode]
 If a document contains more than one type of source code then the source
 mode may be changed dynamically as the document is processed. All QuickBook
@@ -270,10 +270,10 @@
 [note The source mode strings are lowercase.]
-[endsect] [/Source Mode]
+[endsect] [/source_mode]
-[section line-break]
+[section:line_break line-break]
@@ -283,9 +283,9 @@
 there might be problems, especially when using an alternative docbook
-[endsect] [/Line break]
+[endsect] [/line_break]
-[section Anchors]
+[section:anchors Anchors]
@@ -299,9 +299,9 @@
 quickbook documentation. Be careful to avoid clashes with anchors in
 other sections.
-[endsect] [/Anchors]
+[endsect] [/anchors]
-[section Links]
+[section:links Links]
 [@ this is [*boost's] website....]
@@ -339,9 +339,9 @@
 Note that this is only available when using BoostBook, and only for links
 - it can't be used for images.
-[endsect] [/Links]
+[endsect] [/links]
-[section Anchor links]
+[section:anchor_links Anchor links]
 You can link within a document using:
@@ -351,9 +351,9 @@
 See sections __section__ and __heading__ for more info.
-[endsect] [/Anchor links]
+[endsect] [/anchor_links]
-[section refentry links]
+[section:refentry_links refentry links]
 In addition, you can link internally to an XML refentry like:
@@ -372,7 +372,7 @@
 This gets converted into [^<link linkend="xml.refentry">xml.refentry</link>].
-[endsect] [/refentry links]
+[endsect] [/refentry_links]
 [section:code_links Code Links]
@@ -400,9 +400,9 @@
 would have "boost::bar::baz" as the link text.
-[endsect] [/Code Links]
+[endsect] [/code_links]
-[section Escape]
+[section:escape Escape]
 The escape mark-up is used when we don't want to do any processing.
@@ -427,9 +427,9 @@
 [important Be careful when using the escape. The text must conform to
 __boostbook__/__docbook__ syntax.]
-[endsect] [/Escape]
+[endsect] [/escape]
-[section Single char escape]
+[section:single_char_escape Single char escape]
 The backslash may be used to escape a single punctuation character. The
 punctuation immediately after the backslash is passed without any processing.
@@ -445,9 +445,9 @@
 The escaped space: `\ ` also has a special meaning. The escaped space is removed
 from the output.
-[endsect] [/Single char escape]
+[endsect] [/single_char_escape]
-[section Unicode escape]
+[section:unicode_escape Unicode escape]
 You can enter any 16-bit unicode character by using `\u` followed by its 4 digit
 hexadecimal code, or a 32-bit character by using `\U` followed by an 8 digit
@@ -463,9 +463,9 @@
 \u03B1 + \u03B2
-[endsect] [/Unicode escape]
+[endsect] [/unicode_escape]
-[section Images]
+[section:images Images]
@@ -479,9 +479,9 @@
 [$image.jpg [width 200in] [height 200in]]
-[endsect] [/Images]
+[endsect] [/images]
-[section Footnotes]
+[section:footnotes Footnotes]
 As of version 1.3, QuickBook supports footnotes. Just put the text of the
 footnote in a `[footnote]` block, and the text will be put at the bottom
@@ -493,9 +493,9 @@
 will generate this[footnote A sample footnote].
-[endsect] [/Footnotes]
+[endsect] [/footnotes]
-[section Macro Expansion]
+[section:macro_expansion Macro Expansion]
@@ -503,9 +503,9 @@
 See __macros__ for details.
-[endsect] [/Macro Expansion]
+[endsect] [/macro_expansion]
-[section Template Expansion]
+[section:template_expansion Template Expansion]
@@ -513,7 +513,7 @@
 See __templates__ for details.
-[endsect] [/Template Expansion]
+[endsect] [/template_expansion]
 [section:cond Conditional Generation]
@@ -543,4 +543,4 @@
-[endsect] [/Condition Generation]
+[endsect] [/cond]

Modified: trunk/tools/quickbook/doc/syntax.qbk
--- trunk/tools/quickbook/doc/syntax.qbk (original)
+++ trunk/tools/quickbook/doc/syntax.qbk 2012-02-11 07:33:46 EST (Sat, 11 Feb 2012)
@@ -28,7 +28,7 @@
 such as un-matched closing brackets do not go haywire and corrupt anything past
 a single block.
-[section Comments]
+[section:comments Comments]
 Can be placed anywhere.
@@ -50,5 +50,5 @@
 [/ for testing [*only ] ]
-[endsect] [/Comments]
+[endsect] [/comments]

Boost-Commit list run by bdawes at, david.abrahams at, gregod at, cpdaniel at, john at