# Using &appname;

## Quick Start

By default, &appname; starts with an empty book collection. To work with some other type of collection, create it using the File New menu item, or the button on the toolbar. Collections are populated with some of the more common fields, but you can add, modify, or delete them to suit your needs.

New entries can be added by using the &entry-editor;. The Collection New Entry menu item will open the &entry-editor; with an empty entry ready for editing. The &entry-editor; can also be opened by using the Settings Show &entry-editor; menu item. Once you've entered the values for the entry, you can save it to the collection by using the Save Entry button in the &entry-editor; dialog, which remains open in case you want to continue adding new entries. Once you've saved an entry in the collection, you can modify it by clicking on it in the main window. If the &entry-editor; is not already open, you can double click an entry to open the editor and start editing.

If you want to include an image in the entry, you can use the standard &kde; File Selector by clicking the Select Image... button in the &entry-editor;, or you can drag an image from the file manager or web browser into the &entry-editor;.

When you select an entry, the &entry-view; shows a formatted view of the entry's contents. You can change the template used for showing the entry in the &config-dialog;.

The entries in the collection are grouped together when they share the same values for certain fields, such as the author or director. You can change the field used for grouping by using the combo box in the toolbar or the Settings Group Selection menu item.

You can use the &quick-filter; in the toolbar to quickly limit the visible entries to ones which contain the word you type. The filter is also useful when you want to quickly find an entry. You can type in the title or some other unique word that identifies the entry and the &detailed-view; will only show the entries that match the filter. The status bar shows you how many entries are in the collection, and how many are currently being filtered.

## General Usage

The main window has three distinct areas, all of which show information about the collection in a different manner. The primary view is the &detailed-view; in the upper right area, where the value of every field for each entry may be shown. On the left side, tabs hold the &group-view;, which can be used to sort the entries into groups in a tree-structure, the &filter-view;, which is used to track which entries meet cerrtain critera, and the &loan-view;, where any loans are listed. Finally, the &entry-view; shows a formatted view of the data for a single entry, or an icon view of a group of entries, in the lower right.

The &appname; Main Window
The &appname; Main Window

### &detailed-view;

Any of the fields in the collections may be shown in the &detailed-view;, although Paragraph, Image, and Table fields will probably not be useful. Right-clicking on the header of the view opens a menu for selecting the visible fields. The columns may be resized and reordered in any way, and the settings will be saved between sessions.

### &group-view;

The &group-view; groups the entries in a tree-view by any field which allows grouping. The number of entries in each group is shown next to the group name. Groups may be expanded or collapsed by clicking the plus sign, or by double-clicking the item. Expanding and contracting all the groups are options in the right-click context menu. The tree may be sorted either by the group name, or by the count, by clicking on the header. A group may also be used as a filter for the &detailed-view;, by right-clicking on the group item.

When more than one field in the collection has the Format as name option turned on, an additional group is added to combine all those fields into one single People pseudo-group.

If an entry does not contain a value for the field being used to form the groups, it is placed in the (Empty) group, which uses a red folder.

### &filter-view;

If any filters are saved for the collection, the &filter-view; becomes active. As you add or modify entries, they will automatically be checked against the filters and add or removed as appropriate. The filter may be modified by double-clicking on the item to open the &filter-dialog;. Right-clicking gives you the option to delete it altogether.

The &filter-view;
The &filter-view;

### &loan-view;

Once entries are checked-out on loan, the &loan-view; is added to the window, so those borrowed entries may be tracked. Loans are tracked on a per-entry bases, so right-clicking on an entry item has an option for modifying the loan using the &loan-dialog;.

The &loan-view;
The &loan-view;

### &entry-view;

A formatted representation of the entry's values is shown in the &entry-view;. Templates are used for the layout and any additional graphics. Separate templates for each type of collection may be specified in the &config-dialog;, along with custom colors and fonts.

All of the default templates honor the color and font selection, but other custom templates might now. The default templates also make &URL; fields active, which will open up with the default &kde; file association. When exporting to &html;, the current template is used for exporting the individual entry files.

