[Boost-commit] svn:boost r68895 - branches/doc-tools-docs/tools/quickbook/doc

Subject: [Boost-commit] svn:boost r68895 - branches/doc-tools-docs/tools/quickbook/doc
From: dnljms_at_[hidden]
Date: 2011-02-14 20:15:44

Author: danieljames
Date: 2011-02-14 20:15:42 EST (Mon, 14 Feb 2011)
New Revision: 68895
URL: http://svn.boost.org/trac/boost/changeset/68895

Log:
Move the document info section to the syntax section.
Text files modified: 
   branches/doc-tools-docs/tools/quickbook/doc/block.qbk  |    50 --------------------------------------- 
   branches/doc-tools-docs/tools/quickbook/doc/syntax.qbk |    51 ++++++++++++++++++++++++++++++++++++++++
   2 files changed, 51 insertions(+), 50 deletions(-)

Modified: branches/doc-tools-docs/tools/quickbook/doc/block.qbk
==============================================================================
--- branches/doc-tools-docs/tools/quickbook/doc/block.qbk	(original)
+++ branches/doc-tools-docs/tools/quickbook/doc/block.qbk	2011-02-14 20:15:42 EST (Mon, 14 Feb 2011)
@@ -9,56 +9,6 @@
 
 [section:block Block Level Elements]
 
-[section Document]
-
-Every document must begin with a Document Info section, which should look
-like this:
-
-[pre'''
-[document-type The Document Title
-    [quickbook 1.5]
-    [version 1.0]
-    [id the_document_name]
-    [dirname the_document_dir]
-    [copyright 2000 2002 2003 Joe Blow, Jane Doe]
-    [purpose The document's reason for being]
-    [category The document's category]
-    [authors [Blow, Joe] [Doe, Jane]]
-    [license The document's license]
-    [source-mode source-type]
-]
-''']
-
-Where document-type is one of:
-
-* book
-* article
-* library
-* chapter
-* part
-* appendix
-* preface
-* qandadiv
-* qandaset
-* reference
-* set
-
-quickbook 1.5 declares the version of quickbook the document is written for.
-In its absence, version 1.1 is assumed.
-
-=version=, =id=, =dirname=, =copyright=, =purpose=, =category=, =authors=,
-=license=, =last-revision= and =source-mode= are optional information.
-
-=dirname=, =purpose= and =category= are boostbook attributes which are only
-valid for =library= documents. If you use them for other document types,
-quickbook will warn about them, but still use them, generating invalid markup,
-that's just ignored by the style sheets.
-
-=source-type= is a lowercase string setting the initial __source_mode__. If
-the =source-mode= field is omitted, a default value of =c++= will be used.
-
-[endsect] [/Document]
-
 [section Section]
 
 Starting a new section is accomplished with:

Modified: branches/doc-tools-docs/tools/quickbook/doc/syntax.qbk
==============================================================================
--- branches/doc-tools-docs/tools/quickbook/doc/syntax.qbk	(original)
+++ branches/doc-tools-docs/tools/quickbook/doc/syntax.qbk	2011-02-14 20:15:42 EST (Mon, 14 Feb 2011)
@@ -47,4 +47,55 @@
 
 [endsect] [/Comments]
 
+[section Document Info]
+
+Every document must begin with a Document Info section, which should look
+like this:
+
+[pre'''
+[document-type The Document Title
+    [quickbook 1.5]
+    [version 1.0]
+    [id the_document_name]
+    [dirname the_document_dir]
+    [copyright 2000 2002 2003 Joe Blow, Jane Doe]
+    [purpose The document's reason for being]
+    [category The document's category]
+    [authors [Blow, Joe] [Doe, Jane]]
+    [license The document's license]
+    [source-mode source-type]
+]
+''']
+
+Where document-type is one of:
+
+* book
+* article
+* library
+* chapter
+* part
+* appendix
+* preface
+* qandadiv
+* qandaset
+* reference
+* set
+
+quickbook 1.5 declares the version of quickbook the document is written for.
+In its absence, version 1.1 is assumed.
+
+=version=, =id=, =dirname=, =copyright=, =purpose=, =category=, =authors=,
+=license=, =last-revision= and =source-mode= are optional information.
+
+=dirname=, =purpose= and =category= are boostbook attributes which are only
+valid for =library= documents. If you use them for other document types,
+quickbook will warn about them, but still use them, generating invalid markup,
+that's just ignored by the style sheets.
+
+=source-type= is a lowercase string setting the initial __source_mode__. If
+the =source-mode= field is omitted, a default value of =c++= will be used.
+
+
+[endsect]
+
 [endsect] [/Syntax Summary]