[office/kmymoney] doc: Add documentation on configuring the aqbanking plugin
Ralf Habacker
null at kde.org
Wed Aug 20 20:06:40 BST 2025
Git commit 078dafde3fd8e102c40026e536c8d9570941750b by Ralf Habacker.
Committed on 19/08/2025 at 18:41.
Pushed by habacker into branch 'master'.
Add documentation on configuring the aqbanking plugin
The added documentation covers adding HBCI with PIN/TAN and PayPal
online banking services.
BUG:458133
FIXED-IN:5.2.70
A +- -- doc/aqbanking-account-wizard-paypal-page1.png
A +- -- doc/aqbanking-account-wizard-paypal-page2.png
A +- -- doc/aqbanking-user-wizard-hbci-page1.png
A +- -- doc/aqbanking-user-wizard-hbci-page2.png
A +- -- doc/aqbanking-user-wizard-hbci-page3.png
A +- -- doc/aqbanking-user-wizard-hbci-page4.png
A +- -- doc/aqbanking-user-wizard-hbci-page5.png
A +- -- doc/aqbanking-user-wizard-hbci-page6.png
A +- -- doc/aqbanking-user-wizard-hbci-page7.png
A +- -- doc/aqbanking-user-wizard-page1.png
A +- -- doc/aqbanking-user-wizard-page2-hbci.png
A +- -- doc/aqbanking-user-wizard-paypal-page1.png
A +- -- doc/aqbanking-user-wizard-paypal-page2.png
A +- -- doc/aqbanking-user-wizard-paypal-page3.png
A +- -- doc/aqbanking-user-wizard-paypal-page4.png
A +- -- doc/aqbanking-user-wizard-paypal-page5.png
A +- -- doc/aqbanking-user-wizard-paypal-page6.png
A +- -- doc/aqbanking-user-wizard-paypal-page7.png
A +- -- doc/aqbanking-wizard-page1.png
A +- -- doc/config_menu.png
A +339 -0 doc/details-aqbanking.docbook
M +3 -1 doc/index.docbook
https://invent.kde.org/office/kmymoney/-/commit/078dafde3fd8e102c40026e536c8d9570941750b
diff --git a/doc/aqbanking-account-wizard-paypal-page1.png b/doc/aqbanking-account-wizard-paypal-page1.png
new file mode 100644
index 0000000000..bc10e62d85
Binary files /dev/null and b/doc/aqbanking-account-wizard-paypal-page1.png differ
diff --git a/doc/aqbanking-account-wizard-paypal-page2.png b/doc/aqbanking-account-wizard-paypal-page2.png
new file mode 100644
index 0000000000..f6f23af08e
Binary files /dev/null and b/doc/aqbanking-account-wizard-paypal-page2.png differ
diff --git a/doc/aqbanking-user-wizard-hbci-page1.png b/doc/aqbanking-user-wizard-hbci-page1.png
new file mode 100644
index 0000000000..edf4484ab0
Binary files /dev/null and b/doc/aqbanking-user-wizard-hbci-page1.png differ
diff --git a/doc/aqbanking-user-wizard-hbci-page2.png b/doc/aqbanking-user-wizard-hbci-page2.png
new file mode 100644
index 0000000000..e72f2e77a9
Binary files /dev/null and b/doc/aqbanking-user-wizard-hbci-page2.png differ
diff --git a/doc/aqbanking-user-wizard-hbci-page3.png b/doc/aqbanking-user-wizard-hbci-page3.png
new file mode 100644
index 0000000000..687a0e2ae8
Binary files /dev/null and b/doc/aqbanking-user-wizard-hbci-page3.png differ
diff --git a/doc/aqbanking-user-wizard-hbci-page4.png b/doc/aqbanking-user-wizard-hbci-page4.png
new file mode 100644
index 0000000000..e8dccec552
Binary files /dev/null and b/doc/aqbanking-user-wizard-hbci-page4.png differ
diff --git a/doc/aqbanking-user-wizard-hbci-page5.png b/doc/aqbanking-user-wizard-hbci-page5.png
new file mode 100644
index 0000000000..f6bfc7cfe1
Binary files /dev/null and b/doc/aqbanking-user-wizard-hbci-page5.png differ
diff --git a/doc/aqbanking-user-wizard-hbci-page6.png b/doc/aqbanking-user-wizard-hbci-page6.png
new file mode 100644
index 0000000000..4e4a0c7794
Binary files /dev/null and b/doc/aqbanking-user-wizard-hbci-page6.png differ
diff --git a/doc/aqbanking-user-wizard-hbci-page7.png b/doc/aqbanking-user-wizard-hbci-page7.png
new file mode 100644
index 0000000000..976115eee2
Binary files /dev/null and b/doc/aqbanking-user-wizard-hbci-page7.png differ
diff --git a/doc/aqbanking-user-wizard-page1.png b/doc/aqbanking-user-wizard-page1.png
new file mode 100644
index 0000000000..c06945f18d
Binary files /dev/null and b/doc/aqbanking-user-wizard-page1.png differ
diff --git a/doc/aqbanking-user-wizard-page2-hbci.png b/doc/aqbanking-user-wizard-page2-hbci.png
new file mode 100644
index 0000000000..abf6fd8a58
Binary files /dev/null and b/doc/aqbanking-user-wizard-page2-hbci.png differ
diff --git a/doc/aqbanking-user-wizard-paypal-page1.png b/doc/aqbanking-user-wizard-paypal-page1.png
new file mode 100644
index 0000000000..e1aa604650
Binary files /dev/null and b/doc/aqbanking-user-wizard-paypal-page1.png differ
diff --git a/doc/aqbanking-user-wizard-paypal-page2.png b/doc/aqbanking-user-wizard-paypal-page2.png
new file mode 100644
index 0000000000..becf4b510c
Binary files /dev/null and b/doc/aqbanking-user-wizard-paypal-page2.png differ
diff --git a/doc/aqbanking-user-wizard-paypal-page3.png b/doc/aqbanking-user-wizard-paypal-page3.png
new file mode 100644
index 0000000000..bbb67d5fd2
Binary files /dev/null and b/doc/aqbanking-user-wizard-paypal-page3.png differ
diff --git a/doc/aqbanking-user-wizard-paypal-page4.png b/doc/aqbanking-user-wizard-paypal-page4.png
new file mode 100644
index 0000000000..9a36033530
Binary files /dev/null and b/doc/aqbanking-user-wizard-paypal-page4.png differ
diff --git a/doc/aqbanking-user-wizard-paypal-page5.png b/doc/aqbanking-user-wizard-paypal-page5.png
new file mode 100644
index 0000000000..91dc6e44e8
Binary files /dev/null and b/doc/aqbanking-user-wizard-paypal-page5.png differ
diff --git a/doc/aqbanking-user-wizard-paypal-page6.png b/doc/aqbanking-user-wizard-paypal-page6.png
new file mode 100644
index 0000000000..c3277c3f8d
Binary files /dev/null and b/doc/aqbanking-user-wizard-paypal-page6.png differ
diff --git a/doc/aqbanking-user-wizard-paypal-page7.png b/doc/aqbanking-user-wizard-paypal-page7.png
new file mode 100644
index 0000000000..f8721d9082
Binary files /dev/null and b/doc/aqbanking-user-wizard-paypal-page7.png differ
diff --git a/doc/aqbanking-wizard-page1.png b/doc/aqbanking-wizard-page1.png
new file mode 100644
index 0000000000..f942d1cdfc
Binary files /dev/null and b/doc/aqbanking-wizard-page1.png differ
diff --git a/doc/config_menu.png b/doc/config_menu.png
new file mode 100644
index 0000000000..39d90a0fb6
Binary files /dev/null and b/doc/config_menu.png differ
diff --git a/doc/details-aqbanking.docbook b/doc/details-aqbanking.docbook
new file mode 100644
index 0000000000..f144048181
--- /dev/null
+++ b/doc/details-aqbanking.docbook
@@ -0,0 +1,339 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<chapter id="details.aqbanking">
+<chapterinfo>
+ <authorgroup>
+ <author> &Ralf.Habacker; &Ralf.Habacker.mail; </author>
+ </authorgroup>
+ <date>2025-07-31</date>
+ <releaseinfo>5.2.70</releaseinfo>
+</chapterinfo>
+<title>Online banking</title>
+
+<para>
+ Online banking is configured by selecting the menu entry Settings
+ -> Configure Aqbanking,
+</para>
+
+<para>
+<screenshot>
+ <screeninfo>KMyMoney configuration menu</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="config_menu.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>KMyMoney configuration menu</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+</para>
+
+<para>
+ This menu item is visible after the associated KBanking plugin has been activated,
+ which can be done via the menu item "Configure KMyMoney" and after
+ selecting the "Plugins" entry in the left-hand window area.
+</para>
+
+<para>
+<screenshot>
+ <screeninfo>KMyMoney configuration menu</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="configure_plugins.png" />
+ </imageobject>
+ <textobject>
+ <phrase>KMyMoney configuration menu</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+ Make sure that the checkbox in front of the line with KBanking is checked.
+</para>
+
+<sect1>
+<title>Aqbanking setup</title>
+<para>
+ After you pressed the menu entry "Configure Aqbanking" you will see the following dialog:
+</para>
+
+<para>
+<screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-wizard-page1.png" />
+ </imageobject>
+ </mediaobject>
+</screenshot>
+</para>
+
+<para>
+ Adding takes place in two steps. The first step is to
+ add a user and the second step is to add an account.
+</para>
+</sect1>
+
+<sect1 id="create_user">
+ <title>Create a user</title>
+ <para>
+ After pressing "Create user" you will be redirected
+ to the "New user Wizard" dialog shown below:
+ </para>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-page1.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+<sect2 id="hbci_create_user">
+ <title>Create user for HBCI</title>
+<sect3 id="hbci_select_online_banking_protocol">
+ <title>Select online banking protocol</title>
+ <para>
+ After pressing "Next" you will see a list of available
+ online banking protocols:
+ </para>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-page2-hbci.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</sect3>
+<sect3 id="hbci_configuring_a_account">
+ <title>Configuring a HBCI account</title>
+ <para>
+ After choosing "HBCI backend using AqHBCI" and pressing
+ "Next" you will see the following page, on which you can
+ select the security type:
+ </para>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-hbci-page1.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ See
+ <ulink url="https://www.aquamaniac.de/rdm/projects/aqbanking/wiki/AqBanking6_Bankentabelle#section-2">AqBanking6
+ Bank Table</ulink> for some details on the types of security
+ supported by banks. If your bank is not listed there, you should
+ try Pin/TAN first.
+ </para>
+</sect3>
+<sect3 id="hbci_setup_pintan">
+ <title>Setup pin/Tan</title>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-hbci-page2.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</sect3>
+<sect3 id="hbci_select_bank_and_server_url">
+ <title>Select bank and server url</title>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-hbci-page3.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ At
+ <ulink url="https://www.aquamaniac.de/rdm/projects/aqbanking/wiki/AqBanking6_Bankentabelle">AqBanking6
+ Bankentabelle</ulink> you can find a list of bank server url known
+ to work.
+ </para>
+</sect3>
+<sect3 id="hbci_select_bank_account_and_user_name">
+ <title>Select bank account and user name</title>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-hbci-page4.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</sect3>
+<sect3 id="hbci_choose_extended_settings_or_continue">
+ <title>Choose extended settings or continue</title>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-hbci-page5.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</sect3>
+<sect3 id="hbci_select_extended_settings">
+ <title>Select extended settings</title>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-hbci-page6.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</sect3>
+<sect3 id="hbci_finish_creating_user">
+ <title>Finish creating user</title>
+ <para>
+ After pressing "Next" aqbanking will contact the server
+ and fetches the server certificate and bank info.
+ </para>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-hbci-page7.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ After pressing "Close" your user account has
+ been created.
+ </para>
+</sect3>
+<sect3 id="add_account">
+ <title>Add account</title>
+ <para>
+ In case that adding a user account did not fail, the accounts
+ associated to the given bank should already be present in the
+ account list.
+ </para>
+</sect3>
+</sect2>
+<sect2 id="paypal_create_user">
+ <title>Paypal</title>
+<sect3 id="paypal_select_online_banking_protocol">
+ <title>Select online banking protocol</title>
+ <para>
+ After pressing "Next" you will see a list of available
+ online banking protocols:
+ </para>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-paypal-page1.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</sect3>
+<sect3 id="paypal_info_page_1">
+ <title>Configuring a user for Paypal</title>
+ <para>
+ After choosing "Paypal" and pressing "Next" you
+ will see the following info page:
+ </para>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-paypal-page2.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ Press "Run" to continue.
+ </para>
+</sect3>
+<sect3 id="paypal_user_name_and_email">
+ <title>Enter user name and the Paypal email address</title>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-paypal-page3.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</sect3>
+<sect3 id="paypal_api_password_and_signature">
+ <title>Select API settings</title>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-paypal-page4.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</sect3>
+<sect3 id="paypal_info_page_2">
+ <title>Summary info before creating the user</title>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-paypal-page5.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</sect3>
+<sect3 id="paypal_setup_password">
+ <title>Enter new password for the Paypal user</title>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-paypal-page6.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</sect3>
+<sect3 id="paypal_finish_creating_user">
+ <title>Finish creating user</title>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-user-wizard-paypal-page7.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>
+ After pressing "finish" the user account has
+ been created.
+ </para>
+ <para>
+ The remaining step is to create a new account based on this user.
+ </para>
+</sect3>
+<sect3 id="paypal_choose_backend">
+ <title>Add paypal account</title>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-account-wizard-paypal-page1.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</sect3>
+<sect3 id="paypal_add_account">
+ <title>Add paypal account</title>
+ <screenshot>
+ <screeninfo></screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="aqbanking-account-wizard-paypal-page2.png" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</sect3>
+</sect2>
+</sect1>
+</chapter>
diff --git a/doc/index.docbook b/doc/index.docbook
index 7938f50c5b..f29ae003f0 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -85,6 +85,7 @@
<!ENTITY whatsnew SYSTEM "whatsnew.docbook">
<!ENTITY details-institutions SYSTEM "details-institutions.docbook">
<!ENTITY details-accounts SYSTEM "details-accounts.docbook">
+ <!ENTITY details-aqbanking SYSTEM "details-aqbanking.docbook">
<!ENTITY details-loans SYSTEM "details-loans.docbook">
<!ENTITY details-budgets SYSTEM "details-budgets.docbook">
<!ENTITY details-forecast SYSTEM "details-forecast.docbook">
@@ -136,7 +137,7 @@ and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element.
</authorgroup>
<copyright>
-<year>2000-2024</year>
+<year>2000-2025</year>
<holder>The &kmymoney; Development Team</holder>
</copyright>
<!-- Translators: put here the copyright notice of the translation -->
@@ -220,6 +221,7 @@ consistent documentation style across all KDE apps. -->
&details-formats;
&details-database;
&details-settings;
+&details-aqbanking;
&faq;
&reference;
&credits;
More information about the kde-doc-english
mailing list