• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html>
2<head>
3<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4<title>Basic Formatting</title>
5<link rel="stylesheet" href="../../../../doc/src/boostbook.css" type="text/css">
6<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7<link rel="home" href="../index.html" title="Document To Test Formatting">
8<link rel="up" href="../index.html" title="Document To Test Formatting">
9<link rel="prev" href="code_blocks.html" title="Code Blocks">
10<link rel="next" href="blurbs.html" title="Blurbs">
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="code_blocks.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="blurbs.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
24</div>
25<div class="section">
26<div class="titlepage"><div><div><h2 class="title" style="clear: both">
27<a name="document_to_test_formatting.basic_formatting"></a><a class="link" href="basic_formatting.html" title="Basic Formatting">Basic Formatting</a>
28</h2></div></div></div>
29<div class="toc"><dl>
30<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.font_styles">Font
31      Styles</a></span></dt>
32<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.replaceable_text">Replaceable
33      Text</a></span></dt>
34<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.quotations">Quotations</a></span></dt>
35<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.inline_code">Inline
36      Code</a></span></dt>
37<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.links">Links</a></span></dt>
38<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.footnotes">Footnotes</a></span></dt>
39<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.blockquote">Blockquote</a></span></dt>
40<dt><span class="section"><a href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings">Headings</a></span></dt>
41</dl></div>
42<div class="section">
43<div class="titlepage"><div><div><h3 class="title">
44<a name="document_to_test_formatting.basic_formatting.font_styles"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.font_styles" title="Font Styles">Font
45      Styles</a>
46</h3></div></div></div>
47<p>
48        Here we go with some inline formatting: <span class="emphasis"><em>italic</em></span>, <span class="bold"><strong>bold</strong></span>, <span class="underline">underline</span>,
49        <code class="literal">teletype</code>, <span class="strikethrough">strikethrough</span>,
50        we can combine styles as well: <span class="emphasis"><em><span class="bold"><strong>bold italic</strong></span></em></span>,
51        <span class="underline"><code class="literal">teletype with underline</code></span>.
52      </p>
53</div>
54<div class="section">
55<div class="titlepage"><div><div><h3 class="title">
56<a name="document_to_test_formatting.basic_formatting.replaceable_text"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.replaceable_text" title="Replaceable Text">Replaceable
57      Text</a>
58</h3></div></div></div>
59<p>
60        Text that is intended to be user-replaceable is <em class="replaceable"><code>rendered like
61        this</code></em>.
62      </p>
63</div>
64<div class="section">
65<div class="titlepage"><div><div><h3 class="title">
66<a name="document_to_test_formatting.basic_formatting.quotations"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.quotations" title="Quotations">Quotations</a>
67</h3></div></div></div>
68<p>
69        Here we go: <span class="quote">&#8220;<span class="quote">A question that sometimes drives me hazy: am I or are
70        the others crazy?</span>&#8221;</span>--Einstein
71      </p>
72<p>
73        Note the proper left and right quote marks. Also, while you can simply use
74        ordinary quote marks like "quoted", our quotation, above, will
75        generate correct DocBook quotations (e.g. &lt;quote&gt;quoted&lt;/quote&gt;).
76      </p>
77<p>
78        Like all phrase elements, quotations may be nested. Example:
79      </p>
80<p>
81        <span class="quote">&#8220;<span class="quote">Here's the rule for bargains: <span class="quote">&#8216;<span class="quote">Do other men, for they would
82        do you.</span>&#8217;</span> That's the true business precept.</span>&#8221;</span>
83      </p>
84</div>
85<div class="section">
86<div class="titlepage"><div><div><h3 class="title">
87<a name="document_to_test_formatting.basic_formatting.inline_code"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.inline_code" title="Inline Code">Inline
88      Code</a>
89</h3></div></div></div>
90<p>
91        This text has inlined code <code class="computeroutput"><span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> <span class="special">{</span> <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> <span class="special">}</span></code>
92        in it. The code should be syntax highlighted.
93      </p>
94</div>
95<div class="section">
96<div class="titlepage"><div><div><h3 class="title">
97<a name="document_to_test_formatting.basic_formatting.links"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.links" title="Links">Links</a>
98</h3></div></div></div>
99<p>
100        Try this: <a href="http://www.boost.org" target="_top">this is <span class="bold"><strong>boost's</strong></span>
101        website....</a> it should be visible as a link.
102      </p>
103<p>
104        This is <a href="../../../../boost/math/distributions.hpp" target="_top">a link to a header
105        file (boost/math/distributions.hpp)</a>, it should be rewritable and
106        point to the website when built as a PDF.
107      </p>
108<p>
109        This is <a href="../../../../libs/regex/index.html" target="_top">a link to another library's
110        documentation (Boost.Regex)</a>, using the boost: protocol, it should
111        be rewritten to point to the website when building a PDF.
112      </p>
113<p>
114        This is <a href="../../../../libs/regex/index.html" target="_top">a link to another library's
115        documentation (Boost.Regex)</a>, using the boost:/ protocol, it should
116        be rewritten to point to the website when building a PDF.
117      </p>
118<p>
119        This is <a href="../../weighted_tail_quantile.hpp" target="_top">a relative link to a header
120        file within the test source</a>, it should be rewritten to point to the
121        website when building a PDF. Although it might be on the website yet.
122      </p>
123</div>
124<div class="section">
125<div class="titlepage"><div><div><h3 class="title">
126<a name="document_to_test_formatting.basic_formatting.footnotes"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.footnotes" title="Footnotes">Footnotes</a>
127</h3></div></div></div>
128<p>
129        Here's one <sup>[<a name="id769038" href="#ftn.id769038" class="footnote">1</a>]</sup>.
130      </p>
131<p>
132        And here's another <sup>[<a name="id769049" href="#ftn.id769049" class="footnote">2</a>]</sup>.
133      </p>
134</div>
135<div class="section">
136<div class="titlepage"><div><div><h3 class="title">
137<a name="document_to_test_formatting.basic_formatting.blockquote"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.blockquote" title="Blockquote">Blockquote</a>
138</h3></div></div></div>
139<p>
140        Lets indent the next paragraph:
141      </p>
142<div class="blockquote"><blockquote class="blockquote"><p>
143          Here we go!!!
144        </p></blockquote></div>
145</div>
146<div class="section">
147<div class="titlepage"><div><div><h3 class="title">
148<a name="document_to_test_formatting.basic_formatting.headings"></a><a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings" title="Headings">Headings</a>
149</h3></div></div></div>
150<p>
151        Now try rendering some heading styles:
152      </p>
153<a name="document_to_test_formatting.basic_formatting.headings.heading_1"></a><h2>
154<a name="id769109"></a>
155        <a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings.heading_1">Heading
156        1</a>
157      </h2>
158<a name="document_to_test_formatting.basic_formatting.headings.heading_2"></a><h3>
159<a name="id769128"></a>
160        <a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings.heading_2">Heading
161        2</a>
162      </h3>
163<a name="document_to_test_formatting.basic_formatting.headings.heading_3"></a><h4>
164<a name="id769146"></a>
165        <a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings.heading_3">Heading
166        3</a>
167      </h4>
168<a name="document_to_test_formatting.basic_formatting.headings.heading_4"></a><h5>
169<a name="id769165"></a>
170        <a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings.heading_4">Heading
171        4</a>
172      </h5>
173<a name="document_to_test_formatting.basic_formatting.headings.heading_5"></a><h6>
174<a name="id769183"></a>
175        <a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings.heading_5">Heading
176        5</a>
177      </h6>
178<a name="document_to_test_formatting.basic_formatting.headings.heading_6"></a><h4>
179<a name="id769201"></a>
180        <a class="link" href="basic_formatting.html#document_to_test_formatting.basic_formatting.headings.heading_6">Heading
181        6</a>
182      </h4>
183</div>
184<div class="footnotes">
185<br><hr width="100" align="left">
186<div class="footnote"><p><sup>[<a name="ftn.id769038" href="#id769038" class="para">1</a>] </sup>
187          A sample footnote
188        </p></div>
189<div class="footnote"><p><sup>[<a name="ftn.id769049" href="#id769049" class="para">2</a>] </sup>
190          Another sample footnote
191        </p></div>
192</div>
193</div>
194<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
195<td align="left"></td>
196<td align="right"><div class="copyright-footer">Copyright &#169; 2007 John Maddock, Joel de Guzman, Eric Niebler and Matias
197      Capeletto<p>
198        Distributed under the Boost Software License, Version 1.0. (See accompanying
199        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>)
200      </p>
201</div></td>
202</tr></table>
203<hr>
204<div class="spirit-nav">
205<a accesskey="p" href="code_blocks.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.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="blurbs.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
206</div>
207</body>
208</html>
209