[kde-doc-english] [kmymoney/frameworks] doc: Various further edits for 4.7 release, and much work on cvs importer chapter
Cristian Oneț
onet.cristian at gmail.com
Sat Sep 20 22:50:04 UTC 2014
Git commit 9e283be8f54ca8a1fcae41d28224857ffed89bc0 by Cristian Oneț, on behalf of Jack Ostroff.
Committed on 06/09/2014 at 15:41.
Pushed by conet into branch 'frameworks'.
Various further edits for 4.7 release, and much work on cvs importer chapter
(cherry picked from commit c42797645fbd916423b4ad1a0124a6169a6bb218)
M +8 -6 doc/details-categories.docbook
M +29 -4 doc/details-currencies.docbook
M +294 -148 doc/details-impexp-csv.docbook
M +49 -0 doc/details-impexp.docbook
M +25 -11 doc/details-investments.docbook
M +13 -0 doc/details-ledgers.docbook
M +26 -13 doc/details-settings.docbook
M +86 -45 doc/details-tags.docbook
M +141 -108 doc/faq.docbook
M +135 -18 doc/firsttime.docbook
M +3 -1 doc/index.docbook
M +10 -3 doc/installation.docbook
A +- -- doc/list-add.png
A +- -- doc/list-remove.png
A +- -- doc/mail-tagged.png
M +22 -10 doc/makemostof.docbook
http://commits.kde.org/kmymoney/9e283be8f54ca8a1fcae41d28224857ffed89bc0
diff --git a/doc/details-categories.docbook b/doc/details-categories.docbook
index ebe9ccd..8481881 100644
--- a/doc/details-categories.docbook
+++ b/doc/details-categories.docbook
@@ -4,8 +4,8 @@
<authorgroup>
<author>&Roger.Lum; &Roger.Lum.mail;</author>
</authorgroup>
- <date>2010-07-25</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2014-08-30</date>
+ <releaseinfo>4.7.01</releaseinfo>
</chapterinfo>
<title id="details.categories.title">Categories</title>
@@ -27,7 +27,7 @@
</para>
<sect1 id="details.categories.create">
-<title>Creating categories</title>
+<title>Creating a category</title>
<para>
To create a new category, either select <menuchoice><guimenu>Category</guimenu>
@@ -59,7 +59,7 @@
</sect1>
<sect1 id="details.categories.edit">
-<title id="details.categories.edit.title">Editing a Category</title>
+<title>Editing a Category</title>
<para>
To edit a category, right-click on a category name, and choose
@@ -81,7 +81,9 @@
category to a different parent.
-->
You can change the parent category by clicking on another category in this
- view of the category hierarchy.
+ view of the category hierarchy. In an earlier version of &kappname; it was possible to change the parent of
+ a category by dragging and dropping. This functionality will return in a future version, but possibly not
+ until the conversion of &kappname; to &kde; Frameworks.
</para>
<para>
@@ -135,7 +137,7 @@
</sect1>
<sect1 id="details.categories.delete">
-<title>Deleting categories</title>
+<title>Deleting a category</title>
<para>
To delete a category, select it in the tree, right click to bring up the popup
diff --git a/doc/details-currencies.docbook b/doc/details-currencies.docbook
index e91161c..cd057a0 100644
--- a/doc/details-currencies.docbook
+++ b/doc/details-currencies.docbook
@@ -4,15 +4,15 @@
<authorgroup>
<author> &Thomas.Baumgart; &Thomas.Baumgart.mail; </author>
</authorgroup>
- <date>2010-07-25</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2014-08-30</date>
+ <releaseinfo>4.7.01</releaseinfo>
</chapterinfo>
<title>Currencies</title>
<para>
&kappname; supports the use of multiple currencies in different accounts. For
- example, you can set up a bank account in Euro, another in British Pounds, and
+ example, you can set up a bank account in Euros, another in British Pounds, and
still have your credit card account in US Dollars.
</para>
@@ -20,7 +20,7 @@
<title>Base currency</title>
<para>
- Once you create a &kappname; file you will be asked for the base currency. The
+ Once you create a &kappname; file, you will be asked for the base currency. The
base currency is the one that all income and expense categories use and that
reports will be based on. Usually, the base currency is the currency you use
in your country. If not otherwise selected, new accounts will use this
@@ -40,6 +40,31 @@
</mediaobject>
</screenshot>
</para>
+
+<sect2 id="details.currencies.newcurrency">
+<title>Adding a new currency</title>
+
+<para>
+ Although it does not happen often, sometimes a new currency is introduced.
+ This can be a new virtual currency, such as Bitcoin, or a change introduced by
+ a country for financial policy reasons. While any such currency will be added
+ to the next version of &kappname; it is possible to add it manually, in case
+ you have a need to begin using it immediately.
+</para>
+
+<para>
+ To manually add a currency, select
+ <menuchoice><guimenu>Tools</guimenu><guimenuitem>Currencies...</guimenuitem></menuchoice>
+ to display the <guilabel>Currencies</guilabel> dialog, as shown above. Right
+ click on any existing currency and select <menuchoice><guimenuitem>New
+ currency</guimenuitem></menuchoice> from the <menuchoice><guimenu>Currency
+ Options</guimenu></menuchoice> context menu. Enter the official 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 <menuchoice><guimenuitem>Rename
+ currency</guimenuitem></menuchoice>.
+</para>
+</sect2>
</sect1>
<sect1 id="details.currencies.accountsetup">
diff --git a/doc/details-impexp-csv.docbook b/doc/details-impexp-csv.docbook
index c13ae42..96d4ee9 100644
--- a/doc/details-impexp-csv.docbook
+++ b/doc/details-impexp-csv.docbook
@@ -10,18 +10,20 @@
<para>
In general, it is preferable to import OFX. However, not all institutions
provide data in that format. CSV (comma separated value) files are almost
- always available (sometimes described as Excel or spreadsheet.) Also, they
- can often be created fairly easily by capturing the data you want to import,
- such as in a text file, and manually editing it.
+ always available, sometimes described as Excel or spreadsheet files. Also,
+ they can often be created fairly easily by capturing the data you want to
+ import, such as in a text file, and manually editing it.
</para>
<para>
The primary focus of the plugin is on importing data from bank statements, but
- there is also a capability to import some investment statements. This plugin
- was initially created with the ability to produce QIF files from CSV. This
- functionality is still present, but is likely to be removed, as &kappname; has
- the native ability to <link linkend="details.impexp.qifexp">export QIF
- files</link>.
+ there is also a capability to import some investment statements. This plugin
+ was initially created, before becoming a CSV importer, to produce QIF files
+ from CSV, which could then be imported. This functionality is still present,
+ but is likely to be removed, as the plugin now focuses on directly importing
+ CSV files. Also, &kappname; has the native ability to <link
+ linkend="details.impexp.qifexp">export QIF files</link>, so there is no real
+ reason to produce a QIF file from a CSV file.
</para>
</sect2>
@@ -29,11 +31,11 @@
<title>Getting the plugin</title>
<para>
- &kappname; will import CSV (comma separated values) files. This functionality
- is provided as a plugin, and it is now built into the core program, both in
- distro packages and in the source files. Once the distro package is
- installed, or the source files are compiled and installed, the menu choice to
- import CSV files will automatically show up under the
+ &kappname; will import CSV files. This functionality is provided as a plugin,
+ and it is now built into the core program, both in distro packages and in the
+ source files. Once the distro package is installed, or the source files are
+ compiled and installed, the menu choice to import CSV files will automatically
+ show up under the
<menuchoice><guimenu>File</guimenu><guimenuitem>Import</guimenuitem></menuchoice>
menu.
</para>
@@ -70,34 +72,51 @@
<para>
The CSV Importer is in the form of a wizard, with a separate page for each
- individual step of the process.
+ individual step of the process. There may be some minor differences between
+ the text in this handbook, the labels in the screenshots, and the labels you
+ actually see in the wizard. In such cases, the handbook describes what the
+ wizard will look like in the next release.
</para>
<sect3>
-<title>CSV Import Wizard: Introduction</title>
+<title>CSV Import Wizard: Start</title>
<para>
- When started, the CSV Importer displays the <guilabel>Introduction</guilabel>
+ When started, the CSV Importer displays the <guilabel>Start</guilabel>
page. The upper area, where data will be displayed, is initially empty.
- Below that, at the left, is a list of the steps of hte import process, with
+ Below that, on the left, is a list of the steps of the import process, with
the current one highlighted. To the right of that are some brief instructions
and two radio buttons, allowing the choice of either
- <guilabel>Banking</guilabel> or <guilabel>Investing</guilabel>. Next there is
+ <guilabel>Banking</guilabel> or <guilabel>Investment</guilabel>. Next there is
a profile selector box, which is enabled once one of the radio buttons has
- been selected. At the bottom of the disply are buttons to move on to the next
- step of the wizard, go <guibutton>Back</guibutton> to the previous step, or
- <guibutton>Cancel</guibutton> the import.
-
+ been selected. At the bottom of the display are buttons to move on to the
+ next step of the wizard, go <guibutton>Back</guibutton> to the previous step,
+ or <guibutton>Cancel</guibutton> the import. At the inital step, there is
+ also a button <guilabel>Select File</guilabel> to initially select the file to
+ import.
+<!-- want to use inlinemediaobject to avoid lines above and below. -->
<screenshot>
- <inlinemediaobject>
+ <mediaobject>
<imageobject>
<imagedata fileref="csvImporter_1.png" format="PNG" />
</imageobject>
- </inlinemediaobject>
+ </mediaobject>
</screenshot>
+ Also, note the <guilabel>Skip setup</guilabel> checkbox next to the profile
+ selector. Initially, you should not select this check-box. Once you have set
+ up a profile and finished the wizard, those parameters are saved in the
+ resource file. Next time you use that same profile, the parameters will be
+ loaded into the UI (User Interface). The wizard would then plod through the
+ following pages of parameters that you won't need to change. So, instead,
+ once you are happy with a profile, it may be helpful to check this box. The
+ wizard will then move directly to the final page, and, assuming no problems
+ are found, you just have to click <guilabel>Import</guilabel>.
+</para>
+
+<para>
First select either <guilabel>Banking</guilabel> or
- <guilabel>Investing</guilabel>, then click in the selector box, which displays
+ <guilabel>Investment</guilabel>, then click in the selector box, which displays
"Add New Profile." If you have previously created any profiles, you can
select one of them, otherwise enter a new profile name, possibly the name of
the account into which you wish to import. If you enter a new profile name,
@@ -111,23 +130,35 @@
<title>CSV Import Wizard: Separators</title>
<para>
The wizard will now have advanced to the <guilabel>Separators</guilabel> page,
- and you should now see your data, as the plugin should have detected the
- appropriate <guilabel>Field Delimiter</guilabel> to use.
+ and you should now see your data.
<screenshot>
- <inlinemediaobject>
+ <mediaobject>
<imageobject>
<imagedata fileref="csvImporter_2.png" format="PNG" />
</imageobject>
- </inlinemediaobject>
+ </mediaobject>
</screenshot>
- It is not usually possible to select a different one. In fact, attempting to
- do so will reset any field choices you may already have made. There is also a
- selector for the <guilabel>Text Delimiter</guilabel>, but generally the quote
- (") is correct. Now click on the<guilabel>Next</guilabel>button. Depending
- upon the earlier selection you made, you will now be on either the Banking
- page or the Investing page.
+ <warning>
+ <para>
+ It may appear that the displayed entries in the upper section of the
+ plugin window may be edited, and in fact they may, but any edits are not
+ kept. The table is purely for display, not for editing. The input file
+ is never altered by the plugin, and the data actually imported comes from
+ the input file, not from the display. The one exception to this is
+ covered in <link linkend="details.impexp.csv.secsym">Securities and
+ Symbols</link> below.
+ </para>
+ </warning>
+
+ The plugin should have detected the appropriate <guilabel>Field
+ Separator</guilabel> to use, and it is not usually possible to select a
+ different one. In fact, attempting to do so will reset any field choices you
+ may already have made. There is also a selector for the <guilabel>Text
+ Delimiter</guilabel>, but generally the quote (") is correct. Now click on
+ the <guilabel>Next</guilabel> button. Depending upon the earlier selection
+ you made, you will now be on either the Banking page or the Investment page.
</para>
</sect3>
@@ -137,39 +168,57 @@
On this page, you select the column numbers from which to import the relevant fields.
<screenshot>
- <inlinemediaobject>
+ <mediaobject>
<imageobject>
<imagedata fileref="csvImporter_3.png" format="PNG" />
</imageobject>
- </inlinemediaobject>
+ </mediaobject>
</screenshot>
For most fields, you just need to use the appropriate dropdown to select the
- appropriate column. However, there are a few special cases.
+ appropriate column. However, there are a few special considerations.
<itemizedlist>
<listitem>
+<para>
In the center are two radio buttons. If your file has a single column for all
values, select <guilabel>Amount col</guilabel>. However, if there are separate
columns for debits and credits, select <guilabel>Debit/credit col</guilabel>.
This will enable either the <guilabel>Amount column</guilabel> selector or the
<guilabel>Debit column</guilabel> and <guilabel>Credit column</guilabel>
selectors.
+</para>
</listitem>
<listitem>
- It is possible to select more than one memo column, by consecutive selections.
- Memo columns already selected are marked in the drop-down with an asterix (*).
+<para>
+ It is possible to select more than one column for the Memo field, by
+ consecutive selections. Memo columns already selected are marked in the
+ drop-down with an asterix (*). If you select multiple columns in this way,
+ their contents will be concatenated in the Memo field.
+</para>
</listitem>
<listitem>
+<para>
If you attempt to choose the same column number for two fields, the plugin
will alert you and clear both selections. However, it is possible, if
- desired, to use the same column in both the <guilabel>Payee/Description</guilabel> and
- <guilabel>Memo</guilabel> fields. If you select a column for one of these
- fields which has already been selected for the other, you will receive a
- warning that duplicate columns have been selected, but asking if you wish to
- proceed. If you do, click <guibutton>Yes</guibutton>.
+ desired, to use the same column in both the
+ <guilabel>Payee/Description</guilabel> and <guilabel>Memo</guilabel> fields.
+ If you select a column for the <guilabel>Payee/Description</guilabel> field,
+ and then select the same field for the <guilabel>Memo</guilabel> field, you
+ will receive a warning that duplicate columns have been selected, but asking
+ if you wish to proceed. If you do, click <guibutton>Yes</guibutton>.
+</para>
+</listitem>
+
+<listitem>
+<para>
+ One particular reason to also capture the Payee/Descriptor field in the Memo
+ field is that the incoming Payee/Description field might get completely
+ changed on import when &kappname; does transaction matching. Selecting that
+ field also as Memo will preserve that data, which would otherwise get lost.
+</para>
</listitem>
</itemizedlist>
</para>
@@ -177,7 +226,7 @@
<para>
If you notice you have made an incorrect choice, just change that selection.
If several changes need to be made, click the
- <guilabel>Clear selections</guilabel> button.
+ <guilabel>Clear</guilabel> button.
</para>
<para>
@@ -188,75 +237,104 @@
</sect3>
<sect3>
-<title>CSV Import Wizard: Investing</title>
+<title>CSV Import Wizard: Investment</title>
<para>
- Note I have still not reveiewed this section in detail, while actually looking at
- the wizard.
-
- This page is similar to the <guilabel>Banking</guilabel> page, and although it
- is somewhat more complex, most selections are fairly obvious.
+ This page is similar to the <guilabel>Banking</guilabel> page, although it
+ is somewhat more complex. Most selections are fairly obvious, but there are
+ some items which can seem confusing until you have completed the the process
+ once or twice.
<screenshot>
- <inlinemediaobject>
+ <mediaobject>
<imageobject>
<imagedata fileref="csvImporter_4.png" format="PNG" />
</imageobject>
- </inlinemediaobject>
+ </mediaobject>
</screenshot>
+</para>
+<para>
<itemizedlist>
<listitem>
- As on the <guilabel>Banking</guilabel> page, the memo field may select more than one
- column.
+<para>
+ As on the <guilabel>Banking</guilabel> page, you may select more than one
+ column for the Memo field
+</para>
</listitem>
<listitem>
+<para>
The <guilabel>Type/Action</guilabel> selector is to identify the column which
contains the action type, such as Buy, Sell, Dividend, etc.
+</para>
</listitem>
<listitem>
+<para>
The <guilabel>Price Fraction</guilabel> selector is to indicate the
fraction/multiplier for compatibility between imported and stored prices. For
instance, if the import file price is in cents, but your &kappname; account is
priced in dollars, select 0.01. Or, if your &kappname; data file pricing is
in dollars, and so is the CSV file being imported, then set <guilabel>Price
Fraction</guilabel> to 1.0.
+</para>
</listitem>
<listitem>
+<para>
Use the <guilabel>Fee Column</guilabel> selector if your file has a distinct
column for fees. Beware, though, that the fee might have been taken into
account in the price. If there is a fee, and it is a percentage figure,
rather than a value, click the <guilabel>Fee is percentage</guilabel> check
box. Note that on this page, this is the only field to explicitly include
"column" in the label, to emphasize that it is for the fee column, not for any
- actual fee. <!-- This is the only field to explicitly include "column" in the
- label, in case someone tries to enter the fee instead of the column
- number. -->
+ actual fee.
+</para>
+</listitem>
+
+<listitem>
+<para>
+ Below the column selectors are two areas for the security identity. Depending
+ upon your broker or financial institution, your file may contain entries for
+ only one or for several securities.
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ If the file contains transactions for just a single security, with the name
+ possibly in a header row, the name should be entered into the
+ <guilabel>Security Name</guilabel> box. The name you enter will be added to
+ the drop-down list for future use. You may subsequently wish to remove that
+ name from the list. If so, select it, then click the <guilabel>Hide
+ security</guilabel> button. This removes it only from this list, and has no
+ effect on your main &kappname; file.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ If the file includes transactions for several securities, each will be
+ identified by its ticker symbol in a column with further detail in another
+ column. Select those columns in the <guilabel>Symbol</guilabel> and
+ <guilabel>Detail</guilabel> selectors. It may be that a security has no
+ official symbol, and in this case a pseudo-symbol may be invented; this is not
+ a problem, as long as it uniquely identifies that security in the import file.
+ Sometimes the actual activity type is embedded in the detail column, possibly
+ prefixed by a standard text. For instance, if the field contains <quote>type:
+ dividend</quote>, enter into the <guilabel>Filter text</guilabel> box
+ <quote>type: </quote> including the trailing space.
+ </para>
+ </listitem>
+ </itemizedlist>
+</para>
</listitem>
</itemizedlist>
</para>
<para>
- The area below the column selectors is for the security identity, and there
- are two areas. Depending upon your broker or financial institution, your file
- may contain entries for several securities, each identified by its ticker
- symbol in a column with further detail in another column. It may be that there
- is no official symbol, and in this case a pseudo-symbol may be invented; this
- is not a problem, as long as it is unique to that security. The actual
- security type may be embedded in the detail column, and possibly prefixed by a
- standard text. For instance, if the field contains, say, 'type: dividend',
- enter into the <guilabel>Filter text</guilabel> box 'type: '. Or,the file may
- be contain transactions for just a single security, with the name possibly in
- a header row. In this case, the name should be entered into the
- <guilabel>Security Name</guilabel> box. The name you enter will be added to the
- drop-down list for future use. You may subsequently wish to remove that name
- from the list. If so, select it, then click the <guilabel>Hide
- security</guilabel> button. This removes it only from this list, and has no
- effect on your main &kappname; file. When all required fields are selected, the
- <guilabel>Next</guilabel> button will be enabled, and clicking it will advance
- the wizard.
+ When all required fields are selected,
+ the <guilabel>Next</guilabel> button will be enabled, and clicking it will
+ advance the wizard.
</para>
</sect3>
@@ -264,14 +342,14 @@
<title>CSV Import Wizard: Lines</title>
<para>
On this page, you indicate if any lines should be ignored at the beginning or
- end of the file, and the format of any date column.
+ end of the file. You also indicate the format of any date column.
<screenshot>
- <inlinemediaobject>
+ <mediaobject>
<imageobject>
<imagedata fileref="csvImporter_5.png" format="PNG" />
</imageobject>
- </inlinemediaobject>
+ </mediaobject>
</screenshot>
</para>
@@ -315,67 +393,146 @@
<sect3 id="details.impexp.csv.secsym">
<title>CSV Import Wizard: Securities and Symbols</title>
+
<para>
- note that I have not yet run the import wizard on an investment file - so this
- section is still subject to revision.
-</para>
-
-<para>
- For an Investment file, after the lines page has been accepted, another window
- will open. This will show the securities and symbols contained in the file.
- Ensure a symbol is shown, editing if necessary. Then for each security, edit
- the name in one of its rows, ensuring it matches exactly the existing security
- as specified in &kappname;. If the security name appears in the imported
- file, double click on it to select it, then copy and paste/edit to match,
- taking care if you have used a variation or abbreviation within
- &kappname;. Any line without a symbol will be treated as a brokerage-type
- checking item. If any transaction involves another account, ⪚, a checking
- or brokerage account for a received dividend or for making a payment, a
- message box will pop up for the account name to be entered for the transfer.
- If the investment account allows for, say, writing checks, you may enter an
- existing checking/brokerage account name. Similarly enter the column number
- containing the payee, if requested. If a mistake is made when entering the
- account name, the import will go ahead, but &kappname; will not recognize it,
- and will flag those transactions as missing a category assignment. If the
- required account name is rather long, just enter a few characters. The import
- will proceed but the transactions will be flagged by &kappname; as missing a
- category assignment, and the correct transfer account will need to be
- selected. Click <guilabel>OK</guilabel> when done. The import process then
- gets handed over to &kappname;
-</para>
-
-<para>
- For investment data, if any transaction involves another account, ⪚, a
- checking or brokerage account for a received dividend or for making a payment,
- a message box will pop up for the account name to be entered for the transfer.
- If the investment account allows for, say, writing checks, you may enter an
- existing checking/brokerage account name. Similarly enter the column number
- containing the payee, if requested. If a mistake is made when entering the
- account name, the import will go ahead, but &kappname; will not recognize it,
- and will flag those transactions as missing a category assignment. If the
- required account name is rather long, just enter a few characters. The import
- will proceed but the transactions will be flagged by &kappname; as missing a
- category assignment, and the correct transfer account will need to be
- selected.
+ For an Investment file, after the <guilabel>Lines</guilabel> page has been
+ accepted, you need to assure that each security in the file is matched to the
+ correct security in your &kappname; file, before import can proceed. At this
+ point, another window will open, showing the securities and symbols contained
+ in the import file. Note that unlike the data display in the main wizard
+ windows, the changes you make on this page <emphasis>are</emphasis> imported.
+</para>
+
+<para>
+ Completing this page is straightforward, if you consider these items:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Each row represents one transaction, and so it may appear there are
+ duplicate rows. This is OK.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Each security name must match exactly the existing security as specified
+ in &kappname;. If it does not match, it will be created as a new
+ security, which you probably do not want, unless it represents the
+ purchase of a new security.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A symbol must be shown for each security.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The <emphasis>only</emphasis> information on this page should be the
+ security symbol and name. Any other information initially shown (such as
+ date or activity type) is still in the actual import file, but should not
+ be shown here.
+ </para>
+ </listitem>
+ </itemizedlist>
+</para>
+
+<para>
+ You can edit a symbol or security name by double clicking the the cell. For
+ each security, if necessary, edit the name in one of its rows, If the correct
+ security name appears in the imported file, double click on it to select it,
+ then copy and paste/edit, taking care if you have used a variation or
+ abbreviation within &kappname;. If you edit a security name, that edit will
+ be applied to all rows with the same symbol.
+</para>
+
+<para>
+ Any line without a symbol will be treated as a brokerage-type checking
+ item. If any transaction involves another account, ⪚, a checking or
+ brokerage account for a received dividend or for making a payment, a message
+ box will pop up for the account name to be entered for the transfer. This
+ will generally be the Brokerage account you chose or created when you created
+ the Investment account. Similarly enter the column number containing the
+ payee, if requested. If a mistake is made when entering the account name, the
+ import will go ahead, but &kappname; will not recognize it, and will flag
+ those transactions as missing a category assignment. If the required account
+ name is rather long, just enter a few characters. The import will proceed but
+ the transactions will be flagged by &kappname; as missing a category
+ assignment, and you will need to select the correct transfer account after the
+ import. Click <guilabel>OK</guilabel> when done. The import process then gets
+ handed over to
+ &kappname;
+</para>
+
+<para>
+ If you have more that one transaction referring to the same security, you can
+ edit all of them at once, using multi-select. For instance, to add a symbol for
+ several lines, press and hold the <keysym>CTL</keysym> key, and in the symbol column,
+ select each transaction. While still holding the <keysym>CTL</keysym> key,
+ all those symbol cells should still be selected, so click on one and enter the
+ symbol. Click inside the window but outside that column, or hit
+ <keysym>Enter</keysym> (not <guilabel>OK</guilabel>). Now that those
+ transactions all have the same symbol, double click one detail entry and edit
+ the security name as you wish. Click elsewhere on the window (or
+ <keysym>Enter</keysym>) to accept the edit, which will then change all
+ those entries. The remaining entries will show the symbols picked up from the
+ transactions in the import file.
+</para>
+
+<para>
+ Now click <guilabel>OK</guilabel>, then <guilabel>Import</guilabel>. In the
+ <guilabel>Enter Account</guilabel> box, enter the name of a Brokerage/checking
+ account for funds. If you enter a valid name that account will be used. If
+ you can't be bothered entering a correct but long name, enter a few
+ characters. The import will accept that but the transactions in the ledger
+ after import will need a proper account to be selected. For the
+ <guilabel>Brokerage Item</guilabel> box, enter the number of the column
+ containing that detail. Now, on the <guilabel>Invalid transaction</guilabel>
+ box you may get a few entries because the activity type does not match the
+ qty/price/amount combination. On each message, click <guilabel>Select
+ Transaction Type</guilabel>, and a drop down will appear indicating valid
+ activity types for that combination of values.
+</para>
+
+<para>
+ Now the import has occurred and you're into KMM to select the investment
+ account to use. Then the checking account, if there were any brokerage type
+ transactions.
</para>
</sect3>
<sect3>
<title>CSV Import Wizard: Finish</title>
<para>
- At this stage, the final page of the wizard requires entering or confirming two
- items before the file can actually be imported.
+ On reaching the Final page, the plugin automatically validates the values. If
+ the numeric value column/s is/are highlighted in green, then the validation
+ was successful and all that is necessary is to click <guilabel>Import
+ CSV</guilabel> and control then passes to the main &kappname; program.
+ However, if the start and/or end lines are incorrectly set, or if the wrong
+ columns were selected, the highlighting will be in red, and an error message
+ will appear indicating where the error lies. The user will then need to click
+ <guilabel>Back</guilabel> to get to the relevant page to correct the error.
</para>
+<para>
+ It might also be that if debit and credit columns are in use, one of those
+ columns may legitimately contain no entries. This would mean that that column
+ has no decimal symbol present, and this would result in a warning. If you see
+ that this is the case, you may click either of the <guilabel>Accept</guilabel>
+ buttons (<guilabel>Accept this</guilabel> or <guilabel>Accept all</guilabel>.)
+</para>
+
<formalpara><title>Decimal Symbol</title>
<para>
- For each import, the decimal symbol must now be confirmed or selected, as it
- triggers a validation process on your monetary column selected on the
- <guilabel>Banking</guilabel> or <guilabel>Investing</guilabel> page. The
+ Another possible problem might be that the selected decimal symbol is
+ incorrect. Selecting the symbol to match the data should clear that error.
+ Normally, you should not need to change this selection. Note that the
<guilabel>Decimal Symbol</guilabel> must be set to match your file, not your
locale. If your locale setting has a different value, conversion will be seen
- to take place. In the display of the file in the upper part of the window,
- numeric fields are highlighted to show in green if this setting produces valid
+ to take place. The display of the file in the upper part of the window will
+ show numeric fields highlighted in green if the current setting produces valid
results, otherwise in red. The highlighting also reflects the <guilabel>Start
line</guilabel> and <guilabel>End line</guilabel> settings. There could be
warnings if any of the selected cells appear not to contain the selected
@@ -388,7 +545,7 @@
This does not need to be selected, as it is set automatically based on the
<guilabel>Decimal Symbol</guilabel>. It is provided purely as a guide. In
addition, the selector will be inactive if none of the values to be imported
- are greater or equal to 1000.
+ is greater or equal to 1000.
</para>
</formalpara>
@@ -438,14 +595,14 @@
<sect3>
<title>Adding Investment Activity Types</title>
<para>
- - Note - If you find that your investment statements keep including activity
- types that are not recognized, just add them to the section in the resource
- file. (See <link linkend="details.impexp.csv.config">below</link> for more
- details on this file.) For instance, in the [InvestmentSettings] section of
- the file, the BuyParam field includes entries for Purchase, Buy, New Inv, and
- Switch In. If you find a different one, add it to the correct list and
- restart the plugin. You may notice that there are similarities in the entries
- in different fields, and you may find that the wrong activity type is being
+ If you find that your investment statements keep including activity types that
+ are not recognized, just add them to the section in the resource file. (See
+ <link linkend="details.impexp.csv.config">below</link> for more details on
+ this file.) For instance, in the [InvestmentSettings] section of the file,
+ the BuyParam field includes entries for Purchase, Buy, New Inv, and Switch In.
+ If you find a different one, add it to the correct list and restart the
+ plugin. You may notice that there are similarities in the entries in
+ different fields, and you may find that the wrong activity type is being
selected. The plugin checks these lists in the following order: Shrsin, DivX,
Reinvdiv, Brokerage, Buy, Sell, Remove. Re-ordering the lists to suit this
does not work as might be expected, since the entries in the resource file get
@@ -455,17 +612,6 @@
</para>
</sect3>
-<caution>
-<para>
- Note that it may appear that the displayed entries in the upper section of
- the plugin window may be edited, and in fact they may, but the edits are not
- kept. The table is purely for display, not for editing. The input file is
- never altered by the plugin, and the data actually imported comes from the
- input file, not from the display. The one exception to this is covered in
- <link linkend="details.impexp.csv.secsym">Securities and Symbols</link> above
-</para>
-</caution>
-
<sect3 id="details.impexp.csv.config">
<title>Configuration of CSV importer plugin</title>
diff --git a/doc/details-impexp.docbook b/doc/details-impexp.docbook
index a60e069..ae23c9a 100644
--- a/doc/details-impexp.docbook
+++ b/doc/details-impexp.docbook
@@ -951,6 +951,39 @@
</sect2>
<sect2>
+<title>What is OFX</title>
+
+<para>
+ OFX stands for <quote>Open Financial Exchange</quote>. According to the
+ <ulink url="http://www.ofx.net/">OFX web site</ulink> <quote>Open Financial
+ Exchange (OFX) is a unified specification for the electronic exchange of
+ financial data between financial institutions, businesses and consumers via
+ the Internet. OFX is not a financial institution.</quote> The specification
+ defines formats for transfer of finacial data both by file and by direct
+ interchange.
+</para>
+
+<para>
+ Although the standard is much more complete and robust than QIF, there are
+ still variations, depending on the specific implementation used by any
+ institution. OFX files may have an extension of <quote>OFX</quote> or
+ <quote>QFX</quote> (upper or lower case); this does not imply any particular
+ difference in the content. The specification is based on XML, so the files
+ can be read in any text editor, but as whitespace is not relevant to the
+ content itself, some implementations do not use any, making it very hard for a
+ human to read.
+</para>
+
+<para>
+ Another site with good information is <ulink url="http:/ofxhome.com/">OFX
+ Home</ulink>. They maintain a directory of financial institutions that
+ support OFX. This can be useful if you have problems setting up <link
+ linkend="details.impexp.ofxdirectconnect">OFX direct connect.</link> They also
+ have a forum for discussions about OFX issues.
+</para>
+</sect2>
+
+<sect2>
<title>Importing an OFX file</title>
<para>
@@ -1049,6 +1082,22 @@
you may have to do some research to find them.
</para>
+<note>
+ <para>
+ Setting up OFX Direct Connect can sometimes be a challenge, especially as
+ the implementation at most institutions do not provide sufficient details in
+ error messages. One particular issue to note is that many institutuions
+ require you to change your password the first time you access it online
+ using this method. Unfortunately, at this time, the library that &kappname;
+ uses (libofx) does not have a way to interactively change a password. In
+ some cases, it is possible to get a techincal support person at the
+ institution to change the password for you. Until we are able to expand
+ this section with more detailed troubleshooting information, if you have
+ trouble getting this to work for you, you can ask for help on the &kappname;
+ developer list &devlist;.
+ </para>
+</note>
+
<para>
Once you have an account set up with online banking, go to the ledger for that
account. Then from the <guimenu>Account</guimenu> menu, choose <guimenuitem>Update
diff --git a/doc/details-investments.docbook b/doc/details-investments.docbook
index 42fa2c7..ec98500 100644
--- a/doc/details-investments.docbook
+++ b/doc/details-investments.docbook
@@ -4,8 +4,8 @@
<authorgroup>
<author> &Ace.Jones; &Ace.Jones.mail; </author>
</authorgroup>
- <date>2010-07-25</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2014-08-30</date>
+ <releaseinfo>4.7.01</releaseinfo>
</chapterinfo>
<title>Investments</title>
@@ -88,9 +88,22 @@
<title>Adding Investments to Your Account</title>
<para>
- To add individual Investments to your Investment Account, navigate to
- the <guibutton>Investments</guibutton> view, and choose the account where the
+ To add individual Investments to your Investment Account, navigate to the
+ <guibutton>Investments</guibutton> view, select the
+ <guibutton>Equities</guibutton> tab, and choose the account where the
investment is held from the <guilabel>Select Account</guilabel> drop-down box.
+
+ <screenshot>
+ <screeninfo>Investment View, Equities Tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="investments_summarytab.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Investment View, Equities Tab</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
</para>
<para>
@@ -199,13 +212,14 @@
<title>Editing an Investment</title>
<para>
- The Investment view window lists your current holdings in this account, along
- with their symbol, value, and price. Right-click the mouse on any of the
- investments to bring up the <guimenu>Investment Options</guimenu> context
- menu, where you have the option to add, edit, or delete individual investments
- from this account. Also, you can update the price of your investments here
- either manually or via their online source. In addition, it is possible to
- close an empty account, or to reopen a closed account.
+ The <guilabel>Euities</guilabel> tab of the Investments view window lists your
+ current holdings in this account, along with their symbol, value, quantity, and price.
+ Right-click the mouse on any of the investments to bring up the
+ <guimenu>Investment Options</guimenu> context menu, where you have the option
+ to add, edit, or delete individual investments from this account. Also, you
+ can update the price of your investments here either manually or via their
+ online source. In addition, it is possible to close an empty account, or to
+ reopen a closed account.
</para>
</sect1>
diff --git a/doc/details-ledgers.docbook b/doc/details-ledgers.docbook
index bcc5e49..7226c96 100644
--- a/doc/details-ledgers.docbook
+++ b/doc/details-ledgers.docbook
@@ -284,6 +284,19 @@
</sect3>
<sect3>
+<title>The Tag</title>
+
+<para>
+ Tags were introduced to &kappname; in version 4.7, and they are not yet fully
+ documented in this handbook. Tags are similar to Categories, and can be used
+ to maintain an orthogonal view to Categories. For example, you might have
+ a Category for each different type of automotice expenses, and then have a Tag
+ for each vehicle. As with Categories, you can select from the dropdown list, or type
+ a new Tag name, and be prompted if you want to create a new Tag with that name.
+</para>
+</sect3>
+
+<sect3>
<title>The Memo</title>
<para>
diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook
index 58c696e..9f83b94 100644
--- a/doc/details-settings.docbook
+++ b/doc/details-settings.docbook
@@ -696,8 +696,8 @@
<title>Foreground tab</title>
<para>
- Modify the foreground colors by clicking on the color button and opening a
- color select palette.
+ Modify any of the foreground colors by clicking on the color button and
+ opening a color select palette.
</para>
</sect2>
@@ -705,8 +705,17 @@
<title>Background tab</title>
<para>
- Modify the background colors by clicking on the color button and opening a
- color select palette.
+ Modify any of the background colors by clicking on the color button and
+ opening a color select palette.
+</para>
+
+<para>
+ Note the <guilabel>Use system colors</guilabel> checkbox at the top of the
+ tab. If this is checked, &kappname; uses colors provided by the system, such
+ as those associated with a selected theme, although the details depend on
+ which operating system and possibly which window system or display manager is
+ running. Very often, if you experience odd colors or odd combination of
+ colors, toggling this checkbox will help.
</para>
</sect2>
</sect1>
@@ -744,10 +753,13 @@
</sect1>
<sect1 id="details.settings.plugins">
-<title id="details.settings.plugins.title">Plugins</title>
+<title>Plugins</title>
<para>
- These options allow you to modify the behavior of any installed plugins.
+ These options allow you to modify the behavior of any installed plugins. Note
+ that the list of plugins displayed will depend on which plugins &kappname;
+ found when it started. It does not matter whether the plugin was compiled as
+ part of the application or added as a separate package.
<screenshot>
<screeninfo>Configure Plugins</screeninfo>
<mediaobject>
@@ -759,11 +771,12 @@
</textobject>
</mediaobject>
</screenshot>
- For most plugins, the only choice is to enable or disable it, although for
- each there is also an <guibutton>information</guibutton> (&infoicon;) button
- which will show the plugin version and author. Further information on
- configuring and using these plugins may be found in the separate sections for
- <link linkend="details.impexp.csv">CSV Import</link> and <link
+ For most plugins, the only choice is to enable or disable it, as indicated by
+ the checkbox next to the name of the plugin. In addition, there is also an
+ <guibutton>information</guibutton> (&infoicon;) button for each, which will
+ show the plugin version and author. Further information on configuring and
+ using these plugins may be found in the separate sections for <link
+ linkend="details.impexp.csv">CSV Import</link> and <link
linkend="details.impexp.ofx">OFX Import</link> plugins. It is also true for
the <link linkend="details.reconcile">Reconciliation report</link>, although
that report is only a minor part of the larger reconciliation process. The
@@ -779,13 +792,13 @@
transaction, with the layout controlled by an html template. You need to use a
template which is matched to your pre-printed checks. When you click on the
<guibutton>configure</guibutton> (&configicon;) button , the <guilabel>Print
- check</guilabel>configuration dialog is displayed. At the top is a text box
+ check</guilabel> configuration dialog is displayed. At the top is a text box
for the path to the selected template. To the right of that is a button which
brings up a file chooser, to select an alternative template file.
</para>
<para>
- A template file is an html file, which is used with specific strings to
+ A template file is an html file, in which specific strings are used to
reference the fields from the transaction and from the current account and
institution to show where they will be printed on the check. &kappname; is
shipped with some sample template files. You should either be able to use one
diff --git a/doc/details-tags.docbook b/doc/details-tags.docbook
index cc7463d..a146ef7 100644
--- a/doc/details-tags.docbook
+++ b/doc/details-tags.docbook
@@ -4,33 +4,17 @@
<authorgroup>
<author>&Cristian.Onet; &Cristian.Onet.mail;</author>
</authorgroup>
- <date>2014-08-23</date>
- <releaseinfo>4.7</releaseinfo>
+ <date>2014-08-30</date>
+ <releaseinfo>4.7.01</releaseinfo>
</chapterinfo>
-<title id="details.tags.title">Tags</title>
+<title>Tags</title>
<para>
The Tags screen provides detailed information about all the tags which are
applied to transactions. The Tags screen is split into two main
areas: a tags list and a detail area.
-</para>
-
-<para>
- The Tags screen allows for viewing the transactions for the selected tag and
- updating the tag's details.
-</para>
-
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="tags.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
+ </para>
<sect1 id="details.tags.list">
<title>Tags List</title>
@@ -38,54 +22,68 @@
<para>
A list of tags is on the left side of this screen. The tags list
is sorted alphabetically.
+
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="tags.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
+ </screenshot>
</para>
<sect2>
<title>Adding a Tag</title>
-
<para>
- To add a tag, right-click on any tag and choose
- <guimenuitem>New tag</guimenuitem>. This creates a new tag called
- <quote>New tag</quote>. Right-click on this tag and select
- <guimenuitem>Rename tag</guimenuitem> to enter the name of the new tag.
+ To add a tag, either click on the Add tag icon
+ <guiicon><inlinemediaobject><imageobject><imagedata
+ fileref="list-add.png"/></imageobject></inlinemediaobject></guiicon> or
+ right-click on any tag and choose <guimenuitem>New tag</guimenuitem>. This
+ creates a new tag called <quote>New tag</quote>. Right-click on this tag and
+ select <guimenuitem>Rename tag</guimenuitem> to enter the name of the new tag.
</para>
</sect2>
<sect2>
<title>Renaming a Tag</title>
-
<para>
- To rename a tag, simply right-click on the name, select
- <guimenuitem>Rename tag</guimenuitem> and the name becomes
- editable. Changing the name will affect the name in all the transactions in
- which it appears.
+ To rename a tag, either click on the tag name to select it and click on the
+ <guiicon>Rename tag</guiicon> (between the add and remove icons) or
+ right-click on the name and then select <guimenuitem>Rename tag</guimenuitem>.
+ The name then becomes editable. Changing the name will affect the name in all
+ the transactions in which it appears.
</para>
</sect2>
<sect2>
<title>Deleting a Tag</title>
+<para>
+ To remove a tag, either click on the Delete tag icon
+ <guiicon><inlinemediaobject><imageobject><imagedata
+ fileref="list-remove.png"/></imageobject></inlinemediaobject></guiicon> or
+ right-click the name and select <guimenuitem>Delete tag</guimenuitem>. If the
+ tag has any transactions, you will be presented with a dialog that allows you
+ to reassign them to a different tag.
+</para>
+<note>
<para>
- To remove a tag, right-click the name and select
- <guimenuitem>Delete tag</guimenuitem>. If the tag has any transactions,
- you will be presented with a dialog that allows you to reassign them to a
- different tag.
+ As Tags have just been introduced to &kappname; in version 4.7, none of the
+ methods for importing data are able to import tags. It is understood that
+ this is an important feature, and each import method is likely to introduce
+ it in an upcoming release.
</para>
+</note>
</sect2>
-
</sect1>
-<sect1 id="details.tags.details">
-<title>Tag Details</title>
-
+<sect1 id="details.tags.info">
+<title>Tagged transactions and Tag details</title>
<para>
- To view and edit the information associated with a particular tag,
- select the tag from the list and select the Details tab. To modify this
- information, edit the detail area directly and press the Update button when
- finished.
-</para>
+ To view the transactions or view and edit the information associated with a
+ particular tag, select the tag from the list and select the appropriate tab on
+ the right side of the dialog.
-<para>
<screenshot>
<screeninfo>The tag details tab</screeninfo>
<mediaobject>
@@ -98,6 +96,49 @@
</mediaobject>
</screenshot>
</para>
-</sect1>
+<sect2 id="details.tags.info.transactions">
+<title>Tagged transactions</title>
+<para>
+ To see a list of the transacitons associated with the selected tag, select the
+ <guilabel>Transactions</guilabel> tab. This list is similar to the list of
+ transactions for a Payee. You can double-click on a transaction, and you will
+ be taken to the ledger view of that transaction for the account in which the
+ transaction has been tagged.
+</para>
+</sect2>
+
+
+<sect2 id="details.tags.info.details">
+<title>Tag details</title>
+<para>
+ To view and edit the information associated with a particular tag, select the
+ <guilabel>Details</guilabel> tab.
+ <itemizedlist>
+ <listitem>
+ <para>
+ You can select the color used to highlight transactions with which this
+ tag has been asociated. If you click on the color bar, you will get a
+ color chooser dialog.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ To modify the notes associated with the tag, just edit the text in the
+ box.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ Clicking the <guilabel>Closed</guilabel> checkbox will not alter any
+ transactions already associated with the tag, but it will prevent
+ assigning the tag to any additional transactions.
+ </para>
+ </listitem>
+ </itemizedlist>
+ When you are done, don't forget to click the <guiicon>Update</guiicon> button, although you will
+ be prompted if you leave the dialog without havin done so.
+</para>
+</sect2>
+</sect1>
</chapter>
diff --git a/doc/faq.docbook b/doc/faq.docbook
index bc33955..67f34ca 100644
--- a/doc/faq.docbook
+++ b/doc/faq.docbook
@@ -21,6 +21,140 @@
<qandaset>
+<qandadiv><title>Installation and Startup Questions</title>
+
+<qandaentry>
+ <question>
+ <para>&kappname; crashes when I try to launch it.</para>
+ </question>
+ <answer>
+ <para>There are many reasons &kappname; might crash or give an error instead
+ of starting up normally. You first need to determine if the problem is with
+ the software or with your data. So, the first thing to try is to <link
+ linkend="firsttime.launch">launch &kappname;</link> without opening your data
+ file. If the application starts up, but crashes when you try to load your
+ data file, try loading an older copy of your file. (You did make a backup,
+ didn't you?)</para>
+ <para>If &kappname; crashes on startup without trying to load a data file,
+ there may be a problem with your installation. See the section on <link
+ linkend="installation">installing &kappname;</link> or the section on <link
+ linkend="firsttime.contact">getting help</link>.</para>
+ </answer>
+</qandaentry>
+
+<qandaentry>
+ <question>
+ <para>When I start KMyMoney I get a "Malformed URL" error. What's
+ wrong?</para>
+ </question>
+ <answer>
+ <para>Usually the reason for this is that you didn't run 'make install' as
+ root. This step actually copies all of the icons, and other files needed by
+ KMyMoney to run properly. If you did run this, make sure you passed the
+ correct prefix to cmake at the beginning of your compile. See the section on
+ <link linkend="installation.fromsource">compiling from source</link> for more
+ information.</para>
+ </answer>
+</qandaentry>
+
+<qandaentry>
+ <question>
+ <para>When I compile from source, all the icons show up as missing. What
+ did I do wrong?</para>
+ </question>
+ <answer>
+ <para>Usually the reason for this is that you didn't run 'make install' as
+ root. See the previous question/answer for more information.</para>
+ </answer>
+</qandaentry>
+
+<qandaentry>
+ <question>
+ <para>What options are useful to pass to cmake?</para>
+ </question>
+ <answer>
+ <para>The most important option is -DCMAKE_INSTALL_PREFIX. This specifies
+ where you want to install KMyMoney; it should be the same location where
+ &kde; is installed. In many distributions, cmake will find this location on
+ its own, but if it can't, you can use the command line tool
+ <command>kde4-config --prefix</command> to read out what the prefix should
+ be. For &RedHat;-based distributions, including Mandriva and Fedora, &kde; is
+ installed in <filename role="directory">/usr</filename>.</para>
+ <para>Another useful option is -DCMAKE_BUILD_TYPE. Normally this is not set,
+ but if it is set to Debug, it will allow you to build KMyMoney with debug
+ symbols, which help in trying to figure out crashes. This option is essential
+ if you are a developer and want to contribute.</para>
+ </answer>
+</qandaentry>
+
+<qandaentry>
+ <question>
+ <para>The Git version is broken! What do I do now?</para>
+ </question>
+ <answer>
+ <para>Usually the reason for this is that one of the developers made a change
+ to the code that requires a clean reconfigure. See the end of the section on
+ <link linkend="installation.fromsource">compiling from source</link> for
+ instructions. If you follow these steps carefully, and still have a problem
+ compiling, please post a message to the &kappname; Developers List at
+ &devlist;, and include the failed output of either the cmake or
+ make command.
+</para>
+ </answer>
+</qandaentry>
+
+<qandaentry>
+ <question>
+ <para>I compiled from source, but the version number in the Help->About
+ dialog no longer gets changed to show the latest git commit, like it used
+ to?</para>
+ </question>
+ <answer>
+ <para>You probably ran <command>$ make</command> without running <command>$
+ cmake</command> or <command>$ ccmake</command> first. If you update the
+ code, using <command>$ git pull</command>, one of those two commands is
+ necessary to put the updated version number/git commit in the right place.
+</para>
+ </answer>
+</qandaentry>
+
+<qandaentry>
+ <question>
+ <para>Will &kappname; work on my X/&ubuntu; desktop? Will &kappname; work
+ without a full KDE desktop?</para>
+ </question>
+ <answer>
+ <para>Yes, &kappname; will work without a full &kde; desktop, but you will
+ have to install the basic &kde; libraries first. The easiest way to do this
+ is to use <link linkend="installation.distribution">your distribution's
+ package management system</link>, which will handle these requirements
+ automatically. If you are going to install from source, you will probably
+ need development versions of those libraries; refer to these <link
+ linkend="installation.fromsource">instructions</link> for details.</para>
+ <para>There has been at least one report of an error message about a
+ &kappname; process which did not come from any &kappname; or &kde;
+ source. This is not necessarily bad, but it can be very difficult to
+ determine the actual cause.</para>
+ </answer>
+</qandaentry>
+
+</qandadiv>
+
+<qandadiv><title>Configuration Questions</title>
+
+<qandaentry>
+ <question>
+ <para>Can I change the start of the fiscal year, to match my tax year or accounting year?</para>
+ </question>
+ <answer>
+ <para>Yes, you can easily set the start of the year in the <link
+ linkend="details.settings.general.global">Global Options</link> section of
+ the <guilabel>Configure &kappname;</guilabel> dialog.</para>
+ </answer>
+</qandaentry>
+
+</qandadiv>
+
<qandadiv><title>Account and Transaction Questions</title>
<qandaentry>
@@ -135,118 +269,17 @@
</answer>
</qandaentry>
-</qandadiv>
-
-<qandadiv><title>Installation and Startup Questions</title>
-
-<qandaentry>
- <question>
- <para>&kappname; crashes when I try to launch it.</para>
- </question>
- <answer>
- <para>There are many reasons &kappname; might crash or give an error instead
- of starting up normally. You first need to determine if the problem is with
- the software or with your data. So, the first thing to try is to <link
- linkend="firsttime.launch">launch &kappname;</link> without opening your data
- file. If the application starts up, but crashes when you try to load your
- data file, try loading an older copy of your file. (You did make a backup,
- didn't you?)</para>
- <para>If &kappname; crashes on startup without trying to load a data file,
- there may be a problem with your installation. See the section on <link
- linkend="installation">installing &kappname;</link> or the section on <link
- linkend="firsttime.contact">getting help</link>.</para>
- </answer>
-</qandaentry>
-
<qandaentry>
<question>
- <para>When I start KMyMoney I get a "Malformed URL" error. What's
- wrong?</para>
- </question>
- <answer>
- <para>Usually the reason for this is that you didn't run 'make install' as
- root. This step actually copies all of the icons, and other files needed by
- KMyMoney to run properly. If you did run this, make sure you passed the
- correct prefix to cmake at the beginning of your compile. See the section on
- <link linkend="installation.fromsource">compiling from source</link> for more
- information.</para>
- </answer>
-</qandaentry>
-
-<qandaentry>
- <question>
- <para>When I compile from source, all the icons show up as missing. What
- did I do wrong?</para>
- </question>
- <answer>
- <para>Usually the reason for this is that you didn't run 'make install' as
- root. See the previous question/answer for more information.</para>
- </answer>
-</qandaentry>
-
-<qandaentry>
- <question>
- <para>What options are useful to pass to cmake?</para>
+ <para>Why can't I delete an account?</para>
</question>
<answer>
- <para>The most important option is -DCMAKE_INSTALL_PREFIX. This specifies
- where you want to install KMyMoney; it should be the same location where
- &kde; is installed. In many distributions, cmake will find this location on
- its own, but if it can't, you can use the command line tool
- <command>kde4-config --prefix</command> to read out what the prefix should
- be. For &RedHat;-based distributions, including Mandriva and Fedora, &kde; is
- installed in <filename role="directory">/usr</filename>.</para>
- <para>Another useful option is -DCMAKE_BUILD_TYPE. Normally this is not set,
- but if it is set to Debug, it will allow you to build KMyMoney with debug
- symbols, which help in trying to figure out crashes. This option is essential
- if you are a developer and want to contribute.</para>
- </answer>
-</qandaentry>
-
-<qandaentry>
- <question>
- <para>The Git version is broken! What do I do now?</para>
- </question>
- <answer>
- <para>Usually the reason for this is that one of the developers made a change
- to the code that requires a clean reconfigure. See the end of the section on
- <link linkend="installation.fromsource">compiling from source</link> for
- instructions. If you follow these steps carefully, and still have a problem
- compiling, please post a message to the &kappname; Developers List at
- &devlist;, and include the failed output of either the cmake or
- make command.
-</para>
- </answer>
-</qandaentry>
-
-<qandaentry>
- <question>
- <para>I compiled from source, but the version number in the Help->About
- dialog no longer gets changed to show the latest git commit, like it used
- to?</para>
- </question>
- <answer>
- <para>You probably ran <command>$ make</command> without running <command>$
- cmake</command> or <command>$ ccmake</command> first. If you update the
- code, using <command>$ git pull</command>, one of those two commands is
- necessary to put the updated version number/git commit in the right place.
-</para>
- </answer>
-</qandaentry>
-
-<qandaentry>
- <question>
- <para>Will &kappname; work on my X/&ubuntu; desktop? Will &kappname; work
- without a full KDE desktop?</para>
- </question>
- <answer>
- <para>Yes, &kappname; will work without a full &kde; desktop, but you will
- have to install the basic &kde; libraries first. The easiest way to do this
- is to use <link linkend="installation.distribution">your distribution's
- package management system</link>, which will handle these requirement
- automatically. If you are going to install from source, you will probably
- need development versions of those libraries; refer to these <link
- linkend="installation.fromsource">instructions</link> for details.</para>
+ <para>In order to delete an account, &kappname; can have no other references
+ to it. That means you must delete all transactions, or move them to another
+ account. If you still can't delete an account, there may be scheduled
+ transactions referring to that account, which may not be visible in the
+ ledger. You need to delete any future transactions and the schedule itself,
+ or switch them to a different account.</para>
</answer>
</qandaentry>
diff --git a/doc/firsttime.docbook b/doc/firsttime.docbook
index 07cfba2..85048db 100644
--- a/doc/firsttime.docbook
+++ b/doc/firsttime.docbook
@@ -198,6 +198,23 @@
<guiicon>
<inlinemediaobject>
<imageobject>
+ <imagedata fileref="mail-tagged.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Tags View</phrase>
+ </textobject>
+ </inlinemediaobject>
+ </guiicon>
+ Tags: Special accounts that provide an additional means to Categories for
+ you to group associated transactions.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guiicon>
+ <inlinemediaobject>
+ <imageobject>
<imagedata fileref="payees_view.png" format="PNG"/>
</imageobject>
<textobject>
@@ -515,7 +532,7 @@ transactions this is currently empty.</para>
<title>Creating accounts</title>
<para>
- You can create an account in one of two ways both of which are described here:
+ You can create an account in one of two ways, both of which are described here:
</para>
<variablelist>
@@ -535,6 +552,8 @@ transactions this is currently empty.</para>
<listitem>
<para>
To create an account using the accounts view click on the Accounts icon
+ <guiicon><inlinemediaobject><imageobject><imagedata
+ fileref="accounts_view.png"/></imageobject></inlinemediaobject></guiicon>
in the view selector and then right click on the Asset tree icon in the
right hand view and select <guimenuitem>New account</guimenuitem> from
the popup menu. The Asset tree holds all of your accounts that are an
@@ -590,9 +609,9 @@ transactions this is currently empty.</para>
<para>
To maintain <link linkend="details.schedules">schedules</link> click on the
- <guiicon><inlinemediaobject><imageobject><imagedata
- fileref="schedule_view.png"/></imageobject></inlinemediaobject>Schedules</guiicon>
- icon in the view selector.
+ Schedules icon <guiicon><inlinemediaobject><imageobject><imagedata
+ fileref="schedule_view.png"/></imageobject></inlinemediaobject></guiicon> in
+ the view selector.
</para>
</sect1>
@@ -602,8 +621,8 @@ transactions this is currently empty.</para>
<para>
To maintain <link linkend="details.categories">categories</link> click on the
<guiicon><inlinemediaobject><imageobject><imagedata
- fileref="categories_view.png"/></imageobject></inlinemediaobject>Categories</guiicon>
- icon in the view selector.
+ fileref="categories_view.png"/></imageobject></inlinemediaobject></guiicon>
+ Categories icon in the view selector.
</para>
<para>
@@ -612,14 +631,30 @@ transactions this is currently empty.</para>
</para>
</sect1>
+<sect1 id="firsttime.tags">
+<title>Tags</title>
+
+<para>
+ To maintain <link linkend="details.tags">tags</link> click on the Tags icon
+ <guiicon><inlinemediaobject><imageobject><imagedata
+ fileref="mail-tagged.png"/></imageobject></inlinemediaobject></guiicon> in the
+ view selector.
+</para>
+
+<para>
+ A full description of this topic can be found in the <link
+ linkend="details.tags">Tags</link> section.
+</para>
+</sect1>
+
<sect1 id="firsttime.payees">
<title>Payees</title>
<para>
- To maintain your list of payees click on the
+ To maintain your list of payees click on the Payees icon
<guiicon><inlinemediaobject><imageobject><imagedata
- fileref="payees_view.png"/></imageobject></inlinemediaobject>Payees</guiicon>
- icon in the view selector.
+ fileref="payees_view.png"/></imageobject></inlinemediaobject></guiicon> in the
+ view selector.
</para>
<para>
@@ -653,10 +688,10 @@ transactions this is currently empty.</para>
</para>
<para>
- The search dialog can be opened from the toolbar using the
+ The search dialog can be opened from the toolbar using the Find icon
<guiicon><inlinemediaobject><imageobject><imagedata
- fileref="transaction_find.png"/></imageobject></inlinemediaobject>Find</guiicon>
- icon or by selecting <guimenuitem>Find Transaction</guimenuitem> from the
+ fileref="transaction_find.png"/></imageobject></inlinemediaobject></guiicon>
+ or by selecting <guimenuitem>Find Transaction</guimenuitem> from the
<guimenu>Edit</guimenu> menu.
</para>
@@ -691,7 +726,6 @@ transactions this is currently empty.</para>
A full description of this topic can be found in the <link
linkend="details.reconcile">Reconciliation</link> section.
</para>
-
</sect1>
<sect1 id="firsttime.backup">
@@ -733,7 +767,7 @@ transactions this is currently empty.</para>
<para>
For a complete description of all the available line options, see the man page
- for &kappname; However, there are two special cases which we describe here.
+ for &kappname;. However, there are two special cases which we describe here.
</para>
<formalpara><title><command>kmymoney -n</command></title>
@@ -752,7 +786,85 @@ transactions this is currently empty.</para>
used to import a <link linkend="details.impexp.gnucash">GnuCash</link> file.
</para>
</formalpara>
+</sect1>
+
+<sect1 id="firsttime.newpc">
+<title>How to move &kappname; to a new computer</title>
+
+<sect2 id="firsttime.newpc.data">
+<title>Moving your data</title>
+
+<para>
+ If you get a new computer, it's very easy to move your data. In fact, all you
+ have to do is to copy your &kappname; data file. The name of the file is
+ shown in the title bar when &kappname; is running, it usually ends in .kmy.
+ The first time you run the application on the new computer you will have to
+ tell it where you have put the data file, either by running from the command
+ line, or from the
+ <menuchoice><guimenu>File</guimenu><guimenuitem>Open...</guimenuitem></menuchoice>
+ menu. You should even be able to move between &Windows;, &MacOS;, and &Linux; systems.
+</para>
+
+<para>
+ If you have encrypted your data file, be sure the appropriate software and
+ keys have also been set up on the new computer.
+</para>
+
+<para>
+ If your data is in an SQL database, refer to documentation for your database
+ software for guidance on migrating your data.
+</para>
+<para>
+ Note that this assumes you have installed the same version of &kappname; on the new
+ computer as you were running on the old computer. Installing a newer versiou should
+ also be safe, but you need to be aware of any issues related to that upgrade. Any such
+ issues should be noted in the release notes for the new version.
+</para>
+</sect2>
+
+<sect2 id="firsttime.newpc.settings">
+<title>Moving your settings</title>
+
+<para>
+ If you only move your data file to the new machine, as described in the
+ previous section, &kappname; will work correctly, but you will have lost any
+ settings you changed from the default on your old machine. To maintain these
+ settings, you also need to copy your configuration file. This file is called
+ <quote>kmymoneyrc</quote>. This file will be in a directory with other &kde;
+ application configuration files. On a &Linux; system, this will be in
+ <quote>$KDEHOME/share/config</quote> where <quote>$KDEHOME</quote> is usually
+ <quote>.kde4</quote> within your home directory.
+</para>
+
+<sect3 id="firsttime.newpc.settings.plugins">
+<title>Moving plugin settings</title>
+
+<para>
+ If you have run any &kappname; plugins, such as the csv importer or exporter,
+ it may also have created a conguration file in that same directory, such as
+ csvimporterrc or csvexporterrc. These should also be copied to the new
+ computer.
+</para>
+
+<para>
+ As with the main data file, this assumes the same version of the plugin on
+ both computers. Upgrades are generally safe, but if the functionality of the
+ plugin has changed greatly, it is advisable to carefully test using the old
+ configuration file, to be sure the plugin behaves as you expect.
+</para>
+
+<note>
+<para>
+ These instructions are solely for moving your &kappname; data and settings.
+ However, there may be important items which are stored by &kde; and not by
+ &kappname;, such as any passwords stored in kwallet. Moving other parts of
+ your &kde; setup is beyond the scope of this manual, although many of the
+ relevant files are also stored under <quote>$KDEHOME</quote>.
+</para>
+</note>
+</sect3>
+</sect2>
</sect1>
<sect1 id="firsttime.contact">
@@ -762,7 +874,9 @@ transactions this is currently empty.</para>
<title>Contacting the developers</title>
<para>
- You can contact the developers through their mailing list &devlist;.
+ For general questions or comments about &kappname;, there is a users' mailing
+ list &userlist;. In addition, you can contact the developers through their
+ mailing list &devlist;.
</para>
<para>
@@ -812,9 +926,12 @@ transactions this is currently empty.</para>
<para>
The <menuchoice><guimenu>Help</guimenu><guimenuitem>Report
Bug</guimenuitem></menuchoice> menu choice will fill this in automatically,
- but if you would prefer not to use this interface, we will need to know the
- version of &kappname; you're running, the version of &kde;, the name and
- version of your distribution, and the version of your kernel.
+ but if you would prefer not to use this interface, there are several items
+ you need to include in the report. We will need to know what operating
+ system you are using (&Linux;, &MacOS;, or &Windows;), the version of &kde;
+ and the version of &kappname; you're running, and either the version of
+ &MacOS; or &Windows; or the name and version of your &Linux; distribution
+ and the version of your kernel.
</para>
</formalpara>
diff --git a/doc/index.docbook b/doc/index.docbook
index e2c322e..ff6e688 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -161,6 +161,8 @@ and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element.
<year>2009</year>
<year>2010</year>
<year>2011</year>
+<year>2012</year>
+<year>2013</year>
<year>2014</year>
<holder>The &kappname; Development Team</holder>
</copyright>
@@ -177,7 +179,7 @@ Please respect the format of the date (YYYY-MM-DD) and of the version
Do NOT change these in the translation. -->
<date>2014-08-30</date>
-<releaseinfo>4.07.01</releaseinfo>
+<releaseinfo>4.7.01</releaseinfo>
<!-- Abstract about this handbook -->
diff --git a/doc/installation.docbook b/doc/installation.docbook
index 51ddf48..5efe269 100644
--- a/doc/installation.docbook
+++ b/doc/installation.docbook
@@ -196,9 +196,16 @@
the <ulink url="http://www.macports.com">MacPorts web site</ulink>.
</para>
<para>
- &kappname; is also reported to be available for &Windows;. This initiative is
- still a work in progress, and more information can be found at the <ulink
- url="http://windows.kde.org">KDE on Windows Initiative</ulink> page.
+ &kappname; is also available for &Windows;. This initiative is still a work
+ in progress, but great improvements have been made in the past year. For more
+ information about running &kde;, including &kappname; on &Windows; see the
+ <ulink url="http://windows.kde.org">KDE on Windows Initiative</ulink> page.
+ For a standalone installer that only installs &kappname; see the download link
+ on the right of the <ulink url="http://www.kmymoney.org">&kappname; home
+ page</ulink>. Note that the most recent version of this installer no longer
+ works on &Windows; XP. At the time of this release, it was not known if this
+ could be changed, as the issue was related to the tools used to build the
+ application, not the application itself.
</para>
<para>
diff --git a/doc/list-add.png b/doc/list-add.png
new file mode 100644
index 0000000..1e03be9
Binary files /dev/null and b/doc/list-add.png differ
diff --git a/doc/list-remove.png b/doc/list-remove.png
new file mode 100644
index 0000000..5a4d15b
Binary files /dev/null and b/doc/list-remove.png differ
diff --git a/doc/mail-tagged.png b/doc/mail-tagged.png
new file mode 100644
index 0000000..108fc7f
Binary files /dev/null and b/doc/mail-tagged.png differ
diff --git a/doc/makemostof.docbook b/doc/makemostof.docbook
index bbad73c..3c270b4 100644
--- a/doc/makemostof.docbook
+++ b/doc/makemostof.docbook
@@ -269,8 +269,19 @@
<title>Sub-Categories</title>
<para>
- Categories can be split into sub-categories, but the sub-category totals are
- not included in the higher level category total.
+ Categories can be split into sub-categories, but this relationship is only for
+ display purposes, as the sub-category totals are not included in the higher
+ level category total.
+</para>
+</sect2>
+
+<sect2 id="makingmostof.mapping.tags">
+<title>Tags</title>
+
+<para>
+ Tags are very similar to Categories, as they are also non-managed accounts
+ that do not have a value. However, unlike Categories, the use of Tags is
+ completely optional.
</para>
</sect2>
@@ -288,7 +299,7 @@
<title>Scheduled transactions</title>
<para>
- Where regular transactions occur, these can be set up against a
+ Where transactions occur on a regular basis, these can be set up against a
Schedule. Transactions are created from a schedule; any that are overdue can
be seen on the home page.
</para>
@@ -299,10 +310,11 @@
<title>Useful Tips</title>
<para>
- Unless you keep you money under the floorboards, you probably make use of one
- or more institutions where you have accounts which may be in credit or
- debit. In order to familiarize yourself with the way &kappname; works, choose
- an account you want to track of with &kappname; and select <menuchoice><guimenu>File</guimenu>
+ Unless you keep your money under your mattress or under the floorboards, you
+ probably make use of one or more institutions where you have accounts, which
+ may be in credit or debit. In order to familiarize yourself with the way
+ &kappname; works, choose an account you want to track with &kappname; and
+ select <menuchoice><guimenu>File</guimenu>
<guimenuitem>New</guimenuitem></menuchoice> in order
to set up an account file.
</para>
@@ -315,9 +327,9 @@
<para>
If you have some regular receipts into or outgoings from this account, go to
Payee and enter the names of both the payers and the payees involved; then go
- to Schedule and fill in a New Schedule for each transaction. If you haven't
- entered the payee or payer, &kappname; will offer you the opportunity to do
- this in the middle of entering the schedule.
+ to Schedule and fill in a New Schedule for each recurring transaction. If you
+ haven't entered the payee or payer, &kappname; will offer you the opportunity
+ to do this in the middle of entering the schedule.
</para>
<para>
More information about the kde-doc-english
mailing list