runtime/doc/kcontrol/helpindex/index.docbook

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE article PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
   3 "dtd/kdex.dtd" [
   4 <!ENTITY % addindex "IGNORE">
   5 <!ENTITY % English "INCLUDE" > <!-- change language only here -->
   6 ]>
   7
   8 <article lang="&language;">
   9 <articleinfo>
  10
  11 <authorgroup>
  12 <author>&Mike.McBride; &Mike.McBride.mail;</author>
  13 <author>&Jost.Schenck; &Jost.Schenck.mail;</author>
  14
  15 <!-- TRANS:ROLES_OF_TRANSLATORS -->
  16 </authorgroup>
  17
  18 <date>2002-10-17</date>
  19 <releaseinfo>3.1</releaseinfo>
  20
  21 <keywordset>
  22 <keyword>KDE</keyword>
  23 <keyword>KControl</keyword>
  24 <keyword>Help Index</keyword>
  25 <keyword>Index</keyword>
  26 </keywordset>
  27 </articleinfo>
  28
  29 <sect1 id="help-index">
  30
  31 <title>Help Index</title>
  32
  33 <note><para>At the time of writing, for most installations of &kde; the entire search engine function in &khelpcenter; is disabled, and settings made in this &kcontrol; module will have no effect.  We hope to have it back in a future release.</para></note>
  34
  35 <para>&kde; comes with a lot of documentation for applications and
  36 components. While it is possible to just browse the manuals until you
  37 find that piece of information you're looking for, this may be a very
  38 time-consuming task. To make this easier for you, &kde; offers
  39 fulltext search using a program called
  40 <application>ht://dig</application>. It works quite similar to search
  41 engines on the web, in fact some search engines you know might even use
  42 it. Just click on the <guilabel>Search</guilabel> tab in the
  43 &khelpcenter;, enter the word you are looking for, click
  44 <guibutton>Search</guibutton> and enjoy!</para>
  45
  46 <para>However, to make use of this feature,
  47 <application>ht://dig</application> has to be installed on your system
  48 and &kde; has to be configured to make use of it. This control module
  49 tries to help you doing the latter. If you haven't installed
  50 <application>ht://dig</application> and it wasn't shipped with your
  51 operating system you have to get ht://dig yourself. Have a look at
  52 <ulink url="http://www.htdig.org">the ht://dig homepage</ulink> on how
  53 to download and install it.</para>
  54
  55 <para>When you first start, you are in display mode only.  To modify
  56 your settings, click on <guibutton>Administrator Mode</guibutton>.  If
  57 you are logged in as <systemitem class="username">root</systemitem>,
  58 you will go straight to the change dialog.  If not, &kde; will ask for
  59 a superuser password.</para>
  60 <sect2 id="help-index-use">
  61
  62 <title>Use</title>
  63
  64 <para>There are two important things to tell &kde; so it can make use of the
  65 fulltext search engine:</para>
  66
  67 <itemizedlist>
  68 <listitem><para>where to find the <application>ht://dig</application> programs
  69 KDE uses for fulltext search</para></listitem>
  70 <listitem><para>where to search</para></listitem>
  71 </itemizedlist>
  72
  73 <sect3 id="help-index-use-progs">
  74
  75 <title>The <application>ht://dig</application> Programs</title>
  76
  77 <para> There are three programs &kde; needs that come with
  78 <application>ht://dig</application>: <command>htdig</command>,
  79 <command>htsearch</command> and <command>htmerge</command>. For each program you
  80 have to provide the full path including the program name, for example: <filename
  81 class="directory">/usr/bin/htdig</filename>.</para>
  82
  83 <para>Where exactly these programs are installed depends on your operating
  84 system or your distribution. However, there are some good guesses you might want
  85 to try:</para>
  86
  87 <itemizedlist>
  88
  89 <listitem><para><command>htdig</command> and <command>htmerge</command> are
  90 often found in <filename class="directory">/usr/bin/</filename> or in something
  91 like <filename
  92 class="directory">/usr/local/www/htdig/bin/</filename>.</para></listitem>
  93
  94 <listitem><para>the <command>htsearch</command> command is often found in a sub
  95 folder called <filename class="directory">cgi-bin</filename>, for example
  96 <filename class="directory">/usr/local/httpd/cgi-bin/</filename>.</para>
  97
  98 </listitem>
  99 </itemizedlist>
 100
 101 <tip><para>To find out where for example <command>htdig</command> is installed
 102 you can always type <command>whereis htdig</command> on the
 103 console. <command>whereis</command> will look for the specified command in the
 104 standard execution path folders. However, folders like <filename
 105 class="directory">cgi-bin</filename> are often not in the standard execution
 106 path.</para></tip>
 107
 108 </sect3>
 109
 110 <sect3 id="help-index-use-scope">
 111 <title>Scope and Search Paths</title>
 112
 113 <para>In this section you can choose which help resources should be indexed,
 114 &ie; made available to the search engine.</para>
 115
 116 <para>In the <guilabel>Scope</guilabel> frame you can select some
 117 typical resources you want to be indexed, &ie; the &kde; help files,
 118 and the information offered by the <command>man</command> and
 119 <command>info</command> commands. Note that some of those may still be
 120 disabled, which means that support for them has not been added
 121 yet.</para>
 122
 123 <para>Maybe you have additional files you want to access using the
 124 &khelpcenter; fulltext search feature. For example, you might have an
 125 <acronym>HTML</acronym> reference installed in
 126 <filename>/home/jdoe/docs/selfhtml</filename>.  By adding this path to
 127 the list of additional search paths you make this documentation
 128 available to &khelpcenter;'s fulltext search, too. Just click on the
 129 <guibutton>Add</guibutton> button and a file dialog will ask you for
 130 an additional search folder. Select
 131 <filename class="directory">/home/jdoe/docs/selfhtml</filename> and click
 132 <guibutton>OK</guibutton>. To remove an additional search path, just
 133 select it and click <guibutton>Delete</guibutton>.</para>
 134
 135 <important><para>Your changes to the scope and additional search paths
 136 will not take effect if you don't click on the <guibutton>Generate
 137 index</guibutton> button.</para></important>
 138 </sect3>
 139
 140 </sect2>
 141
 142 </sect1>
 143 </article>
 144