[office/kmymoney/5.1] doc: Various edits suggested by Antoni Bella Pérez.
Thomas Baumgart
null at kde.org
Sat Jul 11 10:09:24 BST 2020
Git commit 836568123f54c85d06b8c6a37c91dc47332259c4 by Thomas Baumgart, on behalf of Jack Ostroff.
Committed on 11/07/2020 at 09:07.
Pushed by tbaumgart into branch '5.1'.
Various edits suggested by Antoni Bella Pérez.
AUTHOR: Antoni Bella Pérez <antonibella5 at yahoo.com>
M +3 -3 doc/credits.docbook
M +28 -34 doc/details-accounts.docbook
M +35 -33 doc/details-budgets.docbook
M +6 -8 doc/details-currencies.docbook
M +64 -61 doc/details-database.docbook
M +2 -2 doc/details-forecast.docbook
M +11 -11 doc/details-formats.docbook
M +63 -56 doc/details-impexp-csv.docbook
M +91 -88 doc/details-impexp.docbook
M +6 -8 doc/details-institutions.docbook
M +9 -10 doc/details-investments.docbook
M +8 -9 doc/details-ledgers.docbook
M +5 -5 doc/details-loans.docbook
M +5 -6 doc/details-reconciliation.docbook
M +1 -1 doc/details-reports.docbook
M +3 -4 doc/details-schedules.docbook
M +13 -13 doc/details-settings.docbook
M +4 -5 doc/details-tags.docbook
M +13 -11 doc/details-widgets.docbook
M +3 -3 doc/faq.docbook
M +48 -50 doc/firsttime.docbook
M +2 -0 doc/index.docbook
M +4 -5 doc/makemostof.docbook
M +3 -3 doc/reference.docbook
https://invent.kde.org/office/kmymoney/commit/836568123f54c85d06b8c6a37c91dc47332259c4
diff --git a/doc/credits.docbook b/doc/credits.docbook
index 0ce8650b0..d6bcbb4e6 100644
--- a/doc/credits.docbook
+++ b/doc/credits.docbook
@@ -8,7 +8,7 @@
<title>Credits</title>
<para>
- Program Copyright © 2000-2019 The KMyMoney Development Team
+ Program Copyright © 2000-2019 The &kmymoney; Development Team
</para>
<para>
@@ -16,7 +16,7 @@
</para>
<para>
- Documentation Copyright © 2000-2019 The KMyMoney Development Team
+ Documentation Copyright © 2000-2019 The &kmymoney; Development Team
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
@@ -160,7 +160,7 @@
<listitem>
<formalpara>
<title>Tony Bloomfield &Tony.Bloomfield.mail;</title>
- <para>GnuCash Importer. Database support.</para>
+ <para>&gnucash; Importer. Database support.</para>
</formalpara>
</listitem>
diff --git a/doc/details-accounts.docbook b/doc/details-accounts.docbook
index 3714cd46f..2a16c6143 100644
--- a/doc/details-accounts.docbook
+++ b/doc/details-accounts.docbook
@@ -60,25 +60,21 @@
<sect1 id="details.accounts.create">
<title>Creating an Account</title>
-<para>
- <emphasis>
- NOTE: You must have a file open before you can create a new account. If you
+<note><para>
+ You must have a file open before you can create a new account. If you
do not have an existing file, you will need to <link
linkend="firsttime.3">create one</link>.
- </emphasis>
-</para>
+</para></note>
<para>
- To create a new account, you can either select
- <menuchoice><guimenu>Account</guimenu><guimenuitem>New
- account...</guimenuitem></menuchoice> from the menu or choose the New
- account... icon <guiicon><inlinemediaobject><imageobject><imagedata
- fileref="newacct.png" format="PNG"/></imageobject><textobject>
- <phrase>New</phrase></textobject></inlinemediaobject></guiicon> from the
- toolbar. You can also create an account from the Accounts view; click on the
- Accounts icon in the view selector and then right click on the Asset or
- Liability tree icon and select <guimenuitem>New account...</guimenuitem> from
- the popup menu.
+ To create a new account, you can either select the <menuchoice>
+ <guimenu>Account</guimenu><guimenuitem>New account...</guimenuitem></menuchoice>
+ menu item or choose the <guiicon><inlinemediaobject><imageobject><imagedata
+ fileref="newacct.png" format="PNG"/></imageobject><textobject></inlinemediaobject>
+ </guiicon> new account icon from the toolbar. You can also create an account
+ from the Accounts view; click on the Accounts icon in the view selector and
+ then right click on the Asset or Liability tree icon and select <guimenuitem>New
+ account...</guimenuitem> from the popup menu.
</para>
<sect2 id="details.accounts.create.institution">
@@ -371,8 +367,8 @@
<para>
The next three items are for handling Loans on which you've already made
- payments. If you select Yes in the <guilabel>"Did you make/receive any
- payments yet?"</guilabel> dropdown, you can then select whether you want to
+ payments. If you select <guibutton>Yes</guibutton> in the <guilabel>Did you make/receive any
+ payments yet?</guilabel> dropdown, you can then select whether you want to
record all payments or just those from the beginning of the current year. If
you want to record from the beginning of the current year, you are than asked
to input the balance at the beginning of this year.
@@ -393,7 +389,7 @@
<para>
Finally, enter information about how the interest rate varies. If the loan is
fixed-rate there is nothing to do. If the rate varies, select Variable in
- <guilabel>"Type of interest rate"</guilabel> and then enter the interval
+ <guilabel>Type of interest rate</guilabel> and then enter the interval
between interest rate changes and the date the first change of interest rate
is due: &kmymoney; will ask you to update the interest rate when that date
arrives. Click <guibutton>Next</guibutton> to continue.
@@ -582,14 +578,14 @@
</para>
<para>
- If you re-financed an existing Loan, check the <guilabel>"Refinance existing
- loan"</guilabel> check box, select the Loan account and &kmymoney; will create
+ If you re-financed an existing Loan, check the <guilabel>Refinance existing
+ loan</guilabel> check box, select the Loan account and &kmymoney; will create
a transfer transaction paying off the existing loan.
</para>
<para>
- If you don't want to create the payout transaction, check the <guilabel>"Do
- not create payout transaction"</guilabel> check box.
+ If you don't want to create the payout transaction, check the <guilabel>Do
+ not create payout transaction</guilabel> check box.
</para>
</sect2>
@@ -654,10 +650,9 @@
<guibutton>Cancel</guibutton> to abandon creating the new account.
</para>
-<para>
- NOTE: The Type and Currency cannot at present be changed after the account is
- created.
-</para>
+<note><para>
+ The Type and Currency cannot at present be changed after the account is created.
+</para></note>
</sect2>
</sect1>
@@ -667,8 +662,8 @@
<para>
To open an account in the Ledger view you can either click on the link to the
account from the Home view, or click on the <guiicon><inlinemediaobject>
- <imageobject> <imagedata fileref="ledgers_view.png" /> </imageobject>
- </inlinemediaobject>Ledgers</guiicon> icon in the view selector and select the
+ <imageobject><imagedata fileref="ledgers_view.png" format='PNG'/></imageobject>
+ </inlinemediaobject></guiicon> ledgers icon in the view selector and select the
account in the drop down box at the top of the view. Alternatively, in the
<guiicon>Account</guiicon> view, either double-click the account entry or
right click and select <guimenuitem>Open ledger</guimenuitem>.
@@ -680,9 +675,8 @@
<para>
To edit a particular account, right-click that account and choose
- <menuchoice><guimenuitem>Edit account...</guimenuitem></menuchoice> or
- with that account open in the ledger, select
- <menuchoice><guimenu>Account</guimenu><guimenuitem>Edit
+ <guimenuitem>Edit account...</guimenuitem> or with that account open in the
+ ledger, select <menuchoice><guimenu>Account</guimenu><guimenuitem>Edit
Account...</guimenuitem></menuchoice>. A window will pop-up with several
tabs, each allowing you to view and change certain information about the
account. For more information on any of these details, see the section on
@@ -760,7 +754,7 @@
<itemizedlist>
<listitem>
<para>
- <emphasis>Account Details</emphasis> This shows the status of the
+ <emphasis>Account Details</emphasis>: This shows the status of the
online connection, the bank/broker and account number, and allows
you to store or change the password for the online account.
</para>
@@ -768,7 +762,7 @@
<listitem>
<para>
- <emphasis>OFX Details</emphasis> Here you can adjust certain details
+ <emphasis>OFX Details</emphasis>: Here you can adjust certain details
&kmymoney; uses when it establishes an OFX connection with the
institution. This should only be necessary if you get certain
errors when you first set up the online account, or perhaps if your
@@ -778,7 +772,7 @@
<listitem>
<para>
- <emphasis>Import Details</emphasis> Here you can tell &kmymoney;
+ <emphasis>Import Details</emphasis>: Here you can tell &kmymoney;
what to use as the start date for the import. In addition, starting
with version 4.6, you can choose whether the payee's name is based
on the PAYEEID, NAME, or MEMO field of the imported transaction.
diff --git a/doc/details-budgets.docbook b/doc/details-budgets.docbook
index caf54a4b5..79b40d4a6 100644
--- a/doc/details-budgets.docbook
+++ b/doc/details-budgets.docbook
@@ -34,13 +34,13 @@
<varlistentry>
<term>Yearly</term>
- <listitem><para>specify a single value to divide evenly across each month in
+ <listitem><para>Specify a single value to divide evenly across each month in
the Budget</para></listitem>
</varlistentry>
<varlistentry>
<term>Individual</term>
- <listitem><para>specify separate values for each month.</para>
+ <listitem><para>Specify separate values for each month.</para>
<para>This is used for income and expenses spread irregularly through the
year.</para></listitem>
</varlistentry>
@@ -105,7 +105,7 @@
<para>
Values from the selected Budget are displayed to the right. To select a
different Budget you can click on the Budget in the list. Alternatively, when
- the list has focus, you can select a different Budget using the up and down
+ the list has focus, you can select a different Budget using the &Up; and &Down;
keys. If you have made changes to a Budget and then select a different budget
&kmymoney; will ask you whether you want to save or discard the changes.
</para>
@@ -139,7 +139,7 @@
<varlistentry>
<term>Delete</term>
<listitem>
- <para>Delete the selected Budget</para>
+ <para>Delete the selected Budget.</para>
</listitem>
</varlistentry>
@@ -286,14 +286,14 @@
<!-- It would be nice to include the actual button icons here to confirm
which buttons are referred to. -->
<para>
- Below the Accounts List are several controls. The Update and Revert buttons
- are described further below. The collapse and expand buttons collapse or
- expand the entire Accounts List.
+ Below the Accounts List are several controls. The <guibutton>Update</guibutton>
+ and <guibutton>Revert</guibutton> buttons are described further below. The collapse
+ and expand buttons collapse or expand the entire Accounts List.
</para>
<para>
- The Accounts List can be filtered in two ways. Checking the "Hide
- unused categories" checkbox hides any Categories for which no value
+ The Accounts List can be filtered in two ways. Checking the <guilabel>Hide
+ unused categories</guilabel> checkbox hides any Categories for which no value
has been assigned to the Category or any of its Subcategories. To
the right of this, is an unlabelled text box. Only categories which
include whatever is typed in this box are listed, but their parent
@@ -301,8 +301,8 @@
</para>
<para>
- Note that changing either the "Hide unused budget categories" or the
- filter value is likely to change the list of Categories display.
+ Note that changing either the <guilabel>Hide unused budget categories</guilabel>
+ or the filter value is likely to change the list of Categories display.
You may need to re-expand the list to see all the Categories that
should be displayed with the current settings.
</para>
@@ -330,7 +330,7 @@
<varlistentry>
<term>Total</term>
<listitem>
- <para>Displays the total yearly value assigned to the Category</para>
+ <para>Displays the total yearly value assigned to the Category.</para>
</listitem>
</varlistentry>
@@ -353,27 +353,27 @@
Category.</para>
<para>In general, for you will either check this box and assign
- values to the Category and not to any of its Subcategories, or
- not check the box, and assign values to the Subcategories but
- not the Category. If any Subcategories have assigned amounts
- when this box is checked, then those amounts are rolled up to
- the Category.</para>
+ values to the Category and not to any of its Subcategories, or
+ not check the box, and assign values to the Subcategories but
+ not the Category. If any Subcategories have assigned amounts
+ when this box is checked, then those amounts are rolled up to
+ the Category.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Clear</term>
<listitem>
- <para>The Clear button resets the budgeted category value or values to
- zero.</para>
+ <para>The <guibutton>Clear</guibutton> button resets the budgeted
+ category value or values to zero.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Period</term>
<listitem>
- <para>The Period radio buttons allow you to select the period for which
- the value applies</para>
+ <para>The <guilabel>Period</guilabel> radio buttons allow you to
+ select the period for which the value applies</para>
<variablelist>
<varlistentry>
@@ -416,32 +416,34 @@
<title>Update and Revert</title>
<para>
- For performance reasons, changes made to a Budget are not saved
- immediately. Instead, they must first be stored using the Update
- button and then permanently saved using the &kmymoney; Save.
+ For performance reasons, changes made to a Budget are not saved immediately.
+ Instead, they must first be stored using the <guibutton>Update</guibutton>
+ button and then permanently saved using the <guibutton>Save</guibutton> button.
</para>
<para>
- When a Budget's values are first modified, the Update and Revert buttons are
- enabled. Multiple changes can be made to the Budget. Pressing Update will
- store the changes and disable the Update and Revert buttons.
+ When a Budget's values are first modified, the <guibutton>Update</guibutton>
+ and <guibutton>Revert</guibutton> buttons are enabled. Multiple changes can be
+ made to the Budget. Pressing <guibutton>Update</guibutton> will store the changes
+ and disable this buttons.
</para>
<para>
- The &kmymoney; Save only saves changes that have been stored using the Update
- button. Thus, if you have modified a Budget but not yet stored the changes
- &kmymoney; Save will not affect the modified Budget and the Update and Revert
+ The <guibutton>Save</guibutton> button only saves changes that have been stored
+ using the <guibutton>Update</guibutton> button. Thus, if you have modified a Budget
+ but not yet stored the changes <guibutton>Save</guibutton> button will not affect
+ the modified Budget and the <guibutton>Update</guibutton> and <guibutton>Revert</guibutton>
buttons remain enabled.
</para>
<para>
Revert undoes any changes made to a Budget since the last Update and disables
- the Update and Revert buttons.
+ the <guibutton>Update</guibutton> and <guibutton>Revert</guibutton> buttons.
</para>
<para>
- Changes stored using Update but not yet saved using &kmymoney; Save can only
- be reverted by reloading the &kmymoney; file.
+ Changes stored using <guibutton>Update</guibutton> but not yet saved using
+ <guibutton>Save</guibutton> can only be reverted by reloading the &kmymoney; file.
</para>
</sect2>
</sect1>
diff --git a/doc/details-currencies.docbook b/doc/details-currencies.docbook
index e2bdaf83c..ae6a1870e 100644
--- a/doc/details-currencies.docbook
+++ b/doc/details-currencies.docbook
@@ -55,16 +55,14 @@
</para>
<para>
- To manually add a currency, select
+ To manually add a currency, select the
<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
+ menu item to display the <guilabel>Currencies</guilabel> dialog, as shown above. Right
+ click on any existing currency and select <guimenuitem>New currency</guimenuitem>
+ from the <guimenu>Currency Options</guimenu> 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>.
+ <keycap>F2</keycap> or right click and select <guimenuitem>Rename currency</guimenuitem>.
</para>
</sect2>
</sect1>
@@ -109,7 +107,7 @@
The price database editor allows you to enter exchange rates between
currencies or prices for investments. You can pull it up using the
<menuchoice><guimenu>Tools</guimenu><guimenuitem>Prices...</guimenuitem></menuchoice>
- menu option.
+ menu item.
</para>
<para>
diff --git a/doc/details-database.docbook b/doc/details-database.docbook
index 72a4e51ce..64766a51b 100644
--- a/doc/details-database.docbook
+++ b/doc/details-database.docbook
@@ -19,8 +19,8 @@
As of release 1.0, &kmymoney; allows you to hold your data in a relational
database. One of the advantages of using this industry-standard format is that
it may allow you to view your data using one of the graphic front ends such as
- OpenOffice.org<trademark class="copyright"/> or LibreOffice<trademark
- class="copyright"/>, perhaps in some format that &kmymoney; currently doesn't
+ <trademark>OpenOffice.org</trademark> or <trademark>LibreOffice</trademark>,
+ perhaps in some format that &kmymoney; currently doesn't
provide. Also, a little knowledge of SQL (Structured Query Language, the
language used world-wide to access relational databases) should enable you
more easily to export data to an external program, for example, a budgeting
@@ -36,9 +36,9 @@
Software as part of their &Qt; programming system. This module supports a
number of different database systems through a collection of drivers. Among
the more popular open-source systems for which drivers are available are
- MySQL<trademark class="registered"/>, SQLite (version 3 and upwards only), and PostgreSQL. The module also
- supports the 'heavier', more industrial, systems such as Oracle<trademark
- class="registered"/> and IBM DB2<trademark class="registered"/>.
+ <trademark>MySQL</trademark>, SQLite (version 3 and upwards only), and PostgreSQL.
+ The module also supports the 'heavier', more industrial, systems such as <trademark
+ class="registered">Oracle</trademark> and IBM <trademark class="registered">DB2</trademark>.
</para>
<para>
@@ -56,7 +56,7 @@
corresponding &Qt; driver module. Most distributions will include driver
modules for the more popular databases. Otherwise, check with the <ulink
url="https://www.qt.io/">&Qt; software web site</ulink> and search for
- 'SQL drivers'
+ 'SQL drivers'.
</para>
<note>
@@ -107,9 +107,10 @@
database layout changes, you will need permission (also called privileges) to
create and alter tables and views (see next paragraph). There may be different
names for the permission/privilege in different systems, but something like
- CREATE and ALTER should be commonplace. For normal running, you will need to
- be able to read and write records; these are normally defined in SQL as
- SELECT, INSERT, UPDATE, and DELETE permissions.
+ <literal>CREATE</literal> and <literal>ALTER</literal> should be commonplace.
+ For normal running, you will need to be able to read and write records; these
+ are normally defined in SQL as <literal>SELECT</literal>, <literal>INSERT</literal>,
+ <literal>UPDATE</literal>, and <literal>DELETE</literal> permissions.
</para>
</sect3>
@@ -160,8 +161,8 @@
This box lists all &Qt; SQL drivers installed on your system. Select the
driver for your database type. If the one you want is not in the list, you
need to install the appropriate driver. See your distribution documentation,
- or visit the <ulink url="https://www.qt.io/" type="">&Qt; software web
- site</ulink> and search for 'SQL drivers'.
+ or visit the <ulink url="https://www.qt.io/">&Qt; software web site</ulink>
+ and search for 'SQL drivers'.
</para>
</sect3>
@@ -181,13 +182,12 @@
<sect3>
<title>Database name (others)</title>
<para>
- The default database name is KMyMoney, but you may choose some other name if
- you like.
- For some database types, &kmymoney; may not be able to create the
- database, so it must be pre-created using the appropriate administrative
- procedure. However, &kmymoney; will usually be able to create all table structures where
- necessary. If not, you can create them yourself. See <link
- linkend="details.database.generatesql">Manual Database Creation</link> for more information.
+ The default database name is <literal>KMyMoney</literal>, but you may choose some other
+ name if you like. For some database types, &kmymoney; may not be able to create the
+ database, so it must be pre-created using the appropriate administrative procedure.
+ However, &kmymoney; will usually be able to create all table structures where necessary.
+ If not, you can create them yourself. See <link linkend="details.database.generatesql">Manual
+ Database Creation</link> for more information.
</para>
</sect3>
@@ -230,8 +230,8 @@
subsequent changes to your data are saved only in the database, not in the
file. This means that you can use the file as a backup or snapshot of your
data at a particular time. To make a new backup like this, open your
- database, do <menuchoice><guimenu>File</guimenu><guimenuitem>Save
- As...</guimenuitem></menuchoice>, giving an appropriate file name. Remember
+ database, choose the <menuchoice><guimenu>File</guimenu><guimenuitem>Save
+ As...</guimenuitem></menuchoice> menu item, giving an appropriate file name. Remember
to re-open your database, so &kmymoney; does not continue to use the file.
</para>
</note>
@@ -239,8 +239,8 @@
<para>
To access your data in other formats, you will need to know a little about how
it is held in relational databases. By far the easiest way to get a feel for
- this is to open the database in a front-end such as OpenOffice.org. This
- provides a list of the various tables which make up the database, and
+ this is to open the database in a front-end such as <trademark>OpenOffice.org</trademark>.
+ This provides a list of the various tables which make up the database, and
enables you to see the layout of each of them.
</para>
@@ -274,10 +274,10 @@
<para>Institutions and Accounts</para>
</entry>
<entry valign="top">
- <para>kmmInstitutions.id</para>
+ <para><literal>kmmInstitutions.id</literal></para>
</entry>
<entry valign="top">
- <para>kmmAccounts.institutionId</para>
+ <para><literal>kmmAccounts.institutionId</literal></para>
</entry>
</row>
<row>
@@ -285,10 +285,10 @@
<para>Accounts Parent/Child</para>
</entry>
<entry valign="top">
- <para>kmmAccounts.id</para>
+ <para><literal>kmmAccounts.id</literal></para>
</entry>
<entry valign="top">
- <para>kmmAccounts.parentId</para>
+ <para><literal>kmmAccounts.parentId</literal></para>
</entry>
</row>
<row>
@@ -296,10 +296,10 @@
<para>Transactions and Splits (see Note 1)</para>
</entry>
<entry valign="top">
- <para>kmmTransactions.id</para>
+ <para><literal>kmmTransactions.id</literal></para>
</entry>
<entry valign="top">
- <para>kmmSplits.transactionId</para>
+ <para><literal>kmmSplits.transactionId</literal></para>
</entry>
</row>
<row>
@@ -307,10 +307,10 @@
<para>Accounts and Splits</para>
</entry>
<entry valign="top">
- <para>kmmAccounts.id</para>
+ <para><literal>kmmAccounts.id</literal></para>
</entry>
<entry valign="top">
- <para>kmmSplits.accountId</para>
+ <para><literal>kmmSplits.accountId</literal></para>
</entry>
</row>
<row>
@@ -318,10 +318,10 @@
<para>Payees and Splits</para>
</entry>
<entry valign="top">
- <para>kmmPayees.id</para>
+ <para><literal>kmmPayees.id</literal></para>
</entry>
<entry valign="top">
- <para>kmmSplits.payeeId</para>
+ <para><literal>kmmSplits.payeeId</literal></para>
</entry>
</row>
<row>
@@ -329,10 +329,10 @@
<para>Schedules and Transactions</para>
</entry>
<entry valign="top">
- <para>kmmSchedules.id</para>
+ <para><literal>kmmSchedules.id</literal></para>
</entry>
<entry valign="top">
- <para>kmmTransactions.id</para>
+ <para><literal>kmmTransactions.id</literal></para>
</entry>
</row>
<row>
@@ -340,21 +340,21 @@
<para>Transactions and Currencies</para>
</entry>
<entry valign="top">
- <para>kmmTransactions.currencyId</para>
+ <para><literal>kmmTransactions.currencyId</literal></para>
</entry>
<entry valign="top">
- <para>kmmCurrencies.ISOCode</para>
+ <para><literal>kmmCurrencies.ISOCode</literal></para>
</entry>
</row>
<row>
<entry valign="top">
- <para>Accounts and Securities (see Note 2)</para>
+ <para><literal>Accounts and Securities (see Note 2)</para>
</entry>
<entry valign="top">
- <para>kmmAccounts.currencyId</para>
+ <para><literal>kmmAccounts.currencyId</literal></para>
</entry>
<entry valign="top">
- <para>kmmSecurities.id</para>
+ <para><literal>kmmSecurities.id</literal></para>
</entry>
</row>
<row>
@@ -362,10 +362,10 @@
<para>Securities and Prices</para>
</entry>
<entry valign="top">
- <para>kmmSecurities.id</para>
+ <para><literal>kmmSecurities.id</literal></para>
</entry>
<entry valign="top">
- <para>kmmPrices.fromId or kmmPrices.toId</para>
+ <para><literal>kmmPrices.fromId</literal> or <literal>kmmPrices.toId</literal></para>
</entry>
</row>
<row>
@@ -373,10 +373,10 @@
<para>Currency Rates</para>
</entry>
<entry valign="top">
- <para>kmmCurrencies.ISOCode</para>
+ <para><literal>kmmCurrencies.ISOCode</literal></para>
</entry>
<entry valign="top">
- <para>kmmPrices.fromId or kmmPrices.toId</para>
+ <para><literal>kmmPrices.fromId</literal> or <literal>kmmPrices.toId</literal></para>
</entry>
</row>
</tbody>
@@ -408,13 +408,14 @@
<para>
Monetary amounts and share values are shown both in numerator/denominator
- format, and, with a field name suffixed with 'Formatted', in the form as shown
- on your screens.
+ format, and, with a field name suffixed with '<literal>Formatted</literal>',
+ in the form as shown on your screens.
</para>
<para>
Similarly, some fields, such as account type appear both as a numeric code,
- and in a field suffixed 'String' in the form and language of the application.
+ and in a field suffixed '<literal>String</literal>' in the form and language
+ of the application.
</para>
</sect3>
@@ -437,9 +438,9 @@
Most database systems allow you to store commonly used queries and procedures,
and in some cases, these may be held as tables or other objects within your
database itself. As you will have guessed from the above, all the tables used
- by &kmymoney; begin with the lowercase letters 'kmm'. This standard will be
- maintained, and only tables beginning with these letters will be
- updated. Thus, provided you avoid these in the naming of your queries &etc;,
+ by &kmymoney; begin with the lowercase letters '<literal>kmm</literal>'. This
+ standard will be maintained, and only tables beginning with these letters will
+ be updated. Thus, provided you avoid these in the naming of your queries &etc;,
you should not experience any problems.
</para>
</sect3>
@@ -461,18 +462,20 @@
to standard SQL usage, or support may be introduced for new systems which have not been fully tested in &kmymoney;.
</para>
<para>
- Prior to using this facility, you should try just creating the database entry itself (&ie; with the CREATE DATABASE
- statement). Provided the database exists, &kmymoney; may well be able to create the tables, &etc; in the normal
- database save procedure described above.
+ Prior to using this facility, you should try just creating the database
+ entry itself (&ie; with the <literal>CREATE DATABASE</literal> statement).
+ Provided the database exists, &kmymoney; may well be able to create the
+ tables, &etc; in the normal database save procedure described above.
</para>
</sect3>
<sect3>
<title>Generating the SQL</title>
<para>
- If this fails, it is possible to generate the basic SQL commands needed to create the various tables, views and indexes
- required by the application. Select <guimenuitem>Generate Database SQL</guimenuitem> from the
- <guimenu>Tools</guimenu> menu. This will present the following dialog:
+ If this fails, it is possible to generate the basic SQL commands needed to
+ create the various tables, views and indexes required by the application.
+ Select the <menuchoice><guimenu>Tools</guimenu><guimenuitem>Generate Database
+ SQL</guimenuitem></menuchoice> menu item. This will present the following dialog:
</para>
<screenshot>
<mediaobject>
@@ -488,12 +491,12 @@
must be created using the administrative functions provided by the database system.
</para>
<para>
- If after editing the text in the dialog, you want &kmymoney; to create the database, you will need
- to complete the other fields in the dialog, as detailed in <link
+ If after editing the text in the dialog, you want &kmymoney; to create the database,
+ you will need to complete the other fields in the dialog, as detailed in <link
linkend="details.database.selectdatabase">Creating a Database</link> above,
- and click <guibutton>Create Tables</guibutton>. Note that,
- except in the case of SQLite, you will need either to include a suitable CREATE DATABASE statement
- as the first command, or have previously issued such a command externally to &kmymoney;
+ and click <guibutton>Create Tables</guibutton>. Note that, except in the case of
+ SQLite, you will need either to include a suitable <literal>CREATE DATABASE</literal> statement
+ as the first command, or have previously issued such a command externally to &kmymoney;.
</para>
</sect3>
@@ -501,7 +504,7 @@
<title>Warning</title>
<para>
You should be very careful editing the definitions of any of the basic tables or views
- (those with names beginning with 'kmm'). Some changes,
+ (those with names beginning with '<literal>kmm</literal>'). Some changes,
such as increasing the length of an integer field, may have little impact, but you should not
remove or change the sequence of any fields, or &kmymoney; may refuse to function, or may corrupt your data.
</para>
diff --git a/doc/details-forecast.docbook b/doc/details-forecast.docbook
index eb9c12b87..f97f7fb91 100644
--- a/doc/details-forecast.docbook
+++ b/doc/details-forecast.docbook
@@ -73,7 +73,7 @@
</para>
<para>
- The Forecast window is split into five tabs
+ The Forecast window is split into five tabs:
</para>
<sect2>
@@ -290,7 +290,7 @@
<title>Budget Forecast Tab</title>
<para>
- The Budget tab displays a forecast calculation for the Income and Expense categories. The columns are similar to the Summary and Detailed tabs.
+ The Budget tab displays a forecast calculation for the Income and Expense categories. The columns are similar to the Summary and Details tabs.
</para>
</sect2>
diff --git a/doc/details-formats.docbook b/doc/details-formats.docbook
index f0bafef06..d1dde5ab4 100644
--- a/doc/details-formats.docbook
+++ b/doc/details-formats.docbook
@@ -13,7 +13,7 @@
<para>
Unless you choose to use a <link linkend="details.database">relational
database</link>, &kmymoney; will store all your financial information in a
- file ending in .kmy. Also, unless you use a <link
+ file ending in <filename class="extension">.kmy</filename>. Also, unless you use a <link
linkend="firsttime.launch">command line option</link> that tells it not to do
so, when you launch &kmymoney;, it will open the last file it had open.
However, it is important to know that there is more than one type of file
@@ -24,7 +24,7 @@
This chapter describes the formats in which &kmymoney; stores its data in
permanent form on the user's storage device. In general, &kmymoney; stores its
information in form of an &XML; document. Depending on the actual format, this
- &XML; document will be written
+ &XML; document will be written:
<itemizedlist>
<listitem><para>as a <link linkend="details.formats.plain">plain text
@@ -48,7 +48,7 @@
This is the most space consuming format supported, as no compression is
performed. It is not intended for normal use, and is provided to support
debugging purposes and the capability to modify the file manually. If you end
- a filename in <literal role="extension">.xml</literal>, the file will be
+ a filename in <filename class="extension">.xml</filename>, the file will be
stored in this format.
<caution>
@@ -67,7 +67,7 @@
<title>GZIP-compressed file</title>
<para>
This is the normal format used by &kmymoney; when you store a file with the
- extension <literal role="extension">.kmy</literal>.
+ extension <filename class="extension">.kmy</filename>.
</para>
<note>
@@ -79,15 +79,15 @@
<para>
If you want to look at the contents of a GZIP compressed file, rename it to a
- filename ending in <literal role="extension">.gz</literal> (⪚,
+ filename ending in <filename class="extension">.gz</filename> (⪚,
rename <filename>myfinances.kmy</filename>
to <filename>myfinances.kmy.gz</filename>), then use <command>gunzip</command>
to uncompress the file and look at it. You don't have to compress it before
loading it into &kmymoney; the next time, because &kmymoney; can read the
uncompressed data as well. Nevertheless, if you save it thereafter, it will be
- saved compressed again. Use
- the <link linkend="details.formats.plain">.xml</link> extension to write it in
- uncompressed format.
+ saved compressed again. Use the <link linkend="details.formats.plain"><filename
+ class="extension">.xml</filename></link> extension to write it in uncompressed
+ format.
</para>
</sect1>
@@ -100,7 +100,7 @@
cipher the data using GPG and the key you provided before actually storing
it. When opening an encrypted file, you have to provide the passphrase
necessary to open your keyring. The encrypted file itself will be stored in
- GPG's <emphasis>ASCII armored</emphasis> format.
+ GPG's <emphasis>&ASCII; armored</emphasis> format.
<note>
<para>
When using GPG encryption, GPG also compresses the file, so no extra
@@ -177,7 +177,7 @@
supported so that in case of a problem, you can supply the &kmymoney;
development team with your file without disclosing any of the confidential
details in your financial data. For example, it changes institution, account,
- payee, and category names to strings such as "I000001" and "A000001," it makes
+ payee, and category names to strings such as "I000001" and "A000001", it makes
similar changes to all data such as account numbers, and it also randomly
changes the amounts of transactions.
</para>
@@ -186,7 +186,7 @@
If instructed by the developers, use the <guimenuitem>Save as...</guimenuitem>
menu item to store your data in anonymous format by selecting <literal
role="filter">Anonymous files</literal> as the filter. This also changes the
- file extension to <literal role="extension">.anon.xml</literal>.
+ file extension to <filename class="extension">.anon.xml</filename>.
</para>
<para>
diff --git a/doc/details-impexp-csv.docbook b/doc/details-impexp-csv.docbook
index 05adc74e0..4d68e6730 100644
--- a/doc/details-impexp-csv.docbook
+++ b/doc/details-impexp-csv.docbook
@@ -45,7 +45,7 @@
distributions are now built with the CSV importer already included or
available as a separate package. Ensure that it is enabled within &kmymoney;.
Check the <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
- KMyMoney</guimenuitem><guimenuitem>Plugins</guimenuitem></menuchoice> menu.
+ &kmymoney;...</guimenuitem><guimenuitem>Plugins</guimenuitem></menuchoice> menu item.
If the CSV importer does not seem to be installed in your version, the first
place to check is in the same place you got your base &kmymoney; package. See
if a later version is available, or if the importer is available as a separate
@@ -54,8 +54,8 @@
<para>
If you have installed from RPM or Deb, the CSV Importer Plugin should be
- contained within the &kmymoney; package. If you have built from source, there
- should be no additional requirements. The &kmymoney; build process should
+ contained within the kmymoney package. If you have built from source, there
+ should be no additional requirements. The &kmymoney; build process should
detect the plugin source and compile the plugin.
</para>
</sect2>
@@ -161,7 +161,7 @@
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
+ the <guibutton>Next</guibutton> button. Depending upon the earlier selection
you made, you will now be on either the Banking page or the Investment page.
</para>
</sect3>
@@ -189,11 +189,10 @@
<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.
+ values, select <guilabel>Amount</guilabel> column. However, if there are separate
+ columns for debits and credits, select <guilabel>Debit/credit</guilabel> column.
+ This will enable either the <guilabel>Amount</guilabel> column selector or the
+ <guilabel>Debit</guilabel> and <guilabel>Credit</guilabel> column selectors.
</para>
</listitem>
@@ -327,7 +326,7 @@
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
+ dividend</quote>, go to <guilabel>Filter</guilabel> text box and enter
<quote>type: </quote> including the trailing space.
</para>
</listitem>
@@ -384,9 +383,9 @@
This needs to be set according to the order of year, month, and day in the
dates in the file. If the plugin finds data incompatible with this setting,
it will complain when you try to import. However, if the setting is wrong,
- but does not produce invalid results (such as data with no days higher than 12,
- so month and day could be switched) you will simply get incorrect data,
- because the plugin cannot know you made a mistake. In this case, the error will be
+ but it produce invalid results not detected (such as data with no days higher
+ than 12, so month and day could be switched) you will simply get incorrect data,
+ because the plugin cannot know you made a mistake. In this case, the error will be
obvious in the ledger after import.
</para>
</formalpara>
@@ -467,9 +466,8 @@
name is rather long, just enter a few characters. The import will proceed but
the transactions will be flagged by &kmymoney; 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
- &kmymoney;
+ import. Click <guibutton>OK</guibutton> when done. The import process then gets
+ handed over to &kmymoney;.
</para>
<para>
@@ -479,7 +477,7 @@
select each transaction. While still holding the &Ctrl; 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
- &Enter; (not <guilabel>OK</guilabel>). Now that those
+ &Enter; (not <guibutton>OK</guibutton>). 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
&Enter;) to accept the edit, which will then change all
@@ -488,13 +486,13 @@
</para>
<para>
- Now click <guilabel>OK</guilabel>, then <guilabel>Import</guilabel>. In the
+ Now click <guibutton>OK</guibutton>, then <guibutton>Import</guibutton>. 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
+ <guilabel>Brokerage</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
@@ -503,7 +501,7 @@
</para>
<para>
- Now the import has occurred and you're into KMM to select the investment
+ Now the import has occurred and you're into &kmymoney; to select the investment
account to use. Then the checking account, if there were any brokerage type
transactions.
</para>
@@ -514,20 +512,20 @@
<para>
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 &kmymoney; program.
+ was successful and all that is necessary is to click <guibutton>Import
+ CSV</guibutton> and control then passes to the main &kmymoney; 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.
+ <guibutton>Back</guibutton> 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>.)
+ that this is the case, you may click either of the buttons to accept
+ (<guibutton>Accept this</guibutton> or <guibutton>Accept all</guibutton>.)
</para>
<formalpara><title>Decimal Symbol</title>
@@ -568,7 +566,7 @@
<title>Make QIF File</title>
<para>
This button gives you the ability, after the import has been completed, to
- save the data from the csv file as a qif file, should you require one for any
+ save the data from the CSV file as a QIF file, should you require one for any
reason. This was actually the original functionality that drove the creation
of this plugin. However, as &kmymoney; itself is now able to export a qif
file, the capability is now probably of little use and is likely to be removed
@@ -589,12 +587,12 @@
the plugin will validate the column contents to ensure they match the action
type. For instance, if a quantity appears but no price or amount, it is
assumed that the transaction can be only an Add or Remove Shares. Or, if
- there is an amount but no quantity or price, then a Dividend is assumed, &etc;.
+ there is an amount but no quantity or price, then a Dividend is assumed, &etc;
</para>
<para>
If you wish to save your settings, remember to click the
- <guilabel>Finish</guilabel> button, and the plugin will then close.
+ <guibutton>Finish</guibutton> button, and the plugin will then close.
</para>
</sect3>
@@ -604,17 +602,19 @@
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
- sorted into alphabetical order. If the offending parameter is one you don't
- need, just delete it from the file. If that is not possible, you may need to
- edit your file before input.
+ this file.) For instance, in the <literal>[InvestmentSettings]</literal> section
+ of the file, the <literal>BuyParam</literal> field includes entries for
+ <literal>Purchase</literal>, <literal>Buy</literal>, <literal>New Inv</literal>,
+ and <literal>Switch In</literal>. 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:
+ <literal>Shrsin</literal>, <literal>DivX</literal>, <literal>Reinvdiv</literal>,
+ <literal>Brokerage</literal>, <literal>Buy</literal>, <literal>Sell</literal>, and
+ <literal>Remove</literal>. Re-ordering the lists to suit this does not work as
+ might be expected, since the entries in the resource file get sorted into
+ alphabetical order. If the offending parameter is one you don't need, just delete
+ it from the file. If that is not possible, you may need to edit your file before input.
</para>
</sect3>
@@ -627,23 +627,30 @@
no agreed standard at all. With investment files, in particular, there is
much more scope for variation in specifying the different types of activities
represented in the data. The plugin handles this by listing these activity
- types in a resource file, called csvimporterrc. The location of this file
- depends on your distribution. It will usually be located in ~/.kde4/share/config/,
- or in ~/.kde/... instead. Using this resource file allows the user to add an
- activity type that the developer had not encountered. If the file does not
- exist when the importer first runs, the plugin will create a default version,
- containing a few of the more obvious descriptions.
-</para>
-
-<para>
- A number of sample csv files are provided (in the kmymoney/contrib/csvimporter/
- folder in the source tree) in the hope that they may help. For example, in the
- investment sample, an activity type is "ReInvestorContract Buy : ReInvested Units".
- In the validation process, the first successful match is on the ReInv in
- ReInvestorContract Buy, so the transaction therefore gets classed as Reinvdiv,
- even though Buy also is mentioned. Another example which has been observed is an
- activity type of Reinvest even though the transaction included neither price nor
- amount, but only a quantity, so that needed to be treated as Add Shares, or Shrsin.
+ types in a resource file, called <filename>csvimporterrc</filename>. The location
+ of this file depends on your distribution. On a &Linux; system, this will be in
+ <filename class="directory">$KDEHOME/share/config</filename> where
+ <envar>$KDEHOME</envar> is usually <quote>.config</quote> within your home folder.
+ If you are migrating from a version of &kmymoney; prior to 5.0 or later, the old
+ location of <envar>$KDEHOME</envar> was <filename class="directory">.kde4</filename>.
+ Using this resource file allows the user to add an activity type that the developer
+ had not encountered. If the file does not exist when the importer first runs, the
+ plugin will create a default version, containing a few of the more obvious
+ descriptions.
+</para>
+
+<para>
+ A number of sample CSV files are provided (in the <filename class="directory">
+ kmymoney/contrib/csvimporter/</filename> folder in the source tree) in the hope
+ that they may help. For example, in the investment sample, an activity type is
+ "<literal>ReInvestorContract Buy : ReInvested Units</literal>". In the validation
+ process, the first successful match is on the <literal>ReInv</literal> in
+ <literal>ReInvestorContract Buy</literal>, so the transaction therefore gets
+ classed as <literal>Reinvdiv</literal>, even though <literal>Buy</literal> also is
+ mentioned. Another example which has been observed is an activity type of
+ <literal>Reinvest</literal> even though the transaction included neither price nor
+ amount, but only a quantity, so that needed to be treated as <literal>Add
+ Shares</literal>, or <literal>Shrsin</literal>.
</para>
<para>
diff --git a/doc/details-impexp.docbook b/doc/details-impexp.docbook
index 528722a15..ae65b59be 100644
--- a/doc/details-impexp.docbook
+++ b/doc/details-impexp.docbook
@@ -15,15 +15,15 @@
<author>&Tony.Bloomfield; &Tony.Bloomfield.mail;</author>
</sect1info>
-<title>GnuCash Importer</title>
+<title>&gnucash; Importer</title>
<sect2>
-<title>GnuCash Files</title>
+<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. The following are not supported:
</para>
<itemizedlist>
@@ -32,13 +32,14 @@
<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>export to GnuCash files.</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 GnuCash <guimenuitem>Check & Repair All</guimenuitem> function (in
- the <guimenu>Actions</guimenu> menu) 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 attempting to import.
</para>
<para>
@@ -71,7 +72,7 @@
<para>
It should be noted that &kmymoney; is a <emphasis>personal</emphasis> finance
manager, and as such, does not directly support any of the business features
- of GnuCash, such as tax tables, payroll, and tracking of lots. Any Accounts
+ of &gnucash;, such as tax tables, payroll, and tracking of lots. Any Accounts
Payable or Receivable accounts found in a file will be imported as Liability
or Asset accounts respectively.
</para>
@@ -90,7 +91,7 @@
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
+ 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.
@@ -102,7 +103,7 @@
<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
+ 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.
</para>
@@ -112,12 +113,12 @@
<title>Structure and Placeholders</title>
<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.
+ &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.
</para>
</sect4>
@@ -128,57 +129,57 @@
<tgroup cols='2' align='left' colsep='1' rowsep='1'>
<thead>
<row>
- <entry>GnuCash type</entry><entry>&kmymoney; type</entry>
+ <entry>&gnucash; type</entry><entry>&kmymoney; type</entry>
</row>
</thead>
<tbody>
<row>
- <entry>BANK</entry><entry>Checking</entry>
+ <entry><literal>BANK</literal></entry><entry><literal>Checking</literal></entry>
</row>
<row>
- <entry>CHECKING</entry><entry>Checking</entry>
+ <entry><literal>CHECKING</literal></entry><entry><literal>Checking</literal></entry>
</row>
<row>
- <entry>SAVINGS</entry><entry>Savings</entry>
+ <entry><literal>SAVINGS</literal></entry><entry><literal>Savings</literal></entry>
</row>
<row>
- <entry>ASSET</entry><entry>Asset</entry>
+ <entry><literal>ASSET</literal></entry><entry><literal>Asset</literal></entry>
</row>
<row>
- <entry>CASH</entry><entry>Cash</entry>
+ <entry><literal>CASH</literal></entry><entry><literal>Cash</literal></entry>
</row>
<row>
- <entry>CURRENCY</entry><entry>Cash</entry>
+ <entry><literal>CURRENCY</literal></entry><entry><literal>Cash</literal></entry>
</row>
<row>
- <entry>MONEYMRKT</entry><entry>MoneyMarket</entry>
+ <entry><literal>MONEYMRKT</literal></entry><entry><literal>MoneyMarket</literal></entry>
</row>
<row>
- <entry>STOCK</entry><entry>Stock</entry>
+ <entry><literal>STOCK</literal></entry><entry><literal>Stock</literal></entry>
</row>
<row>
- <entry>MUTUAL</entry><entry>Stock</entry>
+ <entry><literal>MUTUAL</literal></entry><entry><literal>Stock</literal></entry>
</row>
<row>
- <entry>EQUITY</entry><entry>Equity</entry>
+ <entry><literal>EQUITY</literal></entry><entry><literal>Equity</literal></entry>
</row>
<row>
- <entry>LIABILITY</entry><entry>Liability</entry>
+ <entry><literal>LIABILITY</literal></entry><entry><literal>Liability</literal></entry>
</row>
<row>
- <entry>CREDIT</entry><entry>CreditCard</entry>
+ <entry><literal>CREDIT</literal></entry><entry><literal>CreditCard</literal></entry>
</row>
<row>
- <entry>INCOME</entry><entry>Income</entry>
+ <entry><literal>INCOME</literal></entry><entry><literal>Income</literal></entry>
</row>
<row>
- <entry>EXPENSE</entry><entry>Expense</entry>
+ <entry><literal>EXPENSE</literal></entry><entry><literal>Expense</literal></entry>
</row>
<row>
- <entry>RECEIVABLE</entry><entry>Asset</entry>
+ <entry><literal>RECEIVABLE</literal></entry><entry><literal>Asset</literal></entry>
</row>
<row>
- <entry>PAYABLE</entry><entry>Liability</entry>
+ <entry><literal>PAYABLE</literal></entry><entry><literal>Liability</literal></entry>
</row>
</tbody>
</tgroup>
@@ -193,9 +194,9 @@
<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
+ 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
@@ -208,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
+ 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.
+ &gnucash; transaction's Description field.
</para>
</sect4>
@@ -229,7 +230,7 @@
<para>
&kmymoney; provides an account reconciliation function similar to that of
- GnuCash, and the corresponding transaction status will be imported.
+ &gnucash;, and the corresponding transaction status will be imported.
</para>
</sect4>
</sect3>
@@ -238,7 +239,7 @@
<title>Commodities</title>
<para>
- GnuCash uses the term Commodity to cover both currencies and non-currency
+ &gnucash; uses the term Commodity to cover both currencies and non-currency
assets. These are treated separately in &kmymoney;.
</para>
@@ -254,12 +255,12 @@
alternative.
</para>
-<para>
- (NOTE: &kmymoney; does not currently support accounts denominated in 'defunct'
+<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>
+ 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>
</sect4>
<sect4 id="gncsecurities">
@@ -271,7 +272,7 @@
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
+ 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>
@@ -304,7 +305,7 @@
<title>Prices and currency rates</title>
<para>
- Security prices and currency exchange rates as displayed in the GnuCash Price
+ 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>
@@ -314,11 +315,11 @@
<title>Online Quotes</title>
<para>
- For obtaining online price and currency rate quotations, GnuCash uses a
- package called Finance::Quote. 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
+ 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>.
</para>
@@ -328,8 +329,8 @@
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 Finance::Quote, and
- will always use the native retrieval method.
+ import process. Future currency rate updates will not use <literal>Finance::Quote</literal>,
+ and will always use the native retrieval method.
</para>
<para>
@@ -348,7 +349,7 @@
<title>Scheduled Transactions</title>
<para>
- &kmymoney; does not retain the separation made in GnuCash between template
+ &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.
@@ -359,7 +360,7 @@
<para>
&kmymoney; classifies all schedules as one of three types, Bills, Deposits, or
- Transfers. Since GnuCash does not make such a distinction, the importer
+ 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.
@@ -370,7 +371,7 @@
<title>Suspect Schedules</title>
<para>
- Some features of GnuCash scheduled transactions are not available in
+ 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
@@ -379,7 +380,7 @@
<itemizedlist>
<listitem>
- <para>some frequency intervals supported in GnuCash are not currently
+ <para>some frequency intervals supported in &gnucash; are not currently
available in &kmymoney;</para>
</listitem>
@@ -409,7 +410,7 @@
&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.
+ in &gnucash;.
</para>
</sect3>
</sect2>
@@ -462,7 +463,7 @@
<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.
+ 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
@@ -470,7 +471,7 @@
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
+ overwrite your &gnucash; file, you are free to experiment with any of these
selections.
</para>
</sect3>
@@ -479,7 +480,7 @@
<title>Transaction Notes option</title>
<para>
- Under some usage conditions, non-split GnuCash transactions may contain
+ 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
@@ -495,8 +496,8 @@
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 Anonymize option should be used if they are to
- be made publicly available.
+ a confidential nature, and the <guilabel>Anonymize data</guilabel> option
+ should be used if they are to be made publicly available.
</para>
</sect3>
</sect2>
@@ -573,9 +574,9 @@
</itemizedlist>
<para>
- This is generally why Intuit stopped supporting QIF input at all with Quicken
- 2005. If you have the option of getting data some other way, like OFX, always
- choose that option.
+ 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.
</para>
</sect2>
@@ -841,8 +842,9 @@
<para>
A common problem is to convert a list of comma-separated-values into a QIF
- file. This is a textbook case for the awk tool. Create a script called
- csv2qif.awk, with the following two lines as contents:
+ 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:
</para>
<programlisting>
@@ -852,7 +854,7 @@
</programlisting>
<para>
- Then, change the QIF keys (D,T,N,P,M) to match the order of your csv data.
+ 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>.
</para>
@@ -934,8 +936,8 @@
<para>
If you have installed from RPM, the OFX Importer Plugin is contained within
- the kmymoney-ofx RPM. It should be available from whatever source you got the
- base &kmymoney; RPM. If you have built from sources, all you need to do is
+ the kmymoney-ofx package. It should be available from whatever source you got the
+ base &kmymoney; package. If you have built from sources, all you need to do is
have preferably the libOFX 0.9 development headers and libraries installed on
your system. The &kmymoney; build process will detect these and compile the
plugin. At the time of release of &kmymoney; 4.6, the latest libofx version
@@ -945,8 +947,8 @@
<para>
Should you run into trouble trying to compile &kmymoney;, and you are certain
you have the correct version of libOFX installed, please contact the
- developers list &devlist; for assistance. Include a copy of your config.log
- file, compressed first via gzip.
+ developers list &devlist; for assistance. Include a copy of your
+ <filename>config.log</filename> file, compressed first via <command>gzip</command>.
</para>
</sect2>
@@ -1057,14 +1059,15 @@
<para>
To enable this feature, you must compile &kmymoney; with the
- --enable-ofxbanking switch (now the default).
+ <userinput><option>--enable-ofxbanking</option></userinput> switch (now the default).
</para>
<para>
Please be warned: Many banks require a separate signup, will give you a
separate password or PIN, and may even charge you a separate fee for this
service. No bank directly supports &kmymoney;. You will have to tell them
- you want to bank directly from MS Money or Quicken.
+ you want to bank directly from <application>MS Money</application> or
+ <application>Quicken</application>.
</para>
<para>
@@ -1073,7 +1076,7 @@
configure, and choose <guimenuitem>Map to online account...</guimenuitem>.
In case more than one online banking plugin is installed on your system
you will be asked which one to use. For the internal OFX method select
- <guimenuitem>KMyMoney OFX</guimenuitem>. A list of banks will be downloaded
+ <guimenuitem>&kmymoney; OFX</guimenuitem>. A list of banks will be downloaded
from the Internet and a wizard will guide you through choosing a bank,
entering your username and password, and selecting an account. Should you
find that your bank is not listed, then it may still be possible to use the
@@ -1099,19 +1102,19 @@
<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
- account...</guimenuitem>. This will connect to your bank, and download a statement
- for the last 60 days.
+ account. Then choose <menuchoice><guimenu>Account</guimenu><guimenuitem>Update
+ account...</guimenuitem></menuchoice> menu item. This will connect to your bank,
+ and download a statement for the last 60 days.
</para>
<note>
<para>
- In version of &kmymoney; prior to 4.6, the payee name was always taken
- from the PAYEEID field. As of version 4.6, the payee name can be based on
- either the PAYEEID, NAME, or MEMO field in the OFX transaction. You can
- configure this feature and some other OFX direct connect settings by
- selecting the appropriate tab in
- the <link linkend="details.accounts.edit">Edit account</link> dialog.
+ In version of &kmymoney; prior to 4.6, the payee name was always taken from the
+ <literal>PAYEEID</literal> field. As of version 4.6, the payee name can be based
+ on either the <literal>PAYEEID</literal>, <literal>NAME</literal>, or
+ <literal>MEMO</literal> field in the OFX transaction. You can configure this
+ feature and some other OFX direct connect settings by selecting the appropriate
+ tab in the <link linkend="details.accounts.edit">Edit account</link> dialog.
</para>
</note>
</sect2>
diff --git a/doc/details-institutions.docbook b/doc/details-institutions.docbook
index a27918493..cf592428e 100644
--- a/doc/details-institutions.docbook
+++ b/doc/details-institutions.docbook
@@ -48,7 +48,7 @@
<term>Account</term>
<listitem>
<para>
- The name of the institution or account
+ The name of the institution or account.
</para>
</listitem>
</varlistentry>
@@ -200,13 +200,11 @@
</screenshot>
</para>
-<para>
- <emphasis>
- NOTE: You must have a file open before you can create a new institution. If
- you do not have an existing file, you will need to <link
- linkend="firsttime.3">create one</link>.
- </emphasis>
-</para>
+<note><para>
+ You must have a file open before you can create a new institution. If
+ you do not have an existing file, you will need to <link
+ linkend="firsttime.3">create one</link>.
+</para></note>
<para>
Only the name is required in the New Institution Dialog, all other fields are
diff --git a/doc/details-investments.docbook b/doc/details-investments.docbook
index 231d4bef7..f7cc0a928 100644
--- a/doc/details-investments.docbook
+++ b/doc/details-investments.docbook
@@ -93,11 +93,10 @@
<para>
The first step on the path to working with investments is to create an account
- to hold your defined securities. Choose <menuchoice><guimenu>Account</guimenu>
- <guimenuitem>New account...</guimenuitem></menuchoice> to begin the process.
- Create an account as previously defined in the adding
- <menuchoice><guimenu>Account</guimenu></menuchoice> section, making sure to choose
- <quote>Investment</quote> as the type of account.
+ to hold your defined securities. Choose the <menuchoice><guimenu>Account</guimenu>
+ <guimenuitem>New account...</guimenuitem></menuchoice> menu item to begin the process.
+ Create an account as previously defined in the adding <guilabel>Account</guilabel>
+ section, making sure to choose <quote>Investment</quote> as the type of account.
</para>
<para>
@@ -212,7 +211,7 @@
<itemizedlist>
<listitem>
<para>
- Use Finance::Quote. This is an option for GnuCash users who are used to
+ Use Finance::Quote. This is an option for &gnucash; users who are used to
this style of quotes. Most users can leave this unchecked.
</para>
</listitem>
@@ -603,7 +602,7 @@
<para>
Versions of &kmymoney; starting with 0.9 contain support for the Finance::Quote
package for obtaining online quotes. This is intended primarily as a convenience
- for those users converting from the GnuCash finance package, which uses it as its
+ for those users converting from the &gnucash; finance package, which uses it as its
native method. If you do select this option, you should see a different list of
sources, those supported by Finance::Quote. If the list is empty, it suggests that
the package is not properly installed. See their web site at
@@ -640,7 +639,7 @@
Typically, you will update the prices for all your securities and currencies as a
single operation. Choose the
<menuchoice><guimenu>Tools</guimenu><guimenuitem>Update Stock and Currency
- Prices...</guimenuitem></menuchoice> menu option to bring up the online price
+ Prices...</guimenuitem></menuchoice> menu item to bring up the online price
quotes dialog. Press <guibutton>Update All</guibutton> to fetch quotes for all
securities and currencies in your &kmymoney; file.
</para>
@@ -675,9 +674,9 @@
<para>
If you do feel up to the challenge, here's how it works. The quote sources are
- contained in the settings dialog. Choose
+ contained in the settings dialog. Choose the
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
- &kmymoney;</guimenuitem></menuchoice>. From there, choose the <guilabel>Online
+ &kmymoney;</guimenuitem></menuchoice> menu item. From there, choose the <guilabel>Online
Quotes</guilabel> section. You can choose an existing source to edit, or create a
new one. When you are done with your changes, be sure to press
the <guibutton>Update</guibutton> button before exiting the dialog. Your changes
diff --git a/doc/details-ledgers.docbook b/doc/details-ledgers.docbook
index 936506cb7..3f882d19b 100644
--- a/doc/details-ledgers.docbook
+++ b/doc/details-ledgers.docbook
@@ -395,11 +395,11 @@
</para>
<para>
- This is performed by selecting <menuchoice><guimenu>Settings</guimenu>
- <guimenuitem>Configure &kmymoney;</guimenuitem></menuchoice> from the menu bar
- and selecting the <guiicon><inlinemediaobject><imageobject><imagedata
- fileref="ledgers_view.png"/></imageobject></inlinemediaobject>
- Register</guiicon> icon from the list on the left. The option to uncheck is
+ This is performed by selecting the <menuchoice><guimenu>Settings</guimenu>
+ <guimenuitem>Configure &kmymoney;...</guimenuitem></menuchoice> menu item and
+ selecting the <guiicon><inlinemediaobject><imageobject><imagedata
+ fileref="ledgers_view.png" format='PNG'/></imageobject></inlinemediaobject>
+ </guiicon> register icon from the list on the left. The option to uncheck is
labeled <guilabel>Show transaction form</guilabel>. When finished click on
<guibutton>OK</guibutton> to be ready to directly enter or edit transactions.
</para>
@@ -618,10 +618,9 @@
There are several options that change the appearance and behavior of the
Ledger view in terms of transactions. These settings are found by selecting
<guimenu>Settings</guimenu><guimenuitem>Configure &kmymoney;</guimenuitem>
- from the menu bar, and selecting the
- <guiicon><inlinemediaobject><imageobject><imagedata fileref="ledgers_view.png"
- /> </imageobject></inlinemediaobject>Ledger</guiicon> icon from the list on
- the left.
+ from the menu bar, and selecting the <guiicon><inlinemediaobject><imageobject>
+ <imagedata fileref="ledgers_view.png" format='PNG'/></imageobject>
+ </inlinemediaobject></guiicon> ledger icon from the list on the left.
</para>
<para>
diff --git a/doc/details-loans.docbook b/doc/details-loans.docbook
index c6400fb02..561e0e67d 100644
--- a/doc/details-loans.docbook
+++ b/doc/details-loans.docbook
@@ -164,8 +164,8 @@
<para>
In &kmymoney;, a loan is a type of account. Therefore, to create a new loan,
- you begin by selecting <menuchoice><guimenu>Account</guimenu><guimenuitem>New
- Account</guimenuitem></menuchoice>. Continue by answering the questions that
+ you begin by selecting the <menuchoice><guimenu>Account</guimenu><guimenuitem>New
+ Account</guimenuitem></menuchoice> menu item. Continue by answering the questions that
the wizard poses to you.
</para>
@@ -213,12 +213,12 @@
</listitem>
</itemizedlist>
-<para>
- Note: If you are doubling the principal repaid with every periodic payment,
+<note><para>
+ If you are doubling the principal repaid with every periodic payment,
you will need to recalculate the loan schedule for each installment. This will
allow there to be an accurate value for the required principal repayment with
each installment.
-</para>
+</para></note>
</sect1>
</chapter>
diff --git a/doc/details-reconciliation.docbook b/doc/details-reconciliation.docbook
index 3f8a47978..4c726418a 100644
--- a/doc/details-reconciliation.docbook
+++ b/doc/details-reconciliation.docbook
@@ -25,12 +25,11 @@
<para>
To reconcile an account, choose your account from the drop down box and click
- on the <guiicon><inlinemediaobject> <imageobject><imagedata
- fileref="reconcile.png"/></imageobject>
- </inlinemediaobject>Reconcile</guiicon> icon, select
- <menuchoice><guimenu>Account</guimenu>
- <guimenuitem>Reconcile...</guimenuitem></menuchoice> or use the key
- combination <keycombo>&Ctrl;&Shift;<keycap>R</keycap></keycombo>.
+ 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>
</sect1>
diff --git a/doc/details-reports.docbook b/doc/details-reports.docbook
index 1191f293c..9cb90e376 100644
--- a/doc/details-reports.docbook
+++ b/doc/details-reports.docbook
@@ -309,7 +309,7 @@
For transaction reports:
<itemizedlist>
<listitem><para>Organize by: Choose how to group the transactions in this
- report</para></listitem>
+ 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
diff --git a/doc/details-schedules.docbook b/doc/details-schedules.docbook
index 901fd3d19..cd4dca293 100644
--- a/doc/details-schedules.docbook
+++ b/doc/details-schedules.docbook
@@ -116,10 +116,9 @@
<title>The Schedules View</title>
<para>
- Open the Schedules View by clicking on the <guiicon>Schedule
- <inlinemediaobject><imageobject><imagedata
- fileref="schedule_view.png"/></imageobject></inlinemediaobject></guiicon> icon in
- the view selector.
+ Open the Schedules View by clicking on the <guiicon><inlinemediaobject><imageobject>
+ <imagedata fileref="schedule_view.png" format='PNG'/></imageobject></inlinemediaobject>
+ </guiicon> schedule icon in the view selector.
</para>
<para>
diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook
index 887257abb..c182a8ac3 100644
--- a/doc/details-settings.docbook
+++ b/doc/details-settings.docbook
@@ -20,10 +20,10 @@
to customize it to meet the needs of your unique financial affairs, and to
modify its look and feel to match your personality. These settings can be
changed through <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
- &kmymoney;...</guimenuitem></menuchoice> or by using the keyboard shortcut
- <keycombo action="simul">&Ctrl; &Shift;
- <keycap>,</keycap></keycombo>. In order for any changes to take effect the
- <guibutton>Apply</guibutton> button must be clicked.
+ &kmymoney;...</guimenuitem></menuchoice> menu item or by using the keyboard
+ shortcut <keycombo action="simul">&Ctrl; &Shift;<keycap>,</keycap></keycombo>.
+ In order for any changes to take effect the <guibutton>Apply</guibutton>
+ button must be clicked.
</para>
<para>
@@ -87,7 +87,7 @@
then two ways to launch the program.</para>
<para>First, you can use
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
- Toolbars...</guimenuitem></menuchoice> to place the
+ Toolbars...</guimenuitem></menuchoice> menu item to place the
<guilabel>Calculator</guilabel> icon on the Toolbar. Then, when you click
that icon on the Toolbar, &kmymoney; will launch the selected
application.</para>
@@ -98,9 +98,9 @@
doc page. -->
<para>Second, you can use
<menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
- Shortcuts...</guimenuitem></menuchoice> to set a custom keyboard shortcut.
- (The entry is under KMyMoney/Calculator in that list.) You can then use
- that shortcut to launch the application.</para>
+ Shortcuts...</guimenuitem></menuchoice> menu item to set a custom keyboard
+ shortcut. (The entry is under &kmymoney;/Calculator in that list.) You can
+ then use that shortcut to launch the application.</para>
<!-- FIXME is not currently possible to launch the calculator from some menu
item. I have filed a wishlist, and when implemented, it should be
described here, probably as the first choice. -->
@@ -125,7 +125,7 @@
</varlistentry>
<varlistentry>
- <term><guilabel>Type of the KMyMoney view</guilabel></term>
+ <term><guilabel>Type of the &kmymoney; view</guilabel></term>
<listitem>
<para> You can select one of three general layouts for &kmymoney; to use. If
you select the List or Tree view, the icons and their labels will be located at
@@ -140,7 +140,7 @@
<listitem>
<para>Checking this box will display the blue &kmymoney; title bar across the
top of each page. Unchecking it will remove the title bar and provide a larger
- area for viewing the content of each page</para>
+ area for viewing the content of each page.</para>
</listitem>
</varlistentry>
@@ -299,7 +299,7 @@
<listitem>
<para>This will display the accounts that are identified as Preferred accounts
within the <menuchoice><guimenu>Account</guimenu><guimenuitem>Edit account...
- </guimenuitem></menuchoice>Configuration dialog.</para>
+ </guimenuitem></menuchoice> Configuration dialog.</para>
<para>For this and all other account list sections addressed by this set of
options, the display will include the account name and current balance, and
other columns specific to that type of report, and in some cases, as configured
@@ -577,7 +577,7 @@ of accounts.</para>
<para>
This tab controls the default sort order of the ledger while in the
Reconciliation view. This is the display of transactions shown during the
- process of <link linkend="details.reconcile">Reconciliation</link>
+ process of <link linkend="details.reconcile">Reconciliation</link>.
</para>
</sect3>
@@ -941,7 +941,7 @@ of accounts.</para>
institution to show where they will be printed on the check. &kmymoney; is
shipped with some sample template files. You should either be able to use one
of them, or modify one to suit your needs. When the default template is
- selected, the configuration dialog will show you the directory which contains
+ selected, the configuration dialog will show you the folder which contains
the sample files.
</para>
diff --git a/doc/details-tags.docbook b/doc/details-tags.docbook
index ff20a9f93..7ed361f2e 100644
--- a/doc/details-tags.docbook
+++ b/doc/details-tags.docbook
@@ -69,11 +69,10 @@
<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 remove a tag, either click on the <guiicon><inlinemediaobject><imageobject><imagedata
+ fileref="list-remove.png" format='PNG'/></imageobject></inlinemediaobject></guiicon>
+ delete tag icon 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>
diff --git a/doc/details-widgets.docbook b/doc/details-widgets.docbook
index 27d08404d..716bea5be 100644
--- a/doc/details-widgets.docbook
+++ b/doc/details-widgets.docbook
@@ -24,8 +24,8 @@
the <emphasis>date entry widget</emphasis>. This widget consists of three
fields and a button. The fields present the <emphasis>day</emphasis>, the
<emphasis>month</emphasis>, and the <emphasis>year</emphasis>, separated by
- the date separator characters specified by your locale settings. The button -
- if pressed - opens the <emphasis>datepicker</emphasis> widget.
+ the date separator characters specified by your locale settings. If you push
+ the button, will open the <emphasis>datepicker</emphasis> widget.
</para>
<para>
@@ -43,9 +43,9 @@
</para>
<para>
- Within the date entry widget, the left/right cursor keys can be used to switch
+ Within the date entry widget, the &Left;/&Right; cursor keys can be used to switch
between the <emphasis>day</emphasis>, the <emphasis>month</emphasis>, and the
- <emphasis>year</emphasis> fields. Using the up/down cursor keys, the value of
+ <emphasis>year</emphasis> fields. Using the &Up;/&Down; cursor keys, the value of
the selected field can be incremented/decremented. The <keycap>+</keycap> and
<keycap>-</keycap> keys can be used to increment/decrement a single day.
Month and year boundaries are considered and incremented/decremented if
@@ -57,7 +57,7 @@
<emphasis>day</emphasis>, <emphasis>month</emphasis>, or
<emphasis>year</emphasis> field selects the field. The value can then be
incremented/decremented using the arrow buttons on the right of the
- widget. They act exactly the same as the up/down key.
+ widget. They act exactly the same as the &Up;/&Down; cursor keys.
</para>
<para>
@@ -93,7 +93,8 @@
thousands separators, and decimal symbols) as well as a button to the
right. Use the digits to enter the value. Separate the fractional part by
entering the decimal separator for your locale. If you click on the button to
- the right or press a key representing a numeric operation (⪚, +,-,/,* or %)
+ the right or press a key representing a numeric operation (⪚, <keycap>+</keycap>,
+ <keycap>-</keycap>, <keycap>/</keycap>, <keycap>*</keycap> or <keycap>%</keycap>)
a little calculator will pop up and allow you to calculate the final value.
</para>
@@ -120,7 +121,8 @@
<para>
Use the calculator widget just like a normal calculator and once done leave
- it by clicking on the '=' button or press the '=' key on your keyboard.
+ it by clicking on the <guibutton>=</guibutton> button or press the <keycap>=</keycap>
+ key on your keyboard.
</para>
</sect2>
@@ -132,8 +134,8 @@
entering the name by pressing keys on your keyboard. As long as matching
entries exist in the list of payees/payers maintained by &kmymoney; they will
be presented in a box beneath or above the text entry area. Using the mouse or
- the up/down keys one can select a name from that list. Using the keyboard
- additionally requires you to select the entry by pressing the RETURN key.
+ the &Up;/&Down; keys one can select a name from that list. Using the keyboard
+ additionally requires you to select the entry by pressing the &Enter; key.
</para>
<para>
@@ -173,8 +175,8 @@
start entering the name by pressing keys on your keyboard. As long as
matching entries exist in the list of categories/accounts known to &kmymoney;
they will be presented in a box beneath or above the text entry area. Using
- the mouse or the up/down keys one can select a name from that list. Using the
- keyboard additionally requires you to select the entry by pressing the RETURN
+ the mouse or the &Up;/&Down; keys one can select a name from that list. Using the
+ keyboard additionally requires you to select the entry by pressing the &Enter;
key.
</para>
diff --git a/doc/faq.docbook b/doc/faq.docbook
index f956fa8e3..9b9045fd1 100644
--- a/doc/faq.docbook
+++ b/doc/faq.docbook
@@ -44,7 +44,7 @@
<qandaentry>
<question>
<para>Will &kmymoney; work on my X/&ubuntu; desktop? Will &kmymoney; work
- without a full KDE desktop?</para>
+ without a full &kde; desktop?</para>
</question>
<answer>
<para>Yes, &kmymoney; will work without a full &kde; desktop, but you will
@@ -176,7 +176,7 @@
transaction. Is there a global search/replace?</para>
</question>
<answer>
- <para>There is no global search and replace function in KMyMoney.
+ <para>There is no global search and replace function in &kmymoney;.
Nevertheless, it is easy to change a payees name: select the Payees view and
find the entry with the name you want to change. Click with the &RMB; on the
payee, and select <guimenuitem>Rename payee</guimenuitem> from the context menu.
@@ -231,7 +231,7 @@
into your language, please post a message to the proper <ulink
url="https://l10n.kde.org/teams-list.php">team mailing list</ulink>. Should
you fail to find your language in the list or could not contact the team
- members please mail directly to the <ulink url="mailto:kde-i18n-doc at kde.org">KDE
+ members please mail directly to the <ulink url="mailto:kde-i18n-doc at kde.org">&kde;
translation mailing list</ulink> (<ulink
url="https://mail.kde.org/mailman/listinfo/kde-i18n-doc">subscription</ulink>
required) and we will give you the details on how you can
diff --git a/doc/firsttime.docbook b/doc/firsttime.docbook
index 3b409af7e..bbb8f146e 100644
--- a/doc/firsttime.docbook
+++ b/doc/firsttime.docbook
@@ -45,8 +45,8 @@
<note>
<para>
- Tips can be read at anytime by selecting <guimenuitem>Show tip of the
- day</guimenuitem> from the <guimenu>Help</guimenu> menu within &kmymoney;.
+ Tips can be read at anytime by selecting the <menuchoice><guimenu>Help</guimenu>
+ <guimenuitem>Show tip of the day</guimenuitem></menuchoice> menu item within &kmymoney;.
</para>
</note>
@@ -246,10 +246,10 @@
<inlinemediaobject>
<imageobject>
<imagedata fileref="ledgers_view.png" format="PNG"/>
- </imageobject>
+ </imageobject>
<textobject>
<phrase>Ledgers View</phrase>
- </textobject>
+ </textobject>
</inlinemediaobject>
</guiicon>
Ledgers: Your account transactions.
@@ -264,7 +264,7 @@
<imagedata fileref="investments_view.png" format="PNG"/>
</imageobject>
<textobject>
- <phrase>Investments View</phrase>
+ <phrase>Investments View</phrase>
</textobject>
</inlinemediaobject>
</guiicon>
@@ -298,10 +298,10 @@
</imageobject>
<textobject>
<phrase>Budgets View</phrase>
- </textobject>
+ </textobject>
</inlinemediaobject>
</guiicon>
- Budgets: Your budgets
+ Budgets: Your budgets.
</para>
</listitem>
@@ -317,7 +317,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- Forecast: This view provides a forecast of your accounts and categories
+ Forecast: This view provides a forecast of your accounts and categories.
</para>
</listitem>
@@ -357,9 +357,9 @@
<para>
To create a new file you can either select
<menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice>
- menu item or choose the <inlinemediaobject><imageobject><imagedata
- fileref="new.png"/></imageobject><textobject><phrase>New</phrase></textobject></inlinemediaobject>
- icon from the toolbar. In addition, if the main welcome page is displayed,
+ menu item or choose the <guiicon><inlinemediaobject><imageobject><imagedata
+ fileref="new.png" format='PNG'/></imageobject></inlinemediaobject></guiicon> new
+ icon from the toolbar. In addition, if the main welcome page is displayed,
you can also select the first link: "Get started and setup accounts."
</para>
@@ -569,9 +569,9 @@
<term>Using the Accounts view</term>
<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>
+ To create an account using the accounts view click on the <guiicon>
+ <inlinemediaobject><imageobject><imagedata fileref="accounts_view.png"
+ format='PNG'/></imageobject></inlinemediaobject></guiicon> accounts icon
in the view selector to display the Accounts View. Right click on the
either the Asset tree icon or the Liability tree icon in the right hand
view and select <guimenuitem>New account</guimenuitem> from the popup
@@ -640,8 +640,8 @@
<para>
To maintain <link linkend="details.schedules">schedules</link> click on the
- Schedules icon <guiicon><inlinemediaobject><imageobject><imagedata
- fileref="schedule_view.png"/></imageobject></inlinemediaobject></guiicon> in
+ <guiicon><inlinemediaobject><imageobject><imagedata fileref="schedule_view.png"
+ format='PNG'/></imageobject></inlinemediaobject></guiicon> schedules icon in
the view selector.
</para>
</sect1>
@@ -651,9 +651,9 @@
<para>
To maintain <link linkend="details.categories">categories</link> click on the
- <guiicon><inlinemediaobject><imageobject><imagedata
- fileref="categories_view.png"/></imageobject></inlinemediaobject></guiicon>
- Categories icon in the view selector.
+ <guiicon><inlinemediaobject><imageobject><imagedata fileref="categories_view.png"
+ format='PNG'/></imageobject></inlinemediaobject></guiicon> categories icon in
+ the view selector.
</para>
<para>
@@ -666,10 +666,9 @@
<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.
+ To maintain <link linkend="details.tags">tags</link> click on the <guiicon>
+ <inlinemediaobject><imageobject><imagedata fileref="mail-tagged.png" format='PNG'/>
+ </imageobject></inlinemediaobject></guiicon> tags icon in the view selector.
</para>
<para>
@@ -682,10 +681,9 @@
<title>Payees</title>
<para>
- To maintain your list of payees click on the Payees icon
- <guiicon><inlinemediaobject><imageobject><imagedata
- fileref="payees_view.png"/></imageobject></inlinemediaobject></guiicon> in the
- view selector.
+ To maintain your list of payees click on the <guiicon><inlinemediaobject>
+ <imageobject><imagedata fileref="payees_view.png" format='PNG'/></imageobject>
+ </inlinemediaobject></guiicon> payees icon in the view selector.
</para>
<para>
@@ -721,11 +719,11 @@
</para>
<para>
- The search dialog can be opened from the toolbar using the Find icon
- <guiicon><inlinemediaobject><imageobject><imagedata
- fileref="transaction_find.png"/></imageobject></inlinemediaobject></guiicon>
- or by selecting <guimenuitem>Find Transaction</guimenuitem> from the
- <guimenu>Edit</guimenu> menu.
+ The search dialog can be opened from the toolbar using the <guiicon>
+ <inlinemediaobject><imageobject><imagedata fileref="transaction_find.png"
+ format='PNG'/></imageobject></inlinemediaobject></guiicon> find icon or by
+ selecting the <menuchoice><guimenu>Edit</guimenu><guimenuitem>Find
+ Transaction</guimenuitem></menuchoice> menu item.
</para>
<para>
@@ -751,8 +749,8 @@
To reconcile an account, first select the account, either from
<guiicon>Accounts</guiicon> view or from <guiicon>Ledgers</guiicon>
view. Then, either click on the <guiicon>Reconcile</guiicon> icon on the
- Toolbar, or select <guimenuitem>Reconcile</guimenuitem> from the
- <guimenu>Account</guimenu> menu.
+ Toolbar, or select the <menuchoice><guimenu>Account</guimenu>
+ <guimenuitem>Reconcile</guimenuitem></menuchoice> menu item.
</para>
<para>
@@ -778,7 +776,7 @@
<menuchoice><guimenu>File</guimenu><guimenuitem>Backup</guimenuitem></menuchoice>
menu item and enter the folder where you wish the file to be saved. If the folder
needs mounting first and you have the sufficient privileges then check the
- tick box labeled <guilabel>Mount this directory before backing up</guilabel>
+ tick box labeled <guilabel>Mount this folder before backing up</guilabel>
and click on <guibutton>OK</guibutton>.
</para>
@@ -817,7 +815,7 @@
instead of the last file it had open. You can use the name of any valid
&kmymoney; file, as described in the chapter on <link
linkend="details.formats">file formats</link>. In addition, this can be
- used to import a <link linkend="details.impexp.gnucash">GnuCash</link> file.
+ used to import a <link linkend="details.impexp.gnucash">&gnucash;</link> file.
</para>
</formalpara>
</sect1>
@@ -831,10 +829,10 @@
<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 &kmymoney; data file. The name of the file is
- shown in the title bar when &kmymoney; 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
+ shown in the title bar when &kmymoney; is running, it usually ends in <filename
+ class="extension">.kmy</filename>. 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 item. You should even be able to move between &Windows;, &MacOS;, and &Linux; systems.
</para>
@@ -865,12 +863,12 @@
previous section, &kmymoney; 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>.config</quote> within your home directory. If you are migrating from
- a version of &kmymoney; prior to 5.0 to 5.0 or later, the old location
- of <quote>$KDEHOME</quote> was <quote>.kde4</quote>.
+ <filename>kmymoneyrc</filename>. This file will be in a folder with other &kde;
+ application configuration files. On a &Linux; system, this will be in
+ <filename class="directory">$KDEHOME/share/config</filename> where <envar>$KDEHOME</envar> is usually
+ <quote>.config</quote> within your home folder. If you are migrating from
+ a version of &kmymoney; prior to 5.0 or later, the old location
+ of <envar>$KDEHOME</envar> was <filename class="directory">.kde4</filename>.
</para>
<sect3 id="firsttime.newpc.settings.plugins">
@@ -878,9 +876,9 @@
<para>
If you have run any &kmymoney; plugin, such as the csv importer or exporter,
- it may also have created a configuration file in that same directory, such as
- csvimporterrc or csvexporterrc. These should also be copied to the new
- computer.
+ it may also have created a configuration file in that same folder, such as
+ <filename>csvimporterrc</filename> or <filename>csvexporterrc</filename>.
+ These should also be copied to the new computer.
</para>
<para>
@@ -903,7 +901,7 @@
However, there may be important items which are stored by &kde; and not by
&kmymoney;, such as 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>.
+ relevant files are also stored under <envar>$KDEHOME</envar>.
</para>
</note>
</sect3>
diff --git a/doc/index.docbook b/doc/index.docbook
index 9a6094d68..802841de5 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -14,6 +14,8 @@
from entities/general.entities and $LANG/user.entities. -->
<!ENTITY devlist "<email>kmymoney-devel at kde.org</email>">
<!ENTITY userlist "<email>kmymoney at kde.org</email>">
+ <!-- Support for bulding against old kdoctools versions, included in 5.69 -->
+ <!ENTITY gnucash "<application>GnuCash</application>">
<!-- the following author entity was added to contributor.entities in 4.5 branch and trunk of svn
they can be removed from this file once they are present in the kdelibs minimum version required by &kmymoney; -->
diff --git a/doc/makemostof.docbook b/doc/makemostof.docbook
index 890c8bac9..0d32ddb94 100644
--- a/doc/makemostof.docbook
+++ b/doc/makemostof.docbook
@@ -200,7 +200,7 @@
<term>Asset</term>
<listitem>
<para>
- Property, collections, &etc;.
+ Property, collections, &etc;
</para>
</listitem>
</varlistentry>
@@ -229,7 +229,7 @@
<term>Loan</term>
<listitem>
<para>
- Loans made to you, mortgages, &etc;.
+ Loans made to you, mortgages, &etc;
</para>
</listitem>
</varlistentry>
@@ -314,9 +314,8 @@
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
&kmymoney; works, choose an account you want to track with &kmymoney; and
- select <menuchoice><guimenu>File</guimenu>
- <guimenuitem>New</guimenuitem></menuchoice> in order
- to set up an account file.
+ select the <menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem>
+ </menuchoice> menu item in order to set up an account file.
</para>
<para>
diff --git a/doc/reference.docbook b/doc/reference.docbook
index 38d311794..f947fe52c 100644
--- a/doc/reference.docbook
+++ b/doc/reference.docbook
@@ -115,7 +115,7 @@
</menuchoice></term>
<listitem>
<para><action>Imports financial data from other file types, such as QIF
- and Gnucash, or a template file of accounts and categories that can be
+ and &gnucash;, or a template file of accounts and categories that can be
used in setting up new accounts.</action></para>
</listitem>
</varlistentry>
@@ -193,7 +193,7 @@
<guimenu>File</guimenu><guimenuitem>Quit</guimenuitem>
</menuchoice></term>
<listitem>
- <para><action>Quit &kmymoney;</action></para>
+ <para><action>Quit &kmymoney;.</action></para>
</listitem>
</varlistentry>
</variablelist>
@@ -448,7 +448,7 @@
</menuchoice></term>
<listitem>
<para><action>Imports transactions from online banking for an
- account</action></para>
+ account.</action></para>
</listitem>
</varlistentry>
More information about the kde-doc-english
mailing list