Commit 9b3d45ed authored by Burkhard Lück's avatar Burkhard Lück
Browse files

update kontact docbook to kf5, delete kontact-admin docbook + import valid info to kontact docbook

proofread + update
remove kappname + package, not used in kf5
bump date + releaseinfo
remove sect shortcuts, it is in fundamentals
remove obsolete hompage link
fix command line arguments
new screenshots
import valid content from kontact-admin docbook + delete kontact-admin docbook
REVIEW:129629
REVIEW:129561
parent af6d7166
add_subdirectory(kontact)
add_subdirectory(kontact-admin)
########### install files ###############
kdoctools_create_handbook(index.docbook INSTALL_DESTINATION ${KDE_INSTALL_DOCBUNDLEDIR}/en SUBDIR kontact-admin)
install( PROGRAMS kontact-admin.desktop DESTINATION ${KDE_INSTALL_APPDIR} )
<?xml version="1.0" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
"dtd/kdedbx45.dtd" [
<!ENTITY PIM "<acronym>PIM</acronym>">
<!ENTITY kappname "&kontact;">
<!ENTITY package "kdepim">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
]>
<book id="kontact-admin" lang="&language;">
<bookinfo>
<title>The &kappname; Administrator's Guide</title>
<authorgroup>
<author>
<firstname>Allen</firstname>
<surname>Winter</surname>
<affiliation>
<address><email>allen@kdab.net</email></address>
</affiliation>
</author>
</authorgroup>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
<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 (YYYY-MM-DD) and of the version
(V.MM.LL), it could be used by automation scripts.
Do NOT change these in the translation. -->
<date>2009-06-08</date>
<releaseinfo>0.00.03</releaseinfo>
<!-- Abstract about this handbook -->
<abstract><para>This is the administrator's manual for &kappname;,
the integrated solution to your personal information management (&PIM;) needs.
&kappname; combines well-known &kde; applications like &kmail;, &korganizer;
and &kaddressbook; into a single interface to provide easy access to mail,
scheduling, address book and other &PIM; functionality. </para></abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>kdepim</keyword>
<keyword>PIM</keyword>
<keyword>KMail</keyword>
<keyword>KOrganizer</keyword>
<keyword>KAddressBook</keyword>
<keyword>KNotes</keyword>
<keyword>Akregator</keyword>
<keyword>administration</keyword>
<keyword>administer</keyword>
<keyword>email</keyword>
<keyword>calendar</keyword>
<keyword>contact</keyword>
<keyword>administration</keyword>
<keyword>administer</keyword>
<keyword>groupware</keyword>
<keyword>Outlook</keyword>
<keyword>Exchange</keyword>
<keyword>Evolution</keyword>
</keywordset>
</bookinfo>
<!-- Chapter Introduction -->
<chapter id="introduction">
<title>Introduction</title>
<para>
This is the administrator's manual for &kappname;,
the integrated solution to your personal information management (&PIM;) needs.
This document is intended to aid the groupware administrator with typical tasks
needed to setup &kappname; and make it work smoothly in various environments.
</para>
<para>
&kappname; combines well-known &kde; applications like &kmail;, &korganizer;
and &kaddressbook; into a single interface to provide easy access to mail,
scheduling, address book and other &PIM; functionality. </para>
</chapter>
<!-- Chapter Compatibility -->
<chapter id="compat">
<title>Compatibility Issues</title>
<para>
This chapter provides help with how to make &kappname;
communicate effectively with various groupware solutions.
</para>
<sect1 id="compat-outlook">
<title>Outlook and Exchange</title>
<para>
In the &kappname; configuration dialog, under <menuchoice><guimenu>Mail</guimenu>
<guimenuitem>Misc</guimenuitem></menuchoice> on the <guilabel>Invitations</guilabel> page
you will find the following options that will help the user communicate
with Microsoft Outlook(tm) running in a Kolab environment or in a
Microsoft Exchange(tm) environment.
</para>
<variablelist>
<varlistentry>
<term><guilabel>Mangle From:/To: headers in replies to invitations</guilabel></term>
<listitem>
<para>Enable this option to make Microsoft Outlook(tm) understand your answers to invitation replies.</para>
<para>Microsoft Outlook has a number of shortcomings in its implementation of
the iCalendar standard; this option works around one of them. If you
have problems with Outlook users not being able to get your replies,
try setting this option.</para>
<para>Details: When mailing an iCal invitation this makes the message have
the From: header the same as the To: header. It also sets header
X-KMail-Identity to the To:'s UIOD and makes sure the BCC: is blank.
Outlook will only understand the reply if the From: header is
the same as the To: header of the invitation message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Send invitations in the mail body</guilabel></term>
<listitem>
<para>Invitations are normally sent as attachments to a mail. This switch
changes the invitation to be sent in the text of the mail instead;
this is necessary to send invitations and replies to Microsoft Outlook.
But, when you do this, you no longer get descriptive text that mail
programs can read; so, to people who have email programs that do not
understand the invitations, the resulting messages look very odd.
People that have email programs that do understand invitations will
still be able to work with this.</para>
<para>Details: When mailing an iCal invitation this option makes the
message body from the attachment data and sets the Content-Type header
to 'text/calendar; method=something; charset="utf-8"'.</para>
<para>Auto-sending is also turned on so there is no human intervention
required for composing.</para>
<note><para>Encryption and self-signing are disabled.</para></note>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Exchange-compatible invitation naming</guilabel></term>
<listitem>
<para>Microsoft Outlook, when used in combination with a Microsoft Exchange(tm)
server, has a problem understanding standards-compliant groupware email.
Enable this option to send groupware invitations in a way that Microsoft
Exchange(tm) understands. The invitation will be sent as an attachment with name
<filename>ical.ics</filename>.</para>
<para>Details: When mailing an iCal invitation this makes
the message have the subject "(Declined|Tentative|Accepted|Delegated): subject".
The invitation will be sent as an attachment with name <filename>ical.ics</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Outlook compatible invitation reply comments</guilabel></term>
<listitem>
<para>When the user provides comments when responding to invitations, send the
comment in a form that Microsoft Outlook(tm) understands. If this option is not
enabled, the response comments will not be seen in Outlook.</para>
<para>Details: When answering the invitation comments will be sent as a
DESCRIPTION iCal property instead of the COMMENT iCal property
(in violation of RFC2446).</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
</chapter>
<!-- Chapter Behavior -->
<chapter id="behavior">
<title>Behavioral Issues</title>
<para>
This chapter provides instructions on how to make &kappname;
behave more like other groupware clients.
</para>
<sect1 id="behave-composing">
<title>Composing Messages</title>
<para>
Outlook users are accustomed to typing a list of addresses in the To:,
CC: or BCC: fields separated by a semicolon (';') character in addition
to a comma (','). By default, &kappname; only allows the comma as an address
separator character. To also allow the semicolon, change the
<option>AllowSemicolonAsAddressSeparator</option> from false to true
in the installed <filename>share/config.kcfg/kmail.kcfg</filename> file.
</para>
</sect1>
</chapter>
<!-- Chapter RFC Compromises -->
<chapter id="nonrfc">
<title>RFC Compromises</title>
<para>&kappname; is designed to interoperate as well as is possible
with a wide variety of groupware solutions. To that end, we sometimes
make design compromises with respect to the various Internet RFCs
that provide the basis for low-level libraries on which &kappname;
relies heavily.</para>
<note><para>We never knowingly violate any RFC.</para></note>
<para>The following list of RFC compromises is made by &kappname; or
the low-levels libraries used by &kappname;:</para>
<itemizedlist>
<listitem>
<para>
When writing duration values into iCalendar files, &kappname; never
writes the DURATION property in terms of weeks (i.e., 1*DIGIT "W");
instead, the integer number of weeks is always multiplied by 7 and written
in terms of days (i.e. 1*DIGIT "D").
</para>
</listitem>
</itemizedlist>
</chapter>
<!-- Chapter Common Problems -->
<chapter id="common-problems">
<title>Common Problems</title>
<para>
This chapter deals with common problems the administrator is likely to encounter.
</para>
<sect1 id="freebusy">
<title>FreeBusy</title>
<para>
FreeBusy common problems ...
</para>
</sect1>
</chapter>
<!-- Chapter Credits+License -->
<chapter id="credits-and-license">
<title>Credits and License</title>
<para>
Documentation Copyright &copy; 2009 Klarälvdalens Datakonsult AB, a KDAB Group company, <email>info@kdab.net</email>
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL; <!-- FDL: do not remove -->
&underGPL; <!-- GPL License -->
</chapter>
<appendix id="installation">
<title>Installation</title>
<sect1 id="getting-kapp">
<title>How to obtain &kappname;</title>
&install.intro.documentation;
</sect1>
<sect1 id="compilation">
<title>Compilation and Installation</title>
<!-- This entity contains the boilerplate text for standard -->
<!-- compilation instructions. If your application requires any -->
<!-- special handling, remove it, and replace with your own text. -->
&install.compile.documentation;
</sect1>
</appendix>
&documentation.index;
</book>
<!--
Local Variables:
mode: xml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
End:
vim:tabstop=2:shiftwidth=2:expandtab
kate: space-indent on; indent-width 2; tab-width 2; indent-mode none;
-->
[Desktop Entry]
Name=Kontact Administration
Name[bs]=Upravljanje kontaktima
Name[ca]=Administració del Kontact
Name[ca@valencia]=Administració del Kontact
Name[cs]=Správa Kontactu
Name[da]=Administration af Kontact
Name[de]=Kontact-Verwaltung
Name[el]=Διαχείριση του Kontact
Name[en_GB]=Kontact Administration
Name[es]=Administración de Kontact
Name[et]=Kontacti haldur
Name[fi]=Kontactin hallinta
Name[fr]=Administration de Kontact
Name[ga]=Riarachán Kontact
Name[gl]=Administración do Akonadi
Name[hu]=Kontact adminisztráció
Name[ia]=Administration de Kontact
Name[it]=Gestione di Kontact
Name[ja]=Kontact の管理
Name[kk]=Kontact-ты әкімшілік ету
Name[km]=ការ​គ្រប់គ្រង Kontact
Name[ko]=Kontact 관리
Name[lt]=Kontact administravimas
Name[lv]=Kontact administrācija
Name[mr]=कॉन्टेक्ट प्रशासन
Name[nb]=Kontact-administrasjon
Name[nds]=Kontaktenpleeg
Name[nl]=Kontactbeheer
Name[nn]=Kontakt-administrering
Name[pa]=ਕੇਸੰਪਰਕ ਪਰਸ਼ਾਸ਼ਨ
Name[pl]=Administracja Kontact
Name[pt]=Administração do Kontact
Name[pt_BR]=Administração do Kontact
Name[ro]=Administrare Kontact
Name[ru]=Администрирование Kontact
Name[sk]=Správa Kontactu
Name[sl]=Skrbništvo Kontacta
Name[sr]=Администрирање Контакта
Name[sr@ijekavian]=Администрирање Контакта
Name[sr@ijekavianlatin]=Administriranje Kontacta
Name[sr@latin]=Administriranje Kontacta
Name[sv]=Administration av Kontact
Name[tr]=Kontact Yönetimi
Name[uk]=Адміністрування Kontact
Name[wa]=Manaedjmint di Kontact
Name[x-test]=xxKontact Administrationxx
Name[zh_CN]=Kontact 管理
Name[zh_TW]=Kontact 管理
Icon=kontact
Exec=kontact
Categories=Qt;KDE;Office;ProjectManagement;
X-DocPath=kontact-admin/index.html
NoDisplay=true
Terminal=false
Type=Application
doc/kontact/calendar-sidebar-icon.png

