[office/kmymoney/Handbook-5.2] /: Much progress on qif import/export
Jack Ostroff
null at kde.org
Thu Oct 19 00:42:20 BST 2023
Git commit 882605c0a0cd8db303be10467fc0774d313d6d7f by Jack Ostroff.
Committed on 18/10/2023 at 22:23.
Pushed by ostroffjh into branch 'Handbook-5.2'.
Much progress on qif import/export
M +37 -2 README-CONTRIBUTORS
M +- -- doc/currency_dialog1.png
A +- -- doc/currency_editor.png
M +136 -58 doc/details-currencies.docbook
M +374 -308 doc/details-impexp.docbook
M +1 -1 doc/details-investments.docbook
M +176 -113 doc/details-reconciliation.docbook
M +391 -264 doc/details-reports.docbook
A +- -- doc/exchange_rate_editor.png
A +- -- doc/investments_view_equities.png
A +- -- doc/investments_view_securities.png
A +- -- doc/reports_configuration_chart.png
R +- -- doc/reports_configuration_general.png [from: doc/report_configuration-reporttab.png - 100% similarity]
A +- -- doc/reports_configuration_range.png
R +- -- doc/reports_configuration_rowscolumns.png [from: doc/report_configuration-rowscolumns.png - 100% similarity]
R +- -- doc/reports_view_list.png [from: doc/reports_view-all.png - 100% similarity]
https://invent.kde.org/office/kmymoney/-/commit/882605c0a0cd8db303be10467fc0774d313d6d7f
diff --git a/README-CONTRIBUTORS b/README-CONTRIBUTORS
index da0eadd9d..f19631bdd 100644
--- a/README-CONTRIBUTORS
+++ b/README-CONTRIBUTORS
@@ -58,13 +58,16 @@ This is in the order pulled in from index.docbook, with brief note on state of u
prelim update complete
<!ENTITY details-currencies SYSTEM "details-currencies.docbook">
- prelim update begun
+ prelim update complete
<!ENTITY details-reconciliation SYSTEM "details-reconciliation.docbook">
+ prelim update complete
<!ENTITY details-reports SYSTEM "details-reports.docbook">
+ prelim update complete
<!ENTITY details-impexp SYSTEM "details-impexp.docbook">
+ prelim update begun
<!ENTITY details-impexp-csv SYSTEM "details-impexp-csv.docbook">
@@ -226,8 +229,37 @@ multiple places.
needed to be altered due to field separators in the date? It shouldn't, so am I
mis-remembering, or was there a problem?
+- Price Editor dialog first column is labelled Commodity, but in New price entry, it
+ is called Security. Shouldn't this be consistent?
+
+- Reconciliatiohn wizard interest/charge dialog - should it allow split entries? Might
+ be unlikely for interest, but you might have credit card interest plus fees.
+
+- Can we change the order of reports in the Reports View to make more sense? (Look at
+ Tranacions reports for an example)
+
+- Report section CashFlow - should this be Cash Flow (with a space between?)
+
+- what are cash-flow related transactions? How is the term defined?
+
+- Can the tabs in the Reports View get an "X" to close them, instead of needing to use
+ the "Close report" button?
+
+- In Gnucash import, matching of account types, some map to things that are only
+ applicable to security subaccounts of investmant accounts. Should these be shown
+ separately, with an explanation?
+
+- Importing gnucash schedules talks about if it causes fatal errors. Is this while
+ importing, or while running later?
+
+- doc says not all report types are matched - what happens if they don't?
+
+- is the QIF Profile input filter location a single file or a command? Does it just use
+ a single file as the program, and anything more than that as a command to be invoked?
+
-
+
----------------
This is a list of potential enhancements I came up with while reviewing the handbook,
@@ -265,5 +297,8 @@ elsewhere.
the main view for that object. For example identification number for stocks is not
shown anywhere else.
--
+- In report configuration dialog, if the report has not been run (select configure from
+ the reports list) and you close, do not actually run the report.
+
+
diff --git a/doc/currency_dialog1.png b/doc/currency_dialog1.png
index 3f0e2719b..d4241017e 100644
Binary files a/doc/currency_dialog1.png and b/doc/currency_dialog1.png differ
diff --git a/doc/currency_editor.png b/doc/currency_editor.png
new file mode 100644
index 000000000..6f3e5bbee
Binary files /dev/null and b/doc/currency_editor.png differ
diff --git a/doc/details-currencies.docbook b/doc/details-currencies.docbook
index 8621ea698..3a3e7e5bf 100644
--- a/doc/details-currencies.docbook
+++ b/doc/details-currencies.docbook
@@ -6,7 +6,7 @@
<author>&Michael.Carpino; &Michael.Carpino.mail;</author>
<author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2023-09-20</date>
+ <date>2023-09-30</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
@@ -61,13 +61,13 @@
<para>
For a newly created data file, the Currencies dialog will show only the currency
you chose as the default currency. If you want to use a different currency for a
- new account, you must first add that currenc. By clicking the
+ new account, you must first add that currency. By clicking the
<guibutton>Add</guibutton> button, you will be presented with the same list of
currencies from which you chose the default currency. You can either scroll
- through the list, or use the search box at the top to find the currency you wish to
+ through the list or use the search box at the top to find the currency you wish to
use. Click on that currency, and click <guibutton>OK</guibutton>. The Currencies
- dialog will then include that currency in the list displayed, and you can now use
- that currency when creating a new account.
+ dialog will then include that currency in the list displayed, and you can now
+ select that currency when creating a new account.
</para>
</sect2>
@@ -105,15 +105,14 @@
</para>
<para>
- Replace with the currency editor
<screenshot>
<screeninfo>The Currency editor</screeninfo>
<mediaobject>
<imageobject>
- <imagedata fileref="select_currency.png" format="PNG" />
+ <imagedata fileref="currency_editor.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>add new currency or edit currency dedtails</phrase>
+ <phrase>add new currency or edit currency details</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -123,25 +122,66 @@
The Currency editor has some similarities to the dialog for editing details of securities
</para>
-<para>
- Enter the official ISO code for the currency and click <guilabel>OK</guilabel>. The
- currency will be created with the name <quote>New Currency</quote>. To change the
- name, either press <keycap>F2</keycap> or right-click and select
- <guimenuitem>Rename currency</guimenuitem>.
-</para>
-</sect2>
-</sect1>
+<itemizedlist>
+ <listitem>
+ <para>
+ ISO Code: the <ulink
+ url="https://www.iso.org/iso-4217-currency-codes.html">official alpha
+ code</ulink> for the currency. ISO also specified a numeric code, but this is
+ not used in &kmymoney;.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Name: the full name of the currency.
+ </para>
+ </listitem>
-<sect1 id="details.currencies.accountsetup">
-<title>Account setup</title>
+ <listitem>
+ <para>
+ Symbol: the graphic symbol that represents the currency, such as $ for United
+ States Dollar (USD) or € for the Euro (EUR.) In some cases, the symbol can
+ only be specified in a particular character set that includes the appropriate
+ glyph.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Smallest account unit: the smallest officially supported unit of the currency.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Smallest cash unit: the smallest unit for which there is actually a bill or
+ coin.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Rounding method: this dropdown provides a list of possible rules for rounding
+ amounts calculated with more precision than allowed by the smallest account
+ unit.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Price precision: the number of digits or decimal places to be used for
+ recording values in the currency.
+ </para>
+ </listitem>
+</itemizedlist>
<para>
- When you create a new account, you specify the currency in which it will be
- managed. The New Account wizard defaults this setting to the <link
- linkend="details.currencies.basecurrency">base currency</link>. If you
- require a different currency, you need to select it during this initial setup.
- The ledger for the account will then show all values in the selected currency.
+ Enter the information and click <guilabel>OK</guilabel>, and the currency will be
+ created.
</para>
+
+</sect2>
</sect1>
<sect1 id="details.currencies.transactions">
@@ -149,16 +189,16 @@
<para>
Whenever a transaction is entered that refers to more than one currency, the
- exchange rate editor pops up and allows you to enter an exchange
- rate. Initially, the current price available from the price database will be
- used as exchange rate. See <link linkend="details.currencies.prices">Entering
- exchange rates for currencies</link> for more information on how to provide
- exchange rates manually and obtain online price information.
+ exchange rate editor pops up and allows you to enter an exchange rate. Initially,
+ the most recent price available from the price database will be used as the
+ exchange rate. See <link linkend="details.currencies.prices">Entering exchange
+ rates for currencies</link> for more information on how to provide exchange rates
+ manually and obtain online price information.
</para>
<para>
- Optionally, the exchange rate is saved in the price database once entered by
- the user.
+ Optionally, the exchange rate is saved in the price database once entered by the
+ user.
</para>
</sect1>
@@ -169,51 +209,89 @@
<title>Entering prices manually</title>
<para>
- The price database editor allows you to enter exchange rates between
- currencies or prices for investments. You can pull it up using the
+ The <guilabel>Price Editor</guilabel>, also called the price database editor,
+ allows you to enter or modify prices for both investments and exchange rates
+ between currencies. You can pull it up using the
<menuchoice><guimenu>Tools</guimenu><guimenuitem>Prices...</guimenuitem></menuchoice>
menu item.
</para>
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <screeninfo>Currency Price Editor</screeninfo>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="currency_priceeditor.png" format="PNG" />
- </imageobject>
- <textobject>
+ </imageobject>
+ <textobject>
<phrase>Currency Price Editor</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+ </textobject>
+ </mediaobject>
+ </screenshot>
</para>
<para>
- In &kmymoney; a <quote>Price</quote> is the price of one currency in terms of
- a second currency. For example, as I write this, the price of 1 USD in terms
- of 1 EUR is 0.83; that is, 1 USD costs 0.83 EUR. The first currency is the
- one being bought or sold, and the second one is the currency used to buy or
- sell it.
+ The first column in the dialog is labelled <guilabel>Commodidty</guilabel>, which
+ displays both trading symbols of securites and the symbols of currencies. In
+ &kmymoney;, a <quote>Price</quote> is the price of security in terms of a currency,
+ or of a currency in terms of a second currency. For example, as I write this, the
+ price of 1 USD in terms of 1 EUR is 0.94; that is, 1 USD costs 0.94 EUR. The first
+ currency is the one being bought or sold, and the second one is the currency used
+ to buy or sell it.
</para>
<para>
- When you press the <guibutton>New</guibutton> button, you get the New Price
- Entry dialog. Enter the first currency (USD in the example above) in the
- Security field. Enter the second currency (EUR in the example above) in the
- Currency field. Enter the effective date of the price in the Date field.
+ To manually enter a new exchange rate, press the <guibutton>New</guibutton> button,
+ and you get the New Price Entry dialog.
</para>
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <screeninfo>New Price Entry</screeninfo>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="currency_newpriceentry.png" format="PNG" />
- </imageobject>
- <textobject>
+ </imageobject>
+ <textobject>
<phrase>New Price Entry</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+</para>
+
+<para>
+ Enter the first currency (USD in the example above) in the Security field.
+ Enter the second currency (EUR in the example above) in the Currency field. Enter
+ the effective date of the price in the Date field.
+</para>
+
+<para>
+ Press the <guilabel>OK</guilabel> button, and you will then see the
+ <guilabel>Exchange Rate/Price Editor</guilabel> dialog.
+</para>
+
+<para>
+ <screenshot>
+ <screeninfo>Exchange Rate/Price Editor</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="exchange_rate_editor.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Exchange Rate/Price Editor</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+</para>
+
+<para>
+ You can specify a price in two ways. You can enter the <guilabel>To
+ amount</guilabel> or total price of the first currency in terms of the second, or
+ you can enter the actual Exchange rate. In this case, since you are entering the
+ number of EUR for 1 USD, those two values are the same. However, this is the same
+ dialog used to enter an exchage rate when you enter a transaction which involves
+ two currencies. In that case, you will generally enter the amount, and let
+ &kmymoney; calculate the exachange rate, taking care of any rounding.
</para>
</sect2>
@@ -221,7 +299,7 @@
<title>Online currency updates</title>
<para>
- &kmymoney; will fetch currency conversions from the web. Once you have
+ &kmymoney; can fetch currency conversion rates from the web. Once you have
entered a single price for a pair of currencies, the online quote feature will
always list that pair amongst its options.
</para>
diff --git a/doc/details-impexp.docbook b/doc/details-impexp.docbook
index 992686e66..3303f82cf 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>2023-10-05</date>
+ <releaseinfo>5.2</releaseinfo>
</chapterinfo>
<title>Importing and Exporting</title>
@@ -13,6 +14,7 @@
<sect1 id="details.impexp.gnucash">
<sect1info>
<author>&Tony.Bloomfield; &Tony.Bloomfield.mail;</author>
+ <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</sect1info>
<title>&gnucash; Importer</title>
@@ -21,45 +23,43 @@
<title>&gnucash; Files</title>
<para>
- The &kmymoney; &gnucash; importer handles direct
- reading of standard (&XML;) files as produced by &gnucash;
- versions 1.8 and 2.0. The following are not supported:
+ The &kmymoney; &gnucash; importer handles direct reading of standard (&XML;) files
+ as produced by &gnucash; versions 1.8 and 2.0. File from more recent versions
+ should also be imported without problem, but there is no recent testing to confirm
+ this. Specifically, however, the following are not supported:
</para>
<itemizedlist>
<listitem><para>import of database (Postgres) data</para></listitem>
<listitem><para>import of 'multi-book' files</para></listitem>
<listitem><para>import into an existing &kmymoney; file</para></listitem>
- <listitem><para>import of small-business specific features (Employees,
- Invoices, &etc;)</para></listitem>
+ <listitem><para>import of small-business specific features (Employees, Invoices,
+ &etc;)</para></listitem>
<listitem><para>export to &gnucash; files.</para></listitem>
</itemizedlist>
<para>
- The import will probably only work correctly if presented with a valid file.
- It is recommended that the <menuchoice><guimenu>Actions</guimenu><guimenuitem>Check
- & Repair All</guimenuitem></menuchoice> menu item of &gnucash; be run
- before attempting to import.
+ The import will probably only work correctly if presented with a valid file. It is
+ recommended that the <menuchoice><guimenu>Actions</guimenu><guimenuitem>Check &
+ Repair All</guimenuitem></menuchoice> menu item of &gnucash; be run before saving
+ the file and attempting to import into &kmymoney;.
</para>
<para>
Files can be opened by specifying the filename on the command line
(<command>kmymoney <path to file></command>), or by means of the &kmymoney;
- <menuchoice>
- <shortcut><keycombo>&Ctrl;<keycap>O</keycap></keycombo></shortcut>
- <guimenu>File</guimenu><guimenuitem>Open</guimenuitem>
- </menuchoice> or
- <menuchoice>
- <guimenu>File</guimenu><guisubmenu>Import</guisubmenu>
+ <menuchoice> <shortcut> <keycombo>&Ctrl;<keycap>O</keycap> </keycombo> </shortcut>
+ <guimenu>File</guimenu><guimenuitem>Open</guimenuitem> </menuchoice> or
+ <menuchoice> <guimenu>File</guimenu> <guisubmenu>Import</guisubmenu>
</menuchoice> menu items.
</para>
<para>
The similarity between the two products means that much day-to-day data can be
- imported in a straightforward fashion. However, there are some areas where
- differences arise, and various options are provided to deal with these. The
+ imported in a straightforward fashion. However, there are some areas where there
+ are differences, and various options are provided to deal with these. The
following sections will describe some of these differences; understanding them
- should lead to a smoother importation.
+ should lead to a smoother import, where any of them are relevant to your data.
</para>
</sect2>
@@ -86,15 +86,14 @@
<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, ⪚,
- 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
- on your point of view) between account types than does &gnucash;, and the
- importer will correct any inconsistencies it detects. This may result in a
- slightly different account structure, though this can, within reason, be
- amended after the import is complete.
+ account. &kmymoney; supports 5 main types of account: 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 on your point of view)
+ between account types than does &gnucash;, and the importer will correct any
+ inconsistencies it detects. This may result in a slightly different account
+ structure, though this can, within reason, be amended after the import is complete.
</para>
</sect4>
@@ -103,9 +102,10 @@
<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
- during transaction entry into other account types.
+ type. Unlike &gnucash;, these are not considered as <quote>ledger</quote>
+ accounts, and entry of transactions directly into categories is not supported.
+ Allocations are made during transaction entry into other account types.
+<!-- FIXME: can anyone explain what this last sentence means? -->
</para>
</sect4>
@@ -114,11 +114,11 @@
<para>
&gnucash; supports the use of Placeholder accounts. In effect, these are just
- 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
- provide a parent/child account relationship, so the importer simulates
- placeholders by creating empty accounts.
+ 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 provide
+ a parent/child account relationship, so the importer simulates placeholders by
+ creating empty accounts.
</para>
</sect4>
@@ -194,13 +194,13 @@
<title>Balanced transactions</title>
<para>
- As with &gnucash;, data is entered in the form of transactions, each generally
- consisting of 2 or more split entries. In fact, valid &gnucash; transactions
- will always contain at least 2 splits, and to conform to &gnucash;'s
- double-entry bookkeeping standard, these must be in monetary balance (&ie;,
- they must balance out to zero). &kmymoney; encourages, but does not enforce,
- this standard, but any imported transaction which is not balanced will be
- marked in the ledger view as having a problem.
+ In both programs, data is entered in the form of transactions, each generally
+ consisting of 2 or more split entries. In fact, valid &gnucash; transactions will
+ always contain at least 2 splits, and to conform to &gnucash;'s double-entry
+ bookkeeping standard, these must be in monetary balance (&ie;, they must balance
+ out to zero). &kmymoney; encourages, but does not enforce, this standard, but any
+ imported transaction which is not balanced will be marked in the ledger view as
+ having a problem.
</para>
</sect4>
@@ -209,9 +209,9 @@
<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
- &gnucash; transaction's Description field.
+ encompasses both payees and payers,) and unlike &gnucash;, it maintains a list of
+ these payees. Payee names are generated by the importer from the &gnucash;
+ transaction's Description field.
</para>
</sect4>
@@ -221,7 +221,7 @@
<para>
&kmymoney; uses the term Transfer to describe a transaction which does not
involve a Category, but only transfers money between Asset and/or Liability
- accounts.
+ accounts. <!-- FIXME: what does this have to do with gnucash? -->
</para>
</sect4>
@@ -239,53 +239,55 @@
<title>Commodities</title>
<para>
- &gnucash; uses the term Commodity to cover both currencies and non-currency
- assets. These are treated separately in &kmymoney;.
+ &gnucash; uses the term Commodity to cover both currencies and non-currency assets.
+ These are treated separately in &kmymoney;.
</para>
<sect4>
<title>Currencies</title>
<para>
- &kmymoney; has built-in support for all foreign
- <link linkend="details.currencies">currency</link> types. &kmymoney; also
- requires that the user specify a base currency, this being the default
- currency for new accounts. The importer will attempt to determine the most
- likely base currency, though this choice may be rejected in favor of an
- alternative.
+ &kmymoney; has built-in support for all foreign <link
+ linkend="details.currencies">currency</link> types. &kmymoney; also requires that
+ the user specify a base currency, this being the default currency for new accounts.
+ The importer will attempt to determine the most likely base currency, though this
+ choice may be rejected in favor of an alternative.
</para>
-<note><para>
- &kmymoney; does not currently support accounts denominated in 'defunct'
- currencies (except those replaced by the Euro). At present, it will be
- necessary to remove any such accounts from your &gnucash; file before
- importing. We hope to improve on this situation in a future release.
-</para></note>
+<note>
+ <para>
+ &kmymoney; does not currently support accounts denominated in 'defunct'
+ currencies (except those replaced by the Euro.) At present, it will be necessary
+ to remove any such accounts from your &gnucash; file before importing. We hope
+ to improve on this situation in a future release.
+ <!-- FIXME: is this still true? -->
+ </para>
+</note>
</sect4>
<sect4 id="gncsecurities">
<title>Securities and Investments</title>
<para>
- Non-currency assets (normally stocks and bonds) are called Securities by
- &kmymoney;, and represent the main difference between the two products, in
- that &kmymoney; requires any account denominated in a security to be
- subordinate to an Investment Account. This is described in more detail in the
- chapter on <link linkend="details.investments">Investments</link>. Though
- users may have implemented such a relationship, &gnucash; imposes no defined
- structure on it, so the importer is unable to detect it and perform an
- automatic conversion. Three options are therefore made available:
+ Non-currency assets (typically stocks and bonds) are called Securities by
+ &kmymoney;, and represent the main difference between the two products, in that
+ &kmymoney; requires any account denominated in a security to be subordinate to an
+ Investment Account. This is described in more detail in the chapter on <link
+ linkend="details.investments">Investments</link>. Though users may have
+ implemented such a relationship, &gnucash; imposes no defined structure on it, so
+ the importer is unable to detect it and perform an automatic conversion. Three
+ options are therefore made available:
</para>
<itemizedlist>
<listitem>
- <para>Create a separate Investment account for each security, with the same
- name as the security</para>
+ <para>Create a separate Investment account for each security, with the same name
+ as the security</para>
</listitem>
<listitem>
- <para>Create a single Investment account which will act as 'parent' for all
- security accounts</para>
+ <para>Create a single Investment account which will act as <quote>parent</quote>
+ for all security accounts</para>
</listitem>
<listitem>
@@ -295,9 +297,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.
+ It depends entirely on user requirements and preference which of these options is
+ relevant in each situation. In some cases, manual restructuring of accounts after
+ import may be necessary.
</para>
</sect4>
@@ -305,8 +307,8 @@
<title>Prices and currency rates</title>
<para>
- Security prices and currency exchange rates as displayed in the &gnucash; Price
- Editor will be imported. In addition, price and rate entries will be generated
+ Security prices and currency exchange rates, as displayed in the &gnucash; Price
+ Editor, will be imported. In addition, price and rate entries will be generated
from all transactions involving securities and multiple currencies.
</para>
</sect4>
@@ -315,32 +317,33 @@
<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;
- 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
- <link linkend="details.investments.onlinequotes">online quotes</link>.
+ For obtaining online price and currency rate quotations, &gnucash; uses a Perl
+ based package called <literal>Finance::Quote</literal>. Recent versions of
+ &kmymoney; contain support for this package for obtaining stock quotes, and this
+ will be used by default when importing data from &gnucash;. You may however select
+ to convert to the native method used by &kmymoney; which is covered in more detail
+ in the section on <link linkend="details.investments.onlinequotes">online
+ quotes</link>.
</para>
<para>
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
- 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.
+ <quote>native</quote> &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 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.
</para>
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="gnucash-select_price_source.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
</para>
</sect4>
</sect3>
@@ -350,20 +353,20 @@
<para>
&kmymoney; does not retain the separation made in &gnucash; between template
- transactions and their frequency of occurrence. Transaction data will be
- duplicated if the same template is used in different schedules, but this is
- not likely to be of great significance.
+ transactions and their frequency of occurrence. Transaction data will be
+ duplicated if the same template is used in different schedules, but this is not
+ likely to be of great significance.
</para>
<sect4>
<title>Schedule types</title>
<para>
- &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,
- and these will need manual correction.
+ &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, and these will need
+ manual correction.
</para>
</sect4>
@@ -371,34 +374,34 @@
<title>Suspect Schedules</title>
<para>
- Some features of &gnucash; scheduled transactions are not available in
- &kmymoney;, so the importer tries in each case to reach a reasonable
- compromise in converting the data. These transactions will be flagged as
- suspect, and the user will be given the option of editing them directly during
- the import process. Examples of situations which may cause this are:
+ Some features of &gnucash; scheduled transactions are not available in &kmymoney;,
+ so the importer tries in each case to reach a reasonable compromise in converting
+ the data. These transactions will be flagged as suspect, and the user will be
+ given the option of editing them directly during the import process. Examples of
+ situations which may cause this are:
</para>
<itemizedlist>
<listitem>
- <para>some frequency intervals supported in &gnucash; are not currently
- available in &kmymoney;</para>
+ <para>some frequency intervals supported in &gnucash; are not currently available
+ in &kmymoney;</para>
</listitem>
<listitem>
- <para>&kmymoney; does not support the use of formulae and variables in
- amount fields</para>
+ <para>&kmymoney; does not support the use of formulae and variables in amount
+ fields</para>
</listitem>
<listitem>
- <para>complex cases which have not yet been identified for import.</para>
+ <para>complex cases which have not yet been identified for import</para>
</listitem>
</itemizedlist>
<para>
Despite best efforts, it is possible that, due to the many options involved, a
- scheduled transaction may cause a fatal error within &kmymoney;. If this sort
- of problem seems to be occurring, the importer offers the option to drop all
- suspect schedules.
+ scheduled transaction may cause a fatal error within &kmymoney;. If this sort of
+ problem seems to be occurring, the importer offers the option to drop all suspect
+ schedules.
</para>
</sect4>
</sect3>
@@ -407,10 +410,9 @@
<title>Reports</title>
<para>
- &kmymoney; provides a comprehensive selection of configurable reports,
- described in more detail in <link linkend="details.reports">Reports.</link>
- These will not necessarily, however, match precisely those reports available
- in &gnucash;.
+ &kmymoney; provides a comprehensive selection of configurable reports, described in
+ more detail in <link linkend="details.reports">Reports.</link> These will not
+ necessarily, however, match precisely those reports available in &gnucash;.
</para>
</sect3>
</sect2>
@@ -419,13 +421,13 @@
<title>Selecting Importer Options</title>
<para id="details.impexp.gncoptions">
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="gnucash-import_options.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
</para>
<sect3>
@@ -440,12 +442,9 @@
<title>Online Quotes</title>
<para>
- Turn this off if you wish to use the native method for future online price
- quotes.
-</para>
-
-<para>
- See <link linkend="details.impexp.gncquotes">"Online Quotes"</link> above.
+ Turn this off if you wish to use the native method for future online price quotes.
+ See <link linkend="details.impexp.gncquotes">"Online Quotes"</link> above for more
+ details.
</para>
</sect3>
@@ -461,18 +460,17 @@
<title>Decoding Options</title>
<para>
- If your native language is written in letters or symbols which are different
- from those used in the 'Latin' languages (&ie;, generally Western European),
- these are represented in a special fashion ('encoded') in your &gnucash; file.
- If these letters are not displayed correctly on your screen, then they must be
- decoded. Currently, it is often not possible to detect accurately which form
- of decoding must be used, so you may need to set this option and select an
- entry from the list. In general, the first item in the list will be that
- which is considered appropriate for your locale (&ie;, the country and
- language which was selected as native when your operating system was
- installed), so this should be tried first. Since the import process does not
- overwrite your &gnucash; file, you are free to experiment with any of these
- selections.
+ If your native language is written in letters or symbols which are different from
+ those used in the 'Latin' languages (&ie;, generally Western European,) these are
+ represented in a special fashion (<quote>encoded</quote>) in your &gnucash; file.
+ If these characters are not displayed correctly on your screen, then they must be
+ decoded. Currently, it is often not possible to detect accurately which form of
+ decoding must be used, so you may need to set this option manually by selecting an
+ entry from the list. In general, the first item in the list will be that which is
+ considered appropriate for your locale (&ie;, the country and language which was
+ selected as native when your operating system was installed,) so this should be
+ tried first. Since the import process does not overwrite your &gnucash; file, you
+ are free to experiment with any of these selections.
</para>
</sect3>
@@ -480,12 +478,12 @@
<title>Transaction Notes option</title>
<para>
- Under some usage conditions, non-split &gnucash; transactions may contain
- residual, often incorrect, memo data which is not normally visible to the
- user. When imported into &kmymoney; however, due to display differences, this
- data can become visible. Often, these transactions will have a Notes field
- describing the real purpose of the transaction. If this option is selected,
- these notes, if present, will be used to override the extraneous memo data.
+ Under some usage conditions, non-split &gnucash; transactions may contain residual,
+ often incorrect, memo data which is not normally visible to the user. When
+ imported into &kmymoney; however, due to display differences, this data can become
+ visible. Often, these transactions will have a Notes field describing the real
+ purpose of the transaction. If this option is selected, these notes, if present,
+ will be used to override the extraneous memo data.
</para>
</sect3>
@@ -494,10 +492,10 @@
<para>
These need only be used in the event of import problems. If you have such
- problems, you should also report them to the &kmymoney; developer list
- &devlist;. Note that the traces produced by these options may contain data of
- a confidential nature, and the <guilabel>Anonymize data</guilabel> option
- should be used if they are to be made publicly available.
+ problems, you should also report them to the &kmymoney; developer list &devlist;.
+ Note that the traces produced by these options may contain data of a confidential
+ nature, and the <guilabel>Anonymize data</guilabel> option should be used if they
+ are to be made publicly available.
</para>
</sect3>
</sect2>
@@ -507,9 +505,9 @@
<para>
At the end of processing, the importer produces a report showing the number of
- different entities processed, and any errors or anomalies encountered. This
- report will be displayed on screen, and may be saved to a file for later
- review. A full report may contain the following sections:
+ different entities processed, and any errors or anomalies encountered. This report
+ will be displayed on screen, and may be saved to a file for later review. A full
+ report may contain the following sections:
</para>
<itemizedlist>
@@ -527,13 +525,13 @@
</itemizedlist>
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="gnucash-report.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
</para>
</sect2>
</sect1>
@@ -541,6 +539,7 @@
<sect1 id="details.impexp.qifimp">
<sect1info>
<author>&Thomas.Baumgart; &Thomas.Baumgart.mail;</author>
+ <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</sect1info>
<title>QIF Importer</title>
@@ -549,34 +548,33 @@
<title>QIF format considered harmful</title>
<para>
- Generally speaking, the QIF format should be avoided wherever possible. It is
- a poor choice for transporting financial data. Among other things, QIF suffers
- from these problems:
+ Generally speaking, the QIF format should be avoided wherever possible. It is a
+ poor choice for transporting financial data. Among other things, QIF suffers from
+ these problems:
</para>
<itemizedlist>
<listitem>
- <para>Lack of standardized format: Different versions of the same program
- will impart different meanings to the same element.</para>
+ <para>Lack of standardized format: Different versions of the same program will
+ impart different meanings to the same element.</para>
</listitem>
<listitem>
- <para>Lack of transaction identifier: Because there is no ID number
- associated with each transaction, matching duplicate transactions is
- haphazard at best.</para>
+ <para>Lack of transaction identifier: Because there is no ID number associated
+ with each transaction, matching duplicate transactions is haphazard at
+ best.</para>
</listitem>
<listitem>
- <para>Lack of expressiveness: The grammar is really simple, and cannot
- portray the depth of financial information found in today's financial
- environment.</para>
+ <para>Lack of expressiveness: The grammar is really simple, and cannot portray
+ the depth of financial information found in today's financial environment.</para>
</listitem>
</itemizedlist>
<para>
This is generally why Intuit stopped supporting QIF input at all with
- <application>Quicken</application> 2005. If you have the option of getting
- data some other way, like OFX, always choose that option.
+ <application>Quicken</application> 2005. If you have the option of getting data
+ some other way, like OFX, always choose that option.
</para>
</sect2>
@@ -584,38 +582,39 @@
<title>How to import a QIF file</title>
<para>
- To import a QIF file, first ensure you have a valid &kmymoney; file open.
- Then select <menuchoice><guimenu>File</guimenu><guisubmenu>Import</guisubmenu>
+ To import a QIF file, first ensure you have a valid &kmymoney; file open. Then
+ select <menuchoice> <guimenu>File</guimenu> <guisubmenu>Import</guisubmenu>
<guimenuitem>QIF...</guimenuitem> </menuchoice> menu item.
</para>
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="qifopen.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
</para>
<para>
- The resulting dialog prompts for the QIF filename allowing you to locate the
- file by clicking on the <guibutton>Browse</guibutton> button.
+ The resulting dialog prompts for the QIF filename allowing you to type in the full
+ path to the file or 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
- 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.
+ Note that &kmymoney; differentiates between the import of a bank statement file and
+ a file with 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.
</para>
<para>
- In general the default QIF profile should work with your QIF data. In some
- cases it might become necessary to use a modified QIF profile. See
- the <link linkend="details.impexp.qifimp.profile">next section</link> for more
- details on that subject.
+ In general, the default QIF profile should work with your QIF data. In some cases
+ it might become necessary to use a modified QIF profile. See the <link
+ linkend="details.impexp.qifimp.profile">next section</link> for more details on
+ that subject.
</para>
<para>
@@ -623,56 +622,49 @@
</para>
<para>
- &kmymoney; will start scanning the file to determine the formats used to
- represent dates and numbers. In case it cannot determine a date format
- unambiguously, &kmymoney; will ask the user to select one from the list of
- possible date formats.
+ &kmymoney; will start scanning the file to determine the formats used to represent
+ dates and numbers. In case it cannot determine a date format unambiguously,
+ &kmymoney; will ask the user to select one from the list of possible date formats.
</para>
<para>
- Next, &kmymoney; imports the data and creates all necessary objects, such as
- payee information, accounts and category records, 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.
+ Next, &kmymoney; imports the data and creates all necessary objects, such as payee
+ information, account and category records, and stock price information. Wherever
+ possible, existing transactions will be matched against the imported information,
+ to avoid duplicate transactions. 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,
- 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>.
+ In case &kmymoney; could not 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>.
</para>
<para>
- At the end of the import, &kmymoney; shows a statement import statistics
- window.
+ At the end of the import, &kmymoney; shows a statement import statistics window.
</para>
<para>
<screenshot>
- <screeninfo>Statement statistics</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="qif_report.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Statement statistics</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>Statement statistics</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="qif_report.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Statement statistics</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</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
- imported transaction with an already existing transaction, the background is
- shown in light green.
-</para>
-
-<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.
+ background in the Ledgers View. In case &kmymoney; was able to match an imported
+ transaction with an already existing transaction, the background is shown in light
+ green.
</para>
<note>
@@ -681,14 +673,24 @@
may be different in your environment.
</para>
</note>
+
+<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.
+ <!-- FIXME: use correct link. -->
+</para>
+
</sect2>
+<!-- FIXME: confirm whether to keep or just delete this section -->
<!--
<sect2>
<title>Accepting the imported transactions</title>
+
<para>
-
- When &kmymoney; has finished importing the QIF transactions the account will be shown with the imported transactions listed in Yellow.
+ When &kmymoney; has finished importing the QIF transactions the account will
+ be shown with the imported transactions listed in Yellow.
</para>
<para>
@@ -711,8 +713,11 @@
The importer was not able to automatically assign a category based on your past transaction history.
</para>
-<para>
- Transaction data can be edited or even deleted if needed. To edit a transaction simply double-click on the entry or hit enter when the entry is highlighted. Once finished click on <guibutton>OK</guibutton> to accept the imported transactions or <guibutton>Cancel</guibutton> to remove the imported transactions.
+<para>
+ Transaction data can be edited or even deleted if needed. To edit a
+ transaction simply double-click on the entry or hit enter when the entry is
+ highlighted. Once finished click on <guibutton>OK</guibutton> to accept the imported
+ transactions or <guibutton>Cancel</guibutton> to remove the imported transactions.
</para>
</sect2>
@@ -720,8 +725,8 @@
<sect2><title>Importing Investments</title>
<para>
- Please note that if you are importing a file with investment transactions, those investments must first exist in your &kmymoney; file.
- The trading symbol is used to match, so please ensure that the symbol in &kmymoney; is exactly the same as the one in the file you're importing.
+ Please note that if you are importing a file with investment transactions, those investments must first exist in your &kmymoney; file.
+ The trading symbol is used to match, so please ensure that the symbol in &kmymoney; is exactly the same as the one in the file you're importing.
</para>
</sect2>
-->
@@ -730,34 +735,73 @@
<title>Setting up a QIF profile</title>
<para>
- 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.
+ 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, bring up the QIF Importer dialog by
+ selecting <menuchoice> <shortcut> <keycombo>&Ctrl;&Shift;<keycap>,</keycap>
+ </keycombo> </shortcut> <guimenu>Settings</guimenu> <guimenuitem>Configure
+ &kmymoney;...</guimenuitem> </menuchoice> from the main menu, clicking on
+ <guilabel>Plugins</guilabel> at the bottom of the left panel, and clicking the
+ &configicon; button on the entry for <quote>QIF Importer</quote>.
+ <!-- FIXME: do we want to use the plugins icon from that left panel here? -->
</para>
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="qifimport-qifprofileeditor.png" format="PNG" />
- </imageobject>
- <textobject>
+ </imageobject>
+ <textobject>
<phrase>QIF Profile Editor</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+</para>
+
+<para>
+ On the left, the Profile selector displays a list of all existing QIF Importer
+ Profiles, select one to edit its configuration. To create an new profile, press
+ the <guibutton>New</guibutton> button. You can rename an existing profile by
+ selecting it in the Profile selector and clicking the <guibutton>Rename</guibutton>
+ button, and delete on with the <guibutton>Delete</guibutton> button. Clicking the
+ <guibutton>Reset</guibutton> button resets all the fields to their default values.
+</para>
+
+<!-- FIXME: what do these all actually do? do we want/need separate images for each?
+ -->
+<para>
+ The right area of the dialog has four tabs.
+</para>
+
+<para>
+ The <quote>General</quote> tab contains a description and fields
+</para>
+
+<para>
+ The <quote>Filter</quote> tab allows you to specify a filter program or script to
+ be applied when this profile is chosen for import. See the following section for
+ more details.
+</para>
+
+<para>
+ The <quote>Date</quote> tab
+</para>
+
+<para>
+ The <quote>Amounts</quote> tab
</para>
<note>
<para>
Previous versions of &kmymoney; used to have a tab 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
- during import.
+ specifications. &kmymoney; now determines those settings by scanning the file. If
+ it cannot figure out the proper settings, it will interrogate the user during
+ import.
</para>
</note>
+
<!--
<para>
The most commonly changed thing between QIF implementations is the date format.
@@ -803,19 +847,18 @@
<sect2><title>Transaction matching</title>
<para>
- 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
- something that looks like the same transaction, it will match the apparent
- duplicate.
+ 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 something that looks like the same transaction, it
+ will match the apparent duplicate.
</para>
<para>
- This can be a problem if you have transactions that look too similar but are
- actually different. In this case, you can unmatch those transactions later in
- the ledger view.
+ This can be a problem if you have transactions that look very similar but are
+ actually different. In this case, you can unmatch those transactions later in the
+ ledger view.
</para>
</sect2>
@@ -823,89 +866,111 @@
<title>Writing an import filter</title>
<para>
- Sometimes you may have data in a custom format, like comma-separated-values
- (CSV) or something else unique to your situation. As of version 4.6,
- &kmymoney; includes a CSV Importer Plugin, but you can still import other
- types of files into &kmymoney; using a QIF Import Filter. A filter is a
- custom program you write which takes your special file as input, and produces
- a QIF file as output. This can be a shell script, a perl script, a compiled
- program written in C/C++, or anything else you can dream of, as long as the
- system can run it.
+ Sometimes you may have data in a custom format, like comma-separated-values (CSV)
+ or something else unique to your situation. As of version 4.6, &kmymoney; includes
+ a CSV Importer Plugin, but you can still import other types of files into
+ &kmymoney; using a QIF Import Filter. A filter is a custom program you write which
+ takes your special file as input, and produces a QIF file as output. This can be a
+ shell script, a perl script, a compiled program written in C/C++, or anything else
+ you can dream of, as long as the system can run it. The filter will be run with
+ the input file as stdin and stdout is assumed to be a valid qif file to pass on the
+ the actual QIF importer.
+</para>
+
+<para>
+ To use a filter, edit your favorite QIF Profile or create a new one, and select the
+ Filter tab. Enter the full path to your filter program in the <guilabel>Input
+ filter location</guilabel> field, or click the browse icon next to the field and
+ navigate to the filter in the <guilabel>File Open...</guilabel> dialog. Then,
+ whenever you do a QIF import using this profile, the file you select for importing
+ will be run through your filter first
</para>
<para>
- To use it, edit your favorite QIF Profile, and select the Filter tab. Enter
- the location of your filter program where prompted. Then, whenever you do a
- QIF import using this profile, the file you select for importing will be run
- through your filter first.
+ Next, if you want the <guilabel>File Open...</guilabel> dialog where you choose the
+ file to input to have a filter for your specific file type, enter a comma separated
+ list of file filters (such as <quote>*.abc,*.xyz</quote>) in the <guilabel>Input
+ filter file type</guilabel> field. With the above example, when you open a file
+ for import using this profile, you will only see files ending in abc or xyz. If
+ you leave the field empty, no name filtering will be done, and you will see all
+ files.
</para>
<para>
- A common problem is to convert a list of comma-separated-values into a QIF
- file. This is a textbook case for the <command>awk</command> tool. Create
- a script called <filename>csv2qif.awk</filename>, with the following two
- lines as contents:
+ A common problem is to convert a list of comma-separated-values into a QIF file.
+ Prior to the addition of &kmymoney;'s CSV Importer plugin, this would have been a
+ textbook case for the <command>awk</command> tool. We still use this example here,
+ just to show a sample of how the import filter process works. Create a script
+ called <filename>csv2qif.awk</filename>, with the following two lines as contents:
</para>
<programlisting>
- BEGIN { FS=","; print "!Type:Bank" }
+ BEGIN { FS=","; print "!Type:Bank" }
- { print "D"$1; print "T"$2; print "N"$3; print "P"$4; print "M"$5; print "^" }
+ { print "D"$1; print "T"$2; print "N"$3; print "P"$4; print "M"$5; print "^" }
</programlisting>
<para>
- Then, change the QIF keys (D,T,N,P,M) to match the order of your CSV data.
- Set the input filter to <userinput>awk -f csv2qif.awk</userinput>.
+ Then, change the QIF keys (D,T,N,P,M) to match the order of the columns in your CSV
+ data. Set the input filter to <userinput>awk -f csv2qif.awk</userinput>.
</para>
<para>
- Another problem sometimes arises in the encoding of QIF files. &kmymoney;
- expects files to be UTF8 encoded. If your file is encoded in something else,
- it can be useful to convert it to UTF8. For example to convert it from
- iso-8859-1, you would set the input filter to <userinput>recode
- iso-8859-1..utf-8</userinput>.
+ Another problem sometimes arises in the encoding of QIF files. &kmymoney; expects
+ files to be UTF8 encoded. If your file is encoded in something else, it can be
+ useful to convert it to UTF8. For example to convert it from iso-8859-1, you would
+ set the input filter to <userinput>recode iso-8859-1..utf-8</userinput>.
</para>
-
</sect2>
+
<sect2>
<title>Special &kmymoney; QIF extensions</title>
<para>
- As already mentioned, one of the major drawbacks of the QIF format is the lack
- of a unique identifier for each transaction. If you are writing your own QIF
- file creator (or filter, as described above), you can overcome this problem.
- &kmymoney; supports the '#' field. The importer will interpret this as a
- unique transaction ID, and disregard the record if the transaction is already
- in the system.
+ As already mentioned, one of the major drawbacks of the QIF format is the lack of a
+ unique identifier for each transaction. If you are writing your own QIF file
+ creator (or filter, as described above,) you can overcome this problem. &kmymoney;
+ supports the '#' field. The importer will interpret this as a unique transaction
+ ID, and disregard the record if the transaction is already in the system.
</para>
</sect2>
</sect1>
-<sect1 id="details.impexp.qifexp">
-<title>QIF Exporter</title>
+<sect1 id="details.impexp.qifexp"><title>QIF Exporter</title>
<para>
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
+ 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
to use.
</para>
-<note><para>
- At the moment, QIF Exporter does not handle export of investments.
-</para></note>
+<note>
+ <para>The QIF Exporter does not handle export of investment accounts. It may
+ appear to work, and will produce an output file, but that file will not include any
+ actual data.</para>
+</note>
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="qifimport-export.png" format="PNG" />
- </imageobject>
- <textobject>
+ </imageobject>
+ <textobject>
<phrase>QIF Export</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+</para>
+
+<para>
+ The QIF Exporter uses QIF Profiles in a similar way as the QIF Importer, but it
+ uses the information in the Profile for format the QIF file being written, rather
+ than to interpret the file being read. Parallel to the importer, you can use a
+ custom written filter program. There is a separate field on the Filter Tab of the
+ QIF Profile editor for an output filter, so you can use the same QIF Profile for
+ both importing and exporting, but use a separate filter for the two processes.
</para>
</sect1>
@@ -913,6 +978,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>
diff --git a/doc/details-investments.docbook b/doc/details-investments.docbook
index 2a7d379fb..c0a986924 100644
--- a/doc/details-investments.docbook
+++ b/doc/details-investments.docbook
@@ -111,7 +111,7 @@
<screeninfo>account view</screeninfo>
<mediaobject>
<imageobject>
- <imagedata fileref="investments_view_equites.png" format="PNG" />
+ <imagedata fileref="investments_view_equities.png" format="PNG" />
</imageobject>
<textobject>
<phrase>account view</phrase>
diff --git a/doc/details-reconciliation.docbook b/doc/details-reconciliation.docbook
index 1432104a1..58cf9e0f6 100644
--- a/doc/details-reconciliation.docbook
+++ b/doc/details-reconciliation.docbook
@@ -3,9 +3,10 @@
<chapterinfo>
<authorgroup>
<author> &Michael.T.Edwardes; &Michael.T.Edwardes.mail; </author>
+ <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2010-07-21</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2023-09-30</date>
+ <releaseinfo>5.2</releaseinfo>
</chapterinfo>
<title>Reconciliation</title>
@@ -14,68 +15,119 @@
<title>What is reconciliation?</title>
<para>
- Reconciliation is the process of matching the transactions you have entered
- into &kmymoney; with the transactions listed for that account by the
- institution. This is most commonly done with the list of transactions in a
- statement, be it a bank statement, credit card statement, loan statement, or
- any other statement. It can also be done against an on-line listing of the
- account, although this is less common. If any discrepancies are found, then
+ Reconciliation is the process of assuring that your records for an account agree
+ with the records of the institution for that account. This is done by matching the
+ transactions you have entered into &kmymoney; with the transactions listed for that
+ account by the institution. This is most commonly done with the list of
+ transactions in a statement, be it a bank statement, credit card statement, loan
+ statement, or any other statement. It can also be done against an on-line listing
+ of the account, although this is less common. If any discrepancies are found, then
either you or the person who created the statement have made a mistake.
</para>
<para>
- To reconcile an account, choose your account from the drop down box and click
- on the <guiicon><inlinemediaobject><imageobject><imagedata fileref="reconcile.png"
- format="PNG"/></imageobject></inlinemediaobject></guiicon> reconcile icon, select
- the <menuchoice><guimenu>Account</guimenu> <guimenuitem>Reconcile...</guimenuitem>
- </menuchoice> menu item or use the <keycombo>&Ctrl;&Shift;<keycap>R</keycap></keycombo>
- shortcut.
+ Completing the reconciliation process for an account says that you are sure that
+ the the records for that account, up to the date of the reconciliation, are
+ correct. This is most commonly done for accounts at institutions like banks or
+ stores, but some users choose do to this for other accounts, such as cash. In that
+ case, it means that you are sure of the records up to the reconciliation date, and
+ are certain you will not find any further cash receits, and that the balance of the
+ account in &kmymoney; is the same as the actual amount of cash in your pocket.
+</para>
+
+<para>
+ Reconciliation is not required for any account, but by reconciling an account on a
+ routine bases, such as monthly, you will have fewer records to examine if you do
+ find a discrepancy.
</para>
</sect1>
<sect1 id="details.reconcile.wizard">
<title>The reconciliation wizard</title>
<para>
- This will open the reconciliation wizard. The first page of the wizard
- briefly describes the process you will follow. Click
- on <guibutton>Next</guibutton> to actually start the wizard.
+ Note that as you progress through the reconciliation process, there are multiple
+ possible paths for entering all the necessary data, especially if you need to find
+ and correct some discrepancy between &kmymoney; and the statement. All are valid,
+ and on is not any better than another. Over time, as with many activities within
+ &kmymoney; you will find the way that best meets your needs and approach to
+ managing your finances.
+</para>
+
+<para>
+ To reconcile an account, select the account in the Accounts or Institutions Veiw,
+ or display it in the register, then click on the
+ <guiicon><inlinemediaobject><imageobject><imagedata fileref="reconcile.png"
+ format="PNG"/></imageobject></inlinemediaobject></guiicon> reconcile icon, select
+ the <menuchoice><guimenu>Account</guimenu> <guimenuitem>Reconcile...</guimenuitem>
+ </menuchoice> menu item, or use the
+ <keycombo>&Ctrl;&Shift;<keycap>R</keycap></keycombo> shortcut.
+</para>
+
+<para>
+ This will open the reconciliation wizard. The first page of the wizard briefly
+ describes the process you will follow. Click on <guibutton>Next</guibutton> to
+ actually start the wizard.
</para>
<para>
<screenshot>
- <screeninfo>Reconciliation wizard</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="reconcile1.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Reconciliation wizard</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>Reconciliation wizard</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reconcile1.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Reconciliation wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
<sect2 id="details.reconcile.wizard.statement">
<title>Statement details</title>
+<para>
+ The initial statement date presented by &kmymoney; is typically 30 days after the
+ more recent reconcilion for that account. The starting balance presented is the
+ final balance as of the previous reconciliation. This is actually calculated as
+ the sum of the amounts of all transactions in the account which are cleared or
+ reconciled, up to the date of the previous reconciliation. The ending balance
+ presented is the starting balance plus the amounts (added for deposits and
+ subracted for withdrawals) for all cleared transactions for the account since the
+ previous reconciliation. (This also includes cleared transactions prior to the
+ date of the previous reconciliation.) If the starting balance does not match the
+ statement, then you need to confirm that the previous reconciliation was done
+ correctly.
+</para>
+
+<para>
+ Theoretiaclly, the ending balance at the time of the previous reconciliation should
+ not be different from the starting balance at this time. However, &kmymoney; does
+ not prevent you from making changes to transactions prior to the most recent
+ reconciliation. Edits of this type are the usual cause of such discrepancies. At
+ some point, &kmymoney; will probably be enhanced to make it much more obvious to
+ the user if such an edit is made.
+</para>
+
<para>
The statement date, starting balance, and ending balance can be found in your
- statement. Make sure that the figures match and click on
- the <guibutton>Next</guibutton> button. If the figures do not match then
- enter the figures as listed on your statement and click on
- the <guibutton>Next</guibutton> button.
+ statement. Make sure that the figures match and click on the
+ <guibutton>Next</guibutton> button. If the starting balanc does not match, see the
+ previous paragraphs. If the statement date or ending balance does not match then
+ enter the figures as listed on your statement and click on the
+ <guibutton>Next</guibutton> button.
</para>
<para>
<screenshot>
- <screeninfo>Reconciliation wizard</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="reconcile2.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Reconciliation wizard</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>Reconciliation wizard</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reconcile2.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Reconciliation wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
</sect2>
@@ -83,39 +135,45 @@
<sect2 id="details.reconcile.wizard.interest">
<title>Interest</title>
<para>
- If the statement reconciliation is on a bank account or any account with
- interest and/or charges fees, then enter these values in the appropriate
- fields. A category can be assigned for each of these amounts.
+ If you are reconciling a bank account or any account with interest and/or charges
+ or fees, then enter these values in the appropriate fields. Both fields are
+ optional, but if they are used, then a category must be assigned for each amount
+ entered. Note that these amounts may have already been entered if you import
+ transactions either directly or via a downloaded file, in which case you should not
+ enter them again here, or you will have duplicate transaction.
</para>
<note>
<para>
- The interest field is for interest you gained. If you have to pay interest,
- ⪚, for a credit card account, this has to be entered as a charge.
+ The interest field is for interest you gained. If you have to pay interest, ⪚,
+ for a credit card account, this has to be entered as a charge.
</para>
</note>
<para>
<screenshot>
- <screeninfo>Reconciliation wizard</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="reconcile3.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Reconciliation wizard</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>Reconciliation wizard</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reconcile3.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Reconciliation wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
<para>
- Click on <guibutton>Continue</guibutton> to start matching your statement to
- what you have entered. Note that this completes the Reconciliation Wizard,
- but not the process of reconciliation. It also changes the ledger display by
- only showing transactions that have not already been marked as reconciled. As
- described below, you still need to clear transactions and then tell &kmymoney;
- that the account is reconciled.
+ Click on <guibutton>Continue</guibutton> to start matching your statement to what
+ you have entered. Note that this completes the Reconciliation Wizard, but not the
+ process of reconciliation. At this point, &kmymoney; displays the Ledgers View for
+ this account, but it changes the ledger display in two ways. First, it only shows
+ transactions that have not already been marked as reconciled. Second, the line
+ below the main ledger display shows the Ending Balance from the statement on the
+ left, the cleared balance of the account in the center, and the difference between
+ then on the right. As described below, you still need to clear transactions and
+ then tell &kmymoney; that the account is reconciled.
</para>
</sect2>
@@ -123,36 +181,41 @@
<title>Clearing transactions</title>
<para>
During the reconciliation, any transaction can be edited to make it match the
- statement, and new transactions can be created as usual. To mark a
- transaction as cleared, click on the <guilabel>C</guilabel> column in the list
- view. A transaction is cleared when it matches the transaction on your
- statement.
+ statement, and new transactions can be created as usual. To mark a transaction as
+ cleared, click on the <guilabel>C</guilabel> column of the transaction in the
+ ledger. You can also
+ select the <menuchoice><guimenu>Transactions</guimenu></menuchoice> menu
+ or right-click on the transaction to bring up the "Transaction options" contxt menu,
+ and then select <menuchoice> <shortcut> <keycombo> <keysym>&Ctrl;</keysym>
+ <keysym>&Alt;</keysym> <keysym>&Space;</keysym> </keycombo></shortcut>
+ <guisubmenu>Mark transaction as...</guisubmenu> <guimenuitem>Cleared</guimenuitem>
+ </menuchoice>; A transaction is considered cleared when it matches the transaction
+ on your statement.
</para>
<para>
- The command frame (just below the transaction list area) displays the
- statement amount on the left, the cleared amount in the center, and the
- difference on the right. As you mark transactions cleared, these values
- update to show the change.
+ As you mark transactions as cleared, the Cleared and Difference amounts shown below
+ the ledger will be updated.
</para>
<para>
- Note, however, that as reconciliation is the process of matching the data in
- your account with that on a statement, changes to any transaction with dates
- after the statement date you entered in the wizard will be saved, but will not
- have any effect on the cleared amount shown in the command frame.
+ Note, however, that as reconciliation is the process of matching the data in your
+ account with that on a statement, the Cleared amount shown below the ledger is the
+ cleared amount as of the date of the statement. Changes to any transaction with a
+ date after the statement date you entered in the wizard will be saved, but will not
+ have any effect on the cleared amount shown below the ledger display.
</para>
<screenshot>
- <screeninfo>Reconciliation wizard</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="reconcile4.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Reconciliation wizard</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>Reconciliation wizard</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reconcile4.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Reconciliation wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</sect2>
@@ -162,56 +225,56 @@
<sect3 id="details.reconcile.finish">
<title>Finishing Reconciliation</title>
<para>
- When the difference between the statement and the cleared balance is zero then
- the account is reconciled and you can click the <guibutton>Finish</guibutton>
- button. When you do this, &kmymoney; takes all the transactions which have
- been marked as cleared and marks them as reconciled, and the value in the
- <guilabel>C</guilabel> column changes from <quote>C</quote> to
- <quote>R</quote> to reflect the change. In addition, it saves the changes and
- records that the account has been reconciled. (You still need to save the file
- to permanently save all the changes.)
+ When the difference between the statement and the cleared balance is zero, then the
+ account is reconciled and you can click the <guibutton>Finish</guibutton> button.
+ When you do this, &kmymoney; takes all the transactions which have been marked as
+ cleared (only those with a date before the statement date) and marks them as
+ reconciled, and the value in the <guilabel>C</guilabel> column changes from
+ <quote>C</quote> to <quote>R</quote> to reflect the change. In addition, it saves
+ the changes and records that the account has been reconciled. (You still need to
+ save the file to permanently save all the changes.)
</para>
</sect3>
+<!-- FIXME: talk about the reconciliation report -->
+
<sect3 id="details.reconcile.postpone">
<title>Postponing Reconciliation</title>
<para>
If you're having trouble completing the reconciliation, or you need to gather
- some additional information before you can complete the process, you can
- postpone the process to a later time by clicking on the
- <guibutton>Postpone</guibutton> button. When you do this, &kmymoney; remembers
- the values you entered when you started the wizard, it does not mark cleared
- transactions as reconciled, and it returns the ledger to its normal view. If
- you exit &kmymoney; before clicking either <guibutton>Finish</guibutton> or
- <guibutton>Postpone</guibutton>, it has the same effect as clicking
- <guibutton>Postpone</guibutton>. Any edits you have made, such as marking
- transactions cleared or entering new transactions, are not touched, and you
- can still save them before you exit &kmymoney;. However, you will have to run
+ additional information before you can complete the process, you can postpone the
+ process to a later time by clicking on the <guibutton>Postpone</guibutton> button.
+ When you do this, &kmymoney; remembers the values you entered when you started the
+ wizard, it does not mark cleared transactions as reconciled, and it returns the
+ ledger to its normal view. If you exit &kmymoney; before clicking either
+ <guibutton>Finish</guibutton> or <guibutton>Postpone</guibutton>, it has the same
+ effect as clicking <guibutton>Postpone</guibutton>. Any edits you have made, such
+ as marking transactions cleared or entering new transactions, are not touched, and
+ you can still save them before you exit &kmymoney;. However, you will have to run
the reconciliation wizard again in order to reconcile the account.
</para>
<para>
- When you run the reconciliation wizard on this account the next time,
- &kmymoney; remembers the values you entered when you previously ran the
- wizard, and you will be able to change them, if necessary. In this case, the
- initial screen of the wizard is different, to remind you of this.
+ If you do click <guilabel>Postpone</guilabel>, When you run the reconciliation
+ wizard on this account the next time, &kmymoney; remembers the values you entered
+ when you previously ran the wizard, and you will be able to change them, if
+ necessary. In this case, the initial screen of the wizard is different, to remind
+ you of this.
</para>
<screenshot>
- <screeninfo>Reconciliation wizard</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="reconcile-redo.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Reconciliation wizard</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>Reconciliation wizard</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reconcile-redo.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Reconciliation wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</sect3>
</sect2>
</sect1>
-
</chapter>
-
diff --git a/doc/details-reports.docbook b/doc/details-reports.docbook
index 9cb90e376..243a97303 100644
--- a/doc/details-reports.docbook
+++ b/doc/details-reports.docbook
@@ -3,103 +3,111 @@
<chapterinfo>
<authorgroup>
<author> &Ace.Jones; &Ace.Jones.mail; </author>
+ <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2010-07-25</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2023-10-02</date>
+ <releaseinfo>5.2</releaseinfo>
</chapterinfo>
<title>Reports</title>
-<sect1 id="details.reports.avail">
-<title>Available Reports</title>
+<sect1 id="details.reports.avail"><title>Available Reports</title>
<para>
<screenshot>
- <screeninfo>Reports View</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="reports_view-all.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Reports View</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>Reports View</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reports_view_list.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Reports View</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
<para>
- The Reports View lists all available reports, grouped under the following
- headings.
+ The <guilabel>Reports></guilabel> tab of the Reports View lists all available
+ reports, grouped under the following headings. You can click on the
+ <quote>></quote> to expand or collapse the specific reports under each heading.
+ When you open any report, it is displayed in an additional tab, labelled with the
+ name of that report.
</para>
-<sect2>
-<title>Income and Expenses</title>
+<sect2><title>Income and Expenses</title>
<para>
- The reports in this section show your income and expenses either for the
- current month or for each month in the current year. Of course, the duration
- of the overall report and the duration captured by each column can be
- configured to your liking. Graphs and Pie Charts also may be produced.
+ The reports in this section show your income and expenses either for the current
+ month, for each month in the current year, or for each year. Of course, the
+ duration of the overall report and the duration captured by each column can be
+ configured to your liking. Various Graphs and Pie Charts also may be produced.
</para>
</sect2>
-<sect2>
-<title>Net Worth</title>
+<sect2><title>Net Worth</title>
<para>
- Here there are reports that describe your net worth, either at the current
- moment, every month for the current year, or every year of your history. In
- addition, there is a 7-day Cash Flow Forecast and a Net Worth Graph. There
- are also reports to get the balances for all of your accounts at any given
- point in time.
+ Here there are reports that describe your net worth, either at the current moment,
+ every month for the current year, or every year of your history. In addition,
+ there is a 7-day Cash Flow Forecast and a Net Worth Graph. There are also reports
+ to get the balances for all of your accounts at any given point in time.
</para>
</sect2>
-<sect2>
-<title>Transactions</title>
+<sect2><title>Transactions</title>
<para>
This section includes reports that list individual transactions. This is the
best way to print your account register for a specific period of time. The
transactions printed can be grouped together according to your liking by
choosing the appropriate report, such as:
-<itemizedlist>
- <listitem><para>By Account</para></listitem>
- <listitem><para>By Category</para></listitem>
- <listitem><para>By Month or Week</para></listitem>
- <listitem><para>By Payee</para></listitem>
-</itemizedlist>
+ <itemizedlist>
+ <listitem><para>By Account</para></listitem>
+ <listitem><para>By Category</para></listitem>
+ <listitem><para>By Month or Week</para></listitem>
+ <listitem><para>By Payee</para></listitem>
+ <listitem><para>By Reconciliation Status</para></listitem>
+ <listitem><para>By Tag</para></listitem>
+ </itemizedlist>
</para>
-
</sect2>
-<sect2>
-<title>Cash Flow</title>
+<sect2><title>Cash Flow</title>
<para>
The Cash Flow report is similar to a Transaction report, but it displays all
- cash-flow related transactions.
+ cash-flow related transactions for the specified period, which defaults to the
+ current month.
</para>
</sect2>
-<sect2>
-<title>Investments</title>
+<sect2><title>Investments</title>
<para>
These reports help you keep track of your investments. They only include
investment accounts. There are a variety of presentation filters and styles,
as shown in this partial list.
</para>
+
<itemizedlist>
- <listitem><para>Investment Transactions: Similar to a Transactions report,
- and includes the share price and quantities.</para></listitem>
- <listitem><para>Investment Holdings by Account: Shows the current shares,
- price, and value for each account.</para></listitem>
- <listitem><para>Investment Holdings by Type: Same as the previous report, but
- organizes the accounts by type (Stock, Mutual Fund, &etc;)</para></listitem>
- <listitem><para>Investment Performance by Account: Shows the annualized
- performance over any period of time. This performs a cash flow analysis of
- all money coming into and going out of the account. As a result, this is a
- very accurate picture of how well your investments are
- doing.</para></listitem>
- <listitem><para>Investment Performance by Type: Same as the previous report,
- but organizes the accounts by type (Stock, Mutual Fund,
- &etc;)</para></listitem>
+ <listitem>
+ <para> Investment Transactions: Similar to a Transactions report, but it includes
+ share prices and quantities. </para>
+ </listitem>
+ <listitem>
+ <para>Investment Holdings by Account: Shows the current shares, prices, and
+ values for each account.</para>
+ </listitem>
+ <listitem>
+ <para>Investment Holdings by Type: Same as the previous report, but organizes the
+ accounts by type (Stock, Mutual Fund, &etc;)</para>
+ </listitem>
+ <listitem>
+ <para>Investment Performance by Account: Shows the annualized performance over
+ any period of time. This performs a cash flow analysis of all money coming into
+ and going out of the account. As a result, this is a very accurate picture of
+ how well your investments are doing.</para>
+ </listitem>
+ <listitem>
+ <para>Investment Performance by Type: Same as the previous report, but organizes
+ the accounts by type (Stock, Mutual Fund, &etc;)</para>
+ </listitem>
</itemizedlist>
<para>
@@ -107,300 +115,421 @@
</para>
</sect2>
-<sect2>
-<title>Taxes</title>
+<sect2><title>Taxes</title>
<para>
- The tax reports are just like the transactions reports, with the addition that
- only Tax related categories are included. This allows you to flag certain
- categories as being tax-related, and then get one big report at the end of the
- year to see them all in one place. They may be listed either by Category or by
- Payee, and for the last fiscal year.
+ The tax reports are just like the transactions reports, with the addition that only
+ Tax related categories are included. This allows you to flag certain categories as
+ being tax-related, and then get one big report at the end of the year to see the
+ transactions for those categories all in one place. They may be listed either by
+ Category or by Payee, and for the last fiscal year.
</para>
</sect2>
-<sect2>
-<title>Budgeting</title>
+<sect2><title>Budgeting</title>
<para>
- The budgeting reports are similar to net worth reports, but the reports can
- display the budget for a given year, or even compare it to the actual income
- and expenses for the same period.
+ The budgeting reports are similar to net worth reports, but the reports can display
+ the budget for a given year, or even compare it to the actual income and expenses
+ for the same period.
</para>
</sect2>
-<sect2>
-<title>Forecast</title>
+<sect2><title>Forecast</title>
<para>
The forecast reports are just like the net worth reports, but they use the
- information to display forecast information. You can display the information
- at various levels and for the time frame of your choosing.
+ information to display forecast information. You can display the information at
+ various levels and for the time frame of your choosing.
</para>
</sect2>
-<sect2>
-<title>Information</title>
+<sect2><title>Information</title>
<para>
- These reports display non-transaction information about schedules, accounts,
- and loans.
+ These reports display non-transaction information about accounts, loans, and
+ schedules.
</para>
</sect2>
-<sect2>
-<title>Charts</title>
+<sect2><title>Charts</title>
<para>
- If <link linkend="details.reports.charts">Charts</link> are enabled, this
- section lists all the reports which are marked to display a graphical chart as
- the default. They are also listed in one of the other sections, but they are
- also aggregated here for your easy reference.
+ If <link linkend="details.reports.charts">Charts</link> are enabled, this section
+ lists all the reports which are marked to display a graphical chart as the default.
+ They are also listed in one of the other sections, but they are aggregated here for
+ your easy reference.
</para>
</sect2>
-<sect2>
-<title>Favorite Reports</title>
+<sect2><title>Favorite Reports</title>
<para>
This section lists all the reports you have marked as a favorite in the report
- configuration dialog. They are still listed in one of the other sections, but
- they are also aggregated here for your easy reference. Favorite reports are
- also included on the financial summary page for even easier reference.
-</para>
-</sect2>
-
-<sect2>
-<title>Configuring Reports</title>
-<para>
- To access the report configuration dialog, bring up the report you wish to
- configure, and press the <guibutton>Configure</guibutton> button at the top of
- the report.
+ configuration dialog. They are still listed in one of the other sections, but they
+ are aggregated here for your easy reference. Favorite reports can also be included
+ on the Home View for even easier reference.
</para>
</sect2>
-
</sect1>
-<sect1 id="details.reports.working">
-<title>Working With Reports</title>
+<sect1 id="details.reports.working"><title>Working With Reports</title>
<para>
- There are a number of actions you can take on each report. You can access
- these by right-clicking the report name in the list of reports. Alternately,
- once you have run a report, there are buttons across the top of the view to
- invoke each of these:
+ There are a number of actions you can take on each report. You can access some
+ these by right-clicking the report name in the list of reports, which brings up the
+ <guilabel>Report options</guilabel> context menu. Alternately, once you have run a
+ report, there are buttons across the top of the view to invoke each of these:
</para>
<itemizedlist>
- <listitem><para>Chart: Only present if the report is capable of displaying a
- chart. Clicking this option toggles between the report and the
- chart.</para></listitem>
- <listitem><para>Configure: Change the properties of this report. You can
- customize the report to your liking and save it for future
- use.</para></listitem>
- <listitem><para>New: Create a new customized report based on the selected
- report.</para></listitem>
- <listitem><para>Copy: The report output can be copied to the clipboard to
- paste them in another application, like a spreadsheet, for further
- analysis.</para></listitem>
- <listitem><para>Export: Reports can be saved in &HTML; or CSV
- format.</para></listitem>
- <listitem><para>Delete: Customized reports can be deleted. The default
- reports that ship with &kmymoney; cannot be deleted.</para></listitem>
- <listitem><para>Close: Close the current report.</para></listitem>
+ <listitem>
+ <para> Chart: Only present if the report is capable of displaying a chart.
+ Clicking this option toggles between the report and the chart.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Configure report: Change the properties of this report. You can customize
+ the report to your liking and save it for future use. See the next section for
+ more details</para>
+ </listitem>
+ <listitem>
+ <para>New report: Create a new, customized report based on the selected
+ report.</para>
+ </listitem>
+ <listitem>
+ <para>Export report: Reports can be exported, or saved, in &HTML; or CSV format.
+ &HTML; is intended to preserve the displayed formatting of the report. CSV
+ exports the data underlying the report.</para>
+ </listitem>
+ <listitem>
+ <para>Delete report: Customized reports can be deleted. The default reports that
+ ship with &kmymoney; cannot be deleted.</para>
+ </listitem>
+ <listitem>
+ <para>Close report: Close the current report.</para>
+ </listitem>
</itemizedlist>
</sect1>
<sect1 id="details.reports.config">
<title>Configuring Reports</title>
-<sect2>
-<title>Working with custom reports</title>
+<sect2><title>Working with custom reports</title>
<para>
- You can configure the default reports or create your own from them by
- selecting 'New' and then configuring the new report. When you select
- 'Configure' you will be presented with the Report Tab. Initially, it is named
- the same as the old report with <quote>(Customized)</quote> added to the end. You
- can change the name to whatever you want. You can even name your custom
- reports the same as a default report, or the same as another custom
- report. Also, you can always use the Comment field to further distinguish
- reports.
+ You can configure the default reports or create your own from them by selecting
+ <guilabel>New report</guilabel>, and then configuring the new report. When you
+ click <guilabel>Configure report</guilabel> you will be presented with the Report
+ Tab of the <guilabel>Report Configuration</guilabel> dialog. Initially, the new
+ report it is named the same as the old report with <quote>(Customized)</quote>
+ added to the end. You can change the name to whatever you want. You can even name
+ your custom reports the same as a default report, or the same as another custom
+ report. You can use the Comment field to further distinguish reports.
</para>
<para>
- The Report Configuration dialog has a number of tabs across the top. Each tab
- displays options for configuring different aspects of the report.
+ The Report Configuration dialog has a <guilabel>Report</guilabel> tab and a
+ <guilabel>Filters</guilabel> tab, which each have a number of subtabs. Each subtab
+ displays options for configuring different aspects of the report. Note that
+ specific subtabs and options within them may not appear if they are not relevant to
+ the report being configured.
</para>
-
</sect2>
-<sect2><title>Report Tab</title>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="report_configuration-reporttab.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Report Configuration -Report</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+<sect2 id="details.reports.config.report"><title>Report Tab</title>
+<para>
+ This is where you configure general information about the report as well as controlling
+ details about what data is presented and how it is presented.
+</para>
+
+<sect3 id="details.reports.config.general"><title>General subtab</title>
+<para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reports_configuration_general.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Report Configuration - General</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+</para>
+
+<para>
+ Here you set the basic properties of the report.
+ <itemizedlist>
+ <listitem>
+ <para>Report Name: Choose or edit the name for this report.</para>
+ </listitem>
+ <listitem>
+ <para>Comment: Enter a comment to help you remember the details of this report
+ and identify it if the name is the same as any other report.</para>
+ </listitem>
+ <listitem>
+ <para>Convert values to base currency: Select this option to convert all values
+ in the report to your base currency. Leave it unchecked if you'd like to see
+ values in their original currency. If currencies are not converted, then
+ subtotals will not be shown.</para>
+ </listitem>
+ <listitem>
+ <para>Mark as favorite report: Check this to cause this report to show up on
+ the Home View and in the group of <guilabel>Favorite Reports</guilabel>.</para>
+ </listitem>
+ <listitem>
+ <!-- FIXME: when IS this used? -->
+ <para>Skip value if price is zero: This option is only available where it makes
+ sense.</para>
+ </listitem>
+ </itemizedlist>
</para>
+</sect3>
+<sect3 id="details.reports.config.rowscolumns"><title>Rows/Columns subtab</title>
<para>
- On this tab, you set the basic properties of this report.
-<itemizedlist>
- <listitem><para>Report Name: Choose a name for this report.</para></listitem>
- <listitem><para>Comment: Enter a comment to help you remember the details of
- this report.</para></listitem>
- <listitem><para>Convert values to base currency: Select this option to convert
- all values in the report to your base currency. Leave it unchecked if you'd
- like to see values in their original currency. If currencies are not
- converted, then subtotals will not be shown.</para></listitem>
- <listitem><para>Mark as favorite report: Check this to cause this report to
- show up on the home page and in the group of <guilabel>Favorite
- Reports</guilabel>.</para></listitem>
-</itemizedlist>
+ This is where you configure how you would like the rows and columns of the report
+ to be selected and organized. This tab presents different configuration options
+ depending on the style of report you are configuring.
</para>
-</sect2>
-
-<sect2 id="details.reports.config.rowscolumns">
-<title>Rows/Columns Tab</title>
<para>
- On this tab, you configure how you would like the rows and columns to be selected
- and organized. This tab presents different configuration options depending on
- the style of report you have selected.
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reports_configuration_rowscolumns.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Report Configuration - Rows and Columns</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
</para>
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="report_configuration-rowscolumns.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Report Configuration -Rows and Columns</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+ For income/expense and net worth reports:
+ <itemizedlist>
+ <listitem>
+ <para>Budgets: If you have have any <link
+ linkend="details.budgets">budgets</link> defined, you can select one as well as
+ whether differences between budget and actual amounts should be propagated from
+ one time period to the next</para>
+ </listitem>
+ <listitem>
+ <para>Totals: Choose whether to display a row and/or column for total
+ amounts.</para>
+ </listitem>
+ <listitem>
+ <para>Rows: Choose whether to base the report on Income and Expense
+ (Categories) or on Asset and Liability accounts.</para>
+ </listitem>
+ <listitem>
+ <para>Detail: Choose the level of detail required for this report.</para>
+
+ <para>The following levels of detail are available:
+ <itemizedlist>
+ <listitem><para>All: Show every category or account.</para></listitem>
+ <listitem><para>Top-Level: Show only the highest-level categories or
+ accounts, and roll up the sums of the subordinate categories or accounts into
+ those values.</para></listitem>
+ <listitem><para>Groups: Show only the totals of the income and expense or
+ asset and liabilities.</para></listitem>
+ <listitem><para>Totals: Show only the grand totals.</para></listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>In addition you can specify whether or not to include scheduled and/or
+ transfer transactions and unused accounts or categories.</para>
+ </listitem>
+ </itemizedlist>
</para>
<para>
- For income/expense and net worth reports:
-<itemizedlist>
- <listitem><para>Columns: Choose how large of a time period each column should
- encompass</para></listitem>
- <listitem><para>Rows: Choose what kind of accounts to display as the rows of
- this report</para></listitem>
- <listitem><para>Detail: Choose the level of detail required for this
- report.</para></listitem>
-</itemizedlist>
+ For transaction reports:
+ <itemizedlist>
+ <listitem>
+ <para>Organize by: Choose how to group the transactions in this report.</para>
+ </listitem>
+ <listitem>
+ <para>Show Columns: Choose which columns should be shown in the report. The
+ date and transaction amount are always shown.</para>
+ </listitem>
+ <listitem>
+ <para>Include only Tax Categories: Only show categories which have been marked
+ as tax-related.</para>
+ </listitem>
+ <listitem>
+ <para>Include only Investment Accounts: Only show transactions from investment
+ accounts.</para>
+ </listitem>
+ <listitem>
+ <para>Include only Loan Accounts: Only show transactions from loan
+ accounts.</para>
+ </listitem>
+ <listitem>
+ <para>Include transfers: Unless this is checked, transfer transactions are not
+ included in transaction reports</para>
+ </listitem>
+ <listitem>
+ <para>Hide Split Transaction Details: When this option is available, it lets
+ you speicfy that only the total amount of a split transaction is to be
+ displayed.</para>
+ </listitem>
+ <listitem>
+ <para>Hide totals: Selecting this prevents Total lines from being calculated
+ and displayed</para>
+ </listitem>
+ </itemizedlist>
</para>
+</sect3>
+</sect2>
-<para>The following levels of detail are available:
-<itemizedlist>
- <listitem><para>All: Show every category or account.</para></listitem>
- <listitem><para>Top-Level: Show only the highest-level categories or accounts,
- and roll up the sums of the subordinates categories or accounts into those
- values.</para></listitem>
- <listitem><para>Groups: Show only the totals of the income, expenses, assets,
- or liabilities.</para></listitem>
- <listitem><para>Total: Show only the grand totals line.</para></listitem>
-</itemizedlist>
+<sect2 id="details.reports.config.chart"><title>Chart Subtab</title><para>
+ This subtab allows you to configure what the report should look like when it is
+ displayed as a chart. See the <link linkend="details.reports.charts">Graphs &
+ Charts</link> section for more explanation of the charting functions.
</para>
<para>
- For transaction reports:
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reports_configuration_chart.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Report Configuration - Chart</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+</para>
+
<itemizedlist>
- <listitem><para>Organize by: Choose how to group the transactions in this
- report.</para></listitem>
- <listitem><para>Show Columns: Choose which columns should be shown in the
- report. The date and transaction amount are always shown.</para></listitem>
- <listitem><para>Include only Tax Categories: Only show categories which have
- been marked as tax-related.</para></listitem>
- <listitem><para>Include only Investment Accounts: Only show transactions from
- investment accounts.</para></listitem>
- <listitem><para>Include only Loan Accounts: Only show transactions from loan
- accounts.</para></listitem>
+ <listitem>
+ <para>Chart Type: The visual format of chart desired.</para>
+ </listitem>
+ <listitem>
+ <para>Show grid lines: Whether to print horizontal and vertical grid lines on the
+ chart.</para>
+ </listitem>
+ <listitem>
+ <para>Draw values on chart: Whether to print the data values on the chart itself
+ for chosen data points.</para>
+ </listitem>
+ <listitem>
+ <para>Show chart by default: Whether this report should first be displayed as a
+ chart when it's opened.</para>
+ </listitem>
+ <listitem>
+ <para>Logarithmic vertical axis: normally the vertical axis is linear.</para>
+ </listitem>
+ <listitem>
+ <para>Plot expenses downwards: normally both income and expenses are plotted
+ upwards.</para>
+ </listitem>
+ <listitem>
+ <para>Line width: The width of data lines on the chart, specified in
+ pixels.</para>
+ </listitem>
</itemizedlist>
+</sect2>
+
+<sect2 id="details.reports.config.range"><title>Range Subtab</title>
+<para>
+ The Range subtab has two sections, <guilabel>Date range</guilabel> and
+ <guilabel>Data range</guilabel> for controlling the limits and subdivisions of the
+ displayed data. Note that this only controls the display, to control the data used
+ by &kmymoney; to created the report, see the section on the <link
+ linkend="details.reports.config.report">Filters tab</link>.
</para>
-</sect2>
+<para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reports_configuration_range.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Report Configuration - Range</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+</para>
-<sect2>
-<title>Chart Tab</title>
+<sect3><title>Date range</title>
+<para>
+ Selecting one of the descriptive values from the <guilabel>Range</guilabel>
+ dropdown automatically sets the values of the <guilabel>From</guilabel> and
+ <guilabel>To</guilabel> date fields. You can override either or both of those
+ dates, in which case the first dropdown will show <quote>User defined</quote>.
+</para>
<para>
- This tab allows you to configure what the report should look like when it is
- displayed as a chart. See the <link linkend="details.reports.charts">Graphs
- & Charts</link> section for more explanation of the charting functions.
-<itemizedlist>
- <listitem><para>Chart Type: The visual format of chart
- desired.</para></listitem>
- <listitem><para>Show grid lines: Whether to print horizontal and vertical grid
- lines on the chart.</para></listitem>
- <listitem><para>Draw values on chart: Whether to print the data values on the
- chart itself for chosen data points.</para></listitem>
- <listitem><para>Show chart by default: Whether this report should first be
- displayed as a chart when it's opened.</para></listitem>
- <listitem><para>Line width: The width of data lines on the
- chart.</para></listitem>
-</itemizedlist>
+ The <guilabel>Ticks</guilabel> dropdown controls the placement of ticks on the date
+ axis of the chart.
</para>
+</sect3>
+<sect3><title>Data range</title>
+<para>
+ This lets you control the limits, ticks, and labels on the vertical data axis. The
+ default value for the <guilabel>Range</guilabel> dropdown is
+ <quote>Automatic</quote>, lets &kmymoney; choose reasonable values for the other
+ fields. If you select <quote>User defined</quote> you need to specify all the
+ other fields. <guilabel>From</guilabel> and <guilabel>To</guilabel> set the lower
+ and upper limits of the axis. <guilabel>Major tick length</guilabel> and
+ <guilabel>Minor tick length</guilabel> control the positioning of larger and
+ smaller tick marks along the axis. <guilabel>Labels Precision</guilabel> controls
+ the number of decimal places used in the numbers displayed along the axis.
+</para>
+</sect3>
</sect2>
<sect2>
-<title>Other Tabs</title>
+<title>Filters tab</title>
<para>
- The other tabs in this dialog are the same as in the Search Transactions
- interface. Please refer to
- the <link linkend="details.search">documentation</link> on that interface for
- details on the other tabs.</para>
+ The filters tab has several subtabs, which can be used to filter or limit the data
+ &kmymoney; uses to prepare the report. These are the same subtabs used to control
+ searching for transactions. Please refer to the <link
+ linkend="details.search">Search Transactions</link> section for details on those
+ tabs.</para>
</sect2>
-
</sect1>
-<sect1 id="details.reports.charts">
-<title>Graphs & Charts</title>
+<sect1 id="details.reports.charts"><title>Graphs & Charts</title>
-<sect2>
-<title>Viewing as a Chart</title>
+<sect2><title>Viewing as a Chart</title>
<para>
- Each report can be viewed in either textual form or graphical (chart) form.
- The same report configuration parameters are used in either case. You can
- easily jump back and forth between the textual and graphical forms by pressing
- the <guibutton>Chart</guibutton> or <guibutton>Report</guibutton> buttons
- along the top of the report view.
+ Many reports can be viewed in either textual form or graphical (chart) form. The
+ same report configuration parameters are used in either case. You can easily jump
+ back and forth between the textual and graphical forms by pressing the
+ <guibutton>Chart</guibutton> or <guibutton>Report</guibutton> buttons along the top
+ of the report view.
</para>
<para>
- Care should be taken to limit the amount of data you choose to display on a
- chart. If you are not careful, using the same configuration for both textual
- and graphical forms means it's possible to configure a chart to be visually
- cluttered, unappealing, and uninformative. &kmymoney; will not force you to
- keep your charts readable and useful!
+ Please pay attention to the amount of data you choose to display on a chart. If
+ you are not careful, using the same configuration for both textual and graphical
+ forms means it's possible to configure a chart to be visually cluttered,
+ unappealing, and uninformative. &kmymoney; will not force you to keep your charts
+ readable and useful! Also be aware that some reports will take a long time to
+ calculate and display if too much is included.
</para>
-
</sect2>
-<sect2>
-<title>Available Chart Types</title>
+<sect2><title>Available Chart Types</title>
-<sect3>
-<title>Line Graph</title>
+<sect3><title>Line Graph</title>
<para>
- A line graph is one of the most simple forms of a chart. There is one line
- for each series. (Usually a series is a single account or category; see below
- for more details on that.) The time periods stretch out along the bottom axis,
- and the currency values are along the left.
+ A line graph is one of the simplest forms of a chart. There is one line for each
+ series. Usually, a series is data from a single account or category over time; see
+ below for more details. The time periods stretch out along the bottom axis, and
+ the currency values are along the left axis.
</para>
<para>
The detail level for each line is controlled in the <link
- linkend="details.reports.config.rowscolumns">Rows/Columns</link> Tab of chart
- configuration. If you choose the <quote>Top-Level</quote> detail level, there
- will be one line for each of the top-most accounts or categories which show
- the sum total of all underlying accounts or categories. If you choose
- <quote>Groups</quote> it will instead show one line each for Income, Expenses,
+ linkend="details.reports.config.rowscolumns">Rows/Columns</link> Subtab of chart
+ configuration. If you choose the <quote>Top-Level</quote> detail level, there will
+ be one line for each of the top-most accounts or categories, which shows the sum
+ total of all underlying accounts or categories. If you choose
+ <quote>Groups,</quote> it will instead show one line each for Income, Expenses,
Assets, or Liabilities, depending on the other settings.
</para>
</sect3>
@@ -409,8 +538,8 @@
<title>Bar Graph</title>
<para>
- The bar graph works exactly the same as the line graph, except there is one
- bar for each series in each time slice.
+ The bar graph works exactly the same as the line graph, except there is one bar for
+ each series in each time slice.
</para>
</sect3>
@@ -418,11 +547,11 @@
<title>Pie Chart</title>
<para>
- The pie chart is the most simple chart available. It shows only one time
- slice, as opposed to showing the values across time. This chart shows only
- the totals column of whatever report is selected. If your report is
+ The pie chart is the simplest chart type available. It shows data from only one
+ time slice, as opposed to showing the values across time. This chart shows only
+ the data from the totals column of whatever report is selected. If your report is
configured to NOT convert values to the base currency, there will be no totals
- column, and therefore this report is not useful.
+ column, in which case this report is not useful.
</para>
</sect3>
@@ -434,8 +563,6 @@
<quote>ring</quote> for each time slice in the report.
</para>
</sect3>
-
</sect2>
-
</sect1>
</chapter>
diff --git a/doc/exchange_rate_editor.png b/doc/exchange_rate_editor.png
new file mode 100644
index 000000000..0d84c8a6e
Binary files /dev/null and b/doc/exchange_rate_editor.png differ
diff --git a/doc/investments_view_equities.png b/doc/investments_view_equities.png
new file mode 100644
index 000000000..48482b10d
Binary files /dev/null and b/doc/investments_view_equities.png differ
diff --git a/doc/investments_view_securities.png b/doc/investments_view_securities.png
new file mode 100644
index 000000000..760f5da4d
Binary files /dev/null and b/doc/investments_view_securities.png differ
diff --git a/doc/reports_configuration_chart.png b/doc/reports_configuration_chart.png
new file mode 100644
index 000000000..3b4db2c41
Binary files /dev/null and b/doc/reports_configuration_chart.png differ
diff --git a/doc/report_configuration-reporttab.png b/doc/reports_configuration_general.png
similarity index 100%
rename from doc/report_configuration-reporttab.png
rename to doc/reports_configuration_general.png
diff --git a/doc/reports_configuration_range.png b/doc/reports_configuration_range.png
new file mode 100644
index 000000000..2a07fb00e
Binary files /dev/null and b/doc/reports_configuration_range.png differ
diff --git a/doc/report_configuration-rowscolumns.png b/doc/reports_configuration_rowscolumns.png
similarity index 100%
rename from doc/report_configuration-rowscolumns.png
rename to doc/reports_configuration_rowscolumns.png
diff --git a/doc/reports_view-all.png b/doc/reports_view_list.png
similarity index 100%
rename from doc/reports_view-all.png
rename to doc/reports_view_list.png
More information about the kde-doc-english
mailing list