docs/1.6/indexterms.xml

   1 <?xml version='1.0' encoding='UTF-8'?>\r
   2 <chapter xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude"\r
   3   xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:id="indexterms">\r
   4   <title>Marking Terms for Dynamic Index Creation</title>\r
   5   <info>\r
   6     <abstract>\r
   7       <para>This chapter describes how to mark up terms for generating a dynamic index of Evergreen\r
   8         documentation. </para>\r
   9     </abstract>\r
  10   </info>\r
  11   <section>\r
  12     <title>Marking Terms for Index Entry</title>\r
  13     <simplesect>\r
  14       <title>Overview</title>\r
  15       <para>DocBook supports two methods for generating an index. One is to explicitly create the\r
  16         index. The other is to generate the index when the book is published based on elements\r
  17         included in the text. We use the second approach. </para>\r
  18       <para>Authors are not required to mark up index elements; editors will complete any index\r
  19         tagging not accomplished at the authoring stage.</para>\r
  20     </simplesect>\r
  21     <simplesect>\r
  22       <title>Specifying index entries</title>\r
  23       <para>Index entries are specified by adding <tag class="element">indexterm</tag> elements in\r
  24         the text of the book. An index entry must contain one <tag class="element">primary</tag>\r
  25         element. The value of the <tag class="element">primary</tag> element is the top-level entry\r
  26         that will appear in the generated index.</para>\r
  27       <para>In addition, an <tag class="element">indexterm</tag> element can contain the following\r
  28         optional elements:</para>\r
  29       <itemizedlist>\r
  30         <listitem>\r
  31           <para>One <tag class="element">secondary</tag> element that specifies a second level entry\r
  32             in the generated index.</para>\r
  33         </listitem>\r
  34         <listitem>\r
  35           <para>One <tag class="element">tertiary</tag> element that specifies a third level index\r
  36             entry.</para>\r
  37         </listitem>\r
  38         <listitem>\r
  39           <para>One <tag class="element">see</tag> element that specifies an alternate entry to\r
  40             which the reader is redirected.</para>\r
  41         </listitem>\r
  42         <listitem>\r
  43           <para>One <tag class="element">seealso</tag> element that specifies an additional entry\r
  44             with relevant information.</para>\r
  45         </listitem>\r
  46       </itemizedlist>\r
  47       <para>If you want to mark an <tag class="element">indexterm</tag> and you aren't sure what\r
  48         elements to assign it, use the <tag>primary</tag> element.</para>\r
  49     </simplesect>\r
  50     <simplesect>\r
  51       <title>Example: Marking a Primary Index Term</title>\r
  52       <para>The Open Scalable Request Framework (<indexterm>\r
  53           <primary>OpenSRF</primary>\r
  54         </indexterm>, pronounced 'open surf'), is a stateful, decentralized service architecture\r
  55         that allows developers to create applications for Evergreen with a minimum of knowledge of\r
  56         its structure.</para>\r
  57     </simplesect>\r
  58     <simplesect>\r
  59       <title>Example: Marking a Secondary Index Term</title>\r
  60       <para> Indexed-field weighting, which controls relevance ranking in Evergreen, is configured\r
  61         in the 'weight' column of the <indexterm>\r
  62           <primary>Evergreen Tables</primary>\r
  63           <secondary>config.metabib_field</secondary>\r
  64         </indexterm> table of the Evergreen database.</para>\r
  65     </simplesect>\r
  66     <simplesect>\r
  67       <title>Specifying where the Index is Generated</title>\r
  68       <para>In order for the index to auto-generate, every Evergreen book has an <tag\r
  69           class="emptytag">index</tag> element. The index will be generated in the position that\r
  70         corresponds to the element's location in the book file. The <tag class="emptytag"\r
  71           >index</tag> element follows all other chapters and appendices.</para>\r
  72     </simplesect>\r
  73   </section>\r
  74 </chapter>\r