[office/kmymoney/Handbook-5.2] doc: further cleanup
Jack Ostroff
null at kde.org
Sat Aug 3 22:22:03 BST 2024
Git commit c1d1315a684d64de24ebf4ea4fa4c0a7c089edef by Jack Ostroff.
Committed on 05/07/2024 at 23:46.
Pushed by ostroffjh into branch 'Handbook-5.2'.
further cleanup
M +1 -1 doc/details-accounts.docbook
M +3 -1 doc/details-database.docbook
M +22 -9 doc/details-impexp-csv.docbook
M +1 -2 doc/details-institutions.docbook
M +1 -1 doc/details-ledgers.docbook
M +9 -11 doc/details-loans.docbook
M +0 -1 doc/details-schedules.docbook
M +11 -12 doc/details-settings.docbook
M +2 -2 doc/faq.docbook
M +2 -4 doc/firsttime.docbook
M +1 -1 doc/makemostof.docbook
https://invent.kde.org/office/kmymoney/-/commit/c1d1315a684d64de24ebf4ea4fa4c0a7c089edef
diff --git a/doc/details-accounts.docbook b/doc/details-accounts.docbook
index 7189b9c723..40bd9c3490 100644
--- a/doc/details-accounts.docbook
+++ b/doc/details-accounts.docbook
@@ -215,6 +215,7 @@
</para>
<para>
+ <!-- FIXME: confirm accuracy -->
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
@@ -223,7 +224,6 @@
linkend="details.impexp.ofxdirectconnect">online banking</link> and to assure data
imports use the right account. The <acronym>IBAN</acronym> may be used by the
KBanking plugin.
- <!-- FIXME: confirm accuracy -->
</para>
<para>
diff --git a/doc/details-database.docbook b/doc/details-database.docbook
index fd04d8fe69..2d2db19a30 100644
--- a/doc/details-database.docbook
+++ b/doc/details-database.docbook
@@ -84,7 +84,6 @@
modules for the more popular databases. Otherwise, check with the <ulink
url="https://www.qt.io/">&Qt; software web site</ulink> and search for <quote>SQL
drivers</quote>.
- <!-- FIXME: what about Windows and macOS? -->
</para>
<note>
@@ -422,6 +421,9 @@
Notes:
</para>
+<!-- For ndash and right and left double quotes I switched from Unicode –,
+ “, and ”. to direct names, but couldn't find one for left double
+ quote. JHO -->
<para>
1 – txType = "N” for normal transactions, "S” for scheduled
transactions
diff --git a/doc/details-impexp-csv.docbook b/doc/details-impexp-csv.docbook
index f71655741b..5302a48303 100644
--- a/doc/details-impexp-csv.docbook
+++ b/doc/details-impexp-csv.docbook
@@ -464,15 +464,28 @@
<listitem>
<para>
- Use the <guilabel>Fee Column</guilabel> selector if your file has a distinct
- column for fees. Beware, though, that the fee might have been taken into
- account in the price. If there is a fee, and it is a percentage figure,
- rather than a value, click the <guilabel>Fee is percentage</guilabel> check
- box. Note that on this page, this is the only field to explicitly include
- "column" in the label, to emphasize that it is for the fee column, not for any
- actual fee.
- <!-- FIXME: what are the Fee rate and Minimal Fee fields for? What do the Clear
- Fee and Calculate Fee buttons do, and when is the latter enabled? -->
+ There are two ways to specify fees for transactions. If your file has a distinct
+ column for fees, use the <guilabel>Fee Column</guilabel> selector. Note that on
+ this page, this is the only field to explicitly include "column" in the label, to
+ emphasize that it is for the fee column, not for any actual fee. Beware, though,
+ that the fee might have been taken into account in the price.
+</para>
+
+<para>
+ If there is a fee, but it is a percentage figure, rather than a specified value,
+ click the <guilabel>Fee is percentage</guilabel> check box, and enter the
+ percentage rate into the <guilabel>Fee rate</guilabel> field. In addition, if
+ there is a minimum fee, specify it in the <guilabel>Minimal Fee</guilabel> field,
+ which becomes enabled when you enter the Fee rate (with a decimal point.) At this
+ point, clicking the <guibutton>Calculate Fees</guibutton> button will add a column
+ at the right of the table above, and will indicate the calculated fee for each
+ transaction.
+</para>
+
+<para>
+ If you made a mistake in entering the fee information, clicking the
+ <guibutton>Clear Fee</guibutton> button will reset all the fee related fields to
+ their initial values.
</para>
</listitem>
diff --git a/doc/details-institutions.docbook b/doc/details-institutions.docbook
index 30cf1a58a4..c935dffec8 100644
--- a/doc/details-institutions.docbook
+++ b/doc/details-institutions.docbook
@@ -84,7 +84,6 @@
>IBAN</ulink> </acronym> (International Bank Account Number) is shown if
there is a value entered in the appropriate field on the account information
dialog.
- <!-- FIXME: where is this actually used? -->
</para>
</listitem>
</varlistentry>
@@ -105,11 +104,11 @@
<term>SWIFT/BIC</term>
<listitem>
<para>
+ <!-- FIXME: where is this actually used? -->
The <acronym><ulink
url="https://en.wikipedia.org/wiki/ISO_9362">SWIFT/BIC</ulink></acronym>
(Society for Worldwide Interbank Financial Telecommunication/Business
Identifier Code)
- <!-- FIXME: where is this actually used? -->
</para>
</listitem>
</varlistentry>
diff --git a/doc/details-ledgers.docbook b/doc/details-ledgers.docbook
index fdbb97e709..c4f050ad2b 100644
--- a/doc/details-ledgers.docbook
+++ b/doc/details-ledgers.docbook
@@ -740,10 +740,10 @@
<note>
<para>
+ <!-- FIXME: is this restriction still true? -->
The matching interface will not allow you to match two transactions which have
both been imported. Likewise, it also will not allow matching between two
transactions which have both been entered by hand.
- <!-- FIXME: is this restriction still true? -->
</para>
</note>
</sect2>
diff --git a/doc/details-loans.docbook b/doc/details-loans.docbook
index 3fa72ddea0..6df85eb647 100644
--- a/doc/details-loans.docbook
+++ b/doc/details-loans.docbook
@@ -11,13 +11,13 @@
<title>Loans</title>
<sect1 id="details.loans.general"><title>Understanding Loans</title>
-<!-- FIXME: do we leave this request in the released version? -->
-<note>
+<note><title>Feedback requested</title>
<para>
- <!-- FIXME need decision on expanding about principal -->
- I am looking for user feedback on whether to expand this section to discuss the
- variation of principal and interest payments to attain a fixed recurring payment.
- It is mentioned in the section on actually creating a loan in &kmymoney; but it
+ <!-- FIXME: do we leave this request in the released version? Also need
+ decision on expanding about principal -->
+ The author would appreciate feedback on whether to expand this section to discuss
+ the variation of principal and interest to attain a fixed recurring payment. It
+ is mentioned in the section on actually creating a loan in &kmymoney; but it
seems it should be mentioned earlier.
</para>
</note>
@@ -170,12 +170,10 @@
</para>
</sect1>
+<!-- FIXME: this section needs expanding, screenshots of the new loan wizard, and more dtails on the various entry
+ fields. In particular, it needs an explanation of how fixed payments are calculated by adjusting the amount of
+ principal and interest of each payment, sometimes resulting in a final payment different from the others. -->
<sect1 id="details.loans.creation"><title>Creating a New Loan</title>
-<!-- FIXME: this section needs expanding and 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 adjusting the amount of
- principal and interest of each payment, sometimes resulting in a final payment
- different from the others. -->
<para>
In &kmymoney;, a loan is a type of account. Therefore, to create a new loan, you
begin by selecting the <menuchoice><guimenu>Account</guimenu><guimenuitem>New
diff --git a/doc/details-schedules.docbook b/doc/details-schedules.docbook
index 2770741db6..a04d972985 100644
--- a/doc/details-schedules.docbook
+++ b/doc/details-schedules.docbook
@@ -203,7 +203,6 @@
tells &kmymoney; that the amount is specified in the currency of the category. You
will still need to confirm the other value or the conversion rate when the
transaction is entered into the ledger.
- <!-- FIXME: confirm what this really does. -->
</para>
<para>
diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook
index 5d343f5717..b200a3ff1c 100644
--- a/doc/details-settings.docbook
+++ b/doc/details-settings.docbook
@@ -45,7 +45,7 @@
</screenshot>
<!-- FIXME: I would prefer a more consistent hierarchy and use of levels here, such
- as with using sectX and variablelist. For now, I minimize layoue changes. -->
+ as with using sectX and variablelist. For now, I minimize layout changes. -->
<variablelist>
<varlistentry>
<term><guilabel>Autosave options</guilabel></term>
@@ -783,8 +783,8 @@
</listitem>
</varlistentry>
- <!-- FIXME: missing description of Automatic reconciliation -->
<varlistentry>
+ <!-- FIXME: missing description of Automatic reconciliation -->
<term><guilabel>Automatic reconciliation</guilabel></term>
<listitem>
<para>
@@ -834,18 +834,17 @@
</listitem>
<listitem>
- <!-- FIXME: What happens if multiple transactions are within X%? -->
<para>Same transaction if amount differs less than percentage set below</para>
<para>
With this option selected, when you enter a new transaction, &kmymoney;
will display a list of previous transactions for the same payee and
- account. If the amount of a previous transaction differs less than X
- percent from the amount you have entered, it will be considered
- identical, and details from that previous transaction will be used to
- autofill details of the new transaction. The "X" above is specified in
- the box next to <guilabel>Same transaction if amount differs less
- than</guilabel>, and can range from 0 to 100%. If the percentage is 0,
- all previous transactions for the payee and account will be displayed,
+ account. If the amount of a previous transaction is closeenough to the
+ amount you have entered, it will be considered a match, and details from
+ that previous transaction will be used to autofill details of the new
+ transaction. <quote>Close enough</quote> means within the percentage
+ specified in the box next to <guilabel>Same transaction if amount differs
+ less than</guilabel>, and can range from 0 to 100%. If the percentage is
+ 0, all previous transactions for the payee and account will be displayed,
and you can select one of those transactions to use for autofill by
clicking on it.
</para>
@@ -1136,7 +1135,7 @@
</para>
<!-- FIXME: do we want to actually include these checkwriting variables here, and if
- so, with how much detail? -->
+ so, with how much detail? -->
<!-- info from source code on substitution variables. Future exercise to list/describe them here.
// data about the user
checkHTML.replace("$OWNER_NAME", file->user().name());
@@ -1257,7 +1256,7 @@
</sect2>
<!-- FIXME: There is some overlap between here and the Reference/Settings section.
- I would prefer better coordination. -->
+ There should be better coordination between the two areas. -->
<sect2 id="details.settings.plugins.kbanking"><title>KBanking</title>
<para>
diff --git a/doc/faq.docbook b/doc/faq.docbook
index 3182f5eb11..dbee5e27da 100644
--- a/doc/faq.docbook
+++ b/doc/faq.docbook
@@ -147,6 +147,8 @@
</question>
<answer>
<para>
+ <!-- FIXME: this still needs a link to the section on moving transactions, which
+ does not yet exist. Short term - to be added to reference section. -->
You can easily change an account type between checking, savings, and cash.
However, because of the way &kmymoney; stores the account information, it does
not allow other changes of account type. The way around this is to
@@ -154,8 +156,6 @@
type</link>, move all the transactions from the old to the new account, and
then <link linkend="details.accounts.delete"> delete the old account.</link>
</para>
- <!-- FIXME: this still needs a link to the section on moving transactions, which
- does not yet exist. Short term - to be added to reference section. -->
</answer>
</qandaentry>
diff --git a/doc/firsttime.docbook b/doc/firsttime.docbook
index 112045bfb7..3682b49cf2 100644
--- a/doc/firsttime.docbook
+++ b/doc/firsttime.docbook
@@ -305,8 +305,6 @@
display preferences. The exact location of these files depends on your specific
Operating System or Distribution.
</para>
-<!-- FIXME: do we need a section on OS specific issues? This is also mentioned in
- section on migrating KMM data to new PC - is that sufficient? -->
<para>
To create a new file you can either select the
@@ -792,8 +790,8 @@
</sect2>
<sect2 id="firsttime.newpc.settings"><title>Moving your settings</title>
-<!-- FIXME: confirm we don't need to worry at all (or even mention) that there
- are also KMM related files under .local/share or even elsewhere -->
+<!-- FIXME: confirm we don't need to consider/mention that there might also be KMM related files under .local/share or
+ even elsewhere. Also, do we want/need a section on OS specific issues beyond what is mentioned here? -->
<para>
If you only move your data file to the new machine, as described in the previous
section, &kmymoney; will work correctly, but you will have lost any configuration
diff --git a/doc/makemostof.docbook b/doc/makemostof.docbook
index 530a142394..c5f867e779 100644
--- a/doc/makemostof.docbook
+++ b/doc/makemostof.docbook
@@ -27,7 +27,7 @@
same as &kmymoney;'s will almost certainly save you time later.
</para>
-<note><title></title>
+<note><title>Help improve this Handbook</title>
<para>
This and the following sections have been essentially unchanged since the very
early versions of &kmymoney;. While the basics of bookkeeping have not changed
More information about the kde-doc-english
mailing list