doc/html/boostbook/dtd/source.html

   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=US-ASCII">
   5 <title>BoostBook element source</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="../../reference.html" title="Reference">
  10 <link rel="prev" href="template-varargs.html" title="BoostBook element template-varargs">
  11 <link rel="next" href="function.html" title="BoostBook element function">
  12 </head>
  13 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  14 <table cellpadding="2" width="100%"><tr>
  15 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../boost.png"></td>
  16 <td align="center"><a href="../../../../index.html">Home</a></td>
  17 <td align="center"><a href="../../../../libs/libraries.htm">Libraries</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  19 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  20 <td align="center"><a href="../../../../more/index.htm">More</a></td>
  21 </tr></table>
  22 <hr>
  23 <div class="spirit-nav">
  24 <a accesskey="p" href="template-varargs.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.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="function.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  25 </div>
  26 <div class="refentry">
  27 <a name="boostbook.dtd.source"></a><div class="titlepage"></div>
  28 <div class="refnamediv">
  29 <h2><span class="refentrytitle">
  30           BoostBook element <code class="sgmltag-element">source</code></span></h2>
  31 <p>source &#8212; Defines source code for a test</p>
  32 </div>
  33 <h2 xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv-title">Synopsis</h2>
  34 <div xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="refsynopsisdiv">source ::=
  35   (#PCDATA| <a class="link" href="snippet.html" title="BoostBook element snippet">snippet</a>)*
  36 </div>
  37 <div class="refsection">
  38 <a name="idp635297824"></a><h2>Description</h2>
  39 <p>This element will contain the source code for a testcase that
  40   will be generated from the documentation. To reduce the amount of escaping in the text, it is recommended to use CDATA sections, which look like this:
  41
  42     </p>
  43 <pre class="programlisting">&lt;![CDATA[
  44 &lt;your program text here: no escaping needed!&gt;
  45 ]]&gt;</pre>
  46 <p>
  47   </p>
  48 <p>In addition to CDATA sections, code snippets can be pulled in
  49   from <code class="sgmltag-element">programlisting</code> elements using the <a class="link" href="snippet.html" title="BoostBook element snippet"><code class="sgmltag-element">snippet</code></a>
  50   element.</p>
  51 </div>
  52 </div>
  53 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  54 <td align="left"></td>
  55 <td align="right"><div class="copyright-footer">Copyright &#169; 2003-2005 Douglas Gregor<p>Distributed under the Boost Software License, Version 1.0.
  56       (See accompanying file LICENSE_1_0.txt or copy at
  57       <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>).
  58       </p>
  59 </div></td>
  60 </tr></table>
  61 <hr>
  62 <div class="spirit-nav">
  63 <a accesskey="p" href="template-varargs.html"><img src="../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../../reference.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="function.html"><img src="../../../../doc/src/images/next.png" alt="Next"></a>
  64 </div>
  65 </body>
  66 </html>