<!DOCTYPE book PUBLIC  "-//KDE//DTD DocBook V3.1-Based Variant V1.0//EN" [
 <!ENTITY ksteak   "<application>KSteak</application>">
 <!ENTITY kappname "&ksteak;" -- this only *seems* redundant -->
 <!ENTITY % addindex "IGNORE">
 <!ENTITY % English "INCLUDE">
 <!ENTITY % ents PUBLIC "-//KDE//ENTITIES Application-Variable Entities V1.0//EN">
  %ents;
]>

<book lang="EN">

<bookinfo>
<title>The KSteak Handbook</title>

<authorgroup>
<author>
<firstname>Michael</firstname>
<surname>Heidecke</surname>
<affiliation>
<address><email>heidecke@web.de</email></address>
</affiliation>
</author>


<othercredit role="developer">
<firstname>Michael</firstname>
<surname>Heidecke</surname>
<affiliation>
<address><email>heidecke@web.de</email></address>
</affiliation>
<contrib>Developer and maintainer</contrib>
</othercredit>

<othercredit role="developer">
<firstname>Olaf</firstname>
<surname>Hartig</surname>
<affiliation>
<address><email>olebowle@gmx.de</email></address>
</affiliation>
<contrib>Developer</contrib>
</othercredit>

<othercredit role="translator">
<firstname>Marcus</firstname>
<surname>Gruendler</surname>
<affiliation>
<address><email>runner@tamalin.de</email></address>
</affiliation>
<contrib>Translator of the english documentation</contrib>
</othercredit>
</authorGroup>

<copyright>
<year>2000, 2001</year>
<holder>Michael Heidecke</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<date>14/05/2001</date>
<releaseinfo>0.4.0</releaseinfo>

<abstract><para>&ksteak; is an english - german dictionary for the KDE.</para></abstract>

<keywordset>
<keyword>dictionary</keyword>
<keyword>translator</keyword>
</keywordset>

</bookinfo>

<chapter ID="Introduction"><title>Introduction</title>
<para>&ksteak; is a KDE front-end for steak, an english - german dictionary. It's based on the Gtk-program "xsteak" from Razi Lotfi-Tabrizi (<email>razi@cs.uni-frankfurt.de</email>).</para>
<para>&ksteak; translates a given word or the lastest one in the X-Clipboard. 
Since version 0.2 KSteak can be docked on the KDE-panel. </para>

</chapter>


<chapter ID="Installation"><title>Installation</title>

<Sect1 id="requirements"><title>Requirements</title>
<para>
KSteak requires an installed <application>steak</application>-package.
Steak is available on <ULink URL="http://www.tm.informatik.uni-frankfurt.de/~razi/steak/steak.html">http://www.tm.informatik.uni-frankfurt.de/~razi/steak/steak.html</ULink>. </para>
</Sect1>

<Sect1 id="compilation"><title>Compilation and installation</title>
<para>
In order to compile and install Ksteak on your system, type the following in
the base directory of the Ksteak distribution:
<screen>
<prompt>%</prompt> <userinput>./configure</userinput>
<prompt>%</prompt> <userinput>make</userinput>
<prompt>%</prompt> <userinput>make install</userinput>
</screen>
</para>
<para>
Since Ksteak uses autoconf you should have not trouble
compiling it.
Should you run into problems please report them to the the author at 
<ULink URL="mailto:heidecke@web.de">Michael Heidecke</ULink>.
</para>
</Sect1>
</chapter>

<chapter id="usage"><title>Usage</title>

<Sect1 id="input"><title>Input</title>
<para>
If you type a word into the <guilabel>Search</guilabel> field, the translation will be looked up either in the german or
the english dictionary. If you leave the field empty ksteak will automatically use the last clipboard entry.
So you can easily select a word in another window and call ksteak which translates the selected word.
The use of german "umlauts" is allowed. If you want to translate more than one item, you have to quote these
items with double quotes.
</para>
<para>
The gender of the nouns is handled in the following way:
<VariableList>
<VarListEntry>
<term> {m} </term><ListItem><para> masculin, male </para></ListItem>
</VarListEntry>
<VarListEntry>
<term> {f} </term><ListItem><para> feminin, female </para></ListItem>
</VarListEntry>
<VarListEntry>
<term> {n} </term><ListItem><para> neutrum, neuter </para></ListItem>
</VarListEntry>
<VarListEntry>
<term> {pl} </term><ListItem><para> plural </para></ListItem>
</VarListEntry>
</VariableList>
</para>
<para>
Hint: You can use the letters "f", "m", "n", "pl" in order to search all nouns of the same gender. You should
use the <guilabel>context</guilabel> option in order to find all entries.
</para>
</Sect1>

