projects / ceph.git / blame
| 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 Quick Reference | |
| 11 | [quickbook 1.6] | |
| 12 | [compatibility-mode 1.5] | |
| 13 | [id quickbook.ref] | |
| 14 | [source-mode teletype] | |
| 15 | ] | |
| 16 | ||
| 17 | [teletype] | |
| 18 | ||
| 19 | [template ordered_list_sample[] | |
| 20 | ``` | |
| 21 | # one | |
| 22 | # two | |
| 23 | # three | |
| 24 | ``` | |
| 25 | ] | |
| 26 | ||
| 27 | [template unordered_list_sample[] | |
| 28 | ``` | |
| 29 | * one | |
| 30 | * two | |
| 31 | * three | |
| 32 | ``` | |
| 33 | ] | |
| 34 | ||
| 35 | [template table_sample[] | |
| 36 | ``` | |
| 37 | [table Title | |
| 38 | [[a][b][c]] | |
| 39 | [[a][b][c]] | |
| 40 | ] | |
| 41 | ``` | |
| 42 | ] | |
| 43 | ||
| 44 | [template var_list_sample[] | |
| 45 | ``` | |
| 46 | [variablelist Title | |
| 47 | [[a][b]] | |
| 48 | [[a][b]] | |
| 49 | ] | |
| 50 | ``` | |
| 51 | ] | |
| 52 | ||
| 53 | ||
| 54 | [table Syntax Compendium | |
| 55 | [[To do this...] [Use this...] [See this...]] | |
| 56 | [[comment] [`[/ some comment]`] [__comments__]] | |
| 57 | [[['italics]] [`['italics] or /italics/`] [__font_styles__ and __simple_formatting__]] | |
| 58 | [[[*bold]] [`[*bold] or *bold*`] [__font_styles__ and __simple_formatting__]] | |
| 59 | [[[_underline]] [`[_underline] or _underline_`] [__font_styles__ and __simple_formatting__]] | |
| 60 | [[[^teletype]] [`[^teletype] or =teletype=`] [__font_styles__ and __simple_formatting__]] | |
| 61 | [[[-strikethrough]] [`[-strikethrough]`] [__font_styles__ and __simple_formatting__]] | |
| 62 | [[[~replaceable]] [`[~replaceable]`] [__replaceable__]] | |
| 63 | [[source mode] [`[c++]` or `[python]`] [__source_mode__]] | |
| 64 | [[inline code] [[^'''`int main();`''']] [__inline_code__]] | |
| 65 | [[code block] [[^'''``int main();``''']] [__code__]] | |
| 66 | [[code escape] [[^'''``from c++ to QuickBook``''']] [__escape_back__]] | |
| 67 | [[line break] [`[br] or \n`] [__line_break__ *DEPRECATED*]] | |
| 68 | [[anchor] [`[#anchor]`] [__anchors__]] | |
| 69 | [[link] [`[@http://www.boost.org Boost]`] [__links__]] | |
| 70 | [[anchor link] [`[link section.anchor Link text]`] [__anchor_links__]] | |
| 71 | [[refentry link] [`[link xml.refentry Link text]`] [__refentry_links__]] | |
| 72 | [[function link] [`[funcref fully::qualified::function_name Link text]`] [__code_links__]] | |
| 73 | [[class link] [`[classref fully::qualified::class_name Link text]`] [__code_links__]] | |
| 74 | [[member link] [`[memberref fully::qualified::member_name Link text]`] [__code_links__]] | |
| 75 | [[enum link] [`[enumref fully::qualified::enum_name Link text]`] [__code_links__]] | |
| 76 | [[macro link] [`[macroref MACRO_NAME Link text]`] [__code_links__]] | |
| 77 | [[concept link] [`[conceptref ConceptName Link text]`] [__code_links__]] | |
| 78 | [[header link] [`[headerref path/to/header.hpp Link text]`] [__code_links__]] | |
| 79 | [[global link] [`[globalref fully::qualified::global Link text]`] [__code_links__]] | |
| 80 | [[escape] [`'''escaped text (no processing/formatting)'''`] [__escape__]] | |
| 81 | [[single char escape] [`\c`] [__single_char_escape__]] | |
| 82 | [[images] [`[$image.jpg]`] [__images__]] | |
| 83 | [[begin section] [`[section The Section Title]`] [__section__]] | |
| 84 | [[end section] [`[endsect]`] [__section__]] | |
| 85 | [[paragraph] [No markup. Paragraphs start left-flushed and are terminated by two or more newlines.] [__paragraphs__]] | |
| 86 | [[ordered list] [[ordered_list_sample]] [__ordered_lists__]] | |
| 87 | [[unordered list] [[unordered_list_sample]] [__unordered_lists__]] | |
| 88 | [[code] [No markup. Preformatted code starts with a space or a tab.] [__code__]] | |
| 89 | [[preformatted] [`[pre preformatted]`] [__preformatted__]] | |
| 90 | [[block quote] [`[:sometext...]`] [__blockquote__]] | |
| 91 | [[heading 1] [`[h1 Heading 1]`] [__heading__]] | |
| 92 | [[heading 2] [`[h2 Heading 2]`] [__heading__]] | |
| 93 | [[heading 3] [`[h3 Heading 3]`] [__heading__]] | |
| 94 | [[heading 4] [`[h4 Heading 4]`] [__heading__]] | |
| 95 | [[heading 5] [`[h5 Heading 5]`] [__heading__]] | |
| 96 | [[heading 6] [`[h6 Heading 6]`] [__heading__]] | |
| 97 | [[macro] [`[def macro_identifier some text]`] [__macros__]] | |
| 98 | [[template] [`[template[a b] [a] body [b]]`] [__templates__]] | |
| 99 | [[blurb] [`[blurb advertisement or note...]`] [__blurbs__]] | |
| 100 | [[admonition] [`[warning Warning text...]`] [__admonitions__]] | |
| 101 | [[table] [[table_sample]] [__tables__]] | |
| 102 | [[variablelist] [[var_list_sample]] [__variable_lists__]] | |
| 103 | [[include] [`[include someother.qbk]`] [__include__]] | |
| 104 | [[conditional generation] | |
| 105 | [`[? symbol phrase]`] [__cond__]] | |
| 106 | ] |