Git commit 95870f1e334dcac29d9079f0fc0009ec91633eb2 by Jack Ostroff. Committed on 31/01/2024 at 22:25. Pushed by ostroffjh into branch 'Handbook-5.2'.
more FIXM fixes M +2 -0 README-CONTRIBUTORS M +9 -6 doc/details-accounts.docbook M +15 -55 doc/details-impexp.docbook M +24 -13 doc/details-investments.docbook M +1 -0 doc/details-ledgers.docbook M +27 -7 doc/details-reconciliation.docbook M +9 -3 doc/details-reports.docbook M +6 -10 doc/details-settings.docbook A +10 -0 doc/icon-imported.svg A +- -- doc/match_transaction.png https://invent.kde.org/office/kmymoney/-/commit/95870f1e334dcac29d9079f0fc0009ec91633eb2 diff --git a/README-CONTRIBUTORS b/README-CONTRIBUTORS index 5e3c33324d..b8533d7140 100644 --- a/README-CONTRIBUTORS +++ b/README-CONTRIBUTORS @@ -318,6 +318,8 @@ multiple places. - Is it still true you can not match two imported or two not-imported transactions? +- Should there be a note about the relation between aqbanking, kbanking, and hbci? + This is a list of potential enhancements I came up with while reviewing the handbook, but have not yet posted either as wishlist bugs, entries to any Issue on invent, or elsewhere. diff --git a/doc/details-accounts.docbook b/doc/details-accounts.docbook index 9b9512db68..3e71189e3c 100644 --- a/doc/details-accounts.docbook +++ b/doc/details-accounts.docbook @@ -789,12 +789,15 @@ <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 - that account open in the ledger, select - <menuchoice><guimenu>Account</guimenu><guimenuitem>Edit - Account...</guimenuitem></menuchoice>. A window will pop-up with several tabs, each - allowing you to view and change certain information about the account. For more - information on any of these details, see the section on <link - linkend="details.accounts.create">creating a new account</link>. + that account open in the ledger, select <guimenu>Account</guimenu> + <guimenuitem>Edit Account...</guimenuitem>. A window will pop-up with several tabs, + each allowing you to view and change certain information about the account. For + more information on any of these details, see the section on <link + linkend="details.accounts.create">creating a new account</link>. Note that some of + these fields may be disabled, possibly depending on the type of account. For + example, <guilabel>Currency</guilabel> will always be disabled, since it can be set + when the account it created, but not changed after that. <guilabel>Price + Entry</guilabel> is only enabled for Investment Accounts. </para> <screenshot> diff --git a/doc/details-impexp.docbook b/doc/details-impexp.docbook index 01941f0128..0aee4c1a48 100644 --- a/doc/details-impexp.docbook +++ b/doc/details-impexp.docbook @@ -94,8 +94,8 @@ &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> accounts, and entry of transactions directly into categories is not supported. - Allocations are made during transaction entry into other account types. -<!-- FIXME: can anyone explain what this last sentence means? --> + Allocations to Categories are made when transactions are entered or edited in other + account types. </para> </sect4> @@ -200,7 +200,7 @@ <para> &kmymoney; uses the term Transfer to describe a transaction which does not involve a Category, but only transfers money between Asset and/or Liability - accounts. <!-- FIXME: what does this have to do with gnucash? --> + accounts. </para> </sect4> @@ -230,10 +230,9 @@ <note> <para> &kmymoney; does not currently support accounts denominated in 'defunct' - currencies (except those replaced by the Euro.) At present, it will be necessary + currencies, except those replaced by the Euro. At present, it will be necessary to remove any such accounts from your &gnucash; file before importing. We hope to improve on this situation in a future release. - <!-- FIXME: is this still true? --> </para> </note> </sect4> @@ -624,10 +623,14 @@ </note> <para> - The next step is to verify the imported data and accept it. This is a general - process and also applies to imports from other sources. It is outlined in a - separate section of this document. - <!-- FIXME: use correct link. --> + The next step is to verify the imported data and accept all the imported + transactions. This is a general process and also applies to imports from other + sources. It is similar to the process for <link + linkend="details.ledgers.match">matched transactions</link>. All imported + transactions are marked in the ledger with an <inlinemediaobject> <imageobject> + <imagedata fileref="icon-imported.svg" format="SVG"/> </imageobject> + </inlinemediaobject>imported icon. Once you <quote>Accept</quote> the transaction, + it is no longer marked as Imported. </para> </sect2> @@ -760,9 +763,6 @@ displayed profile to their default values. </para> -<!-- FIXME: confirm what each of these actually does, and consider separate - screenshots for each tab. --> - <para> The right area of the dialog has four tabs. </para> @@ -906,44 +906,6 @@ Settings Chapter. </para> -<!-- FIXME: see the new section on plugins at the end of makemostof. Most of this - 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 - Plugin. Once that is installed, the command to import OFX files will - automatically show up under the <menuchoice><guimenu>File</guimenu> - <guisubmenu>Import</guisubmenu></menuchoice> submenu. -</para> - -<para> - Note that many prepackaged versions of &kmymoney; were built with the OFX - importer already included or available as a separate package. If the OFX - importer does not seem to be installed in your version, the first place to - check is in the same place you got your base &kmymoney; package. -</para> - -<para> - If you have installed from RPM, the OFX Importer Plugin is contained within - the kmymoney-ofx package. It should be available from whatever source you got the - base &kmymoney; package. If you have built from sources, all you need to do is - have preferably the libOFX 0.9 development headers and libraries installed on - your system. The &kmymoney; build process will detect these and compile the - plugin. At the time of release of &kmymoney; 4.6, the latest libofx version - was 0.9.4, which is also the minimum required version. -</para> - -<para> - Should you run into trouble trying to compile &kmymoney;, and you are certain - you have the correct version of libOFX installed, please contact the - developers list &devlist; for assistance. Include a copy of your - <filename>config.log</filename> file, compressed first via <command>gzip</command>. -</para> -</sect2> ---> - <sect2><title>What is OFX</title> <para> <acronym>OFX</acronym> stands for <quote>Open Financial Exchange</quote>. @@ -1022,11 +984,9 @@ <para> Please note that this section describes the <quote>native</quote> OFX importer. - OFX files may also be imported using the AqBanking Importer Plugin if you have - installed that and it is enabled. Note that the two importers do behave slightly - differently, and they are written and supported by two different developers. - <!-- FIXME: we do not appear to have any info in this handbook on aqbanking other - than in the reference section? --> + OFX files may also be imported using the AqBanking Importer Plugin. Note that the + two importers do behave slightly differently, and they are written and supported by + two different developers. </para> </sect2> diff --git a/doc/details-investments.docbook b/doc/details-investments.docbook index d968419bd0..e05a62736e 100644 --- a/doc/details-investments.docbook +++ b/doc/details-investments.docbook @@ -293,10 +293,9 @@ <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 - <menuchoice><guimenu>Account</guimenu> - <guimenuitem>New account...</guimenuitem></menuchoice> menu item to begin the - process. Create an account as previously described in the <link + account to hold your defined securities. Choose the <guimenu>Account</guimenu> + <guimenuitem>New account...</guimenuitem> menu item to begin the process. Create + an account as previously described in the <link linkend="details.accounts.create.account"><guilabel>Account</guilabel></link> section, making sure to choose <quote>Investment</quote> as the type of account. </para> @@ -305,6 +304,19 @@ To work with the new investment account, open that account in the Ledgers View, as previously described. </para> + +<sect2><title>Price Entry</title> +<para> + Whenever you enter or edit a buy, sell, or reinvest transaction, you need to + specify the number of shares, price per share, and the total amount of the + transaction. As described <link + linkend="details.investments.priceentry">here</link> you actually specify only two + of those values, and &kmymoney; calculates the third. The default price entry + setting for new Investment Accounts is <quote>Price per share</quote>, but this can + be changed to <quote>Total amount</quote> when you <link + linkend="details.accounts.edit">edit the account</link>. +</para> +</sect2> </sect1> <sect1 id="details.investments.securities"><title>Adding Investments to Your Account</title> @@ -431,11 +443,10 @@ <listitem> <para> - Price entry. When you enter or edit a buy or sell transaction for this - investment, this dropdown indicates whether you want to explicitly enter either - the price per share or the total for all shares or to follow the default, which - is specied in a main configuration item - + Price entry. When you enter or edit a buy, sell, or reinvest transaction for + this investment, this dropdown indicates whether you want to enter the price + per share or the total for all shares or to follow the default for the account, + which was specified when the Investment Account was created. </para> </listitem> @@ -666,17 +677,17 @@ </para> </sect2> -<sect2><title>Shares, Price & Total Amount</title> +<sect2 id="details.investments.priceentry"><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 - any two of these, and &kmymoney; will calculate the third. It's usually best to + any two of these, and &kmymoney; will calculate the third. It is usually best to enter just the total amount and the number of shares, because these are the known facts of the transaction. &kmymoney; will automatically calculate the price per share. Note that there is only one entry field for the price, and it will be labeled <quote>Transaction amount</quote> or <quote>Price/share</quote> depending - on the setting of the <guilabel>Price entry</guilabel> option when the account was - <link linkend="details.investments.newinvestmentwizard">set up</link>. + on the setting of the <guilabel>Price entry</guilabel> option when the investment + was <link linkend="details.investments.newinvestmentwizard">set up</link>. </para> </sect2> diff --git a/doc/details-ledgers.docbook b/doc/details-ledgers.docbook index 16ffdf157e..fd40611323 100644 --- a/doc/details-ledgers.docbook +++ b/doc/details-ledgers.docbook @@ -733,6 +733,7 @@ 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-reconciliation.docbook b/doc/details-reconciliation.docbook index 0c35e3bea3..8779802b54 100644 --- a/doc/details-reconciliation.docbook +++ b/doc/details-reconciliation.docbook @@ -133,10 +133,11 @@ enter them again here, or you will have duplicate transaction. </para> -<note> +<note><title>Interest or Charge</title> <para> - The interest field is for interest you gained. If you have to pay interest, ⪚, - for a credit card account, this has to be entered as a charge. + The interest field is for interest you gained. If you have to pay interest, ⪚, + for a credit card account, this should be entered as a charge. In both cases, you + get to choose the proper category for the amount. </para> </note> @@ -215,13 +216,32 @@ When you do this, &kmymoney; takes all the transactions which have been marked as cleared (only those with a date before the statement date) and marks them as reconciled, and the value in the <guilabel>C</guilabel> column changes from - <quote>C</quote> to <quote>R</quote> to reflect the change. In addition, it saves - the changes and records that the account has been reconciled. (You still need to - save the file to permanently save all the changes.) + <quote>C</quote> to <quote>R</quote>. In addition, it saves the changes and + records that the account has been reconciled. (You still need to save the file to + permanently save all the changes.) </para> </sect3> -<!-- FIXME: talk about the reconciliation report --> +<sect3 id="details.reconcile.report"><title>The Reconciliation Report</title> +<para> + The last thing the reconciliation wizard does it to present a report, in the form of a pop-up with two tabs. +</para> + +<sect4><title>Summary Tab</title> +<para> + This tab shows a summary of the reconciliation, including the starting and ending + balances, and the number and amount of payments and deposits: cleared, outsanding, + and those after the reconciliation date. +</para> +</sect4> + +<sect4><title>Details Tab</title> +<para> + This tab shows a list of outstanding payments and charges. These are unmarked + transactions prior to the statement date of the reconciliation. +</para> +</sect4> +</sect3> <sect3 id="details.reconcile.postpone"><title>Postponing Reconciliation</title> <para> diff --git a/doc/details-reports.docbook b/doc/details-reports.docbook index 1ee8d848eb..78103094c2 100644 --- a/doc/details-reports.docbook +++ b/doc/details-reports.docbook @@ -264,9 +264,15 @@ the Home View and in the group of <guilabel>Favorite Reports</guilabel>.</para> </listitem> <listitem> - <!-- FIXME: when IS this used? --> - <para>Skip value if price is zero: This option is only available where it makes - sense.</para> + <para> + Skip value if price is zero: This option is only used for investments reports + which show prices instead of balances as all other reports do. Selecting + this option includes prices only if there is an actual price for the date; + otherwise 0 will be shown. In a graph, the value will be skipped. If this + option is off, the last existing price is shown for a period. If it is on, + in a table <quote>0</quote> is shown, and in a chart a linear interpolation + for the missing values will be performed. + </para> </listitem> </itemizedlist> </para> diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook index 75fc550bdf..bd74eb2cbd 100644 --- a/doc/details-settings.docbook +++ b/doc/details-settings.docbook @@ -1255,18 +1255,14 @@ </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? -</para> +<!-- FIXME: Since both this and the Configure Aqbanking page are minimal, should both + just point to the same link currently in the other section? --> <para> - This plugins adds support for HBCI/FinTs, OFX and PayPal online banking to - KMyMoney. However, configuring this plugin is not done through this dialog, but - through the <link linkend="reference.menus.settings.help"> - <guilabel>Settings</guilabel> </link> menu, with the <menuchoice> - <guimenu>Settings</guimenu> <guisubmenu>Configure Aqbanking...</guisubmenu> - </menuchoice> menu item. + This plugin adds support for HBCI/FinTs, OFX, and PayPal online banking. However, + configuring this plugin is not done through this dialog, but with the <link + linkend="reference.menus.settings.help"> <guimenu>Settings</guimenu> + <guisubmenu>Configure Aqbanking...</guisubmenu> </link> menu item. </para> </sect2> diff --git a/doc/icon-imported.svg b/doc/icon-imported.svg new file mode 100644 index 0000000000..5817784d4c --- /dev/null +++ b/doc/icon-imported.svg @@ -0,0 +1,10 @@ +<svg viewBox="0 0 16 16" version="1.1" xmlns="http://www.w3.org/2000/svg";> + <defs> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + </style> + </defs> + <path class="ColorScheme-Text" style="fill:currentColor; fill-opacity:1; stroke:none" d="M 13 5 L 13 12 L 8.91406 12 L 10.5352 13.6211 L 9.82812 14.3281 L 7 11.5 L 9.82812 8.67188 L 10.5352 9.37891 L 8.91406 11 L 12 11 L 12 6 L 9 6 L 9 3 L 4 3 L 4 13 L 7 13 L 7 14 L 3 14 L 3 2 L 10 2 L 13 5 Z"/> +</svg> diff --git a/doc/match_transaction.png b/doc/match_transaction.png new file mode 100644 index 0000000000..4615b71f49 Binary files /dev/null and b/doc/match_transaction.png differ
