diff --git a/doc/configuration.docbook b/doc/configuration.docbook index 5c11486b..a368616d 100644 --- a/doc/configuration.docbook +++ b/doc/configuration.docbook @@ -1,473 +1,477 @@ 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 OK applies the changes and closes the dialog. Cancel closes the dialog, but any changes already made and applied will remain. The Defaults button reverts the options on the current page of the dialog to their default values, while Help opens 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. <guilabel>General Options</guilabel> The General Options Dialog The 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. <guilabel>Printing Options</guilabel> &appname; uses an &xslt; template for creating &HTML; and then passes that to the &kde; printing service. Only the fields visible in the Column 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 Dialog The 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 Column 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. <guilabel>Template Options</guilabel> 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 store.kde.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 store.kde.org! The Template Options Dialog The Template Options Dialog <guilabel>Data Sources Options</guilabel> &appname; can use various sources for importing data, which can be configured -in the Data Sources Dialog. There are many available types and sources. A few of them are listed below. +in the Data Sources Dialog. There are many available types and sources. A few of them are listed below, +while the full list is available on the Tellico web site. -Amazon.com Web Services, -the Internet Movie Database, -z39.50 servers, -SRU servers, -Entrez (PubMed) databases, -AnimeNfo.com, -Internet Bookshop Italia, -ISBNdb.com, -arxiv.org, -bibsonomy.org, -crossref.org, -Discogs.com, -TheMovieDB.org, -TheGamesDB.net, -OMDBAPI.com, -MusicBrainz.org, -GiantBomb.com, -OpenLibrary.org, -other external scripts or applications, and -combinations of any of the above sources. +Amazon.com Web Services, +the Internet Movie Database, +AlloCiné, +z39.50 servers, +SRU servers, +Entrez (PubMed) databases, +AnimeNfo.com, +BDGest, +ISBNdb.com, +arxiv.org, +Discogs.com, +TheMovieDB.org, +TheGamesDB.net, +OMDBAPI.com, +MusicBrainz.org, +GiantBomb.com, +OpenLibrary.org, +other external scripts or applications, and +combinations of any of the above sources. The Data Sources Options Dialog The 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 Delete 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. Book and Bibliographic Data Sources 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 Databases Entrez 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. Bibliographic Databases arXiv.org, Bibsonomy, 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. - -Internet Bookstore Italia - -IBS, or Internet Bookstore Italia, is an online Italian bookstore. - - - ISBNdb.com -ISBNdb.com is an online book database, with data collection libraries around the world. +ISBNdb.com is an online book database, from libraries around the world. OpenLibrary.org OpenLibrary.org is an online book database that aims to have one page for every book. Comic Book Data Sources AnimeNfo.com AnimeNfo is a popular site for information on anime, or Japanese animation. + +Bedetheque + +Bedetheque is a French comic book database, managed by BDGest. + + + Movie Data Sources 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 selecting which IMDb nationality to use and whether images are fetched or not. Since IMDb can return a large number of cast members, you can limit that to a certain number. TheMovieDB.org TheMovieDB.org is a free and open online movie database. Registration for a free account is required. OMDBAPI.com The Open Movie Database is a free web service to obtain movie information. + +AlloCiné + +AlloCiné is an online movie information service, based in France. + + + Music Data Sources Discogs.com Discogs.com is a user-built music database containing information on artists, labels, and their recordings. Registration for a free account is required. MusicBrainz.org MusicBrainz.org is a community music metadatabase that attempts to create a comprehensive music information site. Video Game Data Sources GiantBomb.com GiantBomb.com is a large community-driven video game database. Registration for a free account is required. TheGamesDB.net TheGamesDB.net is an open, online database for video game fans. Data Sources for Multiple Collection Types Amazon.com Using the Amazon Web Services, &appname; can search any of 14 different international sites operated by Amazon.com for information: United States, United Kingdom, Germany, Japan, France, Canada, China, Spain, Italy, Brazil, Australia, India, Mexico, and Turkey. 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. +Access to the Amazon Product Advertising API may have restrictions related to sales referrals or advertising. Refer to the Amazon documentation for further information when signing up for API access. + + 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. Python is required to search Dark Horse Comics, a comic book publisher, for example. 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 check box 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 derived value fields. Multiple Combined Data Sources Combinations of up to eight existing data sources can be used as a single source, where the search results from all the sources are merged. The collection type to be used must be set before adding sources. Only existing data sources can be used in combination. The search request is sent to each source, and the results are combined. Since the merged results depend on the order of the search results, the combined set may be different depending on network and source speed. diff --git a/doc/importing-exporting.docbook b/doc/importing-exporting.docbook index 4ecc851a..a7ca2b68 100644 --- a/doc/importing-exporting.docbook +++ b/doc/importing-exporting.docbook @@ -1,398 +1,356 @@ Importing and Exporting Data &appname; is able to import and export a wide variety of data files, as well as search various Internet sites for information. Importing from the Internet &appname; is able to search various Internet sites using the Internet Search Dialog. Entries may be directly imported and added to your current collection. The various providers are configured via the Data Sources Options. Searches may use different criteria: Title, Person, ISBN, UPC/EAN, LCCN, or Keyword. Not all criteria are available for certain data sources. ISBN and LCCN values are for books only, while UPC or EAN values can apply to any type of item. Once a search is initiated, the Search button becomes Stop which will end a search. As results are found, they are added to the list directly under the search box, where selecting an item will show the result without adding it to the collection. Clicking the Add Entry button will add all the selected items to your collection. If the data source has more results than were initially requested, the Get More Results button becomes active. Clicking Clear will remove all the current results and reset the search. The &appname; Internet Search Dialog The &appname; Internet Search Dialog Only entries that match the current collection type will be found. The Description column provides additional information about the entry, in order to differentiate between videos in different formats, or books in different bindings, for example. Once an entry is successfully added to the collection, a checkmark is added to the first column in the list. Multiple entries can be added at once by using the standard &kde; method for multiple selection, which usually involves holding the &Shift; or &Ctrl; key when clicking on an item. To facilitate the use of barcode scanners, searches can include multiple ISBN/UPC values. Selecting the Multiple ISBN/UPC search check box will disable the search box and enable the Edit ISBN/UPC values... button, which will open a multi-line text entry box. Each ISBN should be entered on a line by itself. After closing the box, each ISBN will be validated for correct formatting. The ISBN validation is able to convert 13-digit EAN values, as well as full UPC codes, to the proper formatting. The ISBN list may also be read from a text file. Importing Data -&appname; offers three different actions when importing data. Replace current collection will close the current collection, and create a new one with the data from the imported file. Append to current collection tells &appname; to add all the entries in the imported collection to the current one, and to add any fields which don't currently exist. The Merge collection action is the same as appending, except that each imported entry is compared to the current ones, and any identical entries are skipped. Future plans include an improved heuristic for identifying matching entries, but currently, except for music collections, they must be identical for every field. Music collections compare the artist and album only, and the tracks are merged for matching entries. The audio file importer is able to correctly build track lists by merging entries. +&appname; offers three different actions when importing data. Replace current collection will close the current collection, and create a new one with the data from the imported file. Append to current collection tells &appname; to add all the entries in the imported collection to the current one, and to add any fields which don't currently exist. The Merge collection action is the same as appending, except that each imported entry is compared to the current ones, and any identical entries are skipped. &appname; attempts to identify matching entries which are not completely identical by comparing significant fields and will then merge the entries. For example, music collections compare the artist and album, and the tracks would be merged for matching entries. The audio file importer is able to correctly build track lists by merging entries. - + +Importing Data From Other Software + +&appname; can import data directly from a variety of other collection management programs, including GCstar, Alexandria, Delicious Library, Ant Movie Catalog, Referencer, and Griffith. + + + + +Importing Other Data Formats +&appname; can import data from a variety of other file formats, including CSV, bibtex, audio discs and files, MODS, &PDF;, and RIS. + + Importing &appname; Data -Other &appname; data files may be imported. Replacing the current collection by importing a &appname; file is the same thing as just opening the file itself. The value of importing &appname; data is primarily for appending or merging two collections together. +Other &appname; data files may be imported directly. Replacing the current collection by importing a &appname; file is the same thing as just opening the file itself. The value of importing &appname; data is primarily for appending or merging two collections together. - + - + Importing CSV Data Comma-separated values (CSV) are a common way of importing and exporting tabular data. Each field value is separated by a comma, with one entry per line. The field titles may be included in the first line. The CSV importer is not limited to using a comma as the separator. Any character or string may be used. The CSV Import Dialog The CSV Import Dialog First, select the type of collection that you are importing. If you are appending or merging to your open collection, the type is limited to your current collection type. If the first line of the CSV file contains the field titles, click the check box and the importer will automatically compare the titles against the fields in the current collection. If a field title matches, the header for that column changes to show that the column has been assigned to that field. If the file uses a delimiter other than a comma, be sure to change that option accordingly. In order for &appname; to properly import the file, it must know which field corresponds to each column. If the column only has a number in the header, the data in that column will not be imported. You should assign fields to each column by selecting a column, either by clicking in it or changing the column number itself, then selecting the field to assign from the drop down box and clicking the Assign Field button. If you need to add a new field to the collection, the last item in the drop down box opens the Collection Fields Dialog. -Only the first five lines of the imported CSV file are shown in the dialog. +For compactness, only the first five lines of the imported CSV file are shown in the dialog. However, all the lines in the file will be imported. - + - + Importing Audio &CD; Data &appname; is able to use the freedb.org service to lookup information about a &CD;, including the track list. Depending on your distribution, settings for access to the service may be set in the &kde; &systemsettings;. The &CD; artist, title, genre, year, and track listing are all added. In addition, if the disc contains &CD;-Text, that information is read and added to the imported entry. - + - + Importing Audio File Metadata &appname; is able to scan a folder and read the tags for common audio file formats, such as mp3 and ogg. The songs are entered in a music collection, where each entry is an album. If the song files contain the track number, the song name is inserted in the correct spot in the track list. The artist and genre information is also added to the entry. If the song tags contain comments, they are appended to the comments field in the entry, preceded by the file name. In addition, if a folder contains a .directory file and the folder name matches an album title, the Icon entry in the desktop file is used as the cover image for the album. -The audio file metadata importer can recursively scan a folder to find all audio files in any subfolder, though symbolic links are not followed. &appname; uses the TagLib library for reading the audio file metadata, and so can import data from any file type that TagLib understands. +The audio file metadata importer can recursively scan a folder to find all audio files in any subfolder, though symbolic links are not followed. &appname; uses the TagLib library for reading the audio file metadata, and so can import data from any file type that TagLib understands. - - - -Importing Alexandria Libraries + - -Alexandria is an alternate book collection manager for the GNOME desktop environment. The importer offers a choice of importing any of the libraries found in $HOME/.alexandria/. - - - - - -Importing Ant Movie Catalog Data - - -Ant Movie Catalog is an alternate movie collection manager. - - - - - + Importing Bibtex Data -Bibtex is a bibliography format used with the LaTeX document preparation system. Various type of bibliographic references may be included in the file. &appname; imports bibtex files as a Bibliographic collection. +Bibtex is a bibliography format used with the LaTeX document preparation system. Various type of bibliographic references may be included in the file. &appname; imports bibtex files as a Bibliographic collection. If the bibtex importer encounters fields in the file which are not in the default bibliography collection, they are added as Simple Text fields, with two exceptions. If the field value contains more than 100 characters, it becomes a Paragraph field. If the field value appears to contain a &URL; or a file reference, then a &URL; field is created. &appname; uses an internal copy of the btparse library for parsing the bibtex files. - - - -Importing Bibtexml Data Bibtexml is an &XML; representation of bibtex data, and the data from the imported bibtexml file is treated in the same way as bibtex data would be. - - - -Importing Delicious Library Data - - -Delicious Library is an alternate collection manager for the &Mac; OS X desktop. &appname; imports a subset of the data used by Delicious Library. - - + - -Importing GCstar Data - - -GCstar is an alternate collection manager. Importing books, movies, music, coins, games, board games and wine collections is currently supported. - + +Importing MODS Data -&appname; can also import GCfilms data files. GCfilms is the predecessor of GCstar and was an alternate movie collection manager. Normally, GCfilms data files are found in $HOME/.local/share/gcfilms/. +MODS is a format for representing various types of media collections. Currently, only books are imported by &appname;, as a Bibliographic collection. - - - -Importing Griffith Data + + +Importing &PDF; Data -Griffith is an alternate video collection manager. &appname; is able to import most data from a Griffith database. +If &appname; was compiled with exempi or poppler support, metadata from &PDF; files can be imported. Metadata may include title, author, and date information, as well as bibliographic identifiers which are then used to update other information. - - - -Importing MODS Data + + +Importing RIS Data -MODS is a format for representing various types of media collections. Currently, only books are imported by &appname;, as a Bibliographic collection. +The RIS format is a bibliographic file format used by EndNote, Reference Manager, and others. &appname; imports RIS files as a Bibliographic collection. + - -Importing PDF Data - -If &appname; was compiled with exempi or poppler support, metadata from PDF files can be imported. Metadata may include title, author, and date information, as well as bibliographic identifiers which are then used to update other information. - - + +Importing Online Collections +&appname; can connect to and import from websites that manage personal collections. - -Importing Referencer Data + +Importing BoardGameGeek Collection -Referencer is a document organizer and bibliography manager for the GNOME desktop. &appname; will import most of the data found in a Referencer database. +BoardGameGeek is an online board gaming resource and community. &appname; can import the board games in a user's collection, as long as the collection is set to be publicly accessible. The imported collection may be limited to those items marked as being owned. - - - -Importing RIS Data - -The RIS format is a bibliographic file format used by Reference Manager and others. &appname; imports RIS files as a Bibliographic collection. - - + - + Importing Goodreads Collection -Goodreads is an online social network for readers to track book collections. &appname; can import the list of books in a user's collection, given either the user name or user ID, as long as the collection is set to be publicly accessible. +Goodreads is an online social network for readers to track book collections. &appname; can import the list of books in a user's collection, given either the user name or user ID, as long as the collection is set to be publicly accessible. + Importing File Listings The best way to create a File Catalog is to import the contents of a folder. The folder may be searched recursively, to add all files found within. This importer is most useful for backup listings and media cataloging, such as &CD; or DVD listings. In addition, image previews of the file contents may be generated, although it can take some time to read a large number of files. The file previews are same as those shown in the &kde; file manager. Importing &XML; Data via XSLT Any &XML; file may be imported into &appname; provided an &XSL; stylesheet is available to convert the file to &appname; format. &appname; automatically loads the stylesheet and performs the &xslt; processing needed to load the file. Drag and Drop -Dragging data files to the main &appname; window and dropping them will import the files, just as if the import command was made from the menus. Drag and drop works for the following file formats: Tellico, Bibtex, RIS, and PDF. Importing multiple files at once is also supported. +Dragging data files to the main &appname; window and dropping them will import the files, just as if the import command was made from the menus. Drag and drop works for the following file formats: Tellico, Bibtex, RIS, and &PDF;. Importing multiple files at once is also supported. -So, for example, if you want to catalog several PDF files, select them in the file manager and drag them to the &appname; window. &appname; will import as much metadata from the files as it can, and then fetch additional information from various configured Internet sources. +So, for example, if you want to catalog several &PDF; files, select them in the file manager and drag them to the &appname; window. &appname; will import as much metadata from the files as it can, and then fetch additional information from various configured Internet sources. Exporting Data When exporting the data in the collection, the entry values may be exported as entered, or with the automatic formatting provided by &appname;. Additionally, the export may be limited to the currently selected entries of the collection as well, where the statusbar shows the number of selected entries. Exported text files, such as Bibtex or CSV, may use the Unicode (UTF-8) character encoding, or the current locale of the operating system. General Export Options General Export Options Exporting &XML; The file format for &appname; data is a zipped &XML; file. Exporting to &XML; merely creates the &XML; file without zipping it. Images may be included in the &XML; file as base64-encoded data in an image element, but doing so can create very large text files. Exporting Zip The standard file format for &appname; is a zipped file, contained the &XML; collection file, and optionally, all the images referenced in the collection. If the images are being stored in the application folder instead, exporting to a Zip file will create a self-contained data file, which includes all the images in the collection. Exporting &HTML; The &HTML; export uses the tellico2html.xsl stylesheet. Images are exported to a folder with the same name as the exported &HTML; file with _files appended. The default format is similar to the printed output, and allows various options for modifying the &HTML;. Field headers may be printed at the top of each column, but unfortunately, &kde; does not yet allow the table headers to be repeated on each page. The entries may be grouped as in the Group View, as well. Additionally, individual files may be created for each entry in the collection, with links created in the top-level &HTML; file. The entry files will be created in the same folder as the images. The entry &HTML; files will use the current stylesheet template, as shown in the Entry View. &HTML; Export Options &HTML; Export Options Exporting CSV Comma-separated values (CSV) are a common way of importing and exporting tabular data. Each field value is separated by a comma, with one entry per line. The field titles may be included as headers in the first line. Any character or string other than a comma may also be used to delimit the fields. CSV Export Options CSV Export Options Exporting Alexandria Alexandria is a book collection manager for the GNOME desktop environment. &appname; is able to export a limited subset of book collection fields to the default Alexandria data location. Exporting ONIX ONIX is an &XML; format for representing and communicating book industry product information, primarily for book vendors. &appname; can export book collections using a small subset of ONIX. Exporting Bibtex When exporting to Bibtex, the field values may be escaped with braces or quotation marks. If any string macros are used in the collection, they may optionally be exported as macros or expanded. For &URL; fields, &appname; may enclose the field values with the \url{...} tag. Finally, entries with no citation key may be skipped rather than have &appname; auto-generate the key. Bibtex Export Options Bibtex Export Options - -Exporting Bibtexml - - -Bibtexml is a format for expressing bibtex data via &XML;. - - - - Exporting GCstar GCstar is another movie collection manager. &appname; is able to export most collection types to a GCstar data file. Exporting &XML; via &xslt; Finally, &appname; is able to process its internal &XML; representation of the collection data through an external &XSL; stylesheet before exporting. This type of export may be useful for generating text reports or other file types. Working With Citations When working with a bibliography, citations for the currently selected entries may be generated and used in various other applications. A citation in bibtex format can be copied to the clipboard, and then pasted in a latex file. Bibtex citations can also be pushed to an external application such as LyX or Kile using the so-called lyxpipe. diff --git a/doc/index.docbook b/doc/index.docbook index fdd1119f..73446352 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -1,284 +1,274 @@ XSLT"> ]> -28/08/2009 -2.0 +12/05/2019 +3.2 The &tellico; Handbook Robby Stephenson
&email;
 -2001 -2002 -2003 -2004 -2005 -2006 -2007 -2008 -2009 -2010 -2011 +2001-2019 &robby; For licensing information of both the software and this documentation, please refer to the final section. This document is a handbook for using &tellico;, a collection manager software application. KDE tellico book bibliography movie collection database catalog extragear Introduction &tellico; &tellico; is a program for managing collections. It began as a simple book collection manager, and has expanded to include default collection templates for bibliographies, comic books, videos, music, coins, stamps, trading cards, video games, wines, board games, and file listings. In addition, custom collections can be built for any other type of collectibles. What &tellico; Is &tellico; keeps track of the items in a collection, and offers an easy way to enter data for each entry. It provides several field types, and allows for an unlimited number of user-defined fields. The entries in a collection may be grouped by any field for easy organization, and customizable views show as much or as little information as you like. -Loans may be tracked, with optional integration with &korganizer;. Collections may be +Loans of items in your collection may be tracked, including a due date. Collections may be imported or exported using a variety of formats, to allow for easy exchange or publication of data. What &tellico; Is Not &tellico; is not an audio or video player. It does not provide facilities for reading or modifying multimedia files. It also does not provide any image-editing functionality. Although &tellico; has some functionality for managing bibliography lists, it is not a full-blown bibliographic reference manager. &tellico; also does not pretend to have all the capabilities of a full-fledged relational database. As somewhat of a disclaimer, &tellico; is a hobby for the author, and no guarantees are made about its functionality, usefullness, or otherwise. More information is included in the license declaration. Terminology Collections In &tellico;, a collection is the document. Only one collection exists in each &tellico; file. A collection contains any number of fields and entries. &tellico; supports 12 specific collection types by default: books, bibliographic entries, comic books, videos, music, trading cards, coins, stamps, video games, wines, board games, and file listings. In addition, an empty generic collection template is available for any other type of collectibles or lists. Collection Fields Each collection may have an unlimited number of fields. &tellico; supports eleven types of fields, which allow for a range of different data. The fields can be edited with the Collection Fields Dialog and are explained further in the Field Types section. Collection Entries An entry is the basic record in &tellico;. Each entry contains a single value for each field in the collection. A collection may have an unlimited number of entries, in theory, although since the whole collection is always resident in memory, too many entries could slow down the application. &tellico; has been tested with a collection of 10,000 entries, and the speed was satisfactory. However, if many large images are included in the collection, the loading and processing time does slow down greatly. Performance can be improved by having &tellico; store images separate from the data file itself, either in the application-specific folder or a folder relative to the data file. More information can be found in the configuration section. &fundamentals-chapter; &details-chapter; &importing-exporting-chapter; &advanced-chapter; &configuration-chapter; &hacking-chapter; &faqs-chapter; &menus-chapter; Credits and License &tellico; -Program copyright 2001-2011 &robby; &email; +Program copyright 2001-2019 &robby; &email; -Documentation copyright 2001-2011 &robby; &email; +Documentation copyright 2001-2019 &robby; &email; &underGPL; &underFDL; The author of this documentation has also granted you permission to use the content under the terms of the FreeBSD Documentation License, if you so choose. If you wish to allow use of your version of this content only under the terms of the FreeBSD Documentation License, and not to allow others to use your version of this file under the terms of the GFDL, indicate your decision by deleting the GFDL notice and replacing it with the notice and other provisions required by the FreeBSD Documentation License. If you do not delete the GFDL notice above, a recipient may use your version of this file under the terms of either the GFDL or the FreeBSD Documentation License. &documentation.index;