<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1-Based Variant V1.0//EN" "dtd/kdex.dtd" [
 <!ENTITY kheisereg "<application>KHeiseReg</application>">
 <!ENTITY kappname "&kheisereg;">
 <!ENTITY eg "<abbrev>e.g.</abbrev>">
 <!ENTITY KDE "<abbrev>KDE</abbrev>">
 <!ENTITY % addindex "IGNORE">
 <!ENTITY % English "INCLUDE">
]>

<book lang="&language;">

<bookinfo>
<title>The &kheisereg; Handbook</title>
<authorgroup>
<author>
<firstname>Oliver</firstname><surname>Gantz</surname>
<affiliation><address><email>Oliver.Gantz@ePost.de</email></address>
</affiliation>
</author>
</authorgroup>

<copyright>
<year>2002</year>
<holder>Oliver Gantz</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

<date>2002-04-08</date>
<releaseinfo>0.2</releaseinfo>

<abstract>
<para>
 This Handbook describes &kheisereg; Version 0.2
</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>KHeiseReg</keyword>
</keywordset>

</bookinfo>

<chapter id="introduction">
<title>Introduction</title>

<para>This is &kheisereg;, a &KDE;-based utility to search articles within the
 Heise register.</para>

<sect1 id="kheisereg-revhistory">
<title>&kheisereg; Revision History</title>
<para>
<itemizedlist>
<listitem><para>
 Version 0.1
 <itemizedlist>
 <listitem><para>Initial public release.</para></listitem>
 </itemizedlist>
</para></listitem>
<listitem><para>
 Version 0.2
 <itemizedlist>
 <listitem><para>Ported &kheisereg; to &KDE; 3.</para></listitem>
 </itemizedlist>
</para></listitem>
</itemizedlist>
</para>
</sect1>
</chapter>

<chapter id="installation">
<title>Installation</title>

<sect1 id="getting-kheisereg">
<title>How to obtain &kheisereg;</title>

<para>You can get the latest version of &kheisereg; from the
<ulink url="http://www.tu-bs.de/~y0000441/kheisereg/index.html">&kheisereg; home page</ulink>.</para>
</sect1>

<sect1 id="requirements">
<title>Requirements</title>

<para>In order to successfully install use &kheisereg;, you need to
 have &KDE; 2 properly installed on your system.</para>

</sect1>

<sect1 id="compilation">
<title>Compilation and installation</title>

<para>In order to compile and install &kheisereg; on your system, type the following in the base
 directory of the &kheisereg; distribution:
<screen width="40">
<prompt>%</prompt> <userinput>./configure</userinput>
<prompt>%</prompt> <userinput>make</userinput>
<prompt>%</prompt> <userinput>make install</userinput>
</screen>
</para>

<para>Since &kheisereg; uses <command>autoconf</command> and <command>automake</command>
 you should have not trouble compiling it.
 If you should run into problems please report them to the author at
 <ulink url="mailto:Oliver.Gantz@epost.de">Oliver Gantz</ulink>.</para>

</sect1>

</chapter>

<chapter id="main-window">
<title>Main Window</title>

<para>The main window is visible as soon as you start &kheisereg;.</para>

<sect1 id="main-dialog-elements">
<title>Dialog Elements</title>

<para>The main window contains a menubar, a toolbar, a list containing the
 found articles, an area with details of an article and a statusbar.</para>

<para>The function of the <guilabel>menubar</guilabel> is explained in the
 <link linkend="main-menu-entries">Menu Entries Section</link>.</para>
<para>The <guilabel>toolbar</guilabel> provides short cuts for some of the menu commands.</para>
<para>The list shows all found articles after a search.</para>
<para>In the window area underneath details of the article are shown that is
 currently selected in the list above.</para>

<para>The <guilabel>statusbar</guilabel> gives you some brief hints of what's going on.</para>

</sect1>

<sect1 id="main-menu-entries">
<title>Menu Entries</title>

<!-- The File Menu -->
<sect2>
<title>The <guimenu>File</guimenu> Menu</title>

<para>
<variablelist>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>A</keycap></keycombo>
</shortcut>
<guimenu><accel>F</accel>ile</guimenu>
<guimenuitem><accel>A</accel>ppend Register File</guimenuitem>
</menuchoice></term>
<listitem><para><action>
 Opens the Append Register File dialog.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>Q</keycap></keycombo>
</shortcut>
<guimenu><accel>F</accel>ile</guimenu>
<guimenuitem><accel>Q</accel>uit</guimenuitem>
</menuchoice></term>
<listitem><para><action>
 Closes &kheisereg;.
</action></para></listitem>
</varlistentry>

</variablelist>
</para>

