<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [
  <!ENTITY kall '<application>Kall</application>'>
  <!ENTITY kapp "&kall;"><!-- replace kall here -->
  <!ENTITY package "kde-module"><!-- kdebase, kdeadmin, etc.  Leave
                                     this unchanged if your
                                     application is not maintained in KDE CVS -->
  <!ENTITY % addindex "IGNORE">
  <!ENTITY % English "INCLUDE"><!-- change language only here -->
  
  
  <!-- Do not define any other entities; instead, use the entities
       from kde-genent.entities and $LANG/user.entities. -->
]>
<!-- kdoctemplate v0.8 October 1 1999 
     Minor update to "Credits and Licenses" section on August 24, 2000
     Removed "Revision history" section on 22 January 2001   -->

<!--
This template was designed by: David Rugge davidrugge@mindspring.com
with lots of help from: Eric Bischoff ebisch@cybercable.tm.fr
and Frederik Fouvry fouvry@sfs.nphil.uni-tuebingen.de
of the KDE DocBook team.

You may freely use this template for writing any sort of KDE documentation.
If you have any changes or improvements, please let us know.

In the future, we may want to change from SGML-based DocBook to XML-based
DocBook. To make this change easier, please be careful :
- in XML, the case of the <tags> and attributes is relevant ;
- also, quote all attributes.

Please don't forget to remove all these comments in your final documentation,
thanks ;-).
-->

<!-- ................................................................ -->

<!-- The language must NOT be changed here. -->

<book lang="&language;">

<!-- This header contains all of the meta-information for the document such
as Authors, publish date, the abstract, and Keywords -->

<bookinfo>
<title>The Kall Handbook</title>

<authorgroup>
<author>
<firstname>Robin</firstname>
<othername>M.</othername>
<surname>Atwood</surname>
<affiliation>
<address><email>robin.atwood@attglobal.net</email></address>
</affiliation>
</author>
</authorgroup>

<!-- TRANS:ROLES_OF_TRANSLATORS -->

<copyright>
<year>2004</year>
<holder></holder>
</copyright>
<!-- Translators: put here the copyright notice of the translation -->
<!-- Put here the FDL notice.  Read the explanation in fdl-notice.docbook 
     and in the FDL itself on how to use it. -->
<legalnotice>&FDLNotice;</legalnotice>

<!-- Date and version information of the documentation
Don't forget to include this last date and this last revision number, we
need them for translation coordination !
Please respect the format of the date (DD/MM/YYYY) and of the version
(V.MM.LL), it could be used by automation scripts.
Do NOT change these in the translation. -->

<date>10/07/2009</date>
<releaseinfo>0.08.00</releaseinfo>

<!-- Abstract about this handbook -->

<abstract>
<para>
Kall is a small application to dial the telephone in your KAddressbook.
It has the ability to localise international format numbers based on your
current country of residence. It also enables the creation of "Kall objects"
on your desktop or start menu to enable quick dialling of important numbers.
</para>
</abstract>

<!-- This is a set of Keywords for indexing by search engines.
Please at least include KDE, the KDE package it is in, the name
 of your application, and a few relevant keywords. -->

<keywordset>
<keyword>KDE</keyword>
<keyword>kdepim</keyword>
<keyword>Kall</keyword>
<keyword>address</keyword>
<keyword>book</keyword>
<keyword>dialler</keyword>
<keyword>dialer</keyword>
</keywordset>

</bookinfo>

<!-- The contents of the documentation begin here.  Label
each chapter so with the id attribute. This is necessary for two reasons: it
allows you to easily reference the chapter from other chapters of your
document, and if there is no ID, the name of the generated HTML files will vary
from time to time making it hard to manage for maintainers and for the CVS
system. Any chapter labelled (OPTIONAL) may be left out at the author's
discretion. Other chapters should not be left out in order to maintain a
consistent documentation style across all KDE apps. -->

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

<!-- The introduction chapter contains a brief introduction for the
application that explains what it does and where to report
problems. Basically a long version of the abstract.  Don't include a
revision history. (see installation appendix comment) -->