In addition, when multiple entries are selected, an icon view is shown, using the first Image field in the collection. Entries may be selected as in the &detailed-view;. Right-clicking in the icon view will show a menu that changes the sorting criteria for the entries.

### Statusbar

The status bar is used to show you what &appname; is currently doing. It also includes a total count of the entries in the collection, and if a filter is being used, how many are currently visible.

## Editing Entries

The &entry-editor; is used to add and modify entries in the collection. Double-clicking on an entry in either the &group-view; or the &detailed-view; opens the &entry-editor; with that entry. New entries may be created using the Collection menu, the toolbar icon, or the button in the &entry-editor; itself.

The arrow buttons on the bottom will move to the previous or next entries in the current list.

Closing the &entry-editor; when changes have been made but not saved will cause a warning message to appear. The fields are grouped by category and appear in the order that they appear in the &fields-dialog;. They may also be reordered.

The &entry-editor;
The &entry-editor;

Clicking the field title for a &URL; field will open the link using the default &kde; file association. The &URL; selector button beside the text entry will open the default &kde; File Open Dialog, but the field is not limited to local files.

For Image fields, the Select Image... button opens up the &kde; image file selection dialog. The image is saved in the collection in the original format, and a scaled version is shown in the &entry-editor;. The image may be cleared by using the Clear button. Cleared images are removed from the collection.

The &entry-editor; for Image fields
The &entry-editor; for Image fields

The edit widget also supports drag-and-drop. Dragging an image file from a file-manager or browser window does the same thing as selecting the image in the File Selector. Dragging an image from the edit widget into a &konqueror; file manager window will save the image in that folder.

By default, the images are stored in the collection data file, keeping everything contained in one location. However, too many images will cause &appname; to slow down significantly as well result in a very large data file. Alternatively, &appname; can save the images separately, either in the `$`KDEHOME`/share/apps/tellico/data/` directory or in a directory in the same location as the data file. Loading and saving data files is much faster if images are stored separately, but the data files are no longer portable or archivable. Self-contained data files can always be created by using the File Export Export to Zip... menu item.

Table fields begin with five rows, but moving the cursor to the last row automatically adds another. For multi-column tables, only the first column is used for grouping or formatting.

The &entry-editor; for Table fields
The &entry-editor; for Table fields

### Editing Multiple Entries

Multiple entries may be edited at the same time by selecting more than one in either the &group-view; or the &detailed-view;. If multiple entries are selected, the fields which contain the same value in every entry are enabled. If entries have different values, then the fields are disabled. Check boxes are added to the extreme right for each field entry which control whether the field is enabled or not, as shown in the screenshot below.

Only enabled fields will be modified when the entries are saved, which makes large-scale editing much easier. For example, to set the Medium of all the video entries in the collection, make sure the Medium field is enabled. Change it to DVD, then save the entries. Only the Medium field will be modified, preserving all the other field values for the entries.

The &entry-editor; for multiple entries
The &entry-editor; for multiple entries

### Updating Entry Data

Entries may be automatically updated by querying the data sources available for the current collection type, which is very useful for combining information from multiple sources. For example, you may add a movie to your collection using the Amazon.com Web Services, and then update the entry with additional information from the Internet Movie Database.

Only empty fields are updated unless the setting for that source allows results to overwrite existing information. For external scripts, an update field must be specified in the source options.

The entry updating may be started via the right-click menu for an entry, or by using the Collection Update Entry menu item.

## Editing Fields

The &fields-dialog; allows you to add new fields to the collection, to modify the existing ones, or to delete fields altogether.

The &appname; &fields-dialog;
The &appname; &fields-dialog;

### Field List

On the left side of the dialog is the list of the current fields. Modified fields are shown in bold italics. The buttons below the list will add or delete a field, and the arrows can be used to change their order. The order of the fields in the list is important because the &entry-editor; uses the order for its layout. For each category, the fields will be laid out from left to right, according to the top-to-bottom order of the fields in the list.

