Chapter 9. Plugins

KPhotoAlbum shares a plugin system with a number of other image applications, among these digiKam and Gwenview. The plugin system is named Kipi, which is short for KDE Image Plugin Interface. See Kipi Homepage

The plugins are available from the menu bar, under the item Plugins. The plugins will and can not be described in this manual, as the plugins are not part of KPhotoAlbum, but shipped separately. Most plugins do, however have a help page available from the plugin itself.

Warning

As the plugins are shared between a number of applications, certain plugins might be very little tested with KPhotoAlbum, you should therefore always try out new plugins with the demo database before you try them on your own images[5] (Don't say I didn't warn you!).

The applications using KIPI are very different from each other, this means that some plugins are not always working the KPhotoAlbum way, but after all, this is the price for sharing the functionality between the applications.

The most important difference between KPhotoAlbum and the other applications using KIPI, is that the other applications order the images in albums, where an album simply is a directory. KPhotoAlbum do not have this concept; nevertheless, for certain plugins to function, KPhotoAlbum behaves towards the plugin system as if it did.

KPhotoAlbum does this by defining the current album to be the current view - that is, all the images the browser currently offers to display.

In addition to the current album, KPhotoAlbum must also be able to give a list of all albums; KPhotoAlbum defines this list in the following way:

  • When KPhotoAlbum's browser displays the content of a category, say people, then each item in this category will look like an album to the plugin.

  • Otherwise, the category you specify for Category for virtual albums in the options dialog, will be used; e.g. if you specify People with this option, then KPhotoAlbum will act as if you had just chosen to display people and then invoke the plugin which needs to know about all albums.

Some plugins might be redundant to features implemented in KPhotoAlbum, and in that case you may not want to see them at all in the Plugin menu. For that, you may go to the options dialog, and specify which plugins should be shown at all.



[5] You start KPhotoAlbum with the demo setup either from the shell by executing kphotoalbum -demo, or from the Help menu.