<para>
Breakfast in Brussels? Lunch in Luxembourg? Dinner in Dusseldorf? Then Kall
is the application for you! As long as you enter your telephone numbers into
the KAddressbook in international format, Kall can re-format ("localise") them
according to the dialling codes used in your current country of residence.
</para>
<para>
An international format number consists of a character "+" followed by the
country code and the rest of the number. Thus a number in the UK would be "+44 20 7123 4567".
If you are dialling
from anywhere else in the EU this will be localised to "00-44 20 7123 4567" but
if you are actually in the UK the number would become "0-20 7123 4567". As you
move from country to country you simply update the local dialling codes and the
country code in the "Configure Kall..." dialog.

</para>
<para>
Obviously you need a modem to do the dialling and Kall is targeted at the business
traveller with a laptop, but it would be useful in the home office provided you
have an analogue phone system.
</para>
</chapter>

<chapter id="using-kapp">
<title>Using Kall</title>
<sect1 id="setup">
<title>Set up the Hook-Script</title>
<para>
Kall is now designed to be used with the KDEPIM addressbook. In kaddressbook or
Kontact, select "Settings/Configure Address Book" and under Script-Hooks enter
into the Phone field 'kall --dial "%N"'. Then you can simply click on a telephone 
number. You must of course at least configure the device used by your modem.
</para>
</sect1>
</chapter>


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

<!-- (OPTIONAL, BUT RECOMMENDED) This chapter should list all of the
application windows and their menubar and toolbar commands for easy reference.
Also include any keys that have a special function but have no equivalent in the
menus or toolbars. This may not be necessary for small apps or apps with no tool
or menu bars. -->

<sect1 id="kapp-mainwindow">
<title>The main Kall window</title>
<para></para>

<sect2 id="help-menu">
<title>The Help Menu</title>
<para>
<variablelist>
<varlistentry id="help-contents">
<term><menuchoice>
<guimenu>Help</guimenu>
<guimenuitem>Contents</guimenuitem></menuchoice></term>
<listitem><para>Choose
<menuchoice><guimenu>Help</guimenu><guimenuitem>Contents</guimenuitem></menuchoice>
or click the Help Contents icon to <action>display the help pages</action> for &kall;
which you are right now reading.</para></listitem>
</varlistentry>
<varlistentry id="help-report-bug">
<term><menuchoice>
<guimenu>Help</guimenu>
<guimenuitem>Report Bug</guimenuitem>
</menuchoice></term>
<listitem><para>Choose <guilabel>Report Bug</guilabel> if you believe that you
have discovered a bug in &kall;. A bug reporting window will be shown. Decide how
annoying is the bug, and indicate it on <guilabel>Severity</guilabel>
buttons. The KDE Team welcomes your bug reports, for they contribute
significantly to improving the &kde;.</para>
<para>You can also ask the &kall; authors to add additional features to the
program. Just choose <guilabel>Wishlist</guilabel> as the Severity, and enter
your wish. We are honestly looking forward to receiving your
ideas.</para></listitem>
</varlistentry>
<varlistentry id="help-about-Kall">
<term><menuchoice>
<guimenu>Help</guimenu>
<guimenuitem>About Kall</guimenuitem>
</menuchoice></term>
<listitem><para>Choose <guimenuitem>About Kall</guimenuitem> to
<action>display copyright information</action> about &kall;, and the author
list.</para></listitem>
</varlistentry>
<varlistentry id="help-about-kde">
<term><menuchoice>
<guimenu>Help</guimenu>
<guimenuitem>About KDE</guimenuitem>
</menuchoice></term>
<listitem><para>Choose <guilabel>About KDE</guilabel> to <action>display
copyright information about KDE</action>.</para></listitem>
</varlistentry>
</variablelist>
</para>
</sect2>

</sect1>

<sect1 id="dialdialog">
<title>The Dial Dialog</title>
<para>
After a number is has been selected and the Dial menu item or toolbar icon clicked,
the <guimenu>Dial Dialog</guimenu> is displayed. This shows the number you selected in localised format.
If necessary you may edit it further. There are also two push-buttons.
</para>


