r19774 - gnucash-docs/branches/2.2/help/C - help: Finish backport of r19760
Yawar Amin
yawaramin at code.gnucash.org
Sun Nov 7 18:00:03 EST 2010
Author: yawaramin
Date: 2010-11-07 18:00:03 -0500 (Sun, 07 Nov 2010)
New Revision: 19774
Trac: http://svn.gnucash.org/trac/changeset/19774
Added:
gnucash-docs/branches/2.2/help/C/Help_ch_Tools_Assistants.xml
Removed:
gnucash-docs/branches/2.2/help/C/Help_ch_Tools_Druids.xml
Log:
help: Finish backport of r19760
The renamed file didn't get backported due to some SVN <-> Git weirdness,
do the rename manually.
Copied: gnucash-docs/branches/2.2/help/C/Help_ch_Tools_Assistants.xml (from rev 19773, gnucash-docs/branches/2.2/help/C/Help_ch_Tools_Druids.xml)
===================================================================
--- gnucash-docs/branches/2.2/help/C/Help_ch_Tools_Assistants.xml (rev 0)
+++ gnucash-docs/branches/2.2/help/C/Help_ch_Tools_Assistants.xml 2010-11-07 23:00:03 UTC (rev 19774)
@@ -0,0 +1,2028 @@
+<!--
+ (Do not remove this comment block.)
+ Version: 2.0.x
+ Last modified: April 15th 2007
+ modified: August 12th 2006
+ modified: February 28th 2005
+
+ Maintainers:
+ Chris Lyttle <chris at wilddev.net>
+ Neil Williams <linux at codehelp.co.uk>
+
+ Author:
+ Chris Lyttle <chris at wilddev.net>
+ Translators:
+ (translators put your name and email here)
+-->
+
+<chapter id="ch_AccRegTools">
+ <title>Tools & Assistants</title>
+
+ <para>There are many specialized Tools used in <application>&app;</application>. These tools enable access to the enhanced functionality
+ in <application>&app;</application>. These tools are accessed via the <guimenu>Tools</guimenu> option from any window that displays a
+ <guimenu>Tools</guimenu> menu. Several of these tools may not be displayed depending on if your
+ software was not configured to support Online banking, or the tools appropriate for the current window.</para>
+
+ <sect1 id="tool-find">
+ <title>Find Transactions</title>
+
+ <para>Find Transactions is used to search for transactions in &app;
+ and display the results in a register window. The title bar of the
+ Find Transactions dialog contains 'Search For...' and the first line
+ of the dialog has 'Split Search'. In other search dialogs used in
+ &app; the first line contains a different description but the same
+ basic layout.</para>
+
+ <note><para>The <guilabel>Find</guilabel> tool will also search for; a Customer, an Invoice, a Job, a Vendor,
+ Bill(s), Employee(s), or Expense Voucher(s). The target of the search is determined by where the tools is
+ invoked. Access to the Tool via <guimenu>Business > (Customer/Vendor/Employee) > ... </guimenu>.
+ </para></note>
+
+ <para>To open the Find Transactions dialog in the Account Tree Window
+ go to the Tools menu and select Find Transactions or type menu
+ shortcut Ctrl-F. To open the Find Transactions dialog in the Account
+ Register Window go to the Edit menu and select Find... or type menu
+ shortcut F6.</para>
+
+ <para>There are two panes in the search dialog. The top pane contains
+ the Search Criteria buttons and the bottom pane contains the Type of
+ Search selection.</para>
+
+ <para>There are two buttons in the top of the Search Criteria pane.
+ The left button allows you to add another criteria row to search for
+ multiple criteria. The existing criteria row needs to be completed
+ before adding a new row. The right button is used to Search for items
+ where all criteria are met or Search for items where any criteria are
+ met. The all criteria are met search requires all of the criteria rows
+ to have at least one match. The any criteria are met search requires
+ only one of the criteria rows to be matched.</para>
+
+ <para>The criteria row is used to combine different criteria buttons.
+ The following table describes the possible button combinations (regex
+ means regular expression search);</para>
+
+ <table frame="topbot" id="tool-find-buttons">
+ <title>Search criteria buttons.</title>
+
+ <tgroup cols="8">
+ <thead>
+ <row>
+ <entry><para>Button 1</para></entry>
+
+ <entry><para>Button2</para></entry>
+
+ <entry><para>Button3</para></entry>
+
+ <entry><para>Button4</para></entry>
+
+ <entry><para>Button5</para></entry>
+
+ <entry><para>Button 6</para></entry>
+
+ <entry><para>Button 7</para></entry>
+
+ <entry><para>Button 8</para></entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry><para>Description</para></entry>
+
+ <entry><para>contains</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Description</para></entry>
+
+ <entry><para>does not contain</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Description</para></entry>
+
+ <entry><para>matches regex</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Description</para></entry>
+
+ <entry><para>does not match regex</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Memo</para></entry>
+
+ <entry><para>contains</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Memo</para></entry>
+
+ <entry><para>does not contain</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Memo</para></entry>
+
+ <entry><para>matches regex</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Memo</para></entry>
+
+ <entry><para>does not match regex</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Number</para></entry>
+
+ <entry><para>contains</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Number</para></entry>
+
+ <entry><para>does not contain</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Number</para></entry>
+
+ <entry><para>matches regex</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Number</para></entry>
+
+ <entry><para>does not match regex</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Action</para></entry>
+
+ <entry><para>contains</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Action</para></entry>
+
+ <entry><para>does not contain</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Action</para></entry>
+
+ <entry><para>matches regex</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Action</para></entry>
+
+ <entry><para>does not match regex</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Note</para></entry>
+
+ <entry><para>contains</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Note</para></entry>
+
+ <entry><para>does not contain</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Note</para></entry>
+
+ <entry><para>matches regex</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Note</para></entry>
+
+ <entry><para>does not match regex</para></entry>
+
+ <entry><para>Criteria entry field</para></entry>
+
+ <entry><para>Is entry Case Insensitive?</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Date Posted</para></entry>
+
+ <entry><para>is before</para></entry>
+
+ <entry><para>Date selection field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Date Posted</para></entry>
+
+ <entry><para>is before or on</para></entry>
+
+ <entry><para>Date selection field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Date Posted</para></entry>
+
+ <entry><para>is on</para></entry>
+
+ <entry><para>Date selection field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Date Posted</para></entry>
+
+ <entry><para>is not on</para></entry>
+
+ <entry><para>Date selection field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Date Posted</para></entry>
+
+ <entry><para>is after</para></entry>
+
+ <entry><para>Date selection field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Date Posted</para></entry>
+
+ <entry><para>is on or after</para></entry>
+
+ <entry><para>Date selection field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has credits or debits</para></entry>
+
+ <entry><para>less than</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has credits or debits</para></entry>
+
+ <entry><para>less than or equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has credits or debits</para></entry>
+
+ <entry><para>equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has credits or debits</para></entry>
+
+ <entry><para>not equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has credits or debits</para></entry>
+
+ <entry><para>greater than</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has credits or debits</para></entry>
+
+ <entry><para>greater than or equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has credits</para></entry>
+
+ <entry><para>less than</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has credits</para></entry>
+
+ <entry><para>less than or equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has credits</para></entry>
+
+ <entry><para>equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has credits</para></entry>
+
+ <entry><para>not equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has credits</para></entry>
+
+ <entry><para>greater than</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has credits</para></entry>
+
+ <entry><para>greater than or equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has debits</para></entry>
+
+ <entry><para>less than</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has debits</para></entry>
+
+ <entry><para>less than or equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has debits</para></entry>
+
+ <entry><para>equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has debits</para></entry>
+
+ <entry><para>not equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has debits</para></entry>
+
+ <entry><para>greater than</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Value</para></entry>
+
+ <entry><para>has debits</para></entry>
+
+ <entry><para>greater than or equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Shares</para></entry>
+
+ <entry><para>less than</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Shares</para></entry>
+
+ <entry><para>less than or equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Shares</para></entry>
+
+ <entry><para>equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Shares</para></entry>
+
+ <entry><para>not equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Shares</para></entry>
+
+ <entry><para>greater than</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Shares</para></entry>
+
+ <entry><para>greater than or equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Share Price</para></entry>
+
+ <entry><para>less than</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Share Price</para></entry>
+
+ <entry><para>less than or equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Share Price</para></entry>
+
+ <entry><para>equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Share Price</para></entry>
+
+ <entry><para>not equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Share Price</para></entry>
+
+ <entry><para>greater than</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Share Price</para></entry>
+
+ <entry><para>greater than or equal to</para></entry>
+
+ <entry><para>Amount entry field</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Reconcile</para></entry>
+
+ <entry><para>is</para></entry>
+
+ <entry><para>Not Cleared</para></entry>
+
+ <entry><para>Cleared</para></entry>
+
+ <entry><para>Reconciled</para></entry>
+
+ <entry><para>Frozen</para></entry>
+
+ <entry><para>Voided</para></entry>
+
+ <entry><para>Remove row</para></entry>
+ </row>
+
+ <row>
+ <entry><para>Reconcile</para></entry>
+
+ <entry><para>is not</para></entry>
+
+ <entry><para>Not Cleared</para></entry>
+
+ <entry><para>Cleared</para></entry>
+
+ <entry><para>Reconciled</para></entry>
+
+ <entry><para>Frozen</para></entry>
+
+ <entry><para>Voided</para></entry>
+
+ <entry><para>Remove row</para></entry>
+ </row>
+
+ <row>
+ <entry><para>Balanced</para></entry>
+
+ <entry><para>is</para></entry>
+
+ <entry><para>set true</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Balanced</para></entry>
+
+ <entry><para>is not</para></entry>
+
+ <entry><para>set true</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Account</para></entry>
+
+ <entry><para>matches any account</para></entry>
+
+ <entry><para>Choose Accounts</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>Account</para></entry>
+
+ <entry><para>matches no account</para></entry>
+
+ <entry><para>Choose Accounts</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+
+ <row>
+ <entry><para>All Accounts</para></entry>
+
+ <entry><para>matches all account</para></entry>
+
+ <entry><para>Choose Accounts</para></entry>
+
+ <entry><para>Remove row</para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+
+ <entry><para></para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <para>The Account button performs a search where the accounts selected
+ in the Choose Accounts dialog will both be searched individually for
+ results. This means that a match in any of the selected accounts will
+ either be displayed (matches any account) or discarded (matches no
+ account).</para>
+
+ <para>The All Accounts button performs a search where accounts
+ selected in the Choose Accounts dialog will only return results that
+ match in both accounts.</para>
+
+ <para>There are four selections in the Type of Search pane. When a new
+ search is started only the New Search button is selectable. The other
+ buttons become selectable only when the Search Results register window
+ is visible.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>New Search: Perform a new transaction search</para>
+ </listitem>
+
+ <listitem>
+ <para>Refine current search: Search within the results of the
+ previous search.</para>
+ </listitem>
+
+ <listitem>
+ <para>Add results to current search: Search based on the first set
+ of criteria or the new criteria.</para>
+ </listitem>
+
+ <listitem>
+ <para>Delete results from current search: Discard any results that
+ match the previous search results.</para>
+ </listitem>
+ </itemizedlist>
+
+ </sect1>
+
+
+ <sect1 id="trans-sched-slr">
+ <title>Since Last Run Assistant</title>
+
+ <para>The Since Last Run assistant is run automatically when <application>&app;</application> is started. It is
+ used to enter into the register any transactions that are due to be automatically
+ entered. The run on <application>&app;</application> start can be altered in the preferences. To run the
+ Since Last Run assistant manually go to <guilabel>Actions -> Scheduled Transactions ->
+ Since Last Run...</guilabel></para>
+
+ <para>The Since Last Run assistant will automatically skip any screens that have no
+ transactions. The following describes every possible screen the assistant will show.
+ The three buttons at the very bottom of the screen will not change while using
+ the assistant.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>The <guilabel>Cancel</guilabel> button is used to exit the assistant and cancel entering the
+ transactions. Any selections you have made in this assistant up to this point will
+ be lost.</para>
+ </listitem>
+
+ <listitem>
+ <para>The <guilabel>Back</guilabel> button will bring up the previous screen so you can change a
+ selection made on that screen.</para>
+ </listitem>
+
+ <listitem>
+ <para>The <guilabel>Forward</guilabel> button will bring up the next screen so you can continue though
+ the assistant.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The first screen shows <guilabel>Transaction Reminders</guilabel> page. This lists scheduled
+ transactions that have been set to give a reminder a number of days in advance. The
+ screen contains three columns. The first column contains the name of the scheduled
+ transaction and the date it is due. The second column contains the Frequency of the
+ scheduled transaction. The third column has the number of Days Away the transaction
+ is due to be entered. To create any transactions in the list instead of just being
+ reminded, select the date line. This will add it to the list of transactions on the
+ To-Create Transaction Preparation page.</para>
+
+ <para>The next screen shows the <guilabel>Auto-Created Transactions Notification</guilabel> page. This
+ lists scheduled transactions that have been set to be automatically created and
+ notify when they are created. Each transaction is presented in a register view that
+ shows the details of the splits in the transaction.</para>
+
+ <para>The next screen shows the <guilabel>To-Create Transaction Preparation</guilabel> page. This lists
+ scheduled transactions that are due to be entered in the register. This screen is
+ divided into three panes. The top left pane contains the list of transactions due to
+ be automatically entered. The top right pane allows you to change the Disposition
+ and has a read only view of the Variables used to create the transaction. The bottom
+ pane contains a read only view of the transactions due to be entered.</para>
+
+ <para>The next screen shows the <guilabel>Created Transaction Review</guilabel> page. This screen displays
+ the list of transactions about to be created and allows for final changes to be
+ made. The list is presented in a register view that shows the details of the splits
+ in the transaction. This is editable in the same way transactions are able to be
+ edited in the register.</para>
+
+ <para>The last screen shows the <guilabel>Obsolete Scheduled Transactions</guilabel> page. This screen
+ displays a list of scheduled transactions that are able to be deleted as the
+ schedule is completed. Select the ones to be removed.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>The <guilabel>Cancel</guilabel> button is used to exit the assistant and cancel creating the
+ scheduled transactions. Any selections you have made in this assistant up to this
+ point will be lost.</para>
+ </listitem>
+
+ <listitem>
+ <para>The <guilabel>Back</guilabel> button will bring up the previous screen so you can change a
+ selection made on that screen.</para>
+ </listitem>
+
+ <listitem>
+ <para>The <guilabel>Finish</guilabel> button creates the accounts you have selected.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The Since Last Run assistant has now added the scheduled transactions to the
+ register.</para>
+ </sect1>
+
+ <sect1 id="trans-sched-loans">
+ <title>Mortgage & Loan Repayment Assistant</title>
+
+ <para>This assistant creates a loan repayment scheduled transaction. When used to setup
+ a scheduled transaction, the assistant creates a variable formula so that the
+ compounding interest is correctly calculated. To start this assistant manually go to
+ <guilabel>Actions -> Scheduled Transactions -> Mortgage and Loan Repayment...</guilabel> </para>
+
+ <para>The Mortgage and Loan Repayment assistant opens with a screen that briefly
+ describes what this assistant does. The three buttons at the very bottom of the screen
+ will not change while using the assistant.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>The <guilabel>Cancel</guilabel> button is used to exit the assistant and cancel creating the
+ scheduled transaction. Any selections you have made in this assistant up to this
+ point will be lost.</para>
+ </listitem>
+
+ <listitem>
+ <para>The <guilabel>Back</guilabel> button will bring up the previous screen so you can change a
+ selection made on that screen.</para>
+ </listitem>
+
+ <listitem>
+ <para>The <guilabel>Forward</guilabel> button will bring up the next screen so you can continue
+ though the assistant.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The next screen allows you to enter the basic loan information. This is
+ usually the information provided by the bank when loan and disclosure documents
+ are given to the borrower. Here you can also setup an account that the scheduled
+ transaction will use to enter the payment transaction.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>Loan Account:</guilabel> Choose an account for the loan payment transactions or use
+ New... to setup a new account for the transactions.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Loan Amount:</guilabel> Enter the amount of the loan.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Interest Rate:</guilabel> Enter the loan interest rate.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Type:</guilabel> Choose the type of loan. If an adjustable rate is used the
+ frequency screen is enabled.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Interest Rate Change Frequency:</guilabel> Choose the frequency for the rate change
+ and the start date of the rate change.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Start Date:</guilabel> Choose the date the loan is starting on.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Length:</guilabel> Enter the length of the loan.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Months Remaining:</guilabel> This should be automatically calculated. Choose how many
+ months are remaining on the loan.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The next screen is used to set escrow, insurance and tax options for the
+ loan. It is mainly used for mortgage payments. When each of the options here is set,
+ this enables additional pages in the assistant to setup those portions of the payments.
+ All of the pages will be described here, even though some may not show if that
+ option is not chosen.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>... utilize an escrow account for payments?: This selection enables the
+ use of an account setup for tracking escrow payments. If the mortgage or loan
+ uses an escrow account to pay taxes, insurance, etc then setup an account here.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>... pay "Taxes"?: adds an additional page to setup a scheduled transaction
+ to pay taxes.</para>
+ </listitem>
+
+ <listitem>
+ <para>... pay "Insurance"?: adds an additional page to setup a scheduled
+ transaction to pay insurance payments.</para>
+ </listitem>
+ <listitem>
+ <para>... pay "PMI"?: adds an additional page to setup a scheduled transaction to pay PMI payments.</para>
+ </listitem>
+ <listitem>
+ <para>... pay "Other Expense"?: adds an additional page to setup a scheduled transaction to pay other
+ expenses.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The next screen is used to setup the details of the scheduled transaction for the Loan Repayment.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Transaction Memo: The name entered here will be used as the name for the scheduled transaction,
+ the description of the scheduled transaction and the memo.</para>
+ </listitem>
+
+ <listitem>
+ <para>Payment Amount: Shows the variable used to calculate the payment amount.</para>
+ </listitem>
+
+ <listitem>
+ <para>Payment From: Choose an account to pay the loan amount from.</para>
+ </listitem>
+
+ <listitem>
+ <para>Principal To: Choose an account to transfer the principal part of the loan to.</para>
+ </listitem>
+
+ <listitem>
+ <para>Interest To: Choose an account to transfer the interest part of the loan to.</para>
+ </listitem>
+
+ <listitem>
+ <para>Remainder to: Choose an account to transfer the rest of the payment amount to.</para>
+ </listitem>
+
+ <listitem>
+ <para>Repayment Frequency: Select the Frequency and start date for loan repayments.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The next screen is used to setup the details of the scheduled transaction for the Tax payment.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Transaction Memo: The name entered here will be used as the name for the scheduled transaction,
+ the description of the scheduled transaction and the memo.</para>
+ </listitem>
+
+ <listitem>
+ <para>Amount: Enter the payment amount.</para>
+ </listitem>
+
+ <listitem>
+ <para>Payment From: Choose an account to pay the tax amount from.</para>
+ </listitem>
+
+ <listitem>
+ <para>Payment To: Choose an account to transfer the tax payment to.</para>
+ </listitem>
+
+ <listitem>
+ <para>Repayment Frequency: Select the Frequency and start date for tax payments.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The next screen is used to setup the details of the scheduled transaction for the Insurance payment.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Transaction Memo: The name entered here will be used as the name for the scheduled transaction,
+ the description of the scheduled transaction and the memo.</para>
+ </listitem>
+ <listitem>
+ <para>Amount: Enter the payment amount.</para>
+ </listitem>
+
+ <listitem>
+ <para>Payment From: Choose an account to pay the insurance amount from.</para>
+ </listitem>
+
+ <listitem>
+ <para>Payment To: Choose an account to transfer the insurance payment to.</para>
+ </listitem>
+
+ <listitem>
+ <para>Repayment Frequency: Select the Frequency and start date for insurance payments.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The next screen is used to setup the details of the scheduled transaction for the PMI payment.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Transaction Memo: The name entered here will be used as the name for the scheduled transaction,
+ the description of the scheduled transaction and the memo.</para>
+ </listitem>
+
+ <listitem>
+ <para>Amount: Enter the payment amount.</para>
+ </listitem>
+
+ <listitem>
+ <para>Payment From: Choose an account to pay the PMI amount from.</para>
+ </listitem>
+
+ <listitem>
+ <para>Payment To: Choose an account to transfer the PMI payment to.</para>
+ </listitem>
+
+ <listitem>
+ <para>Repayment Frequency: Select the Frequency and start date for PMI payments.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The next screen is used to setup the details of the scheduled transaction for the Other Expense payment.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Transaction Memo: The name entered here will be used as the name for the scheduled transaction,
+ the description of the scheduled transaction and the memo.</para>
+ </listitem>
+
+ <listitem>
+ <para>Amount: Enter the payment amount.</para>
+ </listitem>
+
+ <listitem>
+ <para>Payment From: Choose an account to pay the other expense amount from.</para>
+ </listitem>
+
+ <listitem>
+ <para>Payment To: Choose an account to transfer the other expense payment to.</para>
+ </listitem>
+
+ <listitem>
+ <para>Repayment Frequency: Select the Frequency and start date for other expense payments.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The last screen gives you a list of three choices to finish the assistant.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>The Cancel button is used to exit the assistant and cancel creating a new loan scheduled transaction.
+ Any selections you have made in this assistant up to this point will be lost.</para>
+ </listitem>
+
+ <listitem>
+ <para>The Back button will bring up the previous screen so you can change a selection made on that screen.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>The Finish button creates the scheduled transaction.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>You should now have the Mortgage or Loan Repayment scheduled transaction
+ setup.</para>
+
+ </sect1>
+
+ <sect1 id="stock-split">
+ <title>Recording a Stock Split</title>
+
+ <para>Stock splits commonly occur when a company decides its stock price is to
+ expensive for individual investors to buy the stock. Splits have the effect of
+ lowering the price of a single share while keeping the value of shares owned by
+ investors who have already purchased shares.</para>
+
+ <sect2 id="stock-split-assistant">
+ <title>Stock Split Assistant</title>
+
+ <para><application>&app;</application> uses the Stock Split assistant to record stock splits. This provides a
+ way of entering the details of the stock split and also any change in stock price
+ or cash disbursement as a result of the stock split.</para>
+
+ <para>The Stock Split assistant is accessed by going to <guimenu>Actions -> Stock Split...</guimenu>
+ </para>
+
+ <para>The Stock Split assistant opens with a screen that briefly describes what this
+ assistant does. The three buttons at the very bottom of the screen will not change
+ while using the assistant.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>The <guibutton>Cancel</guibutton> button is used to exit the assistant and cancel entering the stock
+ split information. Any selections you have made in this assistant up to this point
+ will be lost.</para>
+ </listitem>
+
+ <listitem>
+ <para>The <guibutton>Back</guibutton> button will bring up the previous screen so you can change a
+ selection made on that screen.</para>
+ </listitem>
+
+ <listitem>
+ <para>The <guibutton>Forward</guibutton> button will bring up the next screen so you can continue
+ though the assistant.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The next screen allows you to select a Stock Account. Select an account from
+ the list to record a stock split or merger.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>Account:</guilabel> Lists the &app; account name for the stock.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Symbol:</guilabel> The stock symbol for the stock associated with this account.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Shares:</guilabel> The amount of shares that have been purchased in the account.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The next screen lets you set the Stock Split Details. The top part of the
+ screen contains details used in creating the stock split transaction. </para>
+
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>Date:</guilabel> Choose the date of the stock split.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Share Distribution:</guilabel> Enter the amount of shares gained from the stock split.
+ For a stock merger enter a negative number.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Description:</guilabel> Enter a description or leave as the default.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The bottom part of the screen contains details used to record a price for the
+ split (optional).</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>New Price:</guilabel> Enter the price of the shares on the day of the stock split.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Currency:</guilabel> Choose the currency of the shares.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The next screen lets you enter a transaction for a cash disbursement (Cash In
+ Lieu) as a result of the stock split (optional).</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>Cash Amount:</guilabel> Enter the amount of the Cash disbursement.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Memo:</guilabel> Enter a memo or leave as the default.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Income Account:</guilabel> Choose an Income Account for the disbursement.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Asset Account:</guilabel> Choose an Asset Account for the disbursement.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The last screen gives you a list of three choices to finish the assistant.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>The <guibutton>Cancel</guibutton> button is used to exit the assistant and cancel creating the
+ Stock Split transactions. Any selections you have made in this assistant up to
+ this point will be lost.</para>
+ </listitem>
+
+ <listitem>
+ <para>The <guibutton>Back</guibutton> button will bring up the previous screen so you can change a
+ selection made on that screen.</para>
+ </listitem>
+
+ <listitem>
+ <para>The <guibutton>Finish</guibutton> button creates the transactions for the Stock Split.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>You should now have successfully entered the Stock Split or Merger.</para>
+ </sect2>
+ </sect1>
+
+ <sect1 id="tools-on-line-banking">
+ <title>HBCI (Online Banking) Setup Assistant</title>
+
+<note><para>This section is "under construction - any input will be welcome !!".</para></note>
+
+ <para>The HBCI Assistant is used to create and edit data to enable access to Online banking transactions.
+ Currently the best instruction for this process are in the <application>&app;</application> wiki at
+ <ulink url="http://wiki.gnucash.org/wiki/Setting_up_OFXDirectConnect_in_&app;_2">Setting up OFXDirectConnect
+ in <application>&app;</application> 2</ulink>. If <guilabel>HBCI Setup</guilabel> does not appear in your Tools menus verify that you
+ are in an Account Tree or Register tab.
+ </para>
+
+ </sect1>
+
+ <sect1 id="tool-price">
+ <title>Price Editor</title>
+
+ <para>The Price Editor is used to track/modify the value of a currency, mutual fund and stocks.
+ It provides a unified interface to updating the values of these commodities and is able to update manually
+ or through on-line quotes.</para>
+
+ <para>Each entry in the editor shows a record of a security/commodity price(s):</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Security: </emphasis>The Security/commodity being priced. The display is sorted
+ by the "exchange" that the individual securities are listed on. The list is expanded by clicking on the
+ "caret" on the left of the name.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Currency: </emphasis>The currency the price is recorded in.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Date: </emphasis>The date the price was recorded.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Source: </emphasis>The source of the commodities price quote. Typically, this
+ will be either "user:price-editor", indicating you entered it directly, or "Finance::Quote", indicating
+ that it was retrieved from an on-line source by the Finance::Quote module.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Type: </emphasis>There are several different types
+ of stock price quotes.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Bid: </emphasis>Indicates what a specialist dealer is prepared to pay for a
+ stock.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Ask: </emphasis>Indicates at what price the dealers are prepared to sell a
+ stock.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Last: </emphasis>Indicate the price at which the last trade in that
+ stock/security occurred at. This is the price most commonly quoted in the media.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Net Asset Value: </emphasis>Are typically used for mutual funds. They are
+ calculated on the net value of the fund's assets.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Unknown: </emphasis>Use this if the type of price quoted is not known.</para>
+ </listitem>
+
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Price: </emphasis>The actual price of the commodity.</para>
+ </listitem>
+ </itemizedlist>
+
+ <sect2 id="invest-stockprice-manual">
+ <title>Adding a stock price manually</title>
+
+ <para>To add a new price, click on <guilabel>Add</guilabel>, and enter the details of the security and
+ price into the dialog box. To edit an existing price, select the price
+ in the price list, click the <guilabel>Edit</guilabel> button, and edit the figures.</para>
+
+ <para>To remove just one price, select the price and click the <guilabel>Remove</guilabel>
+ button. If you want to remove all prices older than a certain date,
+ click on the <guilabel>Remove Old</guilabel> button and enter the details in the dialog
+ box.</para>
+
+ <para>A pop-up will display with the message
+ <emphasis role="bold">"Delete all stock prices based upon the criteria below:".</emphasis> Enter the
+ date of the last price you wish to delete.</para>
+
+ <para>Two check-boxes are below the date field;</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>Delete manually entered prices</guilabel> - If checked, delete manually entered stock
+ prices dated earlier than the specified date. Otherwise only stock prices added by Finance::Quote will
+ be deleted.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Delete last price for a stock</guilabel> - If checked, delete all prices before the
+ specified date. Otherwise the last stock price dated before the date will be kept and all earlier
+ quotes deleted.</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+
+ <sect2 id="invest-stockprice-online1">
+ <title>Configuring for use of the "<guilabel>Get Quotes</guilabel>" button</title>
+
+ <para>To support on-line quotations for a particular stock or mutual
+ fund account, you must first enable on-line price quoting and select a
+ price source in the Security. This is described in detail in the "Configuring Securities for Online
+ Quotes" (<xref linkend="invest-stockprice-online3"></xref>) section of Using the Security Editor.
+ Once on-line quotes are enabled, and Finance::Quote is installed, you can update prices for your stocks and
+ mutual funds manually by clicking the <guilabel>Get Quotes</guilabel> button.</para>
+ </sect2>
+ </sect1>
+
+ <sect1 id="tool-security-edit">
+ <title>Security Editor</title>
+
+ <para>The Security Editor is used to create and edit commodities that are used by mutual fund and stock
+ type accounts. It also shows the details of National Currencies that are used by &app;.</para>
+
+ <para>To show the details for National Currencies click the <guilabel>Show National Currencies</guilabel>
+ check-box at the bottom of the screen.</para>
+
+ <para>Each entry in the editor shows the details used by the security/currency:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Type:</emphasis> Indicates for stocks the exchange on which a stock is
+ traded. For mutual funds use the FUND type. If your commodity is not of one of these types, you can
+ create a new type by typing it in the box. For national currencies the type is ISO4217. ISO-4217
+ is an international standard which defines unique three-letter symbols for each currency. National
+ currencies are not user editable.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Symbol:</emphasis> Indicates the symbol or abbreviation for the
+ commodity. This is usually the ticker symbol (for stocks) or other unique abbreviation for the commodity.
+ If the commodity is traded on any public exchange, it is important to use the same identifier
+ used on that exchange. For national currencies the symbol is the ISO-4217 currency code.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Name:</emphasis> The full name of the commodity is a recognizable name
+ such as "US Dollars" or "IBM Common Stock".</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Code:</emphasis> This is any numeric or alphanumeric code that is used
+ to identify the commodity. The CUSIP code is a unique identifying numeric string that is associated with
+ every stock, bond or mutual fund, and most kinds of traded options, futures and commodities. This code is
+ not required.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Fraction:</emphasis> This is the smallest traded unit of the commodity,
+ expressed as a fraction of a single nominal unit. This unit is used by &app; accounts as the default
+ fraction for trades in the commodity.</para>
+ </listitem>
+ </itemizedlist>
+
+ <sect2 id="tool-commodity">
+ <title>Adding or Editing a Commodity</title>
+
+ <para>To add a new commodity (stock, or mutual fund), click on <guilabel>Add</guilabel>, and enter the
+ details of the commodity into the <emphasis role="bold">New Security</emphasis> dialog box. To edit an
+ existing commodity, select the commodity from the Commodities list, click the <guilabel>Edit</guilabel>
+ button, and edit the <emphasis role="bold">Edit Security</emphasis> dialog box. To remove a commodity,
+ select the commodity and click the <guilabel>Remove</guilabel> button.</para>
+
+ <para>The fields in the New/Edit Security screens are the same as defined for the Security Editor
+ <xref linkend="tool-security-edit"></xref>. Below these fields are the options for Online Quotes.</para>
+
+ </sect2>
+
+ <sect2 id="invest-stockprice-online3">
+ <title>Configuring Securities/Currencies for On-Line Retrieval of Prices</title>
+
+ <para>To support on-line quotations for a particular stock or mutual fund account, you must first enable
+ on-line price quoting and select a price source in the Security Editor. Online currency quotes require
+ only that the check-box for Online quotes and the timezone be selected, and that the <quote>Get Quotes</quote>
+ box be checked in the Security Editor.</para>
+
+ <para>Detailed instructions are in the section on Creating New Accounts.
+ <xref linkend="Online-price-setup"></xref></para>
+
+ </sect2>
+
+ </sect1>
+
+ <sect1 id="tool-calc">
+ <title>Financial Calculator</title>
+
+ <para>The Financial Calculator is used to calculate compound interest. It provides a way of entering four of
+ the five parameters of a compound interest calculation and then calculating the remaining figure.</para>
+
+ <para>The calculator is split into two panes. The left pane has five fields with a <guilabel>Calculate</guilabel>
+ button and a <guilabel>Clear</guilabel> button. The <guilabel>Calculate</guilabel> button is used to select
+ the figure to calculate. The <guilabel>Clear</guilabel> button is used to clear any amount in the field.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><emphasis role="bold">Payment Periods:</emphasis> This field is used to select the number of
+ payments you wish to use in the calculation.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Interest Rate:</emphasis> This field is used for the interest rate
+ percentage.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Present Value:</emphasis> This field usually contains the amount you
+ have borrowed. It is the base amount you wish to compound.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Periodic Payment:</emphasis> This field contains the amount that is the
+ payment for the period selected (IE monthly, weekly, etc). If it
+ is for repaying a loan it should be a negative number.</para>
+ </listitem>
+
+ <listitem>
+ <para><emphasis role="bold">Future Value:</emphasis> This field contains the final value at the end
+ of the periods above. If we are repaying a loan in full it would be '0'.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>The right pane contains buttons to select what sort of payments and compounding is used for the left
+ pane calculations.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para><guibutton>Compounding:</guibutton> This button allows you to select the interval used if the
+ <guilabel>Discrete Compounding</guilabel> button is selected.</para>
+ </listitem>
+
+ <listitem>
+ <para><guibutton>Payments:</guibutton> This button allows you to select the interval used for the Payment
+ Periods field.</para>
+ </listitem>
+
+ <listitem>
+ <para><guibutton>End of Period Payments:</guibutton> Use this button if the payment is at the end of
+ the period.</para>
+ </listitem>
+
+ <listitem>
+ <para><guibutton>Beginning of Period Payments:</guibutton> Use this button if the payment
+ is at the beginning of the period.</para>
+ </listitem>
+
+ <listitem>
+ <para><guibutton>Discrete Compounding:</guibutton> This button is used where interest is
+ charged at a discrete interval defined by the <guibutton>Compounding</guibutton> button above.</para>
+ </listitem>
+
+ <listitem>
+ <para><guibutton>Continuous Compounding:</guibutton> This button is used when the
+ interest is charged continuously.</para>
+ </listitem>
+
+ <listitem>
+ <para><guibutton>Payment Total:</guibutton> This field shows the total amount paid.</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Examples of using the Financial Calculator are given in the Tutorial and Concepts Guide.
+ <ulink url="http://svn.gnucash.org/docs/guide/loans_calcs1.html"> &app; Tutorial and Concepts Guide's
+ Chapter on Loans</ulink>
+ </para>
+
+ </sect1>
+
+</chapter>
Deleted: gnucash-docs/branches/2.2/help/C/Help_ch_Tools_Druids.xml
===================================================================
--- gnucash-docs/branches/2.2/help/C/Help_ch_Tools_Druids.xml 2010-11-07 22:48:55 UTC (rev 19773)
+++ gnucash-docs/branches/2.2/help/C/Help_ch_Tools_Druids.xml 2010-11-07 23:00:03 UTC (rev 19774)
@@ -1,2028 +0,0 @@
-<!--
- (Do not remove this comment block.)
- Version: 2.0.x
- Last modified: April 15th 2007
- modified: August 12th 2006
- modified: February 28th 2005
-
- Maintainers:
- Chris Lyttle <chris at wilddev.net>
- Neil Williams <linux at codehelp.co.uk>
-
- Author:
- Chris Lyttle <chris at wilddev.net>
- Translators:
- (translators put your name and email here)
--->
-
-<chapter id="ch_AccRegTools">
- <title>Tools & Druids</title>
-
- <para>There are many specialized Tools used in &app;. These tools enable access to the enhanced functionality
- in &app;. These tools are accessed via the <guimenu>Tools</guimenu> option from any window that displays a
- <guimenu>Tools</guimenu> menu. Several of these tools may not be displayed depending on if your
- software was not configured to support Online banking, or the tools appropriate for the current window.</para>
-
- <sect1 id="tool-find">
- <title>Find Transactions</title>
-
- <para>Find Transactions is used to search for transactions in &app;
- and display the results in a register window. The title bar of the
- Find Transactions dialog contains 'Search For...' and the first line
- of the dialog has 'Split Search'. In other search dialogs used in
- &app; the first line contains a different description but the same
- basic layout.</para>
-
- <note><para>The <guilabel>Find</guilabel> tool will also search for; a Customer, an Invoice, a Job, a Vendor,
- Bill(s), Employee(s), or Expense Voucher(s). The target of the search is determined by where the tools is
- invoked. Access to the Tool via <guimenu>Business > (Customer/Vendor/Employee) > ... </guimenu>.
- </para></note>
-
- <para>To open the Find Transactions dialog in the Account Tree Window
- go to the Tools menu and select Find Transactions or type menu
- shortcut Ctrl-F. To open the Find Transactions dialog in the Account
- Register Window go to the Edit menu and select Find... or type menu
- shortcut F6.</para>
-
- <para>There are two panes in the search dialog. The top pane contains
- the Search Criteria buttons and the bottom pane contains the Type of
- Search selection.</para>
-
- <para>There are two buttons in the top of the Search Criteria pane.
- The left button allows you to add another criteria row to search for
- multiple criteria. The existing criteria row needs to be completed
- before adding a new row. The right button is used to Search for items
- where all criteria are met or Search for items where any criteria are
- met. The all criteria are met search requires all of the criteria rows
- to have at least one match. The any criteria are met search requires
- only one of the criteria rows to be matched.</para>
-
- <para>The criteria row is used to combine different criteria buttons.
- The following table describes the possible button combinations (regex
- means regular expression search);</para>
-
- <table frame="topbot" id="tool-find-buttons">
- <title>Search criteria buttons.</title>
-
- <tgroup cols="8">
- <thead>
- <row>
- <entry><para>Button 1</para></entry>
-
- <entry><para>Button2</para></entry>
-
- <entry><para>Button3</para></entry>
-
- <entry><para>Button4</para></entry>
-
- <entry><para>Button5</para></entry>
-
- <entry><para>Button 6</para></entry>
-
- <entry><para>Button 7</para></entry>
-
- <entry><para>Button 8</para></entry>
- </row>
- </thead>
-
- <tbody>
- <row>
- <entry><para>Description</para></entry>
-
- <entry><para>contains</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Description</para></entry>
-
- <entry><para>does not contain</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Description</para></entry>
-
- <entry><para>matches regex</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Description</para></entry>
-
- <entry><para>does not match regex</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Memo</para></entry>
-
- <entry><para>contains</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Memo</para></entry>
-
- <entry><para>does not contain</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Memo</para></entry>
-
- <entry><para>matches regex</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Memo</para></entry>
-
- <entry><para>does not match regex</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Number</para></entry>
-
- <entry><para>contains</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Number</para></entry>
-
- <entry><para>does not contain</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Number</para></entry>
-
- <entry><para>matches regex</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Number</para></entry>
-
- <entry><para>does not match regex</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Action</para></entry>
-
- <entry><para>contains</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Action</para></entry>
-
- <entry><para>does not contain</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Action</para></entry>
-
- <entry><para>matches regex</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Action</para></entry>
-
- <entry><para>does not match regex</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Note</para></entry>
-
- <entry><para>contains</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Note</para></entry>
-
- <entry><para>does not contain</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Note</para></entry>
-
- <entry><para>matches regex</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Note</para></entry>
-
- <entry><para>does not match regex</para></entry>
-
- <entry><para>Criteria entry field</para></entry>
-
- <entry><para>Is entry Case Insensitive?</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Date Posted</para></entry>
-
- <entry><para>is before</para></entry>
-
- <entry><para>Date selection field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Date Posted</para></entry>
-
- <entry><para>is before or on</para></entry>
-
- <entry><para>Date selection field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Date Posted</para></entry>
-
- <entry><para>is on</para></entry>
-
- <entry><para>Date selection field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Date Posted</para></entry>
-
- <entry><para>is not on</para></entry>
-
- <entry><para>Date selection field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Date Posted</para></entry>
-
- <entry><para>is after</para></entry>
-
- <entry><para>Date selection field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Date Posted</para></entry>
-
- <entry><para>is on or after</para></entry>
-
- <entry><para>Date selection field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has credits or debits</para></entry>
-
- <entry><para>less than</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has credits or debits</para></entry>
-
- <entry><para>less than or equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has credits or debits</para></entry>
-
- <entry><para>equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has credits or debits</para></entry>
-
- <entry><para>not equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has credits or debits</para></entry>
-
- <entry><para>greater than</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has credits or debits</para></entry>
-
- <entry><para>greater than or equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has credits</para></entry>
-
- <entry><para>less than</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has credits</para></entry>
-
- <entry><para>less than or equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has credits</para></entry>
-
- <entry><para>equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has credits</para></entry>
-
- <entry><para>not equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has credits</para></entry>
-
- <entry><para>greater than</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has credits</para></entry>
-
- <entry><para>greater than or equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has debits</para></entry>
-
- <entry><para>less than</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has debits</para></entry>
-
- <entry><para>less than or equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has debits</para></entry>
-
- <entry><para>equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has debits</para></entry>
-
- <entry><para>not equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has debits</para></entry>
-
- <entry><para>greater than</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Value</para></entry>
-
- <entry><para>has debits</para></entry>
-
- <entry><para>greater than or equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Shares</para></entry>
-
- <entry><para>less than</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Shares</para></entry>
-
- <entry><para>less than or equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Shares</para></entry>
-
- <entry><para>equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Shares</para></entry>
-
- <entry><para>not equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Shares</para></entry>
-
- <entry><para>greater than</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Shares</para></entry>
-
- <entry><para>greater than or equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Share Price</para></entry>
-
- <entry><para>less than</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Share Price</para></entry>
-
- <entry><para>less than or equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Share Price</para></entry>
-
- <entry><para>equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Share Price</para></entry>
-
- <entry><para>not equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Share Price</para></entry>
-
- <entry><para>greater than</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Share Price</para></entry>
-
- <entry><para>greater than or equal to</para></entry>
-
- <entry><para>Amount entry field</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Reconcile</para></entry>
-
- <entry><para>is</para></entry>
-
- <entry><para>Not Cleared</para></entry>
-
- <entry><para>Cleared</para></entry>
-
- <entry><para>Reconciled</para></entry>
-
- <entry><para>Frozen</para></entry>
-
- <entry><para>Voided</para></entry>
-
- <entry><para>Remove row</para></entry>
- </row>
-
- <row>
- <entry><para>Reconcile</para></entry>
-
- <entry><para>is not</para></entry>
-
- <entry><para>Not Cleared</para></entry>
-
- <entry><para>Cleared</para></entry>
-
- <entry><para>Reconciled</para></entry>
-
- <entry><para>Frozen</para></entry>
-
- <entry><para>Voided</para></entry>
-
- <entry><para>Remove row</para></entry>
- </row>
-
- <row>
- <entry><para>Balanced</para></entry>
-
- <entry><para>is</para></entry>
-
- <entry><para>set true</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Balanced</para></entry>
-
- <entry><para>is not</para></entry>
-
- <entry><para>set true</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Account</para></entry>
-
- <entry><para>matches any account</para></entry>
-
- <entry><para>Choose Accounts</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>Account</para></entry>
-
- <entry><para>matches no account</para></entry>
-
- <entry><para>Choose Accounts</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
-
- <row>
- <entry><para>All Accounts</para></entry>
-
- <entry><para>matches all account</para></entry>
-
- <entry><para>Choose Accounts</para></entry>
-
- <entry><para>Remove row</para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
-
- <entry><para></para></entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <para>The Account button performs a search where the accounts selected
- in the Choose Accounts dialog will both be searched individually for
- results. This means that a match in any of the selected accounts will
- either be displayed (matches any account) or discarded (matches no
- account).</para>
-
- <para>The All Accounts button performs a search where accounts
- selected in the Choose Accounts dialog will only return results that
- match in both accounts.</para>
-
- <para>There are four selections in the Type of Search pane. When a new
- search is started only the New Search button is selectable. The other
- buttons become selectable only when the Search Results register window
- is visible.</para>
-
- <itemizedlist>
- <listitem>
- <para>New Search: Perform a new transaction search</para>
- </listitem>
-
- <listitem>
- <para>Refine current search: Search within the results of the
- previous search.</para>
- </listitem>
-
- <listitem>
- <para>Add results to current search: Search based on the first set
- of criteria or the new criteria.</para>
- </listitem>
-
- <listitem>
- <para>Delete results from current search: Discard any results that
- match the previous search results.</para>
- </listitem>
- </itemizedlist>
-
- </sect1>
-
-
- <sect1 id="trans-sched-slr">
- <title>Since Last Run Druid</title>
-
- <para>The Since Last Run druid is run automatically when &app; is started. It is
- used to enter into the register any transactions that are due to be automatically
- entered. The run on &app; start can be altered in the preferences. To run the
- Since Last Run druid manually go to <guilabel>Actions -> Scheduled Transactions ->
- Since Last Run...</guilabel></para>
-
- <para>The Since Last Run druid will automatically skip any screens that have no
- transactions. The following describes every possible screen the druid will show.
- The three buttons at the very bottom of the screen will not change while using
- the druid.</para>
-
- <itemizedlist>
- <listitem>
- <para>The <guilabel>Cancel</guilabel> button is used to exit the druid and cancel entering the
- transactions. Any selections you have made in this druid up to this point will
- be lost.</para>
- </listitem>
-
- <listitem>
- <para>The <guilabel>Back</guilabel> button will bring up the previous screen so you can change a
- selection made on that screen.</para>
- </listitem>
-
- <listitem>
- <para>The <guilabel>Forward</guilabel> button will bring up the next screen so you can continue though
- the druid.</para>
- </listitem>
- </itemizedlist>
-
- <para>The first screen shows <guilabel>Transaction Reminders</guilabel> page. This lists scheduled
- transactions that have been set to give a reminder a number of days in advance. The
- screen contains three columns. The first column contains the name of the scheduled
- transaction and the date it is due. The second column contains the Frequency of the
- scheduled transaction. The third column has the number of Days Away the transaction
- is due to be entered. To create any transactions in the list instead of just being
- reminded, select the date line. This will add it to the list of transactions on the
- To-Create Transaction Preparation page.</para>
-
- <para>The next screen shows the <guilabel>Auto-Created Transactions Notification</guilabel> page. This
- lists scheduled transactions that have been set to be automatically created and
- notify when they are created. Each transaction is presented in a register view that
- shows the details of the splits in the transaction.</para>
-
- <para>The next screen shows the <guilabel>To-Create Transaction Preparation</guilabel> page. This lists
- scheduled transactions that are due to be entered in the register. This screen is
- divided into three panes. The top left pane contains the list of transactions due to
- be automatically entered. The top right pane allows you to change the Disposition
- and has a read only view of the Variables used to create the transaction. The bottom
- pane contains a read only view of the transactions due to be entered.</para>
-
- <para>The next screen shows the <guilabel>Created Transaction Review</guilabel> page. This screen displays
- the list of transactions about to be created and allows for final changes to be
- made. The list is presented in a register view that shows the details of the splits
- in the transaction. This is editable in the same way transactions are able to be
- edited in the register.</para>
-
- <para>The last screen shows the <guilabel>Obsolete Scheduled Transactions</guilabel> page. This screen
- displays a list of scheduled transactions that are able to be deleted as the
- schedule is completed. Select the ones to be removed.</para>
-
- <itemizedlist>
- <listitem>
- <para>The <guilabel>Cancel</guilabel> button is used to exit the druid and cancel creating the
- scheduled transactions. Any selections you have made in this druid up to this
- point will be lost.</para>
- </listitem>
-
- <listitem>
- <para>The <guilabel>Back</guilabel> button will bring up the previous screen so you can change a
- selection made on that screen.</para>
- </listitem>
-
- <listitem>
- <para>The <guilabel>Finish</guilabel> button creates the accounts you have selected.</para>
- </listitem>
- </itemizedlist>
-
- <para>The Since Last Run druid has now added the scheduled transactions to the
- register.</para>
- </sect1>
-
- <sect1 id="trans-sched-loans">
- <title>Mortgage & Loan Repayment Druid</title>
-
- <para>This druid creates a loan repayment scheduled transaction. When used to setup
- a scheduled transaction, the druid creates a variable formula so that the
- compounding interest is correctly calculated. To start this druid manually go to
- <guilabel>Actions -> Scheduled Transactions -> Mortgage and Loan Repayment...</guilabel> </para>
-
- <para>The Mortgage and Loan Repayment druid opens with a screen that briefly
- describes what this druid does. The three buttons at the very bottom of the screen
- will not change while using the druid.</para>
-
- <itemizedlist>
- <listitem>
- <para>The <guilabel>Cancel</guilabel> button is used to exit the druid and cancel creating the
- scheduled transaction. Any selections you have made in this druid up to this
- point will be lost.</para>
- </listitem>
-
- <listitem>
- <para>The <guilabel>Back</guilabel> button will bring up the previous screen so you can change a
- selection made on that screen.</para>
- </listitem>
-
- <listitem>
- <para>The <guilabel>Forward</guilabel> button will bring up the next screen so you can continue
- though the druid.</para>
- </listitem>
- </itemizedlist>
-
- <para>The next screen allows you to enter the basic loan information. This is
- usually the information provided by the bank when loan and disclosure documents
- are given to the borrower. Here you can also setup an account that the scheduled
- transaction will use to enter the payment transaction.</para>
-
- <itemizedlist>
- <listitem>
- <para><guilabel>Loan Account:</guilabel> Choose an account for the loan payment transactions or use
- New... to setup a new account for the transactions.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Loan Amount:</guilabel> Enter the amount of the loan.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Interest Rate:</guilabel> Enter the loan interest rate.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Type:</guilabel> Choose the type of loan. If an adjustable rate is used the
- frequency screen is enabled.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Interest Rate Change Frequency:</guilabel> Choose the frequency for the rate change
- and the start date of the rate change.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Start Date:</guilabel> Choose the date the loan is starting on.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Length:</guilabel> Enter the length of the loan.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Months Remaining:</guilabel> This should be automatically calculated. Choose how many
- months are remaining on the loan.</para>
- </listitem>
- </itemizedlist>
-
- <para>The next screen is used to set escrow, insurance and tax options for the
- loan. It is mainly used for mortgage payments. When each of the options here is set,
- this enables additional pages in the druid to setup those portions of the payments.
- All of the pages will be described here, even though some may not show if that
- option is not chosen.</para>
-
- <itemizedlist>
- <listitem>
- <para>... utilize an escrow account for payments?: This selection enables the
- use of an account setup for tracking escrow payments. If the mortgage or loan
- uses an escrow account to pay taxes, insurance, etc then setup an account here.
- </para>
- </listitem>
-
- <listitem>
- <para>... pay "Taxes"?: adds an additional page to setup a scheduled transaction
- to pay taxes.</para>
- </listitem>
-
- <listitem>
- <para>... pay "Insurance"?: adds an additional page to setup a scheduled
- transaction to pay insurance payments.</para>
- </listitem>
- <listitem>
- <para>... pay "PMI"?: adds an additional page to setup a scheduled transaction to pay PMI payments.</para>
- </listitem>
- <listitem>
- <para>... pay "Other Expense"?: adds an additional page to setup a scheduled transaction to pay other
- expenses.</para>
- </listitem>
- </itemizedlist>
-
- <para>The next screen is used to setup the details of the scheduled transaction for the Loan Repayment.</para>
-
- <itemizedlist>
- <listitem>
- <para>Transaction Memo: The name entered here will be used as the name for the scheduled transaction,
- the description of the scheduled transaction and the memo.</para>
- </listitem>
-
- <listitem>
- <para>Payment Amount: Shows the variable used to calculate the payment amount.</para>
- </listitem>
-
- <listitem>
- <para>Payment From: Choose an account to pay the loan amount from.</para>
- </listitem>
-
- <listitem>
- <para>Principal To: Choose an account to transfer the principal part of the loan to.</para>
- </listitem>
-
- <listitem>
- <para>Interest To: Choose an account to transfer the interest part of the loan to.</para>
- </listitem>
-
- <listitem>
- <para>Remainder to: Choose an account to transfer the rest of the payment amount to.</para>
- </listitem>
-
- <listitem>
- <para>Repayment Frequency: Select the Frequency and start date for loan repayments.</para>
- </listitem>
- </itemizedlist>
-
- <para>The next screen is used to setup the details of the scheduled transaction for the Tax payment.</para>
-
- <itemizedlist>
- <listitem>
- <para>Transaction Memo: The name entered here will be used as the name for the scheduled transaction,
- the description of the scheduled transaction and the memo.</para>
- </listitem>
-
- <listitem>
- <para>Amount: Enter the payment amount.</para>
- </listitem>
-
- <listitem>
- <para>Payment From: Choose an account to pay the tax amount from.</para>
- </listitem>
-
- <listitem>
- <para>Payment To: Choose an account to transfer the tax payment to.</para>
- </listitem>
-
- <listitem>
- <para>Repayment Frequency: Select the Frequency and start date for tax payments.</para>
- </listitem>
- </itemizedlist>
-
- <para>The next screen is used to setup the details of the scheduled transaction for the Insurance payment.</para>
-
- <itemizedlist>
- <listitem>
- <para>Transaction Memo: The name entered here will be used as the name for the scheduled transaction,
- the description of the scheduled transaction and the memo.</para>
- </listitem>
- <listitem>
- <para>Amount: Enter the payment amount.</para>
- </listitem>
-
- <listitem>
- <para>Payment From: Choose an account to pay the insurance amount from.</para>
- </listitem>
-
- <listitem>
- <para>Payment To: Choose an account to transfer the insurance payment to.</para>
- </listitem>
-
- <listitem>
- <para>Repayment Frequency: Select the Frequency and start date for insurance payments.</para>
- </listitem>
- </itemizedlist>
-
- <para>The next screen is used to setup the details of the scheduled transaction for the PMI payment.</para>
-
- <itemizedlist>
- <listitem>
- <para>Transaction Memo: The name entered here will be used as the name for the scheduled transaction,
- the description of the scheduled transaction and the memo.</para>
- </listitem>
-
- <listitem>
- <para>Amount: Enter the payment amount.</para>
- </listitem>
-
- <listitem>
- <para>Payment From: Choose an account to pay the PMI amount from.</para>
- </listitem>
-
- <listitem>
- <para>Payment To: Choose an account to transfer the PMI payment to.</para>
- </listitem>
-
- <listitem>
- <para>Repayment Frequency: Select the Frequency and start date for PMI payments.</para>
- </listitem>
- </itemizedlist>
-
- <para>The next screen is used to setup the details of the scheduled transaction for the Other Expense payment.
- </para>
-
- <itemizedlist>
- <listitem>
- <para>Transaction Memo: The name entered here will be used as the name for the scheduled transaction,
- the description of the scheduled transaction and the memo.</para>
- </listitem>
-
- <listitem>
- <para>Amount: Enter the payment amount.</para>
- </listitem>
-
- <listitem>
- <para>Payment From: Choose an account to pay the other expense amount from.</para>
- </listitem>
-
- <listitem>
- <para>Payment To: Choose an account to transfer the other expense payment to.</para>
- </listitem>
-
- <listitem>
- <para>Repayment Frequency: Select the Frequency and start date for other expense payments.</para>
- </listitem>
- </itemizedlist>
-
- <para>The last screen gives you a list of three choices to finish the druid.</para>
-
- <itemizedlist>
- <listitem>
- <para>The Cancel button is used to exit the druid and cancel creating a new loan scheduled transaction.
- Any selections you have made in this druid up to this point will be lost.</para>
- </listitem>
-
- <listitem>
- <para>The Back button will bring up the previous screen so you can change a selection made on that screen.
- </para>
- </listitem>
-
- <listitem>
- <para>The Finish button creates the scheduled transaction.</para>
- </listitem>
- </itemizedlist>
-
- <para>You should now have the Mortgage or Loan Repayment scheduled transaction
- setup.</para>
-
- </sect1>
-
- <sect1 id="stock-split">
- <title>Recording a Stock Split</title>
-
- <para>Stock splits commonly occur when a company decides its stock price is to
- expensive for individual investors to buy the stock. Splits have the effect of
- lowering the price of a single share while keeping the value of shares owned by
- investors who have already purchased shares.</para>
-
- <sect2 id="stock-split-druid">
- <title>Stock Split Druid</title>
-
- <para>&app; uses the Stock Split druid to record stock splits. This provides a
- way of entering the details of the stock split and also any change in stock price
- or cash disbursement as a result of the stock split.</para>
-
- <para>The Stock Split druid is accessed by going to <guimenu>Actions -> Stock Split...</guimenu>
- </para>
-
- <para>The Stock Split druid opens with a screen that briefly describes what this
- druid does. The three buttons at the very bottom of the screen will not change
- while using the druid.</para>
-
- <itemizedlist>
- <listitem>
- <para>The <guibutton>Cancel</guibutton> button is used to exit the druid and cancel entering the stock
- split information. Any selections you have made in this druid up to this point
- will be lost.</para>
- </listitem>
-
- <listitem>
- <para>The <guibutton>Back</guibutton> button will bring up the previous screen so you can change a
- selection made on that screen.</para>
- </listitem>
-
- <listitem>
- <para>The <guibutton>Forward</guibutton> button will bring up the next screen so you can continue
- though the druid.</para>
- </listitem>
- </itemizedlist>
-
- <para>The next screen allows you to select a Stock Account. Select an account from
- the list to record a stock split or merger.</para>
-
- <itemizedlist>
- <listitem>
- <para><guilabel>Account:</guilabel> Lists the &app; account name for the stock.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Symbol:</guilabel> The stock symbol for the stock associated with this account.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Shares:</guilabel> The amount of shares that have been purchased in the account.</para>
- </listitem>
- </itemizedlist>
-
- <para>The next screen lets you set the Stock Split Details. The top part of the
- screen contains details used in creating the stock split transaction. </para>
-
- <itemizedlist>
- <listitem>
- <para><guilabel>Date:</guilabel> Choose the date of the stock split.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Share Distribution:</guilabel> Enter the amount of shares gained from the stock split.
- For a stock merger enter a negative number.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Description:</guilabel> Enter a description or leave as the default.</para>
- </listitem>
- </itemizedlist>
-
- <para>The bottom part of the screen contains details used to record a price for the
- split (optional).</para>
-
- <itemizedlist>
- <listitem>
- <para><guilabel>New Price:</guilabel> Enter the price of the shares on the day of the stock split.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Currency:</guilabel> Choose the currency of the shares.</para>
- </listitem>
- </itemizedlist>
-
- <para>The next screen lets you enter a transaction for a cash disbursement (Cash In
- Lieu) as a result of the stock split (optional).</para>
-
- <itemizedlist>
- <listitem>
- <para><guilabel>Cash Amount:</guilabel> Enter the amount of the Cash disbursement.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Memo:</guilabel> Enter a memo or leave as the default.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Income Account:</guilabel> Choose an Income Account for the disbursement.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Asset Account:</guilabel> Choose an Asset Account for the disbursement.</para>
- </listitem>
- </itemizedlist>
-
- <para>The last screen gives you a list of three choices to finish the druid.</para>
-
- <itemizedlist>
- <listitem>
- <para>The <guibutton>Cancel</guibutton> button is used to exit the druid and cancel creating the
- Stock Split transactions. Any selections you have made in this druid up to
- this point will be lost.</para>
- </listitem>
-
- <listitem>
- <para>The <guibutton>Back</guibutton> button will bring up the previous screen so you can change a
- selection made on that screen.</para>
- </listitem>
-
- <listitem>
- <para>The <guibutton>Finish</guibutton> button creates the transactions for the Stock Split.</para>
- </listitem>
- </itemizedlist>
-
- <para>You should now have successfully entered the Stock Split or Merger.</para>
- </sect2>
- </sect1>
-
- <sect1 id="tools-on-line-banking">
- <title>HBCI (Online Banking) Setup Wizard</title>
-
-<note><para>This section is "under construction - any input will be welcome !!".</para></note>
-
- <para>The HBCI Wizard is used to create and edit data to enable access to Online banking transactions.
- Currently the best instruction for this process are in the &app; wiki at
- <ulink url="http://wiki.gnucash.org/wiki/Setting_up_OFXDirectConnect_in_&app;_2">Setting up OFXDirectConnect
- in &app; 2</ulink>. If <guilabel>HBCI Setup</guilabel> does not appear in your Tools menus verify that you
- are in an Account Tree or Register tab.
- </para>
-
- </sect1>
-
- <sect1 id="tool-price">
- <title>Price Editor</title>
-
- <para>The Price Editor is used to track/modify the value of a currency, mutual fund and stocks.
- It provides a unified interface to updating the values of these commodities and is able to update manually
- or through on-line quotes.</para>
-
- <para>Each entry in the editor shows a record of a security/commodity price(s):</para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Security: </emphasis>The Security/commodity being priced. The display is sorted
- by the "exchange" that the individual securities are listed on. The list is expanded by clicking on the
- "caret" on the left of the name.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Currency: </emphasis>The currency the price is recorded in.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Date: </emphasis>The date the price was recorded.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Source: </emphasis>The source of the commodities price quote. Typically, this
- will be either "user:price-editor", indicating you entered it directly, or "Finance::Quote", indicating
- that it was retrieved from an on-line source by the Finance::Quote module.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Type: </emphasis>There are several different types
- of stock price quotes.</para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Bid: </emphasis>Indicates what a specialist dealer is prepared to pay for a
- stock.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Ask: </emphasis>Indicates at what price the dealers are prepared to sell a
- stock.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Last: </emphasis>Indicate the price at which the last trade in that
- stock/security occurred at. This is the price most commonly quoted in the media.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Net Asset Value: </emphasis>Are typically used for mutual funds. They are
- calculated on the net value of the fund's assets.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Unknown: </emphasis>Use this if the type of price quoted is not known.</para>
- </listitem>
-
- </itemizedlist>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Price: </emphasis>The actual price of the commodity.</para>
- </listitem>
- </itemizedlist>
-
- <sect2 id="invest-stockprice-manual">
- <title>Adding a stock price manually</title>
-
- <para>To add a new price, click on <guilabel>Add</guilabel>, and enter the details of the security and
- price into the dialog box. To edit an existing price, select the price
- in the price list, click the <guilabel>Edit</guilabel> button, and edit the figures.</para>
-
- <para>To remove just one price, select the price and click the <guilabel>Remove</guilabel>
- button. If you want to remove all prices older than a certain date,
- click on the <guilabel>Remove Old</guilabel> button and enter the details in the dialog
- box.</para>
-
- <para>A pop-up will display with the message
- <emphasis role="bold">"Delete all stock prices based upon the criteria below:".</emphasis> Enter the
- date of the last price you wish to delete.</para>
-
- <para>Two check-boxes are below the date field;</para>
-
- <itemizedlist>
- <listitem>
- <para><guilabel>Delete manually entered prices</guilabel> - If checked, delete manually entered stock
- prices dated earlier than the specified date. Otherwise only stock prices added by Finance::Quote will
- be deleted.</para>
- </listitem>
-
- <listitem>
- <para><guilabel>Delete last price for a stock</guilabel> - If checked, delete all prices before the
- specified date. Otherwise the last stock price dated before the date will be kept and all earlier
- quotes deleted.</para>
- </listitem>
- </itemizedlist>
- </sect2>
-
- <sect2 id="invest-stockprice-online1">
- <title>Configuring for use of the "<guilabel>Get Quotes</guilabel>" button</title>
-
- <para>To support on-line quotations for a particular stock or mutual
- fund account, you must first enable on-line price quoting and select a
- price source in the Security. This is described in detail in the "Configuring Securities for Online
- Quotes" (<xref linkend="invest-stockprice-online3"></xref>) section of Using the Security Editor.
- Once on-line quotes are enabled, and Finance::Quote is installed, you can update prices for your stocks and
- mutual funds manually by clicking the <guilabel>Get Quotes</guilabel> button.</para>
- </sect2>
- </sect1>
-
- <sect1 id="tool-security-edit">
- <title>Security Editor</title>
-
- <para>The Security Editor is used to create and edit commodities that are used by mutual fund and stock
- type accounts. It also shows the details of National Currencies that are used by &app;.</para>
-
- <para>To show the details for National Currencies click the <guilabel>Show National Currencies</guilabel>
- check-box at the bottom of the screen.</para>
-
- <para>Each entry in the editor shows the details used by the security/currency:</para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Type:</emphasis> Indicates for stocks the exchange on which a stock is
- traded. For mutual funds use the FUND type. If your commodity is not of one of these types, you can
- create a new type by typing it in the box. For national currencies the type is ISO4217. ISO-4217
- is an international standard which defines unique three-letter symbols for each currency. National
- currencies are not user editable.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Symbol:</emphasis> Indicates the symbol or abbreviation for the
- commodity. This is usually the ticker symbol (for stocks) or other unique abbreviation for the commodity.
- If the commodity is traded on any public exchange, it is important to use the same identifier
- used on that exchange. For national currencies the symbol is the ISO-4217 currency code.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Name:</emphasis> The full name of the commodity is a recognizable name
- such as "US Dollars" or "IBM Common Stock".</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Code:</emphasis> This is any numeric or alphanumeric code that is used
- to identify the commodity. The CUSIP code is a unique identifying numeric string that is associated with
- every stock, bond or mutual fund, and most kinds of traded options, futures and commodities. This code is
- not required.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Fraction:</emphasis> This is the smallest traded unit of the commodity,
- expressed as a fraction of a single nominal unit. This unit is used by &app; accounts as the default
- fraction for trades in the commodity.</para>
- </listitem>
- </itemizedlist>
-
- <sect2 id="tool-commodity">
- <title>Adding or Editing a Commodity</title>
-
- <para>To add a new commodity (stock, or mutual fund), click on <guilabel>Add</guilabel>, and enter the
- details of the commodity into the <emphasis role="bold">New Security</emphasis> dialog box. To edit an
- existing commodity, select the commodity from the Commodities list, click the <guilabel>Edit</guilabel>
- button, and edit the <emphasis role="bold">Edit Security</emphasis> dialog box. To remove a commodity,
- select the commodity and click the <guilabel>Remove</guilabel> button.</para>
-
- <para>The fields in the New/Edit Security screens are the same as defined for the Security Editor
- <xref linkend="tool-security-edit"></xref>. Below these fields are the options for Online Quotes.</para>
-
- </sect2>
-
- <sect2 id="invest-stockprice-online3">
- <title>Configuring Securities/Currencies for On-Line Retrieval of Prices</title>
-
- <para>To support on-line quotations for a particular stock or mutual fund account, you must first enable
- on-line price quoting and select a price source in the Security Editor. Online currency quotes require
- only that the check-box for Online quotes and the timezone be selected, and that the <quote>Get Quotes</quote>
- box be checked in the Security Editor.</para>
-
- <para>Detailed instructions are in the section on Creating New Accounts.
- <xref linkend="Online-price-setup"></xref></para>
-
- </sect2>
-
- </sect1>
-
- <sect1 id="tool-calc">
- <title>Financial Calculator</title>
-
- <para>The Financial Calculator is used to calculate compound interest. It provides a way of entering four of
- the five parameters of a compound interest calculation and then calculating the remaining figure.</para>
-
- <para>The calculator is split into two panes. The left pane has five fields with a <guilabel>Calculate</guilabel>
- button and a <guilabel>Clear</guilabel> button. The <guilabel>Calculate</guilabel> button is used to select
- the figure to calculate. The <guilabel>Clear</guilabel> button is used to clear any amount in the field.</para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis role="bold">Payment Periods:</emphasis> This field is used to select the number of
- payments you wish to use in the calculation.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Interest Rate:</emphasis> This field is used for the interest rate
- percentage.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Present Value:</emphasis> This field usually contains the amount you
- have borrowed. It is the base amount you wish to compound.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Periodic Payment:</emphasis> This field contains the amount that is the
- payment for the period selected (IE monthly, weekly, etc). If it
- is for repaying a loan it should be a negative number.</para>
- </listitem>
-
- <listitem>
- <para><emphasis role="bold">Future Value:</emphasis> This field contains the final value at the end
- of the periods above. If we are repaying a loan in full it would be '0'.</para>
- </listitem>
- </itemizedlist>
-
- <para>The right pane contains buttons to select what sort of payments and compounding is used for the left
- pane calculations.</para>
-
- <itemizedlist>
- <listitem>
- <para><guibutton>Compounding:</guibutton> This button allows you to select the interval used if the
- <guilabel>Discrete Compounding</guilabel> button is selected.</para>
- </listitem>
-
- <listitem>
- <para><guibutton>Payments:</guibutton> This button allows you to select the interval used for the Payment
- Periods field.</para>
- </listitem>
-
- <listitem>
- <para><guibutton>End of Period Payments:</guibutton> Use this button if the payment is at the end of
- the period.</para>
- </listitem>
-
- <listitem>
- <para><guibutton>Beginning of Period Payments:</guibutton> Use this button if the payment
- is at the beginning of the period.</para>
- </listitem>
-
- <listitem>
- <para><guibutton>Discrete Compounding:</guibutton> This button is used where interest is
- charged at a discrete interval defined by the <guibutton>Compounding</guibutton> button above.</para>
- </listitem>
-
- <listitem>
- <para><guibutton>Continuous Compounding:</guibutton> This button is used when the
- interest is charged continuously.</para>
- </listitem>
-
- <listitem>
- <para><guibutton>Payment Total:</guibutton> This field shows the total amount paid.</para>
- </listitem>
- </itemizedlist>
-
- <para>Examples of using the Financial Calculator are given in the Tutorial and Concepts Guide.
- <ulink url="http://svn.gnucash.org/docs/guide/loans_calcs1.html"> &app; Tutorial and Concepts Guide's
- Chapter on Loans</ulink>
- </para>
-
- </sect1>
-
-</chapter>
More information about the gnucash-changes
mailing list