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

<book lang="&language;">

<bookinfo>
<title>The &kab; Handbook</title>

<authorgroup>
<author>
<firstname>Mirko</firstname>
<surname>Boehm</surname>
<affiliation>
<address><email>mirko@kde.org</email></address>
</affiliation>
</author>

<author>
<firstname>Pam</firstname>
<surname>Roberts</surname>
<affiliation>
<address><email>pam.roberts@btinternet.com</email></address>
</affiliation>
</author>

</authorgroup>

<copyright>
<year>2001</year>
<holder>Mirko Boehm, Pam Roberts</holder>
</copyright>

<legalnotice>&FDLNotice;</legalnotice>

<date>24/01/2001</date>
<releaseinfo>2.1.0</releaseinfo>

<abstract><para>&kab; is a simple address book for &kde;.</para>
</abstract>

<keywordset>
<keyword>KDE</keyword>
<keyword>Kab</keyword>
<keyword>kdeutils</keyword>
<keyword>address book</keyword>
</keywordset>

</bookinfo>

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

<para>&kab; is an address book for use with &kde; that lets you save names,
postal, email, talk and <acronym>www</acronym> addresses, telaphone numbers,
important dates and other information in a card index form.</para>

<para>&kab; has two basic views, <guimenuitem>Business Card</guimenuitem> and
<guimenuitem>Editing</guimenuitem>. You can switch between them with the
<guimenu>View</guimenu> menu.</para>

<sect1 id="kabcard">
<title><guimenuitem>Business Card</guimenuitem> View</title>

<screenshot>
<screeninfo>Here's a screenshot of &kab;</screeninfo>
<mediaobject>
  <imageobject>
    <imagedata fileref="kab-using.png" format="PNG">
  </imageobject>
  <textobject>
    <phrase>&kab; in card view mode</phrase>
  </textobject>
</mediaobject>
</screenshot>

<para>This view lets you see what information has been stored for each entry
in &kab;'s database</para>

<para>To select a particular entry you can pick it from the Drop Down box in the
Toolbar, or you can step through the entries using the <guiicon>large
Toolbar arrows</guiicon> or with your keyboard arrow keys.</para>

<para>You can also search the database for a particular entry by using the
<link
linkend="kab-edit-menu"><menuchoice><guimenu>Edit</guimenu><guimenuitem>Search
entries</guimenuitem></menuchoice></link> option.</para>

<para>At the top of the main card area you can see the name as it appears in the
Toolbar Drop Down box list, and possibly an important date such as the person's
Birthday.</para>

<para>An address will be shown in the middle of the card. &kab; lets you enter
more than one address, for - say - Home, Work and Holiday Dacha. The Drop Down
box above the address then lets you select which of these is displayed.</para>

<para>The bottom of the card shows email addresses, <acronym>URL</acronym>s and
telephone numbers. Left click on the email address to send an email, on the
<acronym>URL</acronym> to open a browser window. If you have entered more than
one email address or <acronym>URL</acronym>, then only one will be displayed on
the card followed by [..] and when you click on it a little dialog box will
appear so that you can choose the address you want.</para>

<para>The <link linkend="kab-file-menu"><guimenu>File</guimenu> menu</link> has
options allowing you to create and use more than one database, import your old
KDE 1 address book, print one or all entries, and export the database in
<acronym>HTML</acronym> format.</para> </sect1>

<sect1 id="kab-edit">
<title><guimenuitem>Editing</guimenuitem> View</title>

<screenshot>
<screeninfo>Here's another screenshot of &kab;</screeninfo>
<mediaobject>
  <imageobject>
    <imagedata fileref="kab-edit.png" format="png">
  </imageobject>
  <textobject>
    <phrase>&kab; in edit view mode</phrase>
  </textobject>
</mediaobject>
</screenshot>

<para>This view is used to add or change the details for a card. It has four tab
pages; <guilabel>Person</guilabel>, <guilabel>Telephone</guilabel>,
<guilabel>Address</guilabel> and <guilabel>Birthday</guilabel>.</para>

<para>The <guilabel>Person</guilabel> tab page is where you enter the person's
name and Email and Talk addresses and any associated
<acronym>URL</acronym>s. Whatever you enter in the <guilabel>Formatted
name:</guilabel> text box will appear as the entry's name in the Toolbar Drop
Down list and at the top left of the card. If you do not enter anything in the
<guilabel>Formatted name:</guilabel> text tox then &kab; will automatically
generate a formatted name such as <quote>Holmes, Sherlock</quote>.</para>

<para>The <guilabel>Telephone</guilabel> tab page is, obviously, where you enter
the telephone number(s).</para>

<para>The <guilabel>Addresses</guilabel> tab page lets you enter one or more
addresses for this entry.</para>