</sect2>


<!-- The Search Menu -->
<sect2>
<title>The <guimenu>Search</guimenu> Menu</title>

<para>
<variablelist>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>F</keycap></keycombo>
</shortcut>
<guimenu><accel>S</accel>earch</guimenu>
<guimenuitem><accel>F</accel>ind</guimenuitem>
</menuchoice></term>
<listitem><para><action>
 Opens the search dialog.
</action></para></listitem>
</varlistentry>

</variablelist>
</para>

</sect2>


<!-- The Settings Menu -->
<sect2>
<title>The <guimenu>Settings</guimenu> Menu</title>

<para>
<variablelist>
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>T</keycap></keycombo>
</shortcut>
<guimenu><accel>S</accel>ettings</guimenu>
<guimenuitem>Show <accel>T</accel>oolbar</guimenuitem>
</menuchoice></term>
<listitem><para><action>
 Shows or hides the toolbar.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>S</keycap></keycombo>
</shortcut>
<guimenu><accel>S</accel>ettings</guimenu>
<guimenuitem>Show <accel>S</accel>tatusbar</guimenuitem>
</menuchoice></term>
<listitem><para><action>
 Shows or hides the statusbar.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>S</accel>ettings</guimenu>
<guimenuitem>Save <accel>O</accel>ptions</guimenuitem>
</menuchoice></term>
<listitem><para><action>
 Saves the current window options.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>S</accel>ettings</guimenu>
<guimenuitem><accel>C</accel>onfigure KHeiseReg...</guimenuitem>
</menuchoice></term>
<listitem><para><action>
 Opens the Configure Dialog.
</action></para></listitem>
</varlistentry>

</variablelist>
</para>

</sect2>


<!-- The Help Menu -->
<sect2>
<title>The <guimenu>Help</guimenu> Menu</title>

<para>
<variablelist>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycap>F1</keycap>
</shortcut>
<guimenu><accel>H</accel>elp</guimenu>
<guimenuitem><accel>C</accel>ontents</guimenuitem>
</menuchoice></term>
<listitem><para><action>
 Invokes the &KDE; help system with the &kheisereg; help pages displayed.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Shift</keycap><keycap>F1</keycap></keycombo>
</shortcut>
<guimenu><accel>H</accel>elp</guimenu>
<guimenuitem>What's <accel>T</accel>his</guimenuitem>
</menuchoice></term>
<listitem><para><action>
 Displays a short description of dialog elements.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>H</accel>elp</guimenu>
<guimenuitem><accel>R</accel>eport Bug...</guimenuitem>
</menuchoice></term>
<listitem><para><action>
 Create and send a bug report.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>H</accel>elp</guimenu>
<guimenuitem><accel>A</accel>bout KHeiseReg</guimenuitem>
</menuchoice></term>
<listitem><para><action>
 Displays essential information about &kheisereg;.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>H</accel>elp</guimenu>
<guimenuitem>About <accel>K</accel>DE</guimenuitem>
</menuchoice></term>
<listitem><para><action>
 Displays essential information about &KDE;.
</action></para></listitem>
</varlistentry>

</variablelist>
</para>

</sect2>

</sect1>

<sect1 id="main-key-bindings">
<title>Key Bindings</title>

<para>
<variablelist>

<varlistentry>
<term>
<keycombo><keycap>Ctrl</keycap><keycap>A</keycap></keycombo>
</term>
<listitem><para><action>
 Opens the dialog for appending register files.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term>
<keycombo><keycap>Ctrl</keycap><keycap>F</keycap></keycombo>
</term>
<listitem><para><action>
 Opens the Search dialog.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term>
<keycombo><keycap>Ctrl</keycap><keycap>Q</keycap></keycombo>
</term>
<listitem><para><action>
 Closes &kheisereg;.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term>
<keycombo><keycap>Ctrl</keycap><keycap>S</keycap></keycombo>
</term>
<listitem><para><action>
 Switches the statusbar on or off.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term>
<keycombo><keycap>Ctrl</keycap><keycap>T</keycap></keycombo>
</term>
<listitem><para><action>
 Switches the toolbar on or off.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term>
<keycap>F1</keycap>
</term>
<listitem><para><action>
 Displays the &kheisereg; help pages.
</action></para></listitem>
</varlistentry>

</variablelist>
</para>

</sect1>

</chapter>


<chapter id="append-dialog">
<title>Append Register File Dialog</title>
<anchor id="append-help"/>

<para>You can open the Append Register File dialog by choosing the menu command
 <menuchoice><guimenu>File</guimenu><guimenuitem>Append Register File</guimenuitem></menuchoice>.</para>

