1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<html> 3<head> 4<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 5<title>Syntax Summary</title> 6<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css"> 7<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 8<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset"> 9<link rel="up" href="../quickbook.html" title="Chapter 50. Quickbook 1.7"> 10<link rel="prev" href="command_line.html" title="Command Line Usage"> 11<link rel="next" href="syntax/structure.html" title="Document Structure"> 12</head> 13<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 14<table cellpadding="2" width="100%"><tr> 15<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> 16<td align="center"><a href="../../../index.html">Home</a></td> 17<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> 18<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 19<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 20<td align="center"><a href="../../../more/index.htm">More</a></td> 21</tr></table> 22<hr> 23<div class="spirit-nav"> 24<a accesskey="p" href="command_line.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quickbook.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="syntax/structure.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> 25</div> 26<div class="section"> 27<div class="titlepage"><div><div><h2 class="title" style="clear: both"> 28<a name="quickbook.syntax"></a>Syntax Summary</h2></div></div></div> 29<div class="toc"><dl class="toc"><dt><span class="section"><a href="syntax.html#quickbook.syntax.comments">Comments</a></span></dt></dl></div> 30<p> 31 A QuickBook document is composed of one or more blocks. An example of a block 32 is the paragraph or a C++ code snippet. Some blocks have special mark-ups. 33 Blocks, except code snippets which have their own grammar (C++ or Python), 34 are composed of one or more phrases. A phrase can be a simple contiguous run 35 of characters. Phrases can have special mark-ups. Marked up phrases can recursively 36 contain other phrases, but cannot contain blocks. A terminal is a self contained 37 block-level or phrase-level element that does not nest anything. 38 </p> 39<p> 40 Blocks, in general, are delimited by two end-of-lines (the block terminator). 41 Phrases in each block cannot contain a block terminator. This way, syntax errors 42 such as un-matched closing brackets do not go haywire and corrupt anything 43 past a single block. 44 </p> 45<div class="section"> 46<div class="titlepage"><div><div><h3 class="title"> 47<a name="quickbook.syntax.comments"></a><a name="quickbook.ref.comments"></a><a class="link" href="syntax.html#quickbook.syntax.comments" title="Comments">Comments</a> 48</h3></div></div></div> 49<p> 50 Can be placed anywhere. 51 </p> 52<pre class="programlisting">[/ comment (no output generated) ] 53</pre> 54<pre class="programlisting">[/ comments can be nested [/ some more here] ] 55</pre> 56<pre class="programlisting">[/ Quickbook blocks can nest inside comments. [*Comment this out too!] ] 57</pre> 58</div> 59</div> 60<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 61<td align="left"></td> 62<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman, 63 Eric Niebler<br>Copyright © 2010-2017 Daniel James<p> 64 Distributed under the Boost Software License, Version 1.0. (See accompanying 65 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 66 </p> 67</div></td> 68</tr></table> 69<hr> 70<div class="spirit-nav"> 71<a accesskey="p" href="command_line.html"><img src="../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../quickbook.html"><img src="../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="syntax/structure.html"><img src="../../../doc/src/images/next.png" alt="Next"></a> 72</div> 73</body> 74</html> 75
