Git commit bf9ef0b31123c10f4b3bb0a283a7397aa34d8cfb by Dawid Wróbel. Committed on 19/07/2021 at 10:38. Pushed by wrobelda into branch 'master'.
Docs: add Woob plugin section A +37 -0 doc/details-impexp-woob.docbook M +5 -0 doc/details-impexp.docbook M +5 -3 doc/index.docbook https://invent.kde.org/office/kmymoney/commit/bf9ef0b31123c10f4b3bb0a283a7397aa34d8cfb diff --git a/doc/details-impexp-woob.docbook b/doc/details-impexp-woob.docbook new file mode 100644 index 000000000..145af1a61 --- /dev/null +++ b/doc/details-impexp-woob.docbook @@ -0,0 +1,37 @@ +<sect1 id="details.impexp.woob"> + <sect1info> + <author>&Dawid.Wrobel; &Dawid.Wrobel.mail;</author> + </sect1info> + + <title>Woob Importer</title> + <sect2> + <title>What is Woob?</title> + <para> + <ulink url="https://woob.tech/";>Woob</ulink> is is <quote>a collection of applications able to interact with + websites, without requiring the user to open them in a browser</quote>. One of + <ulink url="https://woob.tech/applications/";>such applications</ulink> allows specifically to interact with + <ulink url="https://woob.tech/applications/bank";>financial institutions</ulink>. &kmymoney; provides a + plugin that employs it directly, therefore allowing to import transactions from those accounts which + otherwise do not offer support for any other financial protocol that &kmymoney; handles. + </para> + + <note> + <para> + &kmymoney; currently requires that you install Woob independently. Refer to the further sections for + details. + </para> + </note> + </sect2> + <sect2> + <title>Installing Woob</title> + <para> + You need to install Python 3 first before continuing. You can download a package for your system from the + <ulink url="https://www.python.org/downloads/";>official website</ulink>. + </para> + + <para> + With Python 3 installed, you should now be able to easily download and install required Woob modules. + Please refer to the instructions on <ulink url="https://woob.tech/install/";>Woob website</ulink>. + </para> + </sect2> +</sect1> \ No newline at end of file diff --git a/doc/details-impexp.docbook b/doc/details-impexp.docbook index ae65b59be..ef93c33f8 100644 --- a/doc/details-impexp.docbook +++ b/doc/details-impexp.docbook @@ -1136,6 +1136,11 @@ &details-impexp-csv; &details-impexp-csvexp; +<!-- here goes the new Woob impexp section. New entity is only a temporary + workaround, although might be good to keep it in a separate file --> +<!-- entity defined in index.docbook --> +&details-impexp-woob; + <sect1 id="details.impexp.plugins"> <title>Writing Importer Plugins</title> diff --git a/doc/index.docbook b/doc/index.docbook index 802841de5..088399d2b 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -41,12 +41,12 @@ <!ENTITY Christian.David "<personname><firstname>Christian</firstname><surname>Dávid</surname></personname>"> <!ENTITY Christian.David.mail "<email>[email protected]</email>"> - <!-- the following author entity was added to contributor.entities for the 5.0 release - it can be removed from this file once it is present in the kdelibs minimum version required by &kmymoney; --> - <!ENTITY Michael.Carpino "<personname><firstname>Michael</firstname><surname>Carpino</surname></personname>"> <!ENTITY Michael.Carpino.mail "<email>[email protected]</email>"> + <!ENTITY Dawid.Wrobel "<personname><firstname>Dawid</firstname><surname>Wróbel</surname></personname>"> + <!ENTITY Dawid.Wrobel.mail "<email>[email protected]</email>"> + <!-- the following entities have been added to user.entities in trunk and probably 4.7 branch of svn they are only in the french branch, and are required for processing of the french documentation they can be removed from this file once they are present in the kdelibs minimum version required by &kmymoney; --> @@ -97,6 +97,7 @@ <!ENTITY details-impexp SYSTEM "details-impexp.docbook"> <!ENTITY details-impexp-csv SYSTEM "details-impexp-csv.docbook"> <!ENTITY details-impexp-csvexp SYSTEM "details-impexp-csvexp.docbook"> + <!ENTITY details-impexp-woob SYSTEM "details-impexp-woob.docbook"> <!ENTITY details-reconciliation SYSTEM "details-reconciliation.docbook"> <!ENTITY details-search SYSTEM "details-search.docbook"> <!ENTITY details-reports SYSTEM "details-reports.docbook"> @@ -131,6 +132,7 @@ and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element. <author> &Darin.Strait; &Darin.Strait.mail; </author> <author> &Roger.Lum; &Roger.Lum.mail; </author> <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author> +<author> &Dawid.Wrobel; &Dawid.Wrobel.mail; </author> <!-- TRANS:ROLES_OF_TRANSLATORS --> </authorgroup>
