diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook index 83c230f1c..b7c46e8c6 100644 --- a/doc/details-settings.docbook +++ b/doc/details-settings.docbook @@ -1,975 +1,977 @@ &Roger.Lum; &Roger.Lum.mail; MichaelCarpino mfcarpino@gmail.com &Jack.H.Ostroff; &Jack.H.Ostroff.mail; 2019-03-31 5.0.3 &kmymoney; Settings - The settings described below modify the behavior of &kmymoney;, allwing you + The settings described below modify the behavior of &kmymoney;, allowing 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 + modify its look and feel to match your personality. These settings can be changed through SettingsConfigure &kmymoney;... or by using the keyboard shortcut CtlShift ,. In order for any changes to take effect the apply tab must be entered. 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. - + General Global tab Startup options If you check the Show splash screen 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. Autosave options Checking the Autosave periodically 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. Checking the Autosave when file is modified upon close box - instructs &kmymoney; to autosave your file when the program is closed. You also have the + 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 + 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. Fiscal Year Enter the day and month of your fiscal year. This value is used for budgets and some reports. External programs 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 Calculator text box. There are then two ways to launch the program. First, you can use SettingsConfigure Toolbars... to place the Calculator icon on the Toolbar. Then, when you click that icon on the Toolbar, &kmymoney; will launch the selected application. Second, you can use SettingsConfigure Shortcuts... 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. Views tab Startup page options 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. - + Type of the KMyMoney View 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 + the 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. - + Show title bar on each page 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 Synchronize account selection of ledger and investment view 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. Filter tab Accounts / Categories Do not show unused categories 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. Do not show closed accounts 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. Show equity accounts 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 Equity group of acccounts, which includes the account(s) which contain the opening balances for other accounts. - + Show categories in the accounts list view By default, Categories are hidden in the Accounts View. Selecting this option will display the Categories in the Accounts View. - + Do not show zero balance equities Checking this option will remove any zero balance equity accounts from appearing in the Accounts View. Schedules Do not show finished schedules Checking this box will hide all finished schedules from appearing in the Scheduled transaction View. Transactions Do not show transaction prior to 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. 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. Do not show reconciled transactions Checking this box will filter transactions by reconciliation state. Transactions that are marked as Reconciled will not be shown in the Ledger View. Home Home page display sections These options allow you to customize the appearance of the Home View (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 Up or Down button. Assets and Liabilities 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. Payments 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. Preferred accounts This will display the accounts that are identified as Preferred accounts within the AccountEdit account... Configuration dialog. 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 + options, the display will include the account name and current balance, and other columns specific to that type of report, and in some cases, as configured elsewhere. Payment accounts 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. Favorite Reports 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. Forecast (schedule) This will display a 30, 60, and 90 day forecast for asset and liability accounts with non zero balances and with non reconciled transactions. Net worth forecast This will display chart of your forecast net worth for the next 90 days. Budget 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. Cash Flow This will display a Cash Flow Summary analysis for the current month. Homepage/Summary page scaling Zoom factor: This option allows for the selection of the font size as a percentage to fit the Home View based on the user preference. Remember zoom factor when leaving the program if manually changed with mouse-wheel Selecting this will save your font size preference if you have changed it on the Home page by using the mouse-wheel. Account information display These options allow you to customize what information is included in any list of accounts. Show account limit information Displays the account limit as set in the Account Edit dialog. It affects any list which includes Payment accounts. Show balance-status of mapped online accounts 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. + Show number of not marked transactions per account [!M] Inserts an additional column next to the account name, showing the number of not marked transactions in the account. Show number of cleared transactions per account [C] Inserts an additional column showing the number of cleared transactions for the account. Show number of not reconciled (not marked + cleared) transactions per account [!R] 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. Show date of last reconciliation Inserts an additional column showing the last reconciliation date for the account. Ledger The following options outlined within this section allow for the modification of the transaction register contained within the Ledger view tab. Display tab Show a grid in the register 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. - + Show all register entries in full detail 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. This has the same effect as selecting the Show Transaction Detail menu option. - + Use the ledger lens Selecting this option displays all the detail lines for the selected transaction, even if Show all register entries in full detail is not selected. Show transaction form Selecting this option displays the transaction form 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. Always show a No. field Always display the number (No.) field when entering or editing a transaction. With this enabled you'll be able to check numbers entered in this field for checking accounts. Show group header between transactions 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. Show header for the previous and current fiscal year Selectling this option will display group headers in the register for the current and the previous fiscal year. Display overdue shcedules with planned date 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. Sorting tab 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. 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. Normal view tab This tab controls the default sort order of the regular Ledger View. Reconciliation view tab 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 Reconciliation Search view tab This tab controls the default sort order of the ledger while in the Search view. Data Entry tab These options affect the process of creating new transactions. Insert transaction type into No. field for new transactions Enabling this will automatically place the type of the transaction, ⪚, Deposit, Withdrawal, &etc;, in the No. field. Auto increment check number 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. Keep changes when selecting a different transaction/split 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. Use Enter to move between fields 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. Match names from start This option controls payee matching. 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. Automatic reconciliation This option needs to be documented. Default reconciliation state Select the default reconciliation state for new transactions: Not reconciled, Cleared, and Reconciled. Autofill - This option allows you to select the deired behavior for autofill. + 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. No Autofill This will deactivate autofill, and you must manually enter all details for the new transaction. Same transaction if amount differs less than percentage set below 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 Same transaction if amount differs less than, 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. With previously most often used transaction for the payee 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. Use memos from previous transaction When selected, the memo from the previously entered transaction will be automatically entered as the memo for the new transaction. Import tab Match transaction within days Search for matching transactions within the range of the imported transaction +/- the given number of days, which can be set from 0 to 99. Ask for a new payee's default category 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. Scheduled Transactions These options allow you to modify the behavior of Scheduling Transactions. Startup options Check schedules upon startup - Enables checking the schedule upon startup of &kmymoney;. If + 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. Enter transactions this number of days in advance Specify how many days in advance a scheduled transaction should be entered. - + Processing Days Use holiday calendar for region Select the region of the world that best suits your needs. Number of days to preview schedules in ledger Specify how many days should the scheduled transactions show up in the ledger. The scheduled transactions will be listed in the ledger. You can enter or skip the scheduled transactions by right-clicking on them. Online Quotes 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. 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. For more details, please refer to the Online Price Quotes section. Colors These section allows you to customize the colors used within &kmymoney;. If Custom colors is not checked, then default colors will be used. To customize colors check the box Custom colors. 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. - + Fonts These options allow you to modify the fonts within the Cell or Header fields. Use system fonts Select this to use system fonts. Deselecting this option allows the select the fonts of your choice. Cell font Specify the custom font to use within each cell of the registers. Header font Specify the custom font to use for the headers of each view within the register. Icons This option allows for the selection of icons that will be displayed. Individual icon settings 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 + Additional icons may be available for downloading and use depending on the operating system installed. Plugins 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. Configure Plugins Configure Plugins 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 information (&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. Check printing plugin 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 + 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 configure (&configicon;) button , the Check printing 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 alternate template file. 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; is shipped with some sample template files. You should either be able to use one of them, or modify one to suit your needs. When the default template is selected, the configuration dialog will show you the directory which contains the sample files. - +