<Sect1 id="expressions"><title>Regular Expressions</title>
<para>
KSteak accepts regular expressions with the following notation: </para>
<VariableList>
<VarListEntry>
 <term> c </term><ListItem><para> a single letter matching itself </para></ListItem>
</VarListEntry>

<VarListEntry>
 <term> . </term><ListItem><para> a dot matching any letter except line end</para></ListItem>
</VarListEntry>

<VarListEntry>
 <term> \? </term><ListItem><para> the pattern preceding the operator \? may occur 0 or one time</para></ListItem>
</VarListEntry>

<VarListEntry>
 <term> * </term><ListItem><para> the pattern preceding the operator * may occur 0 or more times</para></ListItem>
</VarListEntry>

<VarListEntry>
 <term> \+ </term><ListItem><para> the pattern preceding the operator \+ may occur 1 or more times</para></ListItem>
</VarListEntry>

<VarListEntry>
 <term> \| </term><ListItem><para> arguments combined by operator  \| will be or-concatenated</para></ListItem>
</VarListEntry>

<VarListEntry>
 <term> [letters] </term><ListItem><para> matches all letters; you may specify single letters or ranges of the form
            "begin-end"; the expression matches all letters except the specified ones, if the first
            letter after &lsqb; is a ^.</para></ListItem>
</VarListEntry>

<VarListEntry>
 <term> \( \) </term><ListItem><para> braces are collecting expressions; moreover will the matching text of the
            brace enclosed part of the pattern be marked and can be refered to by the following \N expression
            (tag).</para></ListItem>
</VarListEntry>

<VarListEntry>
<term> \N </term><ListItem><para> refers to the matching text of the pattern which is enclosed by the N-th brace.
                 N must be a number larger than or equal to 2. </para>
                 <para>CAUTION: Such requests put a heavy load on the system!</para></ListItem>
</VarListEntry>

<VarListEntry>
 <term> \ </term><ListItem><para> each speacial character - escaped by a \ (backslash) - can match itself.
            \b matches no letter but the beginning or end of a word.</para></ListItem>
</VarListEntry>

<VarListEntry>
 <term> \B </term><ListItem><para> matches all letters within a word</para></ListItem>
</VarListEntry>

<VarListEntry>
 <term> \w </term><ListItem><para> matches all alphanumeric characters &lsqb;A-Za-z0-9&rsqb;</para></ListItem>
</VarListEntry>

<VarListEntry>
 <term> \W </term><ListItem><para> matches all nonalphanumeric characters &lsqb;^A-Za-z0-9&rsqb;</para></ListItem>
</VarListEntry>
</VariableList>

<para>
The rule of precedence of operators is (ordered by highest to lowest precedence): (, ), ?, *, + and |.
All other operators are of equal precedence as characters are.
</para>
</Sect1>

<Sect1 id="Docking"><title>Docking</title>
<para>
The command <guilabel>File->Dock to Panel</guilabel> minimizes the KSteack window. It will then sit in the docking area of
the KDE panel. In this mode you can use the following functions: </para>
<VariableList>
<VarListEntry>
  <term>left mouse button</term><ListItem><para>  searches the selected word(s)</para></ListItem>
</VarListEntry>
<VarListEntry>
  <term>right mouse button</term><ListItem><para> "Undock" restores the window. "Quit" should be easy to figure out ;-)</para></ListItem>
</VarListEntry>
</VariableList>
<para>
The rest of the program should be selfexplaining... ;-)
</para>
</Sect1>
</chapter>


<chapter id="copyright"><title>Copyright</title>
<para>KSteak</para>
<para>Program Copyright 2000, 2001 Michael Heidecke , heidecke@web.de</para>
<para>Developer</para>
<itemizedlist>
<listitem><para>Michael Heidecke <email>heidecke@web.de</email> Developer and maintainer</para></listitem>
<listitem><para>Olaf Hartig <email>olebowle@gmx.de</email> Developer </para></listitem>
</itemizedlist>
<para>
Dokumentation Copyright 2000, 2001 Michael Heidecke , heidecke@web.de
</para>
<para>Documentation Translators</para>
<itemizedlist>
<listitem><para>Michael Heidecke <email>heidecke@web.de</email> german documentation</para></listitem>
<listitem><para>Marcus Gruendler <email>runner@tamalin.de</email> english documentation</para></listitem>
</itemizedlist>
<para>Special thanks go to the <application>steak</application> Developer, Razi Lotfi-Tabrizi (<email>razi@cs.uni-frankfurt.de</email>).</para>

&underGPL;
&underFDL;


</chapter>

<![ %addindex; [ &kdedocindex; ]]>

</book>

<!--
Local Variables:
mode: sgml
sgml-omittag: nil
sgml-shorttag: t
End:
-->