ceph/src/boost/tools/auto_index/doc/html/boost_autoindex/xml.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>XML Handling</title>
   5 <link rel="stylesheet" href="../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.77.1">
   7 <link rel="home" href="../index.html" title="Boost.AutoIndex">
   8 <link rel="up" href="../index.html" title="Boost.AutoIndex">
   9 <link rel="prev" href="workflow.html" title="Understanding The AutoIndex Workflow">
  10 <link rel="next" href="qbk.html" title="Quickbook Support">
  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="workflow.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="qbk.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="boost_autoindex.xml"></a><a class="link" href="xml.html" title="XML Handling">XML Handling</a>
  28 </h2></div></div></div>
  29 <p>
  30       AutoIndex is rather simplistic in its handling of XML:
  31     </p>
  32 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
  33 <li class="listitem">
  34           When indexing a document, all block content at the paragraph level gets
  35           collapsed into a single string for matching against the regular expressions
  36           representing each index term. In other words, for the most part, you can
  37           assume that you're indexing plain text when writing regular expressions.
  38         </li>
  39 <li class="listitem">
  40           Named XML entities for &amp;, ", ', &lt; or &gt; are converted to
  41           their corresponding characters before indexing a section of text. However,
  42           decimal or hex escape sequences are not currently converted.
  43         </li>
  44 <li class="listitem">
  45           Index terms are assumed to be plain text (whether they originate from the
  46           script file or from scanning source files) and the characters &amp;, ",
  47           &lt; and &gt; will be escaped to &amp;amp; &amp;quot; &amp;lt; and &amp;gt;
  48           respectively.
  49         </li>
  50 </ul></div>
  51 </div>
  52 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  53 <td align="left"></td>
  54 <td align="right"><div class="copyright-footer">Copyright &#169; 2008, 2011 John Maddock<p>
  55         Distributed under the Boost Software License, Version 1.0. (See accompanying
  56         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>)
  57       </p>
  58 </div></td>
  59 </tr></table>
  60 <hr>
  61 <div class="spirit-nav">
  62 <a accesskey="p" href="workflow.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="qbk.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  63 </div>
  64 </body>
  65 </html>