### Field Properties

A field is defined by its title, type, category, description, and possibly a default value or some allowed values. The title is used everywhere to refer to the field in the user interface. The &entry-editor; uses it to prompt for values. The &detailed-view; uses it as a column header. The different types of fields are explained in the Field Types section. The description is used as a tooltip in the &entry-editor;, perhaps to provide an explanation of the field's contents. In addition, for Dependent fields, the description is used to format the field's value. The default value is automatically added when creating a new entry. The list of allowed values for Choice fields should be separated by a semi-colon.

New fields may be any type, but changing the type of existing fields is restricted to compatible types, as shown in the table below:

#### Allowable Field Type Changes

Current Type | New Type Allowed
--- | ---
Simple Text | Simple Text, Paragraph, Number, URL, Table
Paragraph | Simple Text, Paragraph
Choice | Simple Text, Paragraph, Choice, Number, URL, Table
Checkbox | Simple Text, Paragraph, Checkbox, Number, URL, Table
Number | Simple Text, Paragraph, Number, URL, Table
URL | Simple Text, Paragraph, Number, URL, Table
Date | Simple Text, Date
Table | Simple Text, Paragraph, Table
Image | Image
Rating | Choice, Rating
Dependent | Dependent

### Field Formatting

&appname; provides some capability for automatic formatting of field values. The simplest is auto-capitalization, which capitalizes every word except the articles. Title formatting moves certain articles from the beginning to the end of the field, for example, changing "The Return of the King" to "Return of the King, The". The title articles are configurable. Finally, name formatting tries to break up the string so that the last, or family, name of the person is shown first. Name prefixes and suffixes are configurable. Also, the special People group uses all fields with name formatting, even if the global setting is turned off.

All automatic formatting can be disabled by changing the global options in the &config-dialog;. Globally, capitalization is a distinct option from formatting, so a title can be auto-formatted without being capitalized. Not all field types allow auto-formatting.

#### Formatting Examples

Format Type | Field Value | Auto-Capitalized | Auto-Formatted | Auto-Capitalized & Auto-Formatted
--- | --- | --- | --- | ---
Title | the return of the king | The Return of the King | return of the king, the | Return of the King, The
Name | tom swift, jr. | Tom Swift, Jr. | swift, jr., tom | Swift, Jr., Tom

### Field Options

Fields also have three general options. If auto-completion is enabled, &appname; caches the values for each field, and the &entry-editor; offers automatic completion, using the standard &kde; settings. Not all field types allow auto-completion. &appname; also needs to know if a field may have multiple values or may be used to group the entries. A semi-colon is used to separate multiple values when editing an entry;

For efficiency, do not enable auto-completion unless you need it for the fields. The more fields with auto-completion in the collection, the slower it takes &appname; to load the file.

## Filtering Entries

The &filter-dialog; allows you to limit the entries visible in the &detailed-view; to those that match one or more filter rules. The filter may be used to find the entries that meet all of the rules in the dialog, or just to find those that meet any of them. The &filter-dialog; is also useful for advanced searching within a collection.

The &appname; &filter-dialog;
The &appname; &filter-dialog;

Each row contains a single filter rule. Select the field to match in the first box in the row, then select a matching rule in the center. Rules may match values that contain a certain word, or are exactly equal. A regular expression may also be used to match entries, in which case the Edit... button becomes active for editing the expression. Finally, the word or string to match should be entered in the text box.

Up to eight (8) rules may be used in the filter. The More and Fewer buttons may be used to add or remove rules.

Filters may be saved, so that all entries which match are grouped together in the &filter-view;. The view is dynamic, so ad entries are added or modified, the group is automatically updated. To save the filter, enter a name in the text box, and lick the Save Filter button.

Previously saved filters may be modified by right-clicking on the filter item in the &filter-view; and selecting Modify Filter. The &filter-dialog; is opened, and changes may be made to the filter's name or rules.

