mirror of
https://github.com/boostorg/auto_index.git
synced 2025-05-11 13:34:10 +00:00
94ef1c7ab6
Merged with John Maddock's additions 27 Jan, hopefully without causing trouble. See also pdf version. [SVN r68534]
59 lines
3.1 KiB
HTML
59 lines
3.1 KiB
HTML
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
|
|
<title>XML Handling</title>
|
|
<link rel="stylesheet" href="../boostbook.css" type="text/css">
|
|
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
|
|
<link rel="home" href="../index.html" title="AutoIndex">
|
|
<link rel="up" href="../index.html" title="AutoIndex">
|
|
<link rel="prev" href="script_ref.html" title="Script File Reference">
|
|
<link rel="next" href="comm_ref.html" title="Command Line Reference">
|
|
</head>
|
|
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
<table cellpadding="2" width="100%"><tr><td valign="top"></td></tr></table>
|
|
<hr>
|
|
<div class="spirit-nav">
|
|
<a accesskey="p" href="script_ref.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="comm_ref.html"><img src="../images/next.png" alt="Next"></a>
|
|
</div>
|
|
<div class="section" lang="en">
|
|
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
|
|
<a name="autoindex.xml"></a><a class="link" href="xml.html" title="XML Handling">XML Handling</a>
|
|
</h2></div></div></div>
|
|
<p>
|
|
Auto-index is rather simplistic in its handling of XML:
|
|
</p>
|
|
<div class="itemizedlist"><ul type="disc">
|
|
<li>
|
|
When indexing a document, all block content at the paragraph level gets
|
|
collapsed into a single string for matching against the regular expressions
|
|
representing each index term. In other words, for the most part, you can
|
|
assume that you're indexing plain text when writing regular expressions.
|
|
</li>
|
|
<li>
|
|
Named XML entities for &, ", ', < or > are converted to
|
|
their corresponding characters before indexing a section of text. However,
|
|
decimal or hex escape sequences are not currently converted.
|
|
</li>
|
|
<li>
|
|
Index terms are assumed to be plain text (whether they originate from the
|
|
script file or from scanning source files) and the characters &, ",
|
|
< and > will be escaped to &amp; &quot; &lt; and &gt;
|
|
respectively.
|
|
</li>
|
|
</ul></div>
|
|
</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 © 2008 , 2011 John Maddock<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="script_ref.html"><img src="../images/prev.png" alt="Prev"></a><a accesskey="u" href="../index.html"><img src="../images/up.png" alt="Up"></a><a accesskey="h" href="../index.html"><img src="../images/home.png" alt="Home"></a><a accesskey="n" href="comm_ref.html"><img src="../images/next.png" alt="Next"></a>
|
|
</div>
|
|
</body>
|
|
</html>
|