Git commit 14e1e610441a9da102a6badc9fca1ad32d6775c1 by Jack Ostroff. Committed on 21/01/2024 at 01:18. Pushed by ostroffjh into branch 'Handbook-5.2'.
Further work on accounts chapter and other cleanup. M +- -- doc/account_options.png M +118 -3 doc/details-accounts.docbook M +13 -42 doc/details-institutions.docbook M +1 -1 doc/details-reports.docbook M +1 -1 doc/reference.docbook https://invent.kde.org/office/kmymoney/-/commit/14e1e610441a9da102a6badc9fca1ad32d6775c1 diff --git a/doc/account_options.png b/doc/account_options.png index 02d7b0cd2b..feb061096f 100644 Binary files a/doc/account_options.png and b/doc/account_options.png differ diff --git a/doc/details-accounts.docbook b/doc/details-accounts.docbook index 6a6c179889..459fb42e38 100644 --- a/doc/details-accounts.docbook +++ b/doc/details-accounts.docbook @@ -6,7 +6,7 @@ <author> &Roger.Lum; &Roger.Lum.mail; </author> <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author> </authorgroup> - <date>2023-08-30</date> + <date>2024-01-18</date> <releaseinfo>5.2.0</releaseinfo> </chapterinfo> @@ -964,7 +964,6 @@ </para> </listitem> </itemizedlist> - </listitem> </varlistentry> </variablelist> @@ -973,7 +972,7 @@ </variablelist> </sect1> -<sect1 id="details.accounts.delete"><title>Deleting accounts</title> +<sect1 id="details.accounts.delete"><title>Deleting and Closing 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 @@ -1004,5 +1003,121 @@ account...</guimenuitem>, but will get a popup stating why &kmymoney; cannot delete the account. </para> + +<para> + Deleting an Account completely removes all data related to that account from your + data file. Howevr, there may be cases where you have closed an account at the + bank, and although you do not want to see it in your daily use of &kmymoney; you + wnat to keep the data for use in historical reports, you can select + <guimenu>Account</guimenu><guimenuitem>Close account</guimenuitem> or right-click + the name in the Accounts View and select <guimenuitem>Close + account...</guimenuitem> from the popup menu. This will mark the account as + closed, and it's visibility will depend on the setting of <link + linkend="reference.menus.view">Show all accounts</link>. Note that to close an + account, it must have a zero balance, but it can still contain transactions. +</para> + +<para> + It is also possible to re-open a closed account. This is most commonly necessary + if you have closed an account, but find you did so before actually entering all + transactions for the account, such as a final interest payment or dividend for an + investment account. In this case, you can select <guimenu>Account</guimenu> + <guimenuitem>Reopen account</guimenuitem> or right-click the name in the Accounts + View and select <guimenuitem>Reopen account</guimenuitem> from the popup menu. +</para> +</sect1> + +<sect1 id="details.accounts.options"><title>Account Options</title> +<para> + Right clicking on an Account in either the Institiutions View or the Accounts View + will bring up the Accounts Options. You can also just click the + <guimenu>Account</guimenu> menu. +</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> +</screenshot> + +<para> + Note that each of the listed menu options may be enabled or disabled depending on + the particular account selected. +</para> + +<para> + Selecting <guimenuitem>New account...</guimenuitem> steps you through the <link + linkend="details.accounts.create">Account creation process</link>. +</para> + +<para> + Selecting <guimenuitem>New Category...</guimenuitem> steps you through the <link + linkend="details.categories.create">Category creation process</link>. +</para> + +<para> + Selecting <guimenuitem>Open Ledger</guimenuitem> brings you directly to the <link + linkend="details.ledgers.view">Ledgers View</link> or the <link + linkend="details.investments.view">Investments View</link>, depending on the + account type. +</para> + +<para> + Selecting <guimenuitem>Edit account...</guimenuitem> brings up a window allowing + you to <link linkend="details.accounts.edit">edit various aspects of the + account</link>. +</para> + +<para> + Selecting <guimenuitem>Deleting account...</guimenuitem> deletes the selected + account, but only if certain criteria are met, as described <link + linkend="details.accounts.delete">here</link>. Otherwise, this item is disabled. +</para> + +<para> + Selecting <guimenuitem>Reconcile...</guimenuitem> opens up the <link + linkend="details.reconcile.wizard">Reconciliation Wizard</link>. + <guimenuitem>Postpone</guimenuitem> and <guimenuitem>Finish</guimenuitem> are also + described in the same section. +</para> + +<para> + Selecting <guimenuitem>Transaction Report</guimenuitem> is onlyl enabled for a + limited selection of Accounts, in which case it opens a <link + linkend="details.reports.transaction">Transaction Report</link> for the selected + account, showing transactions YTD. +</para> + +<para> + Selecting <guimenuitem>Close account</guimenuitem> closes the selected account, as + long as certain criteria are met, as described <link + linkend="details.accounts.delete">here</link>. <guimenuitem>Reopen + account</guimenuitem> is described in the same section. +</para> + +<para> + Selecting <guimenuitem>Map account...</guimenuitem> and <guimenuitem>Unmap + account...</guimenuitem> allows you to associate an account with an online account + and to remove the association. Selecting <guimenuitem>Update + account...</guimenuitem> fetches transaction data from the online source for an + account which has alreay been mapped. In addition, selecting <guimenuitem>Update + all accounts...</guimenuitem>, which only appears on the main + <guimenu>Account</guimenu> menu, updates all mapped accounts. These are all + described in the <link linkend="details.impexp">Importing and Exporting + Chapter.</link> +</para> + +<para> + Selecting <guimenuitem>New investment...</guimenuitem>, which only appears on the + context menu (by right-clicking an account in the Investments View or Accounts + View, brings up the <link linkend="details.investments.newinvestmentwizard">New + Investment Wizard</link>. +</para> </sect1> </chapter> diff --git a/doc/details-institutions.docbook b/doc/details-institutions.docbook index 7b3dd10f96..e3b7911acb 100644 --- a/doc/details-institutions.docbook +++ b/doc/details-institutions.docbook @@ -5,7 +5,7 @@ <author> &Roger.Lum; &Roger.Lum.mail; </author> <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author> </authorgroup> - <date>2018-08-20</date> + <date>2024-01-18</date> <releaseinfo>5.2.0</releaseinfo> </chapterinfo> <title>Institutions</title> @@ -80,10 +80,11 @@ <listitem> <para> The <acronym><ulink - url="https://en.wikipedia.org/wiki/International_Bank_Account_Number";>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: is it used at all by KMM? --> + url="https://en.wikipedia.org/wiki/International_Bank_Account_Number"; + >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> @@ -108,7 +109,7 @@ url="https://en.wikipedia.org/wiki/ISO_9362";>SWIFT/BIC</ulink></acronym> (Society for Worldwide Interbank Financial Telecommunication/Business Identifier Code) - <!-- FIXME: is it used at all by KMM? --> + <!-- FIXME: where is this actually used? --> </para> </listitem> </varlistentry> @@ -172,45 +173,15 @@ depend on the country your bank is in. </para> </sect2> -</sect1> -<sect1 id="details.institutions.account"><title>Account Options</title> +<sect2><title>Account Options</title> <para> - The options just discussed refer to the institutions listed in the Institutions + The options discussed above refer to the institutions listed in the Institutions View. Most of the rows in this view are accounts. Right-clicking an account name - brings up an Account Options menu. The entries and details for this menu will be - discussed in the following <link linkend="details.accounts">Accounts</link> - section. -</para> - -<!-- FIXME: Leaving here for now, as this account options menu is NOT included in the - accounts chapter --> -<para> - Selecting <guimenuitem>New account...</guimenuitem> steps you through the new - account process. Selecting <guimenuitem>Open Ledger</guimenuitem> brings you - directly to the Ledgers View or Investments View, depending on the account - type. Simply double-clicking an account name also opens the account. Selecting - <guimenuitem>Edit account</guimenuitem> brings up a window allowing you to - change an account's name, start date, associated banking institution, and - parent account. Deleting an account is only possible if there are no - transactions associated with that account, and the account is not referred to - in any scheduled transaction. Selecting - <guimenuitem>Reconcile...</guimenuitem> opens up the Reconcile Wizard, which - steps you through the process of comparing your account statement to your - electronic entries. More details, as well as information about the other - options, are presented in the appropriate sections of this manual. + brings up an Account Options menu. The entries and details for this menu are + discussed at the end of the <link linkend="details.accounts.options">Accounts + Chapter</link>. </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> -</screenshot> +</sect2> </sect1> </chapter> diff --git a/doc/details-reports.docbook b/doc/details-reports.docbook index 853634e864..1ee8d848eb 100644 --- a/doc/details-reports.docbook +++ b/doc/details-reports.docbook @@ -49,7 +49,7 @@ </para> </sect2> -<sect2><title>Transactions</title> +<sect2 id="details.reports.transaction"><title>Transactions</title> <para> This section includes reports that list individual transactions. This is the best way to print your account register for a specific period of time. The diff --git a/doc/reference.docbook b/doc/reference.docbook index 80aeadf935..4988ce9c00 100644 --- a/doc/reference.docbook +++ b/doc/reference.docbook @@ -299,7 +299,7 @@ </menuchoice></term> <listitem> <para> - Shows all accounts in the views, including closed accounts and accountw with + Shows all accounts in the views, including closed accounts and accounts with zero balance. </para> </listitem>