<sect2 id="dial-button">
<title>The Dial/Hangup button</title>
<para>
If the number displayed is correct click the <guibutton>Dial</guibutton> button. The button will be disabled and you
will hear the modem start to dial. Once the dial command has been processed by the modem the
button will be enabled again and its name changed to <guibutton>Hangup</guibutton>. When you hear the ringing tone
or any other tone from the remote telephone, pickup your handset and click on <guibutton>Hangup</guibutton>. This will
put the modem back "on-hook" and you now be able to use the handset as usual.
</para>
<para>
In principle, if the remote telephone is busy this will be detected and Kall will wait for a
pre-configured time before re-trying. The number of retries is also configurable.
</para>
</sect2>

<sect2 id="cancel-button">
<title>The Cancel button</title>
<para>
At any stage you can click the <guibutton>Cancel</guibutton> button and return to the main window. Any modem
operations will be cleaned up first.
</para>
</sect2>
</sect1>

<sect1 id="status-dialog">
<title>The Status Dialog</title>
<para>
After you have hungup the modem and the Dial dialog has disappeared the Status dialog will appear.
This contains a timer to remind you how long you have been chatting (:-)) and a check-box group
to indicate the final status of the call.
</para>
<sect2 id="status-checkbox-group">
<title>The Status Check-box Group</title>
<para>
There is a check-box group where you can specify how the call turned out. The four options are:
<itemizedlist>
<listitem><para>OK - the call connected.</para></listitem>
<listitem><para>Busy - the remote telephone was engaged.</para></listitem>
<listitem><para>No answer - no one was home.</para></listitem>
<listitem><para>Unobtainable - the number was incorrect.</para></listitem>
</itemizedlist>
</para>
</sect2>
<sect2 id="status-ok-button">
<title>The OK button</title>
<para>
When you have finished your call and hungup the handset, click the appropiate check-box
and then click the <guibutton>OK</guibutton> button. The name, number, organisation, time of call,
length of call and final status will be written to the log file.
</para>
</sect2>
<sect2 id="status-cancel-button">
<title>The Cancel button</title>
<para>
At any stage you can click the <guibutton>Cancel</guibutton> button and return to the main window.
No logging will be performed.
</para>
</sect2>
</sect1>

<sect1 id="config-dialog">
<title>The Configuration Dialog</title>
<anchor id="config-help"/>

<sect2 id="modem-settings">
<title>Modem Commands</title>
<para>
These consist of various Hayes AT command set strings. You are strongly advised not to change these unless
you really know what you are doing. Changing some initialisation strings could prevent Kall from working
correctly.
</para>
<para>
<variablelist>
<varlistentry>
<term>Serial Port</term>
<listitem>
<para>
Select the serial port to use. Usually this will be /dev/modem. You must specify the device name as
used by Kppp and any other software that uses the modem, such as HylaFAX or efax. This is because the
UUCP locking protocol is used to make sure only one program can access the serial port at a time.
Failure to do this will result in strange things happening. If you have already configured Kppp, Kall will
use that same serial port by default.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Initialise 1</term>
<listitem>
<para>
The command to reset the modem. Usually <quote>ATZ</quote>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Initialise 2</term>
<listitem>
<para>
The command to set the modem modes of operation. Don't touch this.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Dial</term>
<listitem>
<para>
The command to dial the number. This will usually be <quote>ATDT</quote> but if you are dialling from behind
a PABX switchboard you will need to change this. Assuming the number for an external line is
<quote>9</quote>, the command to use would be <quote>ATDT9W</quote>, or possibly <quote>ATDT9,</quote>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Hangup</term>
<listitem>
<para>
The command to hangup the modem. Usually <quote>ATH0</quote>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect2>

