gnucash-docs maint: Multiple changes pushed
John Ralls
jralls at code.gnucash.org
Sun Nov 13 12:17:55 EST 2016
Updated via https://github.com/Gnucash/gnucash-docs/commit/28259318 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/09b13337 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/b1f68171 (commit)
from https://github.com/Gnucash/gnucash-docs/commit/dde2cb79 (commit)
commit 282593184c5eb720c468ed2ab66f747318654931
Merge: dde2cb7 09b1333
Author: John Ralls <jralls at ceridwen.us>
Date: Sun Nov 13 09:16:26 2016 -0800
Merge Pull Request 71, Bug 755174 Help Document Lots in Account window, into maint
commit 09b13337cb88a80d832c20509ce5e3a09845d739
Author: goodvibes2 <chris.good at ozemail.com.au>
Date: Thu Nov 10 17:56:10 2016 +1100
Fix incorrect use of mdash
See discussion https://github.com/Gnucash/gnucash-docs/pull/71
diff --git a/guide/C/ch_invest.xml b/guide/C/ch_invest.xml
index 610a634..bcce28f 100644
--- a/guide/C/ch_invest.xml
+++ b/guide/C/ch_invest.xml
@@ -2757,8 +2757,8 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
<listitem>
<para>Find each new <emphasis>Realized Gain/Loss</emphasis>
- transaction in the security account register — they will
- have the same date as the sell transactions. Edit the <emphasis>
+ transaction in the security account register (they will
+ have the same date as the sell transactions). Edit the <emphasis>
Orphaned Gains-CCC</emphasis> transaction split to re-assign the
income account to a more meaningful income (or expense) gain or
loss account (e.g. <emphasis>Income:Long Term Capital
diff --git a/guide/C/ch_txns.xml b/guide/C/ch_txns.xml
index 1c01232..2ea8d52 100644
--- a/guide/C/ch_txns.xml
+++ b/guide/C/ch_txns.xml
@@ -966,12 +966,13 @@
</imageobject>
<textobject>
- <phrase><guilabel>Edit Scheduled Transaction</guilabel> —
- <guilabel>Overview</guilabel> tab</phrase>
+ <phrase>
+ <guimenuitem>Edit Scheduled Transaction</guimenuitem> window,
+ <guilabel>Overview</guilabel> tab</phrase>
</textobject>
- <caption><para><guilabel>Edit Scheduled Transaction</guilabel> —
- <guilabel>Overview</guilabel> tab</para></caption>
+ <caption><para><guimenuitem>Edit Scheduled Transaction</guimenuitem>
+ window, <guilabel>Overview</guilabel> tab</para></caption>
</mediaobject>
</screenshot>
@@ -1037,12 +1038,13 @@
</imageobject>
<textobject>
- <phrase><guilabel>Edit Scheduled Transaction</guilabel> —
- <guilabel>Frequency</guilabel> tab</phrase>
+ <phrase>
+ <guimenuitem>Edit Scheduled Transaction</guimenuitem> window,
+ <guilabel>Frequency</guilabel> tab</phrase>
</textobject>
- <caption><para><guilabel>Edit Scheduled Transaction</guilabel> —
- <guilabel>Frequency</guilabel> tab</para></caption>
+ <caption><para><guimenuitem>Edit Scheduled Transaction</guimenuitem>
+ window, <guilabel>Frequency</guilabel> tab</para></caption>
</mediaobject>
</screenshot>
@@ -1114,12 +1116,12 @@
</imageobject>
<textobject>
- <phrase><guilabel>Edit Scheduled Transaction</guilabel> —
- <guilabel>Template Transaction</guilabel> tab</phrase>
+ <phrase><guimenuitem>Edit Scheduled Transaction</guimenuitem>
+ window, <guilabel>Template Transaction</guilabel> tab</phrase>
</textobject>
- <caption><para><guilabel>Edit Scheduled Transaction</guilabel> —
- <guilabel>Template Transaction</guilabel> tab</para></caption>
+ <caption><para><guimenuitem>Edit Scheduled Transaction</guimenuitem>
+ window, <guilabel>Template Transaction</guilabel> tab</para></caption>
</mediaobject>
</screenshot>
diff --git a/help/C/Help_ch_Customize.xml b/help/C/Help_ch_Customize.xml
index edc09c6..2e14a2e 100644
--- a/help/C/Help_ch_Customize.xml
+++ b/help/C/Help_ch_Customize.xml
@@ -81,7 +81,9 @@
<title>Accounting Period</title>
<figure id="prefs-acct-period-fig">
- <title>The <guilabel>Preferences — Accounting Period</guilabel> tab</title>
+ <title>The <guimenuitem>Preferences</guimenuitem> window,
+ <guilabel>Accounting Period</guilabel> tab
+ </title>
<screenshot id="Prefer_Accounting-Period">
<mediaobject>
<imageobject role="html">
@@ -103,16 +105,16 @@
<itemizedlist>
<listitem>
- <para><guilabel>Start Date</guilabel> — This item sets the accounting period’s start date.</para>
+ <para><guilabel>Start Date:</guilabel> This item sets the accounting period’s start date.</para>
<itemizedlist>
<listitem>
- <para><guilabel>Relative</guilabel> — Use the specified relative starting date for profit/loss
+ <para><guilabel>Relative:</guilabel> Use the specified relative starting date for profit/loss
calculations. Also use this date for net assets calculations. Relative defines
start by today or start of current/previous year, quarter, month.</para>
</listitem>
<listitem>
- <para><guilabel>Absolute</guilabel> — Use the specified absolute starting date for profit/loss
+ <para><guilabel>Absolute:</guilabel> Use the specified absolute starting date for profit/loss
calculations. Also use this date for net assets calculations.</para>
</listitem>
</itemizedlist>
@@ -120,15 +122,15 @@
</listitem>
<listitem>
- <para><guilabel>End Date</guilabel> — This item sets the accounting period’s end date.</para>
+ <para><guilabel>End Date:</guilabel> This item sets the accounting period’s end date.</para>
<itemizedlist>
<listitem>
- <para><guilabel>Relative</guilabel> — Use the specified relative ending date for profit/loss
+ <para><guilabel>Relative:</guilabel> Use the specified relative ending date for profit/loss
calculations. Also use this date for net assets calculations.</para>
</listitem>
<listitem>
- <para><guilabel>Absolute</guilabel> — Use the specified absolute ending date for profit/loss
+ <para><guilabel>Absolute:</guilabel> Use the specified absolute ending date for profit/loss
calculations. Also use this date for net assets calculations.</para>
</listitem>
</itemizedlist>
@@ -139,12 +141,12 @@
<para><guilabel>Summarybar content</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Include grand total</guilabel> — If checked, show in the <emphasis>Summarybar</emphasis> a grand total of all
+ <para><guilabel>Include grand total:</guilabel> If checked, show in the <emphasis>Summarybar</emphasis> a grand total of all
accounts converted to the default currency.</para>
</listitem>
<listitem>
- <para><guilabel>Include non-currency totals</guilabel> — if this
+ <para><guilabel>Include non-currency totals:</guilabel> if this
option is selected, <application>&app;</application> will include in the <emphasis>Summarybar</emphasis> a total
for non-currency items (for instance number of shares).</para>
</listitem>
@@ -158,7 +160,9 @@
<title>Accounts</title>
<figure id="prefs-acct-fig">
- <title>The <guilabel>Preferences — Accounts</guilabel> tab</title>
+ <title>The <guimenuitem>Preferences</guimenuitem> window, <guilabel>
+ Accounts</guilabel> tab
+ </title>
<screenshot id="Prefer_Accounts">
<mediaobject>
<imageobject role="html">
@@ -179,18 +183,18 @@
<itemizedlist>
<listitem>
- <para><guilabel>Separator Character</guilabel> — The account
+ <para><guilabel>Separator Character:</guilabel> The account
separator is the character that separates a parent account from its
sub-account, for example Utilities:Electric. The default is a
<keycap>:</keycap> (Colon), but you can also select
<keycap>/</keycap> (Slash),
- <keycap>\</keycap> (Backslash), <keycap>—</keycap> (Dash)
+ <keycap>\</keycap> (Backslash), <keycap>-</keycap> (Dash)
or <keycap>.</keycap> (Period), or any Unicode character
that isn’t a letter or a number.</para>
</listitem>
<listitem>
- <para><guilabel>Reverse Balanced accounts</guilabel> — This option
+ <para><guilabel>Reverse Balanced accounts:</guilabel> This option
lets you determine whether account balances will display as positive
or negative numbers:</para>
<itemizedlist>
@@ -218,7 +222,7 @@
</listitem>
<listitem>
- <para><guilabel>Labels</guilabel> — Select this option if you want
+ <para><guilabel>Labels:</guilabel> Select this option if you want
column headings in the register to refer to <guilabel>debits</guilabel> and
<guilabel>credits</guilabel> instead of the default informal headings such
as <guilabel>withdrawal</guilabel>
@@ -226,18 +230,18 @@
</listitem>
<listitem>
- <para><guilabel>Default Currency</guilabel> — This item determines
+ <para><guilabel>Default Currency:</guilabel> This item determines
which currency will be selected by default when creating new
accounts.</para>
<itemizedlist>
<listitem>
- <para><guilabel>Locale</guilabel> — Use the system locale currency for
+ <para><guilabel>Locale:</guilabel> Use the system locale currency for
all newly created accounts.</para>
</listitem>
<listitem>
- <para><guilabel>Choose</guilabel> — specify the
+ <para><guilabel>Choose:</guilabel> specify the
currency to use, independent of your system
settings.</para>
</listitem>
@@ -245,17 +249,17 @@
</listitem>
<listitem>
- <para><guilabel>Account Color</guilabel> — This option
+ <para><guilabel>Account Color:</guilabel> This option
lets you manage the display of the account color set in the
<guilabel>Edit Account</guilabel> window:</para>
<itemizedlist>
<listitem>
- <para><guilabel>Show the Account Colors as background</guilabel> — show the
+ <para><guilabel>Show the Account Colors as background:</guilabel> show the
accounts color as account name background in the Accounts Page.</para>
</listitem>
<listitem>
- <para><guilabel>Show the Account Colors on tabs</guilabel> — show the accounts
+ <para><guilabel>Show the Account Colors on tabs:</guilabel> show the accounts
color as background in the account register tabs.</para>
</listitem>
</itemizedlist>
@@ -267,7 +271,8 @@
<title>Business</title>
<figure id="prefs-biz-fig">
- <title>The <guilabel>Preferences — Business</guilabel> tab</title>
+ <title>The <guimenuitem>Preferences</guimenuitem> window, <guilabel>
+ Business</guilabel> tab</title>
<screenshot id="Prefer_Business">
<mediaobject>
<imageobject role="html">
@@ -291,18 +296,18 @@
<para><guilabel>General</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Enable extra buttons</guilabel> — If checked,
+ <para><guilabel>Enable extra buttons:</guilabel> If checked,
extra toolbar buttons for common business functions are shown.</para>
</listitem>
<listitem>
- <para><guilabel>Open in new window</guilabel> — If checked, each
+ <para><guilabel>Open in new window:</guilabel> If checked, each
invoice will be opened in its own top level window. If clear, the
invoice will be opened in the current window.</para>
</listitem>
<listitem>
- <para><guilabel>Accumulate splits on post</guilabel> — Whether
+ <para><guilabel>Accumulate splits on post:</guilabel> Whether
multiple entries in an invoice which transfer to the same account
should be accumulated into a single split by default.</para>
</listitem>
@@ -313,18 +318,18 @@
<para><guilabel>Invoices</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Report for printing:</guilabel> — Allows to select
+ <para><guilabel>Report for printing:</guilabel> Allows to select
the invoice report to be used for printing.</para>
</listitem>
<listitem>
- <para><guilabel>Tax Included</guilabel> — Whether tax are
+ <para><guilabel>Tax Included:</guilabel> Whether tax are
included by default in entries on invoices. This setting is
inherited by new customers and vendors.</para>
</listitem>
<listitem>
- <para><guilabel>Auto pay on posting</guilabel> — If enabled, at post
+ <para><guilabel>Auto pay on posting:</guilabel> If enabled, at post
time automatically attempt to pay customer documents with outstanding
pre-payments and counter documents.</para>
<note>
@@ -343,24 +348,24 @@
<para><guilabel>Bills</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Notify when due</guilabel> — Lets you set whether
+ <para><guilabel>Notify when due:</guilabel> Lets you set whether
you want to be notified at <application>&app;</application> startup
of when a bill is soon to be due.</para>
</listitem>
<listitem>
- <para><guilabel>Days in advance</guilabel> — How many days before
+ <para><guilabel>Days in advance:</guilabel> How many days before
the due date to warn about bills coming due.</para>
</listitem>
<listitem>
- <para><guilabel>Tax Included</guilabel> — Whether tax are
+ <para><guilabel>Tax Included:</guilabel> Whether tax are
included by default in entries on bills. This setting is inherited
by new customers and vendors.</para>
</listitem>
<listitem>
- <para><guilabel>Auto pay on posting</guilabel> — If enabled, at post
+ <para><guilabel>Auto pay on posting:</guilabel> If enabled, at post
time automatically attempt to pay vendor documents with outstanding
pre-payments and counter documents.</para>
<note>
@@ -382,7 +387,8 @@
<title>Date/Time</title>
<figure id="prefs-date-time-fig">
- <title>The <guilabel>Preferences — Date/Time</guilabel> tab</title>
+ <title>The <guimenuitem>Preferences</guimenuitem> window, <guilabel>
+ Date/Time</guilabel> tab</title>
<screenshot id="Prefer_DateTime">
<mediaobject>
<imageobject role="html">
@@ -406,7 +412,7 @@
<para><guilabel>Time Format</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Use 24-hour clock</guilabel> — Lets you specify if you
+ <para><guilabel>Use 24-hour clock:</guilabel> Lets you specify if you
want to use 24 or 12 hours time format. That is if 11 o’clock at
night should be represented as 11PM or 23:00.</para>
</listitem>
@@ -414,44 +420,44 @@
</listitem>
<listitem>
- <para><guilabel>Date Format</guilabel> — This option controls the
+ <para><guilabel>Date Format:</guilabel> This option controls the
appearance of the date (you could see a preview of the date beside any of the choices).
The available choices are:</para>
<itemizedlist>
<listitem>
- <para><guilabel>US</guilabel> — Use the date format common in the United States.</para>
+ <para><guilabel>US:</guilabel> Use the date format common in the United States.</para>
</listitem>
<listitem>
- <para><guilabel>UK</guilabel> — Use the date format common in the United Kingdom.</para>
+ <para><guilabel>UK:</guilabel> Use the date format common in the United Kingdom.</para>
</listitem>
<listitem>
- <para><guilabel>Europe</guilabel> — Use the date format common in continental Europe.</para>
+ <para><guilabel>Europe:</guilabel> Use the date format common in continental Europe.</para>
</listitem>
<listitem>
- <para><guilabel>ISO</guilabel> — Use the date format specified by the ISO-8601 standard.</para>
+ <para><guilabel>ISO:</guilabel> Use the date format specified by the ISO-8601 standard.</para>
</listitem>
<listitem>
- <para><guilabel>Locale</guilabel> — Use the date format specified by the system locale.</para>
+ <para><guilabel>Locale:</guilabel> Use the date format specified by the system locale.</para>
</listitem>
</itemizedlist>
</listitem>
<listitem>
- <para><guilabel>Date completion</guilabel> — This option
+ <para><guilabel>Date completion:</guilabel> This option
lets you manage the case when a date is entered without a year:
<itemizedlist>
<listitem>
- <para><guilabel>In the current calendar year</guilabel> (Default) — Dates will be completed so that
+ <para><guilabel>In the current calendar year:</guilabel> (Default) Dates will be completed so that
they are within the current calendar year.</para>
</listitem>
<listitem>
<para><guilabel>In a sliding 12-month window starting a configurable number of months before
- the current month</guilabel> — Dates will be completed so that they are close to the current
+ the current month:</guilabel> Dates will be completed so that they are close to the current
date. You can enter the maximum number of months to go backwards in time when completing dates.</para>
</listitem>
</itemizedlist>
@@ -464,7 +470,9 @@
<title>General</title>
<figure id="prefs-general-fig">
- <title>The <guilabel>Preferences — General</guilabel> tab</title>
+ <title>The <guimenuitem>Preferences</guimenuitem> window, <guilabel>
+ General</guilabel> tab
+ </title>
<screenshot id="Prefer_General">
<mediaobject>
<imageobject role="html">
@@ -488,18 +496,18 @@
<para><guilabel>General</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Display "Tip of the Day" dialog</guilabel> — This option displays or hides the
+ <para><guilabel>Display "Tip of the Day" dialog:</guilabel> This option displays or hides the
<guilabel>Tip of the Day</guilabel> screen when <application>&app;</application> is started.</para>
</listitem>
<listitem>
- <para><guilabel>Show splash screen</guilabel> — With this option you
+ <para><guilabel>Show splash screen:</guilabel> With this option you
can enable or disable the visualization of the startup screen while
<application>&app;</application> is starting up.</para>
</listitem>
<listitem>
- <para><guilabel>Perform account list setup on new file</guilabel> —
+ <para><guilabel>Perform account list setup on new file:</guilabel>
This option turns off the display of the <guilabel>New Account
Hierarchy Setup</guilabel> assistant when the entry <menuchoice><guimenu>File</guimenu>
<guimenuitem>New File</guimenuitem></menuchoice> is selected from the
@@ -508,7 +516,7 @@
<listitem>
<para><guilabel>Set book option on new files to use split "action"
- field for "Num" field on registers/reports</guilabel> —
+ field for "Num" field on registers/reports:</guilabel>
If selected, the displayed setting on the <guilabel>New Book
Options</guilabel> dialog for the <guilabel>Use Split Action Field
for Number</guilabel> setting will be selected and, if saved, the
@@ -544,19 +552,19 @@
<para><guilabel>Numbers</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Display negative amounts in red</guilabel> — If you
+ <para><guilabel>Display negative amounts in red:</guilabel> If you
turn off this option, <application>&app;</application> will display negative numbers in
black.</para>
</listitem>
<listitem>
- <para><guilabel>Automatic Decimal Point</guilabel> — This option
+ <para><guilabel>Automatic Decimal Point:</guilabel> This option
will automatically insert a decimal point into numbers you type
in.</para>
</listitem>
<listitem>
- <para><guilabel>Decimal Places</guilabel> — This field allows you
+ <para><guilabel>Decimal Places:</guilabel> This field allows you
to set the number of decimal places to be used.</para>
</listitem>
</itemizedlist>
@@ -569,24 +577,24 @@
</note>
<itemizedlist>
<listitem>
- <para><guilabel>Compress files</guilabel> — This option determines
+ <para><guilabel>Compress files:</guilabel> This option determines
whether the <application>&app;</application> data file will be compressed or not.</para>
</listitem>
<listitem>
- <para><guilabel>Show auto-save confirmation question</guilabel> —
+ <para><guilabel>Show auto-save confirmation question:</guilabel>
If this option is enabled, <application>&app;</application> will show you a confirmation screen
each time the auto-save process is started.</para>
</listitem>
<listitem>
- <para><guilabel>Auto-save time interval</guilabel> —
+ <para><guilabel>Auto-save time interval:</guilabel>
This field sets the number of minutes between each automatic saving of the file.
Set to 0 to disable the auto-save feature.</para>
</listitem>
<listitem>
- <para><guilabel>Enable timout on "Save changes on closing" question</guilabel> —
+ <para><guilabel>Enable timout on "Save changes on closing" question:</guilabel>
If enabled, the <guilabel>Save changes on closing</guilabel> question will only wait a
limited number of seconds for an answer. If the user didn’t answer within that time,
the changes will be saved automatically and the question window closed.
@@ -594,19 +602,19 @@
</listitem>
<listitem>
- <para><guilabel>Retain log files</guilabel> — In this section you could set
+ <para><guilabel>Retain log files:</guilabel> In this section you could set
your preferences about the log files using the provided radio buttons.</para>
<itemizedlist>
<listitem>
- <para><guilabel>Never</guilabel> — Disable the creation of log files.</para>
+ <para><guilabel>Never:</guilabel> Disable the creation of log files.</para>
</listitem>
<listitem>
- <para><guilabel>For:</guilabel> — Enter a specific number of days for which keep the files.</para>
+ <para><guilabel>For:</guilabel> Enter a specific number of days for which keep the files.</para>
</listitem>
<listitem>
- <para><guilabel>Forever</guilabel> — Disable the auto deletion of log files; retains the log files forever.</para>
+ <para><guilabel>Forever:</guilabel> Disable the auto deletion of log files; retains the log files forever.</para>
</listitem>
</itemizedlist>
</listitem>
@@ -617,7 +625,7 @@
<para><guilabel>Search Dialog</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>New search limit:</guilabel> — Defaults to "new
+ <para><guilabel>New search limit:</guilabel> Defaults to "new
search" if fewer than this number of items is returned.</para>
</listitem>
</itemizedlist>
@@ -629,7 +637,9 @@
<title>Online Banking</title>
<figure id="prefs-online-fig">
- <title>The <guilabel>Preferences — Online Banking</guilabel> tab</title>
+ <title>The <guimenuitem>Preferences</guimenuitem> window, <guilabel>
+ Online Banking</guilabel> tab
+ </title>
<screenshot id="Prefer_OnlineBanking">
<mediaobject>
<imageobject role="html">
@@ -653,7 +663,7 @@
<para><guilabel>QIF Import</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Show documentation</guilabel> — The first time you
+ <para><guilabel>Show documentation:</guilabel> The first time you
use the QIF importer you may
notice that the importer has detailed instructions on how to import
a file. Once you have become familiar with using the importer, you
@@ -662,7 +672,7 @@
</listitem>
<listitem>
- <para><guilabel>Default transaction status (overridden by the status given by the QIF file)</guilabel> —
+ <para><guilabel>Default transaction status (overridden by the status given by the QIF file):</guilabel>
In this section you could set the default status for imported transactions using the provided
self-explainingradio buttons:</para>
<itemizedlist>
@@ -686,45 +696,45 @@
<para><guilabel>Generic Importer</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Enable skip transaction action</guilabel> — Enable the SKIP
+ <para><guilabel>Enable skip transaction action:</guilabel> Enable the SKIP
action in the transaction matcher. If enabled, a transaction whose best match’s score
is in the yellow zone (above the Auto-ADD threshold but below the Auto-CLEAR threshold)
will be skipped by default.</para>
</listitem>
<listitem>
- <para><guilabel>Enable update match action</guilabel> — Enable the UPDATE AND RECONCILE
+ <para><guilabel>Enable update match action:</guilabel> Enable the UPDATE AND RECONCILE
action in the transaction matcher. If enabled, a transaction whose best match’s score is
above the Auto-CLEAR threshold and has a different date or amount than the matching existing
transaction will cause the existing transaction to be updated and cleared by default.</para>
</listitem>
<listitem>
- <para><guilabel>Use Bayesian matching</guilabel> — Use Bayesian
+ <para><guilabel>Use Bayesian matching:</guilabel> Use Bayesian
algorithms to match new transactions with existing accounts.</para>
</listitem>
<listitem>
- <para><guilabel>Match display threshold</guilabel> — The minimal
+ <para><guilabel>Match display threshold:</guilabel> The minimal
score a potential match must have to be displayed in the match
list.</para>
</listitem>
<listitem>
- <para><guilabel>Auto-add threshold</guilabel> — A transaction whose
+ <para><guilabel>Auto-add threshold:</guilabel> A transaction whose
best match’s score is in the red zone (above display threshold, but
below or equal to Auto-add threshold) will be added by
default.</para>
</listitem>
<listitem>
- <para><guilabel>Auto-clear threshold</guilabel> — A transaction
+ <para><guilabel>Auto-clear threshold:</guilabel> A transaction
whose best match’s score is in the green zone (above or equal to
Auto-clear threshold) will be cleared by default.</para>
</listitem>
<listitem>
- <para><guilabel>Commercial ATM fees threshold</guilabel> —
+ <para><guilabel>Commercial ATM fees threshold:</guilabel>
In some places commercial ATMs (not
belonging to a financial institution) are installed in places like convenience
store. These ATM add its fee directly to the amount instead of showing up as a
@@ -737,7 +747,7 @@
</listitem>
<listitem>
- <para><guilabel>Automatically create new commodities</guilabel> — Enables the
+ <para><guilabel>Automatically create new commodities:</guilabel> Enables the
automatic creation of new commodities if any unknown commodity is encountered during
import. If not enabled, the user will be asked what to do with each unknown commodity.</para>
</listitem>
@@ -752,18 +762,18 @@
</note>
<itemizedlist>
<listitem>
- <para><guilabel>Close log window when finished</guilabel> — Close the log window
+ <para><guilabel>Close log window when finished:</guilabel> Close the log window
when the operation is completed.</para>
</listitem>
<listitem>
- <para><guilabel>Remember PIN</guilabel> — Enable this option if you
+ <para><guilabel>Remember PIN:</guilabel> Enable this option if you
want <application>&app;</application> to remember the PIN you
enter for online banking authentication.</para>
</listitem>
<listitem>
- <para><guilabel>Verbose debug messages</guilabel> — Enable this option if you
+ <para><guilabel>Verbose debug messages:</guilabel> Enable this option if you
want <application>&app;</application> to show more information about the online
banking operations.</para>
</listitem>
@@ -776,7 +786,9 @@
<title>Printing</title>
<figure id="prefs-printing-fig">
- <title>The <guilabel>Preferences — Printing</guilabel> tab</title>
+ <title>The <guimenuitem>Preferences</guimenuitem> window, <guilabel>
+ Printing</guilabel> tab
+ </title>
<screenshot id="Prefer_Printing">
<mediaobject>
<imageobject role="html">
@@ -801,18 +813,18 @@
<itemizedlist>
<listitem>
- <para><guilabel>Print date format</guilabel> — Enable this option
+ <para><guilabel>Print date format:</guilabel> Enable this option
if you want to print on the check, below the actual date, its format in 8 point type.
</para>
</listitem>
<listitem>
- <para><guilabel>Print blocking chars</guilabel> — Enable this option to print
+ <para><guilabel>Print blocking chars:</guilabel> Enable this option to print
a series of three asterisks before and after each text field in the check.</para>
</listitem>
<listitem>
- <para><guilabel>Default font:</guilabel> — Click the button on the left to open
+ <para><guilabel>Default font:</guilabel> Click the button on the left to open
a <guilabel>Pick a Font</guilabel> screen in which you can customize the font
that will be used to print checks.</para>
</listitem>
@@ -823,7 +835,9 @@
<title>Register</title>
<figure id="prefs-reg-fig">
- <title>The <guilabel>Preferences — Register</guilabel> tab</title>
+ <title>The <guimenuitem>Preferences</guimenuitem> window, <guilabel>
+ Register</guilabel> tab
+ </title>
<screenshot id="Prefer_Register">
<mediaobject>
<imageobject role="html">
@@ -847,20 +861,20 @@
<para><guilabel>Actions</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>'Enter' moves to blank transaction</guilabel> — If
+ <para><guilabel>'Enter' moves to blank transaction:</guilabel> If
selected, move the cursor to the blank transaction at the end of the register
after the user presses the <keycap function="enter">Enter</keycap> key. Otherwise the cursor will be moved
down one row.</para>
</listitem>
<listitem>
- <para><guilabel>Auto-raise lists</guilabel> — If selected, all lists
+ <para><guilabel>Auto-raise lists:</guilabel> If selected, all lists
will automatically be expanded when input focus is in the list
field.</para>
</listitem>
<listitem>
- <para><guilabel>Tab order includes Transfer on Memorised Transaction</guilabel> —
+ <para><guilabel>Tab order includes Transfer on Memorised Transaction:</guilabel>
If selected, when the transaction is auto filled, pressing the
<keycap>Tab</keycap> key in the register the cursor’s jump
will include the <guilabel>Transfer</guilabel> field.</para>
@@ -872,13 +886,13 @@
<para><guilabel>Reconciling</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Check cleared transactions</guilabel> — If selected,
+ <para><guilabel>Check cleared transactions:</guilabel> If selected,
automatically check off cleared transactions when
reconciling.</para>
</listitem>
<listitem>
- <para><guilabel>Automatic interest transfer</guilabel> — If
+ <para><guilabel>Automatic interest transfer:</guilabel> If
selected, prior to reconciling an account which charges or pays
interest, prompt the user to enter a transaction for the interest
charge or payment. Currently only enabled for Bank, Credit, Mutual,
@@ -886,13 +900,13 @@
</listitem>
<listitem>
- <para><guilabel>Automatic credit card payment</guilabel> — If
+ <para><guilabel>Automatic credit card payment:</guilabel> If
selected, after reconciling a credit card statement, prompt the user
to enter a credit card payment.</para>
</listitem>
<listitem>
- <para><guilabel>Always reconcile to today</guilabel> — If
+ <para><guilabel>Always reconcile to today:</guilabel> If
selected, always open the reconcile screen with today’s date for
statement date, regardless of previous reconciliation.</para>
</listitem>
@@ -904,26 +918,26 @@
<itemizedlist>
<listitem>
- <para><guilabel>Use system theme colors</guilabel> — If selected,
+ <para><guilabel>Use system theme colors:</guilabel> If selected,
the system color theme will be applied to register windows. Otherwise
the original <application>&app;</application> register color will be used.</para>
</listitem>
<listitem>
<para><guilabel>Double mode colors alternate with
- transactions</guilabel> — If selected, configures the register
+ transactions:</guilabel> If selected, configures the register
window to alternate between the primary and secondary colors with
each transaction, instead of each row.</para>
</listitem>
<listitem>
- <para><guilabel>Draw horizontal lines between rows</guilabel> — If
+ <para><guilabel>Draw horizontal lines between rows:</guilabel> If
selected, <application>&app;</application> will draw a horizontal line between each
row.</para>
</listitem>
<listitem>
- <para><guilabel>Draw vertical lines between columns</guilabel> — If
+ <para><guilabel>Draw vertical lines between columns:</guilabel> If
selected, <application>&app;</application> will draw a vertical line between the cells in
each row.</para>
</listitem>
@@ -937,7 +951,9 @@
<title>Register Defaults</title>
<figure id="prefs-reg-def-fig">
- <title>The <guilabel>Preferences — Register Defaults</guilabel> tab</title>
+ <title>The <guimenuitem>Preferences</guimenuitem> window, <guilabel>
+ Register Defaults</guilabel> tab
+ </title>
<screenshot id="Prefer_RegisterDefaults">
<mediaobject>
<imageobject role="html">
@@ -967,18 +983,18 @@
different styles for register windows:
<itemizedlist>
<listitem>
- <para><guilabel>Basic ledger</guilabel> — Show all transactions on one line. (Two in double line
+ <para><guilabel>Basic ledger:</guilabel> Show all transactions on one line. (Two in double line
mode.)</para>
</listitem>
<listitem>
- <para><guilabel>Auto-split ledger</guilabel> — Automatically expand the current transaction to show
+ <para><guilabel>Auto-split ledger:</guilabel> Automatically expand the current transaction to show
all splits. All other transactions are shown on one line. (Two in double line
mode.)</para>
</listitem>
<listitem>
- <para><guilabel>Transaction journal</guilabel> — All transactions are expanded to show all splits.
+ <para><guilabel>Transaction journal:</guilabel> All transactions are expanded to show all splits.
</para>
</listitem>
</itemizedlist>
@@ -989,18 +1005,18 @@
<para><guilabel>Other Defaults</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Register opens in a new window</guilabel> — If
+ <para><guilabel>Register opens in a new window:</guilabel> If
selected, register will be in a separate window instead of in a
tab.</para>
</listitem>
<listitem>
- <para><guilabel>Double line mode</guilabel> — If selected, show two
+ <para><guilabel>Double line mode:</guilabel> If selected, show two
lines of information for each transaction instead of one.</para>
</listitem>
<listitem>
- <para><guilabel>Only display leaf account names</guilabel> — If selected, only the name of the leaf
+ <para><guilabel>Only display leaf account names:</guilabel> If selected, only the name of the leaf
accounts will be displayed in the <guilabel>Account</guilabel> selection popup.
The default behavoir is to display the full account name including the path in the account tree.</para>
<warning>
@@ -1011,7 +1027,7 @@
</listitem>
<listitem>
- <para><guilabel>Number of transactions</guilabel> — How many
+ <para><guilabel>Number of transactions:</guilabel> How many
transactions to show in a register. Set to 0 to show all transactions.</para>
</listitem>
</itemizedlist>
@@ -1023,7 +1039,9 @@
<title>Reports</title>
<figure id="prefs-reports-fig">
- <title>The <guilabel>Preferences — Reports</guilabel> tab</title>
+ <title>The <guimenuitem>Preferences</guimenuitem> window, <guilabel>
+ Reports</guilabel> tab
+ </title>
<screenshot id="Prefer_Reports">
<mediaobject>
<imageobject role="html">
@@ -1048,17 +1066,17 @@
<itemizedlist>
<listitem>
- <para><guilabel>Default Report Currency</guilabel> — This item
+ <para><guilabel>Default Report Currency:</guilabel> This item
determines which currency will be used by default when creating
reports. You can choose:</para>
<itemizedlist>
<listitem>
- <para><guilabel>Locale</guilabel> — Use the system locale currency for all
+ <para><guilabel>Locale:</guilabel> Use the system locale currency for all
newly created reports.</para>
</listitem>
<listitem>
- <para><guilabel>Choose</guilabel> — Use the specified currency for all
+ <para><guilabel>Choose:</guilabel> Use the specified currency for all
newly created reports.</para>
</listitem>
</itemizedlist>
@@ -1068,7 +1086,7 @@
<para><guilabel>Location</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Report opens in a new window</guilabel> — if you select this option, the
+ <para><guilabel>Report opens in a new window:</guilabel> if you select this option, the
reports will open up in a new window, instead of in a tab.</para>
</listitem>
</itemizedlist>
@@ -1080,7 +1098,9 @@
<title>Scheduled Transactions</title>
<figure id="prefs-sched-fig">
- <title>The <guilabel>Preferences — Scheduled Transactions</guilabel> tab</title>
+ <title>The <guimenuitem>Preferences</guimenuitem> window, <guilabel>
+ Scheduled Transactions</guilabel> tab
+ </title>
<screenshot id="Prefer_ScheduledTransactions">
<mediaobject>
<imageobject role="html">
@@ -1110,7 +1130,7 @@
<para><guilabel>Since Last Run Dialog</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Run when data file opened</guilabel> — If selected,
+ <para><guilabel>Run when data file opened:</guilabel> If selected,
the <guilabel>Since Last Run</guilabel> screen will appear on <application>&app;</application> start-up (or
rather when <application>&app;</application> opens the file).
</para>
@@ -1122,7 +1142,7 @@
<para><guilabel>Transaction Editor Defaults</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Auto-Create new transactions</guilabel> — If
+ <para><guilabel>Auto-Create new transactions:</guilabel> If
selected, new scheduled transactions will automatically be entered
into the register. If the auto-create option is enabled, you could also check
<guilabel>Notify before transactions are created</guilabel> so that you will be
@@ -1130,13 +1150,13 @@
</listitem>
<listitem>
- <para><guilabel>Create in advance</guilabel> — The default
+ <para><guilabel>Create in advance:</guilabel> The default
number of days in advance to create the registered scheduled
transactions.</para>
</listitem>
<listitem>
- <para><guilabel>Remind in advance</guilabel> — The default
+ <para><guilabel>Remind in advance:</guilabel> The default
number of days in advance to remind on new scheduled
transactions.</para>
</listitem>
@@ -1149,7 +1169,9 @@
<title>Windows</title>
<figure id="prefs-windows-fig">
- <title>The <guilabel>Preferences — Windows</guilabel> tab</title>
+ <title>The <guimenuitem>Preferences</guimenuitem> window, <guilabel>
+ Windows</guilabel> tab
+ </title>
<screenshot id="Prefer_Windows">
<mediaobject>
<imageobject role="html">
@@ -1173,7 +1195,7 @@
<para><guilabel>Window Geometry</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Save window size and position</guilabel> — If
+ <para><guilabel>Save window size and position:</guilabel> If
selected, next time <application>&app;</application> starts will re-use the windows size
and position configured in the last run.</para>
</listitem>
@@ -1184,18 +1206,18 @@
<para><guilabel>Tabs</guilabel></para>
<itemizedlist>
<listitem>
- <para><guilabel>Show close button on notebook tabs</guilabel> — Adds
+ <para><guilabel>Show close button on notebook tabs:</guilabel> Adds
a small close icon on each tab, to make it easier to close the
various tabs.</para>
</listitem>
<listitem>
- <para><guilabel>Bring the most recent tab to the front</guilabel> — If
+ <para><guilabel>Bring the most recent tab to the front:</guilabel> If
selected, the newly created tab will be shown over the other tabs.</para>
</listitem>
<listitem>
- <para><guilabel>Width:</guilabel> — The width of tab label
+ <para><guilabel>Width:</guilabel> The width of tab label
expressed in characters.
<note>
<para>If the text in the tab is longer than this value
diff --git a/help/C/Help_ch_GettingStarted.xml b/help/C/Help_ch_GettingStarted.xml
index a387c1b..a23a70c 100644
--- a/help/C/Help_ch_GettingStarted.xml
+++ b/help/C/Help_ch_GettingStarted.xml
@@ -35,20 +35,20 @@
<itemizedlist id="CreateAccounts">
<listitem>
- <para><guilabel>Create a new set of accounts</guilabel> — Runs the
+ <para><guilabel>Create a new set of accounts:</guilabel> Runs the
<guilabel>New Account Hierarchy Setup</guilabel> assistant (see <xref linkend="acct-hierarchy"/>). Select
this option if you want to be assisted in creating a set of accounts.</para>
</listitem>
<listitem>
- <para><guilabel>Import my QIF files</guilabel> — Runs the
+ <para><guilabel>Import my QIF files:</guilabel> Runs the
<guilabel>Import QIF Files</guilabel> assistant (see <xref linkend="import-qif"/>). Select this option
if you already have Quicken files (<filename>.qif</filename> files) from another
financial application and wish to import them into <application>&app;</application>.</para>
</listitem>
<listitem>
- <para><guilabel>Open the new user tutorial</guilabel> —
+ <para><guilabel>Open the new user tutorial:</guilabel>
Opens the <application>&app;</application> Tutorial and Concepts Guide. Select this
option if you are completely new to <application>&app;</application> and
accounting concepts.</para>
@@ -109,7 +109,7 @@
<itemizedlist>
<listitem>
- <para><guibutton>Cancel</guibutton> — exit the process and cancel creating
+ <para><guibutton>Cancel:</guibutton> exit the process and cancel creating
a new set of accounts.</para>
<warning>
<para>If you click this button, any selections you have made up to
@@ -118,12 +118,12 @@
</listitem>
<listitem>
- <para><guibutton>Back</guibutton> — brings up the previous screen so
+ <para><guibutton>Back:</guibutton> brings up the previous screen so
that you can change a previous selection until the first screen.</para>
</listitem>
<listitem>
- <para><guibutton>Forward</guibutton> — brings up the next
+ <para><guibutton>Forward:</guibutton> brings up the next
screen so you can continue through the assistant.</para>
</listitem>
</itemizedlist>
@@ -233,7 +233,7 @@
<itemizedlist>
<listitem>
- <para><guibutton>Cancel</guibutton> — exits the assistant and cancels creating
+ <para><guibutton>Cancel:</guibutton> exits the assistant and cancels creating
a new set of accounts.</para>
<warning>
<para>If you click this button, any selections you have made up to
@@ -242,12 +242,12 @@
</listitem>
<listitem>
- <para><guibutton>Back</guibutton> — brings up the previous screen so
+ <para><guibutton>Back:</guibutton> brings up the previous screen so
that you can change a previous selection until the first screen.</para>
</listitem>
<listitem>
- <para><guibutton>Apply</guibutton> — creates the accounts you have selected.</para>
+ <para><guibutton>Apply:</guibutton> creates the accounts you have selected.</para>
</listitem>
</itemizedlist>
</listitem>
@@ -281,7 +281,7 @@
<itemizedlist>
<listitem>
- <para><guibutton>Cancel</guibutton> — exit the process and cancel importing
+ <para><guibutton>Cancel:</guibutton> exit the process and cancel importing
<acronym>QIF</acronym> files.</para>
<warning>
<para>If you click this button, any selections you have made up to
@@ -290,12 +290,12 @@
</listitem>
<listitem>
- <para><guibutton>Back</guibutton> — brings up the previous screen so
+ <para><guibutton>Back:</guibutton> brings up the previous screen so
that you can change a previous selection until the first screen.</para>
</listitem>
<listitem>
- <para><guibutton>Forward</guibutton> — brings up the next
+ <para><guibutton>Forward:</guibutton> brings up the next
screen so you can continue through the assistant.</para>
</listitem>
</itemizedlist>
@@ -602,7 +602,7 @@
<itemizedlist>
<listitem>
- <para><guibutton>Cancel</guibutton> — exit the process and cancel importing
+ <para><guibutton>Cancel:</guibutton> exit the process and cancel importing
<acronym>QIF</acronym> files.</para>
<warning>
<para>If you click this button, any selections you have made up to
@@ -611,12 +611,12 @@
</listitem>
<listitem>
- <para><guibutton>Back</guibutton> — brings up the previous screen so
+ <para><guibutton>Back:</guibutton> brings up the previous screen so
that you can change a previous selection until the first screen.</para>
</listitem>
<listitem>
- <para><guibutton>Forward</guibutton> — imports the data and creates the
+ <para><guibutton>Forward:</guibutton> imports the data and creates the
accounts you have specified.</para>
</listitem>
</itemizedlist>
diff --git a/help/C/Help_ch_Reports.xml b/help/C/Help_ch_Reports.xml
index 581e537..6dd3afa 100644
--- a/help/C/Help_ch_Reports.xml
+++ b/help/C/Help_ch_Reports.xml
@@ -358,7 +358,7 @@
<title>Report Options</title>
<figure>
- <title><emphasis>Transaction Report — Report Options</emphasis></title>
+ <title><emphasis>Transaction Report, Report Options</emphasis></title>
<screenshot id="Help_TxRptOpt_Screen">
<mediaobject>
<imageobject role="html">
@@ -371,9 +371,9 @@
srccredit="Geert Janssens" ></imagedata>
</imageobject>
- <textobject><phrase>Transaction Report — Report Options screen</phrase>
+ <textobject><phrase>Transaction Report, Report Options screen</phrase>
</textobject>
- <caption><para>This is an image of the <emphasis>Transaction Report — Report Options — Display tab.</emphasis></para>
+ <caption><para>This is an image of the <emphasis>Transaction Report, Report Options, Display tab.</emphasis></para>
</caption>
</mediaobject>
</screenshot>
@@ -382,7 +382,7 @@
<itemizedlist>
<listitem><para><emphasis>Accounts tab</emphasis></para>
<itemizedlist>
- <listitem><para><guilabel>Accounts</guilabel> — Select one or more accounts to be reported.</para>
+ <listitem><para><guilabel>Accounts:</guilabel> Select one or more accounts to be reported.</para>
<para>There are 4 buttons to aid account selection</para>
<informaltable>
<tgroup cols="2">
@@ -396,18 +396,18 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Show Hidden Accounts</guilabel> — Show accounts that have been marked hidden.</para>
+ <listitem><para><guilabel>Show Hidden Accounts:</guilabel> Show accounts that have been marked hidden.</para>
</listitem>
- <listitem><para><guilabel>Filter By</guilabel> — Optionally select accounts to be either included or
+ <listitem><para><guilabel>Filter By:</guilabel> Optionally select accounts to be either included or
excluded depending on Filter type</para>
</listitem>
- <listitem><para><guilabel>Show Hidden Accounts</guilabel> — Show accounts that have been
+ <listitem><para><guilabel>Show Hidden Accounts:</guilabel> Show accounts that have been
marked hidden in the Filter By list of accounts</para>
</listitem>
- <listitem><para><guilabel>Filter Type</guilabel> — One of</para>
+ <listitem><para><guilabel>Filter Type:</guilabel> One of</para>
<informaltable>
<tgroup cols="2">
<tbody>
@@ -423,7 +423,7 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Void Transactions</guilabel> — One of</para>
+ <listitem><para><guilabel>Void Transactions:</guilabel> One of</para>
<informaltable>
<tgroup cols="2">
<tbody>
@@ -435,7 +435,7 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Reset defaults button</guilabel> — Reset all values to their defaults</para>
+ <listitem><para><guilabel>Reset defaults button:</guilabel> Reset all values to their defaults</para>
</listitem>
</itemizedlist>
@@ -449,19 +449,19 @@
<listitem><para><guilabel>Num</guilabel></para></listitem>
<listitem><para><guilabel>Description</guilabel></para></listitem>
<listitem><para><guilabel>Memo</guilabel></para></listitem>
- <listitem><para><guilabel>Notes</guilabel> — Display the notes if the memo is unavailable</para></listitem>
+ <listitem><para><guilabel>Notes:</guilabel> Display the notes if the memo is unavailable</para></listitem>
<listitem><para><guilabel>Account Name</guilabel></para></listitem>
<listitem><para><guilabel>Use Full Account Name</guilabel></para></listitem>
<listitem><para><guilabel>Account Code</guilabel></para></listitem>
- <listitem><para><guilabel>Other Account Name</guilabel> — For multi-split transactions, this parameter should be unticked. See below for more details.</para>
+ <listitem><para><guilabel>Other Account Name:</guilabel> For multi-split transactions, this parameter should be unticked. See below for more details.</para>
</listitem>
<listitem><para><guilabel>Use Full Other Account Name</guilabel></para></listitem>
<listitem><para><guilabel>Other Account Code</guilabel></para></listitem>
- <listitem><para><guilabel>Shares</guilabel> — Display number of shares</para></listitem>
- <listitem><para><guilabel>Price</guilabel> — Display share prices</para></listitem>
+ <listitem><para><guilabel>Shares:</guilabel> Display number of shares</para></listitem>
+ <listitem><para><guilabel>Price:</guilabel> Display share prices</para></listitem>
- <listitem><para><guilabel>Amount</guilabel> — One of</para>
+ <listitem><para><guilabel>Amount:</guilabel> One of</para>
<informaltable>
<tgroup cols="2">
<tbody>
@@ -476,7 +476,7 @@
<listitem><para><guilabel>Running Balance</guilabel></para></listitem>
<listitem><para><guilabel>Totals</guilabel></para></listitem>
- <listitem><para><guilabel>Sign Reverses</guilabel> — One of</para>
+ <listitem><para><guilabel>Sign Reverses:</guilabel> One of</para>
<informaltable>
<tgroup cols="2">
<tbody>
@@ -494,10 +494,10 @@
<listitem><para><emphasis>General tab</emphasis></para>
<itemizedlist>
- <listitem><para><guilabel>Report name</guilabel> — Enter a descriptive name for this report</para></listitem>
- <listitem><para><guilabel>Stylesheet</guilabel> — Select Default, Easy, Footer or Technicolor</para></listitem>
+ <listitem><para><guilabel>Report name:</guilabel> Enter a descriptive name for this report</para></listitem>
+ <listitem><para><guilabel>Stylesheet:</guilabel> Select Default, Easy, Footer or Technicolor</para></listitem>
- <listitem><para><guilabel>Start Date</guilabel> — Enter or select a specific Start Date</para>
+ <listitem><para><guilabel>Start Date:</guilabel> Enter or select a specific Start Date</para>
<para>or select one of the following named start date options which will be used to determine the start date each time the report is run
</para>
<informaltable>
@@ -516,7 +516,7 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>End Date</guilabel> — Enter or select a specific End Date,</para>
+ <listitem><para><guilabel>End Date:</guilabel> Enter or select a specific End Date,</para>
<para>or select one of the following named end date options which will be used to determine the end date each time the report is run
</para>
<informaltable>
@@ -535,7 +535,7 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Style</guilabel> — One of</para>
+ <listitem><para><guilabel>Style:</guilabel> One of</para>
<informaltable>
<tgroup cols="2">
<tbody>
@@ -549,17 +549,17 @@
</note>
</listitem>
- <listitem><para><guilabel>Common Currency</guilabel> — Convert all transactions into a common currency</para></listitem>
- <listitem><para><guilabel>Report's currency</guilabel> — Select the currency to display values</para></listitem>
- <listitem><para><guilabel>Table for Exporting</guilabel> — Formats the table for cut & paste exporting with extra cells</para></listitem>
- <listitem><para><guilabel>Reset defaults button</guilabel> — Reset all values to their defaults</para></listitem>
+ <listitem><para><guilabel>Common Currency:</guilabel> Convert all transactions into a common currency</para></listitem>
+ <listitem><para><guilabel>Report's currency:</guilabel> Select the currency to display values</para></listitem>
+ <listitem><para><guilabel>Table for Exporting:</guilabel> Formats the table for cut & paste exporting with extra cells</para></listitem>
+ <listitem><para><guilabel>Reset defaults button:</guilabel> Reset all values to their defaults</para></listitem>
</itemizedlist>
</listitem>
<listitem><para><emphasis>Sorting tab</emphasis></para>
<itemizedlist>
- <listitem><para><guilabel>Primary Key</guilabel> — Primary Sort Key. One of</para>
+ <listitem><para><guilabel>Primary Key:</guilabel> Primary Sort Key. One of</para>
<informaltable>
<tgroup cols="2">
<tbody>
@@ -581,14 +581,14 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Show Full Account Name</guilabel> — Show the full account name for subtotals and subtitles</para></listitem>
- <listitem><para><guilabel>Show Account Code</guilabel> — Show the account code for subtotals and subtitles</para></listitem>
- <listitem><para><guilabel>Primary Subtotal</guilabel> — Subtotal according to the primary key</para></listitem>
- <listitem><para><guilabel>Primary Subtotal for Date Key</guilabel> — Do a date subtotal. Only configurable if primary key is date, exact time or register order.
+ <listitem><para><guilabel>Show Full Account Name:</guilabel> Show the full account name for subtotals and subtitles</para></listitem>
+ <listitem><para><guilabel>Show Account Code:</guilabel> Show the account code for subtotals and subtitles</para></listitem>
+ <listitem><para><guilabel>Primary Subtotal:</guilabel> Subtotal according to the primary key</para></listitem>
+ <listitem><para><guilabel>Primary Subtotal for Date Key:</guilabel> Do a date subtotal. Only configurable if primary key is date, exact time or register order.
One of None, weekly, monthly, quarterly or yearly</para>
</listitem>
- <listitem><para><guilabel>Primary Sort Order</guilabel> — One of</para>
+ <listitem><para><guilabel>Primary Sort Order:</guilabel> One of</para>
<informaltable>
<tgroup cols="2">
<tbody>
@@ -599,13 +599,13 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Secondary Key</guilabel> — Secondary Sort Key. Same options as Primary Key</para></listitem>
- <listitem><para><guilabel>Secondary Subtotal</guilabel> — Subtotal according to the secondary key</para></listitem>
- <listitem><para><guilabel>Secondary Subtotal for Date Key</guilabel> — Do a date subtotal. Only configurable if primary key is date, exact time or register order.
+ <listitem><para><guilabel>Secondary Key:</guilabel> Secondary Sort Key. Same options as Primary Key</para></listitem>
+ <listitem><para><guilabel>Secondary Subtotal:</guilabel> Subtotal according to the secondary key</para></listitem>
+ <listitem><para><guilabel>Secondary Subtotal for Date Key:</guilabel> Do a date subtotal. Only configurable if primary key is date, exact time or register order.
One of None, weekly, monthly, quarterly or yearly</para>
</listitem>
- <listitem><para><guilabel>Secondary Sort Order</guilabel> — One of</para>
+ <listitem><para><guilabel>Secondary Sort Order:</guilabel> One of</para>
<informaltable>
<tgroup cols="2">
<tbody>
@@ -616,7 +616,7 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Reset defaults button</guilabel> — Reset all values to their defaults</para></listitem>
+ <listitem><para><guilabel>Reset defaults button:</guilabel> Reset all values to their defaults</para></listitem>
</itemizedlist>
</listitem>
</itemizedlist>
@@ -723,47 +723,47 @@
<para>Columns</para>
<itemizedlist>
- <listitem><para><guilabel>Account</guilabel> — Stock Account</para>
+ <listitem><para><guilabel>Account:</guilabel> Stock Account</para>
</listitem>
- <listitem><para><guilabel>Symbol</guilabel> — Ticker Symbol/Abbreviation as defined in the Security Editor. A report option can suppress this column.</para>
+ <listitem><para><guilabel>Symbol:</guilabel> Ticker Symbol/Abbreviation as defined in the Security Editor. A report option can suppress this column.</para>
</listitem>
- <listitem><para><guilabel>Listing</guilabel> — Type as defined in the Security Editor. A report option can suppress this column.</para>
+ <listitem><para><guilabel>Listing:</guilabel> Type as defined in the Security Editor. A report option can suppress this column.</para>
</listitem>
- <listitem><para><guilabel>Shares</guilabel> — Number of shares (quantity). A report option sets how many decimal places to show.
+ <listitem><para><guilabel>Shares:</guilabel> Number of shares (quantity). A report option sets how many decimal places to show.
A report option can suppress this column.</para>
</listitem>
- <listitem><para><guilabel>Price</guilabel> — Unit market price as at report date. A report option can suppress this column.</para>
+ <listitem><para><guilabel>Price:</guilabel> Unit market price as at report date. A report option can suppress this column.</para>
</listitem>
- <listitem><para><guilabel>Basis</guilabel> — Cost of all shares acquired by any means, including brokerage fees if the option to include them is checked. Report option <emphasis>Basis calculation method</emphasis> can be set to Average, LIFO or FIFO.</para>
+ <listitem><para><guilabel>Basis:</guilabel> Cost of all shares acquired by any means, including brokerage fees if the option to include them is checked. Report option <emphasis>Basis calculation method</emphasis> can be set to Average, LIFO or FIFO.</para>
</listitem>
- <listitem><para><guilabel>Value</guilabel> — Number of shares * Unit market price as at report date</para>
+ <listitem><para><guilabel>Value:</guilabel> Number of shares * Unit market price as at report date</para>
</listitem>
- <listitem><para><guilabel>Money In</guilabel> — Sum of the cost of stock purchased, excluding stock acquired as part of a Dividend Reinvestment Plan. I.e. External money used to purchase shares.</para>
+ <listitem><para><guilabel>Money In:</guilabel> Sum of the cost of stock purchased, excluding stock acquired as part of a Dividend Reinvestment Plan. I.e. External money used to purchase shares.</para>
</listitem>
- <listitem><para><guilabel>Money Out</guilabel> — Money from selling shares or a spin off transaction.</para>
+ <listitem><para><guilabel>Money Out:</guilabel> Money from selling shares or a spin off transaction.</para>
</listitem>
- <listitem><para><guilabel>Realized Gain</guilabel> — Money received for selling shares minus basis for shares sold, minus brokerage fees for the sale if the option to include them in basis is checked.</para>
+ <listitem><para><guilabel>Realized Gain:</guilabel> Money received for selling shares minus basis for shares sold, minus brokerage fees for the sale if the option to include them in basis is checked.</para>
</listitem>
- <listitem><para><guilabel>Unrealized Gain</guilabel> — Value less Basis for unsold shares</para>
+ <listitem><para><guilabel>Unrealized Gain:</guilabel> Value less Basis for unsold shares</para>
</listitem>
- <listitem><para><guilabel>Total Gain</guilabel> — Realized Gain + Unrealized Gain</para>
+ <listitem><para><guilabel>Total Gain:</guilabel> Realized Gain + Unrealized Gain</para>
</listitem>
- <listitem><para><guilabel>Rate of Gain</guilabel> — Total Gain / Money In * 100 (from <application>&app;</application> 2.6.1 onwards)</para>
+ <listitem><para><guilabel>Rate of Gain:</guilabel> Total Gain / Money In * 100 (from <application>&app;</application> 2.6.1 onwards)</para>
</listitem>
- <listitem><para><guilabel>Income</guilabel> — Total of all income transactions associated with a stock account.</para>
+ <listitem><para><guilabel>Income:</guilabel> Total of all income transactions associated with a stock account.</para>
<note>
<para>To include income from dividends which are not reinvested (if there is no split to the stock account in the income transaction, the report has no way of associating the income with a particular stock) :
</para>
@@ -791,13 +791,13 @@
</note>
</listitem>
- <listitem><para><guilabel>Brokerage Fees</guilabel> — Brokerage Fees</para>
+ <listitem><para><guilabel>Brokerage Fees:</guilabel> Brokerage Fees</para>
</listitem>
- <listitem><para><guilabel>Total Return</guilabel> — Total Gain + Income</para>
+ <listitem><para><guilabel>Total Return:</guilabel> Total Gain + Income</para>
</listitem>
- <listitem><para><guilabel>Rate of Return</guilabel> — Total Return / Money In * 100</para>
+ <listitem><para><guilabel>Rate of Return:</guilabel> Total Return / Money In * 100</para>
</listitem>
</itemizedlist>
@@ -812,7 +812,7 @@
<itemizedlist>
- <listitem><para><guilabel>Include accounts with no shares</guilabel> — Unchecked (default) or checked.</para>
+ <listitem><para><guilabel>Include accounts with no shares:</guilabel> Unchecked (default) or checked.</para>
</listitem>
</itemizedlist>
@@ -823,19 +823,19 @@
<itemizedlist>
- <listitem><para><guilabel>Show ticker symbols</guilabel> — Checked default) or unchecked. If unchecked, Symbol column will be omitted.</para>
+ <listitem><para><guilabel>Show ticker symbols:</guilabel> Checked default) or unchecked. If unchecked, Symbol column will be omitted.</para>
</listitem>
- <listitem><para><guilabel>Show listings</guilabel> — Checked (default) or unchecked. If unchecked, Listing column (source of shares price quotes) will be omitted.</para>
+ <listitem><para><guilabel>Show listings:</guilabel> Checked (default) or unchecked. If unchecked, Listing column (source of shares price quotes) will be omitted.</para>
</listitem>
- <listitem><para><guilabel>Show number of shares</guilabel> — Checked (default) or unchecked. If unchecked, Shares column will be omitted.</para>
+ <listitem><para><guilabel>Show number of shares:</guilabel> Checked (default) or unchecked. If unchecked, Shares column will be omitted.</para>
</listitem>
- <listitem><para><guilabel>Share decimal places</guilabel> — The number of decimal places to show in the number of shares. Default is 2.</para>
+ <listitem><para><guilabel>Share decimal places:</guilabel> The number of decimal places to show in the number of shares. Default is 2.</para>
</listitem>
- <listitem><para><guilabel>Show prices</guilabel> — Checked (default) or unchecked. If unchecked, Price column will be omitted.</para>
+ <listitem><para><guilabel>Show prices:</guilabel> Checked (default) or unchecked. If unchecked, Price column will be omitted.</para>
</listitem>
</itemizedlist>
@@ -846,16 +846,16 @@
<itemizedlist>
- <listitem><para><guilabel>Price Source</guilabel> — Nearest in time (default) or Most Recent.</para>
+ <listitem><para><guilabel>Price Source:</guilabel> Nearest in time (default) or Most Recent.</para>
</listitem>
- <listitem><para><guilabel>Basis calculation method</guilabel> — Average (default), FIFO or LIFO.</para>
+ <listitem><para><guilabel>Basis calculation method:</guilabel> Average (default), FIFO or LIFO.</para>
</listitem>
- <listitem><para><guilabel>Set preference for price list data</guilabel> — Checked (default): Use price list data. If there is no relevant price list data, transaction prices will be used and there will be a warning. Unchecked: Get prices from stock transactions.</para>
+ <listitem><para><guilabel>Set preference for price list data:</guilabel> Checked (default): Use price list data. If there is no relevant price list data, transaction prices will be used and there will be a warning. Unchecked: Get prices from stock transactions.</para>
</listitem>
- <listitem><para><guilabel>How to report brokerage fees</guilabel> — Include in basis (default), Include in gain or Ignore.</para>
+ <listitem><para><guilabel>How to report brokerage fees:</guilabel> Include in basis (default), Include in gain or Ignore.</para>
</listitem>
</itemizedlist>
@@ -1054,28 +1054,28 @@
<itemizedlist>
<listitem><para><emphasis>General tab</emphasis></para>
<itemizedlist>
- <listitem><para><guilabel> Report name</guilabel> —
+ <listitem><para><guilabel> Report name:</guilabel>
Enter a descriptive name for this report - see common report
options.</para>
</listitem>
- <listitem><para><guilabel>Stylesheet</guilabel> —
+ <listitem><para><guilabel>Stylesheet:</guilabel>
Select a style sheet for this report - see common report
options.</para>
</listitem>
- <listitem><para><guilabel>To</guilabel> — Select a date
+ <listitem><para><guilabel>To:</guilabel> Select a date
to report on or a named date. Transactions up to and
including the selected date will be used to calculate the
outstanding aged balances. See common report options.</para>
</listitem>
- <listitem><para><guilabel>Report's currency</guilabel> —
+ <listitem><para><guilabel>Report's currency:</guilabel>
Select the currency to display the values in - see common
report options.</para>
</listitem>
- <listitem><para><guilabel>Price Source</guilabel> —
+ <listitem><para><guilabel>Price Source:</guilabel>
Select the source of price information used for currency
conversion if needed. One of</para>
<informaltable>
@@ -1099,12 +1099,12 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Show Multi-currency Totals</guilabel>
- — If not selected, all totals are shown in the report
+ <listitem><para><guilabel>Show Multi-currency Totals:</guilabel>
+ If not selected, all totals are shown in the report
currency.</para>
</listitem>
- <listitem><para><guilabel>Sort By</guilabel> — Sort
+ <listitem><para><guilabel>Sort By:</guilabel> Sort
companies by one of</para>
<informaltable>
<tgroup cols="2">
@@ -1124,7 +1124,7 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Sort Order</guilabel> — One of
+ <listitem><para><guilabel>Sort Order:</guilabel> One of
</para>
<informaltable>
<tgroup cols="2">
@@ -1136,12 +1136,12 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Show zero balance items</guilabel>
- — Show companies even if they have a zero outstanding
+ <listitem><para><guilabel>Show zero balance items:</guilabel>
+ Show companies even if they have a zero outstanding
balance.</para>
</listitem>
- <listitem><para><guilabel>Due or Post Date</guilabel> —
+ <listitem><para><guilabel>Due or Post Date:</guilabel>
Leading date. Which date to use to determine aging. One of
</para>
<informaltable>
@@ -1154,7 +1154,7 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Payable Account</guilabel> —
+ <listitem><para><guilabel>Payable Account:</guilabel>
The accounts payable account used to select vendors to be
reported. Vendors are included if they have a posted
business transaction (usually an invoice) on or before the
@@ -1166,41 +1166,41 @@
<listitem><para><emphasis>Display tab</emphasis></para>
<itemizedlist>
- <listitem><para><guilabel>Address Name</guilabel> —
+ <listitem><para><guilabel>Address Name:</guilabel>
Display vendor address name. This, and other fields, may be
useful if copying this report to a spreadsheet for use in a
mail merge.</para>
</listitem>
- <listitem><para><guilabel>Address 1</guilabel> — Display
+ <listitem><para><guilabel>Address 1:</guilabel> Display
address line 1.</para>
</listitem>
- <listitem><para><guilabel>Address 2</guilabel> — Display
+ <listitem><para><guilabel>Address 2:</guilabel> Display
address line 2.</para>
</listitem>
- <listitem><para><guilabel>Address 3</guilabel> — Display
+ <listitem><para><guilabel>Address 3:</guilabel> Display
address line 3.</para>
</listitem>
- <listitem><para><guilabel>Address 4</guilabel> — Display
+ <listitem><para><guilabel>Address 4:</guilabel> Display
address line 4.</para>
</listitem>
- <listitem><para><guilabel>Phone</guilabel> — Display
+ <listitem><para><guilabel>Phone:</guilabel> Display
address phone number.</para>
</listitem>
- <listitem><para><guilabel>Fax</guilabel> — Display
+ <listitem><para><guilabel>Fax:</guilabel> Display
address fax number.</para>
</listitem>
- <listitem><para><guilabel>Email</guilabel> — Display
+ <listitem><para><guilabel>Email:</guilabel> Display
email address.</para>
</listitem>
- <listitem><para><guilabel>Active</guilabel> — Display
+ <listitem><para><guilabel>Active:</guilabel> Display
vendor active status.</para>
</listitem>
</itemizedlist>
@@ -1246,28 +1246,28 @@
<itemizedlist>
<listitem><para><emphasis>General tab</emphasis></para>
<itemizedlist>
- <listitem><para><guilabel> Report name</guilabel> —
+ <listitem><para><guilabel> Report name:</guilabel>
Enter a descriptive name for this report - see common report
options.</para>
</listitem>
- <listitem><para><guilabel>Stylesheet</guilabel> —
+ <listitem><para><guilabel>Stylesheet:</guilabel>
Select a style sheet for this report - see common report
options.</para>
</listitem>
- <listitem><para><guilabel>To</guilabel> — Select a date
+ <listitem><para><guilabel>To:</guilabel> Select a date
to report on or a named date. Transactions up to and
including the selected date will be used to calculate the
outstanding aged balances. See common report options.</para>
</listitem>
- <listitem><para><guilabel>Report's currency</guilabel> —
+ <listitem><para><guilabel>Report's currency:</guilabel>
Select the currency to display the values in - see common
report options.</para>
</listitem>
- <listitem><para><guilabel>Price Source</guilabel> —
+ <listitem><para><guilabel>Price Source:</guilabel>
Select the source of price information used for currency
conversion if needed. One of</para>
<informaltable>
@@ -1291,12 +1291,12 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Show Multi-currency Totals</guilabel>
- — If not selected, all totals are shown in the report
+ <listitem><para><guilabel>Show Multi-currency Totals:</guilabel>
+ If not selected, all totals are shown in the report
currency.</para>
</listitem>
- <listitem><para><guilabel>Sort By</guilabel> — Sort
+ <listitem><para><guilabel>Sort By:</guilabel> Sort
companies by one of</para>
<informaltable>
<tgroup cols="2">
@@ -1316,7 +1316,7 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Sort Order</guilabel> — One of
+ <listitem><para><guilabel>Sort Order:</guilabel> One of
</para>
<informaltable>
<tgroup cols="2">
@@ -1328,12 +1328,12 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Show zero balance items</guilabel>
- — Show companies even if they have a zero outstanding
+ <listitem><para><guilabel>Show zero balance items:</guilabel>
+ Show companies even if they have a zero outstanding
balance.</para>
</listitem>
- <listitem><para><guilabel>Due or Post Date</guilabel> —
+ <listitem><para><guilabel>Due or Post Date:</guilabel>
Leading date. Which date to use to determine aging. One of
</para>
<informaltable>
@@ -1346,7 +1346,7 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Receivables Account</guilabel> —
+ <listitem><para><guilabel>Receivables Account:</guilabel>
The accounts receivable account used to select customers to be
reported. Customers are included if they have a posted
business transaction (usually an invoice) on or before the
@@ -1358,7 +1358,7 @@
<listitem><para><emphasis>Display tab</emphasis></para>
<itemizedlist>
- <listitem><para><guilabel>Address Source</guilabel> —
+ <listitem><para><guilabel>Address Source:</guilabel>
Which customer address fields to display. One of</para>
<informaltable>
<tgroup cols="2">
@@ -1372,41 +1372,41 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Address Name</guilabel> —
+ <listitem><para><guilabel>Address Name:</guilabel>
Display customer address name. This, and other fields, may be
useful if copying this report to a spreadsheet for use in a
mail merge.</para>
</listitem>
- <listitem><para><guilabel>Address 1</guilabel> — Display
+ <listitem><para><guilabel>Address 1:</guilabel> Display
address line 1.</para>
</listitem>
- <listitem><para><guilabel>Address 2</guilabel> — Display
+ <listitem><para><guilabel>Address 2:</guilabel> Display
address line 2.</para>
</listitem>
- <listitem><para><guilabel>Address 3</guilabel> — Display
+ <listitem><para><guilabel>Address 3:</guilabel> Display
address line 3.</para>
</listitem>
- <listitem><para><guilabel>Address 4</guilabel> — Display
+ <listitem><para><guilabel>Address 4:</guilabel> Display
address line 4.</para>
</listitem>
- <listitem><para><guilabel>Phone</guilabel> — Display
+ <listitem><para><guilabel>Phone:</guilabel> Display
address phone number.</para>
</listitem>
- <listitem><para><guilabel>Fax</guilabel> — Display
+ <listitem><para><guilabel>Fax:</guilabel> Display
address fax number.</para>
</listitem>
- <listitem><para><guilabel>Email</guilabel> — Display
+ <listitem><para><guilabel>Email:</guilabel> Display
email address.</para>
</listitem>
- <listitem><para><guilabel>Active</guilabel> — Display
+ <listitem><para><guilabel>Active:</guilabel> Display
vendor active status.</para>
</listitem>
</itemizedlist>
commit b1f681719d755da7334c9077c45e174fc8248081
Author: goodvibes2 <chris.good at ozemail.com.au>
Date: Sat Nov 5 18:05:11 2016 +1100
Bug 755174 Help Document Lots in Account window
diff --git a/guide/C/ch_invest.xml b/guide/C/ch_invest.xml
index 53e8657..610a634 100644
--- a/guide/C/ch_invest.xml
+++ b/guide/C/ch_invest.xml
@@ -1930,13 +1930,12 @@ Income
</screenshot>
</figure>
-<!-- Link to future (soon!) new Help section
- <para>Refer to the <ulink
+ <para>Refer to the Help Manual, Chapter 8 Tools & Assistants,
+ <ulink
url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html">
- Help Manual, Chapter 8 Tools & Assistants, Lots in Account
- </ulink> for details of the Lots in Account screen elements.
+ Lots in Account
+ </ulink> for details of the Lots in Account screen elements.
</para>
--->
</sect3>
<sect3 id="invest-sellProcedure">
diff --git a/help/C/Help_ch_Tools_Assistants.xml b/help/C/Help_ch_Tools_Assistants.xml
index e056ee4..1b83cc8 100644
--- a/help/C/Help_ch_Tools_Assistants.xml
+++ b/help/C/Help_ch_Tools_Assistants.xml
@@ -3165,4 +3165,548 @@
accounts.</para>
</sect2>
</sect1>
+
+ <sect1 id="tool-lots">
+ <title>Lots in Account</title>
+ <para>
+ <application>&app;</application> uses <emphasis>lots</emphasis> in 2 ways:
+ </para>
+
+ <itemizedlist>
+ <listitem><para>To link security buy transactions to sell transactions so
+ the real cost of the sold securities can be used to calculate capital
+ gain or loss. See <xref linkend="tool-lots-cap" />.</para>
+ </listitem>
+
+ <listitem><para>To link payments or credit notes to the invoices to which
+ they apply in the Business Features. See
+ <xref linkend="tool-lots-bus" />.</para>
+ </listitem>
+
+ </itemizedlist>
+
+ <sect2 id="tool-lots-cap">
+ <title>Lots for Security Capital Gains</title>
+ <para>
+ The <guilabel>Lots in Account SSSS</guilabel> window, where SSSS is
+ the security account, is used to manually or automatically link
+ security transaction splits to lots and create capital gain/loss
+ transactions to account for the difference between the costs of buying
+ a security and the value received by selling it.
+ </para>
+
+ <para>To open the <guilabel>Lots in Account</guilabel> window, open the
+ security account register, then select
+ <menuchoice>
+ <guimenu>Actions</guimenu>
+ <guimenuitem>View Lots</guimenuitem>
+ </menuchoice>.
+ </para>
+
+ <figure pgwide="1">
+ <title>Lots in Account window for Security Capital Gains
+ </title>
+ <screenshot id="tool-lotsInAcctStk">
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="figures/Help_Tool_LotsStk.png"
+ format="PNG" srccredit="Chris Good" width="510px"></imagedata>
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata fileref="figures/Help_Tool_LotsStk.png"
+ format="PNG" srccredit="Chris Good" ></imagedata>
+ </imageobject>
+
+ <textobject>
+ <phrase>Example of Lots in Account window for a security account
+ </phrase>
+ </textobject>
+
+ <caption><para>An image of the <emphasis>Lots in Account
+ </emphasis> window for a security account.</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <sect3 id="tool-lots-cap-scr">
+ <title>Screen Elements</title>
+
+ <para><emphasis>Adjusting the Size of Screen Elements</emphasis>
+ </para>
+
+ <para>As well as adjusting the size of the whole window, it is
+ possible to adjust the proportions of the window elements both
+ horizontally and vertically.
+ </para>
+
+ <para>There are 2 bars for adjusting the window horizontally. One
+ between the <guilabel>Title</guilabel> and the <guilabel>Lots in
+ This Account</guilabel> panel, and the other between the <guilabel>
+ Splits free</guilabel> panel and the <guilabel>>></guilabel>
+ and <guilabel><<</guilabel> buttons.
+ </para>
+
+ <para>The window proportions may be adjusted vertically by
+ dragging the vertical bar located to the right of <guilabel>Show
+ only open lots</guilabel>.
+ </para>
+
+ <para>These resizing bars can be hard to see, so move the mouse pointer
+ until it changes to the resize pointer then click and drag the bar.
+ The resize pointers are different depending on your operating system
+ and theme. Here are some examples of resize pointers:
+ </para>
+
+ <para>
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="figures/Help_Tool_Lots_h_double_arrow.png"
+ format="PNG" width="48px" />
+ </imageobject>
+ <textobject>
+ <phrase><-></phrase>
+ </textobject>
+ </inlinemediaobject>
+
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="figures/Help_Tool_Lots_v_double_arrow.png"
+ format="PNG" width="48px" />
+ </imageobject>
+ </inlinemediaobject>
+ </para>
+
+ <para>It is not possible to individually adjust the size of panel
+ columns.
+ </para>
+
+ <para><emphasis>Fields</emphasis></para>
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>Title:</guilabel> Shows the title for the highlighted
+ (selected) lot in the <guilabel>Lots in This Account </guilabel>
+ panel. When a new lot is created by clicking the <guilabel>New Lot
+ </guilabel> button, it has a default title of <emphasis>Lot n
+ </emphasis> where n is a number starting at 0 (for each security
+ account) and incrementing by 1. Deleting a lot does not reset the
+ next number to be used, but the title can be changed as required.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Notes:</guilabel> Notes for the highlighted lot.
+ Users are free to enter anything they wish and the notes can be
+ changed as required.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para><emphasis>Panels</emphasis></para>
+
+ <para>The order of the items in all the panels in this window
+ can be adjusted by clicking on the column headings.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para><guilabel>Lots in This Account panel</guilabel></para>
+ <para>This panel shows lots for this security account.</para>
+ <para>If <guilabel>Show only open lots</guilabel> is checked, only
+ lots that have not been completely sold are shown.
+ </para>
+ <para><guilabel>Columns</guilabel></para>
+ <itemizedlist>
+ <listitem><para><guilabel>Type:</guilabel> Always
+ blank for security lots. This window is also used for business
+ lots (which link payments to invoices) when coming from an
+ Accounts Payable or Receivable account and in that case,
+ <guilabel>Type</guilabel> will be <emphasis>I</emphasis> for
+ invoice. Credit Notes are also Type I.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Opened:</guilabel> <emphasis>Open
+ </emphasis> if there are no splits in the lot, otherwise the
+ date of the earliest split in this lot.</para>
+ </listitem>
+
+ <listitem><para><guilabel>Closed:</guilabel> <emphasis>
+ Open</emphasis> if the lot is not fully sold, otherwise the
+ date of the last sell split.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Title:</guilabel> Lot Title.</para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Balance:</guilabel> Number of unsold
+ securities in this lot.</para>
+ </listitem>
+
+ <listitem><para><guilabel>Gains:</guilabel> Calculated
+ gains or losses for this lot.</para>
+ </listitem>
+ </itemizedlist> <!-- end of Columns in Lots in This Account -->
+
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Splits free panel</guilabel></para>
+
+ <para>This panel shows buy and sell splits for this security
+ account which are not linked to a lot. Capital Gains splits
+ (Shares and Price are 0) are not shown.
+ </para>
+
+ <para><guilabel>Columns</guilabel></para>
+
+ <itemizedlist>
+ <listitem><para><guilabel>Date:</guilabel> Transaction Date Posted.
+ </para>
+ </listitem>
+
+ <listitem><para><guilabel>Num:</guilabel> Transaction Num.</para>
+ </listitem>
+
+ <listitem><para><guilabel>Description:</guilabel> Transaction
+ Description.</para>
+ </listitem>
+
+ <listitem><para><guilabel>Amount:</guilabel>
+ Number of shares bought or sold from the transaction split.
+ Positive for buys, negative for sells. If the security
+ transaction split has been split into multiple subsplits
+ (because a split may only be linked to 1 lot), this amount
+ will not be the full transaction amount, but only the amount
+ for this split.</para>
+ </listitem>
+
+ <listitem><para><guilabel>Value:</guilabel> Amount x split price.
+ </para>
+ </listitem>
+
+ <listitem><para><guilabel>Gain/Loss:</guilabel>
+ For sell splits, shows calculated gain or loss. This will
+ be recalculated during scrubbing.</para>
+ </listitem>
+
+ <listitem><para><guilabel>Balance:</guilabel>
+ Cumulative number of unsold shares for free splits.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem> <!-- end Splits free panel -->
+
+ <listitem>
+ <para><guilabel>Splits in Lot panel</guilabel></para>
+
+ <para>This panel shows splits linked to the highlighted lot in
+ the <guilabel>Lots in This Account</guilabel> panel. This
+ panel will be empty until a lot is highlighted in the
+ <guilabel>Lots in This Account</guilabel> panel. Capital Gains
+ splits (Shares and Price are 0) are not shown.
+ </para>
+
+ <para>
+ <emphasis>Columns</emphasis>
+ </para>
+
+ <itemizedlist>
+ <listitem><para><guilabel>Date:</guilabel>
+ Transaction Date Posted.</para>
+ </listitem>
+
+ <listitem><para><guilabel>Num:</guilabel>
+ Transaction Num.</para>
+ </listitem>
+
+ <listitem><para><guilabel>Description:</guilabel>
+ Transaction Description.</para>
+ </listitem>
+
+ <listitem><para><guilabel>Amount:</guilabel>
+ Split number of shares bought or sold. Positive for buys,
+ negative for sells. If the security transaction split has been
+ split into multiple subsplits (say by scrubbing because a
+ split may only be linked to 1 lot), this amount will not be
+ the full transaction amount, but only the amount for this
+ split.
+ </para>
+ </listitem>
+
+ <listitem><para><guilabel>Value:</guilabel>
+ Amount (No of Shares) x split price.</para>
+ </listitem>
+
+ <listitem><para><guilabel>Gain/Loss:</guilabel>
+ For sell splits, shows calculated gain or loss. This will
+ be recalculated during scrubbing.</para>
+ </listitem>
+
+ <listitem><para><guilabel>Balance:</guilabel>
+ The number of unsold shares in this lot after this
+ transaction.</para>
+ </listitem>
+ </itemizedlist>
+
+ </listitem> <!-- end Splits in Lot panel -->
+ </itemizedlist> <!-- end Panels -->
+
+ <para><emphasis>Buttons</emphasis></para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <guilabel> >>:</guilabel> Links a free split
+ (buy or sell) to a lot. This button is not enabled until both
+ a lot and a free split are highlighted. The split moves from
+ the <guilabel>Splits free</guilabel> panel to the <guilabel>
+ Splits in lot</guilabel> panel.
+ </para>
+
+ <para>Multiple buy splits and multiple sell splits may be linked
+ to the same lot. Refer to following section about the <guilabel>
+ Scrub Account</guilabel> button for details of the capital gains
+ transactions created in these situations.
+ </para>
+
+ </listitem>
+
+ <listitem>
+ <para><guilabel> <<:</guilabel> Unlinks a split
+ from a lot. The split moves from the <guilabel>Splits in lot
+ </guilabel> panel to the <guilabel>Splits free</guilabel> panel.
+ This button is not enabled until a split in the <guilabel>Splits
+ in lot</guilabel> panel is highlighted. When the last split is
+ unlinked from a lot, the lot is automatically deleted
+ if there is no capital gain/loss transaction.</para>
+ </listitem>
+
+ <listitem><para><guilabel>New Lot:</guilabel> Creates a new
+ lot which shows in the <guilabel>Lots in This Account</guilabel>
+ panel. The new lot is not linked to any split.</para>
+ </listitem>
+
+ <listitem>
+ <para>
+ <guilabel>Scrub Account:</guilabel>
+ </para>
+ <itemizedlist>
+ <listitem><para>Creates a lot for each buy transaction split
+ that is not already linked to a lot.</para>
+ <para>A new lot is created for each unlinked buy transaction
+ split because gains on investments, in some jurisdictions,
+ may be taxed at different rates depending on how long they
+ were held before being sold. As a separate capital gains
+ transaction is created for each lot, this makes it easier to
+ determine tax on the capital gains based on the lot opened
+ and closed dates.
+ </para>
+
+ <para>If you know that the capital gains from a
+ sale are all to be taxed at the same rate, you can manually
+ link multiple buys to a lot so scrubbing will only create
+ 1 capital gains transaction.
+ </para>
+
+ <para>
+ It is also possible to manually link multiple sell
+ transaction splits to a lot. In this case scrubbing creates
+ a capital gains transaction per sell transaction split
+ based on the average cost of securities held at the time of
+ each sale, assuming acquisitions are allocated to sales
+ using the security account costing method (currently only
+ FIFO). As this makes it complicated to manually verify the
+ costs are correct, it may be wise to limit this to specific
+ situations, say for example if there are multiple sales on
+ the same day.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>Links buy and sell transaction splits to lots using FIFO
+ method.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>Calculates gain/loss and creates a separate capital
+ gain/loss transaction for each lot that does not already
+ have one.
+ </para>
+
+ <note>
+ <para>If gain/loss splits have been manually entered as
+ part of a sell transaction, scrubbing does not recognize
+ them, so if manually adding gain/loss, always separate
+ the gain/loss splits from the transaction that reduces
+ the <guilabel>No of Shares</guilabel>, by putting them
+ in a separate transaction.
+ </para>
+ </note>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Scrub:</guilabel> Scrub only the
+ highlighted lot. This button is only enabled if a lot is
+ highlighted. If no buy splits are linked to the highlighted lot,
+ nothing is done. The <guilabel>Scrub</guilabel> button will link
+ any free sell splits to the lot as required until the sum of the
+ sell split amounts equals the sum of the buy split amounts. If
+ the sum of the sell split amounts is greater than the sum of the
+ buy split amounts, a sell split will itself be split into 2
+ splits, with the remaining amount in an unlinked split.
+ </para>
+
+ <note>
+ <para>For both the <guilabel>Scrub Account</guilabel> and the
+ <guilabel>Scrub</guilabel> buttons:
+ </para>
+
+ <para>The Gain/Loss for each lot is recalculated and a capital
+ gain transaction is created if needed. The transaction has
+ 1 split for the security account and the other with
+ account <emphasis>Orphaned Gains-CCC</emphasis> where CCC is
+ the security currency. The <emphasis>Orphaned Gains-CCC
+ </emphasis> account is used because <application>&app;
+ </application> doesn't know which capital gain or loss
+ account should be used, so the user must change it to the
+ required income (or expense) gain or loss account.
+ </para>
+ </note>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Delete:</guilabel> Delete the highlighted
+ lot. Any linked splits are automatically freed (unlinked). This
+ button is only enabled if a lot is highlighted.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para><guilabel>Close:</guilabel> Close the <guilabel>
+ Lots in Account SSSS</guilabel> window.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>See Tutorial and Concepts Guide, <ulink
+url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-guide/invest-sellLots.html">
+ Automatic Calculation of Capital Gain or Loss Using Lots</ulink> for
+ more details.
+ </para>
+
+ </sect3>
+ </sect2>
+
+ <sect2 id="tool-lots-bus">
+ <title>Lots for Business Features</title>
+
+ <sect3 id="tool-bots-bus-intro">
+ <title>Introduction</title>
+ <para>For business features, lots are used to link payments or credit
+ notes to the invoices to which they apply. This is for both customer
+ invoices and vendor bills.
+ </para>
+
+ <para>There are 2 main uses for the <guilabel>Lots in Account</guilabel>
+ window in relation to the business features:
+ </para>
+
+ <orderedlist>
+ <listitem>
+ <para>
+ To enquire about which payments or credit notes offset particular
+ invoices. For each invoice and credit note, <application>&app;
+ </application> automatically creates 1 (and only 1) lot. By
+ selecting the lot for the invoice or credit note in the <guilabel>
+ Lots in This Account</guilabel> panel, all the transaction splits
+ for that lot show in the <guilabel>Splits in Lot</guilabel> panel.
+ </para>
+
+ <tip>
+ <para>
+ Alternatively, print the invoice and check the <guilabel>
+ Payments</guilabel> option on the Display tab in the report
+ options. The Tax Invoice always shows payments so does not have
+ the Payments option.
+ </para>
+ </tip>
+ </listitem>
+
+ <listitem>
+ <para>
+ To correct mistakes that are hard to correct otherwise (either due
+ to bugs in past versions of gnucash or due to unintended use of
+ said features). Some of these use cases are found on
+ <ulink
+ url="https://wiki.gnucash.org/wiki/Business_Features_Issues">
+ this wiki page
+ </ulink>. In the context of the normal operation of business
+ features , the <guilabel>Lots in Account</guilabel> window is
+ <emphasis>not</emphasis> used to create, delete, link or unlink
+ lots. Lots are usually generated and manipulated internally only
+ by the business features programs.
+ </para>
+ </listitem>
+ </orderedlist>
+
+ <para>To open the <guilabel>Lots in Account AAAA</guilabel> window,
+ where AAAA is the <emphasis>Accounts Receivable</emphasis> (AR) or
+ <emphasis>Accounts Payable</emphasis> (AP) account, open the
+ <emphasis>AR</emphasis> or <emphasis>AP</emphasis> account register,
+ then select
+ <menuchoice>
+ <guimenu>Actions</guimenu>
+ <guimenuitem>View Lots</guimenuitem>
+ </menuchoice>.
+ </para>
+
+ <figure pgwide="1">
+ <title>Lots in Account window for business features</title>
+ <screenshot id="tool-lotsInAcctBus">
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="figures/Help_Tool_LotsBus.png"
+ format="PNG" srccredit="Chris Good" width="510px"></imagedata>
+ </imageobject>
+ <imageobject role="fo">
+ <imagedata fileref="figures/Help_Tool_LotsBus.png"
+ format="PNG" srccredit="Chris Good" ></imagedata>
+ </imageobject>
+
+ <textobject>
+ <phrase>Example of Lots in Account window for an Accounts
+ Receivable account
+ </phrase>
+ </textobject>
+
+ <caption><para>An image of the <guilabel>Lots in Account
+ </guilabel> window for an Accounts Receivable account.</para>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ </sect3>
+
+ <sect3 id="tool-lots-bus-scr">
+ <title>Screen Elements</title>
+
+ <para>The screen elements of the <guilabel>Lots in Account</guilabel>
+ window for an AR or AP account are the same as for a security account,
+ although the actions and data are different. As this window is only
+ used for creating, deleting, linking or unlinking lots in <emphasis>
+ exceptional</emphasis> circumstances, the differences are not
+ described. See <xref linkend="tool-lots-cap-scr" /> for a description
+ of the screen elements and what the buttons do when used with the lots
+ of a security account.
+ </para>
+
+ </sect3>
+ </sect2>
+ </sect1>
</chapter>
diff --git a/help/C/figures/Help_Tool_LotsBus.png b/help/C/figures/Help_Tool_LotsBus.png
new file mode 100755
index 0000000..9d9a6f1
Binary files /dev/null and b/help/C/figures/Help_Tool_LotsBus.png differ
diff --git a/help/C/figures/Help_Tool_LotsStk.png b/help/C/figures/Help_Tool_LotsStk.png
new file mode 100755
index 0000000..870ab3b
Binary files /dev/null and b/help/C/figures/Help_Tool_LotsStk.png differ
diff --git a/help/C/figures/Help_Tool_Lots_h_double_arrow.png b/help/C/figures/Help_Tool_Lots_h_double_arrow.png
new file mode 100644
index 0000000..3925b69
Binary files /dev/null and b/help/C/figures/Help_Tool_Lots_h_double_arrow.png differ
diff --git a/help/C/figures/Help_Tool_Lots_v_double_arrow.png b/help/C/figures/Help_Tool_Lots_v_double_arrow.png
new file mode 100644
index 0000000..569fd75
Binary files /dev/null and b/help/C/figures/Help_Tool_Lots_v_double_arrow.png differ
Summary of changes:
guide/C/ch_invest.xml | 13 +-
guide/C/ch_txns.xml | 26 +-
help/C/Help_ch_Customize.xml | 246 +++++-----
help/C/Help_ch_GettingStarted.xml | 30 +-
help/C/Help_ch_Reports.xml | 216 ++++----
help/C/Help_ch_Tools_Assistants.xml | 544 +++++++++++++++++++++
help/C/figures/Help_Tool_LotsBus.png | Bin 0 -> 63204 bytes
.../C/figures/Help_Tool_LotsStk.png | Bin
help/C/figures/Help_Tool_Lots_h_double_arrow.png | Bin 0 -> 1854 bytes
help/C/figures/Help_Tool_Lots_v_double_arrow.png | Bin 0 -> 1825 bytes
10 files changed, 821 insertions(+), 254 deletions(-)
create mode 100755 help/C/figures/Help_Tool_LotsBus.png
copy guide/C/figures/investLots2_BeforeScrub1Lot.png => help/C/figures/Help_Tool_LotsStk.png (100%)
mode change 100644 => 100755
create mode 100644 help/C/figures/Help_Tool_Lots_h_double_arrow.png
create mode 100644 help/C/figures/Help_Tool_Lots_v_double_arrow.png
More information about the gnucash-changes
mailing list