Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: downloads/boost_1_34_1/doc/html/quickbook/ref.html @ 46

Last change on this file since 46 was 29, checked in by landauf, 17 years ago

updated boost from 1_33_1 to 1_34_1
File size: 12.7 KB
Line 
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
4<title> Quick Reference</title>
5<link rel="stylesheet" href="../boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.68.1">
7<link rel="start" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
8<link rel="up" href="../quickbook.html" title="Chapter 23. Quickbook 1.3">
9<link rel="prev" href="syntax.html" title=" Syntax Summary">
10<link rel="next" href="../jam.html" title="Chapter 24. Boost.Jam : 3.1.14">
11</head>
12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
13<table cellpadding="2" width="100%">
14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
15<td align="center"><a href="../../../index.htm">Home</a></td>
16<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
17<td align="center"><a href="../../../people/people.htm">People</a></td>
18<td align="center"><a href="../../../more/faq.htm">FAQ</a></td>
19<td align="center"><a href="../../../more/index.htm">More</a></td>
20</table>
21<hr>
22<div class="spirit-nav">
23<a accesskey="p" href="syntax.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../quickbook.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../jam.html"><img src="../images/next.png" alt="Next"></a>
24</div>
25<div class="section" lang="en">
26<div class="titlepage"><div><div><h2 class="title" style="clear: both">
27<a name="quickbook.ref"></a> Quick Reference</h2></div></div></div>
28<div class="informaltable">
29<h4>
30<a name="id2090711"></a>
31        <span class="table-title">Syntax Compendium</span>
32      </h4>
33<table class="table">
34<colgroup>
35<col>
36<col>
37<col>
38</colgroup>
39<thead><tr>
40<th>To do this...</th>
41<th>Use this...</th>
42<th>See this...</th>
43</tr></thead>
44<tbody>
45<tr>
46<td>comment</td>
47<td><code class="literal">
48[/ some comment]
49            </code></td>
50<td><a href="syntax.html#quickbook.syntax.comments" title="Comments">Comments</a></td>
51</tr>
52<tr>
53<td><span class="emphasis"><em>italics</em></span></td>
54<td><code class="literal">
55['italics] or /italics/
56            </code></td>
57<td>
58<a href="syntax.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font
59            Styles</a> and <a href="syntax.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">formatting
60            Simple formatting</a>
61</td>
62</tr>
63<tr>
64<td><span class="bold"><strong>bold</strong></span></td>
65<td><code class="literal">
66[*bold] or *bold*
67            </code></td>
68<td>
69<a href="syntax.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font
70            Styles</a> and <a href="syntax.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">formatting
71            Simple formatting</a>
72</td>
73</tr>
74<tr>
75<td><span class="underline">underline</span></td>
76<td><code class="literal">
77[_underline] or _underline_
78            </code></td>
79<td>
80<a href="syntax.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font
81            Styles</a> and <a href="syntax.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">formatting
82            Simple formatting</a>
83</td>
84</tr>
85<tr>
86<td><code class="literal">teletype</code></td>
87<td><code class="literal">
88[^teletype] or =teletype=
89            </code></td>
90<td>
91<a href="syntax.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font
92            Styles</a> and <a href="syntax.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">formatting
93            Simple formatting</a>
94</td>
95</tr>
96<tr>
97<td><span class="strikethrough">strikethrough</span></td>
98<td><code class="literal">
99[-strikethrough]
100            </code></td>
101<td>
102<a href="syntax.html#quickbook.syntax.phrase.font_styles" title="Font Styles">Font
103            Styles</a> and <a href="syntax.html#quickbook.syntax.phrase.simple_formatting" title="Simple formatting">formatting
104            Simple formatting</a>
105</td>
106</tr>
107<tr>
108<td>
109            <em class="replaceable"><code>
110              replaceable
111            </code></em>
112            </td>
113<td><code class="literal">
114[~replaceable]
115            </code></td>
116<td><a href="syntax.html#quickbook.syntax.phrase.replaceable" title="Replaceable">Replaceble</a></td>
117</tr>
118<tr>
119<td>source mode</td>
120<td>
121<code class="literal">[c++]</code> or <code class="literal">[python]</code>
122</td>
123<td><a href="syntax.html#quickbook.syntax.phrase.source_mode" title="Source Mode">Source Mode</a></td>
124</tr>
125<tr>
126<td>inline code</td>
127<td><code class="literal">
128`int main();`
129            </code></td>
130<td><a href="syntax.html#quickbook.syntax.phrase.inline_code" title="Inline code">Inline
131            code</a></td>
132</tr>
133<tr>
134<td>code block</td>
135<td><code class="literal">
136``int main();``
137            </code></td>
138<td><a href="syntax.html#quickbook.syntax.block.code" title="Code">Code</a></td>
139</tr>
140<tr>
141<td>code escape</td>
142<td><code class="literal">
143``from c++ to QuickBook``
144            </code></td>
145<td><a href="syntax.html#quickbook.syntax.block.escape_back" title=" Escaping Back To QuickBook">Escaping
146            Back To QuickBook</a></td>
147</tr>
148<tr>
149<td>line break</td>
150<td><code class="literal">
151[br] or \n
152            </code></td>
153<td><a href="syntax.html#quickbook.syntax.phrase.line_break" title="line-break">line-break</a></td>
154</tr>
155<tr>
156<td>anchor</td>
157<td><code class="literal">
158[#anchor]
159            </code></td>
160<td><a href="syntax.html#quickbook.syntax.phrase.anchors" title="Anchors">Anchors</a></td>
161</tr>
162<tr>
163<td>link</td>
164<td><code class="literal">
165[@http://www.boost.org Boost]
166            </code></td>
167<td><a href="syntax.html#quickbook.syntax.phrase.links" title="Links">Links</a></td>
168</tr>
169<tr>
170<td>anchor link</td>
171<td><code class="literal">
172[link section.anchor Link text]
173            </code></td>
174<td><a href="syntax.html#quickbook.syntax.phrase.anchor_links" title="Anchor links">Anchor
175            links</a></td>
176</tr>
177<tr>
178<td>refentry link</td>
179<td><code class="literal">
180[link xml.refentry Link text]
181            </code></td>
182<td><a href="syntax.html#quickbook.syntax.phrase.refentry_links" title="refentry links">refentry
183            links</a></td>
184</tr>
185<tr>
186<td>function link</td>
187<td><code class="literal">
188[funcref fully::qualified::function_name Link text]
189            </code></td>
190<td><a href="syntax.html#quickbook.syntax.phrase.code_links" title=" Code Links">function,
191            class, member, enum or header links</a></td>
192</tr>
193<tr>
194<td>class link</td>
195<td><code class="literal">
196[classref fully::qualified::class_name Link text]
197            </code></td>
198<td><a href="syntax.html#quickbook.syntax.phrase.code_links" title=" Code Links">function,
199            class, member, enum or header links</a></td>
200</tr>
201<tr>
202<td>member link</td>
203<td><code class="literal">
204[memberref fully::qualified::member_name Link text]
205            </code></td>
206<td><a href="syntax.html#quickbook.syntax.phrase.code_links" title=" Code Links">function,
207            class, member, enum or header links</a></td>
208</tr>
209<tr>
210<td>enum link</td>
211<td><code class="literal">
212[enumref fully::qualified::enum_name Link text]
213            </code></td>
214<td><a href="syntax.html#quickbook.syntax.phrase.code_links" title=" Code Links">function,
215            class, member, enum or header links</a></td>
216</tr>
217<tr>
218<td>header link</td>
219<td><code class="literal">
220[headerref path/to/header.hpp Link text]
221            </code></td>
222<td><a href="syntax.html#quickbook.syntax.phrase.code_links" title=" Code Links">function,
223            class, member, enum or header links</a></td>
224</tr>
225<tr>
226<td>escape</td>
227<td><code class="literal">'''escaped text (no processing/formatting)'''</code></td>
228<td><a href="syntax.html#quickbook.syntax.phrase.escape" title="Escape">Escape</a></td>
229</tr>
230<tr>
231<td>single char escape</td>
232<td><code class="literal">\c</code></td>
233<td><a href="syntax.html#quickbook.syntax.phrase.single_char_escape" title="Single char escape">Single char escape</a></td>
234</tr>
235<tr>
236<td>images</td>
237<td><code class="literal">
238[$image.jpg]
239            </code></td>
240<td><a href="syntax.html#quickbook.syntax.phrase.images" title="Images">Images</a></td>
241</tr>
242<tr>
243<td>begin section</td>
244<td><code class="literal">
245[section The Section Title]
246            </code></td>
247<td><a href="syntax.html#quickbook.syntax.block.section" title="Section">Section</a></td>
248</tr>
249<tr>
250<td>end section</td>
251<td><code class="literal">
252[endsect]
253            </code></td>
254<td><a href="syntax.html#quickbook.syntax.block.section" title="Section">Section</a></td>
255</tr>
256<tr>
257<td>paragraph</td>
258<td>No markup. Paragraphs start left-flushed
259            and are terminated by two or more newlines.</td>
260<td><a href="syntax.html#quickbook.syntax.block.paragraphs" title="Paragraphs">Paragraphs</a></td>
261</tr>
262<tr>
263<td>ordered list</td>
264<td><code class="literal"># one<br> # two<br> #
265            three<br> </code></td>
266<td><a href="syntax.html#quickbook.syntax.block.lists.ordered_lists" title="Ordered lists">Ordered
267            lists</a></td>
268</tr>
269<tr>
270<td>unordered list</td>
271<td><code class="literal">* one<br> * two<br>
272            * three<br> </code></td>
273<td><a href="syntax.html#quickbook.syntax.block.lists.unordered_lists" title="Unordered lists">Unordered
274            lists</a></td>
275</tr>
276<tr>
277<td>code</td>
278<td>No markup. Preformatted code starts with a
279            space or a tab.</td>
280<td><a href="syntax.html#quickbook.syntax.block.code" title="Code">Code</a></td>
281</tr>
282<tr>
283<td>preformatted</td>
284<td><code class="literal">
285[pre preformatted]
286            </code></td>
287<td><a href="syntax.html#quickbook.syntax.block.preformatted" title="Preformatted">Preformatted</a></td>
288</tr>
289<tr>
290<td>block quote</td>
291<td><code class="literal">
292[:sometext...]
293            </code></td>
294<td><a href="syntax.html#quickbook.syntax.block.blockquote" title="Blockquote">Blockquote</a></td>
295</tr>
296<tr>
297<td>heading 1</td>
298<td><code class="literal">
299[h1 Heading 1]
300            </code></td>
301<td><a href="syntax.html#quickbook.syntax.block.headings" title="Headings">Heading</a></td>
302</tr>
303<tr>
304<td>heading 2</td>
305<td><code class="literal">
306[h2 Heading 2]
307            </code></td>
308<td><a href="syntax.html#quickbook.syntax.block.headings" title="Headings">Heading</a></td>
309</tr>
310<tr>
311<td>heading 3</td>
312<td><code class="literal">
313[h3 Heading 3]
314            </code></td>
315<td><a href="syntax.html#quickbook.syntax.block.headings" title="Headings">Heading</a></td>
316</tr>
317<tr>
318<td>heading 4</td>
319<td><code class="literal">
320[h4 Heading 4]
321            </code></td>
322<td><a href="syntax.html#quickbook.syntax.block.headings" title="Headings">Heading</a></td>
323</tr>
324<tr>
325<td>heading 5</td>
326<td><code class="literal">
327[h5 Heading 5]
328            </code></td>
329<td><a href="syntax.html#quickbook.syntax.block.headings" title="Headings">Heading</a></td>
330</tr>
331<tr>
332<td>heading 6</td>
333<td><code class="literal">
334[h6 Heading 6]
335            </code></td>
336<td><a href="syntax.html#quickbook.syntax.block.headings" title="Headings">Heading</a></td>
337</tr>
338<tr>
339<td>macro</td>
340<td><code class="literal">
341[def macro_identifier some text]
342            </code></td>
343<td><a href="syntax.html#quickbook.syntax.block.macros" title="Macros">Macros</a></td>
344</tr>
345<tr>
346<td>blurb</td>
347<td><code class="literal">
348[blurb advertisement or note...]
349            </code></td>
350<td><a href="syntax.html#quickbook.syntax.block.blurbs" title="Blurbs">Blurbs</a></td>
351</tr>
352<tr>
353<td>admonition</td>
354<td><code class="literal">
355[warning Warning text...]
356            </code></td>
357<td><a href="syntax.html#quickbook.syntax.block.admonitions" title="Admonitions">Admonitions</a></td>
358</tr>
359<tr>
360<td>table</td>
361<td><code class="literal">[table Title<br> [[a][b][c]]<br>
362            [[a][b][c]]<br> ]</code></td>
363<td><a href="syntax.html#quickbook.syntax.block.tables" title="Tables">Tables</a></td>
364</tr>
365<tr>
366<td>variablelist</td>
367<td><code class="literal">[variablelist Title<br>
368            [[a][b]]<br> [[a][b]]<br> ]</code></td>
369<td><a href="syntax.html#quickbook.syntax.block.variable_lists" title="Variable Lists">Variable
370            Lists</a></td>
371</tr>
372<tr>
373<td>include</td>
374<td><code class="literal">
375[include someother.qbk]
376            </code></td>
377<td><a href="syntax.html#quickbook.syntax.block.include" title="Include">Include</a></td>
378</tr>
379</tbody>
380</table>
381</div>
382</div>
383<table width="100%"><tr>
384<td align="left"></td>
385<td align="right"><small>Copyright © 2002, 2004 Joel de Guzman, Eric Niebler</small></td>
386</tr></table>
387<hr>
388<div class="spirit-nav">
389<a accesskey="p" href="syntax.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../quickbook.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="../jam.html"><img src="../images/next.png" alt="Next"></a>
390</div>
391</body>
392</html>
Note: See TracBrowser for help on using the repository browser.