Git commit c3004af563994a625a109027f54f4bc180fe9152 by Jack Ostroff. Committed on 12/12/2023 at 02:07. Pushed by ostroffjh into branch 'Handbook-5.2'.
more work on settings, and some general cleanup M +12 -1 README-CONTRIBUTORS M +1 -1 doc/details-accounts.docbook M +1 -1 doc/details-formats.docbook M +2 -2 doc/details-impexp-csv.docbook M +1 -1 doc/details-investments.docbook M +1 -1 doc/details-schedules.docbook M +1 -1 doc/details-search.docbook M +325 -221 doc/details-settings.docbook M +1 -1 doc/makemostof.docbook https://invent.kde.org/office/kmymoney/-/commit/c3004af563994a625a109027f54f4bc180fe9152 diff --git a/README-CONTRIBUTORS b/README-CONTRIBUTORS index f1c891f49..63f8e5a8a 100644 --- a/README-CONTRIBUTORS +++ b/README-CONTRIBUTORS @@ -363,5 +363,16 @@ elsewhere. - on the config dialog, home section, should the top area be put in a box as are the other two areas, and most of the contents on the other sections? -- Forecast Vuiw - doesn't seem to change forecast method without restarting KMM. +- Forecast View - doesn't seem to change forecast method without restarting KMM. +- "Show all split details in ledger" acts inconsistenly. With a split transaction, + if a split has a memo, that memo is shown in stead of the second category. I don't + know if this is related to the bug I just filed about splits getting duplicated if + you toggle that setting while the transaction is open for editing. + +- Is there any consistency or pattern in config dialogs where something with a small + number of choicees is presented as a dropdown or a set of radio-button items? For + example, Ledger configuration, Data Entry tab: Default reconciliation state is + dropdown with three choices, but Autofill has three radio-button choices. + +- \ No newline at end of file diff --git a/doc/details-accounts.docbook b/doc/details-accounts.docbook index 94481fdff..1d1824d14 100644 --- a/doc/details-accounts.docbook +++ b/doc/details-accounts.docbook @@ -809,7 +809,7 @@ fileref="ledgers_view.png" format="PNG"/></imageobject></inlinemediaobject></guiicon> ledgers icon in the view selector. If the account is not already displayed there, then click on the - <quote>+</quote> in the right-most tab and select the account in the drop down box + <quote>+</quote> in the right-most tab and select the account in the dropdown box which appears. Alternatively, in the Accounts View or the Institutionss View, either double-click the account name or right-click and select <guimenuitem>Open ledger</guimenuitem>. diff --git a/doc/details-formats.docbook b/doc/details-formats.docbook index 5eff645bf..f24b0f5af 100644 --- a/doc/details-formats.docbook +++ b/doc/details-formats.docbook @@ -133,7 +133,7 @@ <sect3 id="details.formats.encrypted.keysettings"><title>Setting the keys in &kmymoney;</title> <para> - On the encryption page of the settings dialog, there is a drop down list where you + On the encryption page of the settings dialog, there is a dropdown list where you can select the key that should be used for encryption and decryption. Additionally, there is a field where you can enter the key-id of a key not in the listbox. You can use either the key-id, the email address associated with this diff --git a/doc/details-impexp-csv.docbook b/doc/details-impexp-csv.docbook index 8bdb8f316..d8db233f2 100644 --- a/doc/details-impexp-csv.docbook +++ b/doc/details-impexp-csv.docbook @@ -431,7 +431,7 @@ If the file contains transactions for just a single security, with the name possibly in a header row, the name should be entered into the <guilabel>Security Name</guilabel> box. The name you enter will be added to - the drop-down list for future use. You may subsequently wish to remove that + the dropdown list for future use. You may subsequently wish to remove that name from the list. If so, select it, then click the <guilabel>Hide security</guilabel> button. This removes it only from this list, and has no effect on your main &kmymoney; file. @@ -563,7 +563,7 @@ containing that detail. Now, on the <guilabel>Invalid transaction</guilabel> box you may get a few entries because the activity type does not match the qty/price/amount combination. On each message, click <guilabel>Select - Transaction Type</guilabel>, and a drop down will appear indicating valid + Transaction Type</guilabel>, and a dropdown will appear indicating valid activity types for that combination of values. </para> diff --git a/doc/details-investments.docbook b/doc/details-investments.docbook index c0a986924..1f79c3c89 100644 --- a/doc/details-investments.docbook +++ b/doc/details-investments.docbook @@ -329,7 +329,7 @@ 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> drop-down. + <guilabel>Select Account</guilabel> dropdown. <screenshot> <screeninfo>Investment View, Equities Tab</screeninfo> diff --git a/doc/details-schedules.docbook b/doc/details-schedules.docbook index b74b8925e..eb69e8bab 100644 --- a/doc/details-schedules.docbook +++ b/doc/details-schedules.docbook @@ -166,7 +166,7 @@ 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 View and other displays. Specify how often the schedule should occur, using the - Frequency field and drop down list. For example "every 6 weeks" or "every 3 + Frequency field and dropdown list. For example "every 6 weeks" or "every 3 months." If the amount varies transaction to transaction make sure to check the <guilabel>The amount is an estimate because it varies for each payment</guilabel> checkbox in the <guilabel>Options</guilabel> area below, and you will be prompted diff --git a/doc/details-search.docbook b/doc/details-search.docbook index 190b5f899..eb5bc2b3e 100644 --- a/doc/details-search.docbook +++ b/doc/details-search.docbook @@ -70,7 +70,7 @@ </screenshot> <para> - This tab allows you to specify text to search for. There are also a drop-down + This tab allows you to specify text to search for. There are also a dropdown field and two check boxes that control how the text is used in the search. </para> diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook index 9d483f817..19c63abfd 100644 --- a/doc/details-settings.docbook +++ b/doc/details-settings.docbook @@ -46,7 +46,8 @@ </screenshot> <!-- I would prefer to use a more consistent hierarchy and use of levels on this - page, but for now, I'm minimizing changes. --> + page. For example, when to use sectX and when variablelist. For now, I'm + minimizing changes. --> <variablelist> <varlistentry> <term><guilabel>Autosave options</guilabel></term> @@ -164,7 +165,7 @@ view displays larger icons while the Tree view has smaller icons. The <guilabel>Tabbed</guilabel> view locates the icons and labels across the top of the window. - <!-- FIXME: this should better state that this controls the layout of the + <!-- FIXME: needs better wording to show that this controls the layout of the Vew Selector area where you select which View to display. --> </para> </listitem> @@ -557,125 +558,165 @@ <title>Ledger</title> <para> - The following options outlined within this section allow for the modification of the - transaction register contained within the Ledger view tab. + 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> +<sect2 id="details.settings.register.display"><title>Display tab</title> <variablelist> <varlistentry> - <term><guilabel>Show a grid in the register</guilabel></term> + <term><guilabel>Show a grid in the ledger</guilabel></term> <listitem> - <para>Selecting this option displays grid lines in the transaction - register or Ledger View. It provides an additional viewing option that - may make it easier to visualize separate transactions and their component - parts.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><guilabel>Show all register entries in full detail</guilabel></term> - <listitem> - <para>Selecting this option makes the register show all the information - for all displayed transactions, with separate lines in the Detail Column - for Category and Tags and for the Memo. If it is not selected, Category, - Tags, and Memo will not be displayed.</para> - <para>This has the same effect as selecting the <link - linkend="reference.menus.settings.transactiondetail">Show Transaction - Detail</link> menu option.</para> - </listitem> - </varlistentry> - - <varlistentry id="details.settings.register.lens"> - <term><guilabel>Use the ledger lens</guilabel></term> - <listitem> - <para>Selecting this option displays all the detail lines for the selected - transaction, even if <guilabel>Show all register entries in full - detail</guilabel> is not selected.</para> + <para> + Selecting this option displays grid lines in the transaction register or + Ledger View. This is an additional viewing option that may make it easier to + visualize separate transactions and their component parts. + </para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Show transaction form</guilabel></term> <listitem> - <para>Selecting this option displays the <link - linkend="details.ledger.transactionform">transaction form</link> at the - bottom of the register, and that is where you edit a transaction. If the - transaction form is not displayed, you edit a transaction within the - ledger itself. With this option enabled fewer transactions are visible in - the ledger, compared to when it is disabled.</para> + <para> + Selecting this option displays the <link + linkend="details.ledger.transactionform">transaction form</link> at the + bottom of the register, and that is where you enter or edit a transaction. + If the transaction form is not displayed, you edit a transaction within the + ledger itself. With this option enabled, fewer transactions are visible in + the ledger, compared to when it is disabled. + </para> </listitem> </varlistentry> <varlistentry> - <term><guilabel>Always show a No. field</guilabel></term> + <term><guilabel>Display overdue schedules with planned date</guilabel></term> <listitem> - <para>Always display the number (<quote>No.</quote>) field when entering or - editing a transaction. With this enabled you'll be able to check numbers - entered in this field for checking accounts.</para> + <para> + Scheduled transactions with future dates are shown in the Ledger View for the + relevant account. When the date passes, and a scheduled transaction becomes + overdue, it is no longer shown in the ledger, unless this option is selected. + </para> </listitem> </varlistentry> <varlistentry> - <term><guilabel>Show group header between transactions</guilabel></term> + <term><guilabel>Ledger entry details</guilabel></term> <listitem> - <para>Selecting this option will display group headers in the register. - These refer to time periods or milestones such as Last month, Last week, - This month, Last reconciliation, Next week, and Next Month.</para> + <formalpara> + <title><guilabel>Show all ledger entries in full detail</guilabel></title> + <para> + Selecting this option makes the register show all the information for all + displayed transactions, with separate lines in the Detail Column for + Category, Tags, and the Memo. If it is not selected, Category, Tags, and + Memo will not be displayed. This has the same effect as selecting the + <link linkend="reference.menus.settings.transactiondetail">Show Transaction + Detail</link> menu option. + </para> + </formalpara> + + <formalpara id="details.settings.register.lens"> + <title><guilabel>Use the ledger lens</guilabel></title> + <para> + Selecting this option displays all the detail lines for the selected + transaction, even if <guilabel>Show all register entries in full + detail</guilabel> is not selected. + </para> + </formalpara> + + <formalpara><title>Show all split details in ledger</title> + <para> + Selecting this option shows more details about split transactions. + <!-- FIXMNE: might this be related to now showing all categories in a split + transaction instead of just "split transaction" (or whatever it used to + show?)--> + </para> + </formalpara> </listitem> </varlistentry> <varlistentry> - <term><guilabel>Show header for the previous and current fiscal year - </guilabel></term> + <term><guilabel>Information headers</guilabel></term> <listitem> - <para>Selecting this option will display group headers in the register for - the current and the previous fiscal year.</para> + <formalpara> + <title><guilabel>Show group headers between transactions</guilabel></title> + <para> + Selecting this option will display group headers in the register. These + refer to time periods or milestones such as Last month, Last week, This + month, Last reconciliation, Next week, and Next month. + </para> + </formalpara> + + <formalpara> + <title> + <guilabel>Show header for the previous and current fiscal year</guilabel> + </title> + <para> + Selecting this option will display group headers in the register for the + current and the previous fiscal year. + </para> + </formalpara> + + <formalpara> + <title><guilabel>Reconciliation group headers</guilabel></title> + <para> + This dropdown controls the display of group headers for reconcilitations. + If <guilabel>Don't show reconciliation entries</guilabel> is selected, then + no group headers will be shown for reconciliations. If <guilabel>Show last + reconciliation entry with date and balance in ledger</guilabel> is + selected, only the most recent reconciliation will be indicated by a group + header. If <guilabel>Show all reconciliation entries with date and balance + in ledger</guilabel> is selected, then a group header will be shown for all + previous reconciliations. + </para> + </formalpara> </listitem> </varlistentry> - <varlistentry> - <term><guilabel>Display overdue schedules with planned date</guilabel></term> - <listitem> - <para>Scheduled transactions with future dates are shown in the Ledger - View for the relevant account. When the date passes, and a scheduled - transaction becomes overdue, it is no longer shown in the ledger, unless - this option is selected.</para> - </listitem> - </varlistentry> + <!-- Is this still somewhere else??? + <varlistentry> + <term><guilabel>Always show a No. field</guilabel></term> + <listitem> + <para> + Always display the number (<quote>No.</quote>) field when entering or + editing a transaction. With this enabled you'll be able to check numbers + entered in this field for checking accounts. + </para> + </listitem> + </varlistentry> + --> </variablelist> </sect2> -<sect2 id="details.settings.register.sorting"> -<title>Sorting tab</title> +<sect2 id="details.settings.register.sorting"><title>Sorting tab</title> <para> - These three sections allow you to set the default sort order of transactions - in the Ledger View. In all cases, the list on the left shows all the fields - available for sorting. To sort on an item, select it (single mouse click) and - click the right arrow between the two lists. The list on the right shows all - the fields which have been selected as part of the sort order for that view. - You can adjust the relative order of the fields by selecting one and adjusting - its position in the list using the up and down arrows to the right of the - list. You can switch between ascending and descending sort for any item - by double-clicking on it. + These three sections allow you to set the default sort order of transactions in the + Ledger View. In all cases, the list on the right shows the fields which have been + selected as part of the sort order for that view, and the list on the left shows + all the fields available for sorting whic have not yet been chosen. To sort on an + item, select it (single mouse click) and click the right arrow between the two + lists. You can adjust the relative order of the fields by selecting one and + adjusting its position in the list using the up and down arrows to the right of the + list. You can switch between ascending and descending sort for any item by + double-clicking on it. </para> + <para> The fields available for sorting are the same for all three sections: Amount, - Category, Entry Order (date the transaction was created,) Number, Payee, Post - date, Reconcile state, Security, and Type. + Category, Entry Order (the date the transaction was created, not the internal + transaction id,) Number, Payee, Post date, Reconcile state, Reconciliation date, + Security, and Type. </para> -<sect3 id="details.settings.register.sorting.normal"> -<title>Normal view tab</title> +<sect3 id="details.settings.register.sorting.normal"><title>Normal view subtab</title> <para> This tab controls the default sort order of the regular Ledger View. </para> </sect3> <sect3 id="details.settings.register.sorting.reconciliation"> -<title>Reconciliation view tab</title> +<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 @@ -684,46 +725,52 @@ </sect3> <sect3 id="details.settings.register.sorting.search"> -<title>Search view tab</title> +<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>. + This tab controls the default sort order of the ledger while in the <link + linkend="details.search">Search view</link>. </para> </sect3> </sect2> -<sect2 id="details.settings.register.dataentry"> -<title>Data Entry tab</title> +<sect2 id="details.settings.register.dataentry"><title>Data Entry tab</title> + <para>These options affect the process of creating new transactions.</para> <variablelist> <varlistentry> <term><guilabel>Auto increment check number</guilabel></term> <listitem> - <para>Enabling this will automatically increment the check number whenever - entering a new check transaction. They have the same effect whether you - use the Ledger Lens or the Transaction Form.</para> + <para> + Enabling this will automatically increment the check number whenever entering + a new check transaction. It has the same effect whether you use the Ledger + Lens or the Transaction Form. + </para> </listitem> </varlistentry> <varlistentry> - <term><guilabel>Keep changes when selecting a different - transaction/split</guilabel></term> + <term> + <guilabel>Keep changes when selecting a different transaction/split</guilabel> + </term> <listitem> - <para>When enabled, selecting a different transaction or split will save - edits to the current transaction. When disabled, selecting a different - transaction split will prompt you whether or not to save any - changes.</para> + <para> + When enabled, selecting a different transaction or split will save any edits + made to the current transaction. When disabled, selecting a different + transaction split will prompt you whether or not to save any changes. + </para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Use Enter to move between fields</guilabel></term> <listitem> - <para>When enabled, pressing &Enter; will change the focus to the next field - of the transaction. When in the last field, the transaction will be - saved. When disabled, navigation between fields would occur by using the - 	 key or the mouse. Pressing the &Enter; key would save the transaction, - no matter which field is currently in focus. + <para> + When enabled, pressing &Enter; will change the focus to the next field of the + transaction. When in the last field, the transaction will be saved. When + disabled, navigation between fields would occur by using the 	 key or the + mouse. Pressing the &Enter; key would save the transaction, no matter which + field is currently in focus. </para> </listitem> </varlistentry> @@ -731,19 +778,33 @@ <varlistentry> <term><guilabel>Match names from start</guilabel></term> <listitem> - <para>This option controls <link - linkend="details.payees.details.matching">payee matching</link>. When enabled, - payee names will always be matched from the start. When disabled, any - substring will be matched. Also, when enabled additional options for matching - can be established in the Matching Tab of the Payees View.</para> + <para> + This option controls <link linkend="details.payees.details.matching">payee + matching</link>. When enabled, payee names will always be matched from the + start. When disabled, any substring will be matched. Also, when enabled + additional options for matching can be established in the Matching Tab of the + Payees View. + </para> </listitem> </varlistentry> - <!--FIXME missing Automatic reconciliation--> + <!-- FIXME: missing description of Automatic reconciliation --> <varlistentry> <term><guilabel>Automatic reconciliation</guilabel></term> <listitem> - <para>This option needs to be documented. + <para> + This option needs to be documented. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Initial cursor position within the date field</guilabel></term> + <listitem> + <para> + When you advance into a transaction's date field (either by creating or + editing a transaction, or using 	 or &Enter;, this dropdown determines + whether the cursor will start in the Day, Month, or Year portion of the date. </para> </listitem> </varlistentry> @@ -751,43 +812,57 @@ <varlistentry> <term><guilabel>Default reconciliation state</guilabel></term> <listitem> - <para>Select the default reconciliation state for new transactions: Not - reconciled, Cleared, and Reconciled.</para> + <para> + This dropdown allows you to select the default reconciliation state for new + transactions: Not reconciled, Cleared, or Reconciled. + </para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Autofill</guilabel></term> <listitem> - <para>This option allows you to select the desired behavior for autofill. - This controls which, if any, previous transactions for the same payee are - displayed, and which, if any, of those transactions are used to auto-fill - details of the new transaction.</para> + <para> + This option allows you to select the desired behavior for autofill. This + controls which, if any, previous transactions for the same payee are + displayed, and which, if any, of those transactions are used to auto-fill + details of the new transaction. + </para> + <itemizedlist> <listitem> <para>No Autofill</para> - <para>This will deactivate autofill, and you must manually enter all - details for the new transaction.</para> + <para> + This will deactivate autofill, and you must manually enter all details + for the new transaction. + </para> </listitem> + <listitem> <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 transactions differ - less than X percent from the amount you have entered, they will be - considered identical, and details from the 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, and you can select one of those transactions to use - for autofill by clicking on it.</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, + and you can select one of those transactions to use for autofill by + clicking on it. + <!-- FIXME: What happens if multiple transactions are within X%? --> + </para> </listitem> + <listitem> <para>With previously most often used transaction for the payee</para> - <para>With this option selected, when you enter new transaction, - &kmymoney; will fill in all the transaction details based on the - previously most often used transaction for the selected payee.</para> + <para> + With this option selected, when you enter new transaction, &kmymoney; + will fill in all the transaction details based on the previously most + often used transaction for the selected payee. + </para> </listitem> </itemizedlist> </listitem> @@ -796,175 +871,191 @@ <varlistentry> <term><guilabel>Use memos from previous transaction</guilabel></term> <listitem> - <para>When selected, the memo from the previously entered transaction will - be automatically entered as the memo for the new transaction. + <para> + When selected, the memo from the previously entered transaction will be + automatically entered as the memo for the new transaction. </para> </listitem> </varlistentry> </variablelist> </sect2> -<sect2 id="details.settings.register.import"> -<title>Import tab</title> +<sect2 id="details.settings.register.import"><title>Import tab</title> <variablelist> <varlistentry> <term><guilabel>Match transaction within days</guilabel></term> <listitem> - <para>Search for matching transactions within the range of the imported - transaction +/- the given number of days, which can be set from 0 to - 99.</para> + <para> + Search for matching transactions within the range of the imported transaction + +/- the given number of days, which can be set from 0 to 99. + </para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Ask for a new payee's default category</guilabel></term> <listitem> - <para>If this option is selected, whenever a new payee is detected during - an import, the user will be asked for the default category for the - payee.</para> + <para> + If this option is selected, whenever a new payee is detected during an + import, the user will be asked for the default category for the payee. + </para> </listitem> </varlistentry> </variablelist> </sect2> </sect1> -<sect1 id="details.settings.schedules"> -<title>Scheduled Transactions</title> +<sect1 id="details.settings.schedules"><title>Scheduled Transactions</title> <para> These options allow you to modify the behavior of <link - linkend="details.schedules">Scheduling Transactions</link>. + linkend="details.schedules">Scheduled Transactions</link>. </para> -<sect2> -<title>Startup options</title> +<sect2><title>Startup options</title> <variablelist> <varlistentry> <term><guilabel>Check schedules upon startup</guilabel></term> <listitem> - <para>Enables checking the schedule upon startup of &kmymoney;. If - a scheduled transaction matches the schedule criteria set then &kmymoney; - will produce a notification requiring handling of the transaction. </para> + <para> + Enables checking the schedule upon startup of &kmymoney;. If a scheduled + transaction matches the schedule criteria set then &kmymoney; will produce a + notification requiring handling of the transaction. + </para> </listitem> </varlistentry> <varlistentry> - <term><guilabel>Enter transactions this number of days in - advance</guilabel></term> - <listitem><para>Specify how many days in advance a scheduled transaction - should be entered.</para> + <term> + <guilabel>Enter transactions this number of days in advance</guilabel> + </term> + <listitem> + <para> + Specify how many days in advance a scheduled transaction should be entered. + </para> </listitem> </varlistentry> </variablelist> </sect2> -<sect2 id="details.settings.schedules.calendar"> -<title>Processing Days</title> +<sect2 id="details.settings.schedules.calendar"><title>Processing Days</title> <variablelist> <varlistentry> <term><guilabel>Use holiday calendar for region</guilabel></term> - <listitem><para>Select the region of the world that best suits your needs.</para> + <listitem> + <para>Select the region of the world that best suits your needs.</para> </listitem> </varlistentry> </variablelist> </sect2> <sect2><title></title> +<!-- FIXME: This is a good example of problems with the current mix of sect and + variablelist, as this sect with no title gives no spacing between the previous + and this list entry, so it looks like they belong together. I'm open to + suggestions on how to deal with this. Not using sect2 for boxes might help. --> <variablelist> <varlistentry> <term><guilabel>Number of days to preview schedules in ledger</guilabel></term> <listitem> - <para>Specify how many days should the scheduled transactions show up in the - ledger.</para> - <para>The scheduled transactions will be listed in the ledger. You can - enter or skip the scheduled transactions by right-clicking on - them.</para> + <para> + Specify how many days in advance should scheduled transactions show up in the + ledger. For future scheduled transactions displayed in the ledger, you can + enter or skip them by right-clicking on them. + </para> </listitem> </varlistentry> </variablelist> </sect2> </sect1> -<sect1 id="details.settings.onlinequote"> -<title>Online Quotes</title> +<sect1 id="details.settings.onlinequote"><title>Online Quotes</title> <para> - These settings modify how financial quotes are retrieved from different online + These settings determine how price quotes are retrieved from different online sources. These include both stock, bond, and other equity prices, as well as prices for precious metals and currency conversion. </para> <para> - This tab allows you to change the online quote sources for &kmymoney;. - Generally speaking, this is an advanced feature, and should only be attempted - by the most technically adept users. + This section allows you to change the online quote sources for &kmymoney;. + Generally speaking, this is an advanced feature, and should only be attempted by + the most technically adept users. </para> <para> For more details, please refer to the <link linkend="details.investments.onlinequotes">Online Price Quotes</link> section. </para> -</sect1> +<note> + <para> + The initial list and configuration of online quote sources is set up when + &kmymoney; first creates your data file. If an online source makes a change + which requires a change to these settings in order for &kmymoney; to continue to + use it as a valid source, the user must make the necessary changes, using this + dialog, based on instructions posted at one of the suggested<link + linkend="firsttime.contact">support options</link>. Hopefully, in the not to + distanct future, the way online source configuration is handled will be changed + so that &kmymoney; can automatically fetch any necessary updates to these + settings without requiring the user to make any manual edits. + </para> +</note> +</sect1> -<sect1 id="details.settings.colors"> -<title>Colors</title> +<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 used. + These section allows you to customize the colors used within &kmymoney;. If + <guilabel>Custom colors</guilabel> is not checked, then default colors will be + used. </para> <para> - To customize colors check the box Custom colors. -</para> - -<para> - Modify any of the colors by clicking on the color button, which will open - color select palette. This will provide unlimited options in color selection. - You can select a defined basic color, pick a color by clicking anywhere on the - screen, input an &HTML; defined color, specify values for Hue, Saturation, - Value, Red, Green, and Blue. - + To customize colors check the <guilabel>Custom colors</guilabel> checkbox. You can + then modify any of the colors by clicking on the color button, which will open + color select palette. This will provide unlimited options in color selection. You + can select a defined basic color, pick a color by clicking anywhere on the + displayed color palette, input an &HTML; defined color, specify values for Hue, + Saturation, Value, Red, Green, and Blue. </para> </sect1> -<sect1 id="details.settings.fonts"> -<title>Fonts</title> +<sect1 id="details.settings.fonts"><title>Fonts</title> <para> - These options allow you to modify the fonts within the Cell or Header fields. + This section allows you to modify the fonts used within the Cell or Header fields. </para> <variablelist> <varlistentry> <term><guilabel>Use system fonts</guilabel></term> <listitem> - <para>Select this to use system fonts. Deselecting this option allows the select - the fonts of your choice.</para> + <para> + Select this to use system fonts. Deselecting this option allows the select + the fonts of your choice. + </para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Cell font</guilabel></term> <listitem> - <para>Specify the custom font to use within each cell of the registers.</para> + <para>Specify the custom font to use within each cell of the ledgers.</para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Header font</guilabel></term> <listitem> - <para>Specify the custom font to use for the headers of each view within the register.</para> + <para>Specify the custom font to use for the headers of each view within the ledger.</para> </listitem> </varlistentry> </variablelist> </sect1> -<sect1 id="details.settings.icons"> -<title>Icons</title> +<sect1 id="details.settings.icons"><title>Icons</title> <para> This option allows for the selection of icons that will be displayed. @@ -974,9 +1065,11 @@ <varlistentry> <term><guilabel>Individual icon settings</guilabel></term> <listitem> - <para>Using the pull-down menu there is a selection of available icons available for use. - Additional icons may be available for downloading and use depending on the operating - system installed.</para> + <para> + The dropdown list presents a selection of icon themess available for use. + Additional icons may be available for downloading and use depending on the + operating system or &Linux; Distribution installed. + </para> </listitem> </varlistentry> </variablelist> @@ -987,10 +1080,11 @@ <para> This section provides information about the available plugins, and allow you to - modify the behavior of installed plugins. 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. + modify the behavior of some of the installed plugins. 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. + <screenshot> <screeninfo>Configure Plugins</screeninfo> <mediaobject> @@ -1002,51 +1096,58 @@ </textobject> </mediaobject> </screenshot> - Every plugin can be enabled or disabled, according to the state of the checkbox - next to the name of the plugin. In addition, at the right, there is also an - <guibutton>information</guibutton> (&infoicon;) button for each, which will show - the plugin version and author. For some plugins, further information on - configuring and using it may be found by clicking the configure, or tool icon just - to the left of the information button. There is only one plugin that requires - configuration, and that is the Check printing plugin. + + Every plugin can be enabled or disabled, according to the state of the checkbox to + the left of the name of the plugin. In addition, at the right, there is also an + <guibutton>information</guibutton> (&infoicon;) button for each plugin, which will + show the plugin version and author. For some plugins, further information on + configuring and using it may be found by clicking the + <guibutton>configure</guibutton> (&configicon;) button just to the left of the + information button. +</para> +<para> + Until recently, there was only one plugin that required configuration, the Check + printing plugin. Now, there are several plugins which require configuration. + These are described in the following sections. </para> <sect2 id="details.settings.plugins.printchecks"> <title>Check printing plugin</title> <para> - As one example, there is a plugin for printing checks, which - is included with the source of &kmymoney;, and should always be - enabled. It allows printing of a check based on the data from a selected - transaction, with the layout controlled by an &HTML; template. You need to use a - template which is matched to your pre-printed checks. A default, built-in - template is provided. You may also choose a custom template. To do so, click on - the <guibutton>configure</guibutton> (&configicon;) button to get the - <guilabel>Check printing</guilabel> configuration dialog displayed. At the top - you can check the box to use a custom template. To the right of that is a + There is a plugin for printing checks, which is included with the source of + &kmymoney;, and should always be enabled. It allows printing of a check based on + the data from a selected transaction, with the layout controlled by an &HTML; + template. You need to use a template which is matched to your pre-printed checks. + A default, built-in template is provided. You may also choose a custom template. + To do so, click on the <guibutton>configure</guibutton> (&configicon;) button to + get the <guilabel>Check printing</guilabel> configuration dialog displayed. At the + top you can check the box to use a custom template. To the right of that is a button which brings up a file chooser, to select an alternate template file. </para> <para> - A template file is an &HTML; file, in which specific strings are used to - reference the fields from the transaction and from the current account and - institution to show where they will be printed on the check. &kmymoney; - ships with a default, built-in template. At <ulink url="https://invent.kde.org/office/kmymoney/-/blob/master/kmymoney/plugins/checkprinting/templates/";>this</ulink> - address you can find the HTML source file of default template, as well as some - additional templates. You should either be able to use one of them, or modify - one to suit your needs. Note that only a <emphasis>subset</emphasis> of the - HTML standard is supported — the detailed documentation on that can be found - <ulink url="https://doc.qt.io/qt-5/richtext-html-subset.html";>here</ulink>. + A template file is an &HTML; file, in which specific strings are used to reference + the fields from the transaction and from the current account and institution to + show where they will be printed on the check. &kmymoney; ships with a default, + built-in template. At <ulink + url="https://invent.kde.org/office/kmymoney/-/blob/master/kmymoney/plugins/checkprinting/templates/";>this + address</ulink>, you can find the HTML source file of the default template, as well + as some additional templates. You should either be able to use one of them, or + modify one to suit your needs. Note that only a <emphasis>subset</emphasis> of the + HTML standard is supported — the detailed documentation on that can be found <ulink + url="https://doc.qt.io/qt-5/richtext-html-subset.html";>here</ulink>. </para> +<!-- info from source code on substitution variables. Future exercise to list/describe them here. -<!-- info from source code on substitution variables // data about the user checkHTML.replace("$OWNER_NAME", file->user().name()); checkHTML.replace("$OWNER_ADDRESS", file->user().address()); checkHTML.replace("$OWNER_CITY", file->user().city()); checkHTML.replace("$OWNER_STATE", file->user().state()); - // data about the account institution + + // data about the account's institution checkHTML.replace("$INSTITUTION_NAME", institution.name()); checkHTML.replace("$INSTITUTION_STREET", institution.street()); checkHTML.replace("$INSTITUTION_TELEPHONE", institution.telephone()); @@ -1054,6 +1155,7 @@ checkHTML.replace("$INSTITUTION_CITY", institution.city()); checkHTML.replace("$INSTITUTION_POSTCODE", institution.postcode()); checkHTML.replace("$INSTITUTION_MANAGER", institution.manager()); + // data about the transaction checkHTML.replace("$DATE", KGlobal::locale()->formatDate(QDate::currentDate(), KLocale::LongDate)); checkHTML.replace("$CHECK_NUMBER", (*it).split().number()); @@ -1067,8 +1169,12 @@ checkHTML.replace("$MEMO", (*it).split().memo()); --> - </sect2> + +<!-- FIXME: no kbaning or aqbanking plugin currently listed. Where is configuration, + or do I just not have it included in my personally compiled version? In + addition, where does the Online job outbox view come from? +--> <sect2 id="details.settings.plugins.kbanking"> <title>KBanking</title> @@ -1080,7 +1186,5 @@ </sect2> - - </sect1> </chapter> diff --git a/doc/makemostof.docbook b/doc/makemostof.docbook index c04f8bc8b..11e0694b4 100644 --- a/doc/makemostof.docbook +++ b/doc/makemostof.docbook @@ -396,7 +396,7 @@ probably find that the default Categories do not exactly match your needs; you can easily delete ones you know you are never going to need and add others that you need. But when you are entering a transaction, you only have to type a few letters - of a category and &kmymoney; will offer you a drop down list of the matching + of a category and &kmymoney; will offer you a dropdown list of the matching categories from which to choose. </para>