<sect2 id="dial-settings">
<title>Dialling Codes</title>
<para>
These settings must correct for your <emphasis>country of current residence</emphasis>. Kall uses the
<quote>locale</quote> to find the default values for your specified locale, but obviously if you are
on the road you must update them.
</para>
<para>
<variablelist>
<varlistentry>
<term>IDD Prefix</term>
<listitem>
<para>
The local prefix for International Direct Dialling. In the EU this is <quote>00</quote>, in the US
and Canada it is <quote>011</quote>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Long distance prefix</term>
<listitem>
<para>
The prefix used for long distance calls. Anywhere I have ever been this is <quote>0</quote> except
for the US and Canada where it is <quote>1</quote>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Country Code</term>
<listitem>
<para>
The ISO country code for your current location. You will usually find this in the hotel room
telephone information pack.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Maximum retry attempts</term>
<listitem>
<para>
Number of times to retry if the number is busy.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Redial Interval</term>
<listitem>
<para>
Length of time to wait in seconds between retry attempts.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect2>

<sect2 id="browse-dialog">
<title>The Browse Log Dialog</title>
<para>
If you click on the <guiicon>View log</guiicon>
button the Kall Log browse dialog will appear. This simply displays the call log in descending
chronological order.
</para>
</sect2>


</sect1>
</chapter>


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

<!-- (OPTIONAL but recommended) This chapter should include all of the silly
(and not-so-silly) newbie questions that fill up your mailbox. This chapter
should be reserved for BRIEF questions and answers! If one question uses more
than a page or so then it should probably be part of the
"Using this Application" chapter instead. You should use links to
cross-reference questions to the parts of your documentation that answer them.
This is also a great place to provide pointers to other FAQ's if your users
must do some complicated configuration on other programs in order for your
application work. -->

&reporting.bugs;
&updating.documentation;
</chapter>


<chapter id="credits">

<!-- Include credits for the programmers, documentation writers, and
contributors here. The license for your software should then be included below
the credits with a reference to the appropriate license file included in the KDE
distribution. -->

<title>Credits and License</title>

<para>
&kapp;
</para>
<para>
Program copyright 2009 Robin Atwood <email>robin.atwood@attglobal.net</email>
</para>
<para>
Contributors:
</para>

<para>
Documentation copyright 2009 Robin Atwood <email>robin.atwood@attglobal.net</email>
</para>

<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
<para>
Polish translation by Michal Rudolf <email>mrudolf@mercury.ci.uw.edu.pl</email>
</para>
<para>
Spanish translation by Quique <email>quique@sindominio.net</email>
</para>

&underFDL;               <!-- FDL: do not remove. Commercial development should -->
<!-- replace this with their copyright and either remove it or re-set this.-->

<!-- Determine which license your application is licensed under, 
     and delete all the remaining licenses below:

     (NOTE:  All documentation are licensed under the FDL, 
     regardless of what license the application uses) -->

&underGPL;        	 <!-- GPL License -->

</chapter>

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

<sect1 id="getting-kall">
<title>How to obtain Kall</title>

<para>
&kall; is a contributed KDE application available from
<ulink url="http://kde-apps.org">http://kde-apps.org</ulink>.
</para>
</sect1>

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

<!--
List any special requirements for your application here. This should include:
.Libraries or other software that is not included in kdesupport,
kdelibs, or kdebase.
.Hardware requirements like amount of RAM, disk space, graphics card
capabilities, screen resolution, special expansion cards, etc.
.Operating systems the app will run on. If your app is designed only for a
specific OS, (you wrote a graphical LILO configurator for example) put this
information here.
-->

<para>
In order to successfully use &kall;, you need KDE 4.2+. The KDEPIM package must be installed
and KAddressbook used to build a contact list.
</para>

<para>
A modem is also required. ;-)
</para>

<!-- For a list of updates, you may refer to the application web site
or the ChangeLog file, or ... -->
</sect1>

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

<para>
In order to compile and install Kall on your system, type the following in the base
directory of the Kall distribution:
<screen width="40">
<prompt>%</prompt> <userinput>mkdir build</userinput>
<prompt>%</prompt> <userinput>cd build</userinput>
<prompt>%</prompt> <userinput>cmake -DCMAKE_INSTALL_PREFIX=$KDEDIR ..</userinput>
<prompt>%</prompt> <userinput>make</userinput>
<prompt>%</prompt> <userinput>make install</userinput>
</screen>
</para>


</sect1>


</appendix>

&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:
-->













