[ceph.git] / ceph / src / boost / tools / quickbook / doc / syntax.qbk

[/
    Copyright 2002,2004,2006 Joel de Guzman, Eric Niebler
    Copyright 2010-2011 Daniel James

    Distributed under the Boost Software License, Version 1.0.
    (See accompanying file LICENSE_1_0.txt or copy at
    http://www.boost.org/LICENSE_1_0.txt)
]

[chapter Syntax Summary
    [quickbook 1.6]
    [compatibility-mode 1.5]
    [id quickbook.syntax]
    [source-mode teletype]
]

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
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
mark-ups. Marked up phrases can recursively contain other phrases, but
cannot contain blocks. A terminal is a self contained block-level or
phrase-level element that does not nest anything.

Blocks, in general, are delimited by two end-of-lines (the block terminator).
Phrases in each block cannot contain a block terminator. This way, syntax errors
such as un-matched closing brackets do not go haywire and corrupt anything past
a single block.

[#quickbook.ref.comments]
[section:comments Comments]

Can be placed anywhere.

```
[/ comment (no output generated) ]
```

[/ for testing only... ]

```
[/ comments can be nested [/ some more here] ]
```

[/ for testing [/ only ] ]

```
[/ Quickbook blocks can nest inside comments. [*Comment this out too!] ]
```

[/ for testing [*only ] ]

[endsect] [/comments]
Commit	Line	Data
7c673cae FG	1	[/
	2	Copyright 2002,2004,2006 Joel de Guzman, Eric Niebler
	3	Copyright 2010-2011 Daniel James
	4
	5	Distributed under the Boost Software License, Version 1.0.
	6	(See accompanying file LICENSE_1_0.txt or copy at
	7	http://www.boost.org/LICENSE_1_0.txt)
	8	]
	9
	10	[chapter Syntax Summary
	11	[quickbook 1.6]
	12	[compatibility-mode 1.5]
	13	[id quickbook.syntax]
	14	[source-mode teletype]
	15	]
	16
	17	A QuickBook document is composed of one or more blocks. An example of
	18	a block is the paragraph or a C++ code snippet. Some blocks have
	19	special mark-ups. Blocks, except code snippets which have their own
	20	grammar (C++ or Python), are composed of one or more phrases. A phrase
	21	can be a simple contiguous run of characters. Phrases can have special
	22	mark-ups. Marked up phrases can recursively contain other phrases, but
	23	cannot contain blocks. A terminal is a self contained block-level or
	24	phrase-level element that does not nest anything.
	25
	26	Blocks, in general, are delimited by two end-of-lines (the block terminator).
	27	Phrases in each block cannot contain a block terminator. This way, syntax errors
	28	such as un-matched closing brackets do not go haywire and corrupt anything past
	29	a single block.
	30
	31	[#quickbook.ref.comments]
	32	[section:comments Comments]
	33
	34	Can be placed anywhere.
	35
	36	```
	37	[/ comment (no output generated) ]
	38	```
	39
	40	[/ for testing only... ]
	41
	42	```
	43	[/ comments can be nested [/ some more here] ]
	44	```
	45
	46	[/ for testing [/ only ] ]
	47
	48	```
	49	[/ Quickbook blocks can nest inside comments. [*Comment this out too!] ]
	50	```
	51
	52	[/ for testing [*only ] ]
	53
	54	[endsect] [/comments]