<procedure>
<step><para>For each address you want to enter, click on the
<guibutton>Add</guibutton> button. It will display a drop down list with one
blank entry plus any address types you have set up with the
<menuchoice><guimenu>Edit</guimenu><guimenuitem>Configure this
file...</guimenuitem></menuchoice> option. Choose one and it will appear in the
<guilabel>Headline:</guilabel> text box where you can edit it if
required.</para></step>
<step><para>Then fill in the address details.</para></step>
<step><para>Pressing the <guibutton>Insinuation...</guibutton> button brings up
another dialog box where you can enter details of any organisation that the
person works for and his position within it. However, the current version of
&kab; does not display this information in the <guimenuitem>Business
Card</guimenuitem> view. </para></step>
</procedure>

<para>The <guilabel>Birthday</guilabel> tab page is where you select a
significant date to appear at the top right of the card view. It will
only appear if you have checked the <guilabel>I know this persons
birthday:</guilabel> box.</para>

<note><para>You will probably need to experiment with your entries in the
<guilabel>Person</guilabel> and <guilabel>Addresses</guilabel> tab pages to get
the kind of result you want in the Card view.</para></note>

</sect1>

</chapter>

<chapter id="commands">
<title>Command Reference</title>

<sect1 id="kab-menubar">
<title>The Menubar</title>

<sect2 id="kab-file-menu">
<title>The <guimenu>File</guimenu> Menu</title>

<variablelist>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>N</keycap></keycombo>
</shortcut>
<guimenu><accel>F</accel>ile</guimenu>
<guimenuitem><accel>C</accel>reate new database</guimenuitem>
</menuchoice></term>
<listitem><para>Use this if you want to create another &kab;
address book database so that you can keep separate address books
for, say, business and personal contacts.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>O</keycap></keycombo>
</shortcut>
<guimenu><accel>F</accel>ile</guimenu>
<guimenuitem><accel>O</accel>pen...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Open</action> a &kab; database. This menu choice is used to open
a new address book that you have created.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>F</accel>ile</guimenu>
<guimenuitem>Open default <accel>d</accel>atabase</guimenuitem>
</menuchoice></term>
<listitem><para><action>Opens the default</action> &kab; database.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>S</keycap></keycombo>
</shortcut>
<guimenu><accel>F</accel>ile</guimenu>
<guimenuitem><accel>S</accel>ave</guimenuitem>
</menuchoice></term>
<listitem><para><action>Save</action> the current &kab; database.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>F</accel>ile</guimenu>
<guimenuitem><accel>I</accel>mport</guimenuitem>
</menuchoice></term>
<listitem><para>Lets you <action>import an address book</action> generated by
version 1 of &kab;, changing its format to that used by version 2, and
saving it with a different name. Doing this does not destroy the original
version 1 address book.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>T</keycap></keycombo>
</shortcut>
<guimenu><accel>F</accel>ile</guimenu>
<guisubmenu><accel>P</accel>rint</guisubmenu>
<guimenuitem>Print entry</guimenuitem>
</menuchoice></term>
<listitem><para>To print out all details of the current entry.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>E</keycap></keycombo>
</shortcut>
<guimenu><accel>F</accel>ile</guimenu>
<guisubmenu><accel>P</accel>rint</guisubmenu>
<guimenuitem>Print entries</guimenuitem>
</menuchoice></term>
<listitem><para>To print out all details of all entries in
the database.</para></listitem> </varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>F</accel>ile</guimenu>
<guimenuitem><accel>E</accel>xport to HTML...</guimenuitem>
</menuchoice></term>
<listitem><para>Export the database in an html form.</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>Quits</action> &kab;.</para></listitem>
</varlistentry>

</variablelist>

</sect2>

<sect2 id="kab-edit-menu">
<title>The <guimenu>Edit</guimenu> Menu</title>

<variablelist>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>A</keycap></keycombo>
</shortcut>
<guimenu><accel>E</accel>dit</guimenu>
<guimenuitem><accel>A</accel>dd entry...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Add a new entry to the address book</action>. This does the same
as using the Toolbar <guiicon>New entry</guiicon>
icon.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>E</keycap></keycombo>
</shortcut>
<guimenu><accel>E</accel>dit</guimenu> <guimenuitem><accel>E</accel>dit
entry...</guimenuitem> </menuchoice></term>
<listitem><para>If you are in Business card view you can use this menu item (or
the Toolbar <guiicon>Edit entry</guiicon> icon) when you want to <action>edit
the current entry</action>, rather than changing to
<guimenuitem>Editing</guimenuitem> view with the
<menuchoice><guimenu>View</guimenu><guimenuitem>Editing</guimenuitem></menuchoice>
menu choice.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>R</keycap></keycombo>
</shortcut>
<guimenu><accel>E</accel>dit</guimenu>
<guimenuitem><accel>R</accel>emove entry</guimenuitem> </menuchoice></term>
<listitem><para>Remove the current entry from the database.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>M</keycap></keycombo>
</shortcut>
<guimenu><accel>E</accel>dit</guimenu>
<guimenuitem>Send an <accel>e</accel>mail.</guimenuitem>
</menuchoice></term>
<listitem><para> Does the same as <mousebutton>left</mousebutton>
clicking on the <guilabel>email:</guilabel> line at the bottom of the Business
card.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>B</keycap></keycombo>
</shortcut>
<guimenu><accel>E</accel>dit</guimenu>
<guimenuitem><accel>B</accel>rowse</guimenuitem>
</menuchoice></term>
<listitem><para><action>Open a browser</action> with the <acronym>URL</acronym> stored for the current &kab; entry.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo><keycap>Ctrl</keycap><keycap>F</keycap></keycombo>
</shortcut>
<guimenu><accel>E</accel>dit</guimenu>
<guimenuitem><accel>S</accel>earch entries</guimenuitem>
</menuchoice></term>
<listitem><para><action>Search the database</action> for a particular
entry.</para></listitem> </varlistentry>


