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>Quick Reference</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="faq.html" title="Frequently Asked Questions"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td> 15<td align="center"><a href="../../../index.html">Home</a></td> 16<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="faq.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> 24</div> 25<div class="section"> 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="table"> 29<a name="quickbook.ref.syntax_compendium"></a><p class="title"><b>Table 50.8. Syntax Compendium</b></p> 30<div class="table-contents"><table class="table" summary="Syntax Compendium"> 31<colgroup> 32<col> 33<col> 34<col> 35</colgroup> 36<thead><tr> 37<th> 38 <p> 39 To do this... 40 </p> 41 </th> 42<th> 43 <p> 44 Use this... 45 </p> 46 </th> 47<th> 48 <p> 49 See this... 50 </p> 51 </th> 52</tr></thead> 53<tbody> 54<tr> 55<td> 56 <p> 57 comment 58 </p> 59 </td> 60<td> 61 <p> 62 <code class="computeroutput">[/ some comment]</code> 63 </p> 64 </td> 65<td> 66 <p> 67 <a class="link" href="syntax.html#quickbook.ref.comments">Comments</a> 68 </p> 69 </td> 70</tr> 71<tr> 72<td> 73 <p> 74 <span class="emphasis"><em>italics</em></span> 75 </p> 76 </td> 77<td> 78 <p> 79 <code class="computeroutput">['italics] or /italics/</code> 80 </p> 81 </td> 82<td> 83 <p> 84 <a class="link" href="syntax/phrase.html#quickbook.ref.font_styles">Font Styles</a> and 85 <a class="link" href="syntax/phrase.html#quickbook.ref.simple_formatting">Simple formatting</a> 86 </p> 87 </td> 88</tr> 89<tr> 90<td> 91 <p> 92 <span class="bold"><strong>bold</strong></span> 93 </p> 94 </td> 95<td> 96 <p> 97 <code class="computeroutput">[*bold] or *bold*</code> 98 </p> 99 </td> 100<td> 101 <p> 102 <a class="link" href="syntax/phrase.html#quickbook.ref.font_styles">Font Styles</a> and 103 <a class="link" href="syntax/phrase.html#quickbook.ref.simple_formatting">Simple formatting</a> 104 </p> 105 </td> 106</tr> 107<tr> 108<td> 109 <p> 110 <span class="underline">underline</span> 111 </p> 112 </td> 113<td> 114 <p> 115 <code class="computeroutput">[_underline] or _underline_</code> 116 </p> 117 </td> 118<td> 119 <p> 120 <a class="link" href="syntax/phrase.html#quickbook.ref.font_styles">Font Styles</a> and 121 <a class="link" href="syntax/phrase.html#quickbook.ref.simple_formatting">Simple formatting</a> 122 </p> 123 </td> 124</tr> 125<tr> 126<td> 127 <p> 128 <code class="literal">teletype</code> 129 </p> 130 </td> 131<td> 132 <p> 133 <code class="computeroutput">[^teletype] or =teletype=</code> 134 </p> 135 </td> 136<td> 137 <p> 138 <a class="link" href="syntax/phrase.html#quickbook.ref.font_styles">Font Styles</a> and 139 <a class="link" href="syntax/phrase.html#quickbook.ref.simple_formatting">Simple formatting</a> 140 </p> 141 </td> 142</tr> 143<tr> 144<td> 145 <p> 146 <span class="strikethrough">strikethrough</span> 147 </p> 148 </td> 149<td> 150 <p> 151 <code class="computeroutput">[-strikethrough]</code> 152 </p> 153 </td> 154<td> 155 <p> 156 <a class="link" href="syntax/phrase.html#quickbook.ref.font_styles">Font Styles</a> and 157 <a class="link" href="syntax/phrase.html#quickbook.ref.simple_formatting">Simple formatting</a> 158 </p> 159 </td> 160</tr> 161<tr> 162<td> 163 <p> 164 <em class="replaceable"><code>replaceable</code></em> 165 </p> 166 </td> 167<td> 168 <p> 169 <code class="computeroutput">[~replaceable]</code> 170 </p> 171 </td> 172<td> 173 <p> 174 <a class="link" href="syntax/phrase.html#quickbook.ref.replaceable">Replaceble</a> 175 </p> 176 </td> 177</tr> 178<tr> 179<td> 180 <p> 181 source mode 182 </p> 183 </td> 184<td> 185 <p> 186 <code class="computeroutput">[c++]</code> or <code class="computeroutput">[python]</code> 187 </p> 188 </td> 189<td> 190 <p> 191 <a class="link" href="syntax/phrase.html#quickbook.ref.source_mode">Source Mode</a> 192 </p> 193 </td> 194</tr> 195<tr> 196<td> 197 <p> 198 inline code 199 </p> 200 </td> 201<td> 202 <p> 203 <code class="literal">`int main();`</code> 204 </p> 205 </td> 206<td> 207 <p> 208 <a class="link" href="syntax/phrase.html#quickbook.ref.inline_code">Inline code</a> 209 </p> 210 </td> 211</tr> 212<tr> 213<td> 214 <p> 215 code block 216 </p> 217 </td> 218<td> 219 <p> 220 <code class="literal">``int main();``</code> 221 </p> 222 </td> 223<td> 224 <p> 225 <a class="link" href="syntax/block.html#quickbook.ref.code">Code</a> 226 </p> 227 </td> 228</tr> 229<tr> 230<td> 231 <p> 232 code escape 233 </p> 234 </td> 235<td> 236 <p> 237 <code class="literal">``from c++ to QuickBook``</code> 238 </p> 239 </td> 240<td> 241 <p> 242 <a class="link" href="syntax/block.html#quickbook.ref.escape_back">Escaping Back To QuickBook</a> 243 </p> 244 </td> 245</tr> 246<tr> 247<td> 248 <p> 249 line break 250 </p> 251 </td> 252<td> 253 <p> 254 <code class="computeroutput">[br] or \n</code> 255 </p> 256 </td> 257<td> 258 <p> 259 <a class="link" href="syntax/phrase.html#quickbook.ref.line_break">line-break</a> <span class="bold"><strong>DEPRECATED</strong></span> 260 </p> 261 </td> 262</tr> 263<tr> 264<td> 265 <p> 266 anchor 267 </p> 268 </td> 269<td> 270 <p> 271 <code class="computeroutput">[#anchor]</code> 272 </p> 273 </td> 274<td> 275 <p> 276 <a class="link" href="syntax/phrase.html#quickbook.ref.anchors">Anchors</a> 277 </p> 278 </td> 279</tr> 280<tr> 281<td> 282 <p> 283 link 284 </p> 285 </td> 286<td> 287 <p> 288 <code class="computeroutput">[@http://www.boost.org Boost]</code> 289 </p> 290 </td> 291<td> 292 <p> 293 <a class="link" href="syntax/phrase.html#quickbook.ref.links">Links</a> 294 </p> 295 </td> 296</tr> 297<tr> 298<td> 299 <p> 300 anchor link 301 </p> 302 </td> 303<td> 304 <p> 305 <code class="computeroutput">[link section.anchor Link text]</code> 306 </p> 307 </td> 308<td> 309 <p> 310 <a class="link" href="syntax/phrase.html#quickbook.ref.anchor_links">Anchor links</a> 311 </p> 312 </td> 313</tr> 314<tr> 315<td> 316 <p> 317 refentry link 318 </p> 319 </td> 320<td> 321 <p> 322 <code class="computeroutput">[link xml.refentry Link text]</code> 323 </p> 324 </td> 325<td> 326 <p> 327 <a class="link" href="syntax/phrase.html#quickbook.ref.refentry_links">refentry links</a> 328 </p> 329 </td> 330</tr> 331<tr> 332<td> 333 <p> 334 function link 335 </p> 336 </td> 337<td> 338 <p> 339 <code class="computeroutput">[funcref fully::qualified::function_name Link text]</code> 340 </p> 341 </td> 342<td> 343 <p> 344 <a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member, 345 enum, macro, concept or header links</a> 346 </p> 347 </td> 348</tr> 349<tr> 350<td> 351 <p> 352 class link 353 </p> 354 </td> 355<td> 356 <p> 357 <code class="computeroutput">[classref fully::qualified::class_name Link text]</code> 358 </p> 359 </td> 360<td> 361 <p> 362 <a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member, 363 enum, macro, concept or header links</a> 364 </p> 365 </td> 366</tr> 367<tr> 368<td> 369 <p> 370 member link 371 </p> 372 </td> 373<td> 374 <p> 375 <code class="computeroutput">[memberref fully::qualified::member_name Link text]</code> 376 </p> 377 </td> 378<td> 379 <p> 380 <a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member, 381 enum, macro, concept or header links</a> 382 </p> 383 </td> 384</tr> 385<tr> 386<td> 387 <p> 388 enum link 389 </p> 390 </td> 391<td> 392 <p> 393 <code class="computeroutput">[enumref fully::qualified::enum_name Link text]</code> 394 </p> 395 </td> 396<td> 397 <p> 398 <a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member, 399 enum, macro, concept or header links</a> 400 </p> 401 </td> 402</tr> 403<tr> 404<td> 405 <p> 406 macro link 407 </p> 408 </td> 409<td> 410 <p> 411 <code class="computeroutput">[macroref MACRO_NAME Link text]</code> 412 </p> 413 </td> 414<td> 415 <p> 416 <a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member, 417 enum, macro, concept or header links</a> 418 </p> 419 </td> 420</tr> 421<tr> 422<td> 423 <p> 424 concept link 425 </p> 426 </td> 427<td> 428 <p> 429 <code class="computeroutput">[conceptref ConceptName Link text]</code> 430 </p> 431 </td> 432<td> 433 <p> 434 <a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member, 435 enum, macro, concept or header links</a> 436 </p> 437 </td> 438</tr> 439<tr> 440<td> 441 <p> 442 header link 443 </p> 444 </td> 445<td> 446 <p> 447 <code class="computeroutput">[headerref path/to/header.hpp Link text]</code> 448 </p> 449 </td> 450<td> 451 <p> 452 <a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member, 453 enum, macro, concept or header links</a> 454 </p> 455 </td> 456</tr> 457<tr> 458<td> 459 <p> 460 global link 461 </p> 462 </td> 463<td> 464 <p> 465 <code class="computeroutput">[globalref fully::qualified::global Link text]</code> 466 </p> 467 </td> 468<td> 469 <p> 470 <a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member, 471 enum, macro, concept or header links</a> 472 </p> 473 </td> 474</tr> 475<tr> 476<td> 477 <p> 478 escape 479 </p> 480 </td> 481<td> 482 <p> 483 <code class="computeroutput">'''escaped text (no processing/formatting)'''</code> 484 </p> 485 </td> 486<td> 487 <p> 488 <a class="link" href="syntax/phrase.html#quickbook.ref.escape">Escape</a> 489 </p> 490 </td> 491</tr> 492<tr> 493<td> 494 <p> 495 single char escape 496 </p> 497 </td> 498<td> 499 <p> 500 <code class="computeroutput">\c</code> 501 </p> 502 </td> 503<td> 504 <p> 505 <a class="link" href="syntax/phrase.html#quickbook.ref.single_char_escape">Single char escape</a> 506 </p> 507 </td> 508</tr> 509<tr> 510<td> 511 <p> 512 images 513 </p> 514 </td> 515<td> 516 <p> 517 <code class="computeroutput">[$image.jpg]</code> 518 </p> 519 </td> 520<td> 521 <p> 522 <a class="link" href="syntax/phrase.html#quickbook.ref.images">Images</a> 523 </p> 524 </td> 525</tr> 526<tr> 527<td> 528 <p> 529 begin section 530 </p> 531 </td> 532<td> 533 <p> 534 <code class="computeroutput">[section The Section Title]</code> 535 </p> 536 </td> 537<td> 538 <p> 539 <a class="link" href="syntax/structure.html#quickbook.ref.section">Section</a> 540 </p> 541 </td> 542</tr> 543<tr> 544<td> 545 <p> 546 end section 547 </p> 548 </td> 549<td> 550 <p> 551 <code class="computeroutput">[endsect]</code> 552 </p> 553 </td> 554<td> 555 <p> 556 <a class="link" href="syntax/structure.html#quickbook.ref.section">Section</a> 557 </p> 558 </td> 559</tr> 560<tr> 561<td> 562 <p> 563 paragraph 564 </p> 565 </td> 566<td> 567 <p> 568 No markup. Paragraphs start left-flushed and are terminated by two 569 or more newlines. 570 </p> 571 </td> 572<td> 573 <p> 574 <a class="link" href="syntax/block.html#quickbook.ref.paragraphs">Paragraphs</a> 575 </p> 576 </td> 577</tr> 578<tr> 579<td> 580 <p> 581 ordered list 582 </p> 583 </td> 584<td> 585<pre class="programlisting"># one 586# two 587# three 588</pre> 589 </td> 590<td> 591 <p> 592 <a class="link" href="syntax/block.html#quickbook.ref.ordered_lists">Ordered lists</a> 593 </p> 594 </td> 595</tr> 596<tr> 597<td> 598 <p> 599 unordered list 600 </p> 601 </td> 602<td> 603<pre class="programlisting">* one 604* two 605* three 606</pre> 607 </td> 608<td> 609 <p> 610 <a class="link" href="syntax/block.html#quickbook.ref.unordered_lists">Unordered lists</a> 611 </p> 612 </td> 613</tr> 614<tr> 615<td> 616 <p> 617 code 618 </p> 619 </td> 620<td> 621 <p> 622 No markup. Preformatted code starts with a space or a tab. 623 </p> 624 </td> 625<td> 626 <p> 627 <a class="link" href="syntax/block.html#quickbook.ref.code">Code</a> 628 </p> 629 </td> 630</tr> 631<tr> 632<td> 633 <p> 634 preformatted 635 </p> 636 </td> 637<td> 638 <p> 639 <code class="computeroutput">[pre preformatted]</code> 640 </p> 641 </td> 642<td> 643 <p> 644 <a class="link" href="syntax/block.html#quickbook.ref.preformatted">Preformatted</a> 645 </p> 646 </td> 647</tr> 648<tr> 649<td> 650 <p> 651 block quote 652 </p> 653 </td> 654<td> 655 <p> 656 <code class="computeroutput">[:sometext...]</code> 657 </p> 658 </td> 659<td> 660 <p> 661 <a class="link" href="syntax/block.html#quickbook.ref.blockquote">Blockquote</a> 662 </p> 663 </td> 664</tr> 665<tr> 666<td> 667 <p> 668 heading 1 669 </p> 670 </td> 671<td> 672 <p> 673 <code class="computeroutput">[h1 Heading 1]</code> 674 </p> 675 </td> 676<td> 677 <p> 678 <a class="link" href="syntax/block.html#quickbook.ref.headings">Heading</a> 679 </p> 680 </td> 681</tr> 682<tr> 683<td> 684 <p> 685 heading 2 686 </p> 687 </td> 688<td> 689 <p> 690 <code class="computeroutput">[h2 Heading 2]</code> 691 </p> 692 </td> 693<td> 694 <p> 695 <a class="link" href="syntax/block.html#quickbook.ref.headings">Heading</a> 696 </p> 697 </td> 698</tr> 699<tr> 700<td> 701 <p> 702 heading 3 703 </p> 704 </td> 705<td> 706 <p> 707 <code class="computeroutput">[h3 Heading 3]</code> 708 </p> 709 </td> 710<td> 711 <p> 712 <a class="link" href="syntax/block.html#quickbook.ref.headings">Heading</a> 713 </p> 714 </td> 715</tr> 716<tr> 717<td> 718 <p> 719 heading 4 720 </p> 721 </td> 722<td> 723 <p> 724 <code class="computeroutput">[h4 Heading 4]</code> 725 </p> 726 </td> 727<td> 728 <p> 729 <a class="link" href="syntax/block.html#quickbook.ref.headings">Heading</a> 730 </p> 731 </td> 732</tr> 733<tr> 734<td> 735 <p> 736 heading 5 737 </p> 738 </td> 739<td> 740 <p> 741 <code class="computeroutput">[h5 Heading 5]</code> 742 </p> 743 </td> 744<td> 745 <p> 746 <a class="link" href="syntax/block.html#quickbook.ref.headings">Heading</a> 747 </p> 748 </td> 749</tr> 750<tr> 751<td> 752 <p> 753 heading 6 754 </p> 755 </td> 756<td> 757 <p> 758 <code class="computeroutput">[h6 Heading 6]</code> 759 </p> 760 </td> 761<td> 762 <p> 763 <a class="link" href="syntax/block.html#quickbook.ref.headings">Heading</a> 764 </p> 765 </td> 766</tr> 767<tr> 768<td> 769 <p> 770 macro 771 </p> 772 </td> 773<td> 774 <p> 775 <code class="computeroutput">[def macro_identifier some text]</code> 776 </p> 777 </td> 778<td> 779 <p> 780 <a class="link" href="syntax/block.html#quickbook.ref.macros">Macros</a> 781 </p> 782 </td> 783</tr> 784<tr> 785<td> 786 <p> 787 template 788 </p> 789 </td> 790<td> 791 <p> 792 <code class="computeroutput">[template[a b] [a] body [b]]</code> 793 </p> 794 </td> 795<td> 796 <p> 797 <a class="link" href="syntax/block.html#quickbook.ref.templates">Templates</a> 798 </p> 799 </td> 800</tr> 801<tr> 802<td> 803 <p> 804 blurb 805 </p> 806 </td> 807<td> 808 <p> 809 <code class="computeroutput">[blurb advertisement or note...]</code> 810 </p> 811 </td> 812<td> 813 <p> 814 <a class="link" href="syntax/block.html#quickbook.ref.blurbs">Blurbs</a> 815 </p> 816 </td> 817</tr> 818<tr> 819<td> 820 <p> 821 admonition 822 </p> 823 </td> 824<td> 825 <p> 826 <code class="computeroutput">[warning Warning text...]</code> 827 </p> 828 </td> 829<td> 830 <p> 831 <a class="link" href="syntax/block.html#quickbook.ref.admonitions">Admonitions</a> 832 </p> 833 </td> 834</tr> 835<tr> 836<td> 837 <p> 838 table 839 </p> 840 </td> 841<td> 842<pre class="programlisting">[table Title 843[[a][b][c]] 844[[a][b][c]] 845] 846</pre> 847 </td> 848<td> 849 <p> 850 <a class="link" href="syntax/block.html#quickbook.ref.tables">Tables</a> 851 </p> 852 </td> 853</tr> 854<tr> 855<td> 856 <p> 857 variablelist 858 </p> 859 </td> 860<td> 861<pre class="programlisting">[variablelist Title 862[[a][b]] 863[[a][b]] 864] 865</pre> 866 </td> 867<td> 868 <p> 869 <a class="link" href="syntax/block.html#quickbook.ref.variable_lists">Variable Lists</a> 870 </p> 871 </td> 872</tr> 873<tr> 874<td> 875 <p> 876 include 877 </p> 878 </td> 879<td> 880 <p> 881 <code class="computeroutput">[include someother.qbk]</code> 882 </p> 883 </td> 884<td> 885 <p> 886 <a class="link" href="syntax/block.html#quickbook.ref.include">Include</a> 887 </p> 888 </td> 889</tr> 890<tr> 891<td> 892 <p> 893 conditional generation 894 </p> 895 </td> 896<td> 897 <p> 898 <code class="computeroutput">[? symbol phrase]</code> 899 </p> 900 </td> 901<td> 902 <p> 903 <a class="link" href="syntax/phrase.html#quickbook.ref.cond">Conditional Generation</a> 904 </p> 905 </td> 906</tr> 907</tbody> 908</table></div> 909</div> 910<br class="table-break"> 911</div> 912<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 913<td align="left"></td> 914<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman, 915 Eric Niebler<br>Copyright © 2010-2017 Daniel James<p> 916 Distributed under the Boost Software License, Version 1.0. (See accompanying 917 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>) 918 </p> 919</div></td> 920</tr></table> 921<hr> 922<div class="spirit-nav"> 923<a accesskey="p" href="faq.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> 924</div> 925</body> 926</html> 927
