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.

usage.docbook 18KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648
  1. <chapter id="using-kpilot">
  2. <title>Using &kpilot; Data Viewers and Main Window Interface</title>
  3. <para>
  4. This chapter describes the usage of &kpilot;'s main window; as a viewer
  5. application for data on the &handheld;, and its menu structure.
  6. The main window of &kpilot; also contains
  7. the &HotSync;-log, which can be useful when
  8. debugging problems.
  9. </para>
  10. <para>
  11. &kpilot; starts up with a splash screen, and then switches to showing the
  12. &HotSync;-log, as shown <link linkend="main-app">here</link>.
  13. </para>
  14. <sect1 id="main">
  15. <title>The Main Window</title>
  16. <screenshot id="main-app">
  17. <screeninfo>&kpilot; Main Window</screeninfo>
  18. <mediaobject>
  19. <imageobject><imagedata fileref="main-app.png" format="PNG"/></imageobject>
  20. <textobject><phrase>The Main Window</phrase></textobject>
  21. <caption><para>The Main Window</para></caption>
  22. </mediaobject>
  23. </screenshot>
  24. <para>
  25. The main window contains the application menu, which we will deal with here.
  26. </para>
  27. <para>
  28. The <guimenu>file</guimenu> menu contains the synchronization menu items. Note
  29. that these items do not start the sync process, they only select what the new
  30. sync will be. To really start it, you must press the HotSync button on your
  31. &PalmPilot;'s cradle (or on the &handheld; itself, when there is no cradle).
  32. </para>
  33. <note>
  34. <para>
  35. It is not possible to cancel a sync operation once the request has been made.
  36. </para>
  37. </note>
  38. <para>
  39. For more information regarding the synchronization functionality, please check the
  40. <link linkend="synchronization">Synchronization Chapter</link> of this handbook,
  41. where you can find detailed descriptions of the synchronization methods
  42. and options offered by &kpilot;.
  43. </para>
  44. <variablelist id="menu-file">
  45. <varlistentry>
  46. <term>
  47. <menuchoice>
  48. <guimenu>File</guimenu>
  49. <guimenuitem>HotSync</guimenuitem>
  50. </menuchoice>
  51. </term>
  52. <listitem>
  53. <para>
  54. Make the next sync a &HotSync;. For more information, please check the
  55. <link linkend="sync-s"> Syncing your &handheld; data</link> section of this
  56. handbook.
  57. </para>
  58. </listitem>
  59. </varlistentry>
  60. <varlistentry>
  61. <term>
  62. <menuchoice>
  63. <guimenu>File</guimenu>
  64. <guimenuitem>FastSync</guimenuitem>
  65. </menuchoice>
  66. </term>
  67. <listitem>
  68. <para>
  69. (not available with all installations)
  70. Make the next sync a FastSync. For more information, please check the
  71. <link linkend="sync-s">Syncing your &handheld; data</link> section of this
  72. handbook.
  73. </para>
  74. </listitem>
  75. </varlistentry>
  76. <varlistentry>
  77. <term>
  78. <menuchoice>
  79. <guimenu>File</guimenu>
  80. <guimenuitem>FullSync</guimenuitem>
  81. </menuchoice>
  82. </term>
  83. <listitem>
  84. <para>
  85. (not available with all installations)
  86. Make the next sync a FullSync. For more information, please check the
  87. <link linkend="sync-s"> Syncing your &handheld; data</link> section of this
  88. handbook.
  89. </para>
  90. </listitem>
  91. </varlistentry>
  92. <varlistentry>
  93. <term>
  94. <menuchoice>
  95. <guimenu>File</guimenu>
  96. <guimenuitem>Backup</guimenuitem>
  97. </menuchoice>
  98. </term>
  99. <listitem>
  100. <para>
  101. Make the next sync a full backup of your &PalmPilot; data. This action can take
  102. several minutes. For more information, please check the
  103. <link linkend="backup"> Backing up your &handheld; data</link> section of this
  104. handbook.
  105. </para>
  106. <tip>
  107. <para>
  108. The first thing you should do after starting &kpilot; for
  109. the first time is make a full backup.
  110. </para>
  111. </tip>
  112. </listitem>
  113. </varlistentry>
  114. <varlistentry>
  115. <term>
  116. <menuchoice>
  117. <guimenu>File</guimenu>
  118. <guimenuitem>Restore</guimenuitem>
  119. </menuchoice>
  120. </term>
  121. <listitem>
  122. <para>
  123. This copies all the data from a previous backup on your
  124. <acronym>PC</acronym> to your &PalmPilot;,
  125. replacing whatever data was there.
  126. Use this if your &PalmPilot; suffers some from software or hardware failure
  127. (or is replaced by a new one). For more information, please check the
  128. <link linkend="restore"> Restoring your &handheld; data</link> section of this
  129. handbook.
  130. </para>
  131. <warning>
  132. <para>
  133. Doing a restore will erase all data on the &PalmPilot;
  134. before restoring the information from your
  135. <acronym>PC</acronym>!</para>
  136. </warning>
  137. </listitem>
  138. </varlistentry>
  139. <varlistentry>
  140. <term>
  141. <menuchoice>
  142. <guimenu>File</guimenu>
  143. <guimenuitem>Copy Handheld to PC</guimenuitem>
  144. </menuchoice>
  145. </term>
  146. <listitem>
  147. <para>
  148. This runs all conduits and syncs all databases, but instead of merging the
  149. information from both sources, it will copy the handheld data to the PC.
  150. <emphasis>Use with care, as this option erases the changes
  151. you made in your PC since the last sync</emphasis>.</para>
  152. </listitem>
  153. </varlistentry>
  154. <varlistentry>
  155. <term>
  156. <menuchoice>
  157. <guimenu>File</guimenu>
  158. <guimenuitem>Copy PC to Handheld</guimenuitem>
  159. </menuchoice>
  160. </term>
  161. <listitem>
  162. <para>
  163. This runs all conduits and syncs all databases, but instead of merging the
  164. information from both sources, it will copy the PC data to the handheld.
  165. <emphasis>Use with care, as this option erases the changes
  166. you made in your handheld since the last sync</emphasis>.</para>
  167. </listitem>
  168. </varlistentry>
  169. <!--
  170. <varlistentry>
  171. <term>
  172. <menuchoice>
  173. <guimenu>File</guimenu>
  174. <guimenuitem>List Only</guimenuitem>
  175. </menuchoice>
  176. </term>
  177. <listitem>
  178. <para>
  179. The next sync will only list the databases on your &handheld;, no exchange of
  180. data will be performed.
  181. </para>
  182. </listitem>
  183. </varlistentry>
  184. -->
  185. <varlistentry>
  186. <term>
  187. <menuchoice>
  188. <guimenu>File</guimenu>
  189. <guimenuitem>Quit</guimenuitem>
  190. </menuchoice>
  191. </term>
  192. <listitem>
  193. <para>
  194. Quits &kpilot;, closing the main window and stopping the
  195. daemon if that
  196. <link linkend="stopdaemononexit">configuration option</link>
  197. is enabled.
  198. </para>
  199. </listitem>
  200. </varlistentry>
  201. </variablelist>
  202. <para>
  203. The <guimenu>Settings</guimenu> menu allows you to configure &kpilot; main
  204. interface and fine-tune the synchronization process with the &handheld;.
  205. </para>
  206. <variablelist>
  207. <varlistentry>
  208. <term>
  209. <menuchoice>
  210. <guimenu>Settings</guimenu>
  211. <guimenuitem>Show Statusbar</guimenuitem>
  212. </menuchoice>
  213. </term>
  214. <listitem>
  215. <para>
  216. Click this menu item to toggle &kpilot;'s status bar on and off, or in other
  217. words, to show it if hidden, or to hide it if shown.
  218. </para>
  219. </listitem>
  220. </varlistentry>
  221. <varlistentry>
  222. <term>
  223. <menuchoice>
  224. <guimenu>Settings</guimenu>
  225. <guimenuitem>Show Toolbar</guimenuitem>
  226. </menuchoice>
  227. </term>
  228. <listitem>
  229. <para>
  230. Click this menu item to toggle &kpilot;'s toolbar on and off, or in other
  231. words, to show it if hidden, or to hide it if shown.
  232. </para>
  233. </listitem>
  234. </varlistentry>
  235. <varlistentry>
  236. <term>
  237. <menuchoice>
  238. <guimenu>Settings</guimenu>
  239. <guimenuitem>Configure Shortcuts...</guimenuitem>
  240. </menuchoice>
  241. </term>
  242. <listitem>
  243. <para>
  244. Displays &kpilot;'s shortcut configuration dialog, allowing you change or create
  245. key bindings, which are associations between actions (for example, opening
  246. &kpilot;'s configuration dialog) and keys or key combinations (for instance,
  247. Ctrl + Shift + a).
  248. </para>
  249. </listitem>
  250. </varlistentry>
  251. <varlistentry>
  252. <term>
  253. <menuchoice>
  254. <guimenu>Settings</guimenu>
  255. <guimenuitem>Configure Toolbars...</guimenuitem>
  256. </menuchoice>
  257. </term>
  258. <listitem>
  259. <para>
  260. Displays &kpilot;'s toolbar configuration dialog. This dialog lists all actions
  261. available for use on the toolbar, and the actions currently displayed, allowing
  262. you to add or remove actions, and move the actions which already are on the
  263. toolbar.
  264. </para>
  265. </listitem>
  266. </varlistentry>
  267. <varlistentry>
  268. <term>
  269. <menuchoice>
  270. <guimenu>Settings</guimenu>
  271. <guimenuitem>Configure KPilot...</guimenuitem>
  272. </menuchoice>
  273. </term>
  274. <listitem>
  275. <para>
  276. Displays &kpilot;'s configuration dialog, allowing you to match your hardware
  277. with the configuration, so that &kpilot; can talk with your &handheld;, to
  278. configure the way &kpilot; synchronizes your &PalmPilot; with your
  279. desktop applications (through conduits) and the way it shows the data from your &PalmPilot; in the
  280. <link linkend="builtin">built-in viewers</link>. The <link linkend="configure">
  281. Configuring &kpilot;</link> chapter of this handbook offers detailed information
  282. about these configuration options.
  283. </para>
  284. </listitem>
  285. </varlistentry>
  286. <varlistentry>
  287. <term>
  288. <menuchoice>
  289. <guimenu>Settings</guimenu>
  290. <guimenuitem>Configuration Wizard...</guimenuitem>
  291. </menuchoice>
  292. </term>
  293. <listitem>
  294. <para>
  295. Displays &kpilot;'s configuration wizard dialog. The
  296. <link linkend="configwizard">configuration wizard</link> helps you to set up
  297. &kpilot; to communicate with the &PalmPilot; and to configure the conduits as
  298. a group. It's a great start for new users, and you can always fine-tune your
  299. preferences later, using the <link linkend="configure">configure
  300. dialog</link>.
  301. </para>
  302. </listitem>
  303. </varlistentry>
  304. </variablelist>
  305. </sect1>
  306. <sect1 id="builtin">
  307. <title>
  308. Built-in Applications
  309. </title>
  310. <para>
  311. To select one of the Built in applications, just click its icon on &kpilot;'s
  312. sidebar.
  313. </para>
  314. <screenshot>
  315. <screeninfo>KPilot's Sidebar</screeninfo>
  316. <mediaobject>
  317. <imageobject><imagedata fileref="sidebar.png" format="PNG"/></imageobject>
  318. <textobject><phrase>KPilot's Sidebar</phrase></textobject>
  319. <caption><para>KPilot's Sidebar</para></caption>
  320. </mediaobject>
  321. </screenshot>
  322. <para>
  323. Selecting one of the built-in applications
  324. will cause that application to appear in &kpilot;'s main
  325. window.
  326. You may use the viewer applications to edit the information, by enabling
  327. this option in the <link linkend="page-viewers">database viewer's
  328. configuration dialog</link>. The ability to view and edit private records is
  329. configurable too.</para>
  330. <para>
  331. Any changes you make to the &PalmPilot; databases with
  332. the built-in applications (such as deleting a memo)
  333. do not take effect on the &PalmPilot; until the next HotSync.
  334. </para>
  335. <important><para>
  336. If the <guilabel>Make internal viewers editable</guilabel> option is
  337. not enabled, the changes in the viewers are not synchronized with your
  338. &handheld;, and will be lost. In recent versions of &kpilot; it is not possible
  339. enable this option, and therefore, to edit the databases with the viewers.
  340. </para></important>
  341. <sect2 id="todo-app">
  342. <title>The Todo Viewer</title>
  343. <para>
  344. The todo application allows you to view the tasks from your &PalmPilot;,
  345. add new tasks and edit or delete existing ones. The changes you made
  346. are applied to the &handheld; the next time you &HotSync;.
  347. </para>
  348. <screenshot>
  349. <screeninfo>Todo Viewer Application</screeninfo>
  350. <mediaobject>
  351. <imageobject><imagedata fileref="todo-app.png" format="PNG"/></imageobject>
  352. <textobject><phrase>The Todo Viewer Application</phrase></textobject>
  353. <caption><para>The Todo Viewer Application</para></caption>
  354. </mediaobject>
  355. </screenshot>
  356. <para>
  357. The todo application has a drop down box
  358. for the memo categories defined in the &PalmPilot;.
  359. In the screenshot, category <quote>All</quote> is selected.
  360. Underneath the drop down box is a list of todo entries, with a check box
  361. indicating if they are completed or not. You can click the check box to toggle
  362. the todo item between completed and not completed status. Clicking on one of the
  363. todo items in the list will display its details in the text box labelled
  364. <guilabel>Todo info:</guilabel> to the right.
  365. </para>
  366. <para>
  367. If you have the <guilabel>Make internal viewers editable</guilabel> option
  368. enabled in the <link linkend="page-viewers">viewers configuration page</link> you
  369. can use the buttons <guibutton>Edit Record...</guibutton>,
  370. <guibutton>New Record...</guibutton> and <guibutton>Delete Record</guibutton>
  371. to edit the todo data from your &handheld;, and sync the data in the next
  372. &HotSync;.</para>
  373. <!--
  374. <note><para>
  375. If you create new todo and decide that
  376. you do not want to have it on the &PalmPilot;
  377. you must perform a &HotSync; (copying the todo
  378. to the &PalmPilot;) and then delete the todo record
  379. from the &PalmPilot; or the viewer, and &HotSync; again. It is not possible to
  380. delete newly-added records from the built-in applications.
  381. </para></note>
  382. -->
  383. <para>
  384. The <guibutton>Edit Record...</guibutton> button opens a dialog where you can
  385. edit the details of the currently selected todo item, including description,
  386. priority and end date. Click the <guibutton>New Record...</guibutton> button to
  387. open the same dialog, but instead of editing the current selected record, a new
  388. todo will be added to the list. And finally, click the
  389. <guibutton>Delete Record</guibutton> button to remove the selected todo record
  390. from the list.
  391. </para>
  392. </sect2>
  393. <sect2 id="address-app">
  394. <title>The Address Viewer</title>
  395. <para>
  396. The address viewer lets you view, create, delete and edit addresses
  397. from the &PalmPilot;, and synchronize changes back. The addresses can be
  398. sorted and viewed in the <guilabel>"Last, first"</guilabel> or <guilabel>"Company,
  399. last"</guilabel> format, depending on your
  400. <link linkend="page-viewers">viewers configuration.</link>
  401. </para>
  402. <screenshot>
  403. <screeninfo>The Address Viewer Application</screeninfo>
  404. <mediaobject>
  405. <imageobject><imagedata fileref="address-app.png" format="PNG"/></imageobject>
  406. <textobject><phrase>The Address Viewer Application</phrase></textobject>
  407. <caption><para>The Address Viewer Application</para></caption>
  408. </mediaobject>
  409. </screenshot>
  410. <para>
  411. The address application resembles the todo application;
  412. the drop down box, buttons, list and text area function exactly
  413. the same, allowing you to select, view and edit an address
  414. as on the &PalmPilot;.
  415. </para>
  416. <para>
  417. The <guibutton>Edit Record...</guibutton> dialog allows you to edit the
  418. <guilabel>Last Name</guilabel>, <guilabel>First Name</guilabel>,
  419. <guilabel>Company</guilabel>, &etc; fields, just as if you where using your
  420. &handheld;. Click the <guibutton>New Record...</guibutton> button to
  421. open the same dialog, but instead of editing the current selected record, a new
  422. address will be added to the list. Click the
  423. <guibutton>Delete Record</guibutton> button to remove the selected address
  424. from the list.
  425. <!--
  426. <note><para>
  427. If you create new address and decide that
  428. you do not want to have it on the &PalmPilot;
  429. you must perform a &HotSync; (copying the address
  430. to the &PalmPilot;) and then delete the address record
  431. from the &PalmPilot; or the viewer, and &HotSync; again. It is not possible to
  432. delete newly-added records from the built-in applications.
  433. </para></note>
  434. -->
  435. </para>
  436. </sect2>
  437. <sect2 id="memo-app">
  438. <title>The Memo Viewer</title>
  439. <para>
  440. The memo application allows you to view the memos on your &PalmPilot;,
  441. export them to text files, import new ones to be installed the next
  442. time you &HotSync;, or edit existing ones.
  443. </para>
  444. <screenshot>
  445. <screeninfo>Memo Viewer Application</screeninfo>
  446. <mediaobject>
  447. <imageobject><imagedata fileref="memo-app.png" format="PNG"/></imageobject>
  448. <textobject><phrase>The Memo Viewer Application</phrase></textobject>
  449. <caption><para>The Memo Viewer Application</para></caption>
  450. </mediaobject>
  451. </screenshot>
  452. <para>
  453. The memo application has a drop down box
  454. for the memo categories defined in the &PalmPilot;.
  455. Here category <quote>All</quote> is selected.
  456. Underneath the drop down box is a list of memo titles.
  457. These are the first lines of the memos, just like
  458. in the &PalmPilot; memo application.
  459. Clicking on one of the memo titles in the list
  460. box will display it in the text box labelled
  461. <guilabel>Memo Text:</guilabel> to the right.
  462. </para>
  463. <para>
  464. When a memo is selected, you can use the buttons
  465. <guibutton>Export Memo...</guibutton> and
  466. <guibutton>Delete Memo</guibutton>
  467. to export the selected memo to a file
  468. or to delete the selected memo.
  469. Exporting a memo requires
  470. you to give a filename; the memo
  471. is written to that file.
  472. Take care not to overwrite existing files with this action.
  473. Deleting a memo does not affect the &PalmPilot;
  474. until the next &HotSync;.
  475. </para>
  476. <para>
  477. The
  478. <guibutton>Import Memo...</guibutton>
  479. button allows you to read a text file and
  480. add it &mdash; as a memo &mdash; to the &PalmPilot;.
  481. Importing a memo does not take effect until
  482. the next &HotSync;.
  483. <!--
  484. <note><para>
  485. If you import a memo and decide that
  486. you do not want to have it on the &PalmPilot;
  487. you must perform a &HotSync; (copying the memo
  488. to the &PalmPilot;) and then delete the memo record
  489. from the &PalmPilot; or the viewer, and &HotSync; again. It is not possible to
  490. delete newly-added records from the built-in applications.
  491. </para></note>
  492. -->
  493. </para>
  494. </sect2>
  495. <sect2 id="db-app">
  496. <title>The Generic DB Viewer</title>
  497. <para>
  498. In short, databases are all files stored in your &handheld;. A database
  499. can be either a record database, which stores dynamic information created by the
  500. user (for instance, the addresses or the todo information), or a resource
  501. database, which tend to be static (for instance the applications).
  502. </para>
  503. <para>
  504. The Generic DB Viewer is a tool to view and analyze databases stored on
  505. your handheld, especially record databases. It helps a lot creating new conduits
  506. and to debug existing ones.
  507. <warning><para>
  508. While it is possible use the database viewer to edit, add and delete records, you
  509. should really know what you are doing, otherwise you may damage your data. Use
  510. the viewer applications or conduits to edit your &handheld; data instead, in a
  511. normal usage scenario.
  512. </para></warning>
  513. </para>
  514. <screenshot>
  515. <screeninfo>The Generic DB Viewer</screeninfo>
  516. <mediaobject>
  517. <imageobject><imagedata fileref="db-app.png" format="PNG"/></imageobject>
  518. <textobject><phrase>The Generic DB Viewer</phrase></textobject>
  519. <caption><para>The Generic DB Viewer</para></caption>
  520. </mediaobject>
  521. </screenshot>
  522. </sect2>
  523. <sect2 id="installer-app">
  524. <title>The File Installer</title>
  525. <para>
  526. Just hit the
  527. <guibutton>Add File...</guibutton> button to add a file to the
  528. <guilabel>Files to Install:</guilabel> list. These files will
  529. be installed on your &PalmPilot; during the next &HotSync; if
  530. <guilabel>Sync Files</guilabel>
  531. is checked in the conduits section of the
  532. <link linkend="configure">configuration dialog</link>.
  533. If you choose not to
  534. install these files on the &PalmPilot;, just hit
  535. <guibutton>Clear List</guibutton>
  536. to remove any pending files.
  537. </para>
  538. <para>
  539. If you are using the &HotSync; Daemon you may drag and
  540. drop files or &URL;s
  541. onto the docked icon on the toolbar. The file installer application also
  542. supports dragging and dropping into the <guilabel>Files to Install:</guilabel>area.
  543. Provided <guilabel>Sync Files</guilabel> is checked in the
  544. <link linkend="page-general">settings dialog</link> they
  545. will be installed the next time you HotSync.
  546. </para>
  547. <tip>
  548. <para>An internal copy of the
  549. file is kept, so you can even drag and drop &URL;s from
  550. &konqueror;!
  551. </para>
  552. </tip>
  553. <screenshot>
  554. <screeninfo>The File Installer</screeninfo>
  555. <mediaobject>
  556. <imageobject><imagedata fileref="file-app.png" format="PNG"/></imageobject>
  557. <textobject><phrase>The File Installer</phrase></textobject>
  558. <caption><para>The File Installer</para></caption>
  559. </mediaobject>
  560. </screenshot>
  561. </sect2>
  562. </sect1>
  563. </chapter>