generic-library/boost
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
boost/doc/html/quickbook/ref.html

927 lines
23 KiB
HTML
Raw Permalink Normal View History

[DEV] add v1.76.0
2021-10-05 21:37:46 +02:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Quick Reference</title>
<link rel="stylesheet" href="../../../doc/src/boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="../index.html" title="The Boost C++ Libraries BoostBook Documentation Subset">
<link rel="up" href="../quickbook.html" title="Chapter 51. Quickbook 1.7">
<link rel="prev" href="faq.html" title="Frequently Asked Questions">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr>
<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../boost.png"></td>
<td align="center"><a href="../../../index.html">Home</a></td>
<td align="center"><a href="../../../libs/libraries.htm">Libraries</a></td>
<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
<td align="center"><a href="../../../more/index.htm">More</a></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
<div class="section">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="quickbook.ref"></a>Quick Reference</h2></div></div></div>
<div class="table">
<a name="quickbook.ref.syntax_compendium"></a><p class="title"><b>Table 51.8. Syntax Compendium</b></p>
<div class="table-contents"><table class="table" summary="Syntax Compendium">
<colgroup>
<col>
<col>
<col>
</colgroup>
<thead><tr>
<th>
<p>
To do this...
</p>
</th>
<th>
<p>
Use this...
</p>
</th>
<th>
<p>
See this...
</p>
</th>
</tr></thead>
<tbody>
<tr>
<td>
<p>
comment
</p>
</td>
<td>
<p>
<code class="computeroutput">[/ some comment]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax.html#quickbook.ref.comments">Comments</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="emphasis"><em>italics</em></span>
</p>
</td>
<td>
<p>
<code class="computeroutput">['italics] or /italics/</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.font_styles">Font Styles</a> and
<a class="link" href="syntax/phrase.html#quickbook.ref.simple_formatting">Simple formatting</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="bold"><strong>bold</strong></span>
</p>
</td>
<td>
<p>
<code class="computeroutput">[*bold] or *bold*</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.font_styles">Font Styles</a> and
<a class="link" href="syntax/phrase.html#quickbook.ref.simple_formatting">Simple formatting</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="underline">underline</span>
</p>
</td>
<td>
<p>
<code class="computeroutput">[_underline] or _underline_</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.font_styles">Font Styles</a> and
<a class="link" href="syntax/phrase.html#quickbook.ref.simple_formatting">Simple formatting</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
<code class="literal">teletype</code>
</p>
</td>
<td>
<p>
<code class="computeroutput">[^teletype] or =teletype=</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.font_styles">Font Styles</a> and
<a class="link" href="syntax/phrase.html#quickbook.ref.simple_formatting">Simple formatting</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
<span class="strikethrough">strikethrough</span>
</p>
</td>
<td>
<p>
<code class="computeroutput">[-strikethrough]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.font_styles">Font Styles</a> and
<a class="link" href="syntax/phrase.html#quickbook.ref.simple_formatting">Simple formatting</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
<em class="replaceable"><code>replaceable</code></em>
</p>
</td>
<td>
<p>
<code class="computeroutput">[~replaceable]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.replaceable">Replaceble</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
source mode
</p>
</td>
<td>
<p>
<code class="computeroutput">[c++]</code> or <code class="computeroutput">[python]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.source_mode">Source Mode</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
inline code
</p>
</td>
<td>
<p>
<code class="literal">`int main();`</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.inline_code">Inline code</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
code block
</p>
</td>
<td>
<p>
<code class="literal">``int main();``</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.code">Code</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
code escape
</p>
</td>
<td>
<p>
<code class="literal">``from c++ to QuickBook``</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.escape_back">Escaping Back To QuickBook</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
line break
</p>
</td>
<td>
<p>
<code class="computeroutput">[br] or \n</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.line_break">line-break</a> <span class="bold"><strong>DEPRECATED</strong></span>
</p>
</td>
</tr>
<tr>
<td>
<p>
anchor
</p>
</td>
<td>
<p>
<code class="computeroutput">[#anchor]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.anchors">Anchors</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
link
</p>
</td>
<td>
<p>
<code class="computeroutput">[@http://www.boost.org Boost]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.links">Links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
anchor link
</p>
</td>
<td>
<p>
<code class="computeroutput">[link section.anchor Link text]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.anchor_links">Anchor links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
refentry link
</p>
</td>
<td>
<p>
<code class="computeroutput">[link xml.refentry Link text]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.refentry_links">refentry links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
function link
</p>
</td>
<td>
<p>
<code class="computeroutput">[funcref fully::qualified::function_name Link text]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
class link
</p>
</td>
<td>
<p>
<code class="computeroutput">[classref fully::qualified::class_name Link text]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
member link
</p>
</td>
<td>
<p>
<code class="computeroutput">[memberref fully::qualified::member_name Link text]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
enum link
</p>
</td>
<td>
<p>
<code class="computeroutput">[enumref fully::qualified::enum_name Link text]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
macro link
</p>
</td>
<td>
<p>
<code class="computeroutput">[macroref MACRO_NAME Link text]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
concept link
</p>
</td>
<td>
<p>
<code class="computeroutput">[conceptref ConceptName Link text]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
header link
</p>
</td>
<td>
<p>
<code class="computeroutput">[headerref path/to/header.hpp Link text]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
global link
</p>
</td>
<td>
<p>
<code class="computeroutput">[globalref fully::qualified::global Link text]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.code_links">function, class, member,
enum, macro, concept or header links</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
escape
</p>
</td>
<td>
<p>
<code class="computeroutput">'''escaped text (no processing/formatting)'''</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.escape">Escape</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
single char escape
</p>
</td>
<td>
<p>
<code class="computeroutput">\c</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.single_char_escape">Single char escape</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
images
</p>
</td>
<td>
<p>
<code class="computeroutput">[$image.jpg]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.images">Images</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
begin section
</p>
</td>
<td>
<p>
<code class="computeroutput">[section The Section Title]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/structure.html#quickbook.ref.section">Section</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
end section
</p>
</td>
<td>
<p>
<code class="computeroutput">[endsect]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/structure.html#quickbook.ref.section">Section</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
paragraph
</p>
</td>
<td>
<p>
No markup. Paragraphs start left-flushed and are terminated by two
or more newlines.
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.paragraphs">Paragraphs</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
ordered list
</p>
</td>
<td>
<pre class="programlisting"># one
# two
# three
</pre>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.ordered_lists">Ordered lists</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
unordered list
</p>
</td>
<td>
<pre class="programlisting">* one
* two
* three
</pre>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.unordered_lists">Unordered lists</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
code
</p>
</td>
<td>
<p>
No markup. Preformatted code starts with a space or a tab.
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.code">Code</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
preformatted
</p>
</td>
<td>
<p>
<code class="computeroutput">[pre preformatted]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.preformatted">Preformatted</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
block quote
</p>
</td>
<td>
<p>
<code class="computeroutput">[:sometext...]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.blockquote">Blockquote</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
heading 1
</p>
</td>
<td>
<p>
<code class="computeroutput">[h1 Heading 1]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.headings">Heading</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
heading 2
</p>
</td>
<td>
<p>
<code class="computeroutput">[h2 Heading 2]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.headings">Heading</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
heading 3
</p>
</td>
<td>
<p>
<code class="computeroutput">[h3 Heading 3]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.headings">Heading</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
heading 4
</p>
</td>
<td>
<p>
<code class="computeroutput">[h4 Heading 4]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.headings">Heading</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
heading 5
</p>
</td>
<td>
<p>
<code class="computeroutput">[h5 Heading 5]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.headings">Heading</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
heading 6
</p>
</td>
<td>
<p>
<code class="computeroutput">[h6 Heading 6]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.headings">Heading</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
macro
</p>
</td>
<td>
<p>
<code class="computeroutput">[def macro_identifier some text]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.macros">Macros</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
template
</p>
</td>
<td>
<p>
<code class="computeroutput">[template[a b] [a] body [b]]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.templates">Templates</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
blurb
</p>
</td>
<td>
<p>
<code class="computeroutput">[blurb advertisement or note...]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.blurbs">Blurbs</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
admonition
</p>
</td>
<td>
<p>
<code class="computeroutput">[warning Warning text...]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.admonitions">Admonitions</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
table
</p>
</td>
<td>
<pre class="programlisting">[table Title
[[a][b][c]]
[[a][b][c]]
]
</pre>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.tables">Tables</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
variablelist
</p>
</td>
<td>
<pre class="programlisting">[variablelist Title
[[a][b]]
[[a][b]]
]
</pre>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.variable_lists">Variable Lists</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
include
</p>
</td>
<td>
<p>
<code class="computeroutput">[include someother.qbk]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/block.html#quickbook.ref.include">Include</a>
</p>
</td>
</tr>
<tr>
<td>
<p>
conditional generation
</p>
</td>
<td>
<p>
<code class="computeroutput">[? symbol phrase]</code>
</p>
</td>
<td>
<p>
<a class="link" href="syntax/phrase.html#quickbook.ref.cond">Conditional Generation</a>
</p>
</td>
</tr>
</tbody>
</table></div>
</div>
<br class="table-break">
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright © 2002, 2004, 2006 Joel de Guzman,
Eric Niebler<br>Copyright © 2010-2017 Daniel James<p>
Distributed under the Boost Software License, Version 1.0. (See accompanying
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>)
</p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<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>
</div>
</body>
</html>
Reference in New Issue Copy Permalink