[office/kmymoney/Handbook-5.2] doc: formatting to improve and make markup more consistent, especially screenshots
Jack Ostroff
null at kde.org
Sat Jan 6 00:16:16 GMT 2024
Git commit 304d8065ddae2d80353483ad3504f7d07d635961 by Jack Ostroff.
Committed on 06/01/2024 at 01:14.
Pushed by ostroffjh into branch 'Handbook-5.2'.
formatting to improve and make markup more consistent, especially screenshots
M +0 -3 doc/credits.docbook
M +168 -206 doc/details-accounts.docbook
M +3 -13 doc/details-budgets.docbook
M +27 -34 doc/details-categories.docbook
M +73 -100 doc/details-currencies.docbook
M +32 -29 doc/details-database.docbook
M +23 -39 doc/details-forecast.docbook
M +13 -17 doc/details-formats.docbook
M +130 -59 doc/details-impexp-csv.docbook
D +0 -64 doc/details-impexp-csvexp.docbook
M +0 -3 doc/details-impexp-woob.docbook
M +111 -141 doc/details-impexp.docbook
M +42 -59 doc/details-institutions.docbook
M +107 -167 doc/details-investments.docbook
M +129 -193 doc/details-ledgers.docbook
M +3 -10 doc/details-loans.docbook
M +38 -61 doc/details-payees.docbook
M +18 -35 doc/details-reconciliation.docbook
M +51 -70 doc/details-reports.docbook
M +59 -81 doc/details-schedules.docbook
M +16 -20 doc/details-search.docbook
M +52 -75 doc/details-settings.docbook
M +31 -42 doc/details-tags.docbook
M +0 -1 doc/faq.docbook
M +145 -202 doc/firsttime.docbook
M +2 -7 doc/introduction.docbook
M +15 -46 doc/makemostof.docbook
M +0 -10 doc/reference.docbook
M +4 -10 doc/whatsnew.docbook
https://invent.kde.org/office/kmymoney/-/commit/304d8065ddae2d80353483ad3504f7d07d635961
diff --git a/doc/credits.docbook b/doc/credits.docbook
index ec286e7480..1cfe6fb2aa 100644
--- a/doc/credits.docbook
+++ b/doc/credits.docbook
@@ -25,7 +25,6 @@
</para>
<sect1 id="credits.active"><title>Active Developers</title>
-
<itemizedlist>
<listitem>
<para>
@@ -44,7 +43,6 @@
</sect1>
<sect1 id="credits.special"><title>Special Thanks</title>
-
<itemizedlist>
<listitem>
<para>
@@ -104,7 +102,6 @@
</sect1>
<sect1 id="credits.past"><title>Inactive Developers and Contributors to Previous Versions</title>
-
<itemizedlist>
<listitem>
<para>
diff --git a/doc/details-accounts.docbook b/doc/details-accounts.docbook
index 1d1824d146..dd8f59d479 100644
--- a/doc/details-accounts.docbook
+++ b/doc/details-accounts.docbook
@@ -43,22 +43,18 @@
editing that account.
</para>
-<sect1 id="details.accounts.view">
-<title>The Accounts View</title>
-
-<para>
- <screenshot>
- <screeninfo>account view</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="account_view.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>account view</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect1 id="details.accounts.view"><title>The Accounts View</title>
+<screenshot>
+ <screeninfo>accounts view</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="account_view.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>accounts view</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The Accounts View provides a summary of all the accounts. It is similar to the
@@ -177,9 +173,7 @@
</variablelist>
</sect1>
-<sect1 id="details.accounts.create">
-<title>Creating an Account</title>
-
+<sect1 id="details.accounts.create"><title>Creating an Account</title>
<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
@@ -197,38 +191,36 @@
account...</guimenuitem> from the popup menu.
</para>
-<sect2 id="details.accounts.create.institution">
-<title>The Institution (Bank) name</title>
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz1.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
+<sect2 id="details.accounts.create.institution"><title>The Institution (Bank) name</title>
+<screenshot>
+ <screeninfo>new account wizard - institution</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz1.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new account wizard - institution</phrase>
</textobject>
- </mediaobject>
- </screenshot>
-</para>
+ </mediaobject>
+</screenshot>
<para>
- The first step involves selecting an institution for the account. If this is
- an account for an institution you have already created, you can select the
- institution from the dropdown list. If you want to create a new institution,
- click on the <guibutton>New Institution</guibutton> button. This will bring
- up the New Institution Dialog, as described in the previous section. If this
- is not a bank account, or if you do not want to use online banking, you do not
- need to specify an institution.
+ The first step involves selecting an institution for the account. If this is an
+ account for an institution you have already created, you can select the institution
+ from the dropdown list. If you want to create a new institution, click on the
+ <guibutton>New Institution</guibutton> button. This will bring up the New
+ Institution Dialog, as described in the previous section. If this is not a bank
+ account, or if you do not want to use online banking, you do not need to specify an
+ institution.
</para>
<para>
The Account Number and the <ulink
- url="https://en.wikipedia.org/wiki/International_Bank_Account_Number"><acronym>IBAN</acronym>
- (International Bank Account Number)</ulink> are not currently used
- by &kmymoney;. These fields may be left blank and filled in at a later time;
- they are only required for online banking. <!-- FIXME: check accuracy -->
+ url="https://en.wikipedia.org/wiki/International_Bank_Account_Number">
+ <acronym>IBAN</acronym> (International Bank Account Number)</ulink> are not
+ currently used by &kmymoney;. These fields may be left blank and filled in at a
+ later time; they are only required for online banking.
+ <!-- FIXME: check accuracy -->
</para>
<para>
@@ -236,21 +228,18 @@
</para>
</sect2>
-<sect2 id="details.accounts.create.account">
-<title>Account</title>
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz2.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect2 id="details.accounts.create.account"><title>Account</title>
+<screenshot>
+ <screeninfo>new account wizard - account details</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz2.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new account wizard - account details</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
First, enter a name for the account. This name will be used to identify it.
@@ -387,27 +376,24 @@
</para>
</sect2>
-<sect2>
-<title>Credit Card Accounts</title>
-
+<sect2><title>Credit Card Accounts</title>
<para>
When creating a Credit Card account, after entering the basic information and
clicking <guibutton>Next</guibutton>, you can optionally have &kmymoney; create a
<link linkend="details.schedules">Scheduled Transaction</link> for you.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz6.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>new account wizard - credit card with schedule</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz6.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new account wizard - credit card with schedule</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
If you want such a transaction generated, make sure the checkbox is selected
@@ -419,9 +405,7 @@
</para>
</sect2>
-<sect2>
-<title>Investment Accounts</title>
-
+<sect2><title>Investment Accounts</title>
<para>
In &kmymoney;, Investment accounts contain only equities (stocks, bonds,
&etc;) but do not contain cash. (This is why you cannot specify a Opening
@@ -441,18 +425,17 @@
not expected in the near future.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz7.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>new account wizard - investment</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz7.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new account wizard - investment</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
It is generally best to create the Brokerage account here, which will be given the
@@ -463,9 +446,7 @@
</para>
</sect2>
-<sect2>
-<title>Loan Accounts</title>
-
+<sect2><title>Loan Accounts</title>
<para>
Loan accounts have special features to help you manage Loans with interest and
scheduled repayments. By providing &kmymoney; with information about the loan,
@@ -473,18 +454,17 @@
loan.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz8_1.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>new account wizard - loan details</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz8_1.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new account wizard - loan details</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
On the Details page you enter the general information about the loan.
@@ -531,18 +511,17 @@
<guibutton>Next</guibutton> to continue.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz8_2.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>new account wizard - loan payments</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz8_2.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new account wizard - loan payments</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The Payments page is where you enter the payment and interest values for the loan.
@@ -631,18 +610,17 @@
and you can advance to the next page.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz8_3.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>new account wizard - loan fees</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz8_3.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new account wizard - loan fees</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The Fees page is where you can enter any fees added to the loan payments.
@@ -656,18 +634,17 @@
payment, the total additional fees, and the total periodic payment.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz8_4.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>new account wizard - loan schedule</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz8_4.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new account wizard - loan schedule</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
&kmymoney; will create a <link linkend="details.schedules">Scheduled
@@ -685,18 +662,17 @@
created.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz8_5.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>new account wizard - loan payout</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz8_5.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new account wizard - loan payout</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
Optionally, &kmymoney; can create a transaction representing what was received
@@ -725,22 +701,18 @@
</para>
</sect2>
-<sect2 id="details.accounts.create.parent">
-<title>Parent Account</title>
-
-<para>
- <screenshot>
- <screeninfo>Parent Account</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz10.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect2 id="details.accounts.create.parent"><title>Parent Account</title>
+<screenshot>
+ <screeninfo>new account wizard - parent account</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz10.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new account wizard - parent account</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
This is the penultimate step in creating any new account except a loan. Depending
@@ -765,22 +737,18 @@
</sect2>
-<sect2>
-<title>Review and save the account details</title>
-
-<para>
- <screenshot>
- <screeninfo>Review</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz9.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect2><title>Review and save the account details</title>
+<screenshot>
+ <screeninfo>new account wizard - review and finish</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz9.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new account wizard - review and finish</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
This is the final step in creating a new account. A summary of the information
@@ -799,9 +767,7 @@
</sect2>
</sect1>
-<sect1 id="details.accounts.viewing">
-<title>Opening / viewing accounts</title>
-
+<sect1 id="details.accounts.viewing"><title>Opening / viewing accounts</title>
<para>
To open an account in the <link linkend="details.ledgers.view">Ledgers View</link>,
you can either click on the link to the account in the Home View, or you can click
@@ -816,9 +782,7 @@
</para>
</sect1>
-<sect1 id="details.accounts.edit">
-<title>Editing Account Information</title>
-
+<sect1 id="details.accounts.edit"><title>Editing Account Information</title>
<para>
To edit a particular account, right-click the account name in the Accounts View or
the Institutions View and choose <guimenuitem>Edit account...</guimenuitem> or with
@@ -830,20 +794,20 @@
linkend="details.accounts.create">creating a new account</link>.
</para>
-<para>
- <screenshot>
- <screeninfo>Edit an account</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="account_edit.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Edit account information</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+<screenshot>
+ <screeninfo>edit account information</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="account_edit.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>edit account information</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
-This dialog has several tabs for configuring different aspects of an Account.
+<para>
+ This dialog has several tabs for configuring different aspects of an Account.
</para>
<variablelist>
@@ -1009,9 +973,7 @@ This dialog has several tabs for configuring different aspects of an Account.
</variablelist>
</sect1>
-<sect1 id="details.accounts.delete">
-<title>Deleting accounts</title>
-
+<sect1 id="details.accounts.delete"><title>Deleting accounts</title>
<para>
An account can only be deleted if it has no transactions in it, and is not referred
to by any other item in the data file. In general, this means you first need to
diff --git a/doc/details-budgets.docbook b/doc/details-budgets.docbook
index 1a46c18a74..73266cce85 100644
--- a/doc/details-budgets.docbook
+++ b/doc/details-budgets.docbook
@@ -12,7 +12,6 @@
<title>Budgets</title>
<sect1 id="details.budgets.define"><title>What is a budget?</title>
-
<para>
A budget is a categorized list of expected income and expenses for a period.
</para>
@@ -55,7 +54,6 @@
</sect1>
<sect1 id="details.budgets.create" ><title>Your budgets</title>
-
<para>
You can access your budgets in the <guilabel>Budgets View</guilabel>, which you can
display by clicking the appropriate icon in the navigation pane at the left hand
@@ -74,7 +72,6 @@
</para>
<sect2><title>Viewing, creating, renaming, and deleting budgets</title>
-
<para>
The left section of the Budgets View displays the list of Budgets contained in the
current &kmymoney; file. If no Budget has yet been created the list will be empty.
@@ -195,9 +192,7 @@
</variablelist>
</sect2>
-<sect2>
-<title>Account List</title>
-
+<sect2><title>Account List</title>
<para>
The Accounts List displays the list of Income and Expense Categories. (Remember,
within &kmymoney;, categories are treated as a special type of account.) As in
@@ -282,7 +277,6 @@
</sect2>
<sect2><title>Assignments</title>
-
<para>
The Assignments area shows the values for the Category selected in the Accounts
List.
@@ -393,9 +387,7 @@
</variablelist>
</sect2>
-<sect2>
-<title>Update and Revert</title>
-
+<sect2><title>Update and Revert</title>
<!-- FIXME: confirm there reslly is a Save button. I don't see one, but it might not
appear until you actually have a budget and hit Update. -->
<para>
@@ -431,9 +423,7 @@
</sect2>
</sect1>
-<sect1 id="budget.details.reports">
-<title>Budget Reports</title>
-
+<sect1 id="budget.details.reports"><title>Budget Reports</title>
<para>
&kmymoney; provides a number of reports to compare actual income and expenses
against a Budget. These are listed in Reports under "Budgeting". There are two
diff --git a/doc/details-categories.docbook b/doc/details-categories.docbook
index 4abff3c5c0..5634c07e89 100644
--- a/doc/details-categories.docbook
+++ b/doc/details-categories.docbook
@@ -17,18 +17,18 @@
many of the features of Categories are very similar to those of other Accounts.
</para>
-<sect1 id="details.categories.view">
-<title>Categories View</title>
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="categories.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect1 id="details.categories.view"><title>Categories View</title>
+<screenshot>
+ <screeninfo>categories view</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="categories.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>categories view</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The Categories View provides a summary of all the existing categories in your
@@ -68,9 +68,7 @@
</variablelist>
</sect1>
-<sect1 id="details.categories.create">
-<title>Creating a category</title>
-
+<sect1 id="details.categories.create"><title>Creating a category</title>
<para>
There are 3 ways to create a new category: select the
<menuchoice><guimenu>Category</guimenu><guimenuitem>New
@@ -88,20 +86,20 @@
VAT support, and a checkbox to include this category in tax related reports.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="categoryedit.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>create new category</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="categoryedit.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>create new category</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
</sect1>
-<sect1 id="details.categories.edit">
-<title>Editing a Category</title>
-
+<sect1 id="details.categories.edit"><title>Editing a Category</title>
<para>
To edit a category, right-click on a category name in the Category View, and choose
<guimenuitem>Edit category...</guimenuitem>. A window appears with the same three
@@ -133,7 +131,6 @@
<sect1info>
<author>&Thomas.Baumgart; &Thomas.Baumgart.mail;</author>
</sect1info>
-
<title>VAT Support</title>
<para>
@@ -172,9 +169,7 @@
</sect1>
-<sect1 id="details.categories.delete">
-<title>Deleting a category</title>
-
+<sect1 id="details.categories.delete"><title>Deleting a category</title>
<para>
Deleting a Category is similar to deleting an Account. To delete a category,
right-click its name in the Categories View, and select <guimenuitem>Delete
@@ -203,9 +198,7 @@
</para>
</sect1>
-<sect1 id="details.categories.open_ledger">
-<title>Open ledger for a category</title>
-
+<sect1 id="details.categories.open_ledger"><title>Open ledger for a category</title>
<para>
The menu options for categories includes a choice to open a ledger for that
category. When this option is selected &kmymoney; will display that category in a
diff --git a/doc/details-currencies.docbook b/doc/details-currencies.docbook
index 3a3e7e5bff..81bfc905a3 100644
--- a/doc/details-currencies.docbook
+++ b/doc/details-currencies.docbook
@@ -9,7 +9,6 @@
<date>2023-09-30</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Currencies</title>
<para>
@@ -18,9 +17,7 @@
Pounds, and still have your credit card account in US Dollars.
</para>
-<sect1 id="details.currencies.basecurrency">
-<title>Base currency</title>
-
+<sect1 id="details.currencies.basecurrency"><title>Base currency</title>
<para>
During the initial &kmymoney; <link linkend="firsttime.newfile"> New File
Setup</link>, you are asked to select the base currency. Usually, the base
@@ -41,22 +38,18 @@
menu item.
</para>
-<sect2 id="details.currencies.addcurrency">
-<title>Adding a currency to your data file</title>
-
-<para>
- <screenshot>
- <screeninfo>The currency dialog</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="currency_dialog1.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>show used currencies</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect2 id="details.currencies.addcurrency"><title>Adding a currency to your data file</title>
+<screenshot>
+ <screeninfo>currencies dialog</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="currency_dialog1.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>currencies dialog</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
For a newly created data file, the Currencies dialog will show only the currency
@@ -71,22 +64,18 @@
</para>
</sect2>
-<sect2 id="details.currencies.newcurrency">
-<title>Adding a new currency</title>
-
-<para>
- <screenshot>
- <screeninfo>The select currency dialog</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="select_currency.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>select currency</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect2 id="details.currencies.newcurrency"><title>Adding a new currency</title>
+<screenshot>
+ <screeninfo>add a new currency</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="select_currency.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>add a new currency</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
Although it does not happen often, sometimes a new currency is introduced. This
@@ -104,19 +93,17 @@
<guilabel>Currency editor</guilabel>.
</para>
-<para>
- <screenshot>
- <screeninfo>The Currency editor</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="currency_editor.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>add new currency or edit currency details</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>currency editor</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="currency_editor.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>currency editor</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The Currency editor has some similarities to the dialog for editing details of securities
@@ -180,13 +167,10 @@
Enter the information and click <guilabel>OK</guilabel>, and the currency will be
created.
</para>
-
</sect2>
</sect1>
-<sect1 id="details.currencies.transactions">
-<title>Entering transactions using different currencies</title>
-
+<sect1 id="details.currencies.transactions"><title>Entering transactions using different currencies</title>
<para>
Whenever a transaction is entered that refers to more than one currency, the
exchange rate editor pops up and allows you to enter an exchange rate. Initially,
@@ -202,12 +186,9 @@
</para>
</sect1>
-<sect1 id="details.currencies.prices">
-<title>Exchange rates for currencies</title>
-
-<sect2>
-<title>Entering prices manually</title>
+<sect1 id="details.currencies.prices"><title>Exchange rates for currencies</title>
+<sect2><title>Entering prices manually</title>
<para>
The <guilabel>Price Editor</guilabel>, also called the price database editor,
allows you to enter or modify prices for both investments and exchange rates
@@ -216,19 +197,17 @@
menu item.
</para>
-<para>
- <screenshot>
- <screeninfo>Currency Price Editor</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="currency_priceeditor.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Currency Price Editor</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>security and Currency price editor</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="currency_priceeditor.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>security and currency price editor</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The first column in the dialog is labelled <guilabel>Commodidty</guilabel>, which
@@ -245,19 +224,17 @@
and you get the New Price Entry dialog.
</para>
-<para>
- <screenshot>
- <screeninfo>New Price Entry</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="currency_newpriceentry.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>New Price Entry</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>new price entry</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="currency_newpriceentry.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new price entry</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
Enter the first currency (USD in the example above) in the Security field.
@@ -270,19 +247,17 @@
<guilabel>Exchange Rate/Price Editor</guilabel> dialog.
</para>
-<para>
- <screenshot>
- <screeninfo>Exchange Rate/Price Editor</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="exchange_rate_editor.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Exchange Rate/Price Editor</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>exchange rate/price editor</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="exchange_rate_editor.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>exchange rate/price editor</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
You can specify a price in two ways. You can enter the <guilabel>To
@@ -295,9 +270,7 @@
</para>
</sect2>
-<sect2>
-<title>Online currency updates</title>
-
+<sect2><title>Online currency updates</title>
<para>
&kmymoney; can fetch currency conversion rates from the web. Once you have
entered a single price for a pair of currencies, the online quote feature will
diff --git a/doc/details-database.docbook b/doc/details-database.docbook
index 231a2208e0..29551c868f 100644
--- a/doc/details-database.docbook
+++ b/doc/details-database.docbook
@@ -8,13 +8,11 @@
<date>2023-11-25</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Database</title>
<sect1 id="details.database.usage"><title>Using relational databases</title>
<sect2><title>Introduction</title>
-
<para>
Since 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
@@ -31,12 +29,12 @@
<para>
Although most relational database systems allow concurrent access to a database
by more than one user, this is not possible with &kmymoney;. Even though
- &kmymoney; can store its data in a relational database, it actually behaves as if
- the database is just a different type of file storage. When you open your file,
- the program reads all of the data from the database. As you work with your data,
- the changes are made only to the internal storage; they are not immediately
- written back to the database. Only when you save your data does &kmymoney; write
- the entire file back to the database.
+ &kmymoney; can store its data in a relational database, it actually uses the
+ database as just a different type of file storage. When you open your file, the
+ program reads all of the data from the database. As you work with your data, the
+ changes are made only to the internal storage; they are not immediately written
+ back to the database. Only when you save your data does &kmymoney; write the
+ entire file back to the database.
</para>
<para>
@@ -49,13 +47,12 @@
</sect2>
<sect2><title>Preparation</title>
-
<para>
To access the database, &kmymoney; uses the SQL module supplied by &Qt; Software as
part of their &Qt; programming system. This module supports many database systems
through a collection of drivers. &Qt; has drivers for a large numeber of open
source and proprietary relational database systems, including
- <trademark>MySQL</trademark>, PostgreSQL, and Sqlcipher. The module also supports
+ <trademark>MySQL</trademark>, PostgreSQL, and SQLCipher. The module also supports
some 'heavier', more industrial, systems such as <trademark
class="registered">Oracle</trademark> and IBM <trademark
class="registered">DB2</trademark>.
@@ -67,6 +64,8 @@
for <ulink url="https://www.zetetic.net/sqlcipher">SQLCipher</ulink>, which is a
standalone fork of the SQLite database library that adds 256 bit AES encryption and
other security features. The SQLCipher driver will read existing SQLite files.
+ See the section below on <link
+ linkend="details.database.sqlcipher">SQLCipher</link> for more details.
</para>
<para>
@@ -100,7 +99,6 @@
</sect2>
<sect2><title>Administration</title>
-
<para>
Looking after databases is a little more complex than dealing with regular files.
Each system has different methods for performing those necessary administrative
@@ -111,7 +109,6 @@
</para>
<sect3><title>Creating the database</title>
-
<para>
&kmymoney; includes SQL code to create an initial database to hold your data if one
doesn't exist. However, it is strongly recommended that you pre-create a database,
@@ -140,7 +137,6 @@
</sect3>
<sect3><title>Creating Tables</title>
-
<para>
On your first use, &kmymoney; will attempt to create the necessary table
structures. In order to achieve the maximum compatibility between various database
@@ -158,7 +154,6 @@
</sect2>
<sect2 id="details.database.selectdatabase"><title>Creating a Database</title>
-
<para>
Using &kmymoney;, open or import an existing data file, or create a new one. Then
select <menuchoice><guimenu>File</guimenu><guimenuitem>Save as
@@ -169,10 +164,14 @@
</para>
<screenshot>
+ <screeninfo>creating a database</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="select_database.png" format="PNG" />
</imageobject>
+ <textobject>
+ <phrase>creating a database</phrase>
+ </textobject>
</mediaobject>
</screenshot>
@@ -183,9 +182,8 @@
</para>
<sect3><title>Database Type</title>
-
<para>
- This box lists all the &Qt; SQL drivers installed on your system. Select the
+ This dropdown lists all the &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/">&Qt; software web site</ulink> and search for 'SQL
@@ -193,8 +191,7 @@
</para>
</sect3>
-<sect3><title>File (SQLite only)</title>
-
+<sect3 id="details.database.sqlcipher"><title>File (SQLite/SQLCipher only)</title>
<para>
SQLCipher has one database per file so enter the filename in which you wish to
create the database. To browse the file system, click the icon to the right of the
@@ -204,6 +201,19 @@
by the underlying file system to enable the appropriate access for the currently
logged-in user.
</para>
+
+<para>
+ The creators of <ulink url="https://www zetatic.net/sqlcipher">SQLCipher</ulink>
+ released version 4.0 in November, 2018. However, many &kmymoney; users, especially
+ those who do not upgrade very often, or who use LTS (Long Term Support) &Linux;
+ distributions, may still be using a database created with version 3 of SQLCipher.
+ At some point, usually after upgrading &kmymoney; or their distribution, they find
+ they are unable to open their database, with an error that is not particularly
+ informative or useful. What is required in this case is to upgrade the database
+ itself from version 3 to version 4. Instructions for this can be found on the
+ <ulink url="https://discuss.zetetic.net/t/upgrading-to-sqlcipher-4/3283">SQLCipher
+ website</ulink>.
+</para>
</sect3>
<sect3>
@@ -220,7 +230,6 @@
</sect3>
<sect3><title>Host name</title>
-
<para>
For the average user, the default name of <quote>localhost</quote>, being the
machine you are currently using, is correct. For networked databases, enter the
@@ -229,7 +238,6 @@
</sect3>
<sect3><title>User name and password</title>
-
<para>
Check the permissions set up on your database, or contact the database
administrator, for the correct values to use here. The user name must be capable
@@ -242,7 +250,6 @@
<sect2><title>Accessing your data</title>
<sect3><title>Table design</title>
-
<para>
To access your data in &kmymoney;, use the <menuchoice> <guimenu>File</guimenu>
<guimenuitem>Open Database</guimenuitem> </menuchoice> menu item. This will open a
@@ -431,7 +438,6 @@
</sect3>
<sect3><title>Field formats</title>
-
<para>
Several of the data fields are held in an internal format which may not be
immediately useful to external programs. In these cases, the information has been
@@ -452,7 +458,6 @@
</sect3>
<sect3><title>Updating your data</title>
-
<para>
Having data in an industry standard format does give you the ability to modify it
outside the &kmymoney; application. DO NOT DO IT unless you really know what you
@@ -463,7 +468,6 @@
</sect3>
<sect3><title>Stored queries</title>
-
<para>
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
@@ -477,7 +481,6 @@
</sect2>
<sect2 id="details.database.generatesql"><title>Manual database creation</title>
-
<note>
<para>
This section covers more advanced database usage and may be skipped by the general user.
@@ -485,7 +488,6 @@
</note>
<sect3><title>When to use</title>
-
<para>
There may be occasions when &kmymoney; is unable to create the database
automatically, or creates it without some options required by the user. For
@@ -503,7 +505,6 @@
</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 the
@@ -512,10 +513,14 @@
</para>
<screenshot>
+ <screeninfo>generate sql to create a database</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="generate_sql.png" format="PNG" />
</imageobject>
+ <textobject>
+ <phrase>generate sql to create a database</phrase>
+ </textobject>
</mediaobject>
</screenshot>
@@ -539,7 +544,6 @@
</sect3>
<sect3><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 '<literal>kmm</literal>'.) Some changes,
@@ -557,7 +561,6 @@
</sect2>
<sect2><title>Encryption</title>
-
<para>
Encryption of data in your database is not currently supported.
</para>
diff --git a/doc/details-forecast.docbook b/doc/details-forecast.docbook
index 1de7a8c19b..5e330ddbb1 100644
--- a/doc/details-forecast.docbook
+++ b/doc/details-forecast.docbook
@@ -8,11 +8,9 @@
<date>2023-11-20</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Forecast</title>
<sect1 id="details.forecast.define"><title>What is a Forecast?</title>
-
<para>
In &kmymoney;, a Forecast is a prediction of the balances of Accounts during a
specified future period of time.
@@ -60,7 +58,6 @@
</sect1>
<sect1 id="details.forecast.configure" ><title>Configuring the Forecast</title>
-
<para>
The parameters used to calculate a Forecast, including the forecast method, can be
set in the <link linkend="details.settings.plugins.forecast"> <guilabel>Forecast
@@ -72,19 +69,17 @@
<guilabel>configure</guilabel> icon next to <guilabel>Forecast view</guilabel>.
</para>
-<para>
- <screenshot>
- <screeninfo>forecast configuration</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="plugin_config_forecast.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>forecast configuration</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>forecast configuration</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="plugin_config_forecast.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>forecast configuration</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<variablelist>
<varlistentry>
@@ -177,27 +172,23 @@
</para>
</sect1>
-<sect1 id="details.forecast.view" >
-<title>Viewing the Forecasts</title>
-
+<sect1 id="details.forecast.view" ><title>Viewing the Forecasts</title>
<para>
You can display the Forecast View by clicking the appropriate icon in the
navigation pane at the left hand side of your &kmymoney; window.
</para>
-<para>
- <screenshot>
- <screeninfo>forecast view</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="forecast_view.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>forecast view</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>forecast view</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="forecast_view.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>forecast view</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The top area of the Forecast View is the <guilabel>Forecast Settings</guilabel>.
@@ -261,13 +252,11 @@
</para>
<sect2 id="details.forecast.summary"><title>Summary Tab</title>
-
<para>
The Summary tab has two sections.
</para>
<sect3><title>Account Summary</title>
-
<para>
On the left is the Account Summary, displaying one row of information for each
Asset and Liability, with the columns shows below. Note that if the Forecast is
@@ -329,7 +318,6 @@
</sect3>
<sect3><title>Key Summary Information</title>
-
<para>
The right portion of the Summary tab displays noteworthy information about
accounts. This includes:
@@ -362,7 +350,6 @@
</sect2>
<sect2><title>Details Tab</title>
-
<para>
The Details tab also displays one row for each Asset and Liability account, but the
columns displayed differ from the Summary Tab.
@@ -402,7 +389,6 @@
</sect2>
<sect2><title>Advanced Tab</title>
-
<para>
The Advanced tab also displays one row of information for each Asset and Liability
account. The information is split into columns as follows:
@@ -470,7 +456,6 @@
</sect2>
<sect2><title>Budget Forecast Tab</title>
-
<para>
The Budget tab displays a forecast calculation for all Income and Expense
categories. Unlike the Summary Tab, there is one colum per month, starting with
@@ -481,7 +466,6 @@
</sect2>
<sect2><title>Chart Tab</title>
-
<para>
This displays the Forecase in a chart or graphical form. The level of detail
varies depending on the detail level selected on the option above.
diff --git a/doc/details-formats.docbook b/doc/details-formats.docbook
index 956207b97e..5dae36857c 100644
--- a/doc/details-formats.docbook
+++ b/doc/details-formats.docbook
@@ -8,7 +8,6 @@
<date>2023-11-25</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>File Formats</title>
<para>
@@ -28,7 +27,6 @@
</para>
<sect1><title>Data File formats</title>
-
<para>
In general, &kmymoney; stores its
information in form of an &XML; document. Depending on the actual format, which is
@@ -208,7 +206,6 @@
</sect1>
<sect1 id="details.formats.backup"><title>Backup</title>
-
<para>
We will not attempt here to convince you that making backup copies of your data is
an extremely good idea; hopefully you are already convinced of that. This section
@@ -219,7 +216,6 @@
</para>
<sect2><title>Backup file location</title>
-
<para>
If you need a backup copy of your data to confirm some aspect of your finances at a
previous point in time, or to revert to an earlier state, such as to undo importing
@@ -234,7 +230,6 @@
</sect2>
<sect2><title>Autosave</title>
-
<para>
&kmymoney; has the ability to automatically save a copy of your data file at
regular intervals. It can also do so on closing the program, if the data has
@@ -245,7 +240,6 @@
</sect2>
<sect2><title>File copy</title>
-
<para>
Unless you are using SQL storage, your data may be compressed, and it may be
encrypted, but is kept in a regular file. Whenever you save your data with the
@@ -262,22 +256,24 @@
</sect2>
<sect2><title>Backup command</title>
-
<para>
To make things a bit easier, you can select the <menuchoice>
<guimenu>File</guimenu> <guimenuitem>Backup</guimenuitem> </menuchoice> menu item.
+</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="file-backup.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>file backup</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+<screenshot>
+ <screeninfo>file backup</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="file-backup.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>file backup</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>
When you click <guibutton>OK</guibutton> &kmymoney; will create a copy of your data
file, with the date (formatted as YYYY-MM-DD) appended to the name. Note that this
means only one backup per day can be created by this method. If you have already
diff --git a/doc/details-impexp-csv.docbook b/doc/details-impexp-csv.docbook
index 56e9e4c55d..aba2a661ea 100644
--- a/doc/details-impexp-csv.docbook
+++ b/doc/details-impexp-csv.docbook
@@ -6,13 +6,12 @@
<title>CSV Importer Plugin</title>
<sect2><title>Reasons for importing CSV Files</title>
-
<para>
- In general, it is preferable to import OFX. However, not all institutions
- provide data in that format. CSV (comma separated value) files are almost
- always available, sometimes described as Excel or spreadsheet files. Also,
- they can often be created fairly easily by capturing the data you want to
- import, such as in a text file, and manually editing it.
+ In general, it is preferable to import OFX. However, not all institutions provide
+ data in that format. CSV (comma separated value) files are almost always
+ available, sometimes described as Excel or spreadsheet files. Also, they can often
+ be created fairly easily by capturing the data you want to import, such as in a
+ text file, and manually editing it.
</para>
<para>
@@ -29,7 +28,6 @@
</sect2>
<sect2><title>Getting the plugin</title>
-
<para>
The CSV importer is one of the newer features to have been added to &kmymoney; in
the form of a plugin. However, as with other plugins, the CSV Importer is included
@@ -59,7 +57,6 @@
</sect2>
<sect2><title>Importing a CSV file</title>
-
<para>
To import a CSV file, choose the importer from the main menu: <menuchoice>
<guimenu>File</guimenu> <guisubmenu>Import</guisubmenu>
@@ -74,7 +71,6 @@
</para>
<sect3><title>CSV Import Wizard: Start</title>
-
<para>
When launched, the CSV Importer displays the <guilabel>Start</guilabel> or
<guilabel>File</guilabel> page. On the left is a list of the steps of the import
@@ -86,19 +82,22 @@
prices</guilabel>, and <guilabel>Stock prices</guilabel>. Next, there is a profile
selector dropdown, which is enabled if once the radio button has been selected for
one of the import file types.
-
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="csvImporter_1.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
</para>
+
+<screenshot>
+ <screeninfo>csv import wizard: start</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="csvImporter_1.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>csv import wizard: start</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
</sect3>
<sect3><title>CSV Import Profiles</title>
-
<para>
Each type of CSV file to be imported requires sepcification of several details
regarding the expected formatting of the data, as described in the following
@@ -172,16 +171,20 @@
<para>
After opening your selected data file, the wizard will advance to the
<guilabel>Separators</guilabel> page, and you should now see your data.
-
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="csvImporter_2.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
</para>
+<screenshot>
+ <screeninfo>csv import wizard: separators</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="csvImporter_2.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>csv import wizard: separators</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+
<warning>
<para>
It may appear that the data displayed in the upper section of the plugin window
@@ -210,16 +213,20 @@
You will now be on the <guilabel>Rows</guilabel> or <guilabel>Lines</guilabel>
page. Here, you indicate if any lines should be ignored at the beginning or end of
the file.
-
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="csvImporter_5.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
</para>
+<screenshot>
+ <screeninfo>csv import wizard: rows</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="csvImporter_5.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>csv import wizard: rows</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+
<para>
This page allows you to adjust the import to ignore header and footer rows at the
beginning or end of the file, which do not actually contain data to be imported.
@@ -282,15 +289,17 @@
</para>
<sect4><title>CSV Import Wizard: Banking</title>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="csvImporter_3.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>csv import wizard: banking</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="csvImporter_3.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>csv import wizard: banking</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
For most fields, you just need to use the dropdown to select the appropriate
@@ -377,16 +386,20 @@
is somewhat more complex. Most selections are fairly obvious, but there are
some items which can seem confusing until you have completed the process
once or twice.
-
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="csvImporter_4.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
</para>
+<screenshot>
+ <screeninfo>csv import wizard: investment</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="csvImporter_4.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>csv import wizard: investment</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+
<para>
<itemizedlist>
<listitem>
@@ -474,7 +487,6 @@
</sect4>
<sect4 id="details.impexp.csv.secsym"><title>CSV Import Wizard: Securities and Symbols</title>
-
<para>
For an Investment file, after the <guilabel>Columns</guilabel> page has been
accepted, you need to assure that each security in the file is matched to the
@@ -584,14 +596,12 @@
</sect4>
<sect4><title>CSV Import Wizard: Currency Prices</title>
-
<para>
something about importing currency prices
</para>
</sect4>
<sect4><title>CSV Import Wizard: Stock prices</title>
-
<para>
`something about imporing stock prices
</para>
@@ -653,7 +663,6 @@
</sect3>
<sect3><title>Make QIF File</title>
-
<para>
This button gives you the ability, after the import has been completed, to
save the data from the CSV file as a QIF file, should you require one for any
@@ -665,7 +674,6 @@
</sect3>
<sect3><title>Finishing up</title>
-
<para>
For a <guilabel>Banking</guilabel> import, the plugin has finished, and
&kmymoney; will prompt you, as stated above, for the correct account into
@@ -687,7 +695,6 @@
</sect3>
<sect3><title>Adding Investment Activity Types</title>
-
<para>
If you find that your investment statements keep including activity types that
are not recognized, just add them to the section in the resource file. (See
@@ -709,7 +716,6 @@
</sect3>
<sect3 id="details.impexp.csv.config"><title>Configuration of CSV importer plugin</title>
-
<para>
A well-known drawback of QIF format is that it is a fairly loose format. With CSV
files, there is this same problem, only more so, in that there is no agreed standard
@@ -752,7 +758,6 @@
</para>
<sect4><title>CSV Importer configuration dialog</title>
-
<para>
Finally, there are a few other items which may be configured in a dialog invoked
through the <link linkend="details.settings.plugins.csvimporter">CSV Importer
@@ -765,3 +770,69 @@
</sect3>
</sect2>
</sect1>
+
+<sect1 id="details.impexp.csvexp">
+<sect1info>
+ <author>&Jack.H.Ostroff; &Jack.H.Ostroff.mail;</author>
+</sect1info>
+<title>CSV Exporter</title>
+
+<para>
+ To export data to a CSV file, choose the <menuchoice><guimenu>File</guimenu>
+ <guisubmenu>Export</guisubmenu> <guimenuitem>CSV...</guimenuitem> </menuchoice>
+ menu item. The dialog which appears gives you a number of choices which control
+ the data to be exported.
+</para>
+
+<screenshot>
+ <screeninfo>csv exporter</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="csvexport.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>csv exporter</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+
+<para>
+ Please note that an exported CSV file can include data from only one account.
+</para>
+
+<para>
+ Specify the name of the exported CSV file either by entering the complete path in
+ the <guilabel>File to export to</guilabel> field, or by clicking the
+ <guilabel>Browse</guilabel> button and navigating to it in the Save File dialog.
+ Choose which account to export with the <guilabel>Account to export</guilabel>
+ dropdown.
+</para>
+
+<para>
+ The time period of data exported is controlled by the <guilabel>Date
+ Range</guilabel> <guilabel>Start on</guilabel> and <guilabel>End on</guilabel> date
+ fields. The default values represent the complete date range of your entire data
+ file, and they are adjusted when you select an account to export.
+</para>
+
+<para>
+ By default, the <guilabel>Field Separator</guilabel> is a comma, but you can also
+ choose to use a tab or semicolon.
+</para>
+
+<para>
+ If you check the <guilabel>Contents to Export</guilabel>
+ <guilabel>Account</guilabel> radio button, then the data exported will be the
+ transactions from the specified account and date range. However, if you select the
+ <guilabel>Categories</guilabel> radio button, then the exported file will contain
+ one row for each category which has been defined. For top level categories, the
+ category name is shown, and an <quote>I</quote> or <quote>E</quote> is shown to
+ indicate whether the Category is Income or Expense. For non top-level categories,
+ the parent category is also shown.
+</para>
+
+<para>
+ The exporter will output a set of columns appropriate for the type of account being
+ exported.
+</para>
+</sect1>
diff --git a/doc/details-impexp-csvexp.docbook b/doc/details-impexp-csvexp.docbook
deleted file mode 100644
index 0de0ebdc57..0000000000
--- a/doc/details-impexp-csvexp.docbook
+++ /dev/null
@@ -1,64 +0,0 @@
-<sect1 id="details.impexp.csvexp">
-<sect1info>
- <author>&Jack.H.Ostroff; &Jack.H.Ostroff.mail;</author>
-</sect1info>
-<title>CSV Exporter</title>
-
-<para>
- To export data to a CSV file, choose the <menuchoice><guimenu>File</guimenu>
- <guisubmenu>Export</guisubmenu> <guimenuitem>CSV...</guimenuitem> </menuchoice>
- menu item. The dialog which appears gives you a number of choices which control
- the data to be exported.
-</para>
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="csvexport.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>CSV Export</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-
- Please note that an exported CSV file can include data from only one account.
-</para>
-
-<para>
- Specify the name of the exported CSV file either by entering the complete path in
- the <guilabel>File to export to</guilabel> field, or by clicking the
- <guilabel>Browse</guilabel> button and navigating to it in the Save File dialog.
- Choose which account to export with the <guilabel>Account to export</guilabel>
- dropdown.
-</para>
-
-<para>
- The time period of data exported is controlled by the <guilabel>Date
- Range</guilabel> <guilabel>Start on</guilabel> and <guilabel>End on</guilabel> date
- fields. The default values represent the complete date range of your entire data
- file, and they are adjusted when you select an account to export.
-</para>
-
-<para>
- By default, the <guilabel>Field Separator</guilabel> is a comma, but you can also
- choose to use a tab or semicolon.
-</para>
-
-<para>
- If you check the <guilabel>Contents to Export</guilabel>
- <guilabel>Account</guilabel> radio button, then the data exported will be the
- transactions from the specified account and date range. However, if you select the
- <guilabel>Categories</guilabel> radio button, then the exported file will contain
- one row for each category which has been defined. For top level categories, the
- category name is shown, and an <quote>I</quote> or <quote>E</quote> is shown to
- indicate whether the Category is Income or Expense. For non top-level categories,
- the parent category is also shown.
-</para>
-
-<para>
- The exporter will output a set of columns appropriate for the type of account being
- exported.
-</para>
-</sect1>
diff --git a/doc/details-impexp-woob.docbook b/doc/details-impexp-woob.docbook
index ac1016f2d9..2eda04b042 100644
--- a/doc/details-impexp-woob.docbook
+++ b/doc/details-impexp-woob.docbook
@@ -5,7 +5,6 @@
<title>Woob Importer</title>
<sect2><title>What is Woob?</title>
-
<para>
<acronym><ulink url="https://woob.tech/">Woob</ulink></acronym>, or <quote>Web
outside of browsers</quote> is <quote>a collection of applications able to interact
@@ -28,7 +27,6 @@
</sect2>
<sect2><title>Installing Woob</title>
-
<para>
You need to install Python 3 first before continuing. All major &Linux;
distribuitons package Python, and you should use that version, if possible.
@@ -48,7 +46,6 @@
</sect2>
<sect2><title>Using Woob</title>
-
<para>
If Woob is installed, and the &kmymoney; woob plugin is loaded, you should be able
to set it up for use with an account by invoking the <menuchoice>
diff --git a/doc/details-impexp.docbook b/doc/details-impexp.docbook
index 1b600416c7..01941f0128 100644
--- a/doc/details-impexp.docbook
+++ b/doc/details-impexp.docbook
@@ -8,7 +8,6 @@
<date>2023-20-25</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Importing and Exporting</title>
<sect1 id="details.impexp.gnucash">
@@ -19,7 +18,6 @@
<title>&gnucash; Importer</title>
<sect2><title>&gnucash; Files</title>
-
<para>
The &kmymoney; &gnucash; importer is known to handle direct reading of standard
(&XML;) files as produced by &gnucash; versions 1.8 and 2.0. File from more recent
@@ -66,7 +64,6 @@
<sect2><title>Similarities, Differences, and Terminology</title>
<sect3><title>Small Business Usage</title>
-
<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
@@ -79,7 +76,6 @@
<sect3><title>Accounts</title>
<sect4><title>Account types</title>
-
<para>
For both products, the highest level of structure in the file is the
account. &kmymoney; supports 5 main types of account: Asset, Liability, Income,
@@ -94,7 +90,6 @@
</sect4>
<sect4><title>Categories</title>
-
<para>
&kmymoney; uses the term Category to denote an account of an Income or Expense
type. Unlike &gnucash;, these are not considered as <quote>ledger</quote>
@@ -105,7 +100,6 @@
</sect4>
<sect4><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
@@ -117,7 +111,6 @@
</sect4>
<sect4><title>Account Type map</title>
-
<informaltable frame='all'>
<tgroup cols='2' align='left' colsep='1' rowsep='1'>
<thead>
@@ -183,7 +176,6 @@
<sect3><title>Transactions and Splits</title>
<sect4><title>Balanced transactions</title>
-
<para>
In both programs, data is entered in the form of transactions, each generally
consisting of 2 or more split entries. In fact, valid &gnucash; transactions will
@@ -196,7 +188,6 @@
</sect4>
<sect4><title>Payees</title>
-
<para>
&kmymoney; prefers that all transactions have a Payee (a generic term that
encompasses both payees and payers,) and unlike &gnucash;, it maintains a list of
@@ -206,7 +197,6 @@
</sect4>
<sect4><title>Transfers</title>
-
<para>
&kmymoney; uses the term Transfer to describe a transaction which does not
involve a Category, but only transfers money between Asset and/or Liability
@@ -215,7 +205,6 @@
</sect4>
<sect4><title>Reconcile</title>
-
<para>
&kmymoney; provides an account reconciliation function similar to that of
&gnucash;, and the corresponding transaction status will be imported.
@@ -224,14 +213,12 @@
</sect3>
<sect3><title>Commodities</title>
-
<para>
&gnucash; uses the term Commodity to cover both currencies and non-currency assets.
These are treated separately in &kmymoney;.
</para>
<sect4><title>Currencies</title>
-
<para>
&kmymoney; has built-in support for all foreign <link
linkend="details.currencies">currency</link> types. &kmymoney; also requires that
@@ -252,7 +239,6 @@
</sect4>
<sect4 id="gncsecurities"><title>Securities and Investments</title>
-
<para>
Non-currency assets (typically stocks and bonds) are called Securities by
&kmymoney;, and represent the main difference between the two products, in that
@@ -289,7 +275,6 @@
</sect4>
<sect4><title>Prices and currency rates</title>
-
<para>
Security prices and currency exchange rates, as displayed in the &gnucash; Price
Editor, will be imported. In addition, price and rate entries will be generated
@@ -298,7 +283,6 @@
</sect4>
<sect4 id="details.impexp.gncquotes"><title>Online Quotes</title>
-
<para>
For obtaining online price and currency rate quotations, &gnucash; uses a Perl
based package called <literal>Finance::Quote</literal>. Recent versions of
@@ -319,20 +303,21 @@
<literal>Finance::Quote</literal>, and will always use the native retrieval method.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="gnucash-select_price_source.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>gnucash import price source selection</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="gnucash-select_price_source.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>gnucash import price source selection</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
</sect4>
</sect3>
<sect3 id="gncschedules"><title>Scheduled Transactions</title>
-
<para>
&kmymoney; does not retain the separation made in &gnucash; between template
transactions and their frequency of occurrence. Transaction data will be
@@ -341,7 +326,6 @@
</para>
<sect4><title>Schedule types</title>
-
<para>
&kmymoney; classifies all schedules as one of three types: Bills, Deposits, or
Transfers. Since &gnucash; does not make such a distinction, the importer attempts
@@ -352,7 +336,6 @@
</sect4>
<sect4><title>Suspect Schedules</title>
-
<para>
Some features of &gnucash; scheduled transactions are not available in &kmymoney;,
so the importer tries in each case to reach a reasonable compromise in converting
@@ -387,7 +370,6 @@
</sect3>
<sect3><title>Reports</title>
-
<para>
&kmymoney; provides a comprehensive selection of configurable reports, described in
more detail in <link linkend="details.reports">Reports.</link> These will not
@@ -396,27 +378,26 @@
</sect3>
</sect2>
-<sect2><title>Selecting Importer Options</title>
-
-<para id="details.impexp.gncoptions">
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="gnucash-import_options.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect2 id="details.impexp.gncoptions"><title>Selecting Importer Options</title>
+<screenshot>
+ <screeninfo>gnucash import options</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="gnucash-import_options.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>gnucash import options</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<sect3><title>Investment Handling</title>
-
<para>
See <link linkend="gncsecurities">"Securities and Investments"</link> above.
</para>
</sect3>
<sect3><title>Online Quotes</title>
-
<para>
Turn this off if you wish to use the native method for future online price quotes.
See <link linkend="details.impexp.gncquotes">"Online Quotes"</link> above for more
@@ -425,14 +406,12 @@
</sect3>
<sect3><title>Scheduled Transactions</title>
-
<para>
See <link linkend="gncschedules">"Scheduled Transactions"</link> above.
</para>
</sect3>
<sect3><title>Decoding Options</title>
-
<para>
If your native language is written in letters or symbols which are different from
those used in the 'Latin' languages (&ie;, generally Western European,) these are
@@ -449,7 +428,6 @@
</sect3>
<sect3><title>Transaction Notes option</title>
-
<para>
Under some usage conditions, non-split &gnucash; transactions may contain residual,
often incorrect, memo data which is not normally visible to the user. When
@@ -461,7 +439,6 @@
</sect3>
<sect3><title>Debug Options</title>
-
<para>
These need only be used in the event of import problems. If you have such
problems, you should also report them to the developers' mailing list &devlist;.
@@ -473,7 +450,6 @@
</sect2>
<sect2><title>Import Report</title>
-
<para>
At the end of processing, the importer produces a report showing the number of
different entities processed, and any errors or anomalies encountered. This report
@@ -495,15 +471,17 @@
</listitem>
</itemizedlist>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="gnucash-report.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>gnucash importer report</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="gnucash-report.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>gnucash importer report</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
</sect2>
</sect1>
@@ -553,15 +531,17 @@
<guimenuitem>QIF...</guimenuitem> </menuchoice> menu item.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="qifopen.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>qif importer</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="qifopen.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>qif importer</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The resulting dialog prompts for the QIF filename, allowing you to type in the full
@@ -617,19 +597,17 @@
At the end of the import, &kmymoney; shows a statement import statistics window.
</para>
-<para>
<screenshot>
- <screeninfo>Statement statistics</screeninfo>
+ <screeninfo>qif import statement statistics</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="qif_report.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Statement statistics</phrase>
+ <phrase>qif import statement statistics</phrase>
</textobject>
</mediaobject>
</screenshot>
-</para>
<para>
After importing, all of the imported transactions will be shown with a yellow
@@ -671,7 +649,6 @@
</sect2>
<sect2 id="details.impexp.qif.filter"><title>Writing an import filter</title>
-
<para>
Sometimes you may have data in a custom format, like comma-separated-values (CSV)
or something else unique to your situation. As of version 4.6, &kmymoney; includes
@@ -732,7 +709,6 @@
</sect2>
<sect2><title>Special &kmymoney; QIF extensions</title>
-
<para>
As already mentioned, one of the major drawbacks of the QIF format is the lack of a
unique identifier for each transaction. If you are writing your own QIF file
@@ -744,7 +720,6 @@
</sect1>
<sect1 id="details.impexp.qif.profile"><title>QIF Profiles</title>
-
<para>
To edit an existing QIF Profile, or to create a new one, bring up the QIF Importer
dialog by selecting <menuchoice> <shortcut>
@@ -763,18 +738,19 @@
Configuring either one brings up the same Profile Editor dialog.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="qifimport-qifprofileeditor.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>QIF Profile Editor</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+<screenshot>
+ <screeninfo>qif profile editor general tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="qifimport-qifprofileeditor.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>qif profile editor general tab</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>
On the left, the Profile selector displays a list of all existing QIF Profiles;
select one to edit its configuration. To create an new profile, press the
<guibutton>New</guibutton> button. You can rename an existing profile by selecting
@@ -798,18 +774,19 @@
or not to attempt to match similar transactions to avoid duplicates.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="qifimport-qifprofilefilter.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>QIF Profile Editor</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+<screenshot>
+ <screeninfo>qif profile editor filter tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="qifimport-qifprofilefilter.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>qif profile editor filter tab</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>
The <quote>Filter</quote> tab allows you to specify the location of both an import
filter, as described in the <link linkend="details.impexp.qif.filter">previous
section</link> as well as an output filter, which works similarly, but is applied
@@ -818,18 +795,19 @@
does not require filtering.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="qifimport-qifprofiledate.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>QIF Export</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+<screenshot>
+ <screeninfo>qif profile editor date tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="qifimport-qifprofiledate.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>qif profile editor date tab</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>
The <quote>Date</quote> tab is primarily applicable to QIF Export, as &kmymoney; is
usually able to determine the date format by examining the actual data. The primary
purpose is to specify the order of the date parts, and the delimiter which separates
@@ -849,18 +827,19 @@
will be treated as being in the 1900's.
</para>
+<screenshot>
+ <screeninfo>qif profile editor amounts tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="qifimport-qifprofileamount.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>qif profile editor amounts tab</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="qifimport-qifprofileamount.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>QIF Export</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-
The <quote>Amounts</quote> tab is used on QIF Export to specify the Decimal Symbol
and Thousands Separator to be used. However, you need to speicfy those for each
line in the QIF file which can contain an amount. To alter those settings, click
@@ -884,18 +863,19 @@
actual data.</para>
</note>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="qifimport-export.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>QIF Export</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+<screenshot>
+ <screeninfo>qif exporter</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="qifimport-export.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>qif exporter</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>
The QIF Exporter uses QIF Profiles in a similar way as the QIF Importer, but it
uses the information in the Profile to format the QIF file being written, rather
than to interpret the file being read. Parallel to the importer, you can use a
@@ -930,7 +910,6 @@
can probably just be deleted.
<sect2><title>Getting the plugin</title>
-
<para>
&kmymoney; will import OFX files painlessly. However, this functionality is
not built into the core program. You must obtain and install the OFX Importer
@@ -966,7 +945,6 @@
-->
<sect2><title>What is OFX</title>
-
<para>
<acronym>OFX</acronym> stands for <quote>Open Financial Exchange</quote>.
According to the <ulink url="https://financialdataexchange.org/ofx/">OFX Work Group
@@ -1007,7 +985,6 @@
</sect2>
<sect2><title>Importing OFX data</title>
-
<para>
The OFX standard defines the organization and formatting of financial data, but
that data can exist either as a regular file or as a stream of data between two
@@ -1054,7 +1031,6 @@
</sect2>
<sect2><title>Importing Investments</title>
-
<para>
<!-- FIXME: Was this true in the past? Currently, KMM will create securites in OFX
data if they do not already exist. -->
@@ -1066,7 +1042,6 @@
</sect2>
<sect2 id="details.impexp.webconnect"><title>Web Connect</title>
-
<para>
Rather than explicitly downloading an OFX file, as described above, the easiest way
to import an OFX file is to set up Web Connect. Visit your bank's web site, and
@@ -1086,7 +1061,6 @@
</sect2>
<sect2 id="details.impexp.ofxdirectconnect"><title>Direct Connect</title>
-
<para>
&kmymoney; also supports OFX Direct Connect. This gives allows &kmymoney; the
ability to contact your bank directly to download transactions, assuming the bank
@@ -1181,7 +1155,6 @@
</sect2>
<sect2><title>Exporting an OFX file</title>
-
<para>
It is currently not possible to export your data as an OFX file. If you are
interested to contribute in this area, please contact the libofx development team
@@ -1190,14 +1163,11 @@
</sect2>
</sect1>
-<!-- Using entities for the csv import and export and woob import sections allow them
- to be maintained in separate files. The original note here suggested this was a
- workaround, but I don't know why. -->
-<!-- entities defined in index.docbook -->
-<!-- perhaps these entity invokations should also be in index.docbook, where all
- the chapters are so invoked. -->
+<!-- Using entities (defined in index.docbook) for the csv import/export and woob
+ import sections allow them to be maintained in separate files. -->
+<!-- Should these entity invocations be in index.docbook, where all the chapters are
+ so invoked? -->
&details-impexp-csv;
-&details-impexp-csvexp;
&details-impexp-woob;
</chapter>
diff --git a/doc/details-institutions.docbook b/doc/details-institutions.docbook
index 7c65dee656..1ec3062f75 100644
--- a/doc/details-institutions.docbook
+++ b/doc/details-institutions.docbook
@@ -8,7 +8,6 @@
<date>2018-08-20</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Institutions</title>
<para>
@@ -20,9 +19,7 @@
stores.
</para>
-<sect1 id="details.institutions.view">
-<title>Institutions View</title>
-
+<sect1 id="details.institutions.view"><title>Institutions View</title>
<para>
The Institutions View provides a summary of all the accounts grouped under their
respective institutions. The list of accounts under any institution can be
@@ -37,19 +34,17 @@
selecting or unselecting the checkbox next to the name of the column.
</para>
-<para>
<screenshot>
- <screeninfo>institution view</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="institution_view.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>institution view</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>institution view</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="institution_view.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>institution view</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
-</para>
<variablelist>
<varlistentry>
@@ -119,9 +114,7 @@
</sect1>
-<sect1 id="details.institutions.institution">
-<title>Institution Options</title>
-
+<sect1 id="details.institutions.institution"><title>Institution Options</title>
<para>
Right-clicking an institution name brings up an Institution Options menu, providing
you with several choices. Selecting <guimenuitem>New Institution...</guimenuitem>
@@ -135,35 +128,30 @@
the new account process, which is described in more detail in the next section.
</para>
-<para>
<screenshot>
- <screeninfo>Institution options sub-menu</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="institution_options.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Institution options sub-menu</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>institution options sub-menu</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="institution_options.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>institution options sub-menu</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
-</para>
-
-<sect2 id="details.institutions.new">
-<title>New Institution</title>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="newinst.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>New Institution</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect2 id="details.institutions.new"><title>New Institution</title>
+<screenshot>
+ <screeninfo>new institution</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="newinst.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new institution</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<note><para>
You must have a file open before you can create a new institution. If
@@ -184,9 +172,7 @@
</sect2>
</sect1>
-<sect1 id="details.institutions.account">
-<title>Account Options</title>
-
+<sect1 id="details.institutions.account"><title>Account Options</title>
<para>
The options just discussed refer to the institutions listed in the Institutions
View. Most of the rows in this viw are accounts. Right-clicking an account name
@@ -212,19 +198,16 @@
options, are presented in the appropriate sections of this manual.
</para>
-<para>
<screenshot>
- <screeninfo>account options sub-menu</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="account_options.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>account options sub-menu</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>account options sub-menu</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="account_options.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>account options sub-menu</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
-</para>
-
</sect1>
</chapter>
diff --git a/doc/details-investments.docbook b/doc/details-investments.docbook
index 1f79c3c899..a9c4318ed7 100644
--- a/doc/details-investments.docbook
+++ b/doc/details-investments.docbook
@@ -9,12 +9,9 @@
<date>2023-09-05</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Investments</title>
-<sect1 id="details.investments.overview">
-<title>Investments in &kmymoney;</title>
-
+<sect1 id="details.investments.overview"><title>Investments in &kmymoney;</title>
<para>
In very general terms, an investment is any allocation of money with the
expectation of a future benefit. &kmymoney;'s Investment accounts are designed for
@@ -30,8 +27,7 @@
to a stock or mutual fund, it can be tracked.
</para>
-<sect2>
-<title>Investment Accounts</title>
+<sect2><title>Investment Accounts</title>
<para>
A &kmymoney; Investment Account holds a collection of Securities, also referred to
as Equities. An Investment account contains transactions, recording activities
@@ -52,8 +48,7 @@
</para>
</sect2>
-<sect2 id="details.investments.brokerage">
-<title>Brokerage Accounts</title>
+<sect2 id="details.investments.brokerage"><title>Brokerage Accounts</title>
<para>
When an investment transaction uses (to buy a security) or produces case, such as
from a sale or dividend, that transaction must refer to another account which can
@@ -74,8 +69,7 @@
</para>
</sect2>
-<sect2>
-<title>Base Currency</title>
+<sect2><title>Base Currency</title>
<para>
You &kmymoney; data file has a base currency, specified when the file was created.
In addition, an Investment account has a base currency, specified when it is
@@ -90,9 +84,7 @@
</sect2>
</sect1>
-<sect1 id="details.investments.view">
-<title>The Investments View</title>
-
+<sect1 id="details.investments.view"><title>The Investments View</title>
<para>
The Investments View provides a summary of all your investments, similar to several
of the other major views. It has a single display area, with two tabs. The first
@@ -103,22 +95,18 @@
funds, bonds, &etc;, you track in &kmymoney;.
</para>
-<sect2 id="details.investments.view.equities">
-<title>The Equities tab</title>
-
-<para>
- <screenshot>
- <screeninfo>account view</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="investments_view_equities.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>account view</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect2 id="details.investments.view.equities"><title>The Equities tab</title>
+<screenshot>
+ <screeninfo>investments veiw equities tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="investments_view_equities.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>investments veiw equities tab</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The distinction between equities and securities on these two tabs is somewhat
@@ -210,22 +198,18 @@
</para>
</sect2>
-<sect2 id="details.investments.view.securities">
-<title>The Securities tab</title>
-
-<para>
- <screenshot>
- <screeninfo>account view</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="investments_view_securities.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>account view</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect2 id="details.investments.view.securities"><title>The Securities tab</title>
+<screenshot>
+ <screeninfo>investments veiw securities tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="investments_view_securities.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>investments veiw securities tab</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
At the top of the list of securities is a search box. Beacuse this tab lists all
@@ -303,9 +287,7 @@
</sect2>
</sect1>
-<sect1 id="details.investments.investment">
-<title>Creating an Investment Account</title>
-
+<sect1 id="details.investments.investment"><title>Creating an Investment Account</title>
<para>
The first step on the path to working with investments is to create an Investment
account to hold your defined securities. Choose the
@@ -322,27 +304,25 @@
</para>
</sect1>
-<sect1 id="details.investments.securities">
-<title>Adding Investments to Your Account</title>
-
+<sect1 id="details.investments.securities"><title>Adding Investments to Your Account</title>
<para>
To add individual securities to your Investment Account, navigate to the
<guibutton>Investments</guibutton> View, select the <guibutton>Equities</guibutton>
tab, and choose the Investment account where the investment is held from the
<guilabel>Select Account</guilabel> dropdown.
-
- <screenshot>
- <screeninfo>Investment View, Equities Tab</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="investments_summarytab.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Investment View, Equities Tab</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
</para>
+
+<screenshot>
+ <screeninfo>new investment wizard</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="investments_summarytab.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new investment wizard</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<!-- FIXME: the above shot is of the equities tab. Replace with shot(s) of the new
investment dialog. -->
@@ -353,9 +333,7 @@
Investment Wizard</guilabel> which you use to create your new Investment.
</para>
-<sect2 id="details.investments.newinvestmentwizard">
-<title>New Investment Wizard</title>
-
+<sect2 id="details.investments.newinvestmentwizard"><title>New Investment Wizard</title>
<para>
The first thing you'll be asked to enter is the type of investment. The currently
available values are Stock, Bond, and Mutual Fund. If your investment is not
@@ -512,9 +490,7 @@
</itemizedlist>
</sect2>
-<sect2 id="details.investments.reuse">
- <title>Using a Security in more than one Investment Account</title>
-
+<sect2 id="details.investments.reuse"><title>Using a Security in more than one Investment Account</title>
<note>
<para>
It is possible to own shares of the same security in differentmore than one
@@ -543,9 +519,7 @@
</sect2>
</sect1>
-<sect1 id="details.investments.edit">
-<title>Editing an Investment</title>
-
+<sect1 id="details.investments.edit"><title>Editing an Investment</title>
<para>
The <guilabel>Equities</guilabel> tab of the Investments View lists your current
holdings in this Investment account.
@@ -570,22 +544,18 @@
</para>
</sect1>
-<sect1 id="details.investments.ledger">
-<title>Investment Transactions</title>
-
-<para>
- <screenshot>
- <screeninfo>Investment Transaction Form</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="investment-transactionform.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Investment Transaction Form</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect1 id="details.investments.ledger"><title>Investment Transactions</title>
+<screenshot>
+ <screeninfo>investment transaction form</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="investment-transactionform.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>investment transaction form</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
Investment transactions are entered and edited in the <link
@@ -595,8 +565,7 @@
elements, described below.
</para>
-<sect2>
-<title>Activity</title>
+<sect2><title>Activity</title>
<para>
The Activity for an investment transaction describes what type of action is
happening to the security. The following activities are supported:
@@ -665,8 +634,7 @@
</variablelist>
</sect2>
-<sect2>
-<title>Security</title>
+<sect2><title>Security</title>
<para>
Each investment transaction must be associated with an individual security. The
dropdown shows all securities you own in the current Investment account - select
@@ -674,8 +642,7 @@
</para>
</sect2>
-<sect2>
-<title>Account</title>
+<sect2><title>Account</title>
<para>
For any transaction which generates or requires money, you must enter the account
where the money is transferred to/from. If your investment account has an
@@ -685,8 +652,7 @@
</para>
</sect2>
-<sect2>
-<title>Shares, Price & Total Amount</title>
+<sect2><title>Shares, Price & Total Amount</title>
<para>
For buy, sell, and reinvestment transactions, the number of shares, the price per
share, and the total amount of the transaction must be established. You can enter
@@ -700,8 +666,7 @@
</para>
</sect2>
-<sect2>
-<title>Fees</title>
+<sect2><title>Fees</title>
<para>
With many investment transactions you can include the fees (or commission) you paid
the broker. If you enter a category for the fee, then a field will be shown to the
@@ -713,8 +678,7 @@
</para>
</sect2>
-<sect2>
-<title>Interest</title>
+<sect2><title>Interest</title>
<para>
This is how you enter an interest or dividend payment from a security. As with
fees, if you enter a category, then a field will be shown to the right where you
@@ -723,9 +687,7 @@
</sect2>
</sect1>
-<sect1 id="details.investments.foreign">
-<title>Working With Foreign Investments</title>
-
+<sect1 id="details.investments.foreign"><title>Working With Foreign Investments</title>
<para>
&kmymoney; supports multiple currencies, and there are situations where this can be
very useful, if not essential. However, doing so requires extra care to assure
@@ -753,19 +715,17 @@
that it's in a different currency.
</para>
-<para>
- <screenshot>
- <screeninfo>Currency Warning</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="investment-currencywarning.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Currency Warning</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>investment transaction currency warning</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="investment-currencywarning.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>investment transaction currency warning</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
When you finish entering the transaction, you will be prompted for a price update
@@ -774,19 +734,17 @@
Manually</link> for more information on the price dialog.
</para>
-<para>
- <screenshot>
- <screeninfo>Exchange Rate Editor</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="investment-exchangerateeditor.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Exchange Rate Editor</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>exchange rate editor</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="investment-exchangerateeditor.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>exchange rate editor</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
If you then switch over to the brokerage account, you will see the transaction as
@@ -794,32 +752,26 @@
</para>
</sect1>
-<sect1 id="details.investments.prices">
-<title>Updating Security Prices</title>
-
+<sect1 id="details.investments.prices"><title>Updating Security Prices</title>
<para>
There are two ways of updating the prices for your investments. You can either
enter the price manually or have &kmymoney; fetch it from the web.
</para>
-<sect2>
-<title>Manual Price Updates</title>
-
+<sect2><title>Manual Price Updates</title>
<para>
You can enter prices for your investments using the same <link
linkend="details.currencies.prices">Price Editor</link> as used for currencies.
</para>
</sect2>
-<sect2 id="details.investments.onlinequotes">
-<title>Online Price Quotes</title>
+<sect2 id="details.investments.onlinequotes"><title>Online Price Quotes</title>
<para>
&kmymoney; has the ability to download the latest prices for your securities
and currencies via the web.
</para>
-<sect3>
-<title>How Online Quotes Work</title>
+<sect3><title>How Online Quotes Work</title>
<para>
At your request, &kmymoney; will fetch a page from the web that contains the latest
price for each security. By default, prices are fetched from <ulink
@@ -843,9 +795,7 @@
</para>
</sect3>
-<sect3>
-<title>Assigning a Quote Source</title>
-
+<sect3><title>Assigning a Quote Source</title>
<para>
In order to get online price quotes, you first have to enable the feature for each
security or currency you want updated, by setting an <quote>Online Quote
@@ -876,9 +826,7 @@
</para>
</sect3>
-<sect3>
-<title>Adjusting a quote</title>
-
+<sect3><title>Adjusting a quote</title>
<para>
Some online sources do not report the price in a base quantity (⪚, EUR) but in a
fraction (⪚, Cent). Using this information for a price will produce wrong
@@ -897,9 +845,7 @@
</para>
</sect3>
-<sect3>
-<title>Fetching Quotes</title>
-
+<sect3><title>Fetching Quotes</title>
<para>
Typically, you will update the prices for all your securities and currencies as a
single operation. Choose the
@@ -909,24 +855,20 @@
and currencies in your &kmymoney; file.
</para>
-<para>
- <screenshot>
- <screeninfo>Update Stock and Currency Prices</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="investment-onlineupdate.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Online Stock and Currency Price Update</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>online update stock and currency prices</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="investment-onlineupdate.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>online update stock and currency price</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
</sect3>
-<sect3>
-<title>Adding or Editing Quote Sources</title>
-
+<sect3><title>Adding or Editing Quote Sources</title>
<para>
Adding or editing quote sources is not recommended for anyone but the most
technical user. You should feel comfortable reading HTML and writing complex
@@ -984,9 +926,7 @@
</sect2>
</sect1>
-<sect1 id="details.investments.unimplemented">
-<title>Unimplemented Features</title>
-
+<sect1 id="details.investments.unimplemented"><title>Unimplemented Features</title>
<para>
There are some features that are normally associated with investments which are not
yet implemented in &kmymoney;. These include, but are not limited to derivatives,
diff --git a/doc/details-ledgers.docbook b/doc/details-ledgers.docbook
index 7eddd774e5..681206c2c0 100644
--- a/doc/details-ledgers.docbook
+++ b/doc/details-ledgers.docbook
@@ -10,12 +10,9 @@
<date>2023-09-04</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Ledgers</title>
-<sect1 id="details.ledgers.view">
-<title>The Ledgers View</title>
-
+<sect1 id="details.ledgers.view"><title>The Ledgers View</title>
<para>
The Ledgers View is functionally the data integration center of &kmymoney;. This
view is for entering, examining, editin, and deleting transactions in your defined
@@ -42,18 +39,17 @@
within the Ledgers View includes modifying and reconciling the account.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="ledgerview-numbered.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Ledger View</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>ledgers view</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="ledgerview-numbered.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>ledgers view</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The view has three elements:
@@ -70,21 +66,18 @@
</listitem>
</itemizedlist>
-<sect2 id="details.ledgers.view.filter">
-<title>The filter area</title>
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accountdropdown.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Filter area</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect2 id="details.ledgers.view.filter"><title>The filter area</title>
+<screenshot>
+ <screeninfo>ledgers view filter area</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accountdropdown.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>ledgers view filter area</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
In previous versions of &kmymoney;, the filter area was always displayed at the top
@@ -121,21 +114,18 @@
</para>
</sect2>
-<sect2>
-<title>The transaction list</title>
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="translist.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Transaction list</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect2><title>The transaction list</title>
+<screenshot>
+ <screeninfo>ledgers view transaction list</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="translist.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>ledgers view transaction list</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The transaction list displays all the (possible filtered) transaction in the
@@ -258,9 +248,7 @@
</formalpara>
</sect2>
-<sect2>
-<title>The transaction form</title>
-
+<sect2><title>The transaction form</title>
<para>
Whether or not the transaction form is displayed at the bottom area of the Ledger
View depends on your configuration and the type of account being displayed.
@@ -271,9 +259,7 @@
</sect2>
</sect1>
-<sect1 id="details.ledger.transactions">
-<title>Entering Transactions</title>
-
+<sect1 id="details.ledger.transactions"><title>Entering Transactions</title>
<para>
There are two methods of entering transactions into the ledger: using the
transaction form or entering the data directly into the transaction list. The
@@ -292,21 +278,18 @@
</para>
</sect1>
-<sect1 id="details.ledger.transactionform">
-<title>Using the transaction form</title>
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="transactionform.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Transaction Form</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect1 id="details.ledger.transactionform"><title>Using the transaction form</title>
+<screenshot>
+ <screeninfo>ledgers view transaction form</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="transactionform.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>ledgers view transaction form</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The transaction form at the bottom of the ledger view is the interface for manually
@@ -320,9 +303,7 @@
specific tab or specify To: or From:.
</para>
-<sect2>
-<title>The fields of a transaction</title>
-
+<sect2><title>The fields of a transaction</title>
<para>
Enter the information using the following notes on the available fields. Note that
many fields have <quote>Auto Completion</quote> turned on. That is, if you start
@@ -334,9 +315,7 @@
characters.
</para>
-<sect3>
-<title>Payer/Payee</title>
-
+<sect3><title>Payer/Payee</title>
<para>
This is who the money comes from or goes to. If the payee is a new entry
&kmymoney; will ask if you wish to add this to the list of Payees. Any other
@@ -345,9 +324,7 @@
</para>
</sect3>
-<sect3>
-<title>Category</title>
-
+<sect3><title>Category</title>
<para>
This specifies an income or expense category for accounting and reporting purposes,
and enables you to group certain transactions. Type the name of the category into
@@ -378,9 +355,7 @@
</para>
</sect3>
-<sect3>
-<title>Tags</title>
-
+<sect3><title>Tags</title>
<para>
Tags are similar to Categories, and can be used to maintain an orthogonal view to
Categories. They provide the ability to group transactions within a Category based
@@ -394,18 +369,14 @@
</para>
</sect3>
-<sect3>
-<title>Memo</title>
-
+<sect3><title>Memo</title>
<para>
A single or multi-line memo can be entered if you wish to record any further
details of the transaction.
</para>
</sect3>
-<sect3>
-<title>Number</title>
-
+<sect3><title>Number</title>
<para>
The transaction number can be entered if needed. Note that the check number field
can be made visible or invisible in the ledger list if desired. This is configured
@@ -415,9 +386,7 @@
</para>
</sect3>
-<sect3>
-<title>Date</title>
-
+<sect3><title>Date</title>
<para>
The transaction's date must be entered to specify when the transaction took place.
See the special <link linkend="reference.widgets">&kmymoney; fields</link> section
@@ -433,9 +402,7 @@
</para>
</sect3>
-<sect3>
-<title>Amount</title>
-
+<sect3><title>Amount</title>
<para>
Finally, enter the transaction amount into either the <guilabel>Paymenet</guilabel>
or <guilabel>Deposit</guilabel> field. Note that a simple calculator can be
@@ -456,21 +423,18 @@
</sect2>
</sect1>
-<sect1 id="details.ledger.direct">
-<title>Directly inputting transactions into the list</title>
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="transactionform-off.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Direct Transaction Entry</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect1 id="details.ledger.direct"><title>Directly inputting transactions into the list</title>
+<screenshot>
+ <screeninfo>ledger view direct transaction entry</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="transactionform-off.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>ledgers view direct transaction entry</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The second method of entering transactions into the ledger involves creating and
@@ -491,9 +455,7 @@
<guibutton>OK</guibutton> to be ready to directly enter or edit transactions.
</para>
-<sect2>
-<title>Starting the edit</title>
-
+<sect2><title>Starting the edit</title>
<para>
To enter a new transaction into the ledger, you can either click on the empty entry
at the bottom of the ledger list, press <keycombo
@@ -527,9 +489,7 @@
</sect2>
</sect1>
-<sect1 id="details.ledgers.split">
-<title id="details.ledgers.split.title">Split Transactions</title>
-
+<sect1 id="details.ledgers.split"><title>Split Transactions</title>
<para>
The split transaction feature allows you to divide up a transaction into multiple
categories, representing, for example, the different types of items bought with a
@@ -583,19 +543,17 @@
buttons? -->
</para>
-<para>
- <screenshot>
- <screeninfo>Split with unassigned amount</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="split_unassigned.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Split with unassigned amount</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>split editor split with unassigned amount</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="split_unassigned.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>split editor split with unassigned amount</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
To redistribute an <quote>Unassigned</quote> or <quote>Overassigned</quote> amount,
@@ -613,27 +571,22 @@
displays a comma separated list of the categories in each of the split entries.
</para>
-<para>
- <screenshot>
- <screeninfo>Split transactions</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="split_transaction.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Split transaction</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>split transaction in ledger</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="split_transaction.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>split transaction in ledger</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
</sect1>
-<sect1 id="details.ledger.actions">
-<title>Other transaction actions</title>
-
-<sect2 id="details.ledger.edit">
-<title>Editing transactions</title>
+<sect1 id="details.ledger.actions"><title>Other transaction actions</title>
+<sect2 id="details.ledger.edit"><title>Editing transactions</title>
<para>
To edit a transaction, select it in the list view and either click on
<guibutton>Edit</guibutton> in the transaction form or right-click on the entry and
@@ -644,9 +597,7 @@
</para>
</sect2>
-<sect2 id="details.ledger.delete">
-<title>Deleting transactions</title>
-
+<sect2 id="details.ledger.delete"><title>Deleting transactions</title>
<para>
To delete a transaction, right-click it in the list view and select
<guimenuitem>Delete</guimenuitem> from the popup menu when it appears, or click
@@ -654,9 +605,7 @@
</para>
</sect2>
-<sect2 id="details.ledgers.match">
-<title id="details.ledgers.match.title">Matching Transactions</title>
-
+<sect2 id="details.ledgers.match"><title>Matching Transactions</title>
<para>
Generally, when you import transactions, either via QIF, OFX, or HBCI, &kmymoney;
will automatically attempt to match them against existing transactions. To allow
@@ -727,9 +676,7 @@
</sect2>
</sect1>
-<sect1 id="details.ledgers.cleared">
-<title>Understanding the State of a transaction</title>
-
+<sect1 id="details.ledgers.cleared"><title>Understanding the State of a transaction</title>
<para>
The process of reconciling accounts is discussed <link
linkend="details.reconcile">later in the handbook</link>. For now, it is only
@@ -739,19 +686,17 @@
as cleared and thus transform it to state (C).
</para>
-<para>
- <screenshot>
- <screeninfo>Understanding the cleared state</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="cleared_state.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>cleared state</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>understanding the state of a transaction</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="cleared_state.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>understanding the state of a transaction</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
When you receive a statement from the bank, all cleared transactions should be on
@@ -770,9 +715,7 @@
</para>
</sect1>
-<sect1 id="details.ledgers.settings">
-<title>Changing Transaction Settings</title>
-
+<sect1 id="details.ledgers.settings"><title>Changing Transaction Settings</title>
<para>
There are several options that change the appearance and behavior of the Ledger
view in terms of transactions. These settings are found by selecting
@@ -806,35 +749,33 @@
transaction form.
</para>
-<para>The transaction form:
+<para>The transaction form:</para>
<screenshot>
- <screeninfo>The transaction form</screeninfo>
+ <screeninfo>the transaction form</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="transactionform.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Transaction form</phrase>
+ <phrase>the transaction form</phrase>
</textobject>
</mediaobject>
</screenshot>
-</para>
-<para>Transactions entered directly
+<para>Transactions entered directly:</para>
<screenshot>
- <screeninfo>Transactions entered directly</screeninfo>
+ <screeninfo>transactions entered directly in ledger</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="transactionform-off.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Direct input</phrase>
+ <phrase>transaction entered directly in ledger</phrase>
</textobject>
</mediaobject>
</screenshot>
-</para>
<formalpara><title>Keep changes when selecting a different transaction/split</title>
<para>
@@ -843,30 +784,25 @@
to save changes.
</para>
</formalpara>
-
</sect1>
-<sect1 id="details.ledgers.other">
-<title id="details.ledgers.other.title">Other Transaction Functionality</title>
-
+<sect1 id="details.ledgers.other"><title>Other Transaction Functionality</title>
<para>
Additional options are available from the <guimenu>Transaction Options</guimenu>
menu, accessed by right-clicking any transaction in the list.
</para>
-<para>
- <screenshot>
- <screeninfo>The transaction options sub-menu</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="ledger_more.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Transaction options</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>transaction options sub-menu</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="ledger_more.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>transaction options sub-menu</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
Options include jumping to the Payees view for the Payee in the transaction,
diff --git a/doc/details-loans.docbook b/doc/details-loans.docbook
index a64efd4bcf..651a443454 100644
--- a/doc/details-loans.docbook
+++ b/doc/details-loans.docbook
@@ -8,11 +8,9 @@
<date>2023-11-20</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Loans</title>
<sect1 id="details.loans.general"><title>Understanding Loans</title>
-
<note>
<para>
I am looking for user feedback on whether to expand this section to discuss the
@@ -142,8 +140,7 @@
</sect2>
</sect1>
-<sect1 id="details.loans.example">
-<title>Example</title>
+<sect1 id="details.loans.example"><title>Example</title>
<para>
For an example, you might borrow $25,000.00 for a new automobile and agree to pay
the bank one payment each month for 60 months. The interest rate on the loan might
@@ -166,9 +163,7 @@
</para>
</sect1>
-<sect1 id="details.loans.creation">
-<title>Creating a New Loan</title>
-
+<sect1 id="details.loans.creation"><title>Creating a New Loan</title>
<!-- FIXME: this section should really be expanded with screenshots of the new loan
wizard and more detailed explanation of the various entry fields. In
particular, it needs an explanation of how fixed payments are calculated by
@@ -202,9 +197,7 @@
</para>
</sect1>
-<sect1 id="details.loans.extra-payments">
-<title>Making Extra Principle Repayments On Loans</title>
-
+<sect1 id="details.loans.extra-payments"><title>Making Extra Principle Repayments On Loans</title>
<para>
If you would like to make an extra principal repayment, you can do so. Simply
<link linkend="details.ledger.transactions">enter a transaction</link> using the
diff --git a/doc/details-payees.docbook b/doc/details-payees.docbook
index 9830ba0905..449920be3b 100644
--- a/doc/details-payees.docbook
+++ b/doc/details-payees.docbook
@@ -10,7 +10,6 @@
<date>2023-08-30</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Payees</title>
<para>
@@ -24,9 +23,7 @@
Payer, if you want to track them separately.
</para>
-<sect1 id="details.payees.view">
-<title>Payees View</title>
-
+<sect1 id="details.payees.view"><title>Payees View</title>
<para>
The Payees View provides detailed information about all the payees and payers
involved in transactions. &kmymoney; stores information about all the payees and
@@ -35,15 +32,17 @@
misspelling or typing the wrong name.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="payeeview.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>payees view</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="payeeview.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>payees view</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
Like the Tags View, the Payees View is split into two main areas: a payees and payers list on the
@@ -62,8 +61,7 @@
sections.
</para>
-<sect2>
-<title>Adding a Payee or Payer</title>
+<sect2><title>Adding a Payee or Payer</title>
<para>
To add a payee or payer, click the <guibutton>+</guibutton> New Payee button.<!--
FIXME: use proper icon from button --> This creates a new payee called <quote>New
@@ -72,8 +70,7 @@
</para>
</sect2>
-<sect2>
-<title>Renaming a Payee or Payer</title>
+<sect2><title>Renaming a Payee or Payer</title>
<para>
To rename a payee or payer, either double-click on the name or right-click on the
name and select <guimenuitem>Rename payee</guimenuitem>. The name then becomes
@@ -82,8 +79,7 @@
</para>
</sect2>
-<sect2>
-<title>Deleting a Payee or Payer</title>
+<sect2><title>Deleting a Payee or Payer</title>
<para>
To remove a payee or payer, right-click the name and select
<guimenuitem>Delete payee</guimenuitem>. If the payee has any transactions,
@@ -95,17 +91,14 @@
</para>
</sect2>
-<sect2 id="details.payees.merging">
-<title>Merging Payees</title>
+<sect2 id="details.payees.merging"><title>Merging Payees</title>
<para>
<!-- FIXME: write something here -->You can merge payees.
</para>
</sect2>
</sect1>
-<sect1 id="details.payees.transactionhistory">
-<title>Viewing Transactions for a Payee</title>
-
+<sect1 id="details.payees.transactionhistory"><title>Viewing Transactions for a Payee</title>
<para>
To view all transactions associated with a particular payee, select the payee from
the list and select the <guilabel>Transactions</guilabel> tab in the details area.
@@ -115,27 +108,22 @@
the ledger of the appropriate account, with that transaction selected.
</para>
-<para>
- <screenshot>
- <screeninfo>The transaction tab</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="payee_history.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Transaction history</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>payees view transaction tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="payee_history.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>payees veiw transaction tab</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
</sect1>
-<sect1 id="details.payees.details">
-<title>Additional Payee Details</title>
-
-<sect2>
-<title>Payee Personal Information</title>
+<sect1 id="details.payees.details"><title>Additional Payee Details</title>
+<sect2><title>Payee Personal Information</title>
<para>
To view and edit the personal information associated with a particular payee,
select the payee from the list and select the Address tab. Although we call this
@@ -146,27 +134,22 @@
<guibutton>Update</guibutton> button when finished.
</para>
-<para>
<screenshot>
- <screeninfo>The personal information tab</screeninfo>
+ <screeninfo>payees view personal information tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="payee_info.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Personal information</phrase>
+ <phrase>payees view personal information tab</phrase>
</textobject>
</mediaobject>
</screenshot>
-</para>
</sect2>
-<sect2 id="details.payees.details.matching">
-<title>Transaction Matching Settings</title>
-
-<sect3>
-<title>Overview</title>
+<sect2 id="details.payees.details.matching"><title>Transaction Matching Settings</title>
+<sect3><title>Overview</title>
<para>
&kmymoney; has the ability to automatically assign the proper payee to imported
transactions. This can be handy when importing transactions from your bank, when
@@ -184,22 +167,18 @@
</para>
</sect3>
-<sect3>
-<title>Setting up Payee Matching</title>
-
-<para>
+<sect3><title>Setting up Payee Matching</title>
<screenshot>
- <screeninfo>The payee matching tab</screeninfo>
+ <screeninfo>payees veiw matching tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="payee_match.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Payee matching details</phrase>
+ <phrase>payees view matching tab</phrase>
</textobject>
</mediaobject>
</screenshot>
-</para>
<para>
On the Matching tab, you can set the matching settings for transactions imported
@@ -256,9 +235,7 @@
</para>
</sect3>
-<sect3>
-<title>Importing Transactions</title>
-
+<sect3><title>Importing Transactions</title>
<para>
The Match Keys you have set will be considered whenever you import transactions
using the QIF import, or using a plugin such as OFX or AqBanking. If the Match Key
diff --git a/doc/details-reconciliation.docbook b/doc/details-reconciliation.docbook
index 41c7a35762..0c35e3bea3 100644
--- a/doc/details-reconciliation.docbook
+++ b/doc/details-reconciliation.docbook
@@ -8,12 +8,9 @@
<date>2023-09-30</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Reconciliation</title>
-<sect1 id="details.reconcile.whatis">
-<title>What is reconciliation?</title>
-
+<sect1 id="details.reconcile.whatis"><title>What is reconciliation?</title>
<para>
Reconciliation is the process of assuring that your records for an account agree
with the records of the institution for that account. This is done by matching the
@@ -42,8 +39,7 @@
</para>
</sect1>
-<sect1 id="details.reconcile.wizard">
-<title>The reconciliation wizard</title>
+<sect1 id="details.reconcile.wizard"><title>The reconciliation wizard</title>
<para>
Note that as you progress through the reconciliation process, there are multiple
possible paths for entering all the necessary data, especially if you need to find
@@ -69,22 +65,19 @@
actually start the wizard.
</para>
-<para>
<screenshot>
- <screeninfo>Reconciliation wizard</screeninfo>
+ <screeninfo>reconciliation wizard intro</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="reconcile1.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Reconciliation wizard</phrase>
+ <phrase>reconciliation wizard intro</phrase>
</textobject>
</mediaobject>
</screenshot>
-</para>
-<sect2 id="details.reconcile.wizard.statement">
-<title>Statement details</title>
+<sect2 id="details.reconcile.wizard.statement"><title>Statement details</title>
<para>
The initial statement date presented by &kmymoney; is typically 30 days after the
more recent reconcilion for that account. The starting balance presented is the
@@ -117,23 +110,20 @@
<guibutton>Next</guibutton> button.
</para>
-<para>
<screenshot>
- <screeninfo>Reconciliation wizard</screeninfo>
+ <screeninfo>reconciliation wizard starting information</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="reconcile2.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Reconciliation wizard</phrase>
+ <phrase>reconciliation wizard starting information</phrase>
</textobject>
</mediaobject>
</screenshot>
-</para>
</sect2>
-<sect2 id="details.reconcile.wizard.interest">
-<title>Interest</title>
+<sect2 id="details.reconcile.wizard.interest"><title>Interest</title>
<para>
If you are reconciling a bank account or any account with interest and/or charges
or fees, then enter these values in the appropriate fields. Both fields are
@@ -150,19 +140,17 @@
</para>
</note>
-<para>
<screenshot>
- <screeninfo>Reconciliation wizard</screeninfo>
+ <screeninfo>reconciliation wizard interest and chanrges</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="reconcile3.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Reconciliation wizard</phrase>
+ <phrase>reconciliation wizard interest and charges</phrase>
</textobject>
</mediaobject>
</screenshot>
-</para>
<para>
Click on <guibutton>Continue</guibutton> to start matching your statement to what
@@ -177,8 +165,7 @@
</para>
</sect2>
-<sect2 id="details.reconcile.wizard.clearing">
-<title>Clearing transactions</title>
+<sect2 id="details.reconcile.wizard.clearing"><title>Clearing transactions</title>
<para>
During the reconciliation, any transaction can be edited to make it match the
statement, and new transactions can be created as usual. To mark a transaction as
@@ -207,23 +194,21 @@
</para>
<screenshot>
- <screeninfo>Reconciliation wizard</screeninfo>
+ <screeninfo>ledger during reconciliation</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="reconcile4.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Reconciliation wizard</phrase>
+ <phrase>ledger during reconciliation</phrase>
</textobject>
</mediaobject>
</screenshot>
</sect2>
-<sect2 id="details.reconcile.complete">
-<title>Completing Reconciliation</title>
+<sect2 id="details.reconcile.complete"><title>Completing Reconciliation</title>
-<sect3 id="details.reconcile.finish">
-<title>Finishing Reconciliation</title>
+<sect3 id="details.reconcile.finish"><title>Finishing Reconciliation</title>
<para>
When the difference between the statement and the cleared balance is zero, then the
account is reconciled and you can click the <guibutton>Finish</guibutton> button.
@@ -238,8 +223,7 @@
<!-- FIXME: talk about the reconciliation report -->
-<sect3 id="details.reconcile.postpone">
-<title>Postponing Reconciliation</title>
+<sect3 id="details.reconcile.postpone"><title>Postponing Reconciliation</title>
<para>
If you're having trouble completing the reconciliation, or you need to gather
additional information before you can complete the process, you can postpone the
@@ -263,17 +247,16 @@
</para>
<screenshot>
- <screeninfo>Reconciliation wizard</screeninfo>
+ <screeninfo>reconciliation wizard finish</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="reconcile-redo.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Reconciliation wizard</phrase>
+ <phrase>reconciliation; wizard finish</phrase>
</textobject>
</mediaobject>
</screenshot>
-
</sect3>
</sect2>
</sect1>
diff --git a/doc/details-reports.docbook b/doc/details-reports.docbook
index 98f69c3b7d..853634e864 100644
--- a/doc/details-reports.docbook
+++ b/doc/details-reports.docbook
@@ -8,24 +8,20 @@
<date>2023-10-02</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Reports</title>
<sect1 id="details.reports.avail"><title>Available Reports</title>
-
-<para>
<screenshot>
- <screeninfo>Reports View</screeninfo>
+ <screeninfo>reports view</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="reports_view_list.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Reports View</phrase>
+ <phrase>reports view</phrase>
</textobject>
</mediaobject>
</screenshot>
-</para>
<para>
The <guilabel>Reports></guilabel> tab of the Reports View lists all available
@@ -168,7 +164,6 @@
</sect1>
<sect1 id="details.reports.working"><title>Working With Reports</title>
-
<para>
There are a number of actions you can take on each report. You can access some
these by right-clicking the report name in the list of reports, which brings up the
@@ -206,8 +201,7 @@
</itemizedlist>
</sect1>
-<sect1 id="details.reports.config">
-<title>Configuring Reports</title>
+<sect1 id="details.reports.config"><title>Configuring Reports</title>
<sect2><title>Working with custom reports</title>
<para>
@@ -237,18 +231,17 @@
</para>
<sect3 id="details.reports.config.general"><title>General subtab</title>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="reports_configuration_general.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Report Configuration - General</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>report configuration report tab general subtab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reports_configuration_general.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>report configuration report tab general subtab</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
Here you set the basic properties of the report.
@@ -286,18 +279,17 @@
depending on the style of report you are configuring.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="reports_configuration_rowscolumns.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Report Configuration - Rows and Columns</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>report configuration report tab rows/columns subtab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reports_configuration_rowscolumns.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>report configuration report tab rows/columns subtab</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
For income/expense and net worth reports:
@@ -385,18 +377,17 @@
Charts</link> section for more explanation of the charting functions.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="reports_configuration_chart.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Report Configuration - Chart</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>report configuration report tab chart subtab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reports_configuration_chart.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>report configuration report tab chart subtab</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<itemizedlist>
<listitem>
@@ -437,18 +428,17 @@
linkend="details.reports.config.report">Filters tab</link>.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="reports_configuration_range.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Report Configuration - Range</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>report configuration report tab range subtab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="reports_configuration_range.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>report configuration report tab range subtab</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<sect3><title>Date range</title>
<para>
@@ -479,8 +469,7 @@
</sect3>
</sect2>
-<sect2>
-<title>Filters tab</title>
+<sect2><title>Filters tab</title>
<para>
The filters tab has several subtabs, which can be used to filter or limit the data
&kmymoney; uses to prepare the report. These are the same subtabs used to control
@@ -493,7 +482,6 @@
<sect1 id="details.reports.charts"><title>Graphs & Charts</title>
<sect2><title>Viewing as a Chart</title>
-
<para>
Many reports can be viewed in either textual form or graphical (chart) form. The
same report configuration parameters are used in either case. You can easily jump
@@ -515,7 +503,6 @@
<sect2><title>Available Chart Types</title>
<sect3><title>Line Graph</title>
-
<para>
A line graph is one of the simplest forms of a chart. There is one line for each
series. Usually, a series is data from a single account or category over time; see
@@ -534,18 +521,14 @@
</para>
</sect3>
-<sect3>
-<title>Bar Graph</title>
-
+<sect3><title>Bar Graph</title>
<para>
The bar graph works exactly the same as the line graph, except there is one bar for
each series in each time slice.
</para>
</sect3>
-<sect3>
-<title>Pie Chart</title>
-
+<sect3><title>Pie Chart</title>
<para>
The pie chart is the simplest chart type available. It shows data from only one
time slice, as opposed to showing the values across time. This chart shows only
@@ -555,9 +538,7 @@
</para>
</sect3>
-<sect3>
-<title>Ring Chart</title>
-
+<sect3><title>Ring Chart</title>
<para>
The ring chart is very similar to a pie chart, except there is one
<quote>ring</quote> for each time slice in the report.
diff --git a/doc/details-schedules.docbook b/doc/details-schedules.docbook
index 5c159e8801..b95fe14d65 100644
--- a/doc/details-schedules.docbook
+++ b/doc/details-schedules.docbook
@@ -10,12 +10,9 @@
<date>2023-08-30</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Schedules</title>
-<sect1 id="details.schedules.intro">
-<title>Introduction</title>
-
+<sect1 id="details.schedules.intro"><title>Introduction</title>
<para>
Schedules maintain information about transactions that occur one or more times over
a specified period of time.
@@ -56,9 +53,7 @@
</para>
</sect1>
-<sect1 id="details.schedules.type">
-<title>Types of schedules</title>
-
+<sect1 id="details.schedules.type"><title>Types of schedules</title>
<para>
There are four different types of schedules in &kmymoney;:
</para>
@@ -92,28 +87,24 @@
</formalpara>
</sect1>
-<sect1 id="details.schedules.view">
-<title>The Schedules View</title>
-
+<sect1 id="details.schedules.view"><title>The Schedules View</title>
<para>
- Open the Schedules View by clicking on the
- <guiicon><inlinemediaobject><imageobject><imagedata fileref="schedule_view.png"
- format="PNG"/></imageobject></inlinemediaobject></guiicon> Scheduled transactions
- 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> Scheduled transactions icon in the view selector.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="scheduleview.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Schedule View</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>schedules view</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="scheduleview.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>schedules view</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The Schedules View consists of a sinngle display area with a <guibutton>New
@@ -129,20 +120,18 @@
</para>
</sect1>
-<sect1 id="details.schedules.new">
-<title>The New Schedule dialog</title>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="newsched_numbered.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>New Schedule</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect1 id="details.schedules.new"><title>The New Schedule dialog</title>
+<screenshot>
+ <screeninfo>new schedule dialog</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="newsched_numbered.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>new schedule dialog</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
A New Schedule dialog is now shown, prompting for the schedule and transaction
@@ -159,9 +148,7 @@
<listitem><para>Schedule options</para></listitem>
</orderedlist>
-<sect2>
-<title>Filling in the Schedule name, Frequency, and Payment information.</title>
-
+<sect2><title>Filling in the Schedule name, Frequency, and Payment information.</title>
<para>
Enter the name of the schedule and the date of the next occurrence into their
respective fields. The name is how the schedule will be labelled in the Schedules
@@ -179,8 +166,7 @@
</para>
</sect2>
-<sect2>
-<title>Modifying the Schedule Options section</title>
+<sect2><title>Modifying the Schedule Options section</title>
<para>
The <guilabel>If this schedule occurs on a non-processing date:</guilabel> dropdown
allows you to choose how to handle non-processing days. Non-processing days
@@ -239,9 +225,7 @@
</sect2>
</sect1>
-<sect1 id="details.schedules.edit">
-<title>Editing schedules</title>
-
+<sect1 id="details.schedules.edit"><title>Editing schedules</title>
<para>
To edit a schedule simply select the entry in the list, then right-click and select
<guimenuitem>Edit scheduled transaction</guimenuitem> in the context menu. This
@@ -250,9 +234,7 @@
</para>
</sect1>
-<sect1 id="details.schedules.delete">
-<title>Deleting schedules</title>
-
+<sect1 id="details.schedules.delete"><title>Deleting schedules</title>
<para>
To delete a schedule simply select the entry in the list, then right-click and
select <guimenuitem>Delete scheduled transaction</guimenuitem>. in the context
@@ -260,9 +242,7 @@
</para>
</sect1>
-<sect1 id="details.schedules.duplicate">
-<title>Duplicating schedules</title>
-
+<sect1 id="details.schedules.duplicate"><title>Duplicating schedules</title>
<para>
To duplicate a schedule simply select the entry in the list, then right-click and
select <guimenuitem>Duplicate scheduled transaction</guimenuitem> in the context
@@ -270,9 +250,7 @@
</para>
</sect1>
-<sect1 id="details.schedules.entering">
-<title>Entering scheduled transactions</title>
-
+<sect1 id="details.schedules.entering"><title>Entering scheduled transactions</title>
<para>
Entering a scheduled transaction means actually enteringcreating a transaction in
the appropriate ledger, using the details specified in the schedule. Scheduled
@@ -300,9 +278,7 @@
</listitem>
</itemizedlist>
-<sect2>
-<title>Confirming the transaction to enter</title>
-
+<sect2><title>Confirming the transaction to enter</title>
<para>
The first and third methods will display an <guilabel>Enter scheduled
transaction</guilabel> dialog (possibley after displaying an informational window
@@ -310,15 +286,17 @@
information that was entered when you created the schedule.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="enterschedule.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>enter scheduled transaction</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="enterschedule.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>enter schedule transaction</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
This information can be changed, and the changes can be applied to just this one
@@ -330,15 +308,17 @@
changes.
</para>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="confirm_enter.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>confirm manual transaction changes</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="confirm_enter.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>confirm manual transaction changes</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
Select what you want to do with the information presented and click
@@ -346,9 +326,7 @@
</para>
</sect2>
-<sect2>
-<title>Letting &kmymoney; enter the scheduled transaction(s) for you</title>
-
+<sect2><title>Letting &kmymoney; enter the scheduled transaction(s) for you</title>
<para>
Alternatively, &kmymoney; can check which schedules are due upon startup and enter
them for you if the appropriate option was checked when setting up the schedule.
diff --git a/doc/details-search.docbook b/doc/details-search.docbook
index 1655502f9f..0e85c97996 100644
--- a/doc/details-search.docbook
+++ b/doc/details-search.docbook
@@ -8,7 +8,6 @@
<date>2023-11-25</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Search Transactions</title>
<para>
@@ -47,7 +46,6 @@
</para>
<sect1 id="details.search.criteria"><title>Search Criteria</title>
-
<para>
There are several subtabs under the main Criteria tab, each of which allows you to
specify a different type of search criteria. Below the area for specifying the
@@ -55,16 +53,15 @@
currently specified for the search.
</para>
-<sect2 id="details.search.text">
-<title>Text</title>
-
+<sect2 id="details.search.text"><title>Text</title>
<screenshot>
+ <screeninfo>search transactions, criteria tab, text subtab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="find-text.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Search transactions Dialog, Text tab</phrase>
+ <phrase>search transactions, criteria tab, text subtab</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -114,14 +111,14 @@
</sect2>
<sect2 id="details.search.account"><title>Account</title>
-
<screenshot>
+ <screeninfo>search transactions, criteria tab, account subtab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="find-account.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Search transactions Dialog, Account tab</phrase>
+ <phrase>search transactions, criteria tab, account subtab</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -142,14 +139,14 @@
</sect2>
<sect2 id="details.search.date"><title>Date</title>
-
<screenshot>
+ <screeninfo>search transactions, criteria tab, date subtab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="find-date.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Search transactions Dialog, Date tab</phrase>
+ <phrase>search transactions, criteria tab, date subtab</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -171,14 +168,14 @@
<sect2 id="details.search.amount"><title>Amount</title>
-
<screenshot>
+ <screeninfo>search transactions, criteria tab, amount subtab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="find-amount.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Search transactions Dialog, Amount tab</phrase>
+ <phrase>search transactions, criteria tab, amount subtab</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -195,14 +192,14 @@
</sect2>
<sect2 id="details.search.category"><title>Category</title>
-
<screenshot>
+ <screeninfo>search transactions, criteria tab, category subtab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="find-category.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Search transactions Dialog, Category tab</phrase>
+ <phrase>search transactions, criteria tab, category subtab</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -230,14 +227,14 @@
</sect2>
<sect2 id="details.search.tag"><title>Tag</title>
-
<screenshot>
+ <screeninfo>search transactions, criteria tab, tag subtab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="find-tag.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Search transactions Dialog, Tag tab</phrase>
+ <phrase>search transactions, criteria tab, tag subtab</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -265,14 +262,14 @@
</sect2>
<sect2 id="details.search.payee"><title>Payee</title>
-
<screenshot>
+ <screeninfo>search transactions, criteria tab, payee subtab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="find-payee.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Search transactions Dialog, Payee tab</phrase>
+ <phrase>search transactions, criteria tab, payee subtab</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -296,8 +293,8 @@
</sect2>
<sect2 id="details.search.details"><title>Details</title>
-
<screenshot>
+ <screeninfo>search transactions, criteria tab, details subtab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="find-details.png" format="PNG" />
@@ -345,7 +342,6 @@
</sect1>
<sect1 id="details.search.results"><title>Search results</title>
-
<para>
The <guilabel>Result</guilabel> tab displays the Entry (entry date, optional,) Date
(posting date,) Account, Payee, Details (memo,) C (reconciliation status,)
diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook
index 9c750d0a68..75fc550bdf 100644
--- a/doc/details-settings.docbook
+++ b/doc/details-settings.docbook
@@ -9,7 +9,6 @@
<date>2023-12-30</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>&kmymoney; Settings</title>
<para>
@@ -33,14 +32,14 @@
<sect1 id="details.settings.general"><title>General</title>
<sect2 id="details.settings.general.global"><title>Global tab</title>
-
<screenshot>
+ <screeninfo>KMyMoney configuration, general, global tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="config_general_global.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>general config global tab</phrase>
+ <phrase>KMyMoney configuration, general, global tab</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -130,14 +129,14 @@
</sect2>
<sect2 id="details.settings.general.views"><title>Views tab</title>
-
<screenshot>
+ <screeninfo>KMyMoney configuration, general, views tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="config_general_views.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>general config views tab</phrase>
+ <phrase>KMyMoney configuration, general, views tab</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -193,14 +192,14 @@
</sect2>
<sect2 id="details.settings.general.filter"><title>Filter tab</title>
-
<screenshot>
+ <screeninfo>KMyMoney configuration, general, filter tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="config_general_filter.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>general config filter tab</phrase>
+ <phrase>KMyMoney configuration, general, filter tab</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -276,14 +275,14 @@
</sect2>
<sect2 id="details.settings.general.support"><title>Support tab</title>
-
<screenshot>
+ <screeninfo>KMyMoney configuration, general section, support tab</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="config_general_support.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>general config support tab</phrase>
+ <phrase>KMyMoney configuration, general section, support tab</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -330,18 +329,18 @@
</sect1>
<sect1 id="details.settings.home"><title>Home</title>
-
<!-- FIXME: sect2 should only be used for tabs. I'm too lazy to convert this to a
variablelist now, which would require subsuming the lower one to paras. -->
-<sect2><title>Home page display sections</title>
+<sect2><title>Home page display sections</title>
<screenshot>
+ <screeninfo>KMyMoney configuration, home view</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="config_home.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>home config</phrase>
+ <phrase>KMyMoney configuration, home view</phrase>
</textobject>
</mediaobject>
</screenshot>
@@ -466,7 +465,6 @@
</sect2>
<sect2><title>Homepage/Summary page scaling</title>
-
<variablelist>
<varlistentry>
<term><guilabel>Zoom factor:</guilabel></term>
@@ -488,7 +486,6 @@
</sect2>
<sect2 id="details.settings.home.acctinfo"><title>Account information display</title>
-
<para>
These options allow you to customize what information is included in any list of
accounts.
@@ -554,16 +551,13 @@
</sect2>
</sect1>
-<sect1 id="details.settings.register">
-<title>Ledger</title>
-
+<sect1 id="details.settings.register"><title>Ledger</title>
<para>
The settings and options in this section allow for the modification of the
transaction register displayed in the Ledger View.
</para>
<sect2 id="details.settings.register.display"><title>Display tab</title>
-
<variablelist>
<varlistentry>
<term><guilabel>Show a grid in the ledger</guilabel></term>
@@ -715,8 +709,7 @@
</para>
</sect3>
-<sect3 id="details.settings.register.sorting.reconciliation">
-<title>Reconciliation view subtab</title>
+<sect3 id="details.settings.register.sorting.reconciliation"><title>Reconciliation view subtab</title>
<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
@@ -724,8 +717,7 @@
</para>
</sect3>
-<sect3 id="details.settings.register.sorting.search">
-<title>Search view subtab</title>
+<sect3 id="details.settings.register.sorting.search"><title>Search view subtab</title>
<para>
This tab controls the default sort order of the ledger while in the <link
linkend="details.search">Search view</link>.
@@ -734,7 +726,6 @@
</sect2>
<sect2 id="details.settings.register.dataentry"><title>Data Entry tab</title>
-
<para>These options affect the process of creating new transactions.</para>
<variablelist>
@@ -881,7 +872,6 @@
</sect2>
<sect2 id="details.settings.register.import"><title>Import tab</title>
-
<variablelist>
<varlistentry>
<term><guilabel>Match transaction within days</guilabel></term>
@@ -907,7 +897,6 @@
</sect1>
<sect1 id="details.settings.schedules"><title>Scheduled Transactions</title>
-
<para>
These options allow you to modify the behavior of <link
linkend="details.schedules">Scheduled Transactions</link>.
@@ -974,7 +963,6 @@
</sect1>
<sect1 id="details.settings.onlinequote"><title>Online Quotes</title>
-
<para>
These settings determine how price quotes are retrieved from different online
sources. These include stock, bond, and other equity prices, as well as prices for
@@ -1008,7 +996,6 @@
</sect1>
<sect1 id="details.settings.colors"><title>Colors</title>
-
<para>
These section allows you to customize the colors used within &kmymoney;. If
<guilabel>Custom colors</guilabel> is not checked, then default colors will be
@@ -1026,7 +1013,6 @@
</sect1>
<sect1 id="details.settings.fonts"><title>Fonts</title>
-
<para>
This section allows you to modify the fonts used within the Cell or Header fields.
</para>
@@ -1062,7 +1048,6 @@
</sect1>
<sect1 id="details.settings.icons"><title>Icons</title>
-
<para>
This option allows for the selection of icons that will be displayed.
</para>
@@ -1082,26 +1067,27 @@
</sect1>
<sect1 id="details.settings.plugins"><title>Plugins</title>
-
<para>
This section provides information about the available plugins, and allow you to
modify the behavior of some of them. Note that the list of plugins displayed will
depend on which plugins &kmymoney; found when it started. It does not matter
whether the plugin was compiled as part of the application or added as a separate
package.
+</para>
- <screenshot>
- <screeninfo>Configure Plugins</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="configure_plugins.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Configure Plugins</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+<screenshot>
+ <screeninfo>KMyMoney configuration, plugins</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="configure_plugins.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>KMyMoney configuration, plugins</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+<para>
Every plugin can be enabled or disabled, according to the state of the checkbox to
the left of the name of the plugin name and icon. In addition, at the right, there
is an <guibutton>information</guibutton> &infoicon; button for each plugin, which
@@ -1120,7 +1106,6 @@
</para>
<sect2 id="details.settings.plugins.printchecks"><title>Check printing plugin</title>
-
<para>
There is a plugin for printing checks, which is included with the source of
&kmymoney;, and which should always be enabled. It allows printing of a check
@@ -1180,25 +1165,24 @@
</sect2>
<sect2 id="details.settings.plugins.csvimporter"><title>CSV Importer</title>
-
<para>
Some aspects of configuring the CSV Importer plugin have already been discussed
<link linkend="details.settings.plugins.csvimporter">here</link>. However, there
is also a dialog which can be invoked here.
-
- <screenshot>
- <screeninfo>Configure CSV Importer Plugin</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="config_plugins_csvimporter.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Configure CSV Importer Plugin</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
</para>
+<screenshot>
+ <screeninfo>configure csv importer plugin</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="config_plugins_csvimporter.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>configure csv importer plugin</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+
<sect3><title>Autodetecting</title>
<para>
It is generally best to let the plugin autodetect the field delimiter, decimal
@@ -1224,7 +1208,6 @@
</sect2>
<sect2 id="details.settings.plugins.forecast"><title>Forecast view</title>
-
<para>
This is described in the <link linkend="details.forecast.configure">Configuring the
Forecast</link> section of the <link linkend="details.forecast">Forecast
@@ -1234,7 +1217,6 @@
<sect2><title>iCalendar</title>
<!-- FIXME: isn't this mentioned anywhere else? -->
-
<para>
&kmymoney; is capable of exporting a file inb then <quote>iCalendar</quote> format,
so you can import your scheduled transactions into &korganizer;, or another
@@ -1242,20 +1224,20 @@
exporting the file is done with the <menuchoice> <guimenu>File</guimenu>
<guisubmenu>Export</guisubmenu> <guimenuitem>Schedules to iCalendar</guimenuitem>
</menuchoice>menu item.
-
- <screenshot>
- <screeninfo>Configure iCalendar export</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="config_plugins_ical.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Configure iCalendar export</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
</para>
+<screenshot>
+ <screeninfo>configure icalendar export</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="config_plugins_ical.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>configure icalendar export</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+
<para>
The exported file will contain one event for each scheduled transaction. There are
controls to configure whether to have the calender show reminders for the events,
@@ -1273,7 +1255,6 @@
</sect2>
<sect2 id="details.settings.plugins.kbanking"><title>KBanking</title>
-
<para>
Since both this and the Configure Aqbanking page are minimal, should both just
point to the same link currently in the other section?
@@ -1290,7 +1271,6 @@
</sect2>
<sect2><title>QIF Exporter, QIF Importer</title>
-
<para>
These are described in the section on <link
linkend="details.impexp.qif.profile">QIF Profiles</link>. As pointed out in that
@@ -1302,7 +1282,6 @@
<sect2><title>Reports view</title>
<!-- FIXME: this needs better incorporation into the Reports Chapter. It is currently
not mentioned there at all. -->
-
<para>
This provides a dialog where you can configure some default values to be used when displaying
<link linkend="details.reports">Reports</link>.
@@ -1328,14 +1307,12 @@
<guilabel>Default CSS file</guilabel> lets you provide a css file to customize
these displays.
</para>
-
</sect2>
<sect2><title>XML Storage</title>
-
<para>
+ <!-- FIXME: still needs writing..... -->
</para>
</sect2>
-
</sect1>
</chapter>
diff --git a/doc/details-tags.docbook b/doc/details-tags.docbook
index f6d07b87f7..30ae1ca215 100644
--- a/doc/details-tags.docbook
+++ b/doc/details-tags.docbook
@@ -8,7 +8,6 @@
<date>2023-08-30</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Tags</title>
<para>
@@ -18,27 +17,25 @@
reports</link>.
</para>
-<sect1 id="details.tags.view">
-<title>Tags View</title>
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="tags.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect1 id="details.tags.view"><title>Tags View</title>
+<screenshot>
+ <screeninfo>tags view transactions tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="tags.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>tags view transactions tab</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The Tags View provides information about all the tags that have been added to the
data file. The display is split into two areas.
</para>
-<sect2 id="details.tags.list">
-<title>Tags List</title>
-
+<sect2 id="details.tags.list"><title>Tags List</title>
<para>
On the left is a list of tags, with buttons for adding, renaming, or deleting a tag.
</para>
@@ -55,8 +52,7 @@
</para>
</sect2>
-<sect2>
-<title>Adding a Tag</title>
+<sect2><title>Adding a Tag</title>
<para>
As with most actions in &kmymoney;, there are multiple ways to create a new tag.
First, you can click on the <guiicon><inlinemediaobject><imageobject><imagedata
@@ -70,8 +66,7 @@
</para>
</sect2>
-<sect2>
-<title>Renaming a Tag</title>
+<sect2><title>Renaming a Tag</title>
<para>
To rename a tag, either click on the tag name to select it and click on the
<guiicon>Rename tag</guiicon> icon <!-- FIXME: add icon for rename -->(between the
@@ -81,8 +76,7 @@
</para>
</sect2>
-<sect2>
-<title>Deleting a Tag</title>
+<sect2><title>Deleting a Tag</title>
<para>
To delete a tag, either click on the
<guiicon><inlinemediaobject><imageobject><imagedata fileref="list-remove.png"
@@ -102,30 +96,26 @@
</sect2>
</sect1>
-<sect1 id="details.tags.info">
-<title>Tagged transactions and Tag details</title>
+<sect1 id="details.tags.info"><title>Tagged transactions and Tag details</title>
<para>
To view the transactions or view and edit the information associated with a
particular tag, select the tag from the list and select the appropriate tab on the
right side of the dialog.
</para>
-<para>
- <screenshot>
- <screeninfo>The tag details tab</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="tag_details.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Tag details</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
-
-<sect2 id="details.tags.info.transactions">
-<title>Tagged transactions</title>
+<screenshot>
+ <screeninfo>tags view details tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="tag_details.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>tags view details tab</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
+
+<sect2 id="details.tags.info.transactions"><title>Tagged transactions</title>
<para>
To see a list of the transactions associated with the selected tag, select the
<guilabel>Transactions</guilabel> tab. This list is similar to the list of
@@ -136,8 +126,7 @@
</sect2>
-<sect2 id="details.tags.info.details">
-<title>Tag details</title>
+<sect2 id="details.tags.info.details"><title>Tag details</title>
<para>
To view and edit the information associated with a particular tag, select the
<guilabel>Details</guilabel> tab.
diff --git a/doc/faq.docbook b/doc/faq.docbook
index d08dce8d1d..f08433f24b 100644
--- a/doc/faq.docbook
+++ b/doc/faq.docbook
@@ -7,7 +7,6 @@
<date>2023-12-26</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Questions and Answers</title>
<para>
diff --git a/doc/firsttime.docbook b/doc/firsttime.docbook
index f1af7927c1..09a804c640 100644
--- a/doc/firsttime.docbook
+++ b/doc/firsttime.docbook
@@ -8,12 +8,9 @@
<date>2023-08-15</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Using &kmymoney; for the first time</title>
-<sect1 id="firstime-1">
-<title>Running &kmymoney; for the first time</title>
-
+<sect1 id="firstime-1"><title>Running &kmymoney; for the first time</title>
<note>
<para>
When you run &kmymoney;, it might not look exactly like the screenshots in this
@@ -26,22 +23,18 @@
</sect1>
-<sect1 id="firsttime.mainwindow">
-<title>The main window</title>
-
-<para>
- <screenshot>
- <screeninfo>The Main Window</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="mainwindow_numbered.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>The Main Window</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect1 id="firsttime.mainwindow"><title>The main window</title>
+<screenshot>
+ <screeninfo>The Main Window</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="mainwindow_numbered.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>The Main Window</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The &kmymoney; main window consists of four major parts
@@ -296,9 +289,7 @@
</para>
</sect1>
-<sect1 id="firsttime.newfile">
-<title>Creating a new file</title>
-
+<sect1 id="firsttime.newfile"><title>Creating a new file</title>
<para>
&kmymoney; keeps all the data about your finances in a file. As was stated in
<link linkend="makingmostof.basicaccounting.personalaccounts">Defining the
@@ -332,19 +323,17 @@
guide you through the process of creating the file.
</para>
-<para>
- <screenshot>
- <screeninfo>Personal Data Page</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="newfile.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Personal Data Page</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>Personal Data Page</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="newfile.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Personal Data Page</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
Any information entered hereon the <guilabel>Personal Data</guilabel> page is used
@@ -379,19 +368,17 @@
currency, if appropriate for you situation.
</para>
-<para>
- <screenshot>
- <screeninfo>Base currency selection Page</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="newfile-2.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Base currency selection page</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>Base currency selection Page</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="newfile-2.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Base currency selection page</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
In this example, US Dollar has been selected as the base currency.
@@ -403,19 +390,17 @@
account.
</para>
-<para>
- <screenshot>
- <screeninfo>Checking account creation Page</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="newfile-3.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Checking account creation page</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>Checking account creation Page</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="newfile-3.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Checking account creation page</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
Enter the name of the account and a possible account or reference number assigned
@@ -439,20 +424,17 @@
Once finished, press <guibutton>Next</guibutton> to proceed.
</para>
-<para>
- <screenshot>
- <screeninfo>Account template selection Page</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="newfile-4.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account template selection page</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
-
+<screenshot>
+ <screeninfo>Account template selection Page</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="newfile-4.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Account template selection page</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
Choose the appropriate country and account template(s). Each template provides a
@@ -469,19 +451,17 @@
proceed.
</para>
-<para>
- <screenshot>
- <screeninfo>Preference Page</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="newfile-6.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Preference page</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>Preference Page</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="newfile-6.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Preference page</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
This page of the wizard allows you to setup user preferences. If you select the
@@ -493,19 +473,17 @@
<!-- FIXME: note the above shot is 6, but should be numbered 5, and the 5 below
is the wrong shot. -->
-<para>
- <screenshot>
- <screeninfo>Filename selection Page</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="newfile-6.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Filename selection page</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
+<screenshot>
+ <screeninfo>Filename selection Page</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="newfile-6.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Filename selection page</phrase>
+ </textobject>
+ </mediaobject>
+</screenshot>
<para>
The lastfinal page of the wizard allows you to select the location and filename
@@ -522,9 +500,7 @@
</sect1>
-<sect1 id="firsttime.4">
-<title>Creating accounts</title>
-
+<sect1 id="firsttime.4"><title>Creating accounts</title>
<para>
There are multiple ways you can create an account:
</para>
@@ -597,9 +573,7 @@
</para>
</sect1>
-<sect1 id="firsttime.schedules">
-<title>Schedules</title>
-
+<sect1 id="firsttime.schedules"><title>Schedules</title>
<para>
A <link linkend="details.schedules">schedule</link>, sometimes called a scheduled
transaction or a recurring transaction, is a transaction that occurs one or more
@@ -618,9 +592,7 @@
</para>
</sect1>
-<sect1 id="firsttime.categories">
-<title>Categories</title>
-
+<sect1 id="firsttime.categories"><title>Categories</title>
<para>
To maintain your <link linkend="details.categories">categories</link> click on the
<guiicon><inlinemediaobject><imageobject><imagedata fileref="categories_view.png"
@@ -634,9 +606,7 @@
</para>
</sect1>
-<sect1 id="firsttime.tags">
-<title>Tags</title>
-
+<sect1 id="firsttime.tags"><title>Tags</title>
<para>
To maintain your <link linkend="details.tags">tags</link> click on the <guiicon>
<inlinemediaobject><imageobject><imagedata fileref="mail-tagged.png" format="PNG"/>
@@ -649,9 +619,7 @@
</para>
</sect1>
-<sect1 id="firsttime.payees">
-<title>Payees</title>
-
+<sect1 id="firsttime.payees"><title>Payees</title>
<para>
To maintain your payees click on the <guiicon><inlinemediaobject>
<imageobject><imagedata fileref="payees_view.png" format="PNG"/></imageobject>
@@ -664,9 +632,7 @@
</para>
</sect1>
-<sect1 id="firsttime.import">
-<title>Quicken Interchange Format (QIF) Import</title>
-
+<sect1 id="firsttime.import"><title>Quicken Interchange Format (QIF) Import</title>
<para>
If you currently use another financial manager application, &kmymoney; can import
much or all of the data from that program, as long as they can be exported or saved
@@ -683,9 +649,7 @@
<!-- FIXME: do we want to mention any other format here? -->
</sect1>
-<sect1 id="firsttime.find">
-<title>Searching for transactions</title>
-
+<sect1 id="firsttime.find"><title>Searching for transactions</title>
<para>
&kmymoney; provides a useful and powerful transaction search facility in the
form of the search dialog.
@@ -705,9 +669,7 @@
</para>
</sect1>
-<sect1 id="firsttime.reconcile">
-<title>Reconciliation</title>
-
+<sect1 id="firsttime.reconcile"><title>Reconciliation</title>
<para>
At some point, you will want to reconcile your records and details of an account
with the actual account to assure they match. This is generally done by comparing
@@ -733,9 +695,7 @@
</para>
</sect1>
-<sect1 id="firsttime.backup">
-<title>Backing up</title>
-
+<sect1 id="firsttime.backup"><title>Backing up</title>
<para>
Now that you have created some accounts and entered transactions it's a good idea
to perform a backup. Because the file used by &kmymoney; is a standard &Linux; file
@@ -766,9 +726,7 @@
</para>
</sect1>
-<sect1 id="firsttime.launch">
-<title>Launching &kmymoney;</title>
-
+<sect1 id="firsttime.launch"><title>Launching &kmymoney;</title>
<para>
Most commonly, you will launch &kmymoney; from an icon or a start menu of your
window manager or desktop environment. In this case, the default behavior is that
@@ -783,29 +741,26 @@
</para>
<formalpara><title><command>kmymoney -n</command></title>
- <para>
- The -n option tells &kmymoney; not to open the last file it had open. This
- can be useful if the program crashes on startup.
- </para>
+<para>
+ The -n option tells &kmymoney; not to open the last file it had open. This can be
+ useful if the program crashes on startup.
+</para>
</formalpara>
<formalpara><title><command>kmymoney <path to file></command></title>
- <para>
- Giving &kmymoney; a filename on the command line tells it to open that file
- 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.
- </para>
+<para>
+ Giving &kmymoney; a filename on the command line tells it to open that file 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.
+</para>
</formalpara>
</sect1>
-<sect1 id="firsttime.newpc">
-<title>How to move &kmymoney; to a new computer</title>
-
-<sect2 id="firsttime.newpc.data">
-<title>Moving your data</title>
+<sect1 id="firsttime.newpc"><title>How to move &kmymoney; to a new computer</title>
+<sect2 id="firsttime.newpc.data"><title>Moving your data</title>
<para>
If you get a new computer, it's very easy to move your data. In fact, all you
have to do is to copy your &kmymoney; data file. The name of the file is
@@ -835,9 +790,7 @@
</para>
</sect2>
-<sect2 id="firsttime.newpc.settings">
-<title>Moving your settings</title>
-
+<sect2 id="firsttime.newpc.settings"><title>Moving your settings</title>
<!-- Need to clarify location of config data. Some in ~/.config/kmymoney, some in
~/.local/share/kmymoney -->
<para>
@@ -853,9 +806,7 @@
<envar>$KDEHOME</envar> was <filename class="directory">.kde4</filename>.
</para>
-<sect3 id="firsttime.newpc.settings.plugins">
-<title>Moving plugin settings</title>
-
+<sect3 id="firsttime.newpc.settings.plugins"><title>Moving plugin settings</title>
<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 folder, such as
@@ -891,9 +842,7 @@
</sect2>
</sect1>
-<sect1 id="firsttime.contact">
- <title>Getting Help / Contacting the Developers / Reporting Bugs</title>
-
+<sect1 id="firsttime.contact"><title>Getting Help / Contacting the Developers / Reporting Bugs</title>
<para>
Since support channnels change over time, you can refer to the <ulink
url="https://kmymoney.org/support.html">Support page</ulink> at the <ulink
@@ -909,9 +858,7 @@
above link.
</para>
-<sect2>
-<title>Contacting the developers</title>
-
+<sect2><title>Contacting the developers</title>
<para>
For general questions or comments about &kmymoney;, there is a users' mailing list
&userlist; with more details <ulink
@@ -931,9 +878,7 @@
</para>
</sect2>
-<sect2>
-<title>Reporting bugs</title>
-
+<sect2><title>Reporting bugs</title>
<para>
To report a bug please use the interface provided by &kmymoney; by selecting
<menuchoice><guimenu>Help</guimenu><guimenuitem>Report
@@ -954,9 +899,7 @@
listed above.
</para>
-<sect3 id="firsttime.bugs.quality">
-<title>Writing High Quality Bug Reports</title>
-
+<sect3 id="firsttime.bugs.quality"><title>Writing High Quality Bug Reports</title>
<para>
We encourage users to take extra time to write high-quality bug reports when
submitting them. This reduces wasted effort on all sides, as the reporter and
@@ -972,60 +915,60 @@
</para>
<formalpara><title>Include your system information</title>
- <para>
- The <menuchoice><guimenu>Help</guimenu><guimenuitem>Report
- Bug</guimenuitem></menuchoice> menu item will fill this in automatically, but if
- you would prefer not to use this interface, there are several items you need to
- include in the report. We will need to know what operating system you are using
- (&Linux;, &MacOS;, or &Windows;), the version of &kde;, and the version of
- &kmymoney; you're running, and either the version of &MacOS; or &Windows; or the
- name and version of your &Linux; distribution and the version of your kernel.
- This information is extremely important, as many bugs (as well as behaviors
- mis-identified as bugs) depend on the Operating System.
- </para>
+<para>
+ The <menuchoice><guimenu>Help</guimenu><guimenuitem>Report
+ Bug</guimenuitem></menuchoice> menu item will fill this in automatically, but if
+ you would prefer not to use this interface, there are several items you need to
+ include in the report. We will need to know what operating system you are using
+ (&Linux;, &MacOS;, or &Windows;), the version of &kde;, and the version of
+ &kmymoney; you're running, and either the version of &MacOS; or &Windows; or the
+ name and version of your &Linux; distribution and the version of your kernel. This
+ information is extremely important, as many bugs (as well as behaviors
+ mis-identified as bugs) depend on the Operating System.
+</para>
</formalpara>
<formalpara><title>Include a backtrace for crashes</title>
- <para>
+<para>
The backtrace is often the single most useful piece of information in solving
crashes.
- </para>
+</para>
</formalpara>
<formalpara><title>Try to reproduce it</title>
- <para>
- Let us know if you were able to do so. It's useful to know whether the bug only
- happened once and you couldn't get it to happen again or if it happens every time
- or if it happens sometimes but not others.
+<para>
+ Let us know if you were able to do so. It's useful to know whether the bug only
+ happened once and you couldn't get it to happen again or if it happens every time
+ or if it happens sometimes but not others.
</para>
</formalpara>
<formalpara><title>Include specific steps</title>
- <para>
- This is a bad bug report: <quote>I entered a transaction, and &kmymoney;
- crashed.</quote> A much better bug report is: <quote>Using the transaction form,
- I entered a new transaction in my Credit Card account. I selected the Transfer
- tab, entered an amount, then changed to the Deposit tab, and back to the Transfer
- tab. When I returned to the Transfer tab, &kmymoney; crashed. This bug is fully
- reproducible for me.</quote>
- </para>
+<para>
+ This is a bad bug report: <quote>I entered a transaction, and &kmymoney;
+ crashed.</quote> A much better bug report is: <quote>Using the transaction form, I
+ entered a new transaction in my Credit Card account. I selected the Transfer tab,
+ entered an amount, then changed to the Deposit tab, and back to the Transfer tab.
+ When I returned to the Transfer tab, &kmymoney; crashed. This bug is fully
+ reproducible for me.</quote>
+</para>
</formalpara>
<formalpara><title>Tell us what you expected to happen</title>
- <para>
- In some cases, this is obvious, but in more subtle bugs, sometimes you'll see a
- bug report where it is not obvious what the reporter expected to happen. Always
- tell us what you think should have happened, as well as what did happen.
- </para>
+<para>
+ In some cases, this is obvious, but in more subtle bugs, sometimes you'll see a bug
+ report where it is not obvious what the reporter expected to happen. Always tell
+ us what you think should have happened, as well as what did happen.
+</para>
</formalpara>
<formalpara><title>Consider running with debugging enabled</title>
- <para>
- By compiling a version configured with --enable-debug=full you can ensure
- that the best possible backtraces are generated. If you encounter a crash,
- run &kmymoney; again from within gdb, and reproduce the crash. When it
- crashes, type <quote>bt</quote> to generate a backtrace.
- </para>
+<para>
+ By compiling a version configured with --enable-debug=full you can ensure that the
+ best possible backtraces are generated. If you encounter a crash, run &kmymoney;
+ again from within gdb, and reproduce the crash. When it crashes, type
+ <quote>bt</quote> to generate a backtrace.
+</para>
</formalpara>
<para>
diff --git a/doc/introduction.docbook b/doc/introduction.docbook
index d75052eb2f..37d522e0c3 100644
--- a/doc/introduction.docbook
+++ b/doc/introduction.docbook
@@ -4,12 +4,9 @@
<date>2023-10-23</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Introduction</title>
-<sect1 id="what-is-kmymoney">
-<title>What is &kmymoney;?</title>
-
+<sect1 id="what-is-kmymoney"><title>What is &kmymoney;?</title>
<para>
&kmymoney; is a personal finance manager by &kde;. It enables users to keep
careful track of their personal finances by providing a broad array of financial
@@ -53,9 +50,7 @@
</sect1>
-<sect1 id="what-kmymoney-is-not">
-<title>What &kmymoney; is not</title>
-
+<sect1 id="what-kmymoney-is-not"><title>What &kmymoney; is not</title>
<para>
As a personal finance manager, &kmymoney; is not intended to support the needs
of an average business. A small business might find sufficient functionality to
diff --git a/doc/makemostof.docbook b/doc/makemostof.docbook
index 11e0694b4f..137bfd0510 100644
--- a/doc/makemostof.docbook
+++ b/doc/makemostof.docbook
@@ -10,7 +10,6 @@
<date>2023-10-23</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Making the most of &kmymoney;</title>
<para>
@@ -28,9 +27,7 @@
&kmymoney;'s will almost certainly save you time later.
</para>
-<sect1 id="makingmostof.basicaccounting">
-<title>Basic Accounting</title>
-
+<sect1 id="makingmostof.basicaccounting"><title>Basic Accounting</title>
<para>
Imagine your money as balls, or beans, and to stop them rolling around you keep
them in a box, or pot. Accounting, or Bookkeeping, is the process of counting and
@@ -77,9 +74,7 @@
modified the section below, since we explicitly say that KMM is not for
business use. -->
-<sect2 id="makingmostof.basicaccounting.personalaccounts">
-<title>Defining the accounts (personal records)</title>
-
+<sect2 id="makingmostof.basicaccounting.personalaccounts"><title>Defining the accounts (personal records)</title>
<para>
Most accounts, or pots, as described above, represent a measure of our
<quote>Worth</quote>. The cash and goods represent our <quote>Assets</quote>,
@@ -120,9 +115,7 @@
</para>
</sect2>
-<sect2 id="makingmostof.basicaccounting.businessaccounts">
-<title>Defining the accounts (business records)</title>
-
+<sect2 id="makingmostof.basicaccounting.businessaccounts"><title>Defining the accounts (business records)</title>
<para>
There are similarities to setting up accounts for personal use, but there are
additional considerations, including legal guidelines and requirements.
@@ -134,9 +127,7 @@
</sect2>
</sect1>
-<sect1 id="makingmostof.mapping">
-<title>Mapping your finances to &kmymoney;</title>
-
+<sect1 id="makingmostof.mapping"><title>Mapping your finances to &kmymoney;</title>
<para>
So, collect your recent financial papers and see the following sections for more
information on how you can map your own finances to each of the different areas of
@@ -144,9 +135,7 @@
later chapters of this handbook.
</para>
-<sect2 id="makingmostof.mapping.accounts">
-<title>Accounts</title>
-
+<sect2 id="makingmostof.mapping.accounts"><title>Accounts</title>
<para>
An <quote>Account</quote> in &kmymoney; represents one ot the <quote>pots</quote>
of the previous section: it can be anywhere which holds your money and possessions
@@ -170,9 +159,7 @@
</para>
-<sect3 id="makingmostof.mapping.accounts.asset">
-<title>Accounts - Asset</title>
-
+<sect3 id="makingmostof.mapping.accounts.asset"><title>Accounts - Asset</title>
<para>
There are multiple types of Asset Accounts. They are all essentially the same, in
holding your money, but there are some differences in the details of how money
@@ -236,9 +223,7 @@
</variablelist>
</sect3>
-<sect3 id="makingmostof.mapping.accounts.liability">
-<title>Accounts - Liability</title>
-
+<sect3 id="makingmostof.mapping.accounts.liability"><title>Accounts - Liability</title>
<para>
These accounts represent your debts and money you owe to others.
</para>
@@ -274,9 +259,7 @@
</sect3>
</sect2>
-<sect2 id="makingmostof.mapping.institutions">
-<title>Institutions</title>
-
+<sect2 id="makingmostof.mapping.institutions"><title>Institutions</title>
<para>
These represent financial institutions, such as banks or investment brokers. They
can be used to group accounts, and can show the total value of all your accounts
@@ -286,9 +269,7 @@
</para>
</sect2>
-<sect2 id="makingmostof.mapping.categories">
-<title>Categories</title>
-
+<sect2 id="makingmostof.mapping.categories"><title>Categories</title>
<para>
A Category is a special type of account used internally by &kmymoney; to track
income and expenses. These accounts are non-managed, because as mentioned earlier,
@@ -306,9 +287,7 @@
bill.
</para>
-<sect3 id="makingmostof.mapping.subcategories">
-<title>Sub-Categories</title>
-
+<sect3 id="makingmostof.mapping.subcategories"><title>Sub-Categories</title>
<para>
Categories can be split into sub-categories, but this relationship is primarily for
your convenience, and is used for display purposes. Most of the time, the
@@ -319,9 +298,7 @@
</sect2>
-<sect2 id="makingmostof.mapping.tags">
-<title>Tags</title>
-
+<sect2 id="makingmostof.mapping.tags"><title>Tags</title>
<para>
Tags are very similar to Categories, as they are also non-managed accounts that do
not have a value. However, unlike Categories, the use of Tags is completely
@@ -329,9 +306,7 @@
</para>
</sect2>
-<sect2 id="makingmostof.mapping.payees">
-<title>Payees</title>
-
+<sect2 id="makingmostof.mapping.payees"><title>Payees</title>
<para>
A Payee (or Payor) represents someone or some group to which you pay money or which
pays you money. As with Tags, they are non-managed, and do not have a value. They
@@ -342,9 +317,7 @@
</para>
</sect2>
-<sect2 id="makingmostof.mapping.schedules">
-<title>Scheduled transactions</title>
-
+<sect2 id="makingmostof.mapping.schedules"><title>Scheduled transactions</title>
<para>
Where transactions occur on a regular basis, such as salary or utility bills, these
can be set up against a Schedule. Transactions are created from Schedules.
@@ -353,9 +326,7 @@
</sect2>
</sect1>
-<sect1 id="makingmostof.usefultips">
-<title>Useful Tips</title>
-
+<sect1 id="makingmostof.usefultips"><title>Useful Tips</title>
<para>
When you start &kmymoney;, the Home View, or Home Page, shows a high level overview
of your finances. It is divided into several sections, and you can customize which
@@ -435,9 +406,7 @@
</para>
</sect1>
-<sect1 id="makingmostof.plugins">
-<title>Plugins</title>
-
+<sect1 id="makingmostof.plugins"><title>Plugins</title>
<para>
While a detailed knowledge of plugins is not necessary to use &kmymoney;, a basic
understanding is helpful, as the concept is mentioned in many places throughout
diff --git a/doc/reference.docbook b/doc/reference.docbook
index b3a65d3ac6..80aeadf935 100644
--- a/doc/reference.docbook
+++ b/doc/reference.docbook
@@ -4,7 +4,6 @@
<date>2023-12-23</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
-
<title>Reference</title>
<sect1 id="reference.menus">
@@ -24,7 +23,6 @@
</para>
<sect2 id="reference.menus.file"><title>File Menu</title>
-
<variablelist>
<varlistentry>
<term><menuchoice>
@@ -198,7 +196,6 @@
</sect2>
<sect2 id="reference.menus.edit"><title>Edit Menu</title>
-
<variablelist>
<varlistentry>
<term><menuchoice>
@@ -243,7 +240,6 @@
</sect2>
<sect2 id="reference.menus.view"><title>View Menu</title>
-
<variablelist>
<varlistentry id="reference.menus.settings.transactiondetail">
<term><menuchoice>
@@ -312,7 +308,6 @@
</sect2>
<sect2 id="reference.menus.institution"><title>Institution Menu</title>
-
<variablelist>
<varlistentry>
<term><menuchoice>
@@ -347,7 +342,6 @@
</sect2>
<sect2 id="reference.menus.account"><title>Account Menu</title>
-
<variablelist>
<varlistentry>
<term><menuchoice>
@@ -492,7 +486,6 @@
</sect2>
<sect2 id="reference.menus.category"><title>Category Menu</title>
-
<variablelist>
<varlistentry>
<term><menuchoice>
@@ -533,7 +526,6 @@
</sect2>
<sect2 id="reference.menus.transaction"><title>Transaction Menu</title>
-
<variablelist>
<varlistentry>
<term><menuchoice>
@@ -738,7 +730,6 @@
</sect2>
<sect2 id="reference.menus.tools"><title>Tools Menu</title>
-
<variablelist>
<varlistentry>
<term><menuchoice>
@@ -815,7 +806,6 @@
</sect2>
<sect2 id="reference.menus.settings.help"><title>Settings and Help Menus</title>
-
<para>
The Settings and Help menus of &kmymoney; are based on those described in <ulink
url="help:/fundamentals/menus.html">&kde; Fundamentals</ulink> with some additional
diff --git a/doc/whatsnew.docbook b/doc/whatsnew.docbook
index 6f211d9fe8..fd239cb13c 100644
--- a/doc/whatsnew.docbook
+++ b/doc/whatsnew.docbook
@@ -6,9 +6,7 @@
</chapterinfo>
<title>What's new in this release</title>
-<sect1>
-<title>Bug fixes and enhancements to functionality</title>
-
+<sect1><title>Bug fixes and enhancements to functionality</title>
<para>
As with every release, the &kmymoney; development team continues to work hard to
make each version better and easier to use in every way. Many bugs have been fixed
@@ -44,17 +42,13 @@
as it is getting increasingly difficult for the team to provide any assistance for
very old versions.
</para>
-
</sect1>
-<sect1>
-<title>Updates to this Handbook</title>
+<sect1><title>Updates to this Handbook</title>
<para>
This section used to present some details related to the lack of a complete
- handbook update from 4.x to 5.x. The intent is that the handbook be fully updated
- for 5.2, so this section should hopefully be able to be removed before release.
+ handbook update from 4.x to 5.x. As the handbook has now been fully updated for
+ 5.2, this section is no longer necessary.
</para>
-
</sect1>
-
</chapter>
More information about the kde-doc-english
mailing list