To find the science fiction books you've not read, check the Match all of the following button, set the first rule to Genre contains Science Fiction and the second to Read does not contain true. (For Checkbox fields, the internal value is true).

To find the books by Bujold or Weber, check the Match any of the following button, set the first rule to Author contains Bujold and the second to Author contains Weber.

## Generating Reports

&appname; can generate various reports about your current collection. The &report-dialog; checks for all &xslt; templates in the installation path and in `$`KDEHOME`/share/apps/tellico/report-templates/`. So you can create new ones, and they're automatically found and included as options in the &report-dialog;. Some complex reports may take a while to generate for large collections.

The templates that are installed with &appname; include a list of titles only, the default column view, a group view, a summary of all of the groups and the most popular values in those groups, a loan report, and a large report with cover images. Select the desired template and click the Generate button. Any report may also be printed or saved to an &html; file.

The &appname; &report-dialog;
The &appname; &report-dialog;

The entries included in the report will be limited to the ones in the &detailed-view; so if you've got an active filter, the &report-dialog; will use it.

## Loan Tracking

&appname; supports tracking loans of any entries in the collection. The &loan-dialog; may be opened by using the Check-out menu item, or right-clicking on an entry. Multiple entries may be checked-out at once.

The borrower's name may be directly entered, or pulled from the default &kde; address book by clicking on the button next to the name entry. The check-out date is assumed to be the current date, but may be changed. The due date is optional, and other notes may be added about the loan.

If a due date is entered, and &appname; is compiled with libkcal support, a loan reminder may be added to the default &kde; calendar as a To-Do item. &korganizer; can be used to view those items.

When an entry is checked-out, the Loaned field is set to true. If no loaned field exists in the collection, one is added. Do not modify that field directly! Entries on-loan may be checked-in using the menu item, or right-clicking on an entry in the &loan-view;.

The &appname; &loan-dialog;
The &appname; &loan-dialog;

## General Tips

These are the list of tips contained in the "Tip of the Day" list for &appname;.

If a book has more than one author, you should separate their names by a semi-colon, so that Tellico will know to split them and use them separately. Any other field which allows multiple values should be entered the same way. with a semi-colon (;) separating each value.

You can change which fields are shown in the list view by right-clicking on the column header.

You can add, edit, or modify the fields in the collection using the &fields-dialog;. The arrow buttons below the field list can be used to change the position of the field in the list, which affects the placement in the entry editor.

If you want to filter by a Checkbox field, a value of "true" should be used. If you'd like to filter to show only the science fiction books which you've not read, for example, check the Match all of the following button, set the first rule to have "Genre" "contains" "Science Fiction" (no quotes) and the second rule to have "Read" "does not contain" "true" (no quotes).

If a non-word character is used in the Quick Filter, the text is interpreted as a regular expression. To show only books which are by Weber or Bujold, for example, then type "weber|bujold" (no quotes) in the filter box.

You can edit more than one entry at a time, by holding down the &Shift; or &Ctrl; key and selecting multiple entries.

You can convert an existing book collection to a bibliography, which can then be exported to bibtex or Bibtexml format.

If more than one field is formatted as a name, then an additional group named "People" is added to the collection, allowing authors and editors to be sorted or printed together, for example.

You can modify the appearance of the printed output by modifying the `tellico-printing.xsl` file. The file generates &html;, and the &css; within the stylesheet governs things like the font, the margins, etc.

Double-clicking an entry item opens the &entry-editor;.

You can add &html; tags to any Paragraph field for formatting, such as <b>bold</b> or <i>italic</i>.

In the &detailed-view;, you can press a letter on the keyboard to skip to the next entry that starts with that letter.

You can use Dependent Fields to combine multiple separated fields into a single field. Just select the type Dependent and use a description similar to "`Value: %{fielda}%{fieldb}`" where %{...} gets replaced with the appropriate field value. This is useful to collect multiple values in a single field, e.g. for better grouping, and to combine fields of different types by respecting proper sorting at the same time. Consider for example a number field followed by a text subfield with entries 3b, 14a.