Git commit 939d555d10ca32f15f726dcc8b9e4d2647b07695 by Jack Ostroff. Committed on 15/11/2023 at 00:52. Pushed by ostroffjh into branch 'Handbook-5.2'.
Complete first pass on import and export M +4 -2 README-CONTRIBUTORS M +4 -2 doc/details-impexp-csv.docbook M +46 -4 doc/details-impexp-csvexp.docbook M +57 -33 doc/details-impexp-woob.docbook M +6 -19 doc/details-impexp.docbook M +19 -20 doc/details-settings.docbook M +2 -3 doc/makemostof.docbook https://invent.kde.org/office/kmymoney/-/commit/939d555d10ca32f15f726dcc8b9e4d2647b07695 diff --git a/README-CONTRIBUTORS b/README-CONTRIBUTORS index 26e5ec229..43e4fe96d 100644 --- a/README-CONTRIBUTORS +++ b/README-CONTRIBUTORS @@ -64,17 +64,19 @@ This is in the order pulled in from index.docbook, with brief note on state of u prelim update complete <!ENTITY details-reports SYSTEM "details-reports.docbook"> - + prelim update complete <!ENTITY details-impexp SYSTEM "details-impexp.docbook"> prelim update complete <!ENTITY details-impexp-csv SYSTEM "details-impexp-csv.docbook"> - prelim begun. + prelim update one pass. needs lots more work <!ENTITY details-impexp-csvexp SYSTEM "details-impexp-csvexp.docbook"> + prelim update complete <!ENTITY details-impexp-woob SYSTEM "details-impexp-woob.docbook"> + prelim update complete - needs reveiw by Woob user. <!ENTITY details-loans SYSTEM "details-loans.docbook"> diff --git a/doc/details-impexp-csv.docbook b/doc/details-impexp-csv.docbook index 22e0b7142..f5b9e4f20 100644 --- a/doc/details-impexp-csv.docbook +++ b/doc/details-impexp-csv.docbook @@ -416,7 +416,7 @@ </para> </listitem> -<!-- FIXME: shat does the Calucaltae Fee button do, and when is it activated? --> +<!-- FIXME: what does the Calucaltae Fee button do, and when is it activated? --> <listitem> <para> @@ -643,6 +643,7 @@ </sect3> <sect3><title>Make QIF File</title> + <para> This button gives you the ability, after the import has been completed, to save the data from the CSV file as a QIF file, should you require one for any @@ -654,6 +655,7 @@ </sect3> <sect3><title>Finishing up</title> + <para> For a <guilabel>Banking</guilabel> import, the plugin has finished, and &kmymoney; will prompt you, as stated above, for the correct account into @@ -675,6 +677,7 @@ </sect3> <sect3><title>Adding Investment Activity Types</title> + <para> If you find that your investment statements keep including activity types that are not recognized, just add them to the section in the resource file. (See @@ -740,4 +743,3 @@ </sect3> </sect2> </sect1> - diff --git a/doc/details-impexp-csvexp.docbook b/doc/details-impexp-csvexp.docbook index bfff73ca9..1aa00cc6f 100644 --- a/doc/details-impexp-csvexp.docbook +++ b/doc/details-impexp-csvexp.docbook @@ -1,10 +1,14 @@ <sect1 id="details.impexp.csvexp"> +<sect1info> + <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author> +</sect1info> <title>CSV Exporter</title> + <para> - To export one of your accounts to a CSV file, choose the - <menuchoice><guimenu>File</guimenu><guisubmenu>Export</guisubmenu> - <guimenuitem>CSV...</guimenuitem></menuchoice> menu item. You will - be prompted for some options. + To export data to a CSV file, choose the <menuchoice><guimenu>File</guimenu> + <guisubmenu>Export</guisubmenu> <guimenuitem>CSV...</guimenuitem> </menuchoice> + menu item. The dialog which appears gives you a number of choices which control + the data to be exported. </para> <para> @@ -18,5 +22,43 @@ </textobject> </mediaobject> </screenshot> + + Please note that an exported CSV file can include data from only one account. +</para> + +<para> + Specify the name of the exported CSV file either by entering the complete path in + the <guilabel>File to export to</guilabel> field, or by clicking the + <guilabel>Browse</guilabel> button and navigating to it in the Save File dialog. + Choose which account to export with the <guilabel>Account to export</guilabel> + dropdown. +</para> + +<para> + The time period of data exported is controlled by the <guilabel>Date + Range</guilabel> <guilabel>Start on</guilabel> and <guilabel>End on</guilabel> date + fields. The default values represent the complete date range of your entire data + file, and they are adjusted when you select an account to export. +</para> + +<para> + By default, the <guilabel>Field Separator</guilabel> is a comma, but you can also + choose to use a tab or semicolon. +</para> + +<para> + If you check the <guilabel>Contents to Export</guilabel> + <guilabel>Account</guilabel> radio button, then the data exported will be the + transactions from the specified account and date range. However, if you select the + <guilabel>Categories</guilabel> radio button, then the exported file will contain + one row for each category which has been defined. For top level categories, the + category name is shown, and an <quote>I</quote> or <quote>E</quote> is shown to + indicate whether the Category is Income or Expense. For non top-level categories, + the parent category is also shown. +</para> + +<para> + The exporter will output a set of columns appropriate for the type of account being + exported. </para> </sect1> diff --git a/doc/details-impexp-woob.docbook b/doc/details-impexp-woob.docbook index 6d650ab48..ac1016f2d 100644 --- a/doc/details-impexp-woob.docbook +++ b/doc/details-impexp-woob.docbook @@ -1,37 +1,61 @@ <sect1 id="details.impexp.woob"> - <sect1info> - <author>&Dawid.Wrobel; &Dawid.Wrobel.mail;</author> - </sect1info> +<sect1info> + <author>&Dawid.Wrobel; &Dawid.Wrobel.mail;</author> +</sect1info> +<title>Woob Importer</title> - <title>Woob Importer</title> - <sect2> - <title>What is Woob?</title> - <para> - <ulink url="https://woob.tech/";>Woob</ulink> 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> +<sect2><title>What is Woob?</title> - <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> + <acronym><ulink url="https://woob.tech/";>Woob</ulink></acronym>, or <quote>Web + outside of browsers</quote> 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 banks and institutions which + otherwise do not offer support for any other financial protocol that &kmymoney; + handles. +</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 +<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. All major &Linux; + distribuitons package Python, and you should use that version, if possible. + Otherwise, you can download a package for your system from the <ulink + url="https://www.python.org/downloads/";>official Python 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 the <ulink + url="https://woob.tech/install/";>Woob website</ulink>. When it runs, &kmymoney; + checks for the presence of Woob, and loads the plugin if it is found. See the + section on <link linkend="details.settings.plugins">Plugins</link> in the chapter + on <link linkend="details.settings">Settings</link> for more information on + confirming that the woob plugin is loaded. +</para> +</sect2> + +<sect2><title>Using Woob</title> + +<para> + If Woob is installed, and the &kmymoney; woob plugin is loaded, you should be able + to set it up for use with an account by invoking the <menuchoice> + <guimenu>Account</guimenu> <guimenuitem>Map to online account...</guimenuitem> + </menuchoice> menu item. Once that is done, the <menuchoice> + <guimenu>Account</guimenu> <guimenuitem>Update account...</guimenuitem> + </menuchoice> menu item will download transactions for that account using Woob. +</para> +</sect2> +</sect1> diff --git a/doc/details-impexp.docbook b/doc/details-impexp.docbook index f6f00a581..a964579c5 100644 --- a/doc/details-impexp.docbook +++ b/doc/details-impexp.docbook @@ -1190,27 +1190,14 @@ </sect2> </sect1> -<!-- Using an entity for the csv impexp sections allow it to be maintained in a - separate file. Original note here suggested this was a workaround, but I - don't know why. --> -<!-- entity defined in index.docbook --> +<!-- Using entities for the csv import and export and woob import sections allow then + to be maintained in separate files. The original note here suggested this was a + workaround, but I don't know why. --> +<!-- entities defined in index.docbook --> +<!-- perhaps these entity invokations should also be in index.docbook, where all + the chapters are so invoked. --> &details-impexp-csv; &details-impexp-csvexp; - -<!-- as above, for woob import. --> -<!-- entity defined in index.docbook --> &details-impexp-woob; -<sect1 id="details.impexp.plugins"><title>Writing Importer Plugins</title> - -<para> - <!-- FIXME: this is mentioned more generally in the makemostof section on Plugins, - so not sure if it is really necessary to also cover here, or just refer to - that section. --> - &kmymoney; contains explicit support for importer plugins. If you have a custom - format, and you would like to write an importer plugin, we would value your - contribution. To do so, you'll need to compile the program from source. Then use - the OFX Importer Plugin as an example. -</para> -</sect1> </chapter> diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook index 1827c450b..ab67b0f8d 100644 --- a/doc/details-settings.docbook +++ b/doc/details-settings.docbook @@ -860,30 +860,29 @@ of accounts.</para> <title>Plugins</title> <para> - This section provides information about the available plugins, and allow you - to modify the behavior of installed plugins. Note that the list of plugins - displayed will depend on which plugins &kmymoney; found when it started. It - does not matter whether the plugin was compiled as part of the application or - added as a separate package. + This section provides information about the available plugins, and allow you to + modify the behavior of installed plugins. Note that the list of plugins displayed + will depend on which plugins &kmymoney; found when it started. It does not matter + whether the plugin was compiled as part of the application or added as a separate + package. <screenshot> - <screeninfo>Configure Plugins</screeninfo> - <mediaobject> - <imageobject> + <screeninfo>Configure Plugins</screeninfo> + <mediaobject> + <imageobject> <imagedata fileref="configure_plugins.png" format="PNG" /> - </imageobject> - <textobject> + </imageobject> + <textobject> <phrase>Configure Plugins</phrase> - </textobject> - </mediaobject> + </textobject> + </mediaobject> </screenshot> - Every plugin can be enabled or disabled, according to the state of the - checkbox next to the name of the plugin. In addition, at the right, there is - also an <guibutton>information</guibutton> (&infoicon;) button for each, which - will show the plugin version and author. For some plugins, further - information on configuring and using it may be found by clicking the - configure, or tool icon just to the left of the information button. There is - only one plugin that requires configuration, and that is the Check printing - plugin. + Every plugin can be enabled or disabled, according to the state of the checkbox + next to the name of the plugin. In addition, at the right, there is also an + <guibutton>information</guibutton> (&infoicon;) button for each, which will show + the plugin version and author. For some plugins, further information on + configuring and using it may be found by clicking the configure, or tool icon just + to the left of the information button. There is only one plugin that requires + configuration, and that is the Check printing plugin. </para> <sect2 id="details.settings.plugins.printchecks"> diff --git a/doc/makemostof.docbook b/doc/makemostof.docbook index c19442f26..6a48c9079 100644 --- a/doc/makemostof.docbook +++ b/doc/makemostof.docbook @@ -463,9 +463,8 @@ <para> See the section on <link linkend="details.settings.plugins">Plugins</link> in the - chapter on <link linkend="details.settings">Settings</link> in the for more - information on determining which plugins are installed and active, and how to - configure them. + chapter on <link linkend="details.settings">Settings</link> for more information on + determining which plugins are installed and active, and how to configure them. </para> <para>
