~ubuntu-branches/ubuntu/trusty/digikam/trusty

« back to all changes in this revision

Viewing changes to extra/libkipi/tests/kxmlhelloworld/README

  • Committer: Package Import Robot
  • Author(s): Rohan Garg
  • Date: 2012-11-26 18:24:20 UTC
  • mfrom: (1.9.1) (3.1.23 experimental)
  • Revision ID: package-import@ubuntu.com-20121126182420-qoy6z0nx4ai0wzcl
Tags: 4:3.0.0~beta3-0ubuntu1
* New upstream release
  - Add build-deps :  libhupnp-dev, libqtgstreamer-dev, libmagickcore-dev
* Merge from debian, remaining changes:
  - Make sure libqt4-opengl-dev, libgl1-mesa-dev and libglu1-mesa-dev only
    install on i386,amd64 and powerpc
  - Depend on libtiff-dev instead of libtiff4-dev
  - Drop digikam breaks/replaces kipi-plugins-common since we're past the
    LTS release now
  - digikam to recommend mplayerthumbs | ffmpegthumbs. We currently only
    have latter in the archives, even though former is also supposed to
    be part of kdemultimedia. (LP: #890059)
  - kipi-plugins to recommend www-browser rather than konqueror directly
    since 2.8 no direct usage of konqueror is present in the flickr
    plugin anymore (LP: #1011211)
  - Keep kubuntu_mysqld_executable_name.diff
  - Don't install libkipi translations
  - Keep deps on libcv-dev, libcvaux-dev
  - Keep split packaging of libraries
  - Replace icons from KDE 3 time in debian/xpm.d/*.xpm with the new
    versions (LP: #658047)
* Update debian/not-installed

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
This is a sample kipi plugin to demonstrate how to start to implement a new tool.
 
2
 
 
3
A plugin is at least constituate of these files :
 
4
 
 
5
- CMakeLists.txt                   : a rules to compile tool.
 
6
- kipiplugin_helloworld.desktop    : a KDE desktop file to make visible this tool from KIPI host applications.
 
7
- Messages.sh                      : a script to extract internationalization strings for translations purpose.
 
8
- plugin_kxmlhelloworld.h          : the definition of tool based on KIPI::Plugin class.
 
9
- plugin_kxmlhelloworld.cpp        : the implemention of tool. Usually we name plugin entry class file as plugin_*.h/.cpp with * the name of tool.
 
10
 
 
11
We also provide 2 documentation text files :
 
12
 
 
13
- README                           : to give a minimum information about tool
 
14
- TODO                             : to list all pending tasks to implement.
 
15
 
 
16
It's highly recommend to read comments from source to know how to start the implementation of a new tool. Take a look also to
 
17
shared libkipi and kipiplugins/common/libkipiplugins private API.
 
18
 
 
19
NOTE: To be able to load this plugin in digiKam for testing purpose, you need to to remove it from banned list of tool in
 
20
void KipiPluginLoader::loadPlugins() method, from core/utilities/kipiiface/kipipluginloader.cpp
 
21
 
 
22