Subject: [Boost-commit] svn:boost r68897 - branches/doc-tools-docs/tools/quickbook/doc
Date: 2011-02-14 20:16:49
Date: 2011-02-14 20:16:47 EST (Mon, 14 Feb 2011)
New Revision: 68897
Start with a very simple quickbook document.
Text files modified:
branches/doc-tools-docs/tools/quickbook/doc/syntax.qbk | 22 ++++++++++++++++++++--
1 files changed, 20 insertions(+), 2 deletions(-)
--- branches/doc-tools-docs/tools/quickbook/doc/syntax.qbk (original)
+++ branches/doc-tools-docs/tools/quickbook/doc/syntax.qbk 2011-02-14 20:16:47 EST (Mon, 14 Feb 2011)
@@ -9,8 +9,26 @@
[section:syntax Syntax Summary]
-A QuickBook document is composed of one or more blocks. An example of
-a block is the paragraph or a C++ code snippet. Some blocks have
+A simple quickbook document might look something like:
+ [book A sweet little horror story
+ [quickbook 1.5]
+ [author Brown, Fredric]
+ The last man on Earth sat alone in a room. There was a knock on
+ the door...
+The document starts with the
+[link quickbook.syntax.docinfo document info block].
+This describes the type of the document, it's title and document
+metadata. In this case just the version of quickbook to be used.
+This is then followed by one or more blocks. An example of
+a block is the paragraph or a C++ code snippet. In this example we just
+have a single paragraph. Some blocks have
special mark-ups. Blocks, except code snippets which have their own
grammar (C++ or Python), are composed of one or more phrases. A phrase
can be a simple contiguous run of characters. Phrases can have special
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