Git commit cc16ad78f8d2685b6d208d5f1ca9a10c944491d8 by Jack Ostroff, on behalf of Michael Carpino. Committed on 01/04/2019 at 19:32. Pushed by ostroffjh into branch '5.0'.
Update Settings docbook chapter for 5.x M +482 -347 doc/details-settings.docbook https://commits.kde.org/kmymoney/cc16ad78f8d2685b6d208d5f1ca9a10c944491d8 diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook index 353bab23d..83c230f1c 100644 --- a/doc/details-settings.docbook +++ b/doc/details-settings.docbook @@ -3,366 +3,542 @@ <chapterinfo> <authorgroup> <author> &Roger.Lum; &Roger.Lum.mail; </author> + <author> + <personname><firstname>Michael</firstname><surname>Carpino</surname></personname> + <email>mfcarp...@gmail.com</email> + </author> + <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author> </authorgroup> - <date>2014-08-30</date> - <releaseinfo>4.7.01</releaseinfo> + <date>2019-03-31</date> + <releaseinfo>5.0.3</releaseinfo> </chapterinfo> -<title id="details.settings.title">&kmymoney; Settings</title> +<title>&kmymoney; Settings</title> <para> - The settings described below modify the behavior of &kmymoney;. These - settings can be changed - through <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure - &kmymoney;...</guimenuitem></menuchoice>. + The settings described below modify the behavior of &kmymoney;, allwing you + to customize it to meet the needs of your unique financial affairs, and to + modify it's look and feel to match your personality. These settings can be + changed through <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure + &kmymoney;...</guimenuitem></menuchoice> or by using the keyboard shortcut + <keycombo action="simul"><keycap>Ctl</keycap><keycap>Shift</keycap> + <keycap>,</keycap></keycombo>. In order for any changes to take effect the + apply tab must be entered. </para> +<para> + On the left of the settings dialog is a list of icons and labels, each + representing a particular area of the program. When you click on one of + those icons, the right part of the dialog will display controls for + configuring that area of the program, often divided into several tabs. +</para> + <sect1 id="details.settings.general"> -<title id="details.settings.general.title">General</title> +<title>General</title> <sect2 id="details.settings.general.global"> -<title>Global options</title> +<title>Global tab</title> <variablelist> <varlistentry> - <term><guilabel>Price Precision</guilabel></term> + <term><guilabel>Startup options</guilabel></term> + <listitem> + <para>If you check the <guilabel>Show splash screen</guilabel> box, + &kmymoney; will display the splash screen when &kmymoney; starts. The splash + screen shows which version of the program you are running in the lower + left hand corner. Unchecking the box prevents the splash screen from + appearing at startup.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Autosave options</guilabel></term> +<!-- I would prefer to use a more consistent hierarchy and use of levels on this + page, but for now, I'm minimizing changes. --> <listitem> - <para>Enter how many digits of precision your prices will have after the - decimal point. For example, setting this to 2 will result in prices - like 35.18, where setting it to 4 might cause the same price to show - 35.1791</para> + <para>Checking the <guilabel>Autosave periodically</guilabel> box instructs + &kmymoney; to autosave your files at a defined interval. The default value is + 10 minutes. You can change this setting from 0 (backup immediately after + entering a transaction) up to 60 minutes.</para> + + <para>Checking the <guilabel>Autosave when file is modified upon close</guilabel> box + instructs &kmymoney; to autosave your file when the program is closed. You also have the + option upon closing the program to backup your &kmymoney; file. The Number of backup to + keep can be set at 0 (Off) upto to 20 backups. Any backup files will be stored in the same + folder as the main file. The will be labeled sequentially with 1 being the most current.</para> </listitem> </varlistentry> <varlistentry> - <term><guilabel>Autosave periodically</guilabel></term> + <term><guilabel>Fiscal Year</guilabel></term> <listitem> - <para>Check this box if you wish &kmymoney; to autosave your files - periodically. The default is 10 minutes.</para> + <para>Enter the day and month of your fiscal year. This value is used for + budgets and some reports.</para> </listitem> </varlistentry> <varlistentry> - <term><guilabel>Your fiscal year starts on</guilabel></term> + <term><guilabel>External programs</guilabel></term> <listitem> - <para>Enter the starting day and month of your fiscal year</para> + <para>This setting does not directly affect the operation of &kmymoney;, + but provides a convenient way to launch any external utility, such as an + advanced calculator. The first step is to enter the full path to your + chosen program in the <guilabel>Calculator</guilabel> text box. There are + then two ways to launch the program.</para> + <para>First, you can use + <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure + Toolbars...</guimenuitem></menuchoice> to place the + <guilabel>Calculator</guilabel> icon on the Toolbar. Then, when you click + that icon on the Toolbar, &kmymoney; will launch the selected + application.</para> + <!-- FIXME since the Settings menu is deferred to the Frameworks docs and + not explicitly described in this manual, it would at least be nice to + refer to the actual Calculator icon here, but I cannot find the + source png. It might also be nice to have a link to Settings Menu + doc page. --> + <para>Second, you can use + <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure + Shortcuts...</guimenuitem></menuchoice> to set a custom keyboard shortcut. + (The entry is under KMyMoney/Calculator in that list.) You can then use + that shortcut to launch the application.</para> + <!-- FIXME is not currently possible to launch the calculator from some menu + item. I have filed a wishlist, and when implemented, it should be + described here, probably as the first choice. --> + <para> + </para> </listitem> </varlistentry> - <!-- FIXME missing Calculator --> </variablelist> </sect2> <sect2 id="details.settings.general.views"> -<title>Views options</title> +<title>Views tab</title> <variablelist> <varlistentry> - <term><guilabel>Startup</guilabel></term> + <term><guilabel>Startup page options</guilabel></term> <listitem> - <para>Choose the initial view upon startup.</para> - <itemizedlist> - <listitem><para>Start with <link linkend="firsttime.mainwindow">home - page</link></para></listitem> - <listitem><para>Start with last selected page</para></listitem> - </itemizedlist> + <para>When &kmymoney; starts up, this option indicates whether to start + with the Home View or with the view displayed when the program was last + closed.</para> </listitem> </varlistentry> - <!-- FIXME missing Type of KMyMoney view --> + <varlistentry> - <term><guilabel>Show titlebar on each page</guilabel></term> + <term><guilabel>Type of the KMyMoney View</guilabel></term> <listitem> - <para>Whether the title of the current view should be displayed on each - page.</para> + <para> You can select one of three general layouts for &kmymoney; to use. If + you select the List or Tree view, the icons and their labels will be located at + left side of the window. The List view displays larger icons while the Tree + view has smaller icons. The Tabbed view locates the icons and labels across + the top of the window.</para> </listitem> </varlistentry> - + <varlistentry> - <term><guilabel>Synchronize account selection of ledger and investment - view</guilabel></term> + <term><guilabel>Show title bar on each page</guilabel></term> <listitem> - <para>If this option is selected, selecting an account on the investments - view will change the account selection on the ledger view, and - viceversa.</para> + <para>Checking this box will display the blue &kmymoney; title bar across the + top of each page. Unchecking it will remove the title bar and provide a larger + area for viewing the content of each page</para> </listitem> </varlistentry> -<!-- FIXME not in master + <varlistentry> - <term><guilabel>Icon size of navigation bar</guilabel></term> + <term><guilabel>Synchronize account selection of ledger and investment + view</guilabel></term> <listitem> - <para>Select the size of the icons of the left-side navigation bar.</para> + <para>If this option is selected, the accounts displayed in the Ledger View and + Investment View will be synchronized, meaning if you change the account + displayed in one of the views, and then switch to the other view, the + information for the same account will be displayed. This increases the + efficiency of navigating between these 2 tab views. If it is not selected, + selecting either of those views will show the same account previously selected + in that view, regardless of the account selected in the other view.</para> </listitem> </varlistentry> - --> </variablelist> </sect2> <sect2 id="details.settings.general.filter"> -<title>Filter options</title> +<title>Filter tab</title> +<sect3> +<title>Accounts / Categories</title> <variablelist> <varlistentry> <term><guilabel>Do not show unused categories</guilabel></term> <listitem> - <para>Hide unused categories.</para> + <para>Checking this box hides unused categories in the Categories View. A + hidden category is still available should a transaction require it. By typing + a hidden category in the ledger it will become available for use.</para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Do not show closed accounts</guilabel></term> <listitem> - <para>Hide closed accounts.</para> + <para>Checking this box hides closed accounts from display in the Accounts, + Ledger, and Investment Views. Hiding closed accounts makes viewing and working + with open accounts easier. Unchecking this box will show closed accounts with + a line drawn through them allowing viewing and reopening if needed.</para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Show equity accounts</guilabel></term> <listitem> - <para>Equity accounts are normally hidden. Select this option to show - them.</para> + <para>By default, equity accounts are hidden in the Accounts View. Selecting + this option will display the equity accounts in the Accounts View. Equity + accounts are used to track individual equities or investments held in an + Investment Account. This should not be confused with the top level + <emphasis>Equity</emphasis> group of acccounts, which includes the account(s) + which contain the opening balances for other accounts.</para> </listitem> </varlistentry> - <!--FIXME missing Show in categories account list view--> + <varlistentry> + <term><guilabel>Show categories in the accounts list view</guilabel></term> + <listitem> + <para>By default, Categories are hidden in the Accounts View. Selecting this + option will display the Categories in the Accounts View.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Do not show zero balance equities</guilabel></term> + <listitem> + <para>Checking this option will remove any zero balance equity accounts from + appearing in the Accounts View.</para> + </listitem> + </varlistentry> +</variablelist> +</sect3> + +<sect3> +<title>Schedules</title> +<variablelist> + <varlistentry> <term><guilabel>Do not show finished schedules</guilabel></term> <listitem> - <para>Hide finished schedules.</para> + <para>Checking this box will hide all finished schedules from appearing in the + Scheduled transaction View.</para> </listitem> </varlistentry> +</variablelist> +</sect3> +<sect3> +<title>Transactions</title> +<variablelist> <varlistentry> <term><guilabel>Do not show transaction prior to</guilabel></term> <listitem> - <para>Hide transactions prior to the selected date.</para> - <para>Setting this option to January 1, 1900 is a good way to debug - date-related file import problems.</para> + <para>Transactions prior to the date entered here will not be displayed in the + Ledger View. This can be useful if your data includes many years of + transactions; setting this to one or two years ago hides older + transactions.</para> + <para>Setting this option to January 1, 1900 (the default value) is a good way + to debug date-related data import problems, in case some dates were erroneously + very far in the past.</para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Do not show reconciled transactions</guilabel></term> <listitem> - <para>Filter transactions by reconciliation state. Transactions that are - marked as <emphasis>Reconciled</emphasis> will not be shown.</para> + <para>Checking this box will filter transactions by reconciliation state. + Transactions that are marked as <emphasis>Reconciled</emphasis> will not be + shown in the Ledger View.</para> </listitem> </varlistentry> </variablelist> +</sect3> </sect2> </sect1> <sect1 id="details.settings.home"> -<title id="details.settings.home.title">Home</title> +<title>Home</title> +<sect2> +<title>Home page display sections</title> <para> - These options allow you to customize the appearance of the Home page by - choosing which entries to show on the Home page and the order in which they - appear. + These options allow you to customize the appearance of the <link + linkend="firsttime.mainwindow">Home View</link> (also called the Home Page or Main + Window) by choosing which information to display there and the order in which it + appears. Selected sections can be reordered by clicking the respective + <guibutton>Up</guibutton> or <guibutton>Down</guibutton> button. </para> +<!-- FIXME Many of these sections need a <link> to the doc section actually + describing the content. --> <variablelist> <varlistentry> <term><guilabel>Assets and Liabilities</guilabel></term> <listitem> - <para>It shows the balance of all your assets and liabilities</para> + <para>This will display the asset and liability accounts that are open along + with their current balances. This and other account lists on the Home Page are + sorted in alphabetical order, unless otherwise noted.</para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Payments</guilabel></term> <listitem> - <para>It shows the first 5 occurrences of your scheduled - transactions</para> + <para>This will display upcoming occurrences of Scheduled transactions, + distinguishing Overdue payments from Future payments. It shows the date, + schedule name, account and amount of the payment, and the account balance after + the payment. By default it will show up to six transaction. If six are + displayed, there is a link you can select to show more, up to 30 days in + advance.</para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Preferred accounts</guilabel></term> <listitem> - <para>It shows the balance and credit of your favorite accounts</para> + <para>This will display the accounts that are identified as Preferred accounts + within the <menuchoice><guimenu>Account</guimenu><guimenuitem>Edit account... + </guimenuitem></menuchoice>Configuration dialog.</para> + <para>For this and all other account list sections addressed by this set of + options, the display will includ the account name and current balance, and + other columns specific to that type of report, and in some cases, as configured + elsewhere.</para> + <!-- FIXME - the menu item (or maybe link to actual doc page) should point + to the actual other config location and perhaps which items for + which account type. --> </listitem> </varlistentry> <varlistentry> <term><guilabel>Payment accounts</guilabel></term> <listitem> - <para>It shows the balance of your asset and liability accounts, except - for the investment accounts</para> + <para>This will display all Payment accounts; these include any account into + which income can be deposited, and/or out of which bills can be paid.</para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Favorite Reports</guilabel></term> <listitem> - <para>It shows a list of your favorite reports</para> + <para>This will display a list of all reports that have been identified as a + favorite in the Configuration dialog of the Report. The list ordered + chronologically by when each report became a favorite.</para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Forecast (schedule)</guilabel></term> <listitem> - <para>It shows a forecast for your asset and liability Accounts</para> + <para>This will display a 30, 60, and 90 day forecast for asset and liability accounts with non zero + balances and with non reconciled transactions.</para> + <!-- FIXME What are the real criteria for inclusion in this (and these other) list(s). --> </listitem> </varlistentry> <varlistentry> <term><guilabel>Net worth forecast</guilabel></term> <listitem> - <para>It shows a chart of your forecast net worth for the next 90 - days</para> - </listitem> - </varlistentry> -<!--FIXME - <varlistentry> - <term><guilabel>Forecast (history)</guilabel></term> - <listitem> - <para>???</para> + <para>This will display chart of your forecast net worth for the next 90 + days.</para> </listitem> </varlistentry> ---> + + <!-- FIXME "Forecast (history) removed as apparently not actually used. --> + <varlistentry> <term><guilabel>Budget</guilabel></term> <listitem> - <para>It shows the budget items for the current month which have a - negative difference compared to the actual income or expense</para> + <para>This will display a current month summary and overruns for any defined + budget(s), If no budget is defined, it will display no budget or overruns, with + the actual current month spending.</para> </listitem> </varlistentry> <varlistentry> - <term><guilabel>CashFlow</guilabel></term> + <term><guilabel>Cash Flow</guilabel></term> <listitem> - <para>It shows an analysis of your cash flow for the current month</para> + <para>This will display a Cash Flow Summary analysis for the current month.</para> </listitem> </varlistentry> +</variablelist> +</sect2> + +<sect2> +<title>Homepage/Summary page scaling</title> +<variablelist> <varlistentry> - <term><guilabel>Percentage of default font size</guilabel></term> + <term><guilabel>Zoom factor:</guilabel></term> <listitem> - <para>Select the size of the font on the Home page</para> + <para>This option allows for the selection of the font size as a percentage to + fit the Home View based on the user preference.</para> </listitem> </varlistentry> <varlistentry> - <term><guilabel>Remember font size when leaving the program if manually - changed with mouse-wheel</guilabel></term> + <term><guilabel>Remember zoom factor when leaving the program if manually changed + with mouse-wheel</guilabel></term> <listitem> - <para>Selecting this will save your font size preference if you have - changed it from the Home page by using the mouse-wheel</para> + <para>Selecting this will save your font size preference if you have changed it + on the Home page by using the mouse-wheel.</para> </listitem> </varlistentry> +</variablelist> +</sect2> +<sect2> +<title>Account information display</title> +<para>These options allow you to customize what information is included in any list +of accounts.</para> +<variablelist> <varlistentry> <term><guilabel>Show account limit information</guilabel></term> <listitem> - <para>Shows the limit of the accounts on the Payment Accounts and - Preferred Accounts sections of the Home page</para> + <para>Displays the account limit as set in the Account Edit dialog. It affects + any list which includes Payment accounts.</para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Show balance-status of mapped online accounts</guilabel></term> <listitem> - <para>Shows the balance-status of mapped accounts on the Assets and Liabilities - Summary, the Payment Accounts and the Preferred Accounts sections of the Home - page. The balance-status is symbolized by an icon in the columns preceding - the account names. A green checkmark is displayed when online-balance and local - file balance are in sync. If the local file has transactions newer than the - previously online-updated ones a mailbox with a green arrow gets shown. This alerts - the user to start an online-update. Mismatching local file and online-balances are - highlighted by a red warning sign. - </para> + <para>Shows the balance-status of mapped accounts, symbolized by an icon in the + columns preceding the account name. A green checkmark indicates the online + balance and local balance are the same. A mailbox with a green arrow indicates + that the local file has transactions newer than the most recent online update. + This alerts the user to start an online-update. A red warning sign indicates a + mismatch between the local file and online-balance.</para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Show number of not marked transactions per account [!M]</guilabel></term> <listitem> - <para>Insert an additional column between account name and current balance showing - the number of not marked transactions for the accounts on the Assets and Liabilities - Summary, the Payment Accounts and Preferred Accounts sections of the Home page - </para> + <para>Inserts an additional column next to the account name, showing the number + of not marked transactions in the account.</para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Show number of cleared transactions per account [C]</guilabel></term> <listitem> - <para>Insert an additional column between account name and current balance showing - the number of cleared transactions for the accounts on the Assets and Liabilities - Summary, the Payment Accounts and Preferred Accounts sections of the Home page - </para> + <para>Inserts an additional column showing the number of cleared transactions + for the account.</para> </listitem> </varlistentry> <varlistentry> - <term><guilabel>Show number of not reconciled (not marked + cleared) transactions per account [!R]</guilabel></term> + <term><guilabel>Show number of not reconciled (not marked + cleared) transactions + per account [!R]</guilabel></term> <listitem> - <para>Insert an additional column between account name and current balance showing - the number of not reconciled transactions (i.e. the sum of all not marked and - cleared transactions) for the accounts on the Assets and Liabilities Summary, the - Payment Accounts and Preferred Accounts sections of the Home page</para> + <para>Inserts an additional column showing the number of not reconciled + transactions for the account, i.e., the sum of all not marked and cleared + transactions.</para> </listitem> </varlistentry> + <varlistentry> + <term><guilabel>Show date of last reconciliation</guilabel></term> + <listitem> + <para>Inserts an additional column showing the last reconciliation date for the + account.</para> + </listitem> + </varlistentry> </variablelist> +</sect2> </sect1> <sect1 id="details.settings.register"> -<title id="details.settings.register.title">Ledger</title> +<title>Ledger</title> <para> - These options allow you to modify the behavior of the transaction registers. + The following options outlined within this section allow for the modification of the + transaction register contained within the Ledger view tab. </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> <listitem> - <para>Show grid lines in the transaction register.</para> + <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> - <!--FIXME missing Show all register entries in full detail--> + <varlistentry id="details.settings.register.lens"> <term><guilabel>Use the ledger lens</guilabel></term> <listitem> - <para>With this option enabled, the ledger will show all lines of detail - for the transaction you have currently selected, even if you have set - the <link linkend="reference.menus.settings.transactiondetail">Show - Transaction Detail</link> menu option turned off.</para> + <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> </listitem> </varlistentry> <varlistentry> <term><guilabel>Show transaction form</guilabel></term> <listitem> - <para>Show the <link linkend="details.ledger.transactionform">transaction - form</link> at the bottom of the transaction register for entering and - editing transactions. With this option turned off, you edit the - transaction within the register itself.</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 edit a transation. If the + transaction form is not displayed, you edit a transaction within the + ledger itself. With this option enabled fewer transaction are visible in + the ledger, compared to when it is disabled.</para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Always show a No. field</guilabel></term> <listitem> - <para>Always have the number (<quote>No.</quote>) field when entering or - editing a transaction.</para> + <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> <varlistentry> <term><guilabel>Show group header between transactions</guilabel></term> <listitem> - <para>Display group headers in the register</para> + <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> + </listitem> + </varlistentry> + + <varlistentry> + <term><guilabel>Show header for the previous and current fiscal year + </guilabel></term> + <listitem> + <para>Selectling this option will display group headers in the register for + the current and the previous fiscal year.</para> </listitem> </varlistentry> <varlistentry> - <term><guilabel>Show header for the previous and current fiscal - year </guilabel></term> + <term><guilabel>Display overdue shcedules with planned date</guilabel></term> <listitem> - <para>Display group headers for the current and the previous fiscal - year</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> </variablelist> @@ -370,114 +546,167 @@ <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 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 secions: Amount, + Category, Entry Order (date the transaction was created,) Number, Payee, Post + date, Reconcile state, Security, and Type. +</para> + <sect3 id="details.settings.register.sorting.normal"> <title>Normal view tab</title> - <para> - Choose the sort order of the ledger while in the Normal view. + 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> - <para> - Choose the sort order of the ledger while in the Reconciliation view. + This tab controls the default sort order of the ledger while in the + Reconciliation view. This is the display of transactions shown during the + process of <link linkend="details.reconcile">Reconciliation</link> </para> </sect3> <sect3 id="details.settings.register.sorting.search"> <title>Search view tab</title> <para> - Choose the sort order of the ledger while in the Search view. + 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> +<para>These options affect the process of creating new transactions.</para> <variablelist> <varlistentry> <term><guilabel>Insert transaction type into No. field for new - transactions</guilabel></term> + transactions</guilabel></term> <listitem> - <para>Automatically place the type of the transaction, ⪚., Deposit, - Withdrawal, etc., in the No. field.</para> + <para>Enabling this will automatically place the type of the transaction, + ⪚, Deposit, Withdrawal, &etc;, in the No. field.</para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Auto increment check number</guilabel></term> <listitem> - <para>Have the check number automatically increment whenever entering a - new check transaction.</para> + <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> </listitem> </varlistentry> <varlistentry> <term><guilabel>Keep changes when selecting a different - transaction/split</guilabel></term> + transaction/split</guilabel></term> <listitem> <para>When enabled, selecting a different transaction or split will save - edits to the current transaction.</para> - <para>When disabled, selecting a different transaction will cancel them. - Instead, you must explicitly accept the changes.</para> + edits 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 form.</para> + <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 + Tab key or the Mouse. Pressing the Enter key would save the transaction, + no matter which field is currently in focus. + </para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Match names from start</guilabel></term> <listitem> - <para>Mark this option if you always want to match names ⪚, for payees - from the start. If unset, any substring is matched</para> + <para>This option controls <link + linkend="details.payees.personalinformation.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--> + <varlistentry> + <term><guilabel>Automatic reconciliation</guilabel></term> + <listitem> + <para>This option needs to be documented. + </para> + </listitem> + </varlistentry> + <varlistentry> <term><guilabel>Default reconciliation state</guilabel></term> <listitem> - <para>Select the default reconciliation state for new - transactions.</para> + <para>Select the default reconciliation state for new transactions: Not + reconciled, Cleared, and Reconciled.</para> </listitem> </varlistentry> <varlistentry> <term><guilabel>Autofill</guilabel></term> <listitem> - <para>Select the desired behavior for autofill or deactivate it</para> + <para>This option allows you to select the deired 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> </listitem> <listitem> - <para>Same transaction if amount differs less than X percent</para> - <para>When entering a new transaction with this option, &kmymoney; - will display a list of previous transaction for the payee and - account. If previous transactions differ in less than X percent, - they will be considered identical. If the percentage is 0, all - previous transactions for the payee and account will be - displayed. When selecting a transaction, all transactions details - except the date will be autofilled with those of the selected - transaction.</para> + <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> </listitem> <listitem> <para>With previously most often used transaction for the payee</para> - <para>When entering a new transaction with this option enabled, - &kmymoney; will fill in all the transaction details based on the - previously most often used transaction with 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> </varlistentry> + + <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> + </listitem> + </varlistentry> </variablelist> </sect2> @@ -489,15 +718,17 @@ <term><guilabel>Match transaction within days</guilabel></term> <listitem> <para>Search for matching transactions within the range of the imported - transaction +/- given days</para> + 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>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> @@ -505,36 +736,52 @@ </sect1> <sect1 id="details.settings.schedules"> -<title id="details.settings.schedules.title">Scheduled Transactions</title> +<title>Scheduled Transactions</title> <para> - These options allow you to modify the behavior of - the <link linkend="details.schedules">scheduling features</link>. + These options allow you to modify the behavior of <link + linkend="details.schedules">Scheduling Transactions</link>. </para> -<sect2 id="details.settings.schedules.startupoptions"> -<title>Schedule 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;.</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 should the scheduled - transactions be entered.</para> + advance</guilabel></term> + <listitem><para>Specify how many days in advance a scheduled transaction + should be entered.</para> + </listitem> + </varlistentry> +</variablelist> +</sect2> + +<sect2> +<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> </varlistentry> - <!--FIXME missing Processing Days--> +</variablelist> +</sect2> + +<sect2><title></title> +<variablelist> <varlistentry> <term><guilabel>Number of days to preview schedules in ledger</guilabel></term> <listitem> - <para>Specify how many days should the schedules show up in the + <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 @@ -546,11 +793,12 @@ </sect1> <sect1 id="details.settings.onlinequote"> -<title id="details.settings.onlinequote.title">Online Quotes</title> +<title>Online Quotes</title> <para> - These settings modify how online quotes are retrieved from different online - sources. + These settings modify how financial 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> @@ -560,193 +808,81 @@ </para> <para> - For more details, please refer to the <link linkend="details.investments.onlinequotes">Online Price - Quotes</link> section. + For more details, please refer to the <link + linkend="details.investments.onlinequotes">Online Price Quotes</link> section. </para> </sect1> - <!-- FIXME Reports page missing--> -<sect1 id="details.settings.forecast"> -<title id="details.settings.forecast.title">Forecast</title> +<sect1 id="details.settings.colors"> +<title>Colors</title> <para> - These options allow you to modify how the forecast is calculated. + 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> -<variablelist> - <varlistentry> - <term><guilabel>Number of days to forecast</guilabel></term> - <listitem> - <para>Select how many days you want to forecast. The default is 90 - days</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><guilabel>Number of days of account cycle</guilabel></term> - <listitem> - <para>The normal number of days that your commonly-used accounts go - through an income-expense cycle. For example, if you receive your salary - on a monthly basis, you should select 30 days here.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><guilabel>Day of month to start forecast</guilabel></term> - <listitem> - <para>Select the day of the month when you want to start the - forecast. This would usually be the day when you receive your salary or - other income.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><guilabel>Forecast Method</guilabel></term> - <listitem> - <para>The forecast method to be used.</para> - <para>Scheduled and future transaction forecasts your balance based on the - information of your scheduled and future transactions.</para> - <para>History-based uses your past transactions to extrapolate a - forecast.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><guilabel>Number of cycles to use in forecast</guilabel></term> - <listitem> - <para>If using a history-based method, how many previous account cycles - should &kmymoney; use to calculate the forecast.</para> - </listitem> - </varlistentry> +<para> + To customize colors check the box Custom colors. +</para> - <varlistentry> - <term><guilabel>History forecast method</guilabel></term> - <listitem> - <para>Select the method to use when calculating a forecast based on - historic information</para> - <para>Simple moving average averages your past transactions to calculate a - forecast.</para> - <para>Weighted moving average averages your past transactions, but it will - give more importance to the most recent transactions.</para> - <para>Linear regression uses a linear-regression formula based on your - past transactions to calculate the forecast</para> - </listitem> - </varlistentry> -</variablelist> +<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. + +</para> </sect1> -<sect1 id="details.settings.encryption"> -<title id="details.settings.encryption.title">Encryption</title> +<sect1 id="details.settings.fonts"> +<title>Fonts</title> <para> - These options allow you to modify the data encryption settings. + These options allow you to modify the fonts within the Cell or Header fields. </para> <variablelist> <varlistentry> - <term><guilabel>Use GPG encryption</guilabel></term> - <listitem> - <para>Enables the use of GPG to encrypt data file. See the section - on <link linkend="details.formats.encrypted">GPG Encryption</link> for - more details.</para> - </listitem> - </varlistentry> -</variablelist> - -<sect2 id="details.settings.encryption.gpgencryption"> -<title>GPG Encryption</title> - -<variablelist> - <varlistentry> - <term><guilabel>Your key</guilabel></term> + <term><guilabel>Use system fonts</guilabel></term> <listitem> - <para>Enter the email address or the hexadecimal key id to use for data - encryption.</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>Additional keys</guilabel></term> + <term><guilabel>Cell font</guilabel></term> <listitem> - <para>Select additional keys to use for data encryption.</para> + <para>Specify the custom font to use within each cell of the registers.</para> </listitem> </varlistentry> <varlistentry> - <term><guilabel>Also encrypt with kmymoney-recover key</guilabel></term> + <term><guilabel>Header font</guilabel></term> <listitem> - <para>Encrypts data with the &kmymoney; recover key. Selecting this - option will allow core &kmymoney; developers to decrypt your data file - in case you lose your encryption key.</para> + <para>Specify the custom font to use for the headers of each view within the register.</para> </listitem> </varlistentry> </variablelist> -</sect2> -</sect1> - -<sect1 id="details.settings.colors"> -<title id="details.settings.colors.title">Colors</title> - -<para> - These options allow you to change colors within &kmymoney;. -</para> - -<sect2 id="details.settings.colors.foreground"> -<title>Foreground tab</title> - -<para> - Modify any of the foreground colors by clicking on the color button and - opening a color select palette. -</para> -</sect2> - -<sect2 id="details.settings.colors.background"> -<title>Background tab</title> - -<para> - Modify any of the background colors by clicking on the color button and - opening a color select palette. -</para> - -<para> - Note the <guilabel>Use system colors</guilabel> checkbox at the top of the - tab. If this is checked, &kmymoney; uses colors provided by the system, such - as those associated with a selected theme, although the details depend on - which operating system and possibly which window system or display manager is - running. Very often, if you experience odd colors or odd combination of - colors, toggling this checkbox will help. -</para> -</sect2> </sect1> -<sect1 id="details.settings.fonts"> -<title>Fonts</title> +<sect1 id="details.settings.icons"> +<title>Icons</title> <para> - These options allow you to modify the fonts. + This option allows for the selection of icons that will be displayed. </para> <variablelist> <varlistentry> - <term><guilabel>Use system fonts</guilabel></term> - <listitem> - <para>Select this to use system fonts. Deselecting this option allows you - to customize fonts.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><guilabel>Cell font</guilabel></term> - <listitem> - <para>Specify the custom font to use within each cell.</para> - </listitem> - </varlistentry> - - <varlistentry> - <term><guilabel>Header font</guilabel></term> + <term><guilabel>Individual icon settings</guilabel></term> <listitem> - <para>Specify the custom font to use for the headers of each view.</para> + <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> </listitem> </varlistentry> </variablelist> @@ -756,10 +892,11 @@ <title>Plugins</title> <para> - These options allow you to modify the behavior of any 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. + 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. <screenshot> <screeninfo>Configure Plugins</screeninfo> <mediaobject> @@ -771,30 +908,28 @@ </textobject> </mediaobject> </screenshot> - For most plugins, the only choice is to enable or disable it, as indicated by - the checkbox next to the name of the plugin. In addition, there is also an - <guibutton>information</guibutton> (&infoicon;) button for each, which will - show the plugin version and author. Further information on configuring and - using these plugins may be found in the separate sections for <link - linkend="details.impexp.csv">CSV Import</link> and <link - linkend="details.impexp.ofx">OFX Import</link> plugins. It is also true for - the <link linkend="details.reconcile">Reconciliation report</link>, although - that report is only a minor part of the larger reconciliation process. The - one plugin that does require a configuration step is the Print Check plugin. + 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. </para> <sect2 id="details.settings.plugins.printchecks"> -<title>Print check plugin</title> +<title>Check printing plugin</title> <para> This plugin 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. When you click on the - <guibutton>configure</guibutton> (&configicon;) button , the <guilabel>Print - check</guilabel> configuration dialog is displayed. At the top is a text box + <guibutton>configure</guibutton> (&configicon;) button , the <guilabel>Check + printing</guilabel> configuration dialog is displayed. At the top is a text box for the path to the selected template. To the right of that is a button which - brings up a file chooser, to select an alternative template file. + brings up a file chooser, to select an alternate template file. </para> <para>