<para>This dialog shows the state of the internal register data base and provides
 the facility to append additional register files to the data base.</para>

<para>Under <guilabel>Database Status</guilabel> you can see the first and the
 last edition numbers contained in the data base separated by magazines. The
 number of contained articles are also shown.</para>

<para>By pressing the button <guibutton>Append</guibutton> a file open dialog
 opens. With this dialog you can seek and select a register file. The selected
 file is tested to be a valid Heise register file. If it is one and contains
 no magazine editions which are already in the database the file is appended
 to the data base.</para>

</chapter>


<chapter id="search-dialog">
<title>Search Dialog</title>
<anchor id="search-help"/>

<para>You can open the Search dialog by choosing the menu command
 <menuchoice><guimenu>Search</guimenu><guimenuitem>Search</guimenuitem></menuchoice>.</para>

<para>With <guilabel>Bywords</guilabel> you can specify terms to be compared
 with the bywords, titles and subtitles of the articles.</para>

<para>With <guilabel>Authors</guilabel> you can specify the names of authors.</para>

<para>With <guilabel>Editors</guilabel> you can specify tokens of Editors.
 These tokens are up to 3 characters long.</para>

<para>For the specifications at <guilabel>Bywords</guilabel>, <guilabel>Authors</guilabel>
 and <guilabel>Editors</guilabel> the following rules should be considered:</para>

<table>
<title>Rules for search terms</title>
<tgroup cols="2">
<thead>
<row>
<entry>Search term</entry>
<entry>Result</entry>
</row>
</thead>

<tbody>

<row>
<entry><userinput>linux kde</userinput></entry>
<entry>Texts containing the word &quot;linux&quot; <emphasis>or</emphasis>
 &quot;kde&quot;.</entry>
</row>

<row>
<entry><userinput>+linux +kde</userinput></entry>
<entry>Texts containing the word &quot;linux&quot; <emphasis>and</emphasis>
 &quot;kde&quot;.</entry>
</row>

<row>
<entry><userinput>linux -kde</userinput></entry>
<entry>Texts containing the word &quot;linux&quot; <emphasis>but not</emphasis>
 &quot;kde&quot;.</entry>
</row>

<row>
<entry><userinput>linux &quot;kde 2.0&quot;</userinput></entry>
<entry>Texts containing the word &quot;linux&quot; <emphasis>or</emphasis>
 &quot;kde 2.0&quot;.</entry>
</row>

</tbody>
</tgroup>
</table>

<para>With <guilabel>Editions</guilabel> you can specify a list of edition
 numbers separated by blanks.</para>

<para>With <guilabel>Years</guilabel> you can specify a list of year dates
 separated by blanks. Those dates may be specified with 2 or 4 digits.</para>

<para>With <guilabel>Magazines</guilabel> you can select the magazines in which
 the articles should be searched.</para>

<para>If <guilabel>Case sensitive</guilabel> is selected, capitals are
 distinguished from small letters.</para>

<para>If <guilabel>Fuzzy</guilabel> is selected, a fault tolerant search is
 going to be done. You can specify the degree of correlation with the slider
 underneath. A high degree means a low fault tolerance, a low degree means
 a high fault tolerance. A low degree leads to more hits.</para>

</chapter>


<chapter id="configure-dialog">
<title>Configure Dialog</title>
<anchor id="configure-help"/>

<para>You can open the configure dialog by choosing the menu command
 <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure KHeiseReg</guimenuitem></menuchoice>.</para>

<sect1 id="configure-general-page">
<title>General Page</title>

<para>This page provides some general options.</para>
<para><guilabel>Show tooltips</guilabel> enables the tooltips in the dialogs.</para>

</sect1>

<sect1 id="configure-search-page">
<title>Search Page</title>

<para>This page provides the default settings for the search dialog. These
 settings are stored into the search dialog when &kheisereg; is started or
 if you klick the <guibutton>Default</guibutton> button at the search
 dialog.</para>

<para>You can find a detailed description of the particular elements at
 <link linkend="search-dialog">Search Dialog</link>.</para>

</sect1>

</chapter>


<chapter id="legal-information">
<title>Legal Information</title>

<sect1 id="legal-information-license">
<title>License</title>

<para>&kheisereg; - A &KDE;-based utility to search articles within the Heise
 register.</para>

<para>Copyright &copy; 2002 Oliver Gantz <email>Oliver.Gantz@ePost.de</email>.</para>

&underFDL;

&underGPL;

</sect1>

<sect1 id="legal-information-trademarks">
<title>Trademarks</title>

<para>Any trademarks used are the property of their respective owners.</para>

</sect1>

</chapter>

&documentation.index;
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
-->
