gnucash-docs master: Multiple changes pushed
Frank H.Ellenberger
fell at code.gnucash.org
Thu Feb 23 16:41:02 EST 2023
Updated via https://github.com/Gnucash/gnucash-docs/commit/03fad1ec (commit)
via https://github.com/Gnucash/gnucash-docs/commit/65215e52 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/b472d8e1 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/35217025 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/88636417 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/49b2f515 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/027e4720 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/85c27c6b (commit)
via https://github.com/Gnucash/gnucash-docs/commit/ee2bd74f (commit)
from https://github.com/Gnucash/gnucash-docs/commit/0f50d6bc (commit)
commit 03fad1ecd693c22a0fe26dd833e3c35e0e420fe8
Merge: 65215e52 b472d8e1
Author: Frank H. Ellenberger <frank.h.ellenberger at gmail.com>
Date: Thu Feb 23 19:41:00 2023 +0100
Merge PR #294
commit 65215e526ac878a287999e6e41da39dbde21ce2e
Merge: 0f50d6bc 35217025
Author: Frank H. Ellenberger <frank.h.ellenberger at gmail.com>
Date: Thu Feb 23 19:40:35 2023 +0100
Merge branch 'maint'
commit b472d8e192ad0e28b037cb236c9e3be1a5524669
Author: Frank H. Ellenberger <frank.h.ellenberger at gmail.com>
Date: Thu Feb 23 19:31:30 2023 +0100
Simplify screenshot declarations
diff --git a/C/manual/ch_Reports.xml b/C/manual/ch_Reports.xml
index b0d1c03f..f094d0f9 100644
--- a/C/manual/ch_Reports.xml
+++ b/C/manual/ch_Reports.xml
@@ -2417,12 +2417,7 @@ Income (type INCOME)
<screenshot id="InvestmentLotsStackedBarChart">
<screeninfo>800x630</screeninfo>
<mediaobject>
- <imageobject role="html">
- <imagedata fileref="figures/Report_Investment_Lots_StackedBar.png"
- srccredit="Brent McBride" width="&img-w;"/>
- </imageobject>
-
- <imageobject role="fo">
+ <imageobject>
<imagedata fileref="figures/Report_Investment_Lots_StackedBar.png"
srccredit="Brent McBride"/>
</imageobject>
@@ -2435,12 +2430,7 @@ Income (type INCOME)
<screenshot id="InvestmentLotsBarChart">
<screeninfo>800x667</screeninfo>
<mediaobject>
- <imageobject role="html">
- <imagedata fileref="figures/Report_Investment_Lots_Bar.png"
- srccredit="Brent McBride" width="&img-w;"/>
- </imageobject>
-
- <imageobject role="fo">
+ <imageobject>
<imagedata fileref="figures/Report_Investment_Lots_Bar.png"
srccredit="Brent McBride"/>
</imageobject>
commit 35217025dd875f90138dfe637fe918093c676229
Author: Frank H. Ellenberger <frank.h.ellenberger at gmail.com>
Date: Wed Feb 22 03:39:02 2023 +0100
Guide:C: Replace several wrong usages off "Help"
Protocol "help:"
Link type "Help"—both are only under Linux available
Document reference should be "Manual"
diff --git a/guide/C/appendixd.xml b/guide/C/appendixd.xml
index 7bc1360d..5e067796 100644
--- a/guide/C/appendixd.xml
+++ b/guide/C/appendixd.xml
@@ -758,10 +758,9 @@ Blocking_Chars</literallayout>
<guimenu>File</guimenu><guimenuitem>Properties </guimenuitem>
</menuchoice>
for number source (transaction number or anchor-split action - see
- <ulink type="help"
- url="help:gnucash-help?num-action-book-option">Use
+ <ulink url="&url-docs-C;help/book-options.html#num-action-book-option">Use
Split Action Field for Number</ulink> in the Book Options section of the &app;
- Help Manual).
+ Manual).
</entry>
</row>
@@ -808,10 +807,9 @@ Blocking_Chars</literallayout>
<guimenu>File</guimenu><guimenuitem> Properties</guimenuitem>
</menuchoice>
for number source (transaction number or anchor-split action - see
- <ulink
- type="help" url="help:gnucash-help?num-action-book-option">
+ <ulink url="&url-docs-C;help/book-options.html#num-action-book-option">
Use Split Action Field for Number</ulink> in the Book Options section of the &app;
- Help Manual). If number source for the book is specified as anchor-split action,
+ Manual). If number source for the book is specified as anchor-split action,
this field will instead print the transaction number field.
</entry>
</row>
diff --git a/guide/C/ch_basics.xml b/guide/C/ch_basics.xml
index 8d8728c0..f0574400 100644
--- a/guide/C/ch_basics.xml
+++ b/guide/C/ch_basics.xml
@@ -298,7 +298,7 @@ Translators:
common terms <guilabel>Deposit</guilabel> and <guilabel>Withdrawal</guilabel>. If you
prefer the formal accounting terms, you can change the account register column headings to
use them in the <guilabel>Accounts</guilabel> tab under <guilabel>Preferences</guilabel>
- (see the &app; Help Manual for more information on setting preferences).
+ (see the &app; Manual for more information on setting preferences).
</para>
</note>
@@ -1740,7 +1740,7 @@ Translators:
press the <guibutton>Forward</guibutton> button. You can also update these options later
using <menuchoice>
<guimenu>File </guimenu><guimenuitem>Properties</guimenuitem>
- </menuchoice>. For details of these options, see the &app; Help manual, chapter Customizing GnuCash, Book
+ </menuchoice>. For details of these options, see the &app; Manual, chapter Customizing GnuCash, Book
Options.
</para>
diff --git a/guide/C/ch_bus_features.xml b/guide/C/ch_bus_features.xml
index 612afb8b..8b712469 100644
--- a/guide/C/ch_bus_features.xml
+++ b/guide/C/ch_bus_features.xml
@@ -574,7 +574,7 @@
<menuchoice>
<guimenu>GnuCash</guimenu><guimenuitem>Preferences</guimenuitem>
</menuchoice>
- on &mac;). See Help manual chapter 10.3.3 Business Book Options Tab.
+ on &mac;). See &app; Manual chapter 10.3.3 Business Book Options Tab.
</para>
</sect2>
@@ -1698,8 +1698,8 @@
<guimenu>Reports</guimenu><guimenuitem>Account Report </guimenuitem>
</menuchoice>
. Further formatting or analysis may be done by copying and pasting the report into a
- spreadsheet. See <ulink type="help" url="help:gnucash-help?tool-find-txn">Find
- Transaction</ulink> in the &app; Help Manual.
+ spreadsheet. See <ulink url="&url-docs-C;help/tool-find.html?tool-find-txn">Find
+ Transaction</ulink> in the &app; Manual.
</para>
</note>
</para>
diff --git a/guide/C/ch_cc.xml b/guide/C/ch_cc.xml
index 8c941134..64db1817 100644
--- a/guide/C/ch_cc.xml
+++ b/guide/C/ch_cc.xml
@@ -148,7 +148,7 @@
import format.
</para>
- <para>For assistance with entering transactions, see Chapter 6 of the Help manual and
+ <para>For assistance with entering transactions, see Chapter 6 of the &app; Manual and
<xref linkend="chapter_txns"></xref>.
</para>
</sect1>
diff --git a/guide/C/ch_expenses.xml b/guide/C/ch_expenses.xml
index 869793ba..5619e7df 100644
--- a/guide/C/ch_expenses.xml
+++ b/guide/C/ch_expenses.xml
@@ -47,7 +47,7 @@
<para>For many users, the easiest way to set up expense accounts is to check the "Common Accounts" when
you create a new Account Hierarchy. This will establish many of the most common expense
- accounts that users need. See "New Account Hierarchy Setup" in Chapter 3 of the Help guide
+ accounts that users need. See "New Account Hierarchy Setup" in Chapter 3 of the &app; Manual
for more information.
</para>
</sect2>
@@ -56,7 +56,7 @@
<title>Complex Expense Account Setup</title>
<para>If you have different expense accounting needs, you can refer to
- <xref linkend="chapter_txns"></xref>, or Chapter 5.4 in the Help manual for instructions on
+ <xref linkend="chapter_txns"></xref>, or Chapter 5.4 in the &app; Manual for instructions on
how to create accounts.
</para>
diff --git a/guide/C/ch_importing.xml b/guide/C/ch_importing.xml
index 7f9f098b..bf37ed40 100644
--- a/guide/C/ch_importing.xml
+++ b/guide/C/ch_importing.xml
@@ -25,7 +25,7 @@
<para>This is an older version of
<ulink url="&url-docs-C;help/trans-import.html"><quote>Common Transaction
- Operations</quote> in Help</ulink>. Better continue there until this update anomalie is
+ Operations</quote> in the manual</ulink>. Better continue there until this update anomaly is
resolved.
</para>
</important>
diff --git a/guide/C/ch_invest.xml b/guide/C/ch_invest.xml
index c0154306..eedfdc7e 100644
--- a/guide/C/ch_invest.xml
+++ b/guide/C/ch_invest.xml
@@ -766,7 +766,7 @@ Income
<listitem>
<para>The <guilabel>Type:</guilabel> should already be <guilabel>NASDAQ</guilabel>, because this is what
was selected in the security selector, but you can change it here, including
- adding more categories. More information about this can be found in the Help
+ adding more categories. More information about this can be found in the &app;
Manual in section 8.7, <quote>Security Editor</quote>.
</para>
</listitem>
@@ -1296,7 +1296,7 @@ Income
<para>After you have verified the proper fetching of Online Quotes for your commodities,
you can tell your operating system to fetch the quotes periodically. See the section
- <ulink url="&url-docs;C/gnucash-help/finance-quote-scheduler.html">Configuring for Getting Quotes Periodically</ulink>
+ <ulink url="&url-docs-C;help/finance-quote-scheduler.html">Configuring for Getting Quotes Periodically</ulink>
in the manual.
</para>
</sect3>
commit 886364178f9f2e4586acde248b0a8cf5901d6a6b
Merge: 027e4720 49b2f515
Author: Geert Janssens <geert at kobaltwit.be>
Date: Sat Jan 21 11:58:14 2023 +0100
Merge branch 'PR296' into maint
commit 49b2f515072b120dce24ef402424fbdb0d0adcac
Author: sole <sole at users.noreply.github.com>
Date: Sat Jan 21 10:36:38 2023 +0000
Fix typo: expirience -> experience
diff --git a/manual/C/ch_Tools_Assistants.xml b/manual/C/ch_Tools_Assistants.xml
index 87419944..f7dbdde9 100644
--- a/manual/C/ch_Tools_Assistants.xml
+++ b/manual/C/ch_Tools_Assistants.xml
@@ -5152,7 +5152,7 @@
<term><acronym>EBICS</acronym></term>
<listitem>
- <para>No users shared their expirience util now.
+ <para>No users shared their experience util now.
</para>
</listitem>
</varlistentry>
commit 027e4720a9df60a40a19a28976c2c2484838d827
Author: sole <sole at users.noreply.github.com>
Date: Sat Jan 21 10:13:16 2023 +0000
Fixed typo: reciepts -> receipts
diff --git a/manual/C/ch_Transactions.xml b/manual/C/ch_Transactions.xml
index aa0e2956..65307e91 100644
--- a/manual/C/ch_Transactions.xml
+++ b/manual/C/ch_Transactions.xml
@@ -390,7 +390,7 @@ Translators:
<sect1 id="trans-assoc">
<title>Associating an External File with a Transaction.</title>
- <para>Some users find it helpful to associate external files or URLs, perhaps images of store reciepts,
+ <para>Some users find it helpful to associate external files or URLs, perhaps images of store receipts,
cancelled checks, or vendor invoices, with their transactions. &app; provides a facility for
doing just that.
</para>
commit 85c27c6b39030e346d5d3fdfb010943579dc6534
Author: Brent McBride <mcbridebt at hotmail.com>
Date: Wed Jan 11 23:56:30 2023 -0800
process code review feedback
diff --git a/C/guide/ch_reports.xml b/C/guide/ch_reports.xml
index 2b998059..0135aa30 100644
--- a/C/guide/ch_reports.xml
+++ b/C/guide/ch_reports.xml
@@ -360,8 +360,8 @@
</itemizedlist>
<para>For more details, see the
- <ulink url="&url-docs;/C/gnucash-help/report-classes.html#investment-lots-report">Investment Lots</ulink>
- report documentation in the Help Manual.
+ <ulink url="&url-docs-C;help/report-classes.html#investment-lots-report">Investment Lots</ulink>
+ report documentation in the Manual.
</para>
</sect3>
diff --git a/C/manual/ch_Reports.xml b/C/manual/ch_Reports.xml
index 0f56340b..b0d1c03f 100644
--- a/C/manual/ch_Reports.xml
+++ b/C/manual/ch_Reports.xml
@@ -2108,19 +2108,21 @@ Income (type INCOME)
</screenshot>
</figure>
- <para>The Investment Lots report shows details about lots in a selected set of accounts of type
- <emphasis>Stock</emphasis> or <emphasis>Mutual Fund</emphasis>.
- It includes an optional <link linkend="investment-lots-report-chart">capital gains summary chart</link>
- and a <link linkend="investment-lots-report-columns">table</link> with columns for
- <link linkend="investment-lots-report-column-d">dates</link>,
- <link linkend="investment-lots-report-column-b">purchases</link>,
- <link linkend="investment-lots-report-column-s">sales</link>,
- <link linkend="investment-lots-report-column-e">end balances</link>,
- capital gains (<link linkend="investment-lots-report-column-r">realized</link> and
- <link linkend="investment-lots-report-column-r">unrealized</link>,
- short term and long term), and return on investment (ROI). It also performs optional lot
- <link linkend="investment-lots-report-options-val">validation checks</link>.
- </para>
+ <abstract>
+ <para>The Investment Lots report shows details about lots in a selected set of accounts of type
+ <emphasis>Stock</emphasis> or <emphasis>Mutual Fund</emphasis>.
+ It includes an optional <link linkend="investment-lots-report-chart">capital gains summary chart</link>
+ and a <link linkend="investment-lots-report-columns">table</link> with columns for
+ <link linkend="investment-lots-report-column-d">dates</link>,
+ <link linkend="investment-lots-report-column-b">purchases</link>,
+ <link linkend="investment-lots-report-column-s">sales</link>,
+ <link linkend="investment-lots-report-column-e">end balances</link>,
+ capital gains (<link linkend="investment-lots-report-column-r">realized</link> and
+ <link linkend="investment-lots-report-column-r">unrealized</link>,
+ short term and long term), and return on investment (ROI). It also performs optional lot
+ <link linkend="investment-lots-report-options-val">validation checks</link>.
+ </para>
+ </abstract>
<para>For information about lots in &app;, see:
<itemizedlist>
@@ -2128,7 +2130,7 @@ Income (type INCOME)
<para><xref linkend="tool-lots-cap" />
</para>
<note>
- <para>Lots may be used for both securities and invoices, but this report applies to securities.
+ <para>Lots can be used for both securities and invoices, but this report applies to securities.
</para>
</note>
</listitem>
@@ -2163,7 +2165,7 @@ Income (type INCOME)
<para id="investment-lots-report-columns">Table Columns
</para>
<note>
- <para>Most of the columns may be hidden in the report
+ <para>Most of the columns can be hidden in the report
<link linkend="investment-lots-report-options-columns">Column options</link>.
</para>
</note>
@@ -2192,7 +2194,7 @@ Income (type INCOME)
is the transaction date of the first (and ideally only) purchase split.
</para>
<warning>
- <para>Placing more than one purchase split into a single lot may make ambiguous the holding period,
+ <para>Placing more than one purchase split into a single lot can make ambiguous the holding period,
preventing gains from being accurately grouped by short term and long term.
</para>
</warning>
@@ -2255,10 +2257,10 @@ Income (type INCOME)
<para>The
<link linkend="investment-lots-report-column-sa"><guilabel>Sold Amount</guilabel></link>,
<link linkend="investment-lots-report-column-sb"><guilabel>Sold Basis</guilabel></link>, and
- <link linkend="investment-lots-report-column-sv"><guilabel>Sold Value</guilabel></link> columns may be
+ <link linkend="investment-lots-report-column-sv"><guilabel>Sold Value</guilabel></link> columns can be
optionally split into short-term and long-term columns (e.g. <guilabel>ST Sold Amount</guilabel> and
<guilabel>LT Sold Amount</guilabel> instead of
- <link linkend="investment-lots-report-column-sa"><guilabel>Sold Amount</guilabel></link>, etc.) via
+ <link linkend="investment-lots-report-column-sa"><guilabel>Sold Amount</guilabel></link>, etc.) via
the <link linkend="investment-lots-report-options-columns-gg"><guilabel>Group gains by age (short
term and long term)</guilabel></link> Columns option.
</para>
@@ -2330,7 +2332,7 @@ Income (type INCOME)
</listitem>
</itemizedlist>
<note>
- <para>The realized and unrealized gain columns may be optionally split into short-term and
+ <para>The realized and unrealized gain columns can be optionally split into short-term and
long-term columns (e.g. <guilabel>ST Realized Gain</guilabel> and <guilabel>LT Realized Gain</guilabel>
instead of <link linkend="investment-lots-report-column-rg"><guilabel>Realized Gain</guilabel></link>,
etc.) via the <link linkend="investment-lots-report-options-columns-gg"><guilabel>Group gains by age (short
@@ -2539,7 +2541,7 @@ Income (type INCOME)
</para>
</listitem>
<listitem id="investment-lots-report-options-columns-gg">
- <para><guilabel>Group gains by age (short term and long term)</guilabel>: Different governments may have different
+ <para><guilabel>Group gains by age (short term and long term)</guilabel>: Different governments can have different
rules regarding how long shares must be held to qualify for different tax treatment.
</para>
<informaltable>
commit ee2bd74f5178eeb832a29113a9d95b6b9418ece7
Author: Brent McBride <mcbridebt at hotmail.com>
Date: Fri Dec 23 23:12:02 2022 -0800
Add documentation for new Investment Lots report
Add screenshots, links, etc
more cleanup, add missing images
cleanup documentation
diff --git a/C/guide/CMakeLists.txt b/C/guide/CMakeLists.txt
index 280d5de6..aff80b3e 100644
--- a/C/guide/CMakeLists.txt
+++ b/C/guide/CMakeLists.txt
@@ -183,6 +183,7 @@ set (figures
figures/loans_mortgage2.png
figures/loans_mortgage3.png
figures/oview_intro.png
+ figures/Report_Investment_Lots.png
figures/txns_CashFlow.png
figures/txns_TransactionRptChecking.png
figures/txns_TransactionRptExpenses.png
diff --git a/C/guide/ch_reports.xml b/C/guide/ch_reports.xml
index 411226cf..2b998059 100644
--- a/C/guide/ch_reports.xml
+++ b/C/guide/ch_reports.xml
@@ -304,6 +304,67 @@
</para>
</sect3>
+ <sect3 id="rpt_investlots">
+ <title>Investment Lots</title>
+
+ <figure id="fig-investlots" pgwide="1">
+ <title>The Investment Lots Report</title>
+ <screenshot id="InvestmentLotsScreenShot">
+ <screeninfo>1720x982</screeninfo>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="figures/Report_Investment_Lots.png"
+ srccredit="Brent McBride" width="&img-w;"/>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="figures/Report_Investment_Lots.png"
+ srccredit="Brent McBride"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <para>The Investment Lots report shows details about lots in a selected set of accounts of type
+ <emphasis>Stock</emphasis> or <emphasis>Mutual Fund</emphasis> (see <xref linkend="invest-sellLots" />).
+ It includes an optional capital gains summary chart and a table with columns for dates, purchases, sales, end
+ balances, capital gains (realized and unrealized, short term and long term), and return on investment (ROI).
+ It also performs optional lot validation checks.
+ </para>
+
+ <para>The report can help answer questions such as:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Which lots are best candidates for tax loss/gain harvesting?
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>What capital gains have been realized for a particular time period (i.e. this year, last year,
+ etc)? Are they long term or short term gains?
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>Which lots held longer than 1+ years have the largest unrealized gains, and would therefore be
+ most advantageous (tax-wise) if donated to charity?
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>Are the lots (and related accounts and splits) well-formed?
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>For more details, see the
+ <ulink url="&url-docs;/C/gnucash-help/report-classes.html#investment-lots-report">Investment Lots</ulink>
+ report documentation in the Help Manual.
+ </para>
+ </sect3>
+
<sect3 id="rpt_investport">
<title>Investment Portfolio</title>
diff --git a/C/guide/figures/Report_Investment_Lots.png b/C/guide/figures/Report_Investment_Lots.png
new file mode 100644
index 00000000..8cc3218e
Binary files /dev/null and b/C/guide/figures/Report_Investment_Lots.png differ
diff --git a/C/guide/index.docbook b/C/guide/index.docbook
index a393c469..56084e85 100644
--- a/C/guide/index.docbook
+++ b/C/guide/index.docbook
@@ -622,6 +622,10 @@
<firstname>Cristian</firstname> <surname>Marchi</surname>
</author>
,
+ <author>
+ <firstname>Brent</firstname> <surname>McBride</surname>
+ </author>
+ ,
<author>
<firstname>John</firstname> <surname>Ralls</surname>
</author>
diff --git a/C/manual/CMakeLists.txt b/C/manual/CMakeLists.txt
index 8ac73e9e..b7855838 100644
--- a/C/manual/CMakeLists.txt
+++ b/C/manual/CMakeLists.txt
@@ -47,6 +47,9 @@ set (figures
figures/Pref_Sched.png
figures/Pref_Windows.png
figures/Report_Screen.png
+ figures/Report_Investment_Lots_Bar.png
+ figures/Report_Investment_Lots_StackedBar.png
+ figures/Report_Investment_Lots.png
figures/Tool_LotsBus.png
figures/Tool_LotsStk.png
figures/Tool_Lots_h_double_arrow.png
diff --git a/C/manual/ch_Reports.xml b/C/manual/ch_Reports.xml
index 2c2e4746..0f56340b 100644
--- a/C/manual/ch_Reports.xml
+++ b/C/manual/ch_Reports.xml
@@ -2086,6 +2086,722 @@ Income (type INCOME)
</para>
</listitem>
+ <listitem id="investment-lots-report">
+ <para>Investment Lots:
+ </para>
+
+ <figure id="fig-investlots" pgwide="1">
+ <title>The Investment Lots Report</title>
+ <screenshot id="InvestmentLotsScreenShot">
+ <screeninfo>1720x982</screeninfo>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="figures/Report_Investment_Lots.png"
+ srccredit="Brent McBride" width="&img-w;"/>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="figures/Report_Investment_Lots.png"
+ srccredit="Brent McBride"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <para>The Investment Lots report shows details about lots in a selected set of accounts of type
+ <emphasis>Stock</emphasis> or <emphasis>Mutual Fund</emphasis>.
+ It includes an optional <link linkend="investment-lots-report-chart">capital gains summary chart</link>
+ and a <link linkend="investment-lots-report-columns">table</link> with columns for
+ <link linkend="investment-lots-report-column-d">dates</link>,
+ <link linkend="investment-lots-report-column-b">purchases</link>,
+ <link linkend="investment-lots-report-column-s">sales</link>,
+ <link linkend="investment-lots-report-column-e">end balances</link>,
+ capital gains (<link linkend="investment-lots-report-column-r">realized</link> and
+ <link linkend="investment-lots-report-column-r">unrealized</link>,
+ short term and long term), and return on investment (ROI). It also performs optional lot
+ <link linkend="investment-lots-report-options-val">validation checks</link>.
+ </para>
+
+ <para>For information about lots in &app;, see:
+ <itemizedlist>
+ <listitem>
+ <para><xref linkend="tool-lots-cap" />
+ </para>
+ <note>
+ <para>Lots may be used for both securities and invoices, but this report applies to securities.
+ </para>
+ </note>
+ </listitem>
+ <listitem>
+ <para>Tutorial and Concepts Guide
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <ulink url="&url-docs-C;guide/invest-sell1.html#invest-sellLots">
+ Selling Shares with Automatic Calculation of Capital Gain or Loss Using Lots</ulink>
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <ulink url="&url-docs-C;guide/rpt_standardrpts.html#rpt_investlots">
+ Investment Lots</ulink> report
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem>
+ <para>Wiki: <ulink url="&url-wiki-lots;">Concept of Lots</ulink>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+ <para id="investment-lots-report-chart">Account lots gains chart: Summarizes the lot gains and losses of each account.
+ </para>
+
+ <para id="investment-lots-report-columns">Table Columns
+ </para>
+ <note>
+ <para>Most of the columns may be hidden in the report
+ <link linkend="investment-lots-report-options-columns">Column options</link>.
+ </para>
+ </note>
+ <note>
+ <para>The Amount columns are denominated in each account's commodity. But the Value, Basis, Price, and
+ Gain columns are always denominated in the <guilabel>Report's currency</guilabel>, converted if necessary.
+ </para>
+ </note>
+ <itemizedlist>
+ <listitem id="investment-lots-report-column-title">
+ <para><guilabel>Lot Title</guilabel>
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-column-guid">
+ <para><guilabel>GUID</guilabel>: The lot's internal, globally unique identifier. This column is hidden by
+ default, as it is probably not useful for most use cases. But it could come in handy for directly querying
+ the &app; back end data store.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-column-d">
+ <para>Date columns
+ </para>
+ <itemizedlist>
+ <listitem id="investment-lots-report-column-opened">
+ <para><guilabel>Opened</guilabel>: The date on which the lot was opened. In a well-formed lot, this
+ is the transaction date of the first (and ideally only) purchase split.
+ </para>
+ <warning>
+ <para>Placing more than one purchase split into a single lot may make ambiguous the holding period,
+ preventing gains from being accurately grouped by short term and long term.
+ </para>
+ </warning>
+ </listitem>
+ <listitem id="investment-lots-report-column-closed">
+ <para><guilabel>Closed</guilabel>: The date on which the lot was closed, which is the transaction date
+ of the sale split that reduces the lot balance to zero. If the lot is still open on the report end
+ date, then <guilabel>Closed</guilabel> is blank.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem id="investment-lots-report-column-b">
+ <para>Bought columns
+ </para>
+ <itemizedlist>
+ <listitem id="investment-lots-report-column-ba">
+ <para><guilabel>Bought Amount</guilabel>: The total number of purchased shares.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-column-bv">
+ <para><guilabel>Bought Value (Basis)</guilabel>: The total purchase value of the
+ <link linkend="investment-lots-report-column-ba"><guilabel>Bought Amount</guilabel></link>. This is the basis used for computing gains.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-column-bp">
+ <para><guilabel>Bought Average Price</guilabel>: The average price of each purchased share.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem id="investment-lots-report-column-s">
+ <para>Sold columns
+ </para>
+ <itemizedlist>
+ <listitem id="investment-lots-report-column-ss">
+ <para><guilabel>Sold Splits</guilabel>: The total number of sold splits.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-column-sa">
+ <para><guilabel>Sold Amount</guilabel>: The total number of sold shares.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-column-sb">
+ <para><guilabel>Sold Basis</guilabel>: The total basis (purchase value) of the
+ <link linkend="investment-lots-report-column-sa"><guilabel>Sold Amount</guilabel></link>.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-column-sv">
+ <para><guilabel>Sold Value</guilabel>: The total value (sales proceeds) of the
+ <link linkend="investment-lots-report-column-sa"><guilabel>Sold Amount</guilabel></link>.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-column-sp">
+ <para><guilabel>Sold Average Price</guilabel>: The average sale price of each sold share.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <note>
+ <para>The
+ <link linkend="investment-lots-report-column-sa"><guilabel>Sold Amount</guilabel></link>,
+ <link linkend="investment-lots-report-column-sb"><guilabel>Sold Basis</guilabel></link>, and
+ <link linkend="investment-lots-report-column-sv"><guilabel>Sold Value</guilabel></link> columns may be
+ optionally split into short-term and long-term columns (e.g. <guilabel>ST Sold Amount</guilabel> and
+ <guilabel>LT Sold Amount</guilabel> instead of
+ <link linkend="investment-lots-report-column-sa"><guilabel>Sold Amount</guilabel></link>, etc.) via
+ the <link linkend="investment-lots-report-options-columns-gg"><guilabel>Group gains by age (short
+ term and long term)</guilabel></link> Columns option.
+ </para>
+ </note>
+ </listitem>
+ <listitem id="investment-lots-report-column-e">
+ <para>End columns
+ </para>
+ <itemizedlist>
+ <listitem id="investment-lots-report-column-ea">
+ <para><guilabel>End Amount</guilabel>: The number of shares in the lot on the end date.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-column-eb">
+ <para><guilabel>End Basis</guilabel>: The basis (purchase value) of the
+ <link linkend="investment-lots-report-column-ea"><guilabel>End Amount</guilabel></link>.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-column-ev">
+ <para><guilabel>End Value</guilabel>: The value of the
+ <link linkend="investment-lots-report-column-ea"><guilabel>End Amount</guilabel></link>, using the
+ share end price from the <guilabel>Price Source</guilabel> (e.g. the latest price on the end date).
+ </para>
+ <note>
+ <para>The end price used to compute the
+ <link linkend="investment-lots-report-column-ev"><guilabel>End Value</guilabel></link> is displayed between
+ the account name and the lot rows.
+ </para>
+ </note>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem id="investment-lots-report-column-r">
+ <para>Realized gain columns
+ </para>
+ <itemizedlist>
+ <listitem id="investment-lots-report-column-rg">
+ <para><guilabel>Realized Gain</guilabel>: The capital gains (or losses) realized on sold shares.
+ <link linkend="investment-lots-report-column-sv"><guilabel>Sold Value</guilabel></link> minus
+ <link linkend="investment-lots-report-column-sb"><guilabel>Sold Basis</guilabel></link>.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-column-rr">
+ <para><guilabel>Realized ROI</guilabel>: The realized return on investment.
+ <link linkend="investment-lots-report-column-rg"><guilabel>Realized Gain</guilabel></link> divided by
+ <link linkend="investment-lots-report-column-sb"><guilabel>Sold Basis</guilabel></link>, as a percentage.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem id="investment-lots-report-column-u">
+ <para>Unrealized gain columns
+ </para>
+ <itemizedlist>
+ <listitem id="investment-lots-report-column-ug">
+ <para><guilabel>Unrealized Gain</guilabel>: The capital gains (or losses) that would be realized
+ if the remaining shares were sold on the end date.
+ <link linkend="investment-lots-report-column-ev"><guilabel>End Value</guilabel></link> minus
+ <link linkend="investment-lots-report-column-eb"><guilabel>End Basis</guilabel></link>.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-column-ur">
+ <para><guilabel>Unrealized ROI</guilabel>: The unrealized return on investment.
+ <link linkend="investment-lots-report-column-ug"><guilabel>Unrealized Gain</guilabel></link> divided by
+ <link linkend="investment-lots-report-column-eb"><guilabel>End Basis</guilabel></link>, as a percentage.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ <note>
+ <para>The realized and unrealized gain columns may be optionally split into short-term and
+ long-term columns (e.g. <guilabel>ST Realized Gain</guilabel> and <guilabel>LT Realized Gain</guilabel>
+ instead of <link linkend="investment-lots-report-column-rg"><guilabel>Realized Gain</guilabel></link>,
+ etc.) via the <link linkend="investment-lots-report-options-columns-gg"><guilabel>Group gains by age (short
+ term and long term)</guilabel></link> Columns option.
+ </para>
+ </note>
+
+ <para id="investment-lots-report-options">Report Options
+ </para>
+ <itemizedlist>
+ <listitem id="investment-lots-report-options-accounts">
+ <para>Accounts tab
+ </para>
+ <para>These options control which accounts to include in the report, using a standard account selector.
+ Selected accounts that are not of type <emphasis>Stock</emphasis> or <emphasis>Mutual Fund</emphasis>
+ are ignored.
+ </para>
+ <tip>
+ <para>Select only taxable accounts to scope the report to taxable capital gains.
+ </para>
+ </tip>
+ <para>Additional options:
+ </para>
+ <itemizedlist>
+ <listitem id="investment-lots-report-options-accounts-ns">
+ <para><guilabel>Include accounts with no shares</guilabel>: When disabled, accounts with an
+ empty balance on the report's end date are ignored. This can be useful when wanting to see
+ only unrealized gains.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-accounts-nl">
+ <para><guilabel>Include accounts with no lots</guilabel>: If some commodity accounts intentionally do
+ not use lots, then disabling this option is a convenient way to prevent such accounts from cluttering
+ the report.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem id="investment-lots-report-options-chart">
+ <para>Chart tab
+ </para>
+ <para>These options control the
+ <link linkend="investment-lots-report-chart"><guilabel>Account Lot Gains</guilabel></link> chart.
+ </para>
+ <itemizedlist>
+ <listitem id="investment-lots-report-options-chart-sc">
+ <para><guilabel>Show Chart</guilabel>: The other
+ chart options are ignored when this option is disabled.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-chart-ct">
+ <para><guilabel>Chart type</guilabel>
+ </para>
+ <informaltable>
+ <tgroup cols="1">
+ <tbody>
+ <row>
+ <entry>
+ <emphasis>Option
+ </emphasis>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ Stacked Bar Chart (default)
+ </entry>
+ </row>
+ <row>
+ <entry>
+ Bar Chart
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>The following chart examples each show the same four accounts that contain a mix of realized
+ and unrealized gains and losses, both short-term and long-term:
+ </para>
+
+ <figure id="fig-investlots-stackedbar" pgwide="1">
+ <title>The Investment Lots Report, Stacked Bar Chart</title>
+ <screenshot id="InvestmentLotsStackedBarChart">
+ <screeninfo>800x630</screeninfo>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="figures/Report_Investment_Lots_StackedBar.png"
+ srccredit="Brent McBride" width="&img-w;"/>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="figures/Report_Investment_Lots_StackedBar.png"
+ srccredit="Brent McBride"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ <figure id="fig-investlots-bar" pgwide="1">
+ <title>The Investment Lots Report, Bar Chart</title>
+ <screenshot id="InvestmentLotsBarChart">
+ <screeninfo>800x667</screeninfo>
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="figures/Report_Investment_Lots_Bar.png"
+ srccredit="Brent McBride" width="&img-w;"/>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="figures/Report_Investment_Lots_Bar.png"
+ srccredit="Brent McBride"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+
+ </listitem>
+ <listitem id="investment-lots-report-options-chart-cl">
+ <para><guilabel>Chart location</guilabel>
+ </para>
+ <informaltable>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>
+ <emphasis>Option
+ </emphasis>
+ </entry>
+ <entry>
+ <emphasis>Description
+ </emphasis>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ Top (default)
+ </entry>
+ <entry>
+ Display the chart at the top of the report, above the table
+ </entry>
+ </row>
+ <row>
+ <entry>
+ Bottom
+ </entry>
+ <entry>
+ Display the chart at the bottom of the report, below the table
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </listitem>
+ <listitem id="investment-lots-report-options-chart-pwh">
+ <para><guilabel>Plot width</guilabel> and <guilabel>Plot height</guilabel>: Controls the
+ chart's dimensions.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <note>
+ <para>The chart gain categories are controlled by the Columns tab's
+ <link linkend="investment-lots-report-options-columns-gains">Gains options</link>.
+ </para>
+ </note>
+ </listitem>
+ <listitem id="investment-lots-report-options-columns">
+ <para>Columns tab
+ </para>
+ <para>These options control which table columns are visible.
+ </para>
+ <itemizedlist>
+ <listitem id="investment-lots-report-options-columns-gd">
+ <para><link linkend="investment-lots-report-column-guid"><guilabel>Show lot guid column</guilabel></link>:
+ Disabled by default.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-columns-d">
+ <para><link linkend="investment-lots-report-column-d"><guilabel>Show date columns</guilabel></link>
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-columns-b">
+ <para><link linkend="investment-lots-report-column-b"><guilabel>Show bought columns</guilabel></link>
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-columns-s">
+ <para><link linkend="investment-lots-report-column-s"><guilabel>Show sold columns</guilabel></link>
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-columns-e">
+ <para><link linkend="investment-lots-report-column-e"><guilabel>Show end columns</guilabel></link>
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-columns-gains">
+ <para>Gains options
+ </para>
+ <note>
+ <para>These options impact both the table columns and the chart.
+ </para>
+ </note>
+ <itemizedlist>
+ <listitem id="investment-lots-report-options-columns-r">
+ <para><link linkend="investment-lots-report-column-r"><guilabel>Show realized gain columns</guilabel></link>
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-columns-u">
+ <para><link linkend="investment-lots-report-column-u"><guilabel>Show unrealized gain columns</guilabel></link>
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-columns-gg">
+ <para><guilabel>Group gains by age (short term and long term)</guilabel>: Different governments may have different
+ rules regarding how long shares must be held to qualify for different tax treatment.
+ </para>
+ <informaltable>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>
+ <emphasis>Option
+ </emphasis>
+ </entry>
+ <entry>
+ <emphasis>Description
+ </emphasis>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ No
+ </entry>
+ <entry>
+ Do not group gains by age
+ </entry>
+ </row>
+ <row>
+ <entry>
+ Gains Only (default)
+ </entry>
+ <entry>
+ Group gains by age
+ </entry>
+ </row>
+ <row>
+ <entry>
+ Gains and Sales
+ </entry>
+ <entry>
+ Also group the <link linkend="investment-lots-report-column-s">Sold columns</link> by age
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </listitem>
+ <listitem id="investment-lots-report-options-columns-ga">
+ <para><guilabel>Long term gains age (years)</guilabel>: Shares held longer than this many years count as long
+ term. This option is ignored when the
+ <link linkend="investment-lots-report-options-columns-gg"><guilabel>Group gains by age (short term and long term)</guilabel></link>
+ option is disabled. Default: 1 year.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem id="investment-lots-report-options-display">
+ <para>Display tab
+ </para>
+ <itemizedlist>
+ <listitem id="investment-lots-report-options-display-an">
+ <para><guilabel>Show long account names</guilabel>: Controls which name to use for all accounts in the report:
+ long (fully-qualified) or short.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-display-mn">
+ <para><guilabel>Show mnemonic in amounts</guilabel>: Controls whether the currency mnemonic will be use when
+ reporting amounts. I.e. "123 RIO" versus just "123". This setting only impacts amounts not values, which are
+ always displayed in the <guilabel>Report's currency</guilabel>, with its mnemonic.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-display-cl">
+ <para><guilabel>Include closed lots</guilabel>: Allows closed lots to be filtered out. This can be useful when
+ wanting to see only unrealized gains.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-display-bz">
+ <para><guilabel>Show blanks instead of zeros in table cells</guilabel>: This can make the report table look less
+ cluttered. Does not apply to <guilabel>Account Lots Total</guilabel> and <guilabel>Grand Total</guilabel> rows.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-display-sr">
+ <para><guilabel>Show lot split rows</guilabel>: When enabled, rows for each of the bought and sold splits
+ pertaining to the lot (within the report's date window) will be displayed nested under each lot row.
+ Disabled by default.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ <listitem id="investment-lots-report-options-general">
+ <para>General tab
+ </para>
+ <para>See <xref linkend="report-common"/>.
+ </para>
+ <note>
+ <para>The <guilabel>Start date</guilabel> and <guilabel>End date</guilabel> options define the lot's date
+ window. Splits outside of this window are not included in the report. Except that splits from before the
+ <guilabel>Start date</guilabel> are counted only insofar as needed to calculate the
+ <link linkend="investment-lots-report-column-sb"><guilabel>Sold Basis</guilabel></link>,
+ <link linkend="investment-lots-report-column-eb"><guilabel>End Basis</guilabel></link>,
+ and
+ <link linkend="investment-lots-report-column-ea"><guilabel>End Amount</guilabel></link> columns. But these
+ splits are not included in the report's other
+ <link linkend="investment-lots-report-column-b">Bought columns</link> and
+ <link linkend="investment-lots-report-column-s">Sold columns</link>, nor are they shown when the
+ <link linkend="investment-lots-report-options-display-sr"><guilabel>Show lot split rows</guilabel></link>
+ option is enabled.
+ </para>
+ </note>
+ </listitem>
+ <listitem id="investment-lots-report-options-val">
+ <para>Validation tab
+ </para>
+ <para>These options control how lots and accounts are validated. The report shows optional validation warnings
+ that help identify potential lot problems.
+ </para>
+ <itemizedlist>
+ <listitem id="investment-lots-report-options-val-aw">
+ <para><guilabel>Include only accounts with warnings</guilabel>: Enable this option to see only accounts
+ that have one of more of the enabled warnings. This can be useful for quickly validating that lots are
+ well-formed, especially in combination with selecting all accounts and all dates. Disabled by default.
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-val-mb">
+ <para><guilabel>Warn if a lot has more than one bought split</guilabel>: The Scrub operation only adds one
+ purchase per lot, but &app; does not stop a user from manually adding multiple purchase splits to the same
+ lot--even though this is arguably bad practice. Having multiple purchase dates makes the holding period ambiguous.
+ But if this is desired, consider disabling both this warning and the Columns tab's
+ <link linkend="investment-lots-report-options-columns-gg"><guilabel>Group gains by age (short term and long term)
+ </guilabel></link> option.
+ If the column option is left enabled, then the report will use the date of the last purchase split for
+ determining the holding period, but continue to use the first purchase date for the lot
+ <link linkend="investment-lots-report-column-opened"><guilabel>Opened</guilabel></link> column.
+ </para>
+ <note>
+ <para>The last purchase date is used to calculate the holding period because long term gains often receive favorable
+ tax treatment, so it is probably worse to misidentify a gain as long-term rather than as short-term. But better
+ still is to not have more than one purchase per lot, so the holding periods are unambiguous.
+ </para>
+ </note>
+ <para>Example:
+ </para>
+ <para><computeroutput>Warning: Above lot has 2 bought splits. Consider separating them into their own lots.</computeroutput>
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-val-nb">
+ <para><guilabel>Warn if a lot's balance drops below zero</guilabel>: The Scrub operation will not create negative
+ lot balances. But &app; does not prevent users from manually creating them. When this option is enabled, the report
+ shows a warning if a lot's balance becomes negative during the report date window.
+ </para>
+ <para>Example:
+ </para>
+ <para><computeroutput>Warning: Above lot's balance is negative on 10/29/2022. Consider removing the responsible sale
+ split from the lot and then scrubbing.</computeroutput>
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-val-bt">
+ <para><guilabel>Warn if a lot has a blank title</guilabel>: Disabled by default. Lot titles are optional. Enabling
+ this warning will flag lots with blank (empty or whitespace) titles.
+ </para>
+ <para>Example:
+ </para>
+ <para><computeroutput>Warning: Above lot's title is blank.</computeroutput>
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-val-rg">
+ <para><guilabel>Warn if the "Realized Gain/Loss" split(s) sum does not match the computed gains</guilabel>: The
+ report recomputes the gain/loss values from each sale, compares them with the sum of the lot's generated
+ <quote>Realized Gain/Loss</quote> splits and warns if they do not match.
+ </para>
+ <para>Example:
+ </para>
+ <para><computeroutput>Warning: Above lot's computed gain $(1,518.79) is not equal to the "Realized Gain/Loss" split(s)
+ sum $(1,518.80). Difference: $0.01</computeroutput>
+ </para>
+ <para>
+ <note>
+ <para>If a <quote>Realized Gain/Loss</quote> split is incorrect, it can often be repaired thus:
+ </para>
+ <orderedlist >
+ <listitem>
+ <para>Remove the sale split from the lot,
+ </para>
+ </listitem>
+ <listitem>
+ <para>Delete the bad <quote>Realized Gain/Loss</quote> split,
+ </para>
+ </listitem>
+ <listitem>
+ <para>Add the sale split back to the lot, to recreate the <quote>Realized Gain/Loss</quote> split, and
+ </para>
+ </listitem>
+ <listitem>
+ <para><guibutton>Reload</guibutton> this report and verify that the warning is gone.
+ </para>
+ </listitem>
+ </orderedlist>
+ </note>
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-val-os">
+ <para><guilabel>Warn if a split is not assigned to a lot</guilabel>: Realized and unrealized gains cannot be
+ computed for splits that are not in a lot. This warning flags accounts containing unassigned splits.
+ </para>
+ <informaltable>
+ <tgroup cols="2">
+ <tbody>
+ <row>
+ <entry>
+ <emphasis>Option
+ </emphasis>
+ </entry>
+ <entry>
+ <emphasis>Description
+ </emphasis>
+ </entry>
+ </row>
+ <row>
+ <entry>
+ No
+ </entry>
+ <entry>
+ Warning disabled
+ </entry>
+ </row>
+ <row>
+ <entry>
+ Count (default)
+ </entry>
+ <entry>
+ Warning message identifies the number of unassigned splits
+ </entry>
+ </row>
+ <row>
+ <entry>
+ List
+ </entry>
+ <entry>
+ Unassigned splits are listed after the warning message
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ <para>Example:
+ </para>
+ <para><computeroutput>Warning: 2 split(s) are not assigned to a lot. Do lots need to be scrubbed?</computeroutput>
+ </para>
+ </listitem>
+ <listitem id="investment-lots-report-options-val-ab">
+ <para><guilabel>Warn if the account balance does not match the computed lots' end balance</guilabel>:
+ This is often another indication that the account has splits that are not included in a lot.
+ </para>
+ <para>Example:
+ </para>
+ <para><computeroutput>Warning: End amount 236.5 RIO is not equal to actual account balance 234 RIO.
+ Difference: 2.5 RIO. Do lots need to be scrubbed?</computeroutput>
+ </para>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
<listitem>
<para>General Ledger:
</para>
diff --git a/C/manual/ch_Tools_Assistants.xml b/C/manual/ch_Tools_Assistants.xml
index 87419944..ba9d1c39 100644
--- a/C/manual/ch_Tools_Assistants.xml
+++ b/C/manual/ch_Tools_Assistants.xml
@@ -6115,11 +6115,20 @@
</listitem>
</itemizedlist>
- <para>See Tutorial and Concepts Guide,
- <ulink
-url="&url-docs-C;guide/invest-sell1.html#invest-sellLots"> Automatic
- Calculation of Capital Gain or Loss Using Lots</ulink> for more details.
+ <para>For more details, see:
</para>
+ <itemizedlist>
+ <listitem>
+ <para>Tutorial and Concepts Guide,
+ <ulink url="&url-docs-C;guide/invest-sell1.html#invest-sellLots">Automatic
+ Calculation of Capital Gain or Loss Using Lots</ulink>.
+ </para>
+ </listitem>
+ <listitem>
+ <para><link linkend="investment-lots-report">Investment Lots</link> report.
+ </para>
+ </listitem>
+ </itemizedlist>
</sect3>
</sect2>
diff --git a/C/manual/figures/Report_Investment_Lots.png b/C/manual/figures/Report_Investment_Lots.png
new file mode 100644
index 00000000..8cc3218e
Binary files /dev/null and b/C/manual/figures/Report_Investment_Lots.png differ
diff --git a/C/manual/figures/Report_Investment_Lots_Bar.png b/C/manual/figures/Report_Investment_Lots_Bar.png
new file mode 100644
index 00000000..0cc5ff8d
Binary files /dev/null and b/C/manual/figures/Report_Investment_Lots_Bar.png differ
diff --git a/C/manual/figures/Report_Investment_Lots_StackedBar.png b/C/manual/figures/Report_Investment_Lots_StackedBar.png
new file mode 100644
index 00000000..9d0148ad
Binary files /dev/null and b/C/manual/figures/Report_Investment_Lots_StackedBar.png differ
diff --git a/C/manual/index.docbook b/C/manual/index.docbook
index 57cb73fa..cc7fef18 100644
--- a/C/manual/index.docbook
+++ b/C/manual/index.docbook
@@ -505,6 +505,10 @@
<firstname>Cristian</firstname> <surname>Marchi</surname>
</author>
,
+ <author>
+ <firstname>Brent</firstname> <surname>McBride</surname>
+ </author>
+ ,
<author>
<firstname>John</firstname> <surname>Ralls</surname>
</author>
diff --git a/docbook/gnc-docbookx.dtd b/docbook/gnc-docbookx.dtd
index 6e0a616b..252fc183 100644
--- a/docbook/gnc-docbookx.dtd
+++ b/docbook/gnc-docbookx.dtd
@@ -155,6 +155,7 @@ be used in normal text -->
<!ENTITY url-wiki-OQ "https://wiki.gnucash.org/wiki/Online_Quotes">
<!ENTITY url-wiki-qif "https://wiki.gnucash.org/wiki/Quicken_Migration">
<!ENTITY url-wiki-xslt "https://wiki.gnucash.org/wiki/De/export_to_excel_xls_transform">
+<!ENTITY url-wiki-lots "https://wiki.gnucash.org/wiki/Concept_of_Lots">
<!-- wiki Special: translation is done by mediawiki: -->
<!ENTITY url-wiki-category "https://wiki.gnucash.org/wiki/Special:Categories">
<!ENTITY url-wiki-search "https://wiki.gnucash.org/wiki/Special:Search">
Summary of changes:
C/guide/CMakeLists.txt | 1 +
C/guide/appendixd.xml | 10 +-
C/guide/ch_basics.xml | 4 +-
C/guide/ch_bus_features.xml | 6 +-
C/guide/ch_cc.xml | 2 +-
C/guide/ch_expenses.xml | 4 +-
C/guide/ch_importing.xml | 2 +-
C/guide/ch_invest.xml | 4 +-
C/guide/ch_reports.xml | 61 ++
C/guide/figures/Report_Investment_Lots.png | Bin 0 -> 110648 bytes
C/guide/index.docbook | 4 +
C/manual/CMakeLists.txt | 3 +
C/manual/ch_Reports.xml | 708 +++++++++++++++++++++
C/manual/ch_Tools_Assistants.xml | 19 +-
C/manual/ch_Transactions.xml | 2 +-
C/manual/figures/Report_Investment_Lots.png | Bin 0 -> 110648 bytes
C/manual/figures/Report_Investment_Lots_Bar.png | Bin 0 -> 20360 bytes
.../figures/Report_Investment_Lots_StackedBar.png | Bin 0 -> 15132 bytes
C/manual/index.docbook | 4 +
docbook/gnc-docbookx.dtd | 1 +
20 files changed, 812 insertions(+), 23 deletions(-)
create mode 100644 C/guide/figures/Report_Investment_Lots.png
create mode 100644 C/manual/figures/Report_Investment_Lots.png
create mode 100644 C/manual/figures/Report_Investment_Lots_Bar.png
create mode 100644 C/manual/figures/Report_Investment_Lots_StackedBar.png
More information about the gnucash-changes
mailing list