Warning, /office/kmymoney/doc/details-settings.docbook is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" encoding="UTF-8"?>
0002 <chapter id="details.settings">
0003 <chapterinfo>
0004   <authorgroup>
0005     <author> &Roger.Lum; &Roger.Lum.mail; </author>
0006     <author>
0007       <personname><firstname>Michael</firstname><surname>Carpino</surname></personname>
0008       <email>mfcarpino@gmail.com</email>
0009     </author>
0010     <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
0011   </authorgroup>
0012   <date>2019-03-31</date>
0013   <releaseinfo>5.0.3</releaseinfo>
0014 </chapterinfo>
0015 
0016 <title>&kmymoney; Settings</title>
0017 
0018 <para>
0019    The settings described below modify the behavior of &kmymoney;, allowing you
0020    to customize it to meet the needs of your unique financial affairs, and to
0021    modify its look and feel to match your personality.  These settings can be
0022    changed through <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
0023    &kmymoney;...</guimenuitem></menuchoice> menu item or by using the keyboard
0024    shortcut <keycombo action="simul">&Ctrl; &Shift;<keycap>,</keycap></keycombo>.
0025    In order for any changes to take effect the <guibutton>Apply</guibutton>
0026    button must be clicked.
0027 </para>
0028 
0029 <para>
0030     On the left of the settings dialog is a list of icons and labels, each
0031     representing a particular area of the program.  When you click on one of
0032     those icons, the right part of the dialog will display controls for
0033     configuring that area of the program, often divided into several tabs.
0034 </para>
0035 
0036 <sect1 id="details.settings.general">
0037 <title>General</title>
0038 
0039 <sect2 id="details.settings.general.global">
0040 <title>Global tab</title>
0041 
0042 <variablelist>
0043   <varlistentry>
0044     <term><guilabel>Startup options</guilabel></term>
0045     <listitem>
0046       <para>If you check the <guilabel>Show splash screen</guilabel> box,
0047       &kmymoney; will display the splash screen when &kmymoney; starts.  The splash
0048       screen shows which version of the program you are running in the lower
0049       left hand corner.  Unchecking the box prevents the splash screen from
0050       appearing at startup.</para>
0051     </listitem>
0052   </varlistentry>
0053 
0054   <varlistentry>
0055     <term><guilabel>Autosave options</guilabel></term>
0056 <!-- I would prefer to use a more consistent hierarchy and use of levels on this
0057      page, but for now, I'm minimizing changes. -->
0058     <listitem>
0059       <para>Checking the <guilabel>Autosave periodically</guilabel> box instructs
0060       &kmymoney; to autosave your files at a defined interval.  The default value is
0061       10 minutes.  You can change this setting from 0 (backup immediately after
0062       entering a transaction) up to 60 minutes.</para>
0063 
0064       <para>Checking the <guilabel>Autosave when file is modified upon close</guilabel> box
0065       instructs &kmymoney; to autosave your file when the program is closed. You also have the
0066       option upon closing the program to backup your &kmymoney; file.  The Number of backup to
0067       keep can be set at 0 (Off) upto to 20 backups.  Any backup files will be stored in the same
0068       folder as the main file.  They will be labeled sequentially with 1 being the most current.</para>
0069     </listitem>
0070   </varlistentry>
0071 
0072   <varlistentry>
0073     <term><guilabel>Fiscal Year</guilabel></term>
0074     <listitem>
0075       <para>Enter the day and month of your fiscal year.  This value is used for
0076       budgets and some reports.</para>
0077     </listitem>
0078   </varlistentry>
0079 
0080   <varlistentry>
0081     <term><guilabel>External programs</guilabel></term>
0082     <listitem>
0083       <para>This setting does not directly affect the operation of &kmymoney;,
0084       but provides a convenient way to launch any external utility, such as an
0085       advanced calculator.  The first step is to enter the full path to your
0086       chosen program in the <guilabel>Calculator</guilabel> text box.  There are
0087       then two ways to launch the program.</para>
0088       <para>First, you can use
0089       <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
0090       Toolbars...</guimenuitem></menuchoice> menu item to place the
0091       <guilabel>Calculator</guilabel> icon on the Toolbar.  Then, when you click
0092       that icon on the Toolbar, &kmymoney; will launch the selected
0093       application.</para>
0094       <!-- FIXME since the Settings menu is deferred to the Frameworks docs and
0095            not explicitly described in this manual, it would at least be nice to
0096            refer to the actual Calculator icon here, but I cannot find the
0097            source png.  It might also be nice to have a link to Settings Menu
0098            doc page. -->
0099       <para>Second, you can use
0100       <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
0101       Shortcuts...</guimenuitem></menuchoice> menu item to set a custom keyboard
0102       shortcut. (The entry is under &kmymoney;/Calculator in that list.)  You can
0103       then use that shortcut to launch the application.</para>
0104       <!-- FIXME is not currently possible to launch the calculator from some menu
0105            item.  I have filed a wishlist, and when implemented, it should be
0106            described here, probably as the first choice. -->
0107       <para>
0108       </para>
0109     </listitem>
0110   </varlistentry>
0111 </variablelist>
0112 </sect2>
0113 
0114 <sect2 id="details.settings.general.views">
0115 <title>Views tab</title>
0116 
0117 <variablelist>
0118   <varlistentry>
0119     <term><guilabel>Startup page options</guilabel></term>
0120     <listitem>
0121       <para>When &kmymoney; starts up, this option indicates whether to start
0122       with the Home View or with the view displayed when the program was last
0123       closed.</para>
0124     </listitem>
0125   </varlistentry>
0126 
0127   <varlistentry>
0128   <term><guilabel>Type of the &kmymoney; view</guilabel></term>
0129     <listitem>
0130       <para> You can select one of three general layouts for &kmymoney; to use.  If
0131       you select the List or Tree view, the icons and their labels will be located at
0132       the left side of the window.  The List view displays larger icons while the Tree
0133       view has smaller icons.  The Tabbed view locates the icons and labels across
0134       the top of the window.</para>
0135     </listitem>
0136   </varlistentry>
0137 
0138   <varlistentry>
0139     <term><guilabel>Show title bar on each page</guilabel></term>
0140     <listitem>
0141       <para>Checking this box will display the blue &kmymoney; title bar across the
0142       top of each page.  Unchecking it will remove the title bar and provide a larger
0143       area for viewing the content of each page.</para>
0144     </listitem>
0145   </varlistentry>
0146 
0147   <varlistentry>
0148     <term><guilabel>Synchronize account selection of ledger and investment
0149     view</guilabel></term>
0150     <listitem>
0151       <para>If this option is selected, the accounts displayed in the Ledger View and
0152       Investment View will be synchronized, meaning if you change the account
0153       displayed in one of the views, and then switch to the other view, the
0154       information for the same account will be displayed.  This increases the
0155       efficiency of navigating between these 2 tab views.  If it is not selected,
0156       selecting either of those views will show the same account previously selected
0157       in that view, regardless of the account selected in the other view.</para>
0158     </listitem>
0159   </varlistentry>
0160 </variablelist>
0161 </sect2>
0162 
0163 <sect2 id="details.settings.general.filter">
0164 <title>Filter tab</title>
0165 
0166 <sect3>
0167 <title>Accounts / Categories</title>
0168 <variablelist>
0169   <varlistentry>
0170     <term><guilabel>Do not show unused categories</guilabel></term>
0171     <listitem>
0172       <para>Checking this box hides unused categories in the Categories View.  A
0173       hidden category is still available should a transaction require it.  By typing
0174       a hidden category in the ledger it will become available for use.</para>
0175     </listitem>
0176   </varlistentry>
0177 
0178   <varlistentry>
0179     <term><guilabel>Show equity accounts</guilabel></term>
0180     <listitem>
0181       <para>By default, equity accounts are hidden in the Accounts View.  Selecting
0182       this option will display the equity accounts in the Accounts View.  Equity
0183       accounts are used to track individual equities or investments held in an
0184       Investment Account.  This should not be confused with the top level
0185       <emphasis>Equity</emphasis> group of accounts, which includes the account(s)
0186       which contain the opening balances for other accounts.</para>
0187     </listitem>
0188   </varlistentry>
0189 
0190   <varlistentry>
0191   <term><guilabel>Show categories in the accounts list view</guilabel></term>
0192     <listitem>
0193       <para>By default, Categories are hidden in the Accounts View.  Selecting this
0194       option will display the Categories in the Accounts View.</para>
0195     </listitem>
0196   </varlistentry>
0197 
0198   <varlistentry>
0199   <term><guilabel>Do not show zero balance equities</guilabel></term>
0200     <listitem>
0201       <para>Checking this option will remove any zero balance equity accounts from
0202       appearing in the Accounts View.</para>
0203     </listitem>
0204   </varlistentry>
0205 </variablelist>
0206 </sect3>
0207 
0208 <sect3>
0209 <title>Schedules</title>
0210 <variablelist>
0211     <varlistentry>
0212     <term><guilabel>Do not show finished schedules</guilabel></term>
0213     <listitem>
0214       <para>Checking this box will hide all finished schedules from appearing in the
0215       Scheduled transaction View.</para>
0216     </listitem>
0217   </varlistentry>
0218 </variablelist>
0219 </sect3>
0220 
0221 <sect3>
0222 <title>Transactions</title>
0223 <variablelist>
0224   <varlistentry>
0225     <term><guilabel>Do not show transaction prior to</guilabel></term>
0226     <listitem>
0227       <para>Transactions prior to the date entered here will not be displayed in the
0228       Ledger View.  This can be useful if your data includes many years of
0229       transactions; setting this to one or two years ago hides older
0230       transactions.</para>
0231       <para>Setting this option to January 1, 1900 (the default value) is a good way
0232       to debug date-related data import problems, in case some dates were erroneously
0233       very far in the past.</para>
0234     </listitem>
0235   </varlistentry>
0236 
0237   <varlistentry>
0238     <term><guilabel>Do not show reconciled transactions</guilabel></term>
0239     <listitem>
0240       <para>Checking this box will filter transactions by reconciliation state.
0241       Transactions that are marked as <emphasis>Reconciled</emphasis> will not be
0242       shown in the Ledger View.</para>
0243     </listitem>
0244   </varlistentry>
0245 </variablelist>
0246 </sect3>
0247 </sect2>
0248 </sect1>
0249 
0250 <sect1 id="details.settings.home">
0251 <title>Home</title>
0252 
0253 <sect2>
0254 <title>Home page display sections</title>
0255 <para>
0256   These options allow you to customize the appearance of the <link
0257   linkend="firsttime.mainwindow">Home View</link> (also called the Home Page or Main
0258   Window) by choosing which information to display there and the order in which it
0259   appears.  Selected sections can be reordered by clicking the respective
0260   <guibutton>Up</guibutton> or <guibutton>Down</guibutton> button.
0261 </para>
0262 <!-- FIXME Many of these sections need a <link> to the doc section actually
0263      describing the content. -->
0264 
0265 <variablelist>
0266   <varlistentry>
0267     <term><guilabel>Assets and Liabilities</guilabel></term>
0268     <listitem>
0269       <para>This will display the asset and liability accounts that are open along
0270       with their current balances.  This and other account lists on the Home Page are
0271       sorted in alphabetical order, unless otherwise noted.</para>
0272     </listitem>
0273   </varlistentry>
0274 
0275   <varlistentry>
0276     <term><guilabel>Payments</guilabel></term>
0277     <listitem>
0278       <para>This will display upcoming occurrences of Scheduled transactions,
0279       distinguishing Overdue payments from Future payments.  It shows the date,
0280       schedule name, account and amount of the payment, and the account balance after
0281       the payment.  By default it will show up to six transaction.  If six are
0282       displayed, there is a link you can select to show more, up to 30 days in
0283       advance.</para>
0284     </listitem>
0285   </varlistentry>
0286 
0287   <varlistentry>
0288     <term><guilabel>Preferred accounts</guilabel></term>
0289     <listitem>
0290       <para>This will display the accounts that are identified as Preferred accounts
0291       within the <menuchoice><guimenu>Account</guimenu><guimenuitem>Edit account...
0292       </guimenuitem></menuchoice> Configuration dialog.</para>
0293       <para>For this and all other account list sections addressed by this set of
0294       options, the display will include the account name and current balance, and
0295       other columns specific to that type of report, and in some cases, as configured
0296       elsewhere.</para>
0297       <!-- FIXME - the menu item (or maybe link to actual doc page) should point
0298            to the actual other config location and perhaps which items for
0299            which account type. -->
0300     </listitem>
0301   </varlistentry>
0302 
0303   <varlistentry>
0304     <term><guilabel>Payment accounts</guilabel></term>
0305     <listitem>
0306       <para>This will display all Payment accounts; these include any account into
0307       which income can be deposited, and/or out of which bills can be paid.</para>
0308     </listitem>
0309   </varlistentry>
0310 
0311   <varlistentry>
0312     <term><guilabel>Favorite Reports</guilabel></term>
0313     <listitem>
0314       <para>This will display a list of all reports that have been identified as a
0315       favorite in the Configuration dialog of the Report.  The list ordered
0316       chronologically by when each report became a favorite.</para>
0317     </listitem>
0318   </varlistentry>
0319 
0320   <varlistentry>
0321     <term><guilabel>Forecast (schedule)</guilabel></term>
0322     <listitem>
0323       <para>This will display a 30, 60, and 90 day forecast for asset and liability accounts with non zero
0324       balances and with non reconciled transactions.</para>
0325       <!-- FIXME What are the real criteria for inclusion in this (and these other) list(s). -->
0326     </listitem>
0327   </varlistentry>
0328 
0329   <varlistentry>
0330     <term><guilabel>Net worth forecast</guilabel></term>
0331     <listitem>
0332       <para>This will display chart of your forecast net worth for the next 90
0333       days.</para>
0334     </listitem>
0335   </varlistentry>
0336 
0337   <!-- FIXME "Forecast (history) removed as apparently not actually used. -->
0338 
0339   <varlistentry>
0340     <term><guilabel>Budget</guilabel></term>
0341     <listitem>
0342       <para>This will display a current month summary and overruns for any defined
0343       budget(s). If no budget is defined, it will display no budget or overruns, with
0344       the actual current month spending.</para>
0345     </listitem>
0346   </varlistentry>
0347 
0348   <varlistentry>
0349     <term><guilabel>Cash Flow</guilabel></term>
0350     <listitem>
0351       <para>This will display a Cash Flow Summary analysis for the current month.</para>
0352     </listitem>
0353   </varlistentry>
0354 </variablelist>
0355 </sect2>
0356 
0357 <sect2>
0358 <title>Homepage/Summary page scaling</title>
0359 <variablelist>
0360 
0361   <varlistentry>
0362     <term><guilabel>Zoom factor:</guilabel></term>
0363     <listitem>
0364       <para>This option allows for the selection of the font size as a percentage to
0365       fit the Home View based on the user preference.</para>
0366     </listitem>
0367   </varlistentry>
0368 
0369   <varlistentry>
0370     <term><guilabel>Remember zoom factor when leaving the program if manually changed
0371     with mouse-wheel</guilabel></term>
0372     <listitem>
0373       <para>Selecting this will save your font size preference if you have changed it
0374       on the Home page by using the mouse-wheel.</para>
0375     </listitem>
0376   </varlistentry>
0377 </variablelist>
0378 </sect2>
0379 
0380 <sect2>
0381 <title>Account information display</title>
0382 <para>These options allow you to customize what information is included in any list
0383 of accounts.</para>
0384 <variablelist>
0385   <varlistentry>
0386     <term><guilabel>Show account limit information</guilabel></term>
0387     <listitem>
0388       <para>Displays the account limit as set in the Account Edit dialog.  It affects
0389       any list which includes Payment accounts.</para>
0390     </listitem>
0391   </varlistentry>
0392 
0393   <varlistentry>
0394     <term><guilabel>Show balance-status of mapped online accounts</guilabel></term>
0395     <listitem>
0396       <para>Shows the balance-status of mapped accounts, symbolized by an icon in the
0397       columns preceding the account name.  A green checkmark indicates the online
0398       balance and local balance are the same.  A mailbox with a green arrow indicates
0399       that the local file has transactions newer than the most recent online update.
0400       This alerts the user to start an online-update.  A red warning sign indicates a
0401       mismatch between the local file and online-balance.</para>
0402       <!-- Note: the colors might be different depending on the selected theme
0403            -->
0404     </listitem>
0405   </varlistentry>
0406 
0407   <varlistentry>
0408     <term><guilabel>Show number of not marked transactions per account [!M]</guilabel></term>
0409     <listitem>
0410       <para>Inserts an additional column next to the account name, showing the number
0411       of not marked transactions in the account.</para>
0412     </listitem>
0413   </varlistentry>
0414 
0415   <varlistentry>
0416     <term><guilabel>Show number of cleared transactions per account [C]</guilabel></term>
0417     <listitem>
0418       <para>Inserts an additional column showing the number of cleared transactions
0419       for the account.</para>
0420     </listitem>
0421   </varlistentry>
0422 
0423   <varlistentry>
0424     <term><guilabel>Show number of not reconciled (not marked + cleared) transactions
0425     per account [!R]</guilabel></term>
0426     <listitem>
0427       <para>Inserts an additional column showing the number of not reconciled
0428       transactions for the account, &ie;, the sum of all not marked and cleared
0429       transactions.</para>
0430     </listitem>
0431   </varlistentry>
0432 
0433   <varlistentry>
0434     <term><guilabel>Show date of last reconciliation</guilabel></term>
0435     <listitem>
0436       <para>Inserts an additional column showing the last reconciliation date for the
0437       account.</para>
0438     </listitem>
0439   </varlistentry>
0440 </variablelist>
0441 </sect2>
0442 </sect1>
0443 
0444 <sect1 id="details.settings.register">
0445 <title>Ledger</title>
0446 
0447 <para>
0448    The following options outlined within this section allow for the modification of the
0449    transaction register contained within the Ledger view tab.
0450 </para>
0451 
0452 <sect2 id="details.settings.register.display">
0453 <title>Display tab</title>
0454 
0455 <variablelist>
0456   <varlistentry>
0457     <term><guilabel>Show a grid in the register</guilabel></term>
0458     <listitem>
0459       <para>Selecting this option displays grid lines in the transaction
0460       register or Ledger View.  It provides an additional viewing option that
0461       may make it easier to visualize separate transactions and their component
0462       parts.</para>
0463     </listitem>
0464   </varlistentry>
0465 
0466   <varlistentry>
0467     <term><guilabel>Show all register entries in full detail</guilabel></term>
0468     <listitem>
0469       <para>Selecting this option makes the register show all the information
0470       for all displayed transactions, with separate lines in the Detail Column
0471       for Category and Tags and for the Memo.  If it is not selected, Category,
0472       Tags, and Memo will not be displayed.</para>
0473       <para>This has the same effect as selecting the <link
0474       linkend="reference.menus.settings.transactiondetail">Show Transaction
0475       Detail</link> menu option.</para>
0476     </listitem>
0477   </varlistentry>
0478 
0479   <varlistentry id="details.settings.register.lens">
0480     <term><guilabel>Use the ledger lens</guilabel></term>
0481     <listitem>
0482       <para>Selecting this option displays all the detail lines for the selected
0483       transaction, even if <guilabel>Show all register entries in full
0484       detail</guilabel> is not selected.</para>
0485     </listitem>
0486   </varlistentry>
0487 
0488   <varlistentry>
0489   <term><guilabel>Show transaction form</guilabel></term>
0490     <listitem>
0491       <para>Selecting this option displays the <link
0492       linkend="details.ledger.transactionform">transaction form</link> at the
0493       bottom of the register, and that is where you edit a transaction.  If the
0494       transaction form is not displayed, you edit a transaction within the
0495       ledger itself.  With this option enabled fewer transactions are visible in
0496       the ledger, compared to when it is disabled.</para>
0497     </listitem>
0498   </varlistentry>
0499 
0500   <varlistentry>
0501     <term><guilabel>Always show a No. field</guilabel></term>
0502     <listitem>
0503       <para>Always display the number (<quote>No.</quote>) field when entering or
0504       editing a transaction.  With this enabled you'll be able to check numbers
0505       entered in this field for checking accounts.</para>
0506     </listitem>
0507   </varlistentry>
0508 
0509   <varlistentry>
0510     <term><guilabel>Show group header between transactions</guilabel></term>
0511     <listitem>
0512       <para>Selecting this option will display group headers in the register.
0513       These refer to time periods or milestones such as Last month, Last week,
0514       This month, Last reconciliation, Next week, and Next Month.</para>
0515     </listitem>
0516   </varlistentry>
0517 
0518   <varlistentry>
0519     <term><guilabel>Show header for the previous and current fiscal year
0520     </guilabel></term>
0521     <listitem>
0522       <para>Selecting this option will display group headers in the register for
0523       the current and the previous fiscal year.</para>
0524     </listitem>
0525   </varlistentry>
0526 
0527   <varlistentry>
0528     <term><guilabel>Display overdue schedules with planned date</guilabel></term>
0529     <listitem>
0530       <para>Scheduled transactions with future dates are shown in the Ledger
0531       View for the relevant account.  When the date passes, and a scheduled
0532       transaction becomes overdue, it is no longer shown in the ledger, unless
0533       this option is selected.</para>
0534     </listitem>
0535   </varlistentry>
0536 </variablelist>
0537 </sect2>
0538 
0539 <sect2 id="details.settings.register.sorting">
0540 <title>Sorting tab</title>
0541 <para>
0542   These three sections allow you to set the default sort order of transactions
0543   in the Ledger View.  In all cases, the list on the left shows all the fields
0544   available for sorting.  To sort on an item, select it (single mouse click) and
0545   click the right arrow between the two lists.  The list on the right shows all
0546   the fields which have been selected as part of the sort order for that view.
0547   You can adjust the relative order of the fields by selecting one and adjusting
0548   its position in the list using the up and down arrows to the right of the
0549   list.  You can switch between ascending and descending sort for any item
0550   by double clicking on it.
0551 </para>
0552 <para>
0553   The fields available for sorting are the same for all three sections: Amount,
0554   Category, Entry Order (date the transaction was created,) Number, Payee, Post
0555   date, Reconcile state, Security, and Type.
0556 </para>
0557 
0558 <sect3 id="details.settings.register.sorting.normal">
0559 <title>Normal view tab</title>
0560 <para>
0561   This tab controls the default sort order of the regular Ledger View.
0562 </para>
0563 </sect3>
0564 
0565 <sect3 id="details.settings.register.sorting.reconciliation">
0566 <title>Reconciliation view tab</title>
0567 <para>
0568   This tab controls the default sort order of the ledger while in the
0569   Reconciliation view.  This is the display of transactions shown during the
0570   process of <link linkend="details.reconcile">Reconciliation</link>.
0571 </para>
0572 </sect3>
0573 
0574 <sect3 id="details.settings.register.sorting.search">
0575 <title>Search view tab</title>
0576 <para>
0577   This tab controls the default sort order of the ledger while in the <link linkend="details.search">Search view</link>.
0578 </para>
0579 </sect3>
0580 </sect2>
0581 
0582 <sect2 id="details.settings.register.dataentry">
0583 <title>Data Entry tab</title>
0584 <para>These options affect the process of creating new transactions.</para>
0585 
0586 <variablelist>
0587   <varlistentry>
0588     <term><guilabel>Auto increment check number</guilabel></term>
0589     <listitem>
0590       <para>Enabling this will automatically increment the check number whenever
0591       entering a new check transaction.  They have the same effect whether you
0592       use the Ledger Lens or the Transaction Form.</para>
0593     </listitem>
0594   </varlistentry>
0595 
0596   <varlistentry>
0597     <term><guilabel>Keep changes when selecting a different
0598     transaction/split</guilabel></term>
0599     <listitem>
0600       <para>When enabled, selecting a different transaction or split will save
0601       edits to the current transaction.  When disabled, selecting a different
0602       transaction split will prompt you whether or not to save any
0603       changes.</para>
0604     </listitem>
0605   </varlistentry>
0606 
0607   <varlistentry>
0608     <term><guilabel>Use Enter to move between fields</guilabel></term>
0609     <listitem>
0610       <para>When enabled, pressing &Enter; will change the focus to the next field
0611       of the transaction.  When in the last field, the transaction will be
0612       saved.  When disabled, navigation between fields would occur by using the
0613       &Tab; key or the mouse.  Pressing the &Enter; key would save the transaction,
0614       no matter which field is currently in focus.
0615       </para>
0616     </listitem>
0617   </varlistentry>
0618 
0619   <varlistentry>
0620     <term><guilabel>Match names from start</guilabel></term>
0621     <listitem>
0622       <para>This option controls <link
0623       linkend="details.payees.personalinformation.matching">payee
0624       matching.</link> When enabled, payee names will always be matched from the
0625       start.  When disabled, any substring will be matched.  Also, when enabled
0626       additional options for matching can be established in the Matching Tab of
0627       the Payees View.</para>
0628     </listitem>
0629   </varlistentry>
0630 
0631   <!--FIXME missing Automatic reconciliation-->
0632   <varlistentry>
0633     <term><guilabel>Automatic reconciliation</guilabel></term>
0634     <listitem>
0635       <para>This option needs to be documented.
0636       </para>
0637     </listitem>
0638   </varlistentry>
0639 
0640   <varlistentry>
0641     <term><guilabel>Default reconciliation state</guilabel></term>
0642     <listitem>
0643       <para>Select the default reconciliation state for new transactions: Not
0644       reconciled, Cleared, and Reconciled.</para>
0645     </listitem>
0646   </varlistentry>
0647 
0648   <varlistentry>
0649     <term><guilabel>Autofill</guilabel></term>
0650     <listitem>
0651       <para>This option allows you to select the desired behavior for autofill.
0652       This controls which, if any, previous transactions for the same payee are
0653       displayed, and which, if any, of those transactions are used to auto-fill
0654       details of the new transaction.</para>
0655       <itemizedlist>
0656         <listitem>
0657           <para>No Autofill</para>
0658           <para>This will deactivate autofill, and you must manually enter all
0659           details for the new transaction.</para>
0660         </listitem>
0661         <listitem>
0662           <para>Same transaction if amount differs less than percentage set below</para>
0663           <para>With this option selected, when you enter a new transaction,
0664           &kmymoney; will display a list of previous transactions for the same
0665           payee and account.  If the amount of a previous transactions differ
0666           less than X percent from the amount you have entered, they will be
0667           considered identical, and details from the previous transaction will
0668           be used to autofill details of the new transaction.  The "X" above is
0669           specified in the box next to <guilabel>Same transaction if amount
0670           differs less than</guilabel>, and can range from 0 to 100%.  If the
0671           percentage is 0, all previous transactions for the payee and account
0672           will be displayed, and you can select one of those transactions to use
0673           for autofill by clicking on it.</para>
0674         </listitem>
0675         <listitem>
0676           <para>With previously most often used transaction for the payee</para>
0677           <para>With this option selected, when you enter new transaction,
0678           &kmymoney; will fill in all the transaction details based on the
0679           previously most often used transaction for the selected payee.</para>
0680         </listitem>
0681       </itemizedlist>
0682     </listitem>
0683   </varlistentry>
0684 
0685   <varlistentry>
0686     <term><guilabel>Use memos from previous transaction</guilabel></term>
0687     <listitem>
0688       <para>When selected, the memo from the previously entered transaction will
0689       be automatically entered as the memo for the new transaction.
0690       </para>
0691     </listitem>
0692   </varlistentry>
0693 </variablelist>
0694 </sect2>
0695 
0696 <sect2 id="details.settings.register.import">
0697 <title>Import tab</title>
0698 
0699 <variablelist>
0700   <varlistentry>
0701     <term><guilabel>Match transaction within days</guilabel></term>
0702     <listitem>
0703       <para>Search for matching transactions within the range of the imported
0704       transaction +/- the given number of days, which can be set from 0 to
0705       99.</para>
0706     </listitem>
0707   </varlistentry>
0708 
0709   <varlistentry>
0710     <term><guilabel>Ask for a new payee's default category</guilabel></term>
0711     <listitem>
0712       <para>If this option is selected, whenever a new payee is detected during
0713       an import, the user will be asked for the default category for the
0714       payee.</para>
0715     </listitem>
0716   </varlistentry>
0717 </variablelist>
0718 </sect2>
0719 </sect1>
0720 
0721 <sect1 id="details.settings.schedules">
0722 <title>Scheduled Transactions</title>
0723 
0724 <para>
0725   These options allow you to modify the behavior of <link
0726   linkend="details.schedules">Scheduling Transactions</link>.
0727 </para>
0728 
0729 <sect2>
0730 <title>Startup options</title>
0731 <variablelist>
0732   <varlistentry>
0733     <term><guilabel>Check schedules upon startup</guilabel></term>
0734     <listitem>
0735       <para>Enables checking the schedule upon startup of &kmymoney;.  If
0736       a scheduled transaction matches the schedule criteria set then &kmymoney;
0737       will produce a notification requiring handling of the transaction. </para>
0738     </listitem>
0739   </varlistentry>
0740 
0741   <varlistentry>
0742     <term><guilabel>Enter transactions this number of days in
0743     advance</guilabel></term>
0744     <listitem><para>Specify how many days in advance a scheduled transaction
0745     should be entered.</para>
0746     </listitem>
0747   </varlistentry>
0748 </variablelist>
0749 </sect2>
0750 
0751 <sect2 id="details.settings.schedules.calendar">
0752 <title>Processing Days</title>
0753 <variablelist>
0754   <varlistentry>
0755     <term><guilabel>Use holiday calendar for region</guilabel></term>
0756     <listitem><para>Select the region of the world that best suits your needs.</para>
0757     </listitem>
0758   </varlistentry>
0759 </variablelist>
0760 </sect2>
0761 
0762 <sect2><title></title>
0763 <variablelist>
0764   <varlistentry>
0765     <term><guilabel>Number of days to preview schedules in ledger</guilabel></term>
0766     <listitem>
0767       <para>Specify how many days should the scheduled transactions show up in the
0768         ledger.</para>
0769       <para>The scheduled transactions will be listed in the ledger. You can
0770         enter or skip the scheduled transactions by right-clicking on
0771         them.</para>
0772     </listitem>
0773   </varlistentry>
0774 </variablelist>
0775 </sect2>
0776 </sect1>
0777 
0778 <sect1 id="details.settings.onlinequote">
0779 <title>Online Quotes</title>
0780 
0781 <para>
0782   These settings modify how financial quotes are retrieved from different online
0783   sources.  These include both stock, bond, and other equity prices, as well as
0784   prices for precious metals and currency conversion.
0785 </para>
0786 
0787 <para>
0788   This tab allows you to change the online quote sources for &kmymoney;.
0789   Generally speaking, this is an advanced feature, and should only be attempted
0790   by the most technically adept users.
0791 </para>
0792 
0793 <para>
0794   For more details, please refer to the <link
0795   linkend="details.investments.onlinequotes">Online Price Quotes</link> section.
0796 </para>
0797 </sect1>
0798 
0799 
0800 <sect1 id="details.settings.colors">
0801 <title>Colors</title>
0802 
0803 <para>
0804    These section allows you to customize the colors used within &kmymoney;.  If
0805    <guilabel>Custom colors</guilabel> is not checked, then default colors will
0806    be used.
0807 </para>
0808 
0809 <para>
0810    To customize colors check the box Custom colors.
0811 </para>
0812 
0813 <para>
0814   Modify any of the colors by clicking on the color button, which will open
0815   color select palette.  This will provide unlimited options in color selection.
0816   You can select a defined basic color, pick a color by clicking anywhere on the
0817   screen, input an &HTML; defined color, specify values for Hue, Saturation,
0818   Value, Red, Green, and Blue.
0819 
0820 </para>
0821 </sect1>
0822 
0823 <sect1 id="details.settings.fonts">
0824 <title>Fonts</title>
0825 
0826 <para>
0827   These options allow you to modify the fonts within the Cell or Header fields.
0828 </para>
0829 
0830 <variablelist>
0831   <varlistentry>
0832     <term><guilabel>Use system fonts</guilabel></term>
0833     <listitem>
0834       <para>Select this to use system fonts. Deselecting this option allows the select
0835       the fonts of your choice.</para>
0836     </listitem>
0837   </varlistentry>
0838 
0839   <varlistentry>
0840     <term><guilabel>Cell font</guilabel></term>
0841     <listitem>
0842       <para>Specify the custom font to use within each cell of the registers.</para>
0843     </listitem>
0844   </varlistentry>
0845 
0846   <varlistentry>
0847     <term><guilabel>Header font</guilabel></term>
0848     <listitem>
0849       <para>Specify the custom font to use for the headers of each view within the register.</para>
0850     </listitem>
0851   </varlistentry>
0852 </variablelist>
0853 </sect1>
0854 
0855 <sect1 id="details.settings.icons">
0856 <title>Icons</title>
0857 
0858 <para>
0859   This option allows for the selection of icons that will be displayed.
0860 </para>
0861 
0862 <variablelist>
0863   <varlistentry>
0864     <term><guilabel>Individual icon settings</guilabel></term>
0865     <listitem>
0866       <para>Using the pull-down menu there is a selection of available icons available for use.
0867       Additional icons may be available for downloading and use depending on the operating
0868       system installed.</para>
0869     </listitem>
0870   </varlistentry>
0871 </variablelist>
0872 </sect1>
0873 
0874 <sect1 id="details.settings.plugins">
0875 <title>Plugins</title>
0876 
0877 <para>
0878   This section provides information about the available plugins, and allow you
0879   to modify the behavior of installed plugins.  Note that the list of plugins
0880   displayed will depend on which plugins &kmymoney; found when it started.  It
0881   does not matter whether the plugin was compiled as part of the application or
0882   added as a separate package.
0883   <screenshot>
0884         <screeninfo>Configure Plugins</screeninfo>
0885         <mediaobject>
0886         <imageobject>
0887         <imagedata fileref="configure_plugins.png" format="PNG" />
0888         </imageobject>
0889         <textobject>
0890         <phrase>Configure Plugins</phrase>
0891         </textobject>
0892         </mediaobject>
0893   </screenshot>
0894   Every plugin can be enabled or disabled, according to the state of the
0895   checkbox next to the name of the plugin.  In addition, at the right, there is
0896   also an <guibutton>information</guibutton> (&infoicon;) button for each, which
0897   will show the plugin version and author.  For some plugins, further
0898   information on configuring and using it may be found by clicking the
0899   configure, or tool icon just to the left of the information button.  There is
0900   only one plugin that requires configuration, and that is the Check printing
0901   plugin.
0902 </para>
0903 
0904 <sect2 id="details.settings.plugins.printchecks">
0905 <title>Check printing plugin</title>
0906 
0907 <para>
0908   As one example, there is a plugin for printing checks, which
0909   is included with the source of &kmymoney;, and should always be
0910   enabled.  It allows printing of a check based on the data from a selected
0911   transaction, with the layout controlled by an &HTML; template. You need to use a
0912   template which is matched to your pre-printed checks.  When you click on the
0913   <guibutton>configure</guibutton> (&configicon;) button, the <guilabel>Check
0914   printing</guilabel> configuration dialog is displayed.  At the top is a text box
0915   for the path to the selected template.  To the right of that is a button which
0916   brings up a file chooser, to select an alternate template file.
0917 </para>
0918 
0919 <para>
0920   A template file is an &HTML; file, in which specific strings are used to
0921   reference the fields from the transaction and from the current account and
0922   institution to show where they will be printed on the check.  &kmymoney; is
0923   shipped with some sample template files.  You should either be able to use one
0924   of them, or modify one to suit your needs.  When the default template is
0925   selected, the configuration dialog will show you the folder which contains
0926   the sample files.
0927 </para>
0928 
0929 <!-- info from source code on substitution variables
0930     // data about the user
0931     checkHTML.replace("$OWNER_NAME", file->user().name());
0932     checkHTML.replace("$OWNER_ADDRESS", file->user().address());
0933     checkHTML.replace("$OWNER_CITY", file->user().city());
0934     checkHTML.replace("$OWNER_STATE", file->user().state());
0935     // data about the account institution
0936     checkHTML.replace("$INSTITUTION_NAME", institution.name());
0937     checkHTML.replace("$INSTITUTION_STREET", institution.street());
0938     checkHTML.replace("$INSTITUTION_TELEPHONE", institution.telephone());
0939     checkHTML.replace("$INSTITUTION_TOWN", institution.town());
0940     checkHTML.replace("$INSTITUTION_CITY", institution.city());
0941     checkHTML.replace("$INSTITUTION_POSTCODE", institution.postcode());
0942     checkHTML.replace("$INSTITUTION_MANAGER", institution.manager());
0943     // data about the transaction
0944     checkHTML.replace("$DATE", KGlobal::locale()->formatDate(QDate::currentDate(), KLocale::LongDate));
0945     checkHTML.replace("$CHECK_NUMBER", (*it).split().number());
0946     checkHTML.replace("$PAYEE_NAME", file->payee((*it).split().payeeId()).name());
0947     checkHTML.replace("$PAYEE_ADDRESS", file->payee((*it).split().payeeId()).address());
0948     checkHTML.replace("$PAYEE_CITY", file->payee((*it).split().payeeId()).city());
0949     checkHTML.replace("$PAYEE_POSTCODE", file->payee((*it).split().payeeId()).postcode());
0950     checkHTML.replace("$PAYEE_STATE", file->payee((*it).split().payeeId()).state());
0951     checkHTML.replace("$AMOUNT_STRING", converter.convert((*it).split().shares().abs()));
0952     checkHTML.replace("$AMOUNT_DECIMAL", MyMoneyUtils::formatMoney((*it).split().shares().abs(), currency));
0953     checkHTML.replace("$MEMO", (*it).split().memo());
0954 -->
0955 
0956 
0957 </sect2>
0958 <sect2 id="details.settings.plugins.kbanking">
0959 <title>KBanking</title>
0960 
0961 <para>
0962   This plugins adds support for HBCI/FinTs, OFX and PayPal online banking to KMyMoney.
0963   After this plugin has been enabled, online banking can be configured in the
0964   <link linkend="reference.menus.settings.help">Settings</link> menu.
0965 </para>
0966 
0967 </sect2>
0968 </sect1>
0969 </chapter>