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

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>Understanding The AutoIndex Workflow</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="script_ref.html" title="Script File (.idx) Reference">
  10 <link rel="next" href="xml.html" title="XML Handling">
  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="script_ref.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="xml.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.workflow"></a><a class="link" href="workflow.html" title="Understanding The AutoIndex Workflow">Understanding The AutoIndex Workflow</a>
  28 </h2></div></div></div>
  29 <div class="orderedlist"><ol class="orderedlist" type="1">
  30 <li class="listitem">
  31           Load the script file (usually index.idx) and process it one line at a time,
  32           producing one or more index term per (non-comment) line.
  33         </li>
  34 <li class="listitem">
  35           Reading all lines builds a list of <span class="emphasis"><em>terms to index</em></span>.
  36           Some of those may be terms defined (by you) directly in the script file,
  37           others may be terms found by scanning C++ header and source files that
  38           were specified by the <span class="emphasis"><em>!scan-path</em></span> directive.
  39         </li>
  40 <li class="listitem">
  41           Once the complete list of <span class="emphasis"><em>terms to index</em></span> is complete,
  42           it loads the Docbook XML file. (If this comes from Quickbook/Doxygen/Boostbook/Docbook
  43           then this is the complete documentation after conversion to Docbook format).
  44         </li>
  45 <li class="listitem">
  46           AutoIndex builds an internal <a href="http://en.wikipedia.org/wiki/Document_Object_Model" target="_top">Document
  47           Object Model (DOM)</a> of the Docbook XML. This internal representation
  48           then gets scanned for occurrences of the <span class="emphasis"><em>terms to index</em></span>.
  49           This scanning works at the XML paragraph level (or equivalent sibling such
  50           as a table or code block) - so all the XML encoding within a paragraph
  51           gets flattened to plain text.<br> This flattening means the regular expressions
  52           used to search for <span class="emphasis"><em>terms to index</em></span> can find anything
  53           that is completely contained within a paragraph (or code block etc).
  54         </li>
  55 <li class="listitem">
  56           For each term found then an <span class="emphasis"><em>indexterm</em></span> Docbook element
  57           is inserted into the <a href="http://en.wikipedia.org/wiki/Document_Object_Model" target="_top">Document
  58           Object Model (DOM)</a> (provided internal index generation is off),
  59         </li>
  60 <li class="listitem">
  61           Also the AutoIndex's internal index representation gets updated.
  62         </li>
  63 <li class="listitem">
  64           Once the whole XML document has been indexed, then, if AutoIndex has been
  65           instructed to generate the index itself, it creates the necessary XML and
  66           inserts this into the <a href="http://en.wikipedia.org/wiki/Document_Object_Model" target="_top">Document
  67           Object Model (DOM)</a>.
  68         </li>
  69 <li class="listitem">
  70           Finally the whole <a href="http://en.wikipedia.org/wiki/Document_Object_Model" target="_top">Document
  71           Object Model (DOM)</a> is written out as a new Docbook XML file, and
  72           normal processing of this continues via the XSL stylesheets (with xsltproc)
  73           to actually build the final human-readable docs.
  74         </li>
  75 </ol></div>
  76 </div>
  77 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  78 <td align="left"></td>
  79 <td align="right"><div class="copyright-footer">Copyright &#169; 2008, 2011 John Maddock<p>
  80         Distributed under the Boost Software License, Version 1.0. (See accompanying
  81         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>)
  82       </p>
  83 </div></td>
  84 </tr></table>
  85 <hr>
  86 <div class="spirit-nav">
  87 <a accesskey="p" href="script_ref.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="xml.html"><img src="../../../../../doc/src/images/next.png" alt="Next"></a>
  88 </div>
  89 </body>
  90 </html>