[kde-doc-english] [kmymoney/add-onlinebanking] doc: Initial doc on print check plugin.

Christian Dávid christian-david at web.de
Wed Sep 24 19:31:09 UTC 2014


Git commit 5fbb316f89d0ad9e0a0dd688a9118cae2fe47031 by Christian Dávid, on behalf of Jack Ostroff.
Committed on 31/08/2014 at 22:06.
Pushed by christiand into branch 'add-onlinebanking'.

Initial doc on print check plugin.
Other updates for 4.7.

A  +-    --    doc/configure_plugins.png
M  +29   -17   doc/details-settings.docbook
A  +-    --    doc/icon-dialog-configure.png
A  +-    --    doc/icon-dialog-information.png
M  +6    -0    doc/index.docbook
M  +-    --    doc/tag_details.png
M  +-    --    doc/tags.png

http://commits.kde.org/kmymoney/5fbb316f89d0ad9e0a0dd688a9118cae2fe47031

diff --git a/doc/configure_plugins.png b/doc/configure_plugins.png
new file mode 100644
index 0000000..def2f5e
Binary files /dev/null and b/doc/configure_plugins.png differ
diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook
index 0d7dfb0..f236bd2 100644
--- a/doc/details-settings.docbook
+++ b/doc/details-settings.docbook
@@ -747,16 +747,27 @@
 <title id="details.settings.plugins.title">Plugins</title>
 
 <para>
-  These options allow you to modify the behavior of any installed plugins.  For
-  most plugins, the only choice is to enable or disable it, although there is
-  also an <guibutton>Info</guibutton> button which will show the plugin version
-  and author.  Further information on configuring and using these plugins may be
-  found in the separate sections for <link linkend="details.impexp.csv">CSV
-  Import</link> and <link linkend="details.impexp.ofx">OFX Import</link>
-  plugins.  It is also true for the <link
-  linkend="details.reconcile">Reconciliation report</link>, although that report
-  is only a minor part of the larger reconciliation process.  The one plugin
-  that does require a configuration step is the Print Check plugin.
+  These options allow you to modify the behavior of any installed plugins.
+  <screenshot>
+	<screeninfo>Configure Plugins</screeninfo>
+	<mediaobject>
+	<imageobject>
+	<imagedata fileref="configure_plugins.png" format="PNG" />
+	</imageobject>
+	<textobject>
+	<phrase>Configure Plugins</phrase>
+	</textobject>
+	</mediaobject>
+  </screenshot>
+  For most plugins, the only choice is to enable or disable it, although for
+  each there is also an <guibutton>information</guibutton> (&infoicon;) button
+  which will show the plugin version and author.  Further information on
+  configuring and using these plugins may be found in the separate sections for
+  <link linkend="details.impexp.csv">CSV Import</link> and <link
+  linkend="details.impexp.ofx">OFX Import</link> plugins.  It is also true for
+  the <link linkend="details.reconcile">Reconciliation report</link>, although
+  that report is only a minor part of the larger reconciliation process.  The
+  one plugin that does require a configuration step is the Print Check plugin.
 </para>
 
 <sect2 id="details.settings.plugins.printchecks">
@@ -765,9 +776,9 @@
 <para>
   This plugin is inlcuded with the source of &kappname;, and should always be
   enabled.  It allows printing of a check based on the data from a selected
-  transaction, with the layout controlled by an html template. Usually, the
-  template is matched to pre-printed checks.  When you click on the
-  <guibutton>configure</guibutton> (a small wrench), the <guilabel>Print
+  transaction, with the layout controlled by an html template. You need to use a 
+  template which is matched to your pre-printed checks.  When you click on the
+  <guibutton>configure</guibutton> (&configicon;) button , the <guilabel>Print
   check</guilabel>configuration dialog is displayed.  At the top is a text box
   for the path to the selected template.  To the right of that is a button which
   brings up a file chooser, to select an alternative template file.
@@ -775,11 +786,12 @@
 
 <para>
   A template file is an html file, which is used with specific strings to
-  reference the fields from the transaction or from the current account and
+  reference the fields from the transaction and from the current account and
   institution to show where they will be printed on the check.  &kappname; is
-  shipped with several template files.  You should either be able to use one of
-  them, or modify one to suit your needs.  The default value of the template
-  file will show you the directory which contains the sample files.
+  shipped with some sample template files.  You should either be able to use one
+  of them, or modify one to suit your needs.  When the default template is
+  selected, the configuration dialog will show you the directory which contains
+  the sample files.
 </para>
 </sect2>
 </sect1>
diff --git a/doc/icon-dialog-configure.png b/doc/icon-dialog-configure.png
new file mode 100644
index 0000000..5ce478b
Binary files /dev/null and b/doc/icon-dialog-configure.png differ
diff --git a/doc/icon-dialog-information.png b/doc/icon-dialog-information.png
new file mode 100644
index 0000000..c0d4cbd
Binary files /dev/null and b/doc/icon-dialog-information.png differ
diff --git a/doc/index.docbook b/doc/index.docbook
index 1126b3a..d4175ab 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -86,6 +86,12 @@
       <contrib>Relecture de la documentation française </contrib></othercredit>'>
   <!ENTITY SimonDepiets    'Simon Depiets <email>2df at tuxfamily.org</email>'>
 
+<!-- entities to allow use of icons inline in describing some configuration dialogs -->
+  <!ENTITY infoicon "<inlinemediaobject><imageobject><imagedata fileref='icon-dialog-information.png' format='PNG'/>
+    </imageobject></inlinemediaobject>">
+  <!ENTITY configicon "<inlinemediaobject><imageobject><imagedata fileref='icon-dialog-configure.png' format='PNG'/>
+    </imageobject></inlinemediaobject>">
+
 <!-- the chapters -->
   <!ENTITY introduction SYSTEM "introduction.docbook">
   <!ENTITY makemostof SYSTEM "makemostof.docbook">
diff --git a/doc/tag_details.png b/doc/tag_details.png
index f1d6188..e88e66a 100644
Binary files a/doc/tag_details.png and b/doc/tag_details.png differ
diff --git a/doc/tags.png b/doc/tags.png
index 7060527..8a220d2 100644
Binary files a/doc/tags.png and b/doc/tags.png differ



More information about the kde-doc-english mailing list