Configuration
The Configuration Dialog contains all the options for
changing some of the default behaviour of &appname;.
Clicking the Apply button causes the changes to
take effect immediately without closing the dialog, while
OKapplies the changes and closes the dialog. Cancel closes the dialog, but any changes already made
and applied will remain. The Default button reverts
the options on the current page of the dialog to their default values,
while Helpopens the &khelpcenter; to
the relative section of the &appname; manual.
Some minor settings can only be changed by editing the configuration file itself. See Hidden Options.
General OptionsThe General Options DialogThe General Options Dialog
The General Options control the general behavior. Images may be included
in the data files, or saved separately in the &appname; application folder. Also, when &appname;
is started, it can automatically reopen the last data file that was open. The
Tip of the Day dialog contains helpful hints on using &appname;
and appears at program startup. You may want to read through some of the hints and
then disable the dialog.
The Formatting Options control the level of automatic formatting
that &appname; does. For examples, see the Field
Formatting section. Capitalization and formatting are distinct options, since
a field may be capitalized without having the order of the words changed, and
vice-versa. The auto-capitalization can be changed to ignore certain words.
The automatic formatting includes grammatical articles in titles,
along with prefixes and suffixes for personal names. The values are case-insensitive,
and should be separated by a semi-colon.
The formatting rules follow general English usage, which may not work for other languages.
Articles are appended to the end of the title, with a comma. Personal names are formatted
to have the last name first, followed by a comma, then the first name. Personal suffixes,
such as Jr., are kept with the last name. Prefixes, such as von,
are kept with the last name, but are ignored when the values are being sorted.John Q. von Public, III would become
von Public, III, John Q. and Public would
be used as the sort key.
Only single word prefixes are supported. If a name includes van der,
for example, both van and der should be included
in the surname prefix list. Articles ending with an apostrophe are supported for sorting
order, as well.
The actual values in the collection are not changed,
only the visible text used for the interface. So the formatting options can be
changed back and forth without affecting any of the data in the collection.Printing Options
&appname; uses an &xslt; template for creating &html;
and then passes that to the &kde; printing service. Only the fields visible in the &detailed-view; are printed. Furthermore, if the collection
is being filtered, only the visible entries will be printed. Initially, a warning message
is shown if filtering is active.
The Print Options DialogThe Print Options Dialog
The Printing Options allow you to change some formatting when
printing a collection. If Format titles and names is checked,
then the fields are auto-formatted when they
are printed. Otherwise, they are printed exactly as they were entered.
The default printing stylesheet prints the collection with the field values in columns.
Print field headers controls whether the field title is printed
at the top of the column.
In the printout, the entries will be sorted as they are in the &detailed-view;. Additionally, they may be grouped as they are in the &group-view;.
Finally, when image fields are included in the printout, the images may be resized,
while maintaining their aspect ratio. The maximum image width and height define the
largest possible size of the image, though it will never be increased.
Template Options
The &entry-view; uses templates to show the field
values. You can specify a different template for each collection type. Some templates,
such as the Album or Video templates are
for a specific collection type, and a short error message will appear in the
&entry-view; if they are used for other types. The
Preview button pops up a window to show you a preview of what the template looks like.
Custom fonts and colors may be passed to the template, and all of the default templates
will honor those settings. However, custom template may choose to ignore them.
Additional templates may be installed directly, or downloaded from
kde-files.org by clicking
the Download button. Any templates installed by the user may also be deleted.
Entry templates are saved in $KDEHOME/share/apps/tellico/entry-templates/.
If you create a new template, please consider submitting it at kde-files.org!The Template Options DialogThe Template Options DialogData Sources Options
&appname; can use various sources for importing data, which can be configured
in the Data Sources Dialog. There are several available types of sources:Amazon.com Web Services,the Internet Movie Database,z39.50 servers,SRU servers,Entrez (PubMed) databases,Yahoo! Audio Search,AnimeNfo.com,Internet Bookshop Italia,ISBNdb.com,GCstar Plugins,arxiv.org,bibsonomy.org,citebase.org,crossref.org,other external scripts or applicationsThe Data Sources Options DialogThe Data Sources Options Dialog
New sources may be added by clicking the New... button, while
existing ones may be modified or deleted, using the Modify... or
Remove buttons. The order of the sources, which shows up in the
entry updating menus, can also be changed.
Additional templates may be downloaded from the author's online repository by clicking
the Download button. Those scripts are gpg-signed by the author to
guard against dangerous scripts from unknown sources, which could cause damage to your system.
Never install and run a script from an untrusted source. They are executed with the same permissions as the user,
and as a result, could modify or delete files or otherwise mess up your system.
Many of the data sources offer more information than the default fields in &appname;. Those other fields are
shown on the right of the configuration box. If any of those fields are checked, they will be added
to the collection when an entry is added from that source.
Amazon.com
Using the Amazon Web Services, &appname; can search any of six different international sites operated by Amazon.com for information: United States, United Kingdom, Germany, Japan,
France, and Canada.
Configuring each Amazon.com source involves three settings: the server location, image size, and associate's ID. Some information
from Amazon.com may include an image, such as a book or video cover. That image may be downloaded in three different sizes, depending on the item. The associate's ID must be used to access the Amazon.com Web Services, and is included in the links back to the item, as dictated by the license agreement for the use of the Amazon.com Web Services.
Internet Movie Database
The Internet Movie Database provides information about movies and videos. When a search is conducted for a Person, if more than one possible result is returned, a dialog box is opened to allow you to select the correct person. The configuration options include setting the web server address and whether images are grabbed or not. Since IMDb can return a large number of cast members, you can limit
that to a certain number.
z39.50 Servers
The z39.50 protocol is used to access libraries and bibliographic information providers around the world. Lists of public z39.50 servers are available from indexdata.dk, among others. &appname; comes with
several preset configurations for major libraries, or you can specify the connection information manually.&appname;
is able to read data in the MODS, USMARC/MARC21, or UNIMARC format, using the yaz library.
In addition, there is limited support for the GRS-1 format.
To use one of the preset libraries, check the box and then select the library. The other configuration entries will be disabled. If you need to set the information manually, uncheck the preset box.
The default port for z39.50 access is 210, but some servers may use a different one. &appname; assumes the server uses the MARC-8 character encoding, unless configured otherwise. If an incorrect character encoding is used, an error message may appear on the program output, or possibly no entries are retrieved.
Some servers require a username and password for access. &appname; can use and save that password, but be aware that is written to the &appname; configuration file in plain text and is not secure. For most public servers, the username and password fields may be left empty.
SRU Servers
SRU stands for Search/Retrieve via URL and is a standard search protocol for
Internet searches. Some libraries use it for providing access to their data catalogs. Among them, the US Library of Congress is probably
the best known.
Entrez DatabasesEntrez is the integrated, text-based search and retrieval system used at the National Center for Biotechnology Information (NCBI). The most well-known Entrez database is PubMed, the database for life science articles from many biological journals. At the moment, the only Entrez database supported by &appname; is PubMed.Yahoo! Audio Search
The Yahoo! Audio Search may be used to search for music album information.
AnimeNfo.comAnimeNfo is a popular site for information on anime, or Japanese animation.
Internet Bookstore ItaliaIBS, or Internet Bookstore Italia, is an online Italian bookstore.
ISBNdb.comISBNdb.com is an online book database, with data collection libraries around the world.
GCstar Plugins
If GCstar is installed, &appname; is able to take advantage of the wide range of search plugins available for GCstar. Depending on the collection type, various online resources are available for usage as a data source in &appname;
Bibliographic DatabasesarXiv.org, Bibsonomy, Citebase, and CrossRef are online databases for academic articles and bibliographic information. For access to the CrossRef source, you must request an account and add your account information to the data source configuration.External Scripts or Applications
As an easier way for &appname; to integrate with third-party plugins, external scripts or applications may be used as an interface for searching other information sources. &appname; will execute a command, and pass the search terms as command-line options.
Some scripts are distributed with &appname; itself. Allocine.fr is an online French bookstore. This data source requires Python to be installed. The Spanish Ministry of Culture is an online Spanish book database. This data source also required requires Python to be installed. Dark Horse Comics is a comic book publisher. This data source also requires Python. BoardGameGeek is a website with extensive data for board games, and the script requires ruby.
The collection type returned by the script must be set, along with the data format. Not only can &appname; import data from scripts that
use the default &appname; &xml; format, but it can also import other formats as well, such as bibtex.
The full path to the application should be entered in the source options. Be aware that the application is executed on the system with the same permissions as the current user, so do not use scripts from untrusted sources. Check the boxes next to the search keys supported by the application, and enter the required command line options in the edit box. The search value will be inserted where %1 appears.
For updating entries already in the collection, the final checkbox and edit box are used to determine the command-line options. The entry fields used to find an update must be entered, in the same format as used for Dependent fields.