summaryrefslogtreecommitdiffstats
path: root/doc/kbabel/kbabeldict.docbook
diff options
context:
space:
mode:
Diffstat (limited to 'doc/kbabel/kbabeldict.docbook')
-rw-r--r--doc/kbabel/kbabeldict.docbook85
1 files changed, 85 insertions, 0 deletions
diff --git a/doc/kbabel/kbabeldict.docbook b/doc/kbabel/kbabeldict.docbook
new file mode 100644
index 00000000..efe70b79
--- /dev/null
+++ b/doc/kbabel/kbabeldict.docbook
@@ -0,0 +1,85 @@
+<!-- <?xml version="1.0" ?>
+<!DOCTYPE chapter PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd"> -->
+<!-- Uncomment the previous two lines to validate this document -->
+<!-- standalone. Be sure to recomment them before attempting to -->
+<!-- process index.docbook -->
+
+<!-- Note: the id attribute "using-kbabeldict" is used in KBabelDict's source code to call the help.
+So if you change this id attribute, the name *must* be changed in KBabelDict's source code too! -->
+<chapter id="using-kbabeldict">
+<chapterinfo>
+<!-- Fill in this section if this document has a different author -->
+<authorgroup>
+<author>
+<personname><firstname></firstname><surname></surname></personname>
+</author>
+</authorgroup>
+
+<!-- TRANS:ROLES_OF_TRANSLATORS -->
+</chapterinfo>
+
+<title>Using &kbabeldict;</title>
+<anchor id="kbabeldict"/>
+<para>
+&kbabeldict; is a simple interface for translation modules for
+&kbabel;. It allows you to search for translations.
+</para>
+<screenshot>
+<screeninfo>Screenshot of &kbabeldict;</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="snap_kbabeldict.png" format="PNG"/>
+</imageobject>
+<textobject><phrase>Screenshot of &kbabeldict;</phrase></textobject>
+</mediaobject>
+</screenshot>
+<para>
+The screenshot
+above does not contain settings for selected module. You can show
+them using <guibutton>Show Settings</guibutton>. Preferences
+widget for selected module will be shown on the
+right side of the window. The &kbabeldict;
+window then looks like this:
+</para>
+<screenshot>
+<screeninfo>Screenshot of &kbabeldict;</screeninfo>
+<mediaobject>
+<imageobject>
+<imagedata fileref="snap_kbabeldict2.png" format="PNG"/>
+</imageobject>
+<textobject><phrase>Screenshot of &kbabeldict; with shown settings</phrase></textobject>
+</mediaobject>
+</screenshot>
+<para>
+The usage is very simple. You select a module to in the
+<guilabel>Search in module</guilabel> combo-box.
+Then you enter the phrase to lookup and press <guibutton>Start
+Search</guibutton>. All found messages are shown in the list
+below, which is the same as a tool in the &kbabel; main window.
+Searching can be stopped by pressing <guilabel>Stop</guilabel>.
+In case you want to search in translated text, not in original English message,
+you should use <guilabel>Search in translations</guilabel>.
+</para>
+<para>
+Buttons on the bottom of the window can be used for closing &kbabeldict;,
+showing/hiding the module settings or displaying a dialog with credits for
+&kbabeldict; and the modules themselves.
+</para>
+<note>
+<para>
+For description of the standard modules and their settings see
+<xref linkend="dictionaries"/>.
+</para>
+</note>
+</chapter>
+<!--
+Local Variables:
+mode: xml
+sgml-minimize-attributes:nil
+sgml-general-insert-case:lower
+sgml-indent-step:0
+sgml-indent-data:nil
+End:
+
+vim:tabstop=2:shiftwidth=2:expandtab
+--> \ No newline at end of file