Git commit 95664d524f249f72196d0ba615be814b45c87b74 by Jack Ostroff. Committed on 25/01/2024 at 22:15. Pushed by ostroffjh into branch 'Handbook-5.2'.
continue resolving FIXME's M +31 -3 README-CONTRIBUTORS M +15 -13 doc/details-accounts.docbook M +221 -163 doc/details-ledgers.docbook M +31 -16 doc/details-payees.docbook M +1 -1 doc/details-schedules.docbook M +12 -12 doc/details-tags.docbook M +37 -38 doc/details-widgets.docbook A +17 -0 doc/dialog-close.svg A +13 -0 doc/edit-clear.svg A +- -- doc/ledger_filter.png A +13 -0 doc/list-add-user.svg A +16 -0 doc/list-remove-user.svg A +- -- doc/single_split.png A +13 -0 doc/split_icon.svg M +- -- doc/split_transaction.png M +- -- doc/split_unassigned.png A +8 -0 doc/tag-edit.svg A +13 -0 doc/tag-new.svg A +13 -0 doc/user-group-properties.svg https://invent.kde.org/office/kmymoney/-/commit/95664d524f249f72196d0ba615be814b45c87b74 diff --git a/README-CONTRIBUTORS b/README-CONTRIBUTORS index 1481ee4831..5e3c33324d 100644 --- a/README-CONTRIBUTORS +++ b/README-CONTRIBUTORS @@ -22,10 +22,10 @@ complete by then. This is in the order pulled in from index.docbook, with brief note on state of update <!ENTITY introduction SYSTEM "introduction.docbook"> - prelim update done + prelim update complete <!ENTITY whatsnew SYSTEM "whatsnew.docbook"> - prelim update done + prelim update complete <!ENTITY makemostof SYSTEM "makemostof.docbook"> prelim update - probably need a complete replacement of this @@ -287,8 +287,36 @@ multiple places. - CSV importer - Banking cols, many have "X" to clear the value, and ther is "clear all." Investment cols do not have "x" and only "Clear" not "Clear all", plus Clear Fee. +- Why is "Reconciled" not an option on the transaction state dropdown in the filter + section of the ledger? + +- I'd like to be consistent in use or not of inline icons when describing where to click + to do something, but I'm deferring as too much effort for now. + +- The split editor window title is just "Dialog." The title of the window for + actually editing a single split is "Slit transaction." We need better terms that make + more sense. + +- Payees entered in a split, show up in the memo of the transaction, like memos and + tags. Perhaps they should be displayed in the Payee field, perhaps in parens with + the payy from each split?) + +- (from an otherwise resolved FIXME in the split transaction section) do we have + adequate description of currency conversion? I THINK so, but am leaving this + comment for confirmation. + +- It is also not clear if we need more detail on what can be a split (account instead + of category?) and where that would be described. + +- Where should we describe the Undo feature? + +- transaction matching section of Ledgers chapter - first, are matched transactions + still highlighted in green? If not, how? + +- Need more details on the descriptions of all the transaction status features in the + filter dropdown? - ---------------- +- Is it still true you can not match two imported or two not-imported transactions? 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 diff --git a/doc/details-accounts.docbook b/doc/details-accounts.docbook index 459fb42e38..9b9512db68 100644 --- a/doc/details-accounts.docbook +++ b/doc/details-accounts.docbook @@ -218,9 +218,12 @@ 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 --> + required by &kmymoney;. These fields may be left blank and filled in at a later + time. The account number may be used for <link + 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> @@ -836,15 +839,12 @@ <term>Hierarchy</term> <listitem> <para> - <!-- FIXME: drag/drop was in KDE3 versions, but still not ported 5.1.x. See - https://bugs.kde.org/show_bug.cgi?id=272737. You can change the parent - account by dragging the account in this view of the account hierarchy. - Changing the parent account is also possible in the main Accounts - screen, by dragging the account and dropping it on a different parent - account. --> This shows where the account is in the overall hierarcy of accounts. You can - change the parent account by clicking the new parent account and then - clicking <guibutton>OK</guibutton>. + change the parent account by dragging the account and dropping it on a + different parent account in this view of the account hierarchy, or in the + Accounts View or the Institutuions View. You can also change the parent + account here by clicking the new parent account and then clicking + <guibutton>OK</guibutton>. </para> </listitem> </varlistentry> @@ -887,8 +887,10 @@ <para> This shows the status of the online connection, the bank/broker, and the account number. It also allows you to store or change the password - for the online account. - <!-- FIXME: do we want to say WHERE the password is stored? --> + for the online account. Where and how the password is actually stored + depends on your specific instance, but most commonly, it is stored by + the <ulink url="https://apps.kde.org/kwalletmanager5/";>KDE Wallet + Manager</ulink>. </para> </listitem> </varlistentry> diff --git a/doc/details-ledgers.docbook b/doc/details-ledgers.docbook index 681206c2c0..ef79f4dbc7 100644 --- a/doc/details-ledgers.docbook +++ b/doc/details-ledgers.docbook @@ -56,8 +56,8 @@ </para> <itemizedlist> - <listitem><para>The filter area, which may or may not be visible</para></listitem> <listitem><para>The transaction list</para></listitem> + <listitem><para>The filter area, which may or may not be visible</para></listitem> <listitem> <para> The transaction form, which may or may not appear, depending upon your @@ -66,54 +66,12 @@ </listitem> </itemizedlist> -<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 - of the ledger. Now, it is normally hidden, but can be displayed by typing - <keycombo>&Ctrl;<keycap>F</keycap></keycombo>. It will then appear below the - transaction list. At the left of the filter area is a small <quote>x</quote> in a - red circle.<!-- FIXME: use actual icon --> Clicking on this icon will clear any - filters in place and hide the filter area. -</para> - <para> Previous versions of &kmymoney; had a dropdown where you could select the account to be displayed in the ledger. This is no longer necessary, as to view another account, you can just open a new tab. </para> -<para> - If displayed, most of the filter area is a text entry area. Typing in this filter - box will cause &kmymoney; to display only transactions containing the text typed in - the box. The text specified can be in any of the fields of the transaction for the - displayed account. At the right end of the filter box is a small - <quote>x</quote> in a black box.<!-- FIXME: use actual icon --> Clicking this icon - will clear any text in the filter box. -</para> - -<para> - At the right of the text entry is a status filter dropdown. The default value is - <guilabel>Any status</guilabel> which does not apply any filter to the list. The - other values allow you to restrict the list of displayed transactions to those - which are <guilabel>Imported</guilabel>, <guilabel>Matched</guilabel>, - <guilabel>Erroneous</guilabel>, <guilabel>Not marked</guilabel>, <guilabel>Not - reconciled</guilabel>, <guilabel>Cleared</guilabel>, or - <guilabel>Scheduled</guilabel>. -</para> -</sect2> - <sect2><title>The transaction list</title> <screenshot> <screeninfo>ledgers view transaction list</screeninfo> @@ -128,7 +86,7 @@ </screenshot> <para> - The transaction list displays all the (possible filtered) transaction in the + The transaction list displays all the (possible filtered) transactions in the account. The following columns are always displayed: </para> @@ -140,7 +98,7 @@ <formalpara><title>Detail</title> <para> - this shows the category/categories, other account (for transfers,) and memo for the + the category/categories, other account (for transfers,) and memo for the transaction </para> </formalpara> @@ -154,9 +112,9 @@ <formalpara><title>Balance</title> <para> - Note that this depends on the currently displayed sort order, and will not be - calculated if the display is filtered by the searching within the filter box or - transaction status dropdown, as described above. + This depends on the currently displayed sort order, and will not be calculated if + the display is filtered by use of the filter box or transaction status dropdown, as + described above. </para> </formalpara> @@ -186,9 +144,9 @@ <formalpara><title>C</title> <para> - the Reconciliation Status. The value can be blank, a <quote>C</quote> for Cleared, - or <quote>R</quote> for Reconciled. The meaning of these terms is discussed in a - following section on Reconciliation. <!-- FIXME: make a real link --> + the Reconciliation Status. The value can be blank, <quote>C</quote> for Cleared, + or <quote>R</quote> for Reconciled. The meaning of these terms is discussed + further <link linkend="details.ledgers.cleared">below</link>. </para> </formalpara> @@ -206,9 +164,9 @@ <para> Note that altering the sort order can be useful in special circumstances, but for - many sort orders, especiallyl where the transaction date is not the first sort key, - the balance column will not be very meaningful, and will almost certainly not match - the balance of any statement or display by the bank or institution. + many sort orders, especially where the transaction post date is not the first sort + key, the balance column will not be very meaningful, and will almost certainly not + match the balance of any statement or display by the bank or institution. </para> <para> @@ -248,13 +206,78 @@ </formalpara> </sect2> +<sect2 id="details.ledgers.view.filter"><title>The filter area</title> + +<para> + In previous versions of &kmymoney;, the filter area was at the top of the + transaction list, and was always displayed. Now, when shown, it is at the bottom. + It is normally hidden, but can be displayed by typing + <keycombo>&Ctrl;<keycap>F</keycap></keycombo>. At the left of the filter area is a + <guiicon> <inlinemediaobject> <imageobject> <imagedata fileref="dialog-close.svg" + format="SVG"/></imageobject></inlinemediaobject></guiicon> Dialog Close icon. + Clicking on this will clear any filters in place and hide the filter area. +</para> + +<screenshot> + <screeninfo>ledgers view filter area</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="ledger_filter.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>ledgers view filter area</phrase> + </textobject> + </mediaobject> +</screenshot> + +<para> + If displayed, most of the filter area is a text entry area. Typing here will cause + &kmymoney; to display only transactions containing the text typed in the box. The + text specified can be in any of the fields of the transaction for the displayed + account. Clicking the <guiicon> <inlinemediaobject> <imageobject> <imagedata + fileref="edit-clear.svg" format="SVG"/></imageobject> </inlinemediaobject> + </guiicon> clear text icon at the right end of the text entry box will clear any + text in the filter box. +</para> + +<para> + At the right of the text entry is a status filter dropdown. The default value is + <guilabel>Any status</guilabel>, which does not apply any filter to the list. The + <guilabel>Not marked</guilabel> and <guilabel>Cleared</guilabel> choices have been + previously explained. <guilabel>Not reconciled</guilabel> includes transactions in + either of the above groups. There is currently so specific filter for + <guilabel>Reconciled</guilabel> transactions. +</para> + +<para> + <guilabel>Imported</guilabel> selects transactions which have been imported, even + if they have been matched with a non-imported transaction. + <guilabel>Matched</guilabel> selects transactions which have beem matched, either + by &kmymoney; as part of the import process or manually matched by the user. + However, once you have clicked <guilabel>Accept</guilabel> on such a transaction, + it will not be selected by this filter. +</para> + +<para> + <guilabel>Erroneous</guilabel> selects transactions where &kmymoney; has detected + some problem. Most commonly, this is an <link + linkend="details.ledgers.split">unbalanced transaction</link>, which is often the + case for imported transactions. +</para> + +<para> + <guilabel>Scheduled</guilabel> selects upcoming <link + linkend="details.schedules">Scheduled Transactions</link>. +</para> +</sect2> + <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. - However, if present, it generally includes fields for all the details of a single - transaction, as well as buttons for various actions that can apply to a - transaction. It is described in more detail in the following sections. + View depends on your configuration and the type of account being displayed. If + present, it includes fields for all the details of a single transaction, as well as + buttons for various actions that can apply to a transaction. It is described in + more detail in the following sections. </para> </sect2> </sect1> @@ -264,17 +287,19 @@ There are two methods of entering transactions into the ledger: using the transaction form or entering the data directly into the transaction list. The transaction form is displayed by default and this is the method we will discuss - first. Turning off the transaction form can be accomplished by going to the Ledger - section in the Configure &kmymoney; that's within the Settings. - <!-- FIXME: use a proper link --> + first. Turning off the transaction form can be accomplished with a check-box on + the dialog presented when you select the <guimenuitem>Configure + &kmymoney;...</guimenuitem> menu item and clicking <guilabel>Ledger</guilabel> on + the left. This is described in the section on <link + linkend="details.settings.register">configuring the Ledger</link>. </para> <para> - The fields in the input area match the information fields in the transaction list. - Additional fields include the Memo field, for a more detailed description of the - transaction, and a Category selection. The Split button allows you to split the - transaction into multiple categories. - <!-- FIXME: use specific link to discussion of split transaction --> + The fields in the input area match the fields in the transaction list. Additional + fields include the Memo field, for a more detailed description or information + related to the transaction, and a Category selection. The Split button allows you + to <link linkend="details.ledgers.split">split the transaction</link> into multiple + categories. </para> </sect1> @@ -349,9 +374,8 @@ </para> <para> - See the special <link linkend="reference.widgets">&kmymoney; fields</link> - section for more information on how to use this field. - <!-- FIXME: probably need better link to explanation of split transactions --> + See the special section on <link linkend="reference.widgets.category">&kmymoney; + fields</link> for some additional information on how to use this field. </para> </sect3> @@ -442,32 +466,25 @@ </para> <para> - <!-- FIXME: confirm this is right. It looks to me like new entry is always in the - form, although the form is shown at the "correct" position in the ledger, not at - the bottom. --> To do this you must first let &kmymoney; know that you don't want to use the - transaction form. This is done by selecting the <menuchoice><guimenu>Settings</guimenu> - <guimenuitem>Configure &kmymoney;...</guimenuitem></menuchoice> menu item and - selecting the <guiicon><inlinemediaobject><imageobject><imagedata - fileref="ledgers_view.png" format="PNG"/></imageobject></inlinemediaobject> - </guiicon> register icon from the list on the left. The option to uncheck is - labeled <guilabel>Show transaction form</guilabel>. When finished click on - <guibutton>OK</guibutton> to be ready to directly enter or edit transactions. + transaction form. This is done by selecting the <guimenu>Settings</guimenu> + <guimenuitem>Configure &kmymoney;...</guimenuitem> menu item and selecting the + <guiicon><inlinemediaobject><imageobject><imagedata fileref="ledgers_view.png" + format="PNG"/></imageobject></inlinemediaobject> </guiicon> register icon from the + list on the left. The option to uncheck is labeled <guilabel>Show transaction + form</guilabel>. When finished click on <guibutton>OK</guibutton> to be ready to + directly enter or edit transactions. </para> <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 - action="simul">&Ctrl;&Ins;</keycombo>, or select the - <menuchoice><guimenu>Transaction</guimenu> + at the bottom of the ledger list, press <keycombo>&Ctrl;&Ins;</keycombo>, or select + the <menuchoice><guimenu>Transaction</guimenu> <guimenuitem>New transaction...</guimenuitem></menuchoice> menu item. To edit an - existing transaction, the &Up; and &Down; arrow keys let you navigate through the + existing transaction, use the &Up; and &Down; arrow keys to navigate through the list. After pressing &Enter; or double-clicking on an entry, the transaction list displays the fields required to enter or edit the transaction. - <!-- FIXME: should we just say this is the floating transaction for or the - transaction form appears at the location of the transaction in the list - instead of at the bottom of the list? --> </para> <para> @@ -491,58 +508,44 @@ <sect1 id="details.ledgers.split"><title>Split Transactions</title> <para> - The split transaction feature allows you to divide up a transaction into multiple + The split transaction feature allows you to divide a transaction into multiple categories, representing, for example, the different types of items bought with a single purchase at a store. </para> -<!-- FIXME: Need to note you cas assign a payee in the split editor, and it (?) shows - up in the memo columne, which needs to be fixed. - Also need to mention th new buttons: Merge, Delete (different from Delete 0 --> - <para> A transaction always contains one or more splits. Each split represents money - moving into or out of a sigle account. - <!-- FIXME: Is there somewhere else this can refer to which explains in any more - detail what can and can't be split, and the possibility of a transaction with - only one split for adding or removing shares. We also need a place to - explaint currency conversion, and how it relates to currencies. --> - Most of the time, a transaction contains exactly two splits, one for the account - the money is coming from and the other for the account the money is going to. The - term <quote>Split Transaction</quote> is used when one side of the transaction is - further divided into more than one split. This is most commonly done when money - moves in or out of a typical bank account, but is allocated to more than one - category. -</para> - -<para> - To enter a split transaction, using either the transaction form or the transaction - list, start a new transaction, including entering the total amount. Then, instead - of selecting a category, click the <guibutton>Split</guibutton><!-- FIXME: use - actual icon --> button to the right of the <guilabel>Category</guilabel> field. If - you have already selected a category, that becomes the first entry in the split - editor screen. + moving into or out of a sigle account. Most of the time, a transaction contains + exactly two splits, one for the account the money is coming from and the other for + the account the money is going to. The term <quote>Split Transaction</quote> is + used when one side of the transaction is further divided into more than one split. + This is most commonly done when money moves in or out of a typical bank account, + but is allocated to more than one category. +</para> + +<para> + In almost all cases, if a transaction has only one split, it is said to be + <quote>unbalanced</quote> meaning that money is coming from somewhere, but not + going anywhere (or vice versa.) Such transactions are typically flagged by being + displayed in red in the Ledger. The only valid transactions with a single split + occurs in Investment Accounts: Add, Remove, or Split shares. +</para> + +<para> + To enter a split transaction, create a new transaction, entering the total amount. + Then, instead of selecting a category, click the <guiicon> <inlinemediaobject> + <imageobject> <imagedata fileref="split_icon.svg" format="SVG"/> </imageobject> + </inlinemediaobject> </guiicon> split icon at the right of the + <guilabel>Category</guilabel> field. If you have already selected a category, that + becomes the first entry in the split editor. </para> - + <para> - In the split editor screen, double-click an empty line to enter a new split or - sub-transaction or press <keycombo action="simul">&Ctrl;&Ins;</keycombo>. Specify - the category, add an (optional) memo, and enter the amount. To save this part of - the split, press the green check mark under the category. To cancel, press the red - cross.<!-- FIXME: the check and cross are in the second below shot, not the one - immediately below. Can we make this description closer to it's picture? --> + This will display the Split Edito, which shows the Category, Memo, and Payment or + Deposit for each split. It also shows the total of the splits, the amount of the + transaction, and the difference between them. </para> -<para> - After entering a split, the bottom of the split editor shows how much of the total - transaction is still unassigned. After entering all the splits, press the - <guibutton>OK</guibutton> button to save the entire transaction. If there is still - an unassigned amount, you will be prompted to either return to editing the splits, - change the total transaction amount, or leave part of the transaction - unassigned. <!-- FIXME: Have the check and cross been replaced with OK and Cancel - buttons? --> -</para> - <screenshot> <screeninfo>split editor split with unassigned amount</screeninfo> <mediaobject> @@ -555,22 +558,56 @@ </mediaobject> </screenshot> +<para> + To enter a new split or sub-transaction click the <guibutton>New</guibutton> button + press <keycombo action="simul">&Ctrl;&Ins;</keycombo>, or double-click an empty + row. Double-clicking an existing row lets you edit the split. This will expand + the row into form where you can enter or edit a split. +</para> + +<screenshot> + <screeninfo>split transaction edit form</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="single_split.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>split transaction edit form</phrase> + </textobject> + </mediaobject> +</screenshot> + +<para> + Here you specify the category and amount, as well as optional payee, memo, and + tag(s). Note that if a payee and memo were entered into the transaction before + entering the split editor, they will be included in the first split. It often + makes sense to enter a specific memo for each split. This can also be done for the + Payee, but it may make more sense to enter that only once for the transaction. To + save this the split, press <guibutton>Enter</guibutton>. To cancel, press + <guibutton>Cancel</guibutton>. +</para> + +<para> + After entering a split, the bottom of the split editor shows how much of the total + transaction is still unassigned. After entering all the splits, press the + <guibutton>OK</guibutton> button to save the entire transaction. If there is still + an unassigned amount, you will be prompted to either return to editing the splits, + change the total transaction amount, or leave part of the transaction unassigned. + The same is true if the amount is overassigned, in which case the total of the + splits is more than the amount of the transaction. +</para> + <para> To redistribute an <quote>Unassigned</quote> or <quote>Overassigned</quote> amount, - select a split item that has to be adjusted. After that click the <guibutton>Apply + select the split to be adjusted, and click the <guibutton>Apply Difference</guibutton> button. If <quote>Unassigned</quote> was previously shown and non-zero, that amount will be added to the selected line item value. If <quote>Overassigned</quote> was previously shown and non-zero, that amount will be - subtracted from the selected line item value. As the result, the + subtracted from the selected line item value. As a result, the <quote>Unassigned</quote> or <quote>Overassigned</quote> amount will be set to zero and the transaction can be saved successfully. </para> -<para> - Note that the category field in the transaction form or the transaction list now - displays a comma separated list of the categories in each of the split entries. -</para> - <screenshot> <screeninfo>split transaction in ledger</screeninfo> <mediaobject> @@ -582,6 +619,12 @@ </textobject> </mediaobject> </screenshot> + +<para> + Note that the category field in the transaction form or the transaction list now + displays a comma separated list of the categories in each of the split entries. + Payees entered in a split also show up within the memo field in the register. +</para> </sect1> <sect1 id="details.ledger.actions"><title>Other transaction actions</title> @@ -608,12 +651,14 @@ <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 - for differences in the dates, there is a default setting of 4 days, which may be - changed in the settings - Register/Import. <!-- FIXME: make proper link --> Any - transactions so matched will be highlighted in green. <!-- FIXME: confirm the color - highlight --> On completion of the import, you should review these and either - accept or unmatch them. + will automatically attempt to match them against existing transactions. This can + be useful for transactions which are created both as Scheduled Transactions, and + also imported from your bank or credit card. To allow for differences in the + dates, there is a default setting of 4 days, which may be changed in + <guimenu>Settings</guimenu><guimenuitem>Configure MyMopney...</guimenuitem> Ledger + section, <link linkend="details.settings.register.import">Import Tab</link>. Any + transactions so matched will be highlighted in the ledget, and on completion of the + import, you should review these and either accept or unmatch them. </para> <para> @@ -636,13 +681,25 @@ of the transactions to be matched by clicking on it, then select the other by left clicking on it while pressing the <keycap>&Ctrl;</keycap> key, and then select <guimenuitem>Match</guimenuitem> from the context menu. This will match and - combine the two transactions. The values of both transactions must be the - same for the match to work, except that the dates may differ by the window - specified in the settings, as described above. + combine the two transactions. The values of both transactions must be the same for + the match to work, except that the dates may differ by the window specified in the + settings, as described above. </para> +<screenshot> + <screeninfo>Match transaction dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="match_transaction.png" format="PNG" /><!-- FIXME: need pic --> + </imageobject> + <textobject> + <phrase>Match transaction dialog</phrase> + </textobject> + </mediaobject> +</screenshot> + <para> - <!-- FIXME: get screenshot and confirm this description --> + <!-- FIXME: get above screenshot --> Since the value is the only field in the two transaction which must absolutely be the same, the value of other fields may differ. When you select <guilabel>Match</guilabel>, you will see a <guilabel>Match Transactions</guilabel> @@ -650,13 +707,16 @@ the source of the other fields in the matched transaction. Note that if one of the transactions is imported, the date of that transactoin will always be used in the matched transaction, even if all other fields are taken from the non-imported - transaction. + transaction. That dialog also gives you the option of reversing the transactions + in terms of which is used as a source of fields which differ. </para> <para> - If you are happy with the status of the match dialog, right-click the matched - transaction, then select <guibutton>Accept</guibutton>.<!-- where do you really right-click, - as you see the match dialog --> + If you are happy with the status of the match dialog, click + <guibutton>OK</guibutton>. The transaction is then displayed as a Matched + Transaction in the Ledger. You can then click <guimenu>Transaction</guimenu> + <guimenuitem>Accept</guimenuitem> or right-click the matched transaction and select + <guibutton>Accept</guibutton> from the context menu. </para> <para> @@ -678,12 +738,14 @@ <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 - important to know that transaction can have one of three states: non-reconciled - (blank), cleared (C), or reconciled (R). When a transaction is entered, it has - state of non-reconciled. Once the bank posts the transaction, the user can mark it - as cleared and thus transform it to state (C). + A later section of this handbook discusses <link + linkend="details.reconcile">reconciliation</link> in more detail. For now, it is + only important to know that transaction can have one of three states: not marked + (blank), cleared (C), or reconciled (R). When a transaction is entered, it's state + is <quote>not marked</quote>. Once the bank posts the transaction, the user can + mark it as cleared and thus transform it to state (C). Note that these are only a + subset of the states described earlier as available in the <link + linkend="details.ledgers.view.filter">Ledger Filter</link>. </para> <screenshot> @@ -702,10 +764,10 @@ When you receive a statement from the bank, all cleared transactions should be on the statement. When you reconcile your account, you confirm that the transactions marked Cleared and the transactions listed on the statement are the same, and that - the difference between the beginning balance and the cleared transactions equals - the ending balance of the statement. When this is the case, you can 'finish - reconciling' which changes the state of all cleared (C) transactions prior to the - date of reconciliation to reconciled (R). + the beginning balance plus the sum of the cleared transactions equals the ending + balance of the statement. When this is the case, you can 'finish reconciling' + which changes the state of all cleared (C) transactions prior to the date of + reconciliation to reconciled (R). </para> <para> @@ -729,11 +791,7 @@ Most of the settings are self explanatory. The section linked above has a more detailed explanation of each of the settings. Some of these settings have already been mentions, but for clarity, several of them are explained briefly below. - </para> -<!-- FIXME - if these are explained in the chapter on settings, just refer to that - as is done above, and don't duplicate here. Leaving for now, but should clean - up later. *** started simplifyiing here, but not done 20230904 JHO --> <formalpara><title>Show transaction form</title> <para> diff --git a/doc/details-payees.docbook b/doc/details-payees.docbook index 449920be3b..c12d150b43 100644 --- a/doc/details-payees.docbook +++ b/doc/details-payees.docbook @@ -63,37 +63,52 @@ <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 - Payee</quote>. You can also right-click on any existing payee and select - <guimenuitem>Add payee</guimenuitem>. + To add a payee or payer, click the <guiicon> <inlinemediaobject> <imageobject> + <imagedata fileref="list-add-user.svg" format="SVG"/> </imageobject> + </inlinemediaobject> </guiicon>New Payee button. This creates a new payee called + <quote>New Payee</quote>. You can also right-click on any existing payee and + select <guimenuitem>Add payee</guimenuitem>. </para> </sect2> <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 - editable. Changing the name will affect the name in all the transactions in which - it appears. + To rename a payee or payer, select the payee (left click on the name) and click + the <guiicon> <inlinemediaobject> <imageobject> <imagedata + fileref="user-group-properties.svg" format="SVG"/> </imageobject> + </inlinemediaobject> </guiicon>Rename Payee button. You can also double-click on + the name or right-click on the name and select <guimenuitem>Rename + payee</guimenuitem>. The name then becomes editable. Changing the name will + affect the name in all the transactions in which it appears. </para> </sect2> <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, - you will be presented with a dialog that allows you to reassign them to a - different payee, and also a checkbox to enable the deleted name to be added - to the new payee's matching list. Another option for deleting an existing - payee is to select the payee or payer by left clicking it and then left - clicking <guibutton>Del</guibutton>. + To remove a payee or payer, select it and click the <guiicon> <inlinemediaobject> + <imageobject> <imagedata fileref="list-remove-user.svg" format="SVG"/> + </imageobject> </inlinemediaobject> </guiicon> Delete Payee button, or right-click + the name and select <guimenuitem>Delete payee</guimenuitem>. If the payee has any + transactions, you will be presented with a dialog that allows you to reassign them + to a different payee, and also a checkbox to add the deleted name to the new + payee's matching list. </para> </sect2> <sect2 id="details.payees.merging"><title>Merging Payees</title> <para> -<!-- FIXME: write something here -->You can merge payees. + To merge two payees, select one of them (left-click the name) then select the other + (<keycombo>&Ctrl;<mousebutton>left click</mousebutton></keycombo>). You can then + either click the <guiicon><inlinemediaobject><imageobject><imagedata + fileref="user-group-properties.svg" format="SVG"/></imageobject> + </inlinemediaobject> </guiicon> Merge Payees button or right-click either of the + selected payees and select <guilabel>Merge Payees</guilabel>.. You will get a + pop-up asking if you really want to merge the selected payees. If you click + <guibutton>Yes</guibutton>, you will get another popup for you to specify thename + of the payee for the combined data. There will be a drop-down with the names of + the payess you selected for merging (you can actually select more than two) and it + also allows you to type in a completely new name. There is also a checkbox to add + the names of the merged payees to the matching list of the new payee. </para> </sect2> </sect1> diff --git a/doc/details-schedules.docbook b/doc/details-schedules.docbook index b95fe14d65..6fdece5828 100644 --- a/doc/details-schedules.docbook +++ b/doc/details-schedules.docbook @@ -190,7 +190,7 @@ The <guilabel>Do not change amount of category but modify exchange rate of transaction</guilabel> checkbox can be used when the schedule involves an account and a category with different currencies. If it is not selected, the amount - specified is used when the transaction is entered into the ledger. Checked the box + specified is used when the transaction is entered into the ledger. Checking the box 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. diff --git a/doc/details-tags.docbook b/doc/details-tags.docbook index 30ae1ca215..2417ec219f 100644 --- a/doc/details-tags.docbook +++ b/doc/details-tags.docbook @@ -56,8 +56,8 @@ <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 - fileref="list-add.png"/></imageobject></inlinemediaobject></guiicon> new tag icon. - Second, you can right-click on any tag and choose <guimenuitem>New + fileref="tag-new.svg" format="SVG"/></imageobject></inlinemediaobject></guiicon> + new tag icon. Second, you can right-click on any tag and choose <guimenuitem>New tag...</guimenuitem>. This creates a new tag called <quote>New tag.</quote> See the next section for how to rename the tag. Finally, you can add a new tag directly in the ledger or within a split transaction by typing the name of the tag in the tag @@ -69,21 +69,21 @@ <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 - add and remove icons) or right-click on the name and then select - <guimenuitem>Rename tag</guimenuitem>. The name then becomes editable. Changing - the name will affect the name in all the transactions in which it appears. + <guiicon><inlinemediaobject><imageobject><imagedata fileref="tag-edit.svg" + format="SVG"/></imageobject></inlinemediaobject></guiicon> or right-click on the + name and then select <guimenuitem>Rename tag</guimenuitem>. The name then becomes + editable. Changing the name will affect the name in all the transactions in which + it appears. </para> </sect2> <sect2><title>Deleting a Tag</title> <para> - To delete a tag, either click on the - <guiicon><inlinemediaobject><imageobject><imagedata fileref="list-remove.png" - format="PNG"/></imageobject></inlinemediaobject></guiicon> delete tag icon or - right-click the name and select <guimenuitem>Delete tag</guimenuitem>. If the tag - has any transactions, you will be presented with a dialog that allows you to - reassign them to a different tag. + To delete a tag, either click on the <guiicon><inlinemediaobject><imageobject> + <imagedata fileref="tag-delete.svg" format="SVG"/></imageobject> + </inlinemediaobject> </guiicon> delete tag icon or right-click the name and select + <guimenuitem>Delete tag</guimenuitem>. If the tag has any transactions, you will + be presented with a dialog that allows you to reassign them to a different tag. </para> <note> diff --git a/doc/details-widgets.docbook b/doc/details-widgets.docbook index 716bea5be3..e2d896fa74 100644 --- a/doc/details-widgets.docbook +++ b/doc/details-widgets.docbook @@ -30,15 +30,15 @@ <para> <screenshot> - <screeninfo>Tip of the Day</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="date_widget.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Date widget</phrase> - </textobject> - </mediaobject> + <screeninfo>Date widget</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="date_widget.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Date widget</phrase> + </textobject> + </mediaobject> </screenshot> </para> @@ -107,15 +107,15 @@ <para> <screenshot> - <screeninfo>Tip of the Day</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="value_widget.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Value widget</phrase> - </textobject> - </mediaobject> + <screeninfo>Value widget</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="value_widget.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Value widget</phrase> + </textobject> + </mediaobject> </screenshot> </para> @@ -140,15 +140,15 @@ <para> <screenshot> - <screeninfo>Tip of the Day</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="payee_widget.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Payee widget</phrase> - </textobject> - </mediaobject> + <screeninfo>Payee widget</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="payee_widget.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Payee widget</phrase> + </textobject> + </mediaobject> </screenshot> </para> @@ -167,8 +167,7 @@ </sect2> -<sect2 id="reference.widgets.category"> -<title>Category/account entry</title> +<sect2 id="reference.widgets.category"><title>Category/account entry</title> <para> When you are requested to enter the name of a category or account, you can @@ -182,15 +181,15 @@ <para> <screenshot> - <screeninfo>Tip of the Day</screeninfo> - <mediaobject> - <imageobject> - <imagedata fileref="category_widget.png" format="PNG" /> - </imageobject> - <textobject> - <phrase>Category widget</phrase> - </textobject> - </mediaobject> + <screeninfo>Category widget</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="category_widget.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>Category widget</phrase> + </textobject> + </mediaobject> </screenshot> </para> diff --git a/doc/dialog-close.svg b/doc/dialog-close.svg new file mode 100644 index 0000000000..1b7056c853 --- /dev/null +++ b/doc/dialog-close.svg @@ -0,0 +1,17 @@ +<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 16 16"> + <defs id="defs3051"> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + .ColorScheme-NegativeText { + color:#da4453; + } + </style> + </defs> + <path + style="fill:currentColor;fill-opacity:1;stroke:none" + class="ColorScheme-NegativeText" + d="M 8,2 A 6,6 0 0 0 2,8 6,6 0 0 0 8,14 6,6 0 0 0 14,8 6,6 0 0 0 8,2 Z M 5.70703,5 8,7.29297 10.29297,5 11,5.70703 8.70703,8 11,10.29297 10.29297,11 8,8.70703 5.70703,11 5,10.29297 7.29297,8 5,5.70703 5.70703,5 Z" + /> +</svg> diff --git a/doc/edit-clear.svg b/doc/edit-clear.svg new file mode 100644 index 0000000000..f49be9b0a5 --- /dev/null +++ b/doc/edit-clear.svg @@ -0,0 +1,13 @@ +<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 16 16"> + <defs id="defs3051"> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + </style> + </defs> + <path style="fill:currentColor;fill-opacity:1;stroke:none" + d="M 6 2 L 0.70703125 7.2929688 L 0 8 L 0.70703125 8.7070312 L 6 14 L 15 14 L 16 14 L 16 2 L 15 2 L 6 2 z M 8.0019531 5 L 10.011719 7.0097656 L 12.021484 5 L 13.011719 5.9902344 L 11.001953 8 L 13.011719 10.009766 L 12.021484 11 L 10.011719 8.9902344 L 8.0019531 11 L 7.0117188 10.009766 L 9.0214844 8 L 7.0117188 5.9902344 L 8.0019531 5 z " + class="ColorScheme-Text" + /> +</svg> diff --git a/doc/ledger_filter.png b/doc/ledger_filter.png new file mode 100644 index 0000000000..1ec36eb61e Binary files /dev/null and b/doc/ledger_filter.png differ diff --git a/doc/list-add-user.svg b/doc/list-add-user.svg new file mode 100644 index 0000000000..f724bed8ca --- /dev/null +++ b/doc/list-add-user.svg @@ -0,0 +1,13 @@ +<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 16 16"> + <defs id="defs3051"> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + </style> + </defs> + <path style="fill:currentColor;fill-opacity:1;stroke:none" + d="M8 2A3 3 0 0 0 5 5 3 3 0 0 0 8 8 3 3 0 0 0 11 5 3 3 0 0 0 8 2M8 3A2 2 0 0 1 10 5 2 2 0 0 1 8 7 2 2 0 0 1 6 5 2 2 0 0 1 8 3M8 9A5 4.5 0 0 0 3 13.5 5 4.5 0 0 0 3.033203 14H8V13H4.045A4 3.5 0 0 1 8 10zM11 9V11H9V12H11V14H12V12H14V11H12V9z" + class="ColorScheme-Text" + /> +</svg> diff --git a/doc/list-remove-user.svg b/doc/list-remove-user.svg new file mode 100644 index 0000000000..9d5fc8d899 --- /dev/null +++ b/doc/list-remove-user.svg @@ -0,0 +1,16 @@ +<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 16 16"> + <defs id="defs3051"> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + .ColorScheme-NegativeText { + color:#da4453; + } + </style> + </defs> + <path + style="fill:currentColor;fill-opacity:1;stroke:none" + class="ColorScheme-NegativeText" + d="m8 2c-1.657 0-3 1.343-3 3 0 1.657 1.343 3 3 3 1.657 0 3-1.343 3-3 0-1.657-1.343-3-3-3m0 1c1.105 0 2 .895 2 2 0 1.105-.895 2-2 2-1.105 0-2-.895-2-2 0-1.105.895-2 2-2m0 6c-2.761 0-5 2.01-5 4.5.001.167.012.334.033.5h4.967v-1h-3.955c.284-1.721 1.968-2.998 3.955-3zm1 2v1h5v-1z" /> +</svg> diff --git a/doc/single_split.png b/doc/single_split.png new file mode 100644 index 0000000000..724790df89 Binary files /dev/null and b/doc/single_split.png differ diff --git a/doc/split_icon.svg b/doc/split_icon.svg new file mode 100644 index 0000000000..d9349dc774 --- /dev/null +++ b/doc/split_icon.svg @@ -0,0 +1,13 @@ +<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 16 16"> + <defs id="defs3051"> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + </style> + </defs> + <path + style="fill:currentColor;fill-opacity:1;stroke:none" + d="m10 2v2h-5v3h-3v2h3v3h5v2l4-2.5-4-2.5v2h-4v-6h4v2l4-2.5z" + class="ColorScheme-Text"/> +</svg> diff --git a/doc/split_transaction.png b/doc/split_transaction.png index e058f1404a..26c3dd0d8d 100644 Binary files a/doc/split_transaction.png and b/doc/split_transaction.png differ diff --git a/doc/split_unassigned.png b/doc/split_unassigned.png index 0476666010..4f8e451c53 100644 Binary files a/doc/split_unassigned.png and b/doc/split_unassigned.png differ diff --git a/doc/tag-edit.svg b/doc/tag-edit.svg new file mode 100644 index 0000000000..64046dfe1c --- /dev/null +++ b/doc/tag-edit.svg @@ -0,0 +1,8 @@ +<svg version="1.1" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg";> + <defs> + <style id="current-color-scheme" type="text/css">.ColorScheme-Text { + color:#232629; + }</style> + </defs> + <path class="ColorScheme-Text" d="m8 2-5.96875 0.03125-0.03125 5.96875 5 4.615234v-5.615234h5.615234l-4.615234-5zm-2.5 2c0.8284271 0 1.5 0.6715728 1.5 1.5s-0.6715729 1.5-1.5 1.5-1.5-0.6715728-1.5-1.5 0.6715729-1.5 1.5-1.5zm6.5 4-4 4v2h2l4-4-2-2zm-0.310547 1.6894531 0.591797 0.5917969-2.96875 2.984375v0.015625l-0.59375-0.59375 2.970703-2.9980469z" fill="currentColor"/> +</svg> diff --git a/doc/tag-new.svg b/doc/tag-new.svg new file mode 100644 index 0000000000..4f75f355e7 --- /dev/null +++ b/doc/tag-new.svg @@ -0,0 +1,13 @@ +<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 16 16"> + <defs id="defs3051"> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + </style> + </defs> + <path style="fill:currentColor;fill-opacity:1;stroke:none" + d="M 8 2 L 2.03125 2.03125 L 2 8 L 8 13.539062 L 8 8 L 9 8 L 10 8 L 13.539062 8 L 8 2 z M 5.5 4 C 6.3284271 4 7 4.6715728 7 5.5 C 7 6.3284272 6.3284271 7 5.5 7 C 4.6715729 7 4 6.3284272 4 5.5 C 4 4.6715728 4.6715729 4 5.5 4 z M 11 9 L 11 11 L 9 11 L 9 12 L 11 12 L 11 14 L 12 14 L 12 12 L 14 12 L 14 11 L 12 11 L 12 9 L 11 9 z " + class="ColorScheme-Text" + /> +</svg> diff --git a/doc/user-group-properties.svg b/doc/user-group-properties.svg new file mode 100644 index 0000000000..fa4c9e0724 --- /dev/null +++ b/doc/user-group-properties.svg @@ -0,0 +1,13 @@ +<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 16 16"> + <defs id="defs3051"> + <style type="text/css" id="current-color-scheme"> + .ColorScheme-Text { + color:#232629; + } + </style> + </defs> + <path + style="fill:currentColor;fill-opacity:1;stroke:none" + d="M 9 2 L 9 3 L 14 3 L 14 2 L 9 2 z M 5.5 4 A 2.5 2.5 0 0 0 3 6.5 A 2.5 2.5 0 0 0 5.5 9 A 2.5 2.5 0 0 0 8 6.5 A 2.5 2.5 0 0 0 5.5 4 z M 9 5 L 9 6 L 14 6 L 14 5 L 9 5 z M 9 8 L 9 9 L 14 9 L 14 8 L 9 8 z M 5.5 10 A 3.499998 4 0 0 0 2 14 L 9 14 A 3.499998 4 0 0 0 5.5 10 z M 5.5 11 A 2.5 3 0 0 1 7.8535156 13 L 3.1464844 13 A 2.5 3 0 0 1 5.5 11 z " + class="ColorScheme-Text"/> +</svg>
