TDE personal information management applications
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

index.docbook 36KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176
  1. <?xml version="1.0" ?>
  2. <!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN"
  3. "dtd/kdex.dtd" [
  4. <!ENTITY PIM "<acronym>PIM</acronym>">
  5. <!ENTITY kappname "&kontact;">
  6. <!ENTITY package "tdepim">
  7. <!ENTITY % addindex "IGNORE">
  8. <!ENTITY % English "INCLUDE">
  9. <!ENTITY akregator "<application>Akregator</application>">
  10. <!ENTITY kitchensync "<application>KitchenSync</application>">
  11. ]>
  12. <book id="kontact" lang="&language;">
  13. <bookinfo>
  14. <title>The &kontact; Handbook</title>
  15. <authorgroup>
  16. <author>
  17. <firstname>Cornelius</firstname>
  18. <surname>Schumacher</surname>
  19. <affiliation><address><email>schumacher@kde.org</email></address></affiliation>
  20. </author>
  21. <author>
  22. <firstname>Antonio</firstname>
  23. <surname>Salazar</surname>
  24. <affiliation><address><email>savedfastcool@gmail.com</email></address></affiliation>
  25. </author>
  26. <author>
  27. <firstname>Daniel</firstname>
  28. <surname>Molkentin</surname>
  29. <affiliation><address><email>molkentin@kde.org</email></address></affiliation>
  30. </author>
  31. </authorgroup>
  32. <copyright>
  33. <year>2003-2005</year><holder>Cornelius Schumacher</holder>
  34. </copyright>
  35. <legalnotice>&FDLNotice;</legalnotice>
  36. <date>2005-02-22</date>
  37. <releaseinfo>1.1</releaseinfo>
  38. <abstract><para>&kontact; is the integrated solution to your personal
  39. information management (&PIM;) needs. It combines well-known &kde;
  40. applications like &kmail;, &korganizer; and &kaddressbook; into a
  41. single interface to provide easy access to mail, scheduling,
  42. address book and other &PIM; functionality. </para></abstract>
  43. <keywordset>
  44. <keyword>KDE</keyword>
  45. <keyword>tdepim</keyword>
  46. <keyword>KMail</keyword>
  47. <keyword>Organizer</keyword>
  48. <keyword>KAddressBook</keyword>
  49. <keyword>KNotes</keyword>
  50. <keyword>Akregator</keyword>
  51. <keyword>PIM</keyword>
  52. <keyword>groupware</keyword>
  53. <keyword>Outlook</keyword>
  54. <keyword>Evolution</keyword>
  55. </keywordset>
  56. </bookinfo>
  57. <chapter id="introduction">
  58. <title>Introduction</title>
  59. <para>&kontact; is the integrated solution for personal information
  60. management. It combines the well-known &kde; applications for email,
  61. scheduling, address book, notes, and newsgroups (&kmail;, &korganizer;,
  62. &kaddressbook;, &knotes;, and &knode;)
  63. into a single interface. Being
  64. based on a true component framework &kontact; provides exactly the
  65. same functionality as the stand-alone applications, and adds more
  66. features, by making use of the integrated way &kontact; runs the
  67. applications as components. Users still retain the choice of which
  68. applications are run within &kontact; and which are run
  69. stand-alone.</para>
  70. <para>In addition to the functionality of the individual applications &kontact;
  71. provides, a summary view and advanced drag &amp; drop features between components.
  72. </para>
  73. </chapter>
  74. <chapter id="components">
  75. <title>&kontact; Components</title>
  76. <para>
  77. &kontact; integrates the following applications. See the individual
  78. application manuals for details on how to use them. These apply to
  79. running them as components inside &kontact; just as well as running
  80. them stand-alone.
  81. </para>
  82. <sect1 id="mail">
  83. <title>&kmail;</title>
  84. <para>
  85. <ulink url="help:kmail">&kmail;</ulink>, the &kde; mail client.
  86. </para>
  87. </sect1>
  88. <sect1 id="organizer">
  89. <title>&korganizer;</title>
  90. <para>
  91. <ulink url="help:korganizer">&korganizer;</ulink>, the &kde; organizer
  92. and scheduling application.
  93. </para>
  94. </sect1>
  95. <sect1 id="addressbook">
  96. <title>&kaddressbook;</title>
  97. <para>
  98. <ulink url="help:kaddressbook">&kaddressbook;</ulink>, the &kde; contact
  99. manager.
  100. </para>
  101. </sect1>
  102. <sect1 id="notes">
  103. <title>&knotes;</title>
  104. <para>
  105. <ulink url="help:knotes">&knotes;</ulink>, yellow sticky notes.
  106. </para>
  107. </sect1>
  108. <sect1 id="newsreader">
  109. <title>&knode;</title>
  110. <para>
  111. <ulink url="help:knode">&knode;</ulink>, the &kde; news reader.
  112. </para>
  113. </sect1>
  114. <sect1 id="pilot">
  115. <title>&kpilot;</title>
  116. <para>
  117. &kpilot;, the &kde; Pilot synchronization
  118. application.
  119. </para>
  120. </sect1>
  121. <sect1 id="synchronization">
  122. <title>&kitchensync;</title>
  123. <para>
  124. <ulink url="help:kitchensync">&kitchensync;</ulink>, the &kde; synchronization
  125. application.
  126. </para>
  127. </sect1>
  128. <sect1 id="feeds">
  129. <title>&akregator;</title>
  130. <para>
  131. <ulink url="help:akregator">&akregator;</ulink>, the &kde; RSS feed reader.
  132. </para>
  133. </sect1>
  134. </chapter>
  135. <chapter id="main-window">
  136. <title>The &kontact; Main Window</title>
  137. <para>The main window consists of a side pane on the left showing the icons of
  138. the available components, the main view on the right which contains the main
  139. window of the active component and the usual menu, tool and status bars.</para>
  140. <sect1 id="side-pane">
  141. <title>Side Pane</title>
  142. <para>The side pane serves multiple purposes. It allows for switching between
  143. components, shows which component is active and serves as the target for
  144. drag &amp; drop operations to the different applications.</para>
  145. <screenshot>
  146. <screeninfo>&kontact;'s Side Pane</screeninfo>
  147. <mediaobject>
  148. <imageobject><imagedata format="PNG" fileref="side-pane.png"/></imageobject>
  149. <textobject>
  150. <phrase>&kontact;'s Side Pane</phrase>
  151. </textobject>
  152. <caption>
  153. <para>
  154. &kontact;'s Side Pane
  155. </para>
  156. </caption>
  157. </mediaobject>
  158. </screenshot>
  159. <para>For switching between components simply click on the corresponding icon.
  160. The main window of the component is shown and the menu, tool and status bars are
  161. adapted to reflect the functionality of the active component. If you activate a
  162. component for the first time there might be a small delay until the main view
  163. is changed, because components are loaded on demand. This means you don't waste
  164. memory for components you don't use.</para>
  165. <para>The icons in the side pane can also be used as targets for drag &amp; drop
  166. operations. For example, you can drag a mail from the mail part and
  167. drop it on the icon of the todo list or the calendar to create a todo
  168. or event associated with this mail.</para>
  169. <para>Finally, you can change the size of the icons in the side pane.
  170. Right-clicking on the side pane will give you the option to use Large,
  171. Normal, or Small icons, as well as the option to use text only
  172. instead of icons.</para>
  173. <para>If you dislike the sidebar, you can simply hide it by dragging the
  174. splitter. An alternative navigation between part is provided by the
  175. <guilabel>navigator</guilabel> toolbar, which will always be aligned on the opposite
  176. side of the mainwindow from the side pane.</para>
  177. </sect1>
  178. <sect1 id="main-view">
  179. <title>Main View</title>
  180. <para>The view on the right which takes up most of the area of the &kontact;
  181. main window shows the active component. This exactly corresponds to the main
  182. window the component uses when run as a stand-alone application. The highlighted
  183. icon in the side pane indicates to which application the main view belongs.
  184. &kontact; remembers which component was active, so when starting &kontact; the
  185. view initially shows which one was activated when exiting &kontact; the last
  186. time.</para>
  187. <screenshot>
  188. <screeninfo>&kontact;'s Main View</screeninfo>
  189. <mediaobject>
  190. <imageobject><imagedata format="PNG" fileref="main-view.png"/></imageobject>
  191. <textobject>
  192. <phrase>&kontact;'s Main View</phrase>
  193. </textobject>
  194. <caption>
  195. <para>
  196. &kontact;'s Main View
  197. </para>
  198. </caption>
  199. </mediaobject>
  200. </screenshot>
  201. <para>In addition, there are two ways of overriding the component that &kontact;
  202. starts in. The first is as an argument to the &kontact; program call
  203. (see <xref linkend="command-line"/>). The second is a setting in the
  204. &kontact; Settings dialog that will allow you to always start &kontact; in a
  205. certain mode.</para>
  206. <screenshot>
  207. <screeninfo>&kontact; Starting Component Setting</screeninfo>
  208. <mediaobject>
  209. <imageobject><imagedata format="PNG" fileref="configuration-starting-component.png"/></imageobject>
  210. <textobject>
  211. <phrase>&kontact; Starting Component Setting</phrase>
  212. </textobject>
  213. <caption>
  214. <para>
  215. &kontact; Starting Component Setting
  216. </para>
  217. </caption>
  218. </mediaobject>
  219. </screenshot>
  220. </sect1>
  221. <sect1 id="bars">
  222. <title>Menu, Tool and Status Bars</title>
  223. <para>The menu, tool and status bars are adapted to the active component. That
  224. means that, in addition to some common functions like the help menu which are
  225. shown for all components, there are actions which are switched when the active
  226. component is switched. These actions available for each component are the same
  227. ones which are also available when running the application stand-alone.</para>
  228. <screenshot>
  229. <screeninfo>Views of &kontact;'s menu bars in the Summary View, Mail View, and Calendar View</screeninfo>
  230. <mediaobject>
  231. <imageobject><imagedata format="PNG" fileref="menu-bar-summary.png"/></imageobject>
  232. <textobject>
  233. <phrase>Views of &kontact;'s menu bars in the Summary View, Mail View, and Calendar View</phrase>
  234. </textobject>
  235. </mediaobject>
  236. </screenshot>
  237. <screenshot>
  238. <screeninfo>Views of &kontact;'s menu bars in the Summary View, Mail View, and Calendar View</screeninfo>
  239. <mediaobject>
  240. <imageobject><imagedata format="PNG" fileref="menu-bar-kmail.png"/></imageobject>
  241. <textobject>
  242. <phrase>Views of &kontact;'s menu bars in the Summary View, Mail View, and Calendar View</phrase>
  243. </textobject>
  244. </mediaobject>
  245. </screenshot>
  246. <screenshot>
  247. <screeninfo>Views of &kontact;'s menu bars in the Summary View, Mail View, and Calendar View</screeninfo>
  248. <mediaobject>
  249. <imageobject><imagedata format="PNG" fileref="menu-bar-korganizer.png"/></imageobject>
  250. <textobject>
  251. <phrase>Views of &kontact;'s menu bars in the Summary View, Mail View, and Calendar View</phrase>
  252. </textobject>
  253. <caption>
  254. <para>
  255. Views of &kontact;'s menu bars in the Summary View, Mail View, and Calendar View
  256. </para>
  257. </caption>
  258. </mediaobject>
  259. </screenshot>
  260. <para>A special action common to all components is the
  261. <guimenuitem>New</guimenuitem> action. It allows creation of new objects
  262. like emails, contacts, appointments and todos independently of which
  263. component is active. The component responsible for processing the
  264. selected object is started, if required, and takes over the created
  265. object.</para>
  266. <screenshot>
  267. <screeninfo>&kontact;'s New Menu</screeninfo>
  268. <mediaobject>
  269. <imageobject><imagedata format="PNG" fileref="new-menu.png"/></imageobject>
  270. <textobject>
  271. <phrase>&kontact;'s New Menu</phrase>
  272. </textobject>
  273. <caption>
  274. <para>
  275. &kontact;'s New Menu
  276. </para>
  277. </caption>
  278. </mediaobject>
  279. </screenshot>
  280. <para>
  281. Another common action is the <guimenuitem>Synchronize</guimenuitem> action. It synchronizes mail and groupware folders depending on the active component. E.g., if the Calendar component is active, the button synchronizes all Calendar folders. In the Summary, the action synchronizes all folders independent of their content.
  282. </para>
  283. </sect1>
  284. <sect1 id="side-pane-drag-and-drop">
  285. <title>Drag and Drop Functionality</title>
  286. <para>&kontact; provides advanced drag and drop functionality between
  287. the programs it contains. Following is a brief description of each of
  288. the specific drag and drop operations that can be effected and the
  289. result of each.</para>
  290. <sect2 id="side-pane-drag-and-drop-kmail-todo">
  291. <title>&kmail; -> &korganizer; Todo List</title>
  292. <para>
  293. Dragging a message from
  294. <ulink url="help:kmail/using-kmail.html#the-mail-reader-window">&kmail;'s Headers pane</ulink>
  295. to the icon for &korganizer;'s Todo list
  296. (<guiicon><inlinemediaobject><imageobject>
  297. <imagedata fileref="todo-list-sidebar-icon.png" format="PNG"/>
  298. </imageobject></inlinemediaobject></guiicon>)
  299. will create a new Todo with
  300. <guilabel>Mail: <replaceable>Subject</replaceable></guilabel> as the title and
  301. <guilabel>From: <replaceable>Sender</replaceable>
  302. To: <replaceable>Receiver</replaceable>
  303. Subject: <replaceable>Subject</replaceable></guilabel> as the contents
  304. (where text that looks <guilabel><replaceable>like
  305. this</replaceable></guilabel> is information
  306. from the message itself), as well as the e-mail message itself as an
  307. attachment.
  308. </para>
  309. </sect2>
  310. <sect2 id="side-pane-drag-and-drop-kmail-calendar">
  311. <title>&kmail; -> &korganizer; Calendar</title>
  312. <para>
  313. Dragging a message from
  314. <ulink url="help:kmail/using-kmail.html#the-mail-reader-window">&kmail;'s Headers pane</ulink>
  315. to the icon for &korganizer;'s Calendar
  316. (<guiicon><inlinemediaobject><imageobject>
  317. <imagedata fileref="calendar-sidebar-icon.png" format="PNG"/>
  318. </imageobject></inlinemediaobject></guiicon>)
  319. will create a new Event with
  320. <guilabel>Mail: <replaceable>Subject</replaceable></guilabel> as the title and
  321. <guilabel>From: <replaceable>Sender</replaceable>
  322. To: <replaceable>Receiver</replaceable>
  323. Subject: <replaceable>Subject</replaceable></guilabel> as the contents
  324. (where text that looks <guilabel><replaceable>like
  325. this</replaceable></guilabel> is information
  326. from the message itself), as well as the e-mail message itself as an
  327. attachment.
  328. </para>
  329. <para>Note that dragging onto the Todo button creates a Todo,
  330. whereas dragging onto the Calendar creates an Event. More on this
  331. distinction is available in the
  332. <ulink url="help:korganizer">&korganizer; documentation</ulink>
  333. </para>
  334. </sect2>
  335. <sect2 id="side-pane-drag-and-drop-kmail-contacts">
  336. <title>&kmail; -> &kaddressbook;</title>
  337. <para>
  338. Dragging a message from
  339. <ulink url="help:kmail/using-kmail.html#the-mail-reader-window">&kmail;'s Headers pane</ulink>
  340. to the icon for &kaddressbook;
  341. (<guiicon><inlinemediaobject><imageobject> <imagedata
  342. fileref="kaddressbook-sidebar-icon.png"
  343. format="PNG" />
  344. </imageobject></inlinemediaobject></guiicon>) will create a contact
  345. from the email address of the sender, unless a contact with that name
  346. already exists. A dialog box notifies you of this action.
  347. </para>
  348. </sect2>
  349. <sect2 id="side-pane-drag-and-drop-kaddressbook-todo">
  350. <title>&kaddressbook; -> &korganizer; Todo List</title>
  351. <para>
  352. Dragging any number of entries from <ulink
  353. url="help:kaddressbook/using-kaddressbook.html">&kaddressbook;'s main
  354. window</ulink> to the icon for &korganizer;'s Todo List
  355. (<guiicon><inlinemediaobject><imageobject> <imagedata
  356. fileref="todo-list-sidebar-icon.png"
  357. format="PNG"/>
  358. </imageobject></inlinemediaobject></guiicon>) will create a new Todo
  359. with &quot;Meeting&quot; as the title and the selected contacts as
  360. attendees.
  361. </para>
  362. <para>Note that dragging onto the Todo button creates a Todo,
  363. whereas dragging onto the Calendar creates an Event. More on this
  364. distinction is available in the
  365. <ulink url="help:korganizer">&korganizer; documentation</ulink>
  366. </para>
  367. </sect2>
  368. <sect2 id="side-pane-drag-and-drop-kaddressbook-calendar">
  369. <title>&kaddressbook; -> &korganizer; Calendar</title>
  370. <para>
  371. Dragging any number of entries from <ulink
  372. url="help:kaddressbook/using-kaddressbook.html">&kaddressbook;'s main
  373. window</ulink> to the icon for &korganizer;'s Calendar
  374. (<guiicon><inlinemediaobject><imageobject> <imagedata
  375. fileref="calendar-sidebar-icon.png"
  376. format="PNG"/>
  377. </imageobject></inlinemediaobject></guiicon>) will create a new Event
  378. with &quot;Meeting&quot; as the title and the selected contacts as
  379. attendees.
  380. </para>
  381. <para>Note that dragging onto the Todo button creates a Todo,
  382. whereas dragging onto the Calendar creates an Event. More on this
  383. distinction is available in the
  384. <ulink url="help:korganizer">&korganizer; documentation</ulink>
  385. </para>
  386. </sect2>
  387. <sect2 id="side-pane-drag-and-drop-knotes-todo">
  388. <title>&knotes; -> &korganizer;'s Todo List</title>
  389. <para>
  390. Dragging a note from &knotes; to the icon for &korganizer;'s Todo List
  391. (<guiicon><inlinemediaobject><imageobject> <imagedata
  392. fileref="todo-list-sidebar-icon.png"
  393. format="PNG"/>
  394. </imageobject></inlinemediaobject></guiicon>) will create a new Todo
  395. with the title set to the title of the note and the description set to the note itself.
  396. </para>
  397. </sect2>
  398. </sect1>
  399. </chapter>
  400. <chapter id="summary-view">
  401. <title>The Summary View</title>
  402. <para>The default view when starting &kontact; for the first time is the summary
  403. view. It shows an overview of the most relevant information provided by the
  404. selected &kontact; components. These can be newsticker headlines, imminent
  405. appointments or birthdays, due todos, weather data, etc. Which information is
  406. shown is configurable by selecting the corresponding components in the <link
  407. linkend="configuration">&kontact; configuration dialog</link>.</para>
  408. <screenshot>
  409. <screeninfo>&kontact;'s Summary View</screeninfo>
  410. <mediaobject>
  411. <imageobject><imagedata format="PNG" fileref="summary-view.png"/></imageobject>
  412. <textobject>
  413. <phrase>&kontact;'s Summary View</phrase>
  414. </textobject>
  415. <caption>
  416. <para>
  417. &kontact;'s Summary View
  418. </para>
  419. </caption>
  420. </mediaobject>
  421. </screenshot>
  422. <sect1 id="summary-view-component-reposition">
  423. <title>Repositioning Summary View Components</title>
  424. <para>The Summary View allows you to change where the
  425. components are in the view itself. So, if you prefer to
  426. have your Special Dates in the lower left and your to-dos in
  427. the upper right, you can rearrange the summary view to
  428. reflect that.</para>
  429. <para>Repositioning components in the Summary View is as simple
  430. as dragging them to the new location you want them to be in. Click and
  431. hold on the grey title area of the component and drag the component
  432. to wherever you want it to be. Note that this positioning is done
  433. compared to other components. So you can move the Mail component to be
  434. below the to-do component in the view, but you can't place it in a specific
  435. position. If you have only one component in your summary view, the only option
  436. is to move it between the two columns of the view; two components can either
  437. be two in one column or one in each column; and so on and so forth. Whenever
  438. you are dragging a component, you will see a small preview box following your
  439. mouse around showing you the component.</para>
  440. <screenshot>
  441. <screeninfo>Rearranging &kontact;'s Summary View</screeninfo>
  442. <mediaobject>
  443. <imageobject><imagedata format="PNG" fileref="summary-view-repositioning.png"/></imageobject>
  444. <textobject>
  445. <phrase>Rearranging &kontact;'s Summary View</phrase>
  446. </textobject>
  447. <caption>
  448. <para>
  449. Rearranging &kontact;'s Summary View
  450. </para>
  451. </caption>
  452. </mediaobject>
  453. </screenshot>
  454. </sect1>
  455. </chapter>
  456. <chapter id="configuration">
  457. <title>Configuring &kontact;</title>
  458. <sect1 id="main-config">
  459. <title>&kontact; Configuration Window</title>
  460. <para>When selecting the <guimenuitem>Configure &kontact;</guimenuitem>
  461. action from the <guimenu>Settings</guimenu> menu, the &kontact;
  462. configuration dialog is shown. It provides a list of the
  463. configurations for all the active components of &kontact;. You can
  464. click the <guilabel>-</guilabel> symbol next to the component names to
  465. collapse their options so that you can view the options for the
  466. component you are looking for. Selecting one of the configuration
  467. options under a heading will bring up that configuration section on
  468. the right.</para>
  469. <screenshot>
  470. <screeninfo>&kontact;'s Configuration Window</screeninfo>
  471. <mediaobject>
  472. <imageobject><imagedata format="PNG" fileref="configuration-main.png"/></imageobject>
  473. <textobject>
  474. <phrase>&kontact;'s Configuration Window</phrase>
  475. </textobject>
  476. <caption>
  477. <para>
  478. &kontact;'s Configuration Window
  479. </para>
  480. </caption>
  481. </mediaobject>
  482. </screenshot>
  483. <para>In addition, by clicking on the <guibutton>Configure...</guibutton>
  484. button, you can bring up a dialog that will allow you to select which
  485. components you want active from a list.
  486. By checking the box next to the component title you select the
  487. component to be put into the side bar and the summary view. The
  488. component is loaded and its main view is shown in the main window when
  489. clicking on its icon in the side pane for the first time. By
  490. unchecking the check box the component is removed from the side pane and
  491. summary view. Changes become effective by clicking the
  492. <guibutton>Apply</guibutton> or <guibutton>OK</guibutton>
  493. button.</para>
  494. <screenshot>
  495. <screeninfo>&kontact;'s Select Components Window</screeninfo>
  496. <mediaobject>
  497. <imageobject><imagedata format="PNG" fileref="configuration-components.png"/></imageobject>
  498. <textobject>
  499. <phrase>&kontact;'s Select Components Window</phrase>
  500. </textobject>
  501. <caption>
  502. <para>
  503. &kontact;'s Select Components Window
  504. </para>
  505. </caption>
  506. </mediaobject>
  507. </screenshot>
  508. <para>You can also configure individual components by activating the
  509. component by clicking on the corresponding icon in the side pane of
  510. the main window and then selecting the menu item
  511. <guimenuitem>Configure <replaceable>application
  512. name</replaceable></guimenuitem> from the <guimenu>Settings</guimenu>
  513. menu.</para>
  514. <screenshot>
  515. <screeninfo>&kontact; Settings Menu When KMail is Selected</screeninfo>
  516. <mediaobject>
  517. <imageobject>
  518. <imagedata format="PNG" fileref="settings-menu-kmail.png"/>
  519. </imageobject>
  520. <textobject>
  521. <phrase>&kontact; Settings Menu When KMail is Selected</phrase>
  522. </textobject>
  523. <caption>
  524. <para>
  525. &kontact; Settings Menu When KMail is Selected
  526. </para>
  527. </caption>
  528. </mediaobject>
  529. </screenshot>
  530. </sect1>
  531. <sect1 id="summary-view-config">
  532. <title>Configuring &kontact;'s Summary View</title>
  533. <para>When you select <guimenuitem>Configure Summary View...</guimenuitem>
  534. from the &kontact; <guimenu>Settings</guimenu> menu (only available in
  535. Summary View), a dialog pops up that allows you to select which summary
  536. plugins &kontact; should show in its summary view.
  537. Here is a brief list of the currently available plugins and what they do:
  538. </para>
  539. <sect2 id="summary-view-config-calendar">
  540. <title>&kontact; Summary Plugins: Calendar</title>
  541. <para>
  542. The <quote>Calendar</quote> plugin for &kontact;'s Summary View adds
  543. an area in the view labeled <guilabel>Appointments</guilabel>. This
  544. will display any appointments that currently apply.
  545. </para>
  546. <screenshot>
  547. <screeninfo>&kontact; Calendar Summary Plugin</screeninfo>
  548. <mediaobject>
  549. <imageobject>
  550. <imagedata format="PNG" fileref="summary-view-calendar.png"/>
  551. </imageobject>
  552. <textobject>
  553. <phrase>&kontact; Calendar Summary Plugin</phrase>
  554. </textobject>
  555. <caption>
  556. <para>
  557. &kontact; Calendar Summary Plugin
  558. </para>
  559. </caption>
  560. </mediaobject>
  561. </screenshot>
  562. </sect2>
  563. <sect2 id="summary-view-config-contacts">
  564. <title>&kontact; Summary Plugins: Contacts</title>
  565. <para>
  566. The <quote>Contacts</quote> plugin for &kontact;'s Summary View adds
  567. an area in the view labeled <guilabel>Birthdays and
  568. Anniversaries</guilabel> where birthdays and anniversaries of your
  569. contacts are displayed (for contacts who have that information set in
  570. their contact information; see the <ulink
  571. url="help:/kaddressbook/index.html">&kaddressbook;
  572. documentation</ulink> for more information on setting relevant contact
  573. information). It contains the following information:
  574. </para>
  575. <itemizedlist>
  576. <listitem>
  577. <para>Number of days from now when item will occur</para>
  578. </listitem>
  579. <listitem>
  580. <para>Date of birth/anniversary</para>
  581. </listitem>
  582. <listitem>
  583. <para>Name (Click on this to send an email,
  584. right-click for the option to view the contact's
  585. information)</para>
  586. </listitem>
  587. <listitem>
  588. <para>Age/Anniversary Year</para>
  589. </listitem>
  590. </itemizedlist>
  591. <screenshot>
  592. <screeninfo>&kontact; Contacts Summary Plugin</screeninfo>
  593. <mediaobject>
  594. <imageobject>
  595. <imagedata format="PNG" fileref="summary-view-contacts.png"/>
  596. </imageobject>
  597. <textobject>
  598. <phrase>&kontact; Contacts Summary Plugin</phrase>
  599. </textobject>
  600. <caption>
  601. <para>
  602. &kontact; Contacts Summary Plugin
  603. </para>
  604. </caption>
  605. </mediaobject>
  606. </screenshot>
  607. </sect2>
  608. <sect2 id="summary-view-config-kpilot">
  609. <title>&kontact; Summary Plugins: KPilot</title>
  610. <para>
  611. The <quote>KPilot</quote> plugin for &kontact;'s Summary View adds an
  612. area in the view labeled <guilabel>KPilot Information</guilabel>.
  613. This area contains a lot of information from KPilot, including:
  614. </para>
  615. <itemizedlist>
  616. <listitem>
  617. <para>Last synchronization (with sync log)</para>
  618. </listitem>
  619. <listitem>
  620. <para>User who last synchronized</para>
  621. </listitem>
  622. <listitem>
  623. <para>Device last synchronized</para>
  624. </listitem>
  625. <listitem>
  626. <para>Current status</para>
  627. </listitem>
  628. <listitem>
  629. <para>Available conduits</para>
  630. </listitem>
  631. </itemizedlist>
  632. <screenshot>
  633. <screeninfo>&kontact; KPilot Summary Plugin</screeninfo>
  634. <mediaobject>
  635. <imageobject>
  636. <imagedata format="PNG" fileref="summary-view-kpilot.png"/>
  637. </imageobject>
  638. <textobject>
  639. <phrase>&kontact; KPilot Summary Plugin</phrase>
  640. </textobject>
  641. <caption>
  642. <para>
  643. &kontact; KPilot Summary Plugin
  644. </para>
  645. </caption>
  646. </mediaobject>
  647. </screenshot>
  648. </sect2>
  649. <sect2 id="summary-view-config-mail">
  650. <title>&kontact; Summary Plugins: Mail</title>
  651. <para>
  652. The <quote>Mail</quote> plugin for &kontact;'s Summary View adds an
  653. area in the view labeled <guilabel>New Messages</guilabel>. This area
  654. is updated every time you receive new messages to inform you how many
  655. of these messages there are and which folder they are in.
  656. </para>
  657. <screenshot>
  658. <screeninfo>&kontact; Mail Summary Plugin</screeninfo>
  659. <mediaobject>
  660. <imageobject>
  661. <imagedata format="PNG" fileref="summary-view-mail.png"/>
  662. </imageobject>
  663. <textobject>
  664. <phrase>&kontact; Mail Summary Plugin</phrase>
  665. </textobject>
  666. <caption>
  667. <para>
  668. &kontact; Mail Summary Plugin
  669. </para>
  670. </caption>
  671. </mediaobject>
  672. </screenshot>
  673. </sect2>
  674. <sect2 id="summary-view-config-newsticker">
  675. <title>&kontact; Summary Plugins: NewsTicker</title>
  676. <para>
  677. The <quote>NewsTicker</quote> plugin for &kontact;'s Summary View adds an
  678. area in the view labeled <guilabel>News Feeds</guilabel>.
  679. This area contains the latest news from the currently configured news
  680. feeds. You can add and remove feeds in &kontact;'s Summary View
  681. Configuration. Please note that as of &kde; 3.4, the more efficient
  682. way of accessing RSS feed information is the new &akregator; application,
  683. which provides notifications instead of requiring constant checking of
  684. the Summary View to see if new articles have appeared.
  685. </para>
  686. <screenshot>
  687. <screeninfo>&kontact; NewsTicker Plugin</screeninfo>
  688. <mediaobject>
  689. <imageobject>
  690. <imagedata format="PNG" fileref="summary-view-newsticker.png"/>
  691. </imageobject>
  692. <textobject>
  693. <phrase>&kontact; NewsTicker Plugin</phrase>
  694. </textobject>
  695. <caption>
  696. <para>
  697. &kontact; NewsTicker Plugin
  698. </para>
  699. </caption>
  700. </mediaobject>
  701. </screenshot>
  702. </sect2>
  703. <sect2 id="summary-view-config-notes">
  704. <title>&kontact; Summary Plugins: Notes</title>
  705. <para>
  706. The <quote>Notes</quote> plugin for &kontact;'s Summary View adds an
  707. area in the view labeled <guilabel>Notes</guilabel>. This area
  708. displays all current notes' titles (titles default to the date/time
  709. the note was created). Clicking on the title of a note will bring up
  710. the Notes area.
  711. </para>
  712. <screenshot>
  713. <screeninfo>&kontact; Notes Summary Plugin</screeninfo>
  714. <mediaobject>
  715. <imageobject>
  716. <imagedata format="PNG" fileref="summary-view-notes.png"/>
  717. </imageobject>
  718. <textobject>
  719. <phrase>&kontact; Notes Summary Plugin</phrase>
  720. </textobject>
  721. <caption>
  722. <para>
  723. &kontact; Notes Summary Plugin
  724. </para>
  725. </caption>
  726. </mediaobject>
  727. </screenshot>
  728. </sect2>
  729. <sect2 id="summary-view-config-todo-list">
  730. <title>&kontact; Summary Plugins: Todo List</title>
  731. <para>
  732. The <quote>Todo List</quote> plugin for &kontact;'s Summary View adds
  733. an area in the view labeled <guilabel>Todos</guilabel>. This area
  734. contains all current todos, including ones that have been completed.
  735. It displays the title of the todo, the percentage of completion, and
  736. the current status of the todo. Note that you can purge all completed
  737. todos via the &kontact; Todo List. Clicking on a todo's title will
  738. currently do nothing.
  739. </para>
  740. <screenshot>
  741. <screeninfo>&kontact; Todo List Summary Plugin</screeninfo>
  742. <mediaobject>
  743. <imageobject>
  744. <imagedata format="PNG" fileref="summary-view-todos.png"/>
  745. </imageobject>
  746. <textobject>
  747. <phrase>&kontact; Todo List Summary Plugin</phrase>
  748. </textobject>
  749. <caption>
  750. <para>
  751. &kontact; Todo List Summary Plugin
  752. </para>
  753. </caption>
  754. </mediaobject>
  755. </screenshot>
  756. </sect2>
  757. <sect2 id="summary-view-config-special-dates">
  758. <title>&kontact; Summary Plugins: Special Dates</title>
  759. <para>
  760. The <quote>Special Dates</quote> plugin for &kontact;'s Summary View adds an
  761. area in the view labeled <guilabel>Special Dates</guilabel>.
  762. This area contains information based on the criteria selected in the
  763. configuration area of the plugin in &kontact;'s Summary View configuration.
  764. The <quote>Special Dates</quote> plugin is especially useful because it can
  765. display birthdays, anniversaries, holidays, and special occasions from both
  766. the calendar and the contact list in one place.
  767. </para>
  768. <screenshot>
  769. <screeninfo>&kontact; Special Dates Plugin</screeninfo>
  770. <mediaobject>
  771. <imageobject>
  772. <imagedata format="PNG" fileref="summary-view-special-dates.png"/>
  773. </imageobject>
  774. <textobject>
  775. <phrase>&kontact; Special Dates Plugin</phrase>
  776. </textobject>
  777. <caption>
  778. <para>
  779. &kontact; Special Dates Plugin
  780. </para>
  781. </caption>
  782. </mediaobject>
  783. </screenshot>
  784. </sect2>
  785. <sect2 id="summary-view-config-weather">
  786. <title>&kontact; Summary Plugins: Weather</title>
  787. <para>
  788. The <quote>Weather</quote> plugin for &kontact;'s Summary View adds an
  789. area in the view labeled <guilabel>Weather Information</guilabel>.
  790. This area contains the information for currently configured weather
  791. locations. For more information about configuring KWeather, the
  792. weather reporter used as a plugin within &kontact;, see the <ulink
  793. url="help:/kweather/configuring-kweather.html"> KWeather
  794. documentation</ulink>.
  795. </para>
  796. <screenshot>
  797. <screeninfo>&kontact; Weather Summary Plugin</screeninfo>
  798. <mediaobject>
  799. <imageobject>
  800. <imagedata format="PNG" fileref="summary-view-weather.png"/>
  801. </imageobject>
  802. <textobject>
  803. <phrase>&kontact; Weather Summary Plugin</phrase>
  804. </textobject>
  805. <caption>
  806. <para>
  807. &kontact; Weather Summary Plugin
  808. </para>
  809. </caption>
  810. </mediaobject>
  811. </screenshot>
  812. </sect2>
  813. </sect1>
  814. <sect1 id="kontact-configure-profiles">
  815. <title>&kontact; Profiles</title>
  816. <para>A profile is an arbitrary set of configuration values for any of the kontact components (mail, calendar, etc.) accompanied by a configuration file for the profile itself, which specifies its name, description etc. An example profile configuration file looks like this:
  817. </para>
  818. <informalexample>
  819. <para>
  820. <literallayout>
  821. [Kontact Profile]
  822. Description=Default KDE Kontact settings
  823. Identifier=KontactDefaults
  824. Name=Kontact Style
  825. </literallayout>
  826. </para>
  827. <para>
  828. The format is the standard .ini file format used for configuration throughout KDE, including in kiosk.
  829. </para>
  830. </informalexample>
  831. <para>
  832. &kontact;'s profile support makes it possible to load and save user settings in profiles.
  833. The settings stored in the profile include typical Look&amp;Feel related options such as app-specific color schemes, icon sets, toolbar layout and application defaults. Personal information, e.g. accounts and identities are not stored in profiles.
  834. </para>
  835. <para>
  836. Two default profiles are provided by Kontact: &quot;&kontact; Style&quot;, which contains the default &kontact; settings, and &quot;Outlook Style&quot;, adapting &kontact; to Microsoft Outlook Look&amp;Feel.
  837. The user can adapt existing profiles, create new profiles from his current settings, and import and export profiles.
  838. </para>
  839. <para>
  840. The dialog opened through Settings -> "Configure Profiles" allows profiles to be imported, exported, created, deleted and saved. They can also be loaded (applied) from there. Saving applies the currently active settings throughout Kontact to the selected profile, while import and export allow existing profiles to be written to or read from directories. To change a setting, one can edit the kontactrc file using a text editor and save it.
  841. </para>
  842. <para>
  843. Apart from the configuration file, a profile directory can contain configuration skeleton files for Kontact as a whole (kontactrc) or for any of the components (korganizerrc, kmailrc, etc.). These files can in turn contain any configuration values that the profile should set (overriding the user's current configuration) when the profile is loaded.
  844. <itemizedlist>
  845. <listitem><para>
  846. The korganizer configuration for the "Kontact Defaults" profile for example sets the calendar view to be merged, by default :
  847. <informalexample>
  848. <para>
  849. [Views]
  850. Agenda View Calendar Display=CalendarsMerged
  851. </para>
  852. </informalexample>
  853. </para>
  854. </listitem>
  855. <listitem><para>
  856. The Outlook-like profile, on the other hand, sets it to be side by side, like in Outlook:
  857. <informalexample>
  858. <para>
  859. [Views]
  860. Agenda View Calendar Display=CalendarsSideBySide
  861. </para>
  862. </informalexample>
  863. </para>
  864. </listitem>
  865. <listitem><para>
  866. If a profile wants to reset or remove a configuration key, it can specify that key like so:
  867. <informalexample>
  868. <para>
  869. [General]
  870. activeBackground=KONTACT_PROFILE_DELETE_KEY
  871. </para>
  872. </informalexample>
  873. </para>
  874. </listitem>
  875. <listitem><para>
  876. This example resets the background color to whatever the KDE style suggests. The Outlook compatability profile sets this key to the Windows/Outlook color style:
  877. <informalexample>
  878. <para>
  879. [General]
  880. activeBackground=47,103,255
  881. </para>
  882. </informalexample>
  883. </para>
  884. </listitem>
  885. </itemizedlist>
  886. </para>
  887. <para>
  888. Currently Kontact ships with two (incomplete) profiles, one which (re-)configures things to look and feel the way Kontact natively does, while the other one attempts to approach the look&amp;feel of Outlook on Windows. To this end they change a variety of things, concretely the color palette used, the icon theme used, how the calendar view is layed out, whether the navigation toolbar is visible how the splitter sizes are initialized, in the main kontact interface.
  889. </para>
  890. </sect1>
  891. </chapter>
  892. <chapter id="command-line">
  893. <title>&kontact; On the Command Line</title>
  894. <para>&kontact; has several command line arguments
  895. that can be used for certain actions.</para>
  896. <para>First of all, &kontact; supports command line arguments
  897. that all KDE/Qt applications support. You can get a full list of
  898. these by typing:
  899. </para>
  900. <para>
  901. <prompt>&percnt;</prompt> <command>kontact --help-all</command>
  902. </para>
  903. <para>&kontact; also supports several command line arguments
  904. specific to it.</para>
  905. <sect1 id="command-line-arguments">
  906. <title>Command Line Arguments</title>
  907. <sect2 id="command-line-module">
  908. <title>Module-related Arguments</title>
  909. <para>To get a list of available &kontact; modules, you can type:</para>
  910. <para>
  911. <prompt>&percnt;</prompt> <command>kontact --list</command>
  912. </para>
  913. <para>Then, to start &kontact; with a module active, type:</para>
  914. <para>
  915. <prompt>&percnt;</prompt> <command>kontact --module <replaceable>moduleName</replaceable></command>
  916. </para>
  917. <para>Where <replaceable>moduleName</replaceable> is one of the modules obtained using the
  918. previous command.</para>
  919. </sect2>
  920. </sect1>
  921. </chapter>
  922. <chapter id="technology">
  923. <title>Under The Hood</title>
  924. <para>&kontact; makes extensive use of several &kde; key technologies, most
  925. notably KParts and &DCOP;.</para>
  926. <para>The &GUI; integration of the components is done by plugins
  927. providing KParts versions of the applications. This only needs a thin
  928. additional layer on top of the already existing code of the
  929. stand-alone applications.</para>
  930. <para>For communication between the components &DCOP; is used. This
  931. has the nice characteristic that it is completely transparent to
  932. whether the application is run stand-alone or embedded as KPart into
  933. &kontact;. When running inside of &kontact; an efficient in-process
  934. mode of &DCOP; is used.</para>
  935. </chapter>
  936. <chapter id="credits">
  937. <title>Credits and License</title>
  938. <para>&kontact;</para>
  939. <para>Program copyright 2004, The &kde; Developers</para>
  940. <para>Contributors:</para>
  941. <itemizedlist>
  942. <listitem><para>Cornelius Schumacher <email>schumacher@kde.org</email></para>
  943. </listitem>
  944. <listitem><para>Daniel Molkentin <email>molkentin@kde.org</email></para>
  945. </listitem>
  946. <listitem><para>Don Sanders <email>sanders@kde.org</email></para>
  947. </listitem>
  948. <listitem><para>Tobias K&ouml;nig <email>tokoe@kde.org</email></para>
  949. </listitem>
  950. <listitem><para>Matthis H&ouml;lzer-Kl&uuml;pfel <email>mhk@kde.org</email>, the
  951. original author of the &kontact; framework.</para>
  952. </listitem>
  953. <listitem><para>All the valued developers of the applications &kontact; is
  954. integrating. They did almost all the work.</para>
  955. </listitem>
  956. </itemizedlist>
  957. <para>Documentation copyright 2004-2005</para>
  958. <para>Contributors:
  959. <itemizedlist>
  960. <listitem><para>Cornelius Schumacher <email>schumacher@kde.org</email></para>
  961. </listitem>
  962. <listitem><para>Antonio Salazar <email>savedfastcool@gmail.com</email></para>
  963. </listitem>
  964. <listitem><para>Daniel Molkentin <email>molkentin@kde.org</email></para>
  965. </listitem>
  966. <listitem><para>All the members of the KDE documentation list who
  967. assisted with markup and style issues.</para>
  968. </listitem>
  969. </itemizedlist>
  970. </para>
  971. <!-- TRANS:CREDIT_FOR_TRANSLATORS -->
  972. <para>&kontact; homepage is at <ulink
  973. url="http://kontact.kde.org">http://kontact.kde.org</ulink></para>
  974. &underFDL;
  975. &underGPL;
  976. </chapter>
  977. &documentation.index;
  978. </book>
  979. <!--
  980. Local Variables:
  981. mode: sgml
  982. sgml-minimize-attributes:nil
  983. sgml-general-insert-case:lower
  984. sgml-indent-step:0
  985. sgml-indent-data:nil
  986. End:
  987. // vim:ts=2:sw=2:tw=78:noet
  988. -->