2.29 KB | W: | H:

doc/kontact/calendar-sidebar-icon.png

1.48 KB | W: | H:

doc/kontact/calendar-sidebar-icon.png
doc/kontact/calendar-sidebar-icon.png
doc/kontact/calendar-sidebar-icon.png
doc/kontact/calendar-sidebar-icon.png
  • 2-up
  • Swipe
  • Onion skin
doc/kontact/configuration-main.png

116 KB | W: | H:

doc/kontact/configuration-main.png

72.3 KB | W: | H:

doc/kontact/configuration-main.png
doc/kontact/configuration-main.png
doc/kontact/configuration-main.png
doc/kontact/configuration-main.png
  • 2-up
  • Swipe
  • Onion skin
......@@ -2,8 +2,6 @@
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.5-Based Variant V1.1//EN"
"dtd/kdedbx45.dtd" [
<!ENTITY PIM "<acronym>PIM</acronym>">
<!ENTITY kappname "&kontact;">
<!ENTITY package "kdepim">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE">
]>
......@@ -43,14 +41,14 @@
<legalnotice>&FDLNotice;</legalnotice>
<date>2010-08-20</date>
<releaseinfo>4.5.1 beta1</releaseinfo>
<date>2016-12-08</date>
<releaseinfo>5.4.40 (Applications 16.12)</releaseinfo>
<abstract><para>&kontact; is the integrated solution to your personal
information management (&PIM;) needs. It combines well-known &kde;
applications such as &kmail;, &korganizer; and &kaddressbook; into a
single interface to provide easy access to mail, scheduling,
address book and other &PIM; functionality. </para></abstract>
address book and other &PIM; functionality.</para></abstract>
<keywordset>
<keyword>KDE</keyword>
......@@ -473,84 +471,6 @@ distinction is available in the
</sect1>
<sect1 id="keyboard-shortcuts">
<title>Keyboard Shortcuts</title>
<para>&kontact; provides several global keyboard shortcuts for easier access to
certain features. Below is a list of the default shortcuts; however, note that
you can configure the keyboard shortcuts by going to
<menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts...</guimenuitem></menuchoice>.</para>
<screenshot>
<screeninfo>&kontact;'s Shortcut Configuration Window</screeninfo>
<mediaobject>
<imageobject>
<imagedata format="PNG" fileref="configuration-shortcuts.png" />
</imageobject>
<textobject>
<phrase>&kontact;'s Shortcut Configuration Window</phrase>
</textobject>
<caption>
<para>
&kontact;'s Shortcut Configuration Window
</para>
</caption>
</mediaobject>
</screenshot>
<important>
<para>The shortcuts mentioned below for switching components vary slightly
depending on the components you have activated (see
<xref linkend="main-config" />). In general, the components can be activated
by using &Ctrl; in conjunction with a number; the number can
be determined by counting how many items from the top the component is in
the side pane.</para>
</important>
<para>The following are the default shortcuts for &kontact;:</para>
<table>
<title>Keyboard Shortcuts</title>
<tgroup cols="2">
<thead><row><entry>Action</entry><entry>Key Combo</entry></row></thead>
<tbody>
<row><entry>Summary View</entry><entry><keycombo action="simul">&Ctrl;<keycap>1</keycap></keycombo></entry></row>
<row><entry>Mail Component</entry><entry><keycombo action="simul">&Ctrl;<keycap>2</keycap></keycombo></entry></row>
<row><entry>Contacts Component</entry><entry><keycombo action="simul">&Ctrl;<keycap>3</keycap></keycombo></entry></row>
<row><entry>Calendar Component</entry><entry><keycombo action="simul">&Ctrl;<keycap>4</keycap></keycombo></entry></row>
<row><entry>To-do List Component</entry><entry><keycombo action="simul">&Ctrl;<keycap>5</keycap></keycombo></entry></row>
<row><entry>Feeds Component</entry><entry><keycombo action="simul">&Ctrl;<keycap>6</keycap></keycombo></entry></row>
<row><entry>Usenet Component</entry><entry><keycombo action="simul">&Ctrl;<keycap>7</keycap></keycombo></entry></row>
<row><entry>Journal Component</entry><entry><keycombo action="simul">&Ctrl;<keycap>8</keycap></keycombo></entry></row>
<row><entry>Notebooks Component</entry><entry><keycombo action="simul">&Ctrl;<keycap>9</keycap></keycombo></entry></row>
<row><entry>New <replaceable>Item</replaceable></entry><entry><keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
<important><para>New <replaceable>Item</replaceable> changes depending on
what component is currently selected. It is New Message for the Summary
and Mail components, New Contact for the Contact component, New Event
for the Calendar component, New To-do for the To-do list component, New
Journal for the Journal component, New Note for the Notes component,
New Feed for the Feeds component, and New Article for the Usenet
component. Each of these actions has its own keyboard shortcut as listed
below.</para></important></entry></row>
<row><entry>New Message</entry><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>M</keycap></keycombo></entry></row>
<row><entry>New Contact</entry><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>C</keycap></keycombo></entry></row>
<row><entry>New To-do</entry><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>T</keycap></keycombo></entry></row>
<row><entry>New Feed</entry><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>F</keycap></keycombo></entry></row>
<row><entry>New Article</entry><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>A</keycap></keycombo></entry></row>
<row><entry>New Journal</entry><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>J</keycap></keycombo></entry></row>
<row><entry>New KJots Page</entry><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>P</keycap></keycombo></entry></row>
<row><entry>New KJots Book</entry><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>B</keycap></keycombo></entry></row>
<row><entry>New Popup Note</entry><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>N</keycap></keycombo></entry></row>
<row><entry>New Task</entry><entry><keycombo action="simul">&Ctrl;&Shift;<keycap>W</keycap></keycombo></entry></row>
<row><entry>&kontact; Handbook</entry><entry><keycombo action="press"><keycap>F1</keycap></keycombo></entry></row>
<row><entry>What's This Help</entry><entry><keycombo action="simul">&Ctrl;<keycap>F1</keycap></keycombo></entry></row>
<row><entry>Quit</entry><entry><keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo></entry></row>
</tbody>
</tgroup>
</table>
</sect1>
</chapter>
<chapter id="summary-view">
......@@ -737,6 +657,7 @@ will display any events that currently apply.
</mediaobject>
</screenshot>
</sect2>
<sect2 id="summary-view-config-mail">
<title>&kontact; Summary Plugins: Mail</title>
......@@ -867,12 +788,7 @@ the calendar and the contact list in one place.
that can be used for certain actions.</para>
<para>First of all, &kontact; supports command line arguments
that all &kde;/&Qt; applications support. You can get a full list of
these by typing:
</para>
<para>
<prompt>&percnt;</prompt> <command>kontact --help-all</command>
that all &kf5;/&Qt; applications support, see the man pages qt5options and kf5options.
</para>
<para>&kontact; also supports several command line arguments
......@@ -986,18 +902,152 @@ assisted with markup and style issues.</para>
</itemizedlist>
</para>
<para>&kontact; homepage is at <ulink
url="http://kontact.kde.org">http://kontact.kde.org</ulink></para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL;
&underGPL;
</chapter>
<appendix id="kontact-admin">
<title>Administrator's Guide</title>
<!-- Section Compatibility -->
<sect1 id="compat">
<title>Compatibility Issues</title>
<para>
This section provides help with how to make &kontact;
communicate effectively with various groupware solutions.
</para>
<sect2 id="compat-outlook">
<title>Outlook and Exchange</title>
<para>
In the &kontact; configuration dialog, under <menuchoice><guimenu>Mail</guimenu>
<guimenuitem>Misc</guimenuitem></menuchoice> on the <guilabel>Invitations</guilabel> page
you will find the following options that will help the user communicate
with Microsoft Outlook(tm) running in a Kolab environment or in a
Microsoft Exchange(tm) environment.
</para>
<variablelist>
<varlistentry>
<term><guilabel>Mangle From:/To: headers in replies to invitations</guilabel></term>
<listitem>
<para>Enable this option to make Microsoft Outlook(tm) understand your answers to invitation replies.</para>
<para>Microsoft Outlook has a number of shortcomings in its implementation of
the iCalendar standard; this option works around one of them. If you
have problems with Outlook users not being able to get your replies,
try setting this option.</para>
<para>Details: When mailing an iCal invitation this makes the message have
the From: header the same as the To: header. It also sets header
X-KMail-Identity to the To:'s UIOD and makes sure the BCC: is blank.
Outlook will only understand the reply if the From: header is
the same as the To: header of the invitation message.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Send invitations in the mail body</guilabel></term>
<listitem>
<para>Invitations are normally sent as attachments to a mail. This switch
changes the invitation to be sent in the text of the mail instead;
this is necessary to send invitations and replies to Microsoft Outlook.
But, when you do this, you no longer get descriptive text that mail
programs can read; so, to people who have email programs that do not
understand the invitations, the resulting messages look very odd.
People that have email programs that do understand invitations will
still be able to work with this.</para>
<para>Details: When mailing an iCal invitation this option makes the
message body from the attachment data and sets the Content-Type header
to 'text/calendar; method=something; charset="utf-8"'.</para>
<para>Auto-sending is also turned on so there is no human intervention
required for composing.</para>
<note><para>Encryption and self-signing are disabled.</para></note>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Exchange-compatible invitation naming</guilabel></term>
<listitem>
<para>Microsoft Outlook, when used in combination with a Microsoft Exchange(tm)
server, has a problem understanding standards-compliant groupware email.
Enable this option to send groupware invitations in a way that Microsoft
Exchange(tm) understands. The invitation will be sent as an attachment with name
<filename>ical.ics</filename>.</para>
<para>Details: When mailing an iCal invitation this makes
the message have the subject "(Declined|Tentative|Accepted|Delegated): subject".
The invitation will be sent as an attachment with name <filename>ical.ics</filename>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Outlook-compatible attachment naming</guilabel></term>
<listitem>
<para>Turn this option on to make Outlook(tm) understand attachment names
containing non-English characters.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
<!-- Section Behavior -->
<sect1 id="behavior">
<title>Behavioral Issues</title>
<para>
This section provides instructions on how to make &kontact;
behave more like other groupware clients.
</para>