D-Bus Interface

Tellico has a minimal D-Bus interface, which can be useful for scripting or interacting with a running application from the command-line. As with all D-Bus calls, you need to specify the service you want to interface with, and the particular interface. The name of the D-Bus service is org.kde.tellico.

D-Bus Commands

Two D-Bus primary objects are available in the tellico interface: Tellico and Collections.

The Tellico Object

The full list of D-Bus commands in the tellico object is shown below:

bool importTellico(QString file, QString action)
bool importBibtex(QString file, QString action)
bool importMODS(QString file, QString action)
bool importRIS(QString file, QString action)
bool exportXML(QString file, bool filtered)
bool exportZip(QString file, bool filtered)
bool exportBibtex(QString file, bool filtered)
bool exportHTML(QString file, bool filtered)
bool exportCSV(QString file, bool filtered)
QList<int> selectedEntries()
QList<int> filteredEntries()
void openFile(QString file)
void setFilter(QString text)
bool showEntry(int id)

For the four import commands, the first argument is the file to import, and the second is the import action. Three actions are available: replace, append, and merge. Four file formats are supported for importing: Tellico XML files, Bibtex files, MODS files, and RIS files.

The current open collection in Tellico may be exported to a file, in either Tellico XML format, Tellico ZIP format, Bibtex, HTML, or comma-separated values (CSV). The export commands take an optional argument to specify whether the collection should be limited to the current filter or not.

A list of the entry IDs currently selected or being filtered is able to facilitate showing or updating entries in the view.

A new data file may be opened by using the openFile() command. The full path must be specified.

A new filter may be set using the setFilter() command, which is the equivalent of typing in the filter box in the main window.

Given an entry ID, showEntry() will select that entry and show the entry details in the main window.

The Collections Object

The full list of D-Bus commands in the Collections object is shown below:

int addEntry()
bool removeEntry(int entryID)
QStringList allValues(QString fieldName)
QStringList entryValues(int entryID, QString fieldName)
QStringList selectedBibtexKeys()
QString entryBibtexKey(int entryID)
bool setEntryValue(int entryID, QString fieldName, QString value)
bool addEntryValue(int entryID, QString fieldName, QString value)

A new empty entry may be created in the current collection using the addEntry() command. The return value is the entry ID, which can then be used to set the field values in the entry. An entry can be deleted from the collection by calling removeEntry().

Calling allValues() using just a field name will return all the values for that field for the currently selected entries. If no entries are selected, the return list is empty. If an entry ID is included in the command, the field values for that specific entry are returned.

If the current collection is a bibliography, calling selectedBibtexKeys() will return the Bibtex citation key for all selected entries. The bibtexKey for a specific entry may be found by using the entryBibtexKey() command.

Entries can be edited directly with the D-Bus interface. Given an entry ID, setEntryValue() will set the field value directly. To add a value, without affecting the existing values, use addEntryValue(). The new value gets appended to the end of the existing list.

D-Bus Examples

Here are some examples for scripting Tellico using the D-Bus interface.

Open a Bibtex file
% qdbus org.kde.tellico /Tellico org.kde.tellico.importBibtex "/home/robby/reference.bib" "replace"
Export a Bibtex file
% qdbus org.kde.tellico /Tellico org.kde.tellico.exportBibtex ~/documents/reference.bib
Export a Bibtex file using the current filter
% qdbus org.kde.tellico /Tellico org.kde.tellico.exportBibtex ~/documents/reference.bib true
Echo the citation key of the current selection
% qdbus org.kde.tellico /Collections org.kde.tellico.selectedBibtexKeys
Add a new entry and set the title
% myid=`qdbus org.kde.tellico /Collections org.kde.tellico.addEntry`
% qdbus org.kde.tellico /Collections org.kde.tellico.setEntryValue $myid title "My New Book"