diff --git a/doc/docbook-reference.docbook b/doc/docbook-reference.docbook index f67510cd..7f5fc8d7 100644 --- a/doc/docbook-reference.docbook +++ b/doc/docbook-reference.docbook @@ -1,793 +1,793 @@ David C. Bryant
davidbryant@gvtc.com
 2019 David C. Bryant &CCBYSA4Notice; 2019-08-26 5.10.3 (Applications 18.12.3) &kaddressbook; is a very complicated program with lots of built-in features. Some of the more advanced features of &kaddressbook; are documented in this appendix, primarily to keep the main document from getting too large and unwieldy. KDE KAddressBook kdepim Email &kaddressbook; Advanced Features Reference Section The New Group Dialog When you invoke the New Group function, a dialog will begin, as shown below. A screenshot of &kaddressbook;'s New Group dialog. A screenshot of &kaddressbook;'s New Group dialog. &kaddressbook;'s New Group dialog after choosing the FileNew   > New Group function.   Use the Add To: drop-down box to choose the address book to which the new group should be added. Use the Name field to give the new group a name. Enter e-mail addresses, or portions of email addresses, in the blue + area. A list of potential matches will appear. Select an item in the list that pops up, and a new name will be added to the list. Continue adding individual contacts to the list until it is complete, then click the  ✔ OK  button to add this group to your address book. If you want to delete a name from the list, click the icon to the right of that particular name. If you need to make changes to the group later, simply select the group and use the Edit menu, or the Edit Contact button on the toolbar, to open a substantially similar dialog that will let you make the desired changes. The &kmail; program provides an alternative method of creating a new group in &kaddressbook;. After you have addressed an e-mail message to several people, you are given the option of adding a new group to your address book, as shown below. A screenshot of &kmail;'s New Group dialog. A screenshot of &kmail;'s New Group dialog. &kmail;'s New Group dialog after choosing the  Save List...   function.   After addressing a message to a group of people, clicking the  Save List...  button to the right of the address input area will cause the illustrated dialog box to appear. Give the list a name and left click the  Save List  button. Another dialog box will pop up, asking you to select an address book. Make your selection, and a new group will be created for you. Click here to return to the Table of Contents for this Appendix. The Print-Preview Dialog &kaddressbook;'s Print Preview function lets you tailor a hard-copy of your address book data just about any way you want. A screenshot of &kaddressbook;'s Print Preview dialog. A screenshot of &kaddressbook;'s Print Preview dialog. &kaddressbook;'s Print Preview dialog. You may select one or more entire address books, or just a smattering of individual contacts.   The first step is to select the contacts to be included in the printout. If you wish to print just a smattering of individual contacts, you must choose the contacts to be printed before invoking the Print Preview dialog. If you wish to select all your contacts, or all the contacts in a particular address book, you can do it here. Click Next when you have made your selection. A new screen will appear. A second screenshot of &kaddressbook;'s Print Preview dialog. A screenshot of &kaddressbook;'s Print Preview dialog. The second screen in &kaddressbook;'s Print Preview dialog. You may choose a sort field and a sort direction (up or down). You may also choose among seven different print layouts.   Here you can choose a sort field (any one of the 47 named fields in the contact record), the direction of the sort, and any one of seven different report formats. When you click Next, you will be given a chance to tailor the color scheme to be used. - A third screenshot of &kaddressbook;'s Pint Preview dialog. + A third screenshot of &kaddressbook;'s Print Preview dialog. A third screenshot of &kaddressbook;'s Print Preview dialog. The third screen in &kaddressbook;'s Print Preview dialog. You may select a color scheme here.   Here is a picture of the completed report. It is now ready for printing. - A screenshot of &kaddressbook;'s Pint Preview dialog. + A screenshot of &kaddressbook;'s Print Preview dialog. A screenshot of &kaddressbook;'s Print Preview dialog. &kaddressbook;'s Print Preview after the report has been generated and is ready to print. You may select alternative print orientations (landscape or portrait) and launch the print task from this window.   Click here to return to the Table of Contents for this Appendix. The Configure LDAP Dialog Here is a picture of the first configuration screen that appears when you choose either the Configure LDAP Servers... button in the File Import   >Import from LDAP Server... dialog or the Settings Configure &kaddressbook;... menu item. A screenshot of &kaddressbook;'s Configure LDAP Server dialog. A screenshot of &kaddressbook;'s Configure LDAP Server dialog. &kaddressbook;'s Configure LDAP Server dialog after choosing the FileImport   >Import from LDAP Server... function and left clicking the Configure LDAP Servers... button.   If you have already configured one or more LDAP servers, use this screen to select the servers that should be queried when you search for a name or email address. Use the Add host... button to add a new server to the list of available LDAP hosts. Use the Edit host... button to reconfigure a server that's already on the list, and the Remove host button to delete an entry you don't need any more. The Reset button can be used to undo the last Add or Remove action performed. The Defaults button is inoperative in release 5.10.3. The rest of the buttons (OK, Apply, Cancel) have their ordinary functions: apply changes and exit, apply changes and stay here, and exit the dialog without making any changes, respectively.   When you choose either the Add host... button or the Edit host... button, the following dialog will appear. A second screenshot of &kaddressbook;'s Configure LDAP Server dialog. A second screenshot of &kaddressbook;'s Configure LDAP Server dialog. &kaddressbook;'s Configure LDAP Server dialog after left clicking either the Add Host... or the Edit Host... button.   The first four fields (User:, Bind DN:, Realm:, and Password:) will all be grayed out unless authentication is required. Obtain these credentials from the LDAP server's administrator. Enter the appropriate URI in the Host: field. The default values for Port:, Size limit:, &etc; will work OK for most users. You can use the Query Server button to set up the DN: field. I have no idea what the Filter: field is for. If you figure it out, please let me know (davidbryant AT gvtc.com). Use the Security section to specify the encryption method to use: No for an unencrypted connection, TLS for Transport Layer Security, or SSL for Secure Socket Layer. Use the Authentication options to specify what level of authentication the server requires: Anonymous for no name or password at all, Simple if Bind DN and Password must be given, and SASL (Simple Authentication and Security Layer) for the whole schmear (four data items). If SASL is chosen, use the Query Server button to set the advanced options for this host.   Click here to return to the Table of Contents for this Appendix. The Import CSV File Function When you choose the FileImport   > Import CSV file... function, you will be presented with a dialog. After you click the button and choose the file to be imported, the screen will look like this. A screenshot of &kaddressbook;'s Import CSV File dialog. A screenshot of &kaddressbook;'s Import CSV File dialog. &kaddressbook;'s Import CSV File dialog after choosing the FileImport   >Import CSV file... function and selecting the file to be imported.   Use the Delimiter section of this dialog to specify which separator character defines the end of a field in the chosen input file. If quote marks are used to delimit fields with embedded separator characters, you may specify the style (single or double quote) used via the Text quote: drop-down box. If the input file contains dates, use the Date format: field to define the way dates have been encoded. The default is yyyy-mm-dd. If that's the wrong format, hover your cursor over the Date format: box and a handy set of formatting instructions will be displayed. If the input file is not UTF-8 encoded, use the Text codec: drop-down box to specify the binary encoding scheme to use. If the first row of the file contains column headers, check the Skip first row of file box to avoid importing the column headers as data. Use the Undefined boxes at the top of each column to specify which data fields are to be imported, and where they should be stored, as shown below. A second screenshot of &kaddressbook;'s Import CSV File dialog. A second screenshot of &kaddressbook;'s Import CSV File dialog. &kaddressbook;'s Import CSV File dialog after choosing the FileImport   >Import CSV file... function, selecting the file to be imported, and beginning to define the fields to be imported.   If you wish the contents of the current column to be imported, choose a destination from the list of field names appearing beneath the blue Undefined box. See the next section for a list of the pre-defined fields. Use the horizontal scrollbar near the bottom of the dialog to view all the columns in the input file. When your selections are complete, click the  ✔ OK  button. If you have defined multiple address books, you will be asked to specify which address book is to be used. &kaddressbook; will then import the selected data as new contacts. If you intend to import additional datasets in the same format sometime in the future, you may click the Save template... button (cf. the first illustration in this section) to save the selections you have made. You will be prompted to give the template a name. Later, when you import another file with the same layout, you can save time by clicking the Apply template... button. Click here to return to the Table of Contents for this Appendix. The Export CSV File Function When you invoke the FileExport  >Export CSV file ... function, a dialog box appears. A screenshot of &kaddressbook;'s Export CSV File dialog. A screenshot of &kaddressbook;'s Export CSV File dialog. &kaddressbook;'s Export CSV File dialog after choosing the FileExport   >Export CSV file ... function.   You may select all your contact data, or just a portion of it. When you press the  ✔ OK  button, you will be allowed to choose the name of the generated file, and the directory in which it will be written. The output file will contain the following forty-seven (47) output fields, in this order, left to right. This list of field names is included as the first record in the file. Formatted Name | Honorific Prefixes | Given Name | Additional Names | Family Name | Honorific Suffixes | Nick Name | Birthday | Anniversary | EMail (preferred) | EMail (2) | EMail (3) | EMail (4) | Home Address Street | Home Address Post Office Box | Home Address City | Home Address State | Home Address Zip Code | Home Address Country | Home Address Label | Business Address Street | Business Address Post Office Box | Business Address City | Business Address State | Business Address Zip Code | Business Address Country | Business Address Label | Home Phone | Business Phone | Mobile Phone | Home Fax | Business Fax | Car Phone | ISDN | Pager | Mail Client | Title | Role | Organization | Note | Homepage | Blog Feed | Profession | Office | Manager | Assistant | Spouse All fields are formatted as character class data. Dates (Birthday and Anniversary, if present) are coded as yyyy-mm-dd (Year, Month, Day). Click here to return to the Table of Contents for this Appendix. The Change Number of Columns Function When you open the View menu, the following screen appears. A screenshot of &kaddressbook;'s View menu. A screenshot of &kaddressbook;'s View menu. &kaddressbook;'s View menu after choosing the View menu on the main Menubar.   Not happy with the hum-drum three column layout appearing above? Jazz things up a little with this minimalist approach. A screenshot of &kaddressbook;'s single panel layout. A screenshot of &kaddressbook;'s single panel layout. &kaddressbook;'s Simple (one column) layout. Only the basic contact data are visible.   Notice that the information about which address books exist and are in use is not visible when this Simple layout is in effect. Only the contacts from the address books that were selected before choosing this view are displayed.   If the Simple layout does not appeal to you, you may want to try the Two columns style. A screenshot of &kaddressbook;'s double panel layout. A screenshot of &kaddressbook;'s double panel layout. &kaddressbook;'s Two columns layout. The list of address books is stacked on top of the alphabetized contact list.   At &kde;, our motto is "Be Free!" We aim to give you maximum flexibility when it comes to tailoring and configuring our software to suit your tastes. We toyed with the idea of adding even more views to &kaddressbook; (Four columns! Five!), but eventually concluded that enough is enough.   Click here to return to the Table of Contents for this Appendix. The Configure Shortcuts Option When you first select the Settings Configure Shortcuts... option, this is what you will see. A screenshot of &kaddressbook;'s Configure Shortcuts dialog. A screenshot of &kaddressbook;'s Configure Shortcuts dialog. &kaddressbook;'s Configure Shortcuts dialog. Use the Search field, or the vertical scrollbar, to locate the action for which a new keyboard shortcut is to be defined.   The &kaddressbook; actions for which keyboard shortcuts have already been defined are clearly marked in the Shortcut column. You may either assign additional shortcuts via the Alternate, Global, and Global Alternate columns in this table, or assign a new shortcut to an action for which no keyboard shortcut has as yet been defined. Select the action to be configured by clicking its name, as illustrated above.   When you left-click the None button, its name will change to Input...; you can then record the combination of keystrokes you wish to assign to the selected action. (Hover the cursor over the None button to view a handy hint about this procedure.) The program will note which keys you have pressed, and record the new keyboard shortcut, as illustrated below. If you choose a combination that conflicts with an existing shortcut assignment, you will see an error message, and you will be prompted to make a different selection. You may use the button to erase your selection. A second screenshot of &kaddressbook;'s Configure Shortcuts dialog. A second screenshot of &kaddressbook;'s Configure Shortcuts dialog. &kaddressbook;'s Configure Shortcuts dialog after a new keyboard shortcut has been entered, but before the new configuration has been saved.   Click the  ✔ OK  button to save your changes. Click on  ⦸ Cancel  to exit without saving your changes. Click Defaults to restore &kaddressbook;'s default set of keyboard shortcuts. Choose  Manage Schemes >>  to integrate your custom assignments into a larger scheme of shortcut assignments; see the Customizing KDE Software chapter in the Fundamentals handbook for more details. You may select the Print button to produce a hard-copy version of the keyboard shortcut assignments. Here is a sample from the printed table. A screenshot of &kaddressbook;'s Print output. A screenshot of &kaddressbook;'s Print output. An excerpt from &kaddressbook;'s printed list of keyboard shortcuts.   Click here to return to the Table of Contents for this Appendix. The Configure Toolbars Option Here is a picture of the screen that appears when you click on the Settings Configure Toolbars... menu item. A screenshot of &kaddressbook;'s Configure Toolbars dialog. A screenshot of &kaddressbook;'s Configure Toolbars dialog. &kaddressbook;'s Configure Toolbars dialog. Actions that are already displayed on the Toolbar appear in the large window on the right. Actions in the left-hand window may be added to the Toolbar, as explained below.   Use either one of the Filter fields to restrict the range of choices displayed in the corresponding window. Select an action in the left-hand window (as shown above) if you wish to add it to the Toolbar. Left click the button to add the item to the list in the right-hand window (and thence to &kaddressbook;'s Toolbar). If you want to delete an item from the Toolbar simply reverse the procedure: highlight the item to be deleted from the right-hand window and click the button. The selected item will be removed from the Toolbar. You may tailor the order in which selected items appear on the Toolbar by using drag and drop within the right-hand window. The order of items on the Toolbar, left to right, corresponds with the order in the window, top to bottom. You may make additional changes to the appearance of the Toolbar by using the Change Icon... button to alter the icon associated with a particular action. Similarly, you may change the description of each item on the Toolbar by clicking the Change Text... button. Use the Defaults button to restore the default Toolbar settings. Choose OK to save your changes and exit the dialog, Apply to apply your changes while keeping the dialog open, or Cancel to exit the dialog without saving your changes. (See the Customizing KDE Software chapter in the Fundamentals handbook for a more detailed explanation of this procedure.)   Click here to return to the Table of Contents for this Appendix. The Configure &kaddressbook; Option When the SettingsConfigure &kaddressbook;... option is selected, this screen will appear. A screenshot of &kaddressbook;'s Configure &kaddressbook; dialog. A screenshot of &kaddressbook;'s Configure &kaddressbook; dialog. &kaddressbook;'s Configure Contact Actions dialog. These features are still experimental, and not yet entirely operational.   The first dialog that appears supports experimental features that have not yet been completely implemented. You may select from several different options under the headings Show Address, Dial Phone Number, or Send SMS, but there isn't yet any software to do anything with the options you choose.   The next option, LDAP Server Settings, is the same dialog that is documented in the preceding section entitled The Configure LDAP Dialog. A second screenshot of &kaddressbook;'s Configure &kaddressbook; dialog. A second screenshot of &kaddressbook;'s Configure &kaddressbook; dialog. &kaddressbook;'s LDAP Server Settings dialog. This dialog, and its child, are documented in a preceding section of this appendix.   The final set of options for configuring &kaddressbook; appears when you select Plugins. A third screenshot of &kaddressbook;'s Configure &kaddressbook; dialog. A third screenshot of &kaddressbook;'s Configure &kaddressbook; dialog. &kaddressbook;'s Plugins dialog. There are ten plugins all together. Seven of them have been activated by default, as shown above.   The actions supported by the seven default Plugins are documented in preceding sections of this manual. The Import Export GMX and Import/Export LDIF actions will appear as part of the File menu when activated. The Check Gravatar item will appear in the Tools menu when it is activated. Notice that &kaddressbook; must be stopped and restarted before any changes to the Plugins will take effect.   Click here to return to the Table of Contents for this Appendix. Credits and Licenses &kaddressbook; Copyright © 2007–2019 KAddressBook authors montel@kde.org Documentation Copyright © 2019 David C. Bryant davidbryant@gvtc.com &underCCBYSA4; Click here to return to the Table of Contents for this Appendix.