[office/kmymoney/Handbook-5.2] /: Improve KBanking/AqBanking descriptions

Jack Ostroff null at kde.org
Tue Jun 25 23:54:58 BST 2024


Git commit 565c50a180e4fbc437156d050e7fd708fe173b4f by Jack Ostroff.
Committed on 25/06/2024 at 22:54.
Pushed by ostroffjh into branch 'Handbook-5.2'.

Improve KBanking/AqBanking descriptions

M  +2    -0    README-CONTRIBUTORS
M  +4    -4    doc/details-impexp.docbook
M  +12   -5    doc/details-settings.docbook
M  +26   -6    doc/reference.docbook

https://invent.kde.org/office/kmymoney/-/commit/565c50a180e4fbc437156d050e7fd708fe173b4f

diff --git a/README-CONTRIBUTORS b/README-CONTRIBUTORS
index 08097dd496..21e4dcfb02 100644
--- a/README-CONTRIBUTORS
+++ b/README-CONTRIBUTORS
@@ -160,6 +160,8 @@ multiple places.
 
 ----- new as of 202404
 
+- The FAQ chapter needs checking for coordination with https://userbase.kde.org/KMyMoney/FAQ#How_do_I_configure_online_banking_.3F"
+
 - In Plugins section of KMM Config, there is "GNC Importer" but everywhere else it is
   referred to as GnuCash Importer.  Any reason for the difference?
 
diff --git a/doc/details-impexp.docbook b/doc/details-impexp.docbook
index 1404b10409..4b0bb8e659 100644
--- a/doc/details-impexp.docbook
+++ b/doc/details-impexp.docbook
@@ -984,10 +984,10 @@
 </para>
 
 <para>
-  Please note that this section describes the <quote>native</quote> OFX importer.
-  OFX files may also be imported using the AqBanking Importer Plugin.  Note that the
-  two importers do behave slightly differently, and they are written and supported by
-  two different developers.
+  This section describes the <quote>native</quote> OFX importer.  OFX files may also
+  be imported using the AqBanking Importer Plugin.  The two importers do behave
+  slightly differently, and they are written and supported by two different
+  developers.
 </para>
 </sect2>
 
diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook
index 59aa4b8043..7c46d15c8b 100644
--- a/doc/details-settings.docbook
+++ b/doc/details-settings.docbook
@@ -1259,14 +1259,21 @@
 </sect2>
 
 <sect2 id="details.settings.plugins.kbanking"><title>KBanking</title>
-<!-- FIXME: Since both this and the Configure Aqbanking page are minimal, should both
-     just point to the same link currently in the other section?  -->
+<!-- FIXME: There is some overlap between here and the Reference/Settings section.
+            Better coordination would be good. -->
 
 <para>
-  This plugin adds support for HBCI/FinTs, OFX, and PayPal online banking.  However,
-  configuring this plugin is not done through this dialog, but with the <link
+  This plugin adds support for HBCI/FinTs, OFX, and PayPal online banking by using
+  <ulink url="https://www.aquamaniac.de/rdm/">AqBanking</ulink>, which is a an open
+  source project on its own.  Most of the protocols is uses to communicate with banks
+  are only used in Germany.
+</para>
+
+<para>
+  Configuring this plugin is not done through this dialog, but with the <link
   linkend="reference.menus.settings.help"> <guimenu>Settings</guimenu>
-  <guisubmenu>Configure Aqbanking...</guisubmenu> </link> menu item.
+  <guisubmenu>Configure Aqbanking...</guisubmenu> </link> menu item, and there is
+  further information there.
 </para>
 </sect2>
 
diff --git a/doc/reference.docbook b/doc/reference.docbook
index 9dc890e651..8959d4dded 100644
--- a/doc/reference.docbook
+++ b/doc/reference.docbook
@@ -862,18 +862,38 @@
   </varlistentry>
 
   <varlistentry>
+  <!-- FIXME: There is some overlap between here and the KBanking Plugin section.
+              Better coordination would be good. -->
     <term><menuchoice>
       <guimenu>Settings</guimenu><guimenuitem>Configure Aqbanking</guimenuitem>
     </menuchoice></term>
     <listitem>
       <para>
-        Configure online banking setting.  See <ulink
+        Configure online banking settings, but only if the KBanking module is
+        enabled.  More information may be found in the section on configuring the
+        <link linkend="details.settings.plugins.kbanking">KBanking plugin</link> as
+        well as in the <ulink
+        url="https://www.gnucash.org/docs/v5/C/gnucash-manual/tools-on-line-banking.html#tool-
+        aqb-modules">GnuCash documentation</ulink>.
+      </para>
+
+      <para>
+        The process of setting up online access in AqBanking is described in <ulink
+        url="https://wiki.gnucash.org/wiki/De/Onlinebanking-Einrichtungsassistent">the
+        GnuCash wiki (German only)</ulink>.  This menu entry brings you to the dialog
+        shown in step #3.  The process until step #18 is the same for KMyMoney.  Once
+        done, you can map the account in &kmymoney; using <guimenu>Account</guimenu>
+        <guisubmenu>Map account</guisubmenu> and select the account from the list
+        provided.  From there, simply use <guimenu>Account</guimenu>
+        <guisubmenu>Update account</guisubmenu>, or in case you have more than one
+        online account mapped <guimenu>Account</guimenu> <guisubmenu>Update all
+        accounts</guisubmenu>.
+      </para>
+
+      <para>
+        See <ulink
         url="https://userbase.kde.org/KMyMoney/FAQ#How_do_I_configure_online_banking_.3F">How
-        do I configure online banking</ulink> for further details.  This menu
-        selection is only available if the KBanking module is enabled.  See the
-        section on configuring the <link
-        linkend="details.settings.plugins.kbanking">KBanking plugin</link> for more
-        information.
+        do I configure online banking</ulink> for further details.
       </para>
     </listitem>
   </varlistentry>


More information about the kde-doc-english mailing list