[office/kmymoney/5.1] doc: Update handbook import/export chapter and man page
Jack Ostroff
null at kde.org
Tue Jun 14 23:57:14 BST 2022
Git commit d27498031f45392c91fe996109672c9415120d62 by Jack Ostroff.
Committed on 14/06/2022 at 22:56.
Pushed by ostroffjh into branch '5.1'.
Update handbook import/export chapter and man page
M +48 -33 doc/details-impexp-woob.docbook
M +123 -100 doc/details-impexp.docbook
M +30 -26 doc/man-kmymoney.1.docbook
M +1 -1 doc/whatsnew.docbook
https://invent.kde.org/office/kmymoney/commit/d27498031f45392c91fe996109672c9415120d62
diff --git a/doc/details-impexp-woob.docbook b/doc/details-impexp-woob.docbook
index 145af1a61..23c8a704c 100644
--- a/doc/details-impexp-woob.docbook
+++ b/doc/details-impexp-woob.docbook
@@ -1,37 +1,52 @@
<sect1 id="details.impexp.woob">
- <sect1info>
- <author>&Dawid.Wrobel; &Dawid.Wrobel.mail;</author>
- </sect1info>
+ <sect1info>
+ <author>&Dawid.Wrobel; &Dawid.Wrobel.mail;</author>
+ <author>&Jack.H.Ostroff; &Jack.H.Ostroff.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>
+ <title>Woob Importer</title>
+ <sect2>
+ <title>What is Woob?</title>
+ <para>
+ <ulink url="https://woob.tech/">Woob</ulink> (short for <quote>Web outside of
+ browsers</quote>) 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 account at those institutions 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>
+ <note>
+ <para>
+ &kmymoney; currently requires that you install Woob independently. Refer to the following
+ sections for details.
+ </para>
+ </note>
+ </sect2>
+ <sect2>
+ <title>Installing Woob</title>
+ <para>
+ An increasing number of Linux distributions provide a package for Woob, and this is
+ preferable, if one is available for you.
+ </para>
+ <para>
+ You need to install Python 3 first before continuing. All Linux distributions provide
+ packages for Python, but you can always 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
+ <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>
+ <sect2>
+ <title>Using Woob</title>
+ <para>
+ &kmymoney; uses the <quote>woob bank</quote> module.
+ </para>
+ </sect2>
+</sect1>
diff --git a/doc/details-impexp.docbook b/doc/details-impexp.docbook
index ef93c33f8..7eb9dea44 100644
--- a/doc/details-impexp.docbook
+++ b/doc/details-impexp.docbook
@@ -3,9 +3,10 @@
<chapterinfo>
<authorgroup>
<author> &Ace.Jones; &Ace.Jones.mail; </author>
+ <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2011-07-03</date>
- <releaseinfo>4.6</releaseinfo>
+ <date>2022-06-05</date>
+ <releaseinfo>5.1.2</releaseinfo>
</chapterinfo>
<title>Importing and Exporting</title>
@@ -86,8 +87,8 @@
<para>
For both products, the highest level of structure in the file is the
- account. &kmymoney; supports 5 main types of account: Asset, Liability,
- Income, Expense and Equity, each of which may have various subtypes, ⪚,
+ account. &kmymoney; supports 5 main types of accounts: Asset, Liability,
+ Income, Expense, and Equity; each of which may have various subtypes, ⪚,
Checking, Credit Card, &etc; &kmymoney; includes a 'standard' account for
each of these five types, and all other accounts are held subordinate to one
of these. &kmymoney; enforces more consistency (or less flexibility, depending
@@ -103,8 +104,8 @@
<para>
&kmymoney; uses the term Category to denote an account of an Income or Expense
- type. Unlike &gnucash;, these are not considered as 'ledger' accounts, and entry
- of transactions folder into categories is not supported; allocations are made
+ type. Unlike &gnucash;, these are not considered as 'ledger' accounts, and direct
+ entry of transactions into categories is not supported; allocations are made
during transaction entry into other account types.
</para>
</sect4>
@@ -113,7 +114,7 @@
<title>Structure and Placeholders</title>
<para>
- &gnucash; supports the use of Placeholder accounts. In effect, these are just
+ &gnucash; supports the use of Placeholder accounts. In effect, these are
read-only accounts into which no transactions can be entered, but which function
in an analogous fashion to folders in a folder structure, as a holder for other
accounts. Though &kmymoney; does not support this feature as such, it does
@@ -210,7 +211,7 @@
<para>
&kmymoney; prefers that all transactions have a Payee (a generic term that
encompasses both payees and payers), and unlike &gnucash;, a list of these
- payees is maintained. Payee names are generated by the importer from the
+ Payees is maintained. Payee names are generated by the importer from the
&gnucash; transaction's Description field.
</para>
</sect4>
@@ -295,9 +296,9 @@
</itemizedlist>
<para>
- It depends entirely on user requirements which of these options is relevant in
- each situation, and in some cases, manual restructuring of accounts after
- importation may be necessary.
+ User requirements and preferences determine which of these options is relevant
+ in each situation, and in some cases, manual restructuring of accounts after
+ import may be necessary.
</para>
</sect4>
@@ -315,8 +316,8 @@
<title>Online Quotes</title>
<para>
- For obtaining online price and currency rate quotations, &gnucash; uses a
- package called <literal>Finance::Quote</literal>. Recent versions of &kmymoney;
+ For obtaining online price and currency rate quotations, &gnucash; uses a perl
+ package called <literal>Finance::Quote</literal>. &kmymoney;
contain support for this package for obtaining stock quotes, and this will be
used by default when importing data. You may however select to convert to the
native method used by &kmymoney; which is covered in more detail in
@@ -327,7 +328,7 @@
If you choose to do so, the following dialog will allow selection of a
'native' &kmymoney; price source, or a user-defined source, for each account
for which online quotes are required. However, the stock (ticker) symbol will
- be imported unchanged. Since this symbol will almost certainly be different in
+ be imported unchanged. Since this symbol may be different in
the two packages, it will need to be manually edited after completion of the
import process. Future currency rate updates will not use <literal>Finance::Quote</literal>,
and will always use the native retrieval method.
@@ -359,7 +360,7 @@
<title>Schedule types</title>
<para>
- &kmymoney; classifies all schedules as one of three types, Bills, Deposits, or
+ &kmymoney; classifies all schedules as one of three types: Bills, Deposits, or
Transfers. Since &gnucash; does not make such a distinction, the importer
attempts to determine the classification from the accounts and direction of
money movements. It may be that in some cases incorrect assumptions are made,
@@ -600,12 +601,12 @@
</para>
<para>
- The resulting dialog prompts for the QIF filename allowing you to locate the
+ The resulting dialog prompts for the QIF filename, allowing you to locate the
file by clicking on the <guibutton>Browse</guibutton> button.
</para>
<para>
- Also, &kmymoney; differentiates between the import of a bank statement file
+ &kmymoney; differentiates between the import of a bank statement file
and historic data exported from another application. The default is to import
a bank statement file. In case you are importing data from your previous personal
finance manager application select the appropriate option.
@@ -631,16 +632,16 @@
<para>
Next, &kmymoney; imports the data and creates all necessary objects, such as
- payee information, accounts and category records, and stock price information.
+ Payees, Accounts, Categories, and stock price information.
Wherever possible, existing transactions will be matched against the imported
information. A progress bar is shown and updated during the import process.
</para>
<para>
- In case &kmymoney; could not detect the name of the account to be imported,
+ In case &kmymoney; cannot detect the name of the account to be imported,
the user will be asked to select the account into which the data should be
imported. If the account does not already exist in your file, a new account
- can be created by clicking on <guibutton>Create</guibutton>.
+ can be created by clicking the <guibutton>Create</guibutton> button.
</para>
<para>
@@ -663,8 +664,8 @@
</para>
<para>
- After importing, all of the imported transactions will be shown with a yellow
- background in the ledger view. In case &kmymoney; was able to match an
+ After importing, all of the imported transactions will be shown in the ledger
+ view with a yellow background. In case &kmymoney; was able to match an
imported transaction with an already existing transaction, the background is
shown in light green.
</para>
@@ -672,7 +673,7 @@
<para>
The next step is to verify the imported data and accept it. This is a general
process and also applies to imports from other sources. It is outlined in a
- separate section of this document.
+ separate section of this document. JHOXXXJHO
</para>
<note>
@@ -733,8 +734,9 @@
Because there is no universally standard format for a QIF file, different
vendors have taken liberties with the format, and introduced their own
nuances. The QIF Profile allows &kmymoney; to know about the peculiarities of
- your file. To edit an existing QIF Profile, or to create a new one, press the
- <guibutton>New</guibutton> button on the QIF Import dialog, near the profile selector.
+ your file. To edit an existing QIF Profile, use the various fields on the
+ QIF Import dialog. To create a new one, press the <guibutton>New</guibutton>
+ button near the profile selector.
</para>
<para>
@@ -752,9 +754,9 @@
<note>
<para>
- Previous versions of &kmymoney; used to have a tab for date and amount
+ Recent versions of &kmymoney; no longer have tabs for date and amount
specifications. &kmymoney; now determines those settings by scanning the
- file. If it cannot figure out all settings, it will interrogate the user
+ file. If it cannot figure out all settings, it will interrogate the user
during import.
</para>
</note>
@@ -806,8 +808,8 @@
As noted previously, one of the major drawbacks of the QIF format is the lack
of a unique identifier for each transaction. Thus, if you import a QIF file
and some of the transactions are already in your ledger, you may get
- duplicates. &kmymoney; attempts to get around this by looking for
- transactions that look similar to those you already have. If it finds
+ duplicates. &kmymoney; attempts to get around this by looking for existing
+ transactions that look similar to the one being imported. If it finds
something that looks like the same transaction, it will match the apparent
duplicate.
</para>
@@ -887,7 +889,7 @@
To export one of your accounts to a QIF file, choose
the <menuchoice><guimenu>File</guimenu><guisubmenu>Export</guisubmenu>
<guimenuitem>QIF...</guimenuitem></menuchoice> menu item. You will be prompted for
- which single account to export, what file to export it to, and what QIF Profile
+ which single account to export, what file to export it to, and which QIF Profile
to use.
</para>
@@ -913,6 +915,7 @@
<sect1info>
<author>&Ace.Jones; &Ace.Jones.mail;</author>
<author>&Thomas.Baumgart; &Thomas.Baumgart.mail;</author>
+ <author>&Jack.H.Ostroff; &Jack.H.Ostroff.mail;</author>
</sect1info>
<title>OFX Importer Plugin</title>
@@ -921,27 +924,34 @@
<para>
&kmymoney; will import OFX files painlessly. However, this functionality is
- not built into the core program. You must obtain and install the OFX Importer
- Plugin. Once that is installed, the command to import OFX files will
- automatically show up under the <menuchoice><guimenu>File</guimenu>
+ not built into the core program - it is provided as a Plugin. You must obtain
+ and install the OFX Importer Plugin for this functionality to be available,
+ Once that is done, the command to import OFX files will automatically show up
+ under the <menuchoice><guimenu>File</guimenu>
<guisubmenu>Import</guisubmenu></menuchoice> submenu.
</para>
<para>
- Note that many prepackaged versions of &kmymoney; were built with the OFX
+ Note that the source of the Plugin is provided as part of the &kmymoney;
+ source, and most prepackaged versions of &kmymoney; are built with the OFX
importer already included or available as a separate package. If the OFX
importer does not seem to be installed in your version, the first place to
- check is in the same place you got your base &kmymoney; package.
+ check is in the same place you got your base &kmymoney; package. You can
+ check whether it is installed either by trying to invoke the above submenu, or
+ by invoking the <menuchoice><guimenu>Settings</guimenu>
+ <guisubmenu>Configure KMyMoney...</guisubmenu></menuchoice> menu, selecting
+ <guilabel>Plugins</guilabel> in the left pane, and looking for the OFX
+ Importer in the list of installed Plugins.
</para>
<para>
If you have installed from RPM, the OFX Importer Plugin is contained within
- the kmymoney-ofx package. It should be available from whatever source you got the
- base &kmymoney; package. If you have built from sources, all you need to do is
- have preferably the libOFX 0.9 development headers and libraries installed on
- your system. The &kmymoney; build process will detect these and compile the
- plugin. At the time of release of &kmymoney; 4.6, the latest libofx version
- was 0.9.4, which is also the minimum required version.
+ the kmymoney-ofx package. It should be available from whatever source you got
+ the base &kmymoney; package. If you have built from sources, all you need to
+ do is have a recent version of the libOFX development headers and libraries
+ installed on your system. The &kmymoney; build process will detect these and
+ compile the plugin. As of September, 2021, version 0.10.3 was avialable,
+ although the minimum required version for &kmymoney; is still 0.9.4.
</para>
<para>
@@ -956,13 +966,14 @@
<title>What is OFX</title>
<para>
- OFX stands for <quote>Open Financial Exchange</quote>. According to the
- <ulink url="https://www.ofx.net/">OFX web site</ulink> <quote>Open Financial
- Exchange (OFX) is a unified specification for the electronic exchange of
- financial data between financial institutions, businesses and consumers via
- the Internet. OFX is not a financial institution.</quote> The specification
- defines formats for transfer of financial data both by file and by direct
- interchange.
+ OFX stands for <quote>Open Financial Exchange,</quote> although in 2019, the
+ OFX Consortium joined the <quote>Financial Data Exchange (FDX).</quote>
+ According to the <ulink url="https://finincialdataexchange.org/">FDX web
+ site</ulink> <quote>Open Financial Exchange is an open standard for
+ client-server systems and cloud based APIs for exchanging financial data, and
+ performing financial transactions between financial institutions, and
+ financial applications.</quote> The specification defines formats for transfer
+ of financial data both by file and by direct interchange.
</para>
<para>
@@ -981,7 +992,10 @@
Home</ulink>. They maintain a directory of financial institutions that
support OFX. This can be useful if you have problems setting up <link
linkend="details.impexp.ofxdirectconnect">OFX direct connect.</link> They also
- have a forum for discussions about OFX issues.
+ have a forum for discussions about OFX issues. However, there is a post on
+ the site that it is expected to be closed down in February, 2022, if the
+ current maintainer does not find someone to replace him and take over running
+ the site.
</para>
</sect2>
@@ -992,14 +1006,18 @@
The most basic way to import an OFX file is to choose the importer from the
menu bar. From the <menuchoice><guimenu>File</guimenu><guisubmenu>Import</guisubmenu>
<guimenuitem>OFX...</guimenuitem></menuchoice> menu item. If OFX does not show
- up under Import, you do not have the OFX Importer Plugin installed correctly.
- Please see the previous section.
+ up under Import, the OFX Importer Plugin is either not installed or not
+ installed installed correctly. Please see the previous section.
</para>
<para>
The first thing the importer will do is ask you into which account to import
the transactions. If there are transactions from multiple accounts in your
- file, you will be asked this question multiple times.
+ file, you will be asked this question multiple times. Note that when
+ importing data for an investment account, purely cash transactions will be
+ imported to the associated brokerage account, if one is configured. If a
+ brokerage account has not been configured (or does not have the default name)
+ you may be asked to identify the account to use.
</para>
<para>
@@ -1011,10 +1029,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
- if you have installed that. Note that the two importers do behave slightly
- differently, and they are written and supported by two different developers.
+ Please note that this section describes the <quote>native</quote> OFX Importer
+ Plugin. OFX files may also be imported using the AqBanking Importer Plugin if
+ you have installed that. The two importers do behave slightly differently,
+ and they are written and supported by different developers.
</para>
</sect2>
@@ -1037,9 +1055,9 @@
bank's web site, and click on a link to download an OFX file. Your browser
should ask you what program you would like to use to open the file. Point
your browser to &kmymoney;. It will then import the downloaded OFX file into
- the &kmymoney; file you most recently had open. You can also change the file
- associations of your desktop environment, and have &kmymoney; open the OFX
- file automatically for you.
+ the &kmymoney; file currently open, or the one you most recently had open.
+ You can also change the file associations of your desktop environment, and
+ have &kmymoney; open the OFX file automatically for you.
</para>
<para>
@@ -1052,43 +1070,42 @@
<title>Direct Connect</title>
<para>
- OFX Direct Connect is now supported in &kmymoney;. This gives you the ability
- to contact your bank directly to obtain statements. In the future, there will
- be more help written, and this will be moved to its own section.
+ OFX Direct Connect is now supported in &kmymoney;. This gives &kmymoney; the
+ ability to contact your bank directly to obtain transaction. To enable this
+ feature, you must compile &kmymoney; with the
+ <userinput><option>--enable-ofxbanking</option></userinput> switch. This is
+ now the default, and this feature is enabled in the version provided by most
+ if not all Linux distributions, and the versions provided at the &kmymoney;
+ website.
</para>
<para>
- To enable this feature, you must compile &kmymoney; with the
- <userinput><option>--enable-ofxbanking</option></userinput> switch (now the default).
-</para>
-
-<para>
- Please be warned: Many banks require a separate signup, will give you a
- separate password or PIN, and may even charge you a separate fee for this
- service. No bank directly supports &kmymoney;. You will have to tell them
- you want to bank directly from <application>MS Money</application> or
- <application>Quicken</application>.
+ Please be warned: some banks require a different signup from the main web
+ banking access, will give you a separate password or PIN, and may even charge
+ you a separate fee for this service. No bank directly supports &kmymoney;.
+ You will have to tell them you want to bank directly from <application>MS
+ Money</application> or <application>Quicken</application>.
</para>
<para>
The first step is to configure each account for which you wish to download
- statements. Go to the Accounts view, right click on the account you wish to
- configure, and choose <guimenuitem>Map to online account...</guimenuitem>.
- In case more than one online banking plugin is installed on your system
- you will be asked which one to use. For the internal OFX method select
+ statements. Go to the Accounts View, right click on the account you wish to
+ configure, and choose <guimenuitem>Map to online account...</guimenuitem>. In
+ case more than one online banking plugin is installed on your system you will
+ be asked which one to use. For the internal OFX method select
<guimenuitem>&kmymoney; OFX</guimenuitem>. A list of banks will be downloaded
from the Internet and a wizard will guide you through choosing a bank,
entering your username and password, and selecting an account. Should you
- find that your bank is not listed, then it may still be possible to use the
- manual option. Your bank may be able to provide the required parameters, or
- you may have to do some research to find them.
+ find that your bank is not listed, it may still be possible to use the manual
+ option. Your bank may be able to provide the required parameters, or you may
+ have to do some research to find them.
</para>
<note>
<para>
Setting up OFX Direct Connect can sometimes be a challenge, especially as
- the implementation at most institutions do not provide sufficient details in
- error messages. One particular issue to note is that many institutions
+ the implementations at most institutions do not provide sufficient details
+ in error messages. One particular issue to note is that many institutions
require you to change your password the first time you access it online
using this method. Unfortunately, at this time, the library that &kmymoney;
uses (libofx) does not have a way to interactively change a password. In
@@ -1096,25 +1113,31 @@
institution to change the password for you. Until we are able to expand
this section with more detailed troubleshooting information, if you have
trouble getting this to work for you, you can ask for help on the &kmymoney;
- developer list &devlist;.
+ developer mailing list &devlist;.
</para>
</note>
<para>
Once you have an account set up with online banking, go to the ledger for that
- account. Then choose <menuchoice><guimenu>Account</guimenu><guimenuitem>Update
- account...</guimenuitem></menuchoice> menu item. This will connect to your bank,
- and download a statement for the last 60 days.
+ account, and then choose the
+ <menuchoice><guimenu>Account</guimenu><guimenuitem>Update
+ account...</guimenuitem></menuchoice> menu item. This will connect to your
+ bank, and download available transactions. You can use the <link
+ linkend="details.accounts.edit">Edit account</link> dialog (under the
+ <guilabel>Online settings</guilabel> tab, <guilabel>Import
+ Details</guilabel>subtab) to indicate whether to download transactions since
+ the last update, since a specified number of days ago, or since a specified
+ date.
</para>
<note>
<para>
- In version of &kmymoney; prior to 4.6, the payee name was always taken from the
- <literal>PAYEEID</literal> field. As of version 4.6, the payee name can be based
- on either the <literal>PAYEEID</literal>, <literal>NAME</literal>, or
- <literal>MEMO</literal> field in the OFX transaction. You can configure this
- feature and some other OFX direct connect settings by selecting the appropriate
- tab in the <link linkend="details.accounts.edit">Edit account</link> dialog.
+ In versions of &kmymoney; prior to 4.6, the payee name was always taken from
+ the <literal>PAYEEID</literal> field. As of version 4.6, the payee name can
+ be based on either the <literal>PAYEEID</literal>, <literal>NAME</literal>,
+ or <literal>MEMO</literal> field in the OFX transaction. You can configure
+ this feature and some other OFX direct connect settings in the
+ <guilabel>Edit account</guilabel> dialog mentioned just above.
</para>
</note>
</sect2>
@@ -1123,21 +1146,21 @@
<title>Exporting an OFX file</title>
<para>
- It is not possible to export your data as an OFX file currently. If you are
+ It is not currently possible to export your data as an OFX file. If you are
interested to contribute in this area, please contact the libofx development
team for details.
</para>
</sect2>
</sect1>
-<!-- here goes the new csv impexp section. New entity is only a temporary
- workaround, although might be good to keep it in a separate file -->
+<!-- These entities facilitate keeping the csv import/export information in
+ separate files, but within this chapter. -->
<!-- entity defined in index.docbook -->
&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 -->
+<!-- This entity facilitates keeping the woob (formerly weboob) import/export
+ information in a separate file, but within this chapter. -->
<!-- entity defined in index.docbook -->
&details-impexp-woob;
@@ -1145,10 +1168,10 @@
<title>Writing Importer Plugins</title>
<para>
- &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.
+ &kmymoney; contains explicit support for additional importer and/or exporter
+ plugins. If you would like to write a plugin to handle a custom format, 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/man-kmymoney.1.docbook b/doc/man-kmymoney.1.docbook
index a7449a196..334106aac 100644
--- a/doc/man-kmymoney.1.docbook
+++ b/doc/man-kmymoney.1.docbook
@@ -88,8 +88,8 @@
There are eight additional people in credits.docbook for "Special Thanks."
Should any of them be included here? -->
-<date>2016-06-17</date>
-<releaseinfo>KMyMoney 5.0</releaseinfo>
+<date>2022-06-05</date>
+<releaseinfo>KMyMoney 5.1</releaseinfo>
</refentryinfo>
<refmeta>
@@ -101,7 +101,7 @@
<refnamediv>
<refname><command>kmymoney</command></refname>
-<refpurpose>the personal finances manager by &kde;</refpurpose>
+<refpurpose>the personal finance manager by &kde;</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -109,23 +109,23 @@
<command>kmymoney</command>
<group choice="opt"><option>--lang</option></group>
<group choice="opt"><option>-n</option></group>
-<group choice="opt"><option>--timers</option>
-<replaceable> column</replaceable></group>
+<group choice="opt"><option>--timers</option><replaceable> column</replaceable></group>
<group choice="opt"><option>--nocatch</option></group>
<group choice="opt"><option>--trace</option></group>
+<group choice="opt"><option>--dump-actions</option></group>
<group choice="opt"><option><replaceable>file</replaceable></option></group>
</cmdsynopsis>
-
</refsynopsisdiv>
<refsect1>
<title>Description</title>
-<para>&kmymoney; is the Personal Finance Manager by &kde;. It
-provides the functions required to balance your checkbooks, manage your personal
-loans and categories your incomes and expenses using a checkbook style graphical
-user interface.</para>
-
+<para>
+ &kmymoney; is the Personal Finance Manager by &kde;. It provides the
+ functions required to balance your checkbooks, manage your personal loans,
+ categorize your income and expenses, and more, using a checkbook style
+ graphical user interface.
+</para>
</refsect1>
<refsect1>
@@ -137,7 +137,7 @@ user interface.</para>
<term><option>--lang</option></term>
<listitem>
<para>
-Language to be used
+ Language to be used
</para>
</listitem>
</varlistentry>
@@ -146,7 +146,7 @@ Language to be used
<term><option>-n</option></term>
<listitem>
<para>
-Do not open last used file
+ Do not open last used file
</para>
</listitem>
</varlistentry>
@@ -155,7 +155,7 @@ Do not open last used file
<term><option>--timers</option></term>
<listitem>
<para>
-Enable performance timers
+ Enable performance timers
</para>
</listitem>
</varlistentry>
@@ -164,7 +164,7 @@ Enable performance timers
<term><option>--nocatch</option></term>
<listitem>
<para>
-Do not globally catch uncaught exceptions
+ Do not globally catch uncaught exceptions
</para>
</listitem>
</varlistentry>
@@ -173,7 +173,7 @@ Do not globally catch uncaught exceptions
<term><option>--trace</option></term>
<listitem>
<para>
-Turn on program traces. This option is only available when &kmymoney; is compiled in debug mode.
+ Turn on program traces. This option is only available when &kmymoney; is compiled in debug mode.
</para>
</listitem>
</varlistentry>
@@ -182,29 +182,33 @@ Turn on program traces. This option is only available when &kmymoney; is compile
<term><option>--dump-actions</option></term>
<listitem>
<para>
-Dump the names of all defined QAction objects to stdout and quit. This option is only available when &kmymoney; is compiled in debug mode.
+ Dump the names of all defined QAction objects to stdout and quit. This option
+ is only available when &kmymoney; is compiled in debug mode.
</para>
</listitem>
</varlistentry>
</variablelist>
-
</refsect1>
-
<refsect1>
<title>See Also</title>
<simplelist>
-<member>The full documentation for &kmymoney; is maintained as a docbook manual.
-If the &khelpcenter; program is properly installed at your site, the command
+<member>
+The full documentation for &kmymoney; is maintained as a docbook manual. If the
+&khelpcenter; program is properly installed at your site, the command
<userinput><command>khelpcenter</command>
<parameter>help:/kmymoney</parameter></userinput> should give you access to the
-complete manual. Alternatively the manual can be browsed in &konqueror; giving
-it the <acronym>URL</acronym> <ulink
-url="help:/kmymoney">help:/kmymoney</ulink></member>
-<member>kf5options(7)</member>
-<member>qt5options(7)</member>
+complete manual. The manual can als be browsed in &konqueror; giving it the
+<acronym>URL</acronym> <ulink url="help:/kmymoney">help:/kmymoney</ulink>.
+There are also online versions for both the stable and development versions of
+&kmymoney; at <ulink
+url="https://docs.kde.org/index.php?application=kmymoney">https://docs.kde.org/index.php?application=kmymoney"</ulink>
+ </member>
+
+ <member>kf5options(7)</member>
+ <member>qt5options(7)</member>
</simplelist>
</refsect1>
diff --git a/doc/whatsnew.docbook b/doc/whatsnew.docbook
index d2ef3549f..17b403bc2 100644
--- a/doc/whatsnew.docbook
+++ b/doc/whatsnew.docbook
@@ -88,6 +88,7 @@
<member><link linkend="details.reconcile">Schedules</link></member>
<member><link linkend="details.ledgers">Ledgers</link></member>
<member><link linkend="details.investments">Investments</link></member>
+ <member><link linkend="details.impexp">Importing and Exporting</link></member>
<member><link linkend="details.settings">Settings</link></member>
<member><link linkend="reference.menus">Reference: Menus</link></member>
<member><link linkend="credits">Credits</link></member>
@@ -98,7 +99,6 @@
<member><link linkend="details.currencies">Currencies</link></member>
<member><link linkend="details.reconcile">Reconciliation</link></member>
<member><link linkend="details.reports">Reports</link></member>
- <member><link linkend="details.impexp">Importing and Exporting</link></member>
<member><link linkend="details.loans">Loans</link></member>
<member><link linkend="details.budgets">Budgets</link></member>
<member><link linkend="details.forecast">Forecast</link></member>
More information about the kde-doc-english
mailing list