From bd9e6617827818fd043452c08c606f07b78014a0 Mon Sep 17 00:00:00 2001 From: toma Date: Wed, 25 Nov 2009 17:56:58 +0000 Subject: Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. BUG:215923 git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdesdk@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- kbabel/kbabeldict/README.modules | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 kbabel/kbabeldict/README.modules (limited to 'kbabel/kbabeldict/README.modules') diff --git a/kbabel/kbabeldict/README.modules b/kbabel/kbabeldict/README.modules new file mode 100644 index 00000000..a672743b --- /dev/null +++ b/kbabel/kbabeldict/README.modules @@ -0,0 +1,34 @@ +This directory contains the framework for KBabel to be easily extensible with +plugins for searching translations. + +For an examples of modules see subdirectory "modules". + + +Here is a short description, how to write an module: + +First off all, the module must inherit the interface class SearchEngine and +has to implement all the virtual functions in there. Also a preferences +widget must be available, that has to inherit from PrefWidget. +Just include searchengine.h to have everything necessary available. + +Then you module has to be compiled as shared library and there must be a +factory available, so that it can be loaded with KLibLoader. See +documentation of KLibLoader for more details. The library should be prefixed +by "kbabeldict_" instead of more common "lib". This is to indicate that it is +a module for KBabelDict. + +The method of dictionary loading has changed in KBabel 1.2, but the +modules for previous versions should work. Here is how to install +the dictionary: You should define a standard KDE service desktop file. +The most important entry is + +X-KDE-Library= + +where is the name of the shared library, that contains your +SearchEngine, for example "kbabeldict_pocompendium". +Additionally you can add a list of applications, to them your module is +restricted to with "Applications=". For example with "Applications=kbabel", +your module will only be used in KBabel. If you omit the entry, the +module can be used in any application. + + -- cgit v1.2.1