<varlistentry>
<term><menuchoice>
<guimenu><accel>E</accel>dit</guimenu>
<guimenuitem>Enable all <accel>m</accel>essages</guimenuitem>
</menuchoice></term>
<listitem><para>There are some messages that might be accidentally
disabled by the user, such as one at start up informing him how to import his
old KDE 1 addressbook. <action>Selecting this menu item makes all such messages reappear.
</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>E</accel>dit</guimenu>
<guimenuitem><accel>C</accel>onfigure this file...</guimenuitem>
</menuchoice></term>
<listitem><para><action>Lets you configure some parameters of the current
address book</action>. At present the <guilabel>User fields</guilabel> tab page
does not function, but the <guilabel>Address types</guilabel> tab page can be
used to set up default address <guilabel>Headline:</guilabel>
values. </para></listitem>
</varlistentry>


<varlistentry>
<term><menuchoice>
<guimenu><accel>E</accel>dit</guimenu>
<guimenuitem><accel>P</accel>references for the KDE address book...</guimenuitem>
</menuchoice></term>
<listitem><para>Allows you to set up some general &kab;
settings.</para></listitem>
</varlistentry>

</variablelist>

</sect2>

<sect2>
<title>The <guimenu>View</guimenu> Menu</title>

<variablelist>

<varlistentry>
<term><menuchoice>
<guimenu><accel>V</accel>iew</guimenu>
<guimenuitem><accel>B</accel>usiness card</guimenuitem>
</menuchoice></term>
<listitem><para><action>Show the normal card index view.</action></para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>V</accel>iew</guimenu>
<guimenuitem><accel>E</accel>diting</guimenuitem>
</menuchoice></term>
<listitem><para><action>Change</action> the main &kab; window to allow the entry
to be edited. </para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>V</accel>iew</guimenu>
<guimenuitem>Show main toolbar</guimenuitem>
</menuchoice></term>
<listitem><para><action>Show or hide the main
toolbar</action>.</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu><accel>V</accel>iew</guimenu>
<guimenuitem>Show entry navigation toolbar</guimenuitem>
</menuchoice></term>
<listitem><para><action>Show or hide the toolbar
used to navigate through your database</action>.</para></listitem>
</varlistentry>

</variablelist>

</sect2>
</sect1>
</chapter>

<chapter id="faq">
<title>Questions and Answers</title>

<qandaset>

<qandaentry>
<question><para>Where does &kab; store the address book?</para></question>
<answer><para>The default address book database is stored at
<filename>~/.kde/share/apps/kab/addressbook.kab</filename>, any new databases
that you have created will be stored wherever you put them. </para></answer>
</qandaentry>

<qandaentry>
<question><para>What configuration files does &kab; use?</para></question>
<answer><para>The file <filename>~/.kde/share/apps/kab/kab.config</filename>
holds your &kab; <quote>preferences</quote> and the command strings for mail and
talk.</para>
<para><filename>~/.kde/share/config/kabrc</filename> holds general &kab;
appearance parameters and a list of the most recently visited address
books.</para> <para>Don't modify these files unless you really know what you are
doing (and have made a back up).</para>
</answer>
</qandaentry>

</qandaset>

</chapter>

<chapter id="credits">

<title>Credits and License</title>

<para>&kab;</para>
<para>Program copyright 1996-2001 Mirko Boehm
<email>mirko@kde.org</email></para>

<para>Documentation copyright 2001</para>

<itemizedlist>
<listitem><para>Mirko Boehm <email>mirko@kde.org</email></para></listitem>
<listitem><para>Pam Roberts
<email>pam.roberts@btinternet.com</email></para></listitem>
</itemizedlist>

&underFDL;
&underGPL;

</chapter>

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

<para>&kab; is part of the kdeutils package which is an essential part of the
&kde; 2 project.</para>

<para>For details of &kde; visit <ulink
url="http://www.kde.org">http://www.kde.org</ulink>.</para>

<para>Source code for &kab; can be found in the kdeutils package on <ulink
url="ftp://ftp.kde.org/pub/kde/">ftp://ftp.kde.org/pub/kde/</ulink>, the main
ftp site of the &kde; project. </para>

</appendix>

<![ %addindex; [ &kdedocindex; ]]>
</book>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes: nil
sgml-general-insert-case: lower
End:
-->
