gnucash-docs maint: Multiple changes pushed
Frank H.Ellenberger
fell at code.gnucash.org
Sat Sep 18 14:24:29 EDT 2021
Updated via https://github.com/Gnucash/gnucash-docs/commit/7e4e560f (commit)
via https://github.com/Gnucash/gnucash-docs/commit/8276f1a8 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/3f4628ea (commit)
via https://github.com/Gnucash/gnucash-docs/commit/a9e32318 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/ab6c9581 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/56c74d57 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/35c8e580 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/0777dffb (commit)
via https://github.com/Gnucash/gnucash-docs/commit/1e176058 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/b80e1d6d (commit)
from https://github.com/Gnucash/gnucash-docs/commit/4183b55e (commit)
commit 7e4e560fee172a21c914f0b6f5e58e33f80b463f
Merge: 4183b55e 8276f1a8
Author: Frank H. Ellenberger <frank.h.ellenberger at gmail.com>
Date: Sat Sep 18 20:16:20 2021 +0200
Merge branch 'PR_#192' into maint
commit 8276f1a8687244481342b250231d9122adde4e59
Author: TANIGUCHI Yasuaki <yasuakit at gmail.com>
Date: Wed Aug 4 16:31:59 2021 +0900
Change the system order of procedure. &lin;, &mac;, &win;
diff --git a/guide/C/ch_invest.xml b/guide/C/ch_invest.xml
index 3b86c783..74b9f39a 100644
--- a/guide/C/ch_invest.xml
+++ b/guide/C/ch_invest.xml
@@ -1366,33 +1366,6 @@ Income
<title>Installing &app-fq;</title>
<para>The process of installing &app-fq; depends on the system. </para>
- <procedure>
- <title>Installing &app-fq; on &win;</title>
- <step><simpara>Close &app;.</simpara></step>
- <step><simpara>Run <menuchoice>
- <guimenu>Start</guimenu>
- <guisubmenu>&app;</guisubmenu>
- <guimenuitem>Install Online Price Retrieval</guimenuitem></menuchoice>.
- </simpara>
- </step>
- </procedure>
-
- <procedure>
- <title>Installing &app-fq; on &mac;</title>
- <step><simpara>Close &app;.</simpara></step>
- <step><simpara>Install Xcode if it is not installed.</simpara>
- <simpara>XCode is an optional item from your &mac; distribution DVD.</simpara>
- </step>
- <step><simpara>Run the <emphasis>Update Finance Quote</emphasis> app in the &app; dmg.</simpara>
- <para>You can run it from the dmg or copy it to the same
- folder to which you copied &app;.
- It will open a Terminal window and run a script for you
- which will ask lots of questions. Accept the default for each unless you know what
- you’re doing.
- </para>
- </step>
- </procedure>
-
<procedure>
<title>Installing &app-fq; on &lin;</title>
<step><simpara>Close &app;.</simpara></step>
@@ -1421,6 +1394,34 @@ Income
<step><simpara>Run <command>gnc-fq-dump</command> to check &app-fq; works properly.</simpara></step>
</procedure>
+
+ <procedure>
+ <title>Installing &app-fq; on &mac;</title>
+ <step><simpara>Close &app;.</simpara></step>
+ <step><simpara>Install Xcode if it is not installed.</simpara>
+ <simpara>XCode is an optional item from your &mac; distribution DVD.</simpara>
+ </step>
+ <step><simpara>Run the <emphasis>Update Finance Quote</emphasis> app in the &app; dmg.</simpara>
+ <para>You can run it from the dmg or copy it to the same
+ folder to which you copied &app;.
+ It will open a Terminal window and run a script for you
+ which will ask lots of questions. Accept the default for each unless you know what
+ you’re doing.
+ </para>
+ </step>
+ </procedure>
+
+ <procedure>
+ <title>Installing &app-fq; on &win;</title>
+ <step><simpara>Close &app;.</simpara></step>
+ <step><simpara>Run <menuchoice>
+ <guimenu>Start</guimenu>
+ <guisubmenu>&app;</guisubmenu>
+ <guimenuitem>Install Online Price Retrieval</guimenuitem></menuchoice>.
+ </simpara>
+ </step>
+ </procedure>
+
<note>
<para>If you feel uncomfortable about performing any of these steps, please either email the &app;-user
mailing list (<email>gnucash-user at gnucash.org</email>) for help or come to the &app; IRC
commit 3f4628ea52f27260b4cbbf29cb30c42cd461b5f0
Author: TANIGUCHI Yasuaki <yasuakit at gmail.com>
Date: Wed Aug 4 16:12:18 2021 +0900
Fix comment below:
https://github.com/Gnucash/gnucash-docs/pull/192#discussion_r680355097
diff --git a/guide/C/ch_invest.xml b/guide/C/ch_invest.xml
index 1db35f40..3b86c783 100644
--- a/guide/C/ch_invest.xml
+++ b/guide/C/ch_invest.xml
@@ -1089,7 +1089,7 @@ Income
</para>
<para>Now for the transaction, on the first (transaction) line, enter the <guilabel>Date</guilabel> of the
- purchase (for example, Jan. 3 2005) and <guilabel>Description</guilabel> (for example, Initial IBM
+ purchase (for example, Jan. 3, 2005) and <guilabel>Description</guilabel> (for example, Initial IBM
Purchase). On the first split line, enter <userinput>50</userinput> in <guilabel>Shares</guilabel>, delete
<guilabel>Price</guilabel> (leave it empty so it will be calculated), and enter <userinput>5000</userinput> in
<guilabel>Buy</guilabel>. You do not need to fill in the <guilabel>Price</guilabel>
@@ -1136,7 +1136,7 @@ Income
</para>
<para>Now for the transaction, on the first (transaction) line, enter the <guilabel>Date</guilabel> of the
- purchase (for example, Jan. 3 2005) and <guilabel>Description</guilabel> (for example, Initial IBM
+ purchase (for example, Jan. 3, 2005) and <guilabel>Description</guilabel> (for example, Initial IBM
Purchase). On the first split line, optionally enter more details in <guilabel>Memo
</guilabel>, then <userinput>50</userinput> in <guilabel>Shares</guilabel>, delete anything in
<guilabel>Price</guilabel> (so it will be calculated by dividing <guilabel>Buy</guilabel>
@@ -1397,32 +1397,28 @@ Income
<title>Installing &app-fq; on &lin;</title>
<step><simpara>Close &app;.</simpara></step>
<step><simpara>Run the command <command>which gnc-fq-update</command> to check <filename>gnc-fq-update</filename> program is in your PATH environment
- variable.
+ variable.<footnote><simpara>If you’ve installed &app; packages provided by your distribution, <filename>gnc-fq-update</filename> must be on your PATH.</simpara></footnote>
</simpara>
- <substeps><step id="gnc-fq-update-not-found">
+ <substeps><step id="gnc-fq-update-not-found">
<simpara>If <filename>gnc-fq-update</filename> is not in your PATH, search the folder where &app; is
- installed.<footnote><simpara>If you’ve installed &app; packages provided by your distribution, <filename>gnc-fq-update</filename> must be on your PATH.</simpara></footnote></simpara>
+ installed.</simpara>
</step>
</substeps>
</step>
- <step><simpara>Open a root shell by using <command>su -</command> or <command>sudo su -</command>. It depends on your distribution.</simpara></step>
- <step><simpara>Run the command <command>gnc-fq-update</command>. If <filename>gnc-fq-update</filename> is not in your PATH, specify full path of <filename>gnc-fq-update</filename>
- instead which is found by <xref linkend="gnc-fq-update-not-found" />.
- </simpara>
+ <step><simpara>Run the command <command>sudo gnc-fq-update</command> or <command>su -c gnc-fq-update</command> in order to run it with root privilege.
+ It depends on your distribution.
+ If <filename>gnc-fq-update</filename> is not in your PATH, specify full path of <filename>gnc-fq-update</filename>
+ instead, which is found by <xref linkend="gnc-fq-update-not-found" />.</simpara>
<para>
This will launch a <application>Perl</application> <acronym><ulink url="https://www.cpan.org/">CPAN</ulink></acronym><footnote>
<simpara>See <ulink url="https://www.cpan.org/misc/cpan-faq.html">CPAN Frequently Asked Questions</ulink> for details.</simpara></footnote>
- update session that will go out
- onto the internet and install the &app-fq; module on your
- system. The <filename>gnc-fq-update program</filename> is interactive, however, with most systems you should be
- able to answer the first question <computeroutput>Are you ready for manual
- configuration? [yes]</computeroutput> with <userinput>no</userinput>. Then the update will continue automatically from that point.
- </para>
- <para>After installation is complete, you should run the <quote><filename>gnc-fq-dump</filename></quote> test program, in the
- same directory, distributed with &app; to test if
- &app-fq; is installed and working properly.
- </para>
+ module internally. When you launch the CPAN module for the first time, you must setup and configure it. However, on the most systems if you accept the default settings
+ or answer the first question <computeroutput>Are you ready for manual
+ configuration? [yes]</computeroutput> with <userinput>no</userinput>, you will be able to install &app-fq; successfully.
+ </para>
</step>
+
+ <step><simpara>Run <command>gnc-fq-dump</command> to check &app-fq; works properly.</simpara></step>
</procedure>
<note>
commit a9e32318f6866a81a7716afe7a1189bb403e78df
Author: TANIGUCHI Yasuaki <yasuakit at gmail.com>
Date: Wed Aug 4 14:31:05 2021 +0900
Fix comment below:
- https://github.com/Gnucash/gnucash-docs/pull/192#discussion_r680359545
diff --git a/guide/C/ch_invest.xml b/guide/C/ch_invest.xml
index 6a98b866..1db35f40 100644
--- a/guide/C/ch_invest.xml
+++ b/guide/C/ch_invest.xml
@@ -3445,7 +3445,7 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
<orderedlist>
<listitem>
<para>&app; implements only the First In/ First Out (<acronym>FIFO</acronym>) cost method when automatically linking buy
- transactions to sell transactions. That is the oldest securities are always sold first.
+ transactions to sell transactions. That means the oldest securities are always sold first.
The Last In First Out (<acronym>LIFO</acronym>) cost method may be used by manually linking the most
recent buy security splits to the sell split before scrubbing.
</para>
commit ab6c958138e618c21fad2b6b0222748d0be6c590
Author: TANIGUCHI Yasuaki <yasuakit at gmail.com>
Date: Wed Aug 4 14:27:32 2021 +0900
Fix comments below:
- https://github.com/Gnucash/gnucash-docs/pull/192#discussion_r680356731
- https://github.com/Gnucash/gnucash-docs/pull/192#discussion_r680358015
- https://github.com/Gnucash/gnucash-docs/pull/192#discussion_r680359138
diff --git a/guide/C/ch_invest.xml b/guide/C/ch_invest.xml
index d0a32cc5..6a98b866 100644
--- a/guide/C/ch_invest.xml
+++ b/guide/C/ch_invest.xml
@@ -1550,7 +1550,7 @@ Income
<title>The <quote>Price Source</quote> in Reports</title>
<para>Most &app; reports have options to set/modify a number of parameters for the report. The Options
- dialog box is displayed by selecting the report tab then clicking on either the
+ dialog box is displayed by selecting the report tab, then ether clicking on the
<guibutton>Options</guibutton> icon in the <emphasis>Menubar</emphasis> or selecting
<menuchoice>
<guimenu>Edit</guimenu><guimenuitem>Report Options</guimenuitem>
@@ -1560,10 +1560,11 @@ Income
report the selector may appear in either the <guilabel>General</guilabel>, the
<guilabel>Commodities</guilabel>, or the <guilabel>Display</guilabel> tab of the
<guilabel>Report Options</guilabel> dialog box.
- <note>
- <para>In the example below, the report is a customization of the <emphasis role="strong">Average
- Balance</emphasis> report in the Assets & Liabilities reports submenu.
- </para>
+
+ <note>
+ <simpara>In the example the report can be customized using the
+ <menuchoice><guimenu>Reports</guimenu><guisubmenu>Assets & Liabilities</guisubmenu><guimenuitem>Average Balance</guimenuitem></menuchoice> menu.
+ </simpara>
</note>
</para>
<screenshot id="invest-stockvalue-report-options">
@@ -2114,7 +2115,7 @@ Income
</screenshot>
</figure>
<note>
- <para>In the above screenshot, it appears there are 2 transactions for Mar 21st, 2006. This is because the
+ <para>In the above screenshot, it appears there are 2 transactions for Mar. 21, 2006. This is because the
register is in <guilabel> Auto-Split Ledger</guilabel> view and there are 2 splits for
the register account in the 1 transaction. <guilabel>Transaction Journal</guilabel>
view may be clearer. Refer to <xref linkend="txns-registers-txntypes" />. As there are 2
@@ -3212,11 +3213,11 @@ Income
<para>The term <emphasis>scrub</emphasis> is used because security accounts need to be cleaned after sales
to ensure the difference between the cost paid for securities, and value received from
selling them, is accounted for as capital gain or loss. If the capital gain/loss is not
- correct, the <guimenuitem>Trial Balance</guimenuitem>
- (<menuchoice>
+ correct, the <guimenuitem>Trial Balance</guimenuitem> bottom line total debits will not balance to total credits.
+ To see the <guimenuitem>Trial Balance</guimenuitem>, select <menuchoice>
<guimenu>Reports</guimenu> <guisubmenu>Income & Expense</guisubmenu>
<guimenuitem>Trial Balance</guimenuitem>
- </menuchoice>) bottom line total debits will not balance to total credits.
+ </menuchoice>.
</para>
<note>
commit 56c74d578921b8213a03b81ab9cd51294cb55f98
Author: TANIGUCHI Yasuaki <yasuakit at gmail.com>
Date: Wed Aug 4 13:37:45 2021 +0900
Fix comment below:
https://github.com/Gnucash/gnucash-docs/pull/192#discussion_r680356197
diff --git a/docbook/gnc-docbookx.dtd b/docbook/gnc-docbookx.dtd
index 5f4aee49..36cc64a5 100644
--- a/docbook/gnc-docbookx.dtd
+++ b/docbook/gnc-docbookx.dtd
@@ -128,6 +128,7 @@ own entity definitions to use across all of our DocBook pages. -->
<!ENTITY url-wiki-pmt-term "https://wiki.gnucash.org/wiki/Payment_Terms">
<!ENTITY url-wiki-ofx "https://wiki.gnucash.org/wiki/Setting_up_OFXDirectConnect">
<!ENTITY url-wiki-ofx-banks "https://wiki.gnucash.org/wiki/OFX_Direct_Connect_Bank_Settings">
+<!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">
<!-- wiki Special: translation is done by mediawiki: -->
diff --git a/guide/C/ch_invest.xml b/guide/C/ch_invest.xml
index 84384860..d0a32cc5 100644
--- a/guide/C/ch_invest.xml
+++ b/guide/C/ch_invest.xml
@@ -1495,8 +1495,8 @@ Income
<step><simpara>Enter the appropirate items on <guilabel>Create Task</guilabel> Window.</simpara></step>
</procedure>
- <para>See <ulink url="https://code.gnucash.org/docs/C/gnucash-help/acct-create.html#Online-price-setup">GnuCash Help Manual</ulink>
- and <ulink url="https://wiki.gnucash.org/wiki/Online_Quotes#Updating_enabled_Quotes_from_outside_GnuCash">Online Quotes Page on GnuCash Wiki</ulink> for more details.
+ <para>See <ulink url="&url-docs-build-C;help/acct-create.html#Online-price-setup">GnuCash Help Manual</ulink>
+ and <ulink url="&url-wiki-OQ;#Updating_enabled_Quotes_from_outside_GnuCash">Online Quotes Page on GnuCash Wiki</ulink> for more details.
</para>
<para>Remember that Mutual Fund <quote>prices</quote> are really <quote>Net Asset Value</quote> and
commit 35c8e580b921c82c8c1e30b950a9a63a8acdd611
Author: TANIGUCHI Yasuaki <yasuakit at gmail.com>
Date: Wed Aug 4 13:28:21 2021 +0900
Fix comments bellow:
- https://github.com/Gnucash/gnucash-docs/pull/192#discussion_r682260218
- https://github.com/Gnucash/gnucash-docs/pull/192#discussion_r680355097
diff --git a/guide/C/ch_invest.xml b/guide/C/ch_invest.xml
index 63bc2f8d..84384860 100644
--- a/guide/C/ch_invest.xml
+++ b/guide/C/ch_invest.xml
@@ -1379,6 +1379,7 @@ Income
<procedure>
<title>Installing &app-fq; on &mac;</title>
+ <step><simpara>Close &app;.</simpara></step>
<step><simpara>Install Xcode if it is not installed.</simpara>
<simpara>XCode is an optional item from your &mac; distribution DVD.</simpara>
</step>
@@ -1394,14 +1395,26 @@ Income
<procedure>
<title>Installing &app-fq; on &lin;</title>
- <step><simpara>Close any running &app; instances.</simpara></step>
- <step><simpara>Locate the folder where &app; is installed by searching for <filename>gnc-fq-update</filename>.</simpara></step>
- <step><simpara>Change to that directory, open a root shell.</simpara></step>
- <step><simpara>Run the command <command>./gnc-fq-update</command>.</simpara>
+ <step><simpara>Close &app;.</simpara></step>
+ <step><simpara>Run the command <command>which gnc-fq-update</command> to check <filename>gnc-fq-update</filename> program is in your PATH environment
+ variable.
+ </simpara>
+ <substeps><step id="gnc-fq-update-not-found">
+ <simpara>If <filename>gnc-fq-update</filename> is not in your PATH, search the folder where &app; is
+ installed.<footnote><simpara>If you’ve installed &app; packages provided by your distribution, <filename>gnc-fq-update</filename> must be on your PATH.</simpara></footnote></simpara>
+ </step>
+ </substeps>
+ </step>
+ <step><simpara>Open a root shell by using <command>su -</command> or <command>sudo su -</command>. It depends on your distribution.</simpara></step>
+ <step><simpara>Run the command <command>gnc-fq-update</command>. If <filename>gnc-fq-update</filename> is not in your PATH, specify full path of <filename>gnc-fq-update</filename>
+ instead which is found by <xref linkend="gnc-fq-update-not-found" />.
+ </simpara>
<para>
- This will launch a <application>Perl</application> CPAN update session that will go out
+ This will launch a <application>Perl</application> <acronym><ulink url="https://www.cpan.org/">CPAN</ulink></acronym><footnote>
+ <simpara>See <ulink url="https://www.cpan.org/misc/cpan-faq.html">CPAN Frequently Asked Questions</ulink> for details.</simpara></footnote>
+ update session that will go out
onto the internet and install the &app-fq; module on your
- system. The gnc-fq-update program is interactive, however, with most systems you should be
+ system. The <filename>gnc-fq-update program</filename> is interactive, however, with most systems you should be
able to answer the first question <computeroutput>Are you ready for manual
configuration? [yes]</computeroutput> with <userinput>no</userinput>. Then the update will continue automatically from that point.
</para>
commit 0777dffbc7282c0048b1a2aff79ebce5f2e5325a
Author: TANIGUCHI Yasuaki <yasuakit at gmail.com>
Date: Sat Jul 31 10:23:57 2021 +0900
Fix comment https://github.com/Gnucash/gnucash-docs/pull/192#discussion_r676279712
diff --git a/guide/C/ch_invest.xml b/guide/C/ch_invest.xml
index 0cf71d22..63bc2f8d 100644
--- a/guide/C/ch_invest.xml
+++ b/guide/C/ch_invest.xml
@@ -1085,8 +1085,7 @@ Income
<para>In this example you will purchase 100 shares at $50 per share of IBM stock with a commission of $100. First step will be
to create the stock account for IBM. The existing <emphasis>Expenses:Commission</emphasis>
- account will be used. If you wish to track commissions to the individual stock level an
- additional sub-account would be necessary, like <emphasis>Expenses:Commission:IBM</emphasis>.
+ account will be used.
</para>
<para>Now for the transaction, on the first (transaction) line, enter the <guilabel>Date</guilabel> of the
commit 1e176058c9b50a85b250a1d59e390ae0bbb9ea2b
Author: TANIGUCHI Yasuaki <yasuakit at gmail.com>
Date: Sat Jul 31 10:06:36 2021 +0900
Fix comment https://github.com/Gnucash/gnucash-docs/pull/192#discussion_r680092489
and https://github.com/Gnucash/gnucash-docs/pull/192#discussion_r676052158a
diff --git a/guide/C/ch_invest.xml b/guide/C/ch_invest.xml
index 44b31268..0cf71d22 100644
--- a/guide/C/ch_invest.xml
+++ b/guide/C/ch_invest.xml
@@ -1440,31 +1440,51 @@ Income
Quotes</guibutton> button to update your stock prices on the Internet.
</para>
- <para>The command <command>gnucash-cli --quotes get <filename><replaceable>$HOME/gnucash-filename</replaceable></filename></command> can be used to
+ <para>The command <command>gnucash-cli --quotes get <filename><replaceable>${HOME}/gnucash-filename</replaceable></filename></command><footnote>
+ <simpara>The Online Quotes Retrieval command has been changed from &app; 4.0. The old command
+ <command>gnucash --add-price-quotes <filename><replaceable>${HOME}/gnucash-filename</replaceable></filename></command> is
+ still available, but it is deprecated and will be removed in the future release.
+ If you've upgraded from &app; 3.11 or previous version,
+ it is recommended to use the new command <command>gnucash-cli</command>.</simpara>
+ </footnote> can be used to
fetch the current prices of your stocks. The file specified
- <filename><replaceable>$HOME/gnucash-filename</replaceable></filename> will depend on the name and
+ <filename><replaceable>${HOME}/gnucash-filename</replaceable></filename> will depend on the name and
location of your data file. This can be determined by the name displayed in the top frame
of the &app; window, before the <quote>-</quote>. The file name can also be found under
<guimenu>File</guimenu> in the recently opened file list; the first item, numbered 1, is
the name of the currently open file.
</para>
- <note>
- <simpara>The Online Quotes Retrieval command has been changed from &app; 4.0. If you've upgraded from &app; 3.11 or previous version,
- be sure to change the command.</simpara>
- </note>
+
</sect3>
<sect3 id="invest-stockprice-auto-scheduler">
<title>Configuring for Getting Online Quotes Periodically</title>
- <para>This can be automated by creating a <application>crontab</application> entry. For example, to update
- your file every Friday evening (16:00) after the relevant exchange markets close (modify
- the time accordingly for your time zone), you could add the following to your personal
- <application>crontab</application>:
- <informalexample>
- <screen>0 16 * * 5 gnucash-cli --quotes get <replaceable>$HOME/gnucash-filename</replaceable> > /dev/null 2>&1</screen>
- </informalexample>
+ <para>You have to register the <command>gnucash-cli</command> with a scheduler in order to get Online Quotes automatically and periodically.
+ The method depends on your OS. For example, suppose you want to update
+ your file on 16:00 on every Friday.
+ </para>
+
+ <procedure>
+ <title>Register <command>gnucash-cli</command> with <application>cron</application> on &lin; and &mac;</title>
+ <step><simpara>Run <command>crontab -e</command>.</simpara></step>
+ <step><para>Add the following line to your crontab:
+ <informalexample>
+ <screen>0 16 * * 5 gnucash-cli --quotes get <replaceable>${HOME}/gnucash-filename</replaceable> > /dev/null 2>&1</screen>
+ </informalexample></para>
+ </step>
+ </procedure>
+
+ <procedure>
+ <title>Register <command>gnucash-cli</command> with Task Scheduler on &win;</title>
+ <step><simpara>Select <menuchoice><guimenu>Start</guimenu><guisubmenu>Windows Administrative Tools</guisubmenu><guimenuitem>Task Scheduler</guimenuitem></menuchoice>.</simpara></step>
+ <step><simpara>Select <guimenuitem>Create Task</guimenuitem>.</simpara></step>
+ <step><simpara>Enter the appropirate items on <guilabel>Create Task</guilabel> Window.</simpara></step>
+ </procedure>
+
+ <para>See <ulink url="https://code.gnucash.org/docs/C/gnucash-help/acct-create.html#Online-price-setup">GnuCash Help Manual</ulink>
+ and <ulink url="https://wiki.gnucash.org/wiki/Online_Quotes#Updating_enabled_Quotes_from_outside_GnuCash">Online Quotes Page on GnuCash Wiki</ulink> for more details.
</para>
<para>Remember that Mutual Fund <quote>prices</quote> are really <quote>Net Asset Value</quote> and
commit b80e1d6d67e1c38e0b8cafa59ec87e208d8122cb
Author: TANIGUCHI Yasuaki <yasuakit at gmail.com>
Date: Fri Jul 16 20:19:08 2021 +0900
Fix typos.
Change some itemizelist to variablelist.
Remove extra spaces within inline tags for translation.
Modify tags to make translation easier.
Replace Finance::Quote with &app-fq;.
Fix according to the comment https://github.com/Gnucash/gnucash-docs/pull/192
Added a space between a word and a tag.
Replace misused acronyms with guilabels.
Add spaces between words and tags to avoid word concatenation.
Change German word Strg to English word Ctrl.
Add replaceable tag, see
https://github.com/Gnucash/gnucash-docs/pull/190#discussion_r671407584
This reverts commit 2f2e0150a643f01f2711732bdac461db481b6c3e.
Revert "Add spaces between words and tags to avoid word concatenation."
This reverts commit 3477ab14a1c2e9def0bb8b6e5e9add47d156b905.
Revert "Fix typos."
This reverts commit 06540fceefe517fd91d9fc02cb569c3040028f97.
Fix typos.
Change some itemizelist to variablelist.
Remove extra spaces within inline tags for translation.
Modify tags to make translation easier.
Replace Finance::Quote with &app-fq;.
Unify Savings account name.
Replace CD with certificate of deposit.
Fix according to the pull request comments.
https://github.com/Gnucash/gnucash-docs/pull/192#discussion_r676045943
https://github.com/Gnucash/gnucash-docs/pull/192#discussion_r676179884
Fix 1 of https://github.com/Gnucash/gnucash-docs/pull/192#discussion_r676050567
Add sect3 "Configuring for Getting Online Quotes Periodically"
to add gnucash-cli to time scheduler that depends on the OS.
diff --git a/guide/C/ch_invest.xml b/guide/C/ch_invest.xml
index b94d0275..44b31268 100644
--- a/guide/C/ch_invest.xml
+++ b/guide/C/ch_invest.xml
@@ -19,9 +19,9 @@
<title>Investments</title>
<para>This chapter explains how to manage your investments with &app;. Most people have an investment
- plan, whether its just putting money into a CD account, investing through a company sponsored
+ plan, whether its just putting money into a certificate of deposit (<acronym>CD</acronym> for short) account, investing through a company sponsored
plan at your workplace or buying and selling stocks and bonds through a brokerage. &app; gives
- you tools to help you manage these investments such as the <emphasis>Price Editor </emphasis>
+ you tools to help you manage these investments such as the <emphasis>Price Database</emphasis>
which allows you to record changes in the prices of stocks you own.
</para>
@@ -46,7 +46,7 @@
<variablelist>
<varlistentry>
- <term><emphasis>Capital gains</emphasis></term>
+ <term id="invest_terms2.capgain">Capital gains</term>
<listitem>
<para>The difference between the purchase and selling prices of an investment. If the selling price is
@@ -57,7 +57,7 @@
</varlistentry>
<varlistentry>
- <term><emphasis>Commission</emphasis></term>
+ <term>Commission</term>
<listitem>
<para>The fee you pay to a broker to buy or sell securities.
@@ -66,7 +66,7 @@
</varlistentry>
<varlistentry>
- <term><emphasis>Common stock</emphasis></term>
+ <term>Common stock</term>
<listitem>
<para>A security that represents a certain fractional ownership of a company. This is what you buy when
@@ -77,7 +77,7 @@
</varlistentry>
<varlistentry>
- <term><emphasis>Compounding</emphasis></term>
+ <term>Compounding</term>
<listitem>
<para>The concept that the reinvested interest can later earn interest of its own (interest on interest).
@@ -87,7 +87,7 @@
</varlistentry>
<varlistentry>
- <term><emphasis>Dividends</emphasis></term>
+ <term>Dividends</term>
<listitem>
<para>Dividends are cash payments a company makes to shareholders. The amount of this payment is usually
@@ -98,7 +98,7 @@
</varlistentry>
<varlistentry>
- <term><emphasis>Equities</emphasis></term>
+ <term>Equities</term>
<listitem>
<para>Equities are investments in which the investor becomes part (or whole) owner in something. This
@@ -108,7 +108,7 @@
</varlistentry>
<varlistentry>
- <term><emphasis>Interest</emphasis></term>
+ <term>Interest</term>
<listitem>
<para>What a borrower pays a lender for the use of their money. Normally, this is expressed in terms of a
@@ -120,7 +120,7 @@
</varlistentry>
<varlistentry>
- <term><emphasis>Liquidity</emphasis></term>
+ <term>Liquidity</term>
<listitem>
<para>A measure of how easily convertible an investment is to cash. Money in a savings account is very
@@ -131,7 +131,7 @@
</varlistentry>
<varlistentry>
- <term><emphasis>Principal</emphasis></term>
+ <term>Principal</term>
<listitem>
<para>The original amount of money invested or borrowed.
@@ -140,27 +140,26 @@
</varlistentry>
<varlistentry>
- <term><emphasis>Realized vs Unrealized Gain/Loss</emphasis></term>
+ <term>Realized vs Unrealized Gain/Loss</term>
<listitem>
<para>Unrealized gain or loss occurs when you’ve got a change in price of an asset. You realize the
- gain/loss when you actually sell the asset. See also <emphasis>capital
- gain/loss</emphasis>.
+ gain/loss when you actually sell the asset. See also <xref linkend="invest_terms2.capgain" />.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis>Return</emphasis></term>
+ <term id="invest_terms2.return">Return</term>
<listitem>
- <para>The total income plus capital gains or losses of an investment. See also <emphasis>Yield</emphasis>.
+ <para>The total income plus capital gains or losses of an investment. See also <xref linkend="invest_terms2.yield" />.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><emphasis>Risk</emphasis></term>
+ <term>Risk</term>
<listitem>
<para>The probability that the return on investment is different from what was expected. Investments are
@@ -172,7 +171,7 @@
</varlistentry>
<varlistentry>
- <term><emphasis>Shareholder</emphasis></term>
+ <term>Shareholder</term>
<listitem>
<para>A shareholder is a person who holds common stock in a company.
@@ -181,7 +180,7 @@
</varlistentry>
<varlistentry>
- <term><emphasis>Stock split</emphasis></term>
+ <term>Stock split</term>
<listitem>
<para>Occurs when a company offers to issue some additional multiple of shares for each existing stock.
@@ -194,7 +193,7 @@
</varlistentry>
<varlistentry>
- <term><emphasis>Valuation</emphasis></term>
+ <term>Valuation</term>
<listitem>
<para>The process of determining the market value or the price the investment would sell at in a
@@ -204,12 +203,12 @@
</varlistentry>
<varlistentry>
- <term><emphasis>Yield</emphasis></term>
+ <term id="invest_terms2.yield">Yield</term>
<listitem>
- <para>A measure of the amount of money you earn from an investment (IE: how much income you receive from
+ <para>A measure of the amount of money you earn from an investment (That is how much income you receive from
the investment). Typically this is reported as a percentage of the principal amount.
- Yield does not include capital gains or loses (see Return). Eg: A stock sells for $100
+ Yield does not include capital gains or loses (see <xref linkend="invest_terms2.return" />). For example, a stock sells for $100
and gives $2 in dividends per year has a yield of 2%.
</para>
</listitem>
@@ -258,7 +257,7 @@
</para>
<para>A mutual fund is a group investment mechanism in which you can buy into many stocks simultaneously.
- For example, a "S&P 500 index fund" is a fund which purchases all 500 stocks listed
+ For example, a <quote>S&P 500 index fund</quote> is a fund which purchases all 500 stocks listed
in the Standard and Poor’s index. When you buy a share of this fund, you are
really buying a small amount of each of the 500 stocks contained within the fund. Mutual
funds are treated exactly like a single stock, both for tax purposes and in accounting.
@@ -314,8 +313,8 @@
&app; file is open, switch to the <guilabel>Accounts</guilabel> tab, and choose
<menuchoice>
<guimenu>Actions</guimenu><guimenuitem>New Account Hierarchy</guimenuitem>
- </menuchoice>
- . This will run the <guilabel>New Account Hierarchy Setup</guilabel> assistant and allow you
+ </menuchoice>.
+ This will run the <guilabel>New Account Hierarchy Setup</guilabel> assistant and allow you
to select additional accounts to add to your account hierarchy. Choose the
<guilabel>Investment Accounts</guilabel> option (along with any others you are interested
in). Assuming only investment accounts were selected, this will create an account hierarchy
@@ -352,7 +351,7 @@
</mediaobject>
</screenshot>
- <para>You will probably at least want to add a <emphasis>Bank</emphasis> account to the Assets and
+ <para>You will probably at least want to add a <emphasis>Bank</emphasis> account to the <emphasis>Assets</emphasis> account and
probably an <emphasis>Equity:Opening Balances</emphasis> account, as we have done in
previous chapters. Don’t forget to save your new account file with a relevant name!
</para>
@@ -381,11 +380,8 @@
as the brokerage account.
</para>
- <para>Security prices are kept in a separate area of &app; (the Price Database -
- <menuchoice>
- <guimenu>Tools</guimenu><guimenuitem>Price Editor</guimenuitem>
- </menuchoice>
- ). This contains prices for individual securities (not security accounts). All prices for an
+ <para>Security prices are kept in the <guilabel>Price Database</guilabel> of &app; (see <xref linkend="invest-stockprice1" />).
+ This contains prices for individual securities (not security accounts). All prices for an
individual security are in a single currency. If a security is traded in multiple
currencies, then a separate security and separate accounts should be set up for each
currency.
@@ -479,15 +475,16 @@
<screen>
Assets
Bank ABC
- CD
+ Certificate of Deposit
Savings
Expenses
Bank ABC
Charges
Income
Interest Income
- CD
+ Certificate of Deposit
Savings</screen>
+
<para>As usual, this account hierarchy is simply presented as an example, you should create your accounts
in a form which best matches your actual situation.
</para>
@@ -497,9 +494,9 @@ Income
<title>Example</title>
<para>Now let’s populate these accounts with real numbers. Let’s assume that you start with
- $10000 in your bank account, which pays 1% interest and you buy a $5000 certificate of
+ $10,000 in your bank account, which pays 1% interest and you buy a $5,000 certificate of
deposit with a 6 month maturity date and a 2% yield. Clearly, it is much better to keep your
- money in the CD than in the savings account. After the initial purchase, your accounts
+ money in the certificate of deposit than in the savings account. After the initial purchase, your accounts
should look something like this:
</para>
@@ -520,7 +517,7 @@ Income
</textobject>
<caption>
- <para>This is an image of the account register after creating and investing in a CD investment.
+ <para>This is an image of the account register after creating and investing in a certificate of deposit investment.
</para>
</caption>
</mediaobject>
@@ -529,7 +526,7 @@ Income
<para>Now, during the course of the next 6 months, you receive monthly bank statements which describe the
activity of your account. In our fictional example, we do nothing with the money at this
bank, so the only activity is income from interest and bank charges. The monthly bank
- charges are $2. After 6 months, the register window for the CD and for the savings account
+ charges are $2. After 6 months, the register window for the certificate of deposit and for the savings account
should look like these:
</para>
@@ -550,7 +547,7 @@ Income
</textobject>
<caption>
- <para>This is an image of the register of the CD account after 6 months.
+ <para>This is an image of the register of the certificate of deposit account after 6 months.
</para>
</caption>
</mediaobject>
@@ -606,14 +603,14 @@ Income
</screenshot>
<para>From the above image of the main &app; account window you see a nice summary of what happened to
- these investments over the 6 months. While the yield on the CD is double that of the savings
- account, the return on the CD was $50.21 versus $13.03 for the savings account, or almost 4
+ these investments over the 6 months. While the yield on the certificate of deposit is double that of the savings
+ account, the return on the certificate of deposit was $50.21 versus $13.03 for the savings account, or almost 4
times more. Why? Because of the pesky $2 bank charges that hit the savings account (which
counted for $12 over 6 months).
</para>
- <para>After this 6 month period, the CD has reached maturity which means you may sell it with no early
- withdrawal penalty. To do so, simply transfer the $5050.21 from the CD account into the
+ <para>After this 6 month period, the certificate of deposit has reached maturity which means you may sell it with no early
+ withdrawal penalty. To do so, simply transfer the $5,050.21 from the certificate of deposit account into the
savings account.
</para>
</sect2>
@@ -626,9 +623,9 @@ Income
to create and populate the accounts with your investment portfolio. After this initial setup
of your portfolio, you may have shares of stock purchased from before you started using &app;.
For these stocks, follow the instructions in the
- <link linkend="invest-buy-stock2"><emphasis>Entering Preexisting Shares</emphasis></link>
- section below. If you have just purchased your stocks, then use the
- <link linkend="invest-buy-new2"><emphasis>Buying New Shares</emphasis> </link> section.
+ <xref linkend="invest-buy-stock2" endterm="invest-buy-stock2.title" /> section.
+ If you have just purchased your stocks, then use the
+ <xref linkend="invest-buy-new2" endterm="invest-buy-new2.title" /> section.
</para>
<sect2 id="invest-setup-stockaccounts2">
@@ -680,8 +677,8 @@ Income
menu
<menuchoice>
<guimenu>Actions</guimenu><guimenu>New Account...</guimenu>
- </menuchoice>
- . The New Account dialog will appear, follow the steps, in the sequence below to setup your
+ </menuchoice>.
+ The New Account dialog will appear, follow the steps, in the sequence below to setup your
new stock account.
</para>
@@ -710,8 +707,8 @@ Income
<orderedlist>
<listitem>
- <para><emphasis>Account Name</emphasis> - Usually, use the stock ticker abbreviation, IE:
- <quote>AMZN</quote>
+ <para><emphasis>Account Name</emphasis> - Usually, use the stock ticker abbreviation, like
+ <quote><userinput>AMZN</userinput></quote>.
</para>
</listitem>
@@ -741,20 +738,20 @@ Income
<listitem>
<para><emphasis>Create the New Security</emphasis> - To use a new stock, you must create the stock as a
- new commodity
+ new commodity.
</para>
<note>
- <para>Be sure to first select Account Type <emphasis>Stock </emphasis> or <emphasis>Mutual Fund</emphasis>
- so that the <guilabel>Select...</guilabel> button brings up the list of securites
+ <para>Be sure to first select Account Type <emphasis>Stock</emphasis> or <emphasis>Mutual Fund</emphasis>
+ so that the <guibutton>Select...</guibutton> button brings up the list of securities
rather than currencies.
</para>
</note>
<itemizedlist>
<listitem>
- <para><emphasis>Select Security/Currency</emphasis> - Click on the <guibutton>Select ...</guibutton>
- button next to the <guilabel>security/currency</guilabel> line. We must change the
+ <para><emphasis>Select Security/Currency</emphasis> - Click on the <guibutton>Select...</guibutton>
+ button next to the <guilabel>Security/currency</guilabel> line. We must change the
security from the default (your default currency) to this specific stock. This will
bring up the <guilabel>Select Security</guilabel> dialog.
</para>
@@ -801,16 +798,18 @@ Income
-->
<itemizedlist>
<listitem>
- <para>The <guilabel>Full name:</guilabel> is <quote>Amazon.com</quote>.
+ <para>The <guilabel>Full name:</guilabel> is <userinput>Amazon.com</userinput>.
</para>
</listitem>
<listitem>
- <para>The <guilabel>Symbol/abbreviation:</guilabel> is <quote>AMZN</quote>. The symbol is the stock ticker
- used in your quote source several lines down on the form. Note that different
- symbols will be utilized on different price sources for the same stock, an
+ <para>The <guilabel>Symbol/abbreviation:</guilabel> is <userinput>AMZN</userinput>. The symbol is the stock ticker
+ used in your quote source several lines down on the form.
+ <note><para>
+ Different symbols will be used on different price sources for the same stock, an
example is Ericsson on the Stockholm Exchange is ERIC-B while on Yahoo it is
- ERRICB.ST
+ ERRICB.ST.</para>
+ </note>
</para>
</listitem>
@@ -830,22 +829,20 @@ Income
<listitem>
<para>The <guilabel>Fraction traded</guilabel> should be adjusted to the smallest fraction of this
- security which can be traded, usually 1/100 or 1/10000.
+ security which can be traded, usually <guilabel>1/100</guilabel> or <guilabel>1/10000</guilabel>.
</para>
</listitem>
<listitem>
<para>The checkbox <quote>Get Online Quotes</quote>, the quote source and the timezone should be selected
- to define the sources for updating prices on-line. See Also
- <link linkend="invest-stockprice-auto2"> <quote>Setting Stock Price
- Automatically</quote></link>.
+ to define the sources for updating prices on-line. See also
+ <xref linkend="invest-stockprice-auto2" />.
</para>
<note>
<para>If the <guibutton>Get Online Quotes</guibutton> button is not highlighted, and it is not tickable,
- then the <application>Finance::Quote</application> package is not installed.
- See the section on <link linkend="invest-stockprice-auto-install3">
- <quote>Installing <application>Finance::Quote</application></quote></link>.
+ then the &app-fq; package is not installed.
+ See the section on <xref linkend="invest-stockprice-auto-install3"/>.
</para>
</note>
@@ -955,7 +952,7 @@ Income
</textobject>
<caption>
- <para>This image is after the creation of the first stock account (AMZN)
+ <para>This image is after the creation of the first stock account (AMZN).
</para>
</caption>
</mediaobject>
@@ -975,22 +972,22 @@ Income
<title>Buying Shares</title>
<sect2 id="invest-buy-stock2">
- <title>Entering Preexisting Shares</title>
+ <title id="invest-buy-stock2.title">Entering Preexisting Shares</title>
- <para>The examples in this section use <guilabel>Transaction Journal </guilabel> view.
+ <para>The examples in this section use <guilabel>Transaction Journal</guilabel> view.
</para>
- <para>To register the initial 100 shares of this stock that you purchased previously, on the first
- (transaction) line, enter the date of the purchase (eg: Jan. 1 2005) and
- <guilabel>Description</guilabel> (eg: Opening Balance). On the first split line, enter 100
- in <guilabel>Shares </guilabel>, delete the (unit) <guilabel>Price</guilabel> (it will be
- calculated when you <keycap>Tab</keycap> out of the split) and enter 2000 in the
+ <para>To register the initial <userinput>100</userinput> shares of this stock that you purchased previously, on the first
+ (transaction) line, enter the date of the purchase (for example, Jan. 1 2005) and
+ <guilabel>Description</guilabel> (for example, Opening Balance). On the first split line, enter <userinput>100</userinput>
+ in <guilabel>Shares</guilabel>, delete the (unit) <guilabel>Price</guilabel> (it will be
+ calculated when you <keycap>Tab</keycap> out of the split) and enter <userinput>2000</userinput> in the
<guilabel>Buy</guilabel> column.
</para>
<note>
<para>It is also possible to use &app; to calculate <guilabel>Shares</guilabel> or
- <guilabel>Buy</guilabel> from the other 2 columns but to avoid rounding errors, it is
+ <guilabel>Buy</guilabel> from the other 2 columns. But to avoid rounding errors, it is
better to automatically calculate <guilabel>Price</guilabel>.
</para>
</note>
@@ -1017,7 +1014,7 @@ Income
</textobject>
<caption>
- <para>This image is of the transaction register of the AMZN account after the first stock
+ <para>This image is the transaction register of the AMZN account after the first stock
<quote>purchase</quote>.
</para>
</caption>
@@ -1025,18 +1022,18 @@ Income
</screenshot>
<para>Notice that the <guilabel>Balance</guilabel> (last column) is in the units of the commodity (AMZN
- shares) not in currency units. Thus, the balance is 100 (AMZN units) rather than $2000. This
+ shares) not in currency units. Thus, the balance is 100 (AMZN units) rather than $2,000. This
is how it should be.
</para>
</sect2>
<sect2 id="invest-buy-new2">
- <title>Buying New Shares</title>
+ <title id="invest-buy-new2.title">Buying New Shares</title>
<para>The main difference between setting up a new stock purchase versus the setup for preexisting stocks
as described in the previous section is that instead of transferring the money used to
purchase the stock from the <emphasis>Equity:Opening Balances</emphasis> account, you
- transfer from your <emphasis>Assets:Bank ABC</emphasis> or <emphasis> Assets:Brokerage
+ transfer from your <emphasis>Assets:Bank ABC</emphasis> or <emphasis>Assets:Brokerage
Account</emphasis> account.
</para>
@@ -1044,41 +1041,39 @@ Income
<title>Handling Commissions and Fees</title>
<para>For conciseness, this document will refer to the money you pay to a broker for buying and selling
- securities as <emphasis>Commissions </emphasis>. Government fees may also be payable.
+ securities as <emphasis>Commissions</emphasis>. Government fees may also be payable.
Unless otherwise stated, fees are handled in a similar way.
</para>
- <para>In &app; there are 2 alternate ways to handle commissions (for simplicity this document section will
- refer to these ways as net pricing and gross pricing):
- </para>
-
- <itemizedlist>
- <listitem>
- <para><emphasis>Net Pricing:</emphasis> You enter a net price (adjusted by commissions) when buying and
- selling securities. You do <emphasis>not</emphasis> also record commissions in a
- specific commissions account in order to later claim it as an expense, as this would
- be claiming commissions twice. This way <emphasis>is</emphasis> compatible with using
- <xref linkend="invest-sellLots"></xref>. This results in a slightly misleading price
- being added to the price database (the effective price you paid) but is not usually of
- any concern.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>OR
- </para>
+ <para>In &app; 2 alternate ways can be used to handle commissions (for simplicity this document section will
+ refer to these ways as net pricing and gross pricing).</para>
- <itemizedlist>
- <listitem>
- <para><emphasis>Gross Pricing:</emphasis> You enter the price not adjusted by commissions and enter the
- commissions expense on a separate split in the transaction. This enables the tracking
- of commissions but is <emphasis>not</emphasis> compatible with using
- <xref linkend="invest-sellLots"></xref>. Scrubbing doesn't know to deduct commissions
- and fees from the gains, so capital gains or losses must be manually calculated (see
- <xref linkend="invest-sell-man"></xref>).
- </para>
- </listitem>
- </itemizedlist>
+ <variablelist>
+ <varlistentry>
+ <term>Gross Pricing</term>
+ <listitem><para>You enter the price not adjusted by commissions and enter the
+ commissions expense on a separate split in the transaction. This enables the tracking
+ of commissions but is <emphasis>not</emphasis> compatible with using
+ <xref linkend="invest-sellLots"/>. Scrubbing doesn't know to deduct commissions
+ and fees from the gains, so capital gains or losses must be manually calculated (see
+ <xref linkend="invest-sell-man"/>).
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>Net Pricing</term>
+ <listitem><para>
+ You enter a net price (adjusted by commissions) when buying and
+ selling securities. You do <emphasis>not</emphasis> also record commissions in a
+ specific commissions account in order to later claim it as an expense, as this would
+ be claiming commissions twice. This way <emphasis>is</emphasis> compatible with using
+ <xref linkend="invest-sellLots"/>. This results in a slightly misleading price
+ being added to the price database (the effective price you paid) but is not usually of
+ any concern.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
<para>Please get professional advice if you are unsure which of these ways are applicable to your
jurisdiction.
@@ -1088,22 +1083,21 @@ Income
<sect3 id="invest-buy-gross">
<title>Example: Buying Shares with Gross Pricing</title>
- <para>In this example you will purchase $5000 of IBM stock, with a commission of $100. First step will be
+ <para>In this example you will purchase 100 shares at $50 per share of IBM stock with a commission of $100. First step will be
to create the stock account for IBM. The existing <emphasis>Expenses:Commission</emphasis>
account will be used. If you wish to track commissions to the individual stock level an
- additional sub-account would be necessary. E.g.
- <emphasis>Expenses:Commission:IBM</emphasis>.
+ additional sub-account would be necessary, like <emphasis>Expenses:Commission:IBM</emphasis>.
</para>
<para>Now for the transaction, on the first (transaction) line, enter the <guilabel>Date</guilabel> of the
- purchase (eg: Jan. 3 2005) and <guilabel>Description</guilabel> (eg: Initial IBM
- Purchase). On the first split line, enter 50 in <guilabel>Shares</guilabel>, delete
- <guilabel>Price</guilabel> (leave it empty so it will be calculated)), and enter 5000 in
+ purchase (for example, Jan. 3 2005) and <guilabel>Description</guilabel> (for example, Initial IBM
+ Purchase). On the first split line, enter <userinput>50</userinput> in <guilabel>Shares</guilabel>, delete
+ <guilabel>Price</guilabel> (leave it empty so it will be calculated), and enter <userinput>5000</userinput> in
<guilabel>Buy</guilabel>. You do not need to fill in the <guilabel>Price</guilabel>
column, as it will be calculated for you when you <keycap>Tab</keycap> to the next split.
- The next line in the split transaction will be <emphasis>Expenses:Commissions </emphasis>
- and fill in <guilabel>Buy</guilabel> ($100). The third line will be to transfer $5100 from
- account <emphasis> Assets:Bank ABC</emphasis> to balance the transaction. Your IBM
+ The next line in the split transaction will be <emphasis>Expenses:Commissions</emphasis>
+ and fill <userinput>100</userinput> in <guilabel>Buy</guilabel>. The third split line will be to transfer $5,100 from
+ <emphasis>Assets:Bank ABC</emphasis> account to balance the transaction. Your IBM
Commodity view should now appear like this:
</para>
@@ -1136,30 +1130,30 @@ Income
<title>Example: Buying Shares with Net Pricing</title>
<para>Repeating the previous example using Net Pricing instead of Gross Pricing, in Transaction Journal
- view:
+ view.
</para>
- <para>Purchase $5000 of IBM stock being 50 Shares for $100.00 each, plus a commission of $100.
+ <para>Purchase $5,000 of IBM stock being 50 Shares for $100.00 each, plus a commission of $100.
</para>
<para>Now for the transaction, on the first (transaction) line, enter the <guilabel>Date</guilabel> of the
- purchase (eg: Jan. 3 2005) and a <guilabel>Description</guilabel> (eg: Initial IBM
+ purchase (for example, Jan. 3 2005) and <guilabel>Description</guilabel> (for example, Initial IBM
Purchase). On the first split line, optionally enter more details in <guilabel>Memo
- </guilabel>, then 50 in <guilabel>Shares</guilabel>, delete anything in
+ </guilabel>, then <userinput>50</userinput> in <guilabel>Shares</guilabel>, delete anything in
<guilabel>Price</guilabel> (so it will be calculated by dividing <guilabel>Buy</guilabel>
by <guilabel>Shares</guilabel> when you <keycap>Tab</keycap> out of the split), 5100 in
- <guilabel>Buy </guilabel> (50 * $100.00 + $100). Alternatively use &app; to calculate
- <guilabel>Buy</guilabel> by entering the formula <emphasis>5000+100</emphasis> or
- <emphasis> (50 * 100) + 100 </emphasis> in <guilabel>Buy</guilabel> (
- <guilabel>Buy</guilabel> will be calculated when you <keycap>Tab </keycap> out of the
- column. Use the <keycap>Tab</keycap> key as many times as needed to proceed to the next
+ <guilabel>Buy</guilabel> (50 * $100.00 + $100). Alternatively use &app; to calculate
+ <guilabel>Buy</guilabel> by entering the formula <userinput>5000 + 100</userinput> or
+ <userinput>(50 * 100) + 100</userinput> in <guilabel>Buy</guilabel> (
+ <guilabel>Buy</guilabel> will be calculated when you <keycap>Tab</keycap> out of the
+ column.) Use the <keycap>Tab</keycap> key as many times as needed to proceed to the next
split.
</para>
<para>Do <emphasis>not</emphasis> enter a separate split for Commission as it has already been included in
- the <guilabel>Buy</guilabel> value. The second split line will be to transfer from
- <emphasis> Assets:Bank ABC</emphasis> $5100 to balance the transaction. After the splits
- are all correct, use the <keycap function="enter">Enter </keycap> key to save the
+ the <guilabel>Buy</guilabel> value. The second split line will be to transfer $5,100 from
+ <emphasis>Assets:Bank ABC</emphasis> account to balance the transaction. After the splits
+ are all correct, use the <keycap function="enter">Enter</keycap> key to save the
transaction. Your IBM Commodity view should now appear like this:
</para>
@@ -1195,21 +1189,21 @@ Income
<para>The value of a commodity, such as a stock, must be explicitly set. The stock accounts track the
quantity of stocks you own, but the value of the stock is stored in the <emphasis>Price
- Editor</emphasis>. The values set in the <guilabel>Price Editor</guilabel> can be updated
+ Database</emphasis>. The values set in the <guilabel>Price Database</guilabel> can be updated
manually or automatically.
</para>
<sect2 id="invest-stockprice-initial2">
- <title>Initial Price Editor Setup</title>
-
- <para>To use the <guilabel>Price Editor</guilabel> to track a stock value, you must initially insert the
- stock. To do so, open the <guilabel>Price Editor</guilabel> (
- <menuchoice>
- <guimenu>Tools</guimenu><guimenuitem>Price Editor</guimenuitem>
- </menuchoice>
- ) and click on <guibutton>Add</guibutton> button. The first time a Commodity/Stock is
+ <title>Initial Price Database Setup</title>
+
+ <para>To use the <guilabel>Price Database</guilabel> to track a stock value, you must initially insert the
+ stock. To do so, open the <guilabel>Price Database</guilabel>
+ (<menuchoice>
+ <guimenu>Tools</guimenu><guimenuitem>Price Database</guimenuitem>
+ </menuchoice>)
+ and click on <guibutton>Add</guibutton> button. The first time a Commodity/Stock is
entered this window will be blank except for the control buttons on the bottom. Select the
- appropriate Commodity you want to insert into the <guilabel>Price Editor</guilabel>. At this
+ appropriate Commodity you want to insert into the <guilabel>Price Database</guilabel>. At this
point, you can input the price of the commodity manually. There are 6 fields in the New
Commodity window:
</para>
@@ -1219,7 +1213,7 @@ Income
<term><guilabel>Namespace</guilabel></term>
<listitem>
- <para>The exchange market where the security/commodity is traded (in this example NASDAQ)
+ <para>The exchange market where the security/commodity is traded (in this example NASDAQ.)
</para>
</listitem>
</varlistentry>
@@ -1228,7 +1222,7 @@ Income
<term><guilabel>Security</guilabel></term>
<listitem>
- <para>The name of the commodity, must be chosen from the <guibutton>Select...</guibutton> list
+ <para>The name of the commodity, must be chosen from the <guibutton>Select...</guibutton> list.
</para>
</listitem>
</varlistentry>
@@ -1246,7 +1240,7 @@ Income
<term><guilabel>Date</guilabel></term>
<listitem>
- <para>Date that the price is valid
+ <para>Date that the price is valid.
</para>
</listitem>
</varlistentry>
@@ -1257,7 +1251,7 @@ Income
<listitem>
<para>One of: <guilabel>Bid</guilabel> (the market buying price), <guilabel>Ask</guilabel> (the market
selling price), <guilabel>Last</guilabel> (the last transaction price), <guilabel>Net
- Asset Value</guilabel> (mutual fund price per share), or <guilabel>Unknown</guilabel>.
+ Asset Value</guilabel> (mutual fund price per share, <acronym>NAV</acronym> for short), or <guilabel>Unknown</guilabel>.
Stocks and currencies will usually give their quotes as one of bid, ask or last.
Mutual funds are often given as net asset value. For other commodities, simply choose
<guilabel>Unknown</guilabel>. This option is for informational purposes only, it is
@@ -1276,7 +1270,7 @@ Income
</varlistentry>
</variablelist>
- <para>As an example of adding the AMZN commodity to the price editor, with an initial value of $40.50 per
+ <para>As an example of adding the AMZN commodity to the price database, with an initial value of $40.50 per
share.
</para>
@@ -1293,28 +1287,27 @@ Income
</imageobject>
<textobject>
- <phrase>Price Editor</phrase>
+ <phrase>Price Database</phrase>
</textobject>
<caption>
- <para>Adding the AMZN commodity to the price editor, with an initial value of $40.50 per share.
+ <para>Adding the AMZN commodity to the price database, with an initial value of $40.50 per share.
</para>
</caption>
</mediaobject>
</screenshot>
<para>Click <guibutton>OK</guibutton> when finished. Once you have performed this initial placement of the
- commodity into the <guilabel>Price Editor</guilabel>, you will not have to do it again, even
+ commodity into the <guilabel>Price Database</guilabel>, you will not have to do it again, even
if you use the same commodity in another account.
</para>
<note>
<para>If you have online retrieval of quotes activated (see
- <xref
- linkend="invest-stockprice-auto2"></xref>), you can initialize a commodity
+ <xref linkend="invest-stockprice-auto2" />), you can initialize a commodity
without manually making an entry. When you initially add the security in the
- <guilabel>Security Editor</guilabel>, check <guibutton>Get Online Quotes</guibutton> and
- save the security. Then, in the <guilabel>Price Editor</guilabel>, click <guibutton>Get
+ <guilabel>Security Editor</guilabel>, check <guilabel>Get Online Quotes</guilabel> and
+ save the security. Then, in the <guilabel>Price Database</guilabel>, click <guibutton>Get
Quotes</guibutton>, and the new security will be inserted into the price list with the
retrieved price.
</para>
@@ -1325,7 +1318,7 @@ Income
<title>Setting Stock Price Manually</title>
<para>If the value of the commodity (stock) changes, you can adjust the value by entering the
- <guilabel>Price Editor</guilabel>, selecting the commodity, clicking on
+ <guilabel>Price Database</guilabel>, selecting the commodity, clicking on
<guibutton>Edit</guibutton> and entering the new price.
</para>
@@ -1342,11 +1335,11 @@ Income
</imageobject>
<textobject>
- <phrase>Price Editor</phrase>
+ <phrase>Price Database</phrase>
</textobject>
<caption>
- <para>The main price editor window, showing the list of all known commodities.
+ <para>The main price database window, showing the list of all known commodities.
</para>
</caption>
</mediaobject>
@@ -1359,11 +1352,11 @@ Income
<para>If you have more than a couple of commodities, you will tire of having to update their prices
constantly. &app; has the ability to automatically download the most recent price for your
commodities using the Internet. This is accomplished through the
- <application>Perl</application> module <application>Finance::Quote</application>, which must
+ <application>Perl</application> module &app-fq;, which must
be installed in order to activate this feature.
</para>
- <para>To determine if the <application>Perl</application> module <application>Finance::Quote</application>
+ <para>To determine if the <application>Perl</application> module &app-fq;
is already installed on your system, type <command>perldoc Finance::Quote</command> in a
terminal window and check to see if there is any documentation available. If you see the
documentation, then the module is installed, if you do not see the documentation, then it
@@ -1371,64 +1364,54 @@ Income
</para>
<sect3 id="invest-stockprice-auto-install3">
- <title>Installing <application>Finance::Quote</application></title>
-
- <para>&win;:
- <itemizedlist>
- <listitem>
- <para>Close &app;.
- </para>
- </listitem>
-
- <listitem>
- <para>Run <emphasis role="strong">Install Online Price Retrieval</emphasis> which can be found in the
- &app; <quote>Start</quote> menu entry.
- </para>
- </listitem>
- </itemizedlist>
- </para>
-
- <para>&mac;: You need to have XCode installed. XCode is an optional
- item from your &mac; distribution DVD. Run the <emphasis role="strong">Update Finance
- Quote</emphasis> app in the &app; dmg. You can run it from the dmg or copy it to the same
- folder to which you copied &app;. It will open a Terminal window and run a script for you
- which will ask lots of questions. Accept the default for each unless you know what
- you’re doing.
- </para>
-
- <para>&lin;:
- <itemizedlist>
- <listitem>
- <para>Close any running &app; instances.
- </para>
- </listitem>
-
- <listitem>
- <para>Locate the folder where &app; is installed by searching for <application>gnc-fq-update</application>
- </para>
- </listitem>
-
- <listitem>
- <para>Change to that directory, open a root shell
- </para>
- </listitem>
-
- <listitem>
- <para>Run the command <command>gnc-fq-update</command>
- </para>
- </listitem>
- </itemizedlist>
- This will launch a <application>Perl</application> CPAN update session that will go out
- onto the internet and install the <application>Finance::Quote</application> module on your
- system. The gnc-fq-update program is interactive, however, with most systems you should be
- able to answer <quote>no</quote> to the first question: <quote>Are you ready for manual
- configuration? [yes]</quote> and the update will continue automatically from that point.
- </para>
-
- <para>After installation is complete, you should run the <quote>gnc-fq-dump</quote> test program, in the
- same directory, distributed with &app; to test if
- <application>Finance::Quote</application> is installed and working properly.
- </para>
+ <title>Installing &app-fq;</title>
+ <para>The process of installing &app-fq; depends on the system. </para>
+
+ <procedure>
+ <title>Installing &app-fq; on &win;</title>
+ <step><simpara>Close &app;.</simpara></step>
+ <step><simpara>Run <menuchoice>
+ <guimenu>Start</guimenu>
+ <guisubmenu>&app;</guisubmenu>
+ <guimenuitem>Install Online Price Retrieval</guimenuitem></menuchoice>.
+ </simpara>
+ </step>
+ </procedure>
+
+ <procedure>
+ <title>Installing &app-fq; on &mac;</title>
+ <step><simpara>Install Xcode if it is not installed.</simpara>
+ <simpara>XCode is an optional item from your &mac; distribution DVD.</simpara>
+ </step>
+ <step><simpara>Run the <emphasis>Update Finance Quote</emphasis> app in the &app; dmg.</simpara>
+ <para>You can run it from the dmg or copy it to the same
+ folder to which you copied &app;.
+ It will open a Terminal window and run a script for you
+ which will ask lots of questions. Accept the default for each unless you know what
+ you’re doing.
+ </para>
+ </step>
+ </procedure>
+
+ <procedure>
+ <title>Installing &app-fq; on &lin;</title>
+ <step><simpara>Close any running &app; instances.</simpara></step>
+ <step><simpara>Locate the folder where &app; is installed by searching for <filename>gnc-fq-update</filename>.</simpara></step>
+ <step><simpara>Change to that directory, open a root shell.</simpara></step>
+ <step><simpara>Run the command <command>./gnc-fq-update</command>.</simpara>
+ <para>
+ This will launch a <application>Perl</application> CPAN update session that will go out
+ onto the internet and install the &app-fq; module on your
+ system. The gnc-fq-update program is interactive, however, with most systems you should be
+ able to answer the first question <computeroutput>Are you ready for manual
+ configuration? [yes]</computeroutput> with <userinput>no</userinput>. Then the update will continue automatically from that point.
+ </para>
+ <para>After installation is complete, you should run the <quote><filename>gnc-fq-dump</filename></quote> test program, in the
+ same directory, distributed with &app; to test if
+ &app-fq; is installed and working properly.
+ </para>
+ </step>
+ </procedure>
<note>
<para>If you feel uncomfortable about performing any of these steps, please either email the &app;-user
@@ -1442,37 +1425,46 @@ Income
<sect3 id="invest-stockprice-auto-configure3">
<title>Configuring Securities for Online Quotes</title>
- <para>With <application>Finance::Quote</application> installed and functioning correctly, you must
+ <para>With &app-fq; installed and functioning correctly, you must
configure your &app; securities to use this feature to obtain updated price information
automatically. Whether creating new securities or modifying securities that have already
been setup, use the
<menuchoice>
<guimenu>Tools</guimenu><guimenuitem>Security Editor</guimenuitem>
- </menuchoice>
- , to edit the security and check the <guilabel>Get Online Quotes</guilabel> box. You will
+ </menuchoice>,
+ to edit the security and check the <guilabel>Get Online Quotes</guilabel> box. You will
now be able to modify the radio buttons for <guilabel>Type of quote source</guilabel>, the
pull-down menus to specify the specific source(s) and <guilabel>The timezone for these
quotes</guilabel>. When finished editing, <guilabel>Close</guilabel> the Security Editor
- to return to the <guilabel>Price Editor</guilabel> and click on the <guibutton>Get
+ to return to the <guilabel>Price Database</guilabel> and click on the <guibutton>Get
Quotes</guibutton> button to update your stock prices on the Internet.
</para>
- <para>The command <command>gnucash --add-price-quotes $HOME/gnucash-filename</command> can be used to
+ <para>The command <command>gnucash-cli --quotes get <filename><replaceable>$HOME/gnucash-filename</replaceable></filename></command> can be used to
fetch the current prices of your stocks. The file specified
- <filename class="directory">$HOME/gnucash-filename</filename> will depend on the name and
+ <filename><replaceable>$HOME/gnucash-filename</replaceable></filename> will depend on the name and
location of your data file. This can be determined by the name displayed in the top frame
of the &app; window, before the <quote>-</quote>. The file name can also be found under
<guimenu>File</guimenu> in the recently opened file list; the first item, numbered 1, is
the name of the currently open file.
</para>
+ <note>
+ <simpara>The Online Quotes Retrieval command has been changed from &app; 4.0. If you've upgraded from &app; 3.11 or previous version,
+ be sure to change the command.</simpara>
+ </note>
+ </sect3>
+
+ <sect3 id="invest-stockprice-auto-scheduler">
+ <title>Configuring for Getting Online Quotes Periodically</title>
+
<para>This can be automated by creating a <application>crontab</application> entry. For example, to update
your file every Friday evening (16:00) after the relevant exchange markets close (modify
the time accordingly for your time zone), you could add the following to your personal
<application>crontab</application>:
- </para>
-
- <para>0 16 * * 5 gnucash --add-price-quotes $HOME/gnucash-filename > /dev/null 2>&1
+ <informalexample>
+ <screen>0 16 * * 5 gnucash-cli --quotes get <replaceable>$HOME/gnucash-filename</replaceable> > /dev/null 2>&1</screen>
+ </informalexample>
</para>
<para>Remember that Mutual Fund <quote>prices</quote> are really <quote>Net Asset Value</quote> and
@@ -1530,18 +1522,18 @@ Income
<guibutton>Options</guibutton> icon in the <emphasis>Menubar</emphasis> or selecting
<menuchoice>
<guimenu>Edit</guimenu><guimenuitem>Report Options</guimenuitem>
- </menuchoice>
- . <guilabel>Price Source</guilabel> determines how accounts denominated in commodities
+ </menuchoice>.
+ <guilabel>Price Source</guilabel> determines how accounts denominated in commodities
different from the report currency are converted to the report currency. Depending on the
report the selector may appear in either the <guilabel>General</guilabel>, the
<guilabel>Commodities</guilabel>, or the <guilabel>Display</guilabel> tab of the
<guilabel>Report Options</guilabel> dialog box.
- <note>
+ <note>
<para>In the example below, the report is a customization of the <emphasis role="strong">Average
Balance</emphasis> report in the Assets & Liabilities reports submenu.
</para>
</note>
-
+ </para>
<screenshot id="invest-stockvalue-report-options">
<mediaobject>
<imageobject>
@@ -1560,64 +1552,63 @@ Income
</caption>
</mediaobject>
</screenshot>
+
- <itemizedlist>
- <listitem>
- <para><guilabel>Weighted Average</guilabel>: Calculates the price by summing the absolute value of the
+ <variablelist>
+ <varlistentry>
+ <term><guilabel>Weighted Average</guilabel></term>
+ <listitem><para>Calculates the price by summing the absolute value of the
amount and the absolute value of every split in every account denominated in the
commodity, excluding those splits with a zero amount, and dividing the sum of values
by the sum of amounts to obtain a price. For example, if you had a buy transaction for
200 shares of XYZ for a total of 2000 and a sell of 100 for 1300 the weighted average
would be 3300/300 or 11/share.
- </para>
-
<note>
<para>Gain/Loss splits have an amount of 0 and are <emphasis>not</emphasis> included in this calculation.
</para>
</note>
- </listitem>
-
- <listitem>
- <para><guilabel>Average Cost</guilabel>: Calculates the price by summing the amounts and values of every
- split in every account denominated in the commodity, including the zero amount splits.
- In the example above, with an additional split (either part of the sale transaction or
- in a separate transaction) booking the gain at 0 shares and a 300 gain, the average
- cost is 1000/100 (2000 original cost - 1300 proceeds from the sale + 300 gain)/(200 -
- 100) shares or 10/share.
- </para>
-
- <note>
- <para>Gain/Loss splits <emphasis>are</emphasis> included in this calculation.
- </para>
- </note>
-
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><guilabel>Average Cost</guilabel></term>
+ <listitem><para>Calculates the price by summing the amounts and values of every
+ split in every account denominated in the commodity, including the zero amount splits.
+ In the example above, with an additional split (either part of the sale transaction or
+ in a separate transaction) booking the gain at 0 shares and a 300 gain, the average
+ cost is 1000/100 (2000 original cost − 1300 proceeds from the sale + 300 gain)/(200 −
+ 100) shares or 10/share.
<note>
- <para>This is the <emphasis>only</emphasis> <guilabel>Price Source</guilabel> that will balance the
- <guilabel>Trial Balance Report</guilabel> and in order for it to balance you
- <emphasis>must</emphasis> correctly book your gains and losses.
- </para>
+ <itemizedlist>
+ <listitem><simpara>Gain/Loss splits <emphasis>are</emphasis> included in this calculation.</simpara></listitem>
+ <listitem><simpara>This is the <emphasis>only</emphasis> <guilabel>Price Source</guilabel> that will balance the
+ <guilabel>Trial Balance Report</guilabel> and in order for it to balance you
+ <emphasis>must</emphasis> correctly book your gains and losses.</simpara></listitem>
+ </itemizedlist>
</note>
- </listitem>
-
- <listitem>
- <para><guilabel>Most Recent</guilabel>: Uses the latest price from the price database.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Nearest in time</guilabel>: Uses the price nearest in time to the report date—the
- datum date for time series reports like <guilabel>Assets Over
- Time</guilabel>—from the price database.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><guilabel>Most Recent</guilabel></term>
+ <listitem><para>Uses the latest price from the price database.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><guilabel>Nearest in time</guilabel></term>
+ <listitem><para>Uses the price nearest in time to the report date—the
+ datum date for time series reports like <guilabel>Assets Over
+ Time</guilabel>—from the price database.
+ <note>
+ <simpara>The nearest date isn’t necessarily before the date in question.</simpara>
+ </note>
</para>
-
- <note>
- <para>The nearest date isn’t necessarily before the date in question.
- </para>
- </note>
- </listitem>
- </itemizedlist>
- </para>
-
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
<screenshot id="invest-stockvalue-report">
<mediaobject>
<imageobject>
@@ -1644,22 +1635,18 @@ Income
<para>Entering an investment sale transaction is done in a similar way to entering a buy transaction (see
<xref linkend="invest-buy-new2" />) except the amount entered in the
- <emphasis>Shares</emphasis> column is negative and the proceeds of the transaction is entered
- in the <emphasis>Sell </emphasis> column. The net proceeds from the sale should be transferred
+ <guilabel>Shares</guilabel> column is negative and the proceeds of the transaction is entered
+ in the <guilabel>Sell</guilabel> column. The net proceeds from the sale should be transferred
from the shares account to your bank or brokerage account.
</para>
<para>For information on handling <emphasis>commissions</emphasis> and the use of <emphasis>Net
Pricing</emphasis> or <emphasis>Gross Pricing</emphasis>, please see
<xref linkend="invest-buy-com" />.
- </para>
-
- <para>If you will be recording a capital gain or loss on the sale, please see
+ If you will be recording a capital gain or loss on the sale, please see
<xref linkend="chapter_capgain" /> and <xref linkend="chapter_dep" /> for more information on
this topic.
- </para>
-
- <para>To use the &app;<emphasis> Automatic Calculation of Capital Gain or Loss Using Lots</emphasis>
+ To use the &app; <emphasis>Automatic Calculation of Capital Gain or Loss Using Lots</emphasis>
feature, please see <xref linkend="invest-sellLots" /> otherwise continue to the next section.
</para>
@@ -1668,79 +1655,102 @@ Income
<note>
<para>In order for &app; to commit the zero-share, zero-price split for account
- <emphasis>Assets:Stock:SYMBOL </emphasis> to the transaction in the following schemes, you
- *must* <keycap>Tab</keycap> out of that split. If you use the
+ <emphasis>Assets:Stock:SYMBOL</emphasis> to the transaction in the following schemes, you
+ <emphasis>must</emphasis> <keycap>Tab</keycap> out of that split. If you use the
<keycap function="enter">Enter</keycap> key, &app; will convert the split into shares of
the commodity.
</para>
</note>
<para>In the schemes of transaction splits presented below, the following symbols are used:
- </para>
- <itemizedlist>
+ <variablelist>
+ <varlistentry>
+ <term>NUM_SHARES</term>
<listitem>
- <para>NUM_SHARES: number of shares you are selling
- </para>
+ <simpara>the number of shares you are selling</simpara>
</listitem>
+ </varlistentry>
- <listitem>
- <para>COMMISSION: brokerage commissions or fees
- </para>
- </listitem>
+ <varlistentry>
+ <term>COMMISSION</term>
+ <listitem>
+ <simpara>brokerage commissions or fees</simpara>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>GROSS_SELL_PRICE: unit price for which you sold the shares, not reduced by COMMISSION
- </para>
- </listitem>
+ <varlistentry>
+ <term>GROSS_SELL_PRICE</term>
+ <listitem>
+ <simpara>unit price for which you sold the shares, not reduced by COMMISSION</simpara>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>NET_SELL_PRICE: unit price for which you sold the shares, reduced by COMMISSION
- </para>
- </listitem>
+ <varlistentry>
+ <term>NET_SELL_PRICE</term>
+ <listitem>
+ <simpara>unit price for which you sold the shares, reduced by COMMISSION</simpara>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>GROSS_BUY_PRICE: unit price for which you bought the shares, not increased by COMMISSION
- </para>
- </listitem>
+ <varlistentry>
+ <term>GROSS_BUY_PRICE</term>
+ <listitem>
+ <simpara>unit price for which you bought the shares, not increased by COMMISSION</simpara>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>NET_BUY_PRICE: unit price for which you bought the shares, increased by COMMISSION
- </para>
- </listitem>
+ <varlistentry>
+ <term>NET_BUY_PRICE</term>
+ <listitem>
+ <simpara>unit price for which you bought the shares, increased by COMMISSION</simpara>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>GROSS_BUY: total price for which you bought shares, excluding COMMISSION, equal to NUM_SHARES *
- GROSS_BUY_PRICE
- </para>
- </listitem>
+ <varlistentry>
+ <term>GROSS_BUY</term>
+ <listitem>
+ <simpara>total price for which you bought shares, excluding COMMISSION, equal to NUM_SHARES * GROSS_BUY_PRICE</simpara>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>NET_BUY: amount of money for which you bought shares including COMMISSION, equal to GROSS_BUY +
- COMMISSION.
- </para>
- </listitem>
+ <varlistentry>
+ <term>NET_BUY</term>
+ <listitem>
+ <simpara>amount of money for which you bought shares including COMMISSION, equal to GROSS_BUY + COMMISSION</simpara>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>GROSS_SALE: total price for which you sold shares, equal to NUM_SHARES * GROSS_SELL_PRICE
- </para>
- </listitem>
+ <varlistentry>
+ <term>GROSS_SALE</term>
+ <listitem>
+ <simpara>total price for which you sold shares, equal to NUM_SHARES * GROSS_SELL_PRICE</simpara>
+ </listitem>
+ </varlistentry>
- <listitem>
- <para>NET_SALE: amount of money received from the sale, equal to GROSS_SALE − COMMISSION
- </para>
+ <varlistentry>
+ <term>NET_SALE</term>
+ <listitem>
+ <simpara>amount of money received from the sale, equal to GROSS_SALE − COMMISSION</simpara>
</listitem>
+ </varlistentry>
- <listitem>
- <para>GROSS_PROFIT: amount of money you made on the sale, not reduced by COMMISSION
- </para>
- </listitem>
+ <varlistentry>
+ <term>GROSS_PROFIT</term>
+ <listitem>
+ <simpara>amount of money you made on the sale, not reduced by COMMISSION</simpara>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>NET_PROFIT</term>
+ <listitem>
+ <simpara>amount of money you made on the sale, reduced by COMMISSION</simpara>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
- <listitem>
- <para>NET_PROFIT: amount of money you made on the sale, reduced by COMMISSION
- </para>
- </listitem>
- </itemizedlist>
<para>There are 2 ways of manually recording the capital gain or loss. The capital gain/loss can be
combined with the sale in one transaction or it can be entered in a separate transaction.
@@ -1758,7 +1768,7 @@ Income
<para>When the capital gain/loss splits are combined with the sale splits in one transaction, there are 2
splits for the security account in the same transaction, so the transaction must be
- entered with the security register in <guilabel> Auto-Split Ledger</guilabel> or
+ entered with the security register in <guilabel>Auto-Split Ledger</guilabel> or
<guilabel>Transaction Journal</guilabel> view. One of the splits for the security account
is for the sale and the other is for the capital gain or loss. The security account split
for the capital gain or loss must be entered with 0 number of shares and 0 price per share
@@ -1903,51 +1913,256 @@ Income
</tbody>
</tgroup>
</table>
- </sect4>
- <sect4 id="invest-sell-man-comb-net">
- <title>Combined, Net Pricing</title>
+ <example>
- <table>
- <title>Selling Shares Split Scheme, Sale and Capital Gain/Loss Are Combined, Net Pricing</title>
+ <title>Sale of Shares with Profit, Manual Profit/Loss Calculation, Sale & Profit Combined,
+ Gross Pricing</title>
+
+ <simpara>In this example, we will use the AMZN account created in <xref linkend="invest-setup-example2" />.</simpara>
+ <para>
+ You bought 100 shares of AMZN for $20 per share, then later sell them all for $36
+ per share with a commission of $75. The split transaction scheme is as follows:
+ <itemizedlist>
+ <listitem><simpara>GROSS_BUY_PRICE is $20 (the original buying price),</simpara></listitem>
+ <listitem><simpara>NUM_SHARES is 100,</simpara></listitem>
+ <listitem><simpara>GROSS_BUY is $2,000 (the original buying cost),</simpara></listitem>
+ <listitem><simpara>GROSS_SALE is $3,600,</simpara></listitem>
+ <listitem><simpara>and finally GROSS_PROFIT is $1,600 (GROSS_SALE − GROSS_BUY).</simpara></listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ <table>
+ <title>Selling Shares Split Scheme, Sale & Gain Combined, Gross Pricing</title>
- <tgroup cols="5">
- <colspec colnum="1" colwidth="2*"/>
+<?dbfo table-width="70%" ?>
+ <tgroup cols="5">
+ <colspec colnum="1" colwidth="4*"/>
- <colspec colnum="1" colwidth="2*"/>
+ <colspec colnum="1" colwidth="2*"/>
- <colspec colnum="1" colwidth="2*"/>
+ <colspec colnum="1" colwidth="2*"/>
- <colspec colnum="1" colwidth="2*"/>
+ <colspec colnum="1" colwidth="1*"/>
- <colspec colnum="1" colwidth="2*"/>
+ <colspec colnum="1" colwidth="1*"/>
- <tbody>
- <row>
- <entry>
- <emphasis>Account</emphasis>
- </entry>
+ <tbody>
+ <row>
+ <entry>
+ <emphasis>Account</emphasis>
+ </entry>
- <entry>
- <emphasis>Number of Shares</emphasis>
- </entry>
+ <entry>
+ <emphasis>Shares</emphasis>
+ </entry>
- <entry>
- <emphasis>Share Price</emphasis>
- </entry>
+ <entry>
+ <emphasis>Price</emphasis>
+ </entry>
- <entry>
- <emphasis>Total Buy</emphasis>
- </entry>
+ <entry>
+ <emphasis>Buy</emphasis>
+ </entry>
- <entry>
- <emphasis>Total Sell</emphasis>
- </entry>
- </row>
+ <entry>
+ <emphasis>Sell</emphasis>
+ </entry>
+ </row>
- <row>
- <entry>
- Assets:Bank ABC
+ <row>
+ <entry>
+ Assets:Bank ABC
+ </entry>
+
+ <entry></entry>
+
+ <entry></entry>
+
+ <entry>
+ 3525.00
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Assets:Brokerage Account:Stock:AMZN
+ </entry>
+
+ <entry>
+ 0
+ </entry>
+
+ <entry>
+ 0
+ </entry>
+
+ <entry>
+ 1600.00
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Expenses:Commission
+ </entry>
+
+ <entry></entry>
+
+ <entry></entry>
+
+ <entry>
+ 75.00
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Assets:Brokerage Account:Stock:AMZN
+ </entry>
+
+ <entry>
+ −100
+ </entry>
+
+ <entry>
+ 36.00
+ </entry>
+
+ <entry></entry>
+
+ <entry>
+ 3600.00
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ Income:Capital Gain (Long Term):AMZN
+ </entry>
+
+ <entry></entry>
+
+ <entry></entry>
+
+ <entry></entry>
+
+ <entry>
+ 1600.00
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+ <para>
+ <figure pgwide="1">
+ <title>Selling Shares, Gain Combined, Gross Pricing</title>
+ <screenshot id="invest-sellstockManProfComb">
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="figures/invest_sellstock.png" format="PNG"
+ srccredit="Chris Good" width="510px"></imagedata>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="figures/invest_sellstock.png" format="PNG"
+ srccredit="Chris Good"></imagedata>
+ </imageobject>
+
+ <textobject><phrase>Selling Shares,Gain Combined, Gross Pricing</phrase></textobject>
+
+ </mediaobject>
+ </screenshot>
+ </figure>
+ <note>
+ <para>In the above screenshot, it appears there are 2 transactions for Mar 21st, 2006. This is because the
+ register is in <guilabel> Auto-Split Ledger</guilabel> view and there are 2 splits for
+ the register account in the 1 transaction. <guilabel>Transaction Journal</guilabel>
+ view may be clearer. Refer to <xref linkend="txns-registers-txntypes" />. As there are 2
+ splits for the register account in the sale transaction, this transaction must be
+ entered in <guilabel>Auto-Split Ledger</guilabel> or <guilabel>Transaction
+ Journal</guilabel> view. It cannot be entered in <guilabel>Basic Ledger</guilabel> view.
+ </para>
+ </note>
+ </para>
+ <para>
+ <figure pgwide="1">
+ <title>the Account Tree after the Example of Selling Shares for a Gain</title>
+ <screenshot id="invest-sellstockManProfComb2">
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="figures/invest_sellstock2.png" format="PNG"
+ srccredit="Chris Good" width="510px"></imagedata>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="figures/invest_sellstock2.png" format="PNG"
+ srccredit="Chris Good"></imagedata>
+ </imageobject>
+
+ <textobject><phrase>Selling Shares Example</phrase></textobject>
+
+ </mediaobject>
+ </screenshot>
+ </figure>
+ </para>
+
+ </example>
+
+
+
+ </sect4>
+
+ <sect4 id="invest-sell-man-comb-net">
+ <title>Combined, Net Pricing</title>
+
+ <table>
+ <title>Selling Shares Split Scheme, Sale and Capital Gain/Loss Are Combined, Net Pricing</title>
+
+ <tgroup cols="5">
+ <colspec colnum="1" colwidth="2*"/>
+
+ <colspec colnum="1" colwidth="2*"/>
+
+ <colspec colnum="1" colwidth="2*"/>
+
+ <colspec colnum="1" colwidth="2*"/>
+
+ <colspec colnum="1" colwidth="2*"/>
+
+ <tbody>
+ <row>
+ <entry>
+ <emphasis>Account</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Number of Shares</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Share Price</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Total Buy</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Total Sell</emphasis>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ Assets:Bank ABC
</entry>
<entry></entry>
@@ -2005,7 +2220,7 @@ Income
<row>
<entry>
- Income:Capital Gain
+ Income:Capital Gains
</entry>
<entry></entry>
@@ -2023,15 +2238,170 @@ Income
</tbody>
</tgroup>
</table>
+
+ <example>
+ <title>Sale of Shares with Profit, Manual Profit/Loss Calculation, Sale & Profit Combined, Net Pricing</title>
+ <simpara>In this example, we will use the AMZN account created in <xref linkend="invest-setup-example2" />.</simpara>
+ <para>You bought 100 shares of AMZN for $20 per share (including commissions), then later
+ sell them all for $36 per share with a commission of $75. The split transaction scheme
+ is as follows:
+ <itemizedlist>
+ <listitem><simpara>NUM_SHARES is 100,</simpara></listitem>
+ <listitem><simpara>NET_BUY_PRICE is $20 (the original buying price),</simpara></listitem>
+ <listitem><simpara>NET_BUY is $2,000 (the original buying cost),</simpara></listitem>
+ <listitem><simpara>NET_SELL_PRICE is $35.25 (($3600 − $75) / 100)),</simpara></listitem>
+ <listitem><simpara>GROSS_SALE is $3,600, NET_SALE is $3,525,</simpara></listitem>
+ <listitem><simpara>and finally NET_PROFIT is $1,525 (NET_SALE − NET_BUY).</simpara></listitem>
+ </itemizedlist>
+ </para>
+
+ <para>
+ <table>
+ <title>Selling Shares Split Scheme, Sale & Gain Combined, Net Pricing</title>
+<?dbfo table-width="70%" ?>
+ <tgroup cols="5">
+ <colspec colnum="1" colwidth="4*"/>
+
+ <colspec colnum="1" colwidth="2*"/>
+
+ <colspec colnum="1" colwidth="2*"/>
+
+ <colspec colnum="1" colwidth="1*"/>
+
+ <colspec colnum="1" colwidth="1*"/>
+
+ <tbody>
+ <row>
+ <entry>
+ <emphasis>Account</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Shares</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Price</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Buy</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Sell</emphasis>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ Assets:Bank ABC
+ </entry>
+
+ <entry></entry>
+
+ <entry></entry>
+
+ <entry>
+ 3525.00
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Assets:Brokerage Account:Stock:AMZN
+ </entry>
+
+ <entry>
+ 0
+ </entry>
+
+ <entry>
+ 0
+ </entry>
+
+ <entry>
+ 1525.00
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Assets:Brokerage Account:Stock:AMZN
+ </entry>
+
+ <entry>
+ −100
+ </entry>
+
+ <entry>
+ 35.25
+ </entry>
+
+ <entry></entry>
+
+ <entry>
+ 3525.00
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ Income:Capital Gain (Long Term):AMZN
+ </entry>
+
+ <entry></entry>
+
+ <entry></entry>
+
+ <entry></entry>
+
+ <entry>
+ 1525.00
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+
+ <para>
+ <figure pgwide="1">
+ <title>Selling Shares for Gain using Net Pricing in Transaction Journal View</title>
+ <screenshot id="invest-sellstockManProfCombNet">
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="figures/invest_sellstockManProfCombNet.png" format="PNG"
+ srccredit="Chris Good" width="510px"></imagedata>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="figures/invest_sellstockManProfCombNet.png" format="PNG"
+ srccredit="Chris Good"></imagedata>
+ </imageobject>
+
+ <textobject><phrase>Selling Shares Example</phrase></textobject>
+
+ </mediaobject>
+ </screenshot>
+ </figure>
+ </para>
+ </example>
+
+
</sect4>
</sect3>
<sect3 id="invest-sell-man-sep">
- <title>Separate the Capital Gain/Loss Transaction from the Sale Transaction.</title>
+ <title>Separate the Capital Gain/Loss Transaction from the Sale Transaction</title>
- <para>This is <emphasis>required</emphasis> if using <emphasis>scrubbing </emphasis> to automatically
- calculate and create capital gain/loss transactions (otherwise scrubbing will not detect
- them and will create an incorrectly valued gain/loss transaction).
+ <para>This is <emphasis>required</emphasis> if using <emphasis>scrubbing</emphasis> to
+ calculate and create capital gain/loss transactions automatically. Otherwise scrubbing will not detect
+ them and will create an incorrectly valued capital gain/loss transaction.
</para>
<sect4 id="invest-sell-man-sep-gr">
@@ -2167,581 +2537,64 @@ Income
</entry>
</row>
- <row>
- <entry>
- Assets:Stock:SYMBOL
- </entry>
-
- <entry>
- 0
- </entry>
-
- <entry>
- 0
- </entry>
-
- <entry>
- GROSS_PROFIT
- </entry>
-
- <entry>
- (Loss)
- </entry>
- </row>
-
- <row>
- <entry>
- Income:Capital Gain
- </entry>
-
- <entry></entry>
-
- <entry></entry>
-
- <entry>
- (Loss)
- </entry>
-
- <entry>
- GROSS_PROFIT
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </sect4>
-
- <sect4 id="invest-sell-man-sep-net">
- <title>Separated, Net Pricing</title>
-
- <table>
- <title>Selling Shares Split Scheme, Sale and Capital Gain/Loss Are Separate Transactions, Sale Transaction</title>
-
- <tgroup cols="5">
- <colspec colnum="1" colwidth="2*"/>
-
- <colspec colnum="1" colwidth="2*"/>
-
- <colspec colnum="1" colwidth="2*"/>
-
- <colspec colnum="1" colwidth="2*"/>
-
- <colspec colnum="1" colwidth="2*"/>
-
- <tbody>
- <row>
- <entry>
- <emphasis>Account</emphasis>
- </entry>
-
- <entry>
- <emphasis>Number of Shares</emphasis>
- </entry>
-
- <entry>
- <emphasis>Share Price</emphasis>
- </entry>
-
- <entry>
- <emphasis>Total Buy</emphasis>
- </entry>
-
- <entry>
- <emphasis>Total Sell</emphasis>
- </entry>
- </row>
-
- <row>
- <entry>
- Assets:Bank ABC
- </entry>
-
- <entry></entry>
-
- <entry></entry>
-
- <entry>
- NET_SALE
- </entry>
-
- <entry></entry>
- </row>
-
- <row>
- <entry>
- Assets:Stock:SYMBOL
- </entry>
-
- <entry>
- −NUM_SHARES
- </entry>
-
- <entry>
- NET_SELL_PRICE
- </entry>
-
- <entry></entry>
-
- <entry>
- NET_SALE
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <table>
- <title>Selling Shares Split Scheme, Sale and Capital Gain/Loss Are Separate Transactions, Capital Gain/Loss
- Transaction</title>
-
- <tgroup cols="5">
- <colspec colnum="1" colwidth="2*"/>
-
- <colspec colnum="1" colwidth="2*"/>
-
- <colspec colnum="1" colwidth="2*"/>
-
- <colspec colnum="1" colwidth="2*"/>
-
- <colspec colnum="1" colwidth="2*"/>
-
- <tbody>
- <row>
- <entry>
- <emphasis>Account</emphasis>
- </entry>
-
- <entry>
- <emphasis>Number of Shares</emphasis>
- </entry>
-
- <entry>
- <emphasis>Share Price</emphasis>
- </entry>
-
- <entry>
- <emphasis>Total Buy</emphasis>
- </entry>
-
- <entry>
- <emphasis>Total Sell</emphasis>
- </entry>
- </row>
-
- <row>
- <entry>
- Assets:Stock:SYMBOL
- </entry>
-
- <entry>
- 0
- </entry>
-
- <entry>
- 0
- </entry>
-
- <entry>
- NET_PROFIT
- </entry>
-
- <entry>
- (Loss)
- </entry>
- </row>
-
- <row>
- <entry>
- Income:Capital Gain
- </entry>
-
- <entry></entry>
-
- <entry></entry>
-
- <entry>
- (Loss)
- </entry>
-
- <entry>
- NET_PROFIT
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </sect4>
- </sect3>
- </sect2>
-
- <sect2 id="invest-sell-man-examples">
- <title>Examples of Selling Shares with Manually Entry of Capital Gain or Loss</title>
-
- <para>In these examples we will use the AMZN account created in the previous section.
- </para>
-
- <sect3 id="invest-sell-man-prof-comb-gross">
- <title>Example: Sale of Shares with Profit, Manual Profit/Loss Calculation, Sale & Profit Combined,
- Gross Pricing</title>
-
- <para>In this example you bought 100 shares of AMZN for $20 per share, then later sell them all for $36
- per share with a commission of $75. In the split transaction scheme above, GROSS_BUY_PRICE
- is $20 (the original buying price), NUM_SHARES is 100, GROSS_BUY is $2000 (the original
- buying cost), GROSS_SALE is $3600, and finally GROSS_PROFIT is $1600 (GROSS_SALE −
- GROSS_BUY).
- </para>
-
- <table>
- <title>Selling Shares Split Scheme, Sale & Gain Combined, Gross Pricing</title>
-<?dbfo table-width="70%" ?>
- <tgroup cols="5">
- <colspec colnum="1" colwidth="4*"/>
-
- <colspec colnum="1" colwidth="2*"/>
-
- <colspec colnum="1" colwidth="2*"/>
-
- <colspec colnum="1" colwidth="1*"/>
-
- <colspec colnum="1" colwidth="1*"/>
-
- <tbody>
- <row>
- <entry>
- <emphasis>Account</emphasis>
- </entry>
-
- <entry>
- <emphasis>Shares</emphasis>
- </entry>
-
- <entry>
- <emphasis>Price</emphasis>
- </entry>
-
- <entry>
- <emphasis>Buy</emphasis>
- </entry>
-
- <entry>
- <emphasis>Sell</emphasis>
- </entry>
- </row>
-
- <row>
- <entry>
- Assets:Bank ABC
- </entry>
-
- <entry></entry>
-
- <entry></entry>
-
- <entry>
- 3525.00
- </entry>
-
- <entry></entry>
- </row>
-
- <row>
- <entry>
- Assets:Brokerage Account:Stock:AMZN
- </entry>
-
- <entry>
- 0
- </entry>
-
- <entry>
- 0
- </entry>
-
- <entry>
- 1600.00
- </entry>
-
- <entry></entry>
- </row>
-
- <row>
- <entry>
- Expenses:Commission
- </entry>
-
- <entry></entry>
-
- <entry></entry>
-
- <entry>
- 75.00
- </entry>
-
- <entry></entry>
- </row>
-
- <row>
- <entry>
- Assets:Brokerage Account:Stock:AMZN
- </entry>
-
- <entry>
- −100
- </entry>
-
- <entry>
- 36.00
- </entry>
-
- <entry></entry>
-
- <entry>
- 3600.00
- </entry>
- </row>
-
- <row>
- <entry>
- Income:Capital Gain (Long Term):AMZN
- </entry>
-
- <entry></entry>
-
- <entry></entry>
-
- <entry></entry>
-
- <entry>
- 1600.00
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <screenshot id="invest-sellstockManProfComb">
- <mediaobject>
- <imageobject role="html">
- <imagedata fileref="figures/invest_sellstock.png" format="PNG"
- srccredit="Chris Good" width="510px"></imagedata>
- </imageobject>
-
- <imageobject role="fo">
- <imagedata fileref="figures/invest_sellstock.png" format="PNG"
- srccredit="Chris Good"></imagedata>
- </imageobject>
-
- <textobject>
- <phrase>Selling Shares Example</phrase>
- </textobject>
-
- <caption>
- <para>An example of selling shares for gain. You bought 100 shares of AMZN for $20 per share, and sold for
- $36.
- </para>
- </caption>
- </mediaobject>
- </screenshot>
-
- <note>
- <para>In the above screenshot, it appears there are 2 transactions for Mar 21st 2006. This is because the
- register is in <guilabel> Auto-Split Ledger</guilabel> view and there are 2 splits for
- the register account in the 1 transaction. <guilabel>Transaction Journal </guilabel>
- view may be clearer. Refer to <xref linkend="txns-registers-txntypes" />. As there are 2
- splits for the register account in the sale transaction, this transaction must be
- entered in <guilabel>Auto-Split Ledger</guilabel> or <guilabel> Transaction
- Journal</guilabel> view. It cannot be entered in <guilabel>Basic Ledger</guilabel> view.
- </para>
- </note>
-
- <para></para>
-
- <screenshot id="invest-sellstockManProfComb2">
- <mediaobject>
- <imageobject role="html">
- <imagedata fileref="figures/invest_sellstock2.png" format="PNG"
- srccredit="Chris Good" width="510px"></imagedata>
- </imageobject>
-
- <imageobject role="fo">
- <imagedata fileref="figures/invest_sellstock2.png" format="PNG"
- srccredit="Chris Good"></imagedata>
- </imageobject>
-
- <textobject>
- <phrase>Selling Shares Example</phrase>
- </textobject>
-
- <caption>
- <para>An image of the account tree after the example of selling shares for gain.
- </para>
- </caption>
- </mediaobject>
- </screenshot>
- </sect3>
-
- <sect3 id="invest-sell-man-prof-comb-net">
- <title>Example: Sale of Shares with Profit, Manual Profit/Loss Calculation, Sale & Profit Combined, Net
- Pricing</title>
-
- <para>In this example you bought 100 shares of AMZN for $20 per share (including commissions), then later
- sell them all for $36 per share with a commission of $75. In the split transaction scheme
- above, NUM_SHARES is 100, NET_BUY_PRICE is $20 (the original buying price), NET_BUY is
- $2000 (the original buying cost), NET_SELL_PRICE is $35.25 (($3600 − $75) / 100)),
- GROSS_SALE is $3600, NET_SALE is $3525, and finally NET_PROFIT is $1525 (NET_SALE −
- NET_BUY).
- </para>
-
- <table>
- <title>Selling Shares Split Scheme, Sale & Gain Combined, Net Pricing</title>
-<?dbfo table-width="70%" ?>
- <tgroup cols="5">
- <colspec colnum="1" colwidth="4*"/>
-
- <colspec colnum="1" colwidth="2*"/>
-
- <colspec colnum="1" colwidth="2*"/>
-
- <colspec colnum="1" colwidth="1*"/>
-
- <colspec colnum="1" colwidth="1*"/>
-
- <tbody>
- <row>
- <entry>
- <emphasis>Account</emphasis>
- </entry>
-
- <entry>
- <emphasis>Shares</emphasis>
- </entry>
-
- <entry>
- <emphasis>Price</emphasis>
- </entry>
-
- <entry>
- <emphasis>Buy</emphasis>
- </entry>
-
- <entry>
- <emphasis>Sell</emphasis>
- </entry>
- </row>
-
- <row>
- <entry>
- Assets:Bank ABC
- </entry>
-
- <entry></entry>
-
- <entry></entry>
-
- <entry>
- 3525.00
- </entry>
-
- <entry></entry>
- </row>
-
- <row>
- <entry>
- Assets:Brokerage Account:Stock:AMZN
- </entry>
-
- <entry>
- 0
- </entry>
-
- <entry>
- 0
- </entry>
-
- <entry>
- 1525.00
- </entry>
-
- <entry></entry>
- </row>
-
- <row>
- <entry>
- Assets:Brokerage Account:Stock:AMZN
- </entry>
-
- <entry>
- −100
- </entry>
-
- <entry>
- 35.25
- </entry>
-
- <entry></entry>
-
- <entry>
- 3525.00
- </entry>
- </row>
-
- <row>
- <entry>
- Income:Capital Gain (Long Term):AMZN
- </entry>
-
- <entry></entry>
+ <row>
+ <entry>
+ Assets:Stock:SYMBOL
+ </entry>
- <entry></entry>
+ <entry>
+ 0
+ </entry>
- <entry></entry>
+ <entry>
+ 0
+ </entry>
- <entry>
- 1525.00
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
+ <entry>
+ GROSS_PROFIT
+ </entry>
- <screenshot id="invest-sellstockManProfCombNet">
- <mediaobject>
- <imageobject role="html">
- <imagedata fileref="figures/invest_sellstockManProfCombNet.png" format="PNG"
- srccredit="Chris Good" width="510px"></imagedata>
- </imageobject>
+ <entry>
+ (Loss)
+ </entry>
+ </row>
- <imageobject role="fo">
- <imagedata fileref="figures/invest_sellstockManProfCombNet.png" format="PNG"
- srccredit="Chris Good"></imagedata>
- </imageobject>
+ <row>
+ <entry>
+ Income:Capital Gains
+ </entry>
- <textobject>
- <phrase>Selling Shares Example</phrase>
- </textobject>
+ <entry></entry>
- <caption>
- <para>An example of selling shares for gain using net pricing in transaction journal view. You bought 100
- shares of AMZN for $20 per share, and sold for $36.
- </para>
- </caption>
- </mediaobject>
- </screenshot>
+ <entry></entry>
- <para></para>
- </sect3>
+ <entry>
+ (Loss)
+ </entry>
- <sect3 id="invest-sell-man-prof-sep-gross">
- <title>Example: Sale of Shares with Profit, Manual Profit/Loss Calculation, Sale & Profit Separated,
- Gross Pricing</title>
+ <entry>
+ GROSS_PROFIT
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <example>
+ <title>Sale of Shares with Profit, Manual Profit/Loss Calculation, Sale & Profit Separated, Gross Pricing</title>
+ <simpara>In this example, we will use the AMZN account created in <xref linkend="invest-setup-example2" />.</simpara>
<para>You bought 100 shares of AMZN for $20 per share and commissions $20, then later sell them all for
- $36 per share with a commission of $75. In the split transaction scheme above,
- GROSS_BUY_PRICE is $20 (the original buying price), NUM_SHARES is 100, GROSS_BUY is $2000
- (the original buying cost), GROSS_SALE is $3600, and finally GROSS_PROFIT is $1600
- (GROSS_SALE − GROSS_BUY).
+ $36 per share with a commission of $75. The split transaction scheme is as follows:
+ <itemizedlist>
+ <listitem><simpara>GROSS_BUY_PRICE is $20 (the original buying price),</simpara></listitem>
+ <listitem><simpara>NUM_SHARES is 100,</simpara></listitem>
+ <listitem><simpara>GROSS_BUY is $2,000 (the original buying cost),</simpara></listitem>
+ <listitem><simpara>GROSS_SALE is $3,600,</simpara></listitem>
+ <listitem><simpara>finally GROSS_PROFIT is $1,600 (GROSS_SALE − GROSS_BUY).</simpara></listitem>
+ </itemizedlist>
</para>
+ <para>
<table>
<title>Selling Shares Split Scheme, Sale Transaction, Gross Pricing</title>
<?dbfo table-width="70%" ?>
@@ -2833,7 +2686,9 @@ Income
</tbody>
</tgroup>
</table>
-
+ </para>
+
+ <para>
<table>
<title>Selling Shares Split Scheme, Gain Transaction, Gross Pricing</title>
<?dbfo table-width="70%" ?>
@@ -2909,7 +2764,11 @@ Income
</tbody>
</tgroup>
</table>
-
+ </para>
+ <para>
+ <figure pgwide="1">
+ <title>Selling Shares for Gain Where the Sale and Gain are Recorded in Separate Transactions,
+ in <guilabel>Transaction Journal</guilabel> View</title>
<screenshot id="invest-sellstockManProfSep">
<mediaobject>
<imageobject role="html">
@@ -2922,31 +2781,195 @@ Income
srccredit="Chris Good"></imagedata>
</imageobject>
- <textobject>
- <phrase>Selling Shares Example</phrase>
- </textobject>
+ <textobject><phrase>Selling Shares Example</phrase></textobject>
- <caption>
- <para>An example of selling shares for gain where the sale and gain are recorded in separate transactions,
- in <guilabel> Transaction Journal</guilabel> view. You bought 100 shares of AMZN for
- $20 per share, and sold for $36.
- </para>
- </caption>
</mediaobject>
</screenshot>
- </sect3>
+ </figure>
+ </para>
+ </example>
+
+
+
+ </sect4>
+
+ <sect4 id="invest-sell-man-sep-net">
+ <title>Separated, Net Pricing</title>
+
+ <table>
+ <title>Selling Shares Split Scheme, Sale and Capital Gain/Loss Are Separate Transactions, Sale Transaction</title>
+
+ <tgroup cols="5">
+ <colspec colnum="1" colwidth="2*"/>
+
+ <colspec colnum="1" colwidth="2*"/>
+
+ <colspec colnum="1" colwidth="2*"/>
+
+ <colspec colnum="1" colwidth="2*"/>
+
+ <colspec colnum="1" colwidth="2*"/>
+
+ <tbody>
+ <row>
+ <entry>
+ <emphasis>Account</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Number of Shares</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Share Price</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Total Buy</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Total Sell</emphasis>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ Assets:Bank ABC
+ </entry>
+
+ <entry></entry>
+
+ <entry></entry>
+
+ <entry>
+ NET_SALE
+ </entry>
+
+ <entry></entry>
+ </row>
+
+ <row>
+ <entry>
+ Assets:Stock:SYMBOL
+ </entry>
+
+ <entry>
+ −NUM_SHARES
+ </entry>
+
+ <entry>
+ NET_SELL_PRICE
+ </entry>
+
+ <entry></entry>
+
+ <entry>
+ NET_SALE
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <table>
+ <title>Selling Shares Split Scheme, Sale and Capital Gain/Loss Are Separate Transactions, Capital Gain/Loss
+ Transaction</title>
+
+ <tgroup cols="5">
+ <colspec colnum="1" colwidth="2*"/>
+
+ <colspec colnum="1" colwidth="2*"/>
+
+ <colspec colnum="1" colwidth="2*"/>
+
+ <colspec colnum="1" colwidth="2*"/>
+
+ <colspec colnum="1" colwidth="2*"/>
+
+ <tbody>
+ <row>
+ <entry>
+ <emphasis>Account</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Number of Shares</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Share Price</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Total Buy</emphasis>
+ </entry>
+
+ <entry>
+ <emphasis>Total Sell</emphasis>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ Assets:Stock:SYMBOL
+ </entry>
+
+ <entry>
+ 0
+ </entry>
+
+ <entry>
+ 0
+ </entry>
+
+ <entry>
+ NET_PROFIT
+ </entry>
+
+ <entry>
+ (Loss)
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ Income:Capital Gains
+ </entry>
+
+ <entry></entry>
- <sect3 id="invest-sell-man-prof-sep-net">
- <title>Example: Sale of Shares with Profit, Manual Profit/Loss Calculation, Sale & Profit Separated,
- Net Pricing</title>
+ <entry></entry>
+
+ <entry>
+ (Loss)
+ </entry>
+
+ <entry>
+ NET_PROFIT
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ <example id="invest-sell-man-prof-sep-net">
+ <title>Sale of Shares with Profit, Manual Profit/Loss Calculation, Sale & Profit Separated, Net Pricing</title>
+ <simpara>In this example, we will use the AMZN account created in <xref linkend="invest-setup-example2" />.</simpara>
<para>You bought 100 shares of AMZN for $20 per share (including commissions), then later sell them all
- for $36 per share with a commission of $75. In the split transaction scheme above,
- NUM_SHARES is 100, NET_BUY_PRICE is $20 (the original buying price), NET_BUY is $2000 (the
- original buying cost), NET_SELL_PRICE is $35.25 (($3600 − $75) / 100)), GROSS_SALE
- is $3600, NET_SALE is $3525, and finally NET_PROFIT is $1525 (NET_SALE − NET_BUY).
+ for $36 per share with a commission of $75. In the split transaction scheme is as follows:
+ <itemizedlist>
+ <listitem><simpara>NUM_SHARES is 100,</simpara></listitem>
+ <listitem><simpara>NET_BUY_PRICE is $20 (the original buying price),</simpara></listitem>
+ <listitem><simpara>NET_BUY is $2,000 (the original buying cost),</simpara></listitem>
+ <listitem><simpara>NET_SELL_PRICE is $35.25 (($3600 − $75) / 100)),</simpara></listitem>
+ <listitem><simpara>GROSS_SALE is $3,600, NET_SALE is $3,525,</simpara></listitem>
+ <listitem><simpara>and finally NET_PROFIT is $1,525 (NET_SALE − NET_BUY).</simpara></listitem>
+ </itemizedlist>
</para>
+ <para>
<table>
<title>Selling Shares Split Scheme, Sale Transaction, Net Pricing</title>
<?dbfo table-width="70%" ?>
@@ -3022,7 +3045,9 @@ Income
</tbody>
</tgroup>
</table>
-
+ </para>
+
+ <para>
<table>
<title>Selling Shares Split Scheme, Gain Transaction, Net Pricing</title>
<?dbfo table-width="70%" ?>
@@ -3094,35 +3119,39 @@ Income
<entry>
1525.00
</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
-
- <screenshot id="invest-sellstockManProfSepNet">
- <mediaobject>
- <imageobject role="html">
- <imagedata fileref="figures/invest_sellstockManProfSepNet.png" format="PNG"
- srccredit="Chris Good" width="510px"></imagedata>
- </imageobject>
-
- <imageobject role="fo">
- <imagedata fileref="figures/invest_sellstockManProfSep.png" format="PNG"
- srccredit="Chris Good"></imagedata>
- </imageobject>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </para>
+
+ <para>
+ <figure pgwide="1">
+ <title>Selling Shares for Gain Where the Sale and Gain are Recorded in Separate Transactions,
+ in <guilabel>Transaction Journal</guilabel> View</title>
+ <screenshot id="invest-sellstockManProfSepNet">
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="figures/invest_sellstockManProfSepNet.png" format="PNG"
+ srccredit="Chris Good" width="510px"></imagedata>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="figures/invest_sellstockManProfSep.png" format="PNG"
+ srccredit="Chris Good"></imagedata>
+ </imageobject>
+
+ <textobject><phrase>Selling Shares Example</phrase>
+
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </figure>
+ </para>
+ </example>
- <textobject>
- <phrase>Selling Shares Example</phrase>
- </textobject>
- <caption>
- <para>An example of selling shares for gain where the sale and gain are recorded in separate transactions,
- in <guilabel>Transaction Journal</guilabel> view. You bought 100 shares of AMZN for
- $20 per share, and sold for $36.
- </para>
- </caption>
- </mediaobject>
- </screenshot>
+ </sect4>
</sect3>
</sect2>
@@ -3132,12 +3161,12 @@ Income
<sect3 id="invest-sellLotsIntro">
<title>Introduction</title>
- <para><ulink url="&url-wp-en;Lot">Wikipedia</ulink> includes the following definition of a lot
+ <para><ulink url="&url-wp-en;Lot">Wikipedia</ulink> includes the following definition of a lot.
</para>
- <para><quote>a set of goods for sale together in an auction; or a quantity of a financial
- instrument</quote>.
- </para>
+ <blockquote>
+ <simpara>a set of goods for sale together in an auction; or a quantity of a financial instrument</simpara>
+ </blockquote>
<para>&app; has a built-in lot management facility that can be used to keep track of capital gains or
losses resulting from security sales. Buy and sell transactions are put into lots for the
@@ -3151,12 +3180,11 @@ Income
<para>The term <emphasis>scrub</emphasis> is used because security accounts need to be cleaned after sales
to ensure the difference between the cost paid for securities, and value received from
selling them, is accounted for as capital gain or loss. If the capital gain/loss is not
- correct, the Trial Balance (
- <menuchoice>
+ correct, the <guimenuitem>Trial Balance</guimenuitem>
+ (<menuchoice>
<guimenu>Reports</guimenu> <guisubmenu>Income & Expense</guisubmenu>
<guimenuitem>Trial Balance</guimenuitem>
- </menuchoice>
- ) bottom line total debits will not balance to total credits.
+ </menuchoice>) bottom line total debits will not balance to total credits.
</para>
<note>
@@ -3168,11 +3196,11 @@ Income
</para>
</note>
- <para>If you are not familiar with FIFO, LIFO or Average costing, please see Wikipedia
+ <para>If you are not familiar with <acronym>FIFO</acronym>, <acronym>LIFO</acronym> or Average costing, please see Wikipedia
<ulink
- url="&url-wp-en;FIFO_and_LIFO_accounting"> FIFO and LIFO
+ url="&url-wp-en;FIFO_and_LIFO_accounting">FIFO and LIFO
accounting</ulink> and <ulink
- url="&url-wp-en;Average_cost_method"> Average
+ url="&url-wp-en;Average_cost_method">Average
cost method</ulink>.
</para>
@@ -3182,10 +3210,10 @@ Income
<para>The &app; lot management facility can be a useful feature, reducing manual calculation, especially
if dividends have been reinvested over years and there are many different costs involved.
- It can automatically link buy transactions to sell transactions using FIFO cost method and
- one can manually link specific buy transactions to sell transactions in order to use LIFO.
+ It can automatically link buy transactions to sell transactions using <acronym>FIFO</acronym> cost method and
+ one can manually link specific buy transactions to sell transactions in order to use <acronym>LIFO</acronym>.
Advanced Portfolio Report basis costs and gains/losses will agree with the costs and
- gain/loss transactions created by scrubbing if either the FIFO or LIFO cost methods are
+ gain/loss transactions created by scrubbing if either the <acronym>FIFO</acronym> or <acronym>LIFO</acronym> cost methods are
used.
</para>
</sect3>
@@ -3203,8 +3231,7 @@ Income
select
<menuchoice>
<guimenu>Actions</guimenu> <guimenuitem>View Lots</guimenuitem>
- </menuchoice>
- .
+ </menuchoice>.
</para>
<figure pgwide="1">
@@ -3225,7 +3252,7 @@ Income
</textobject>
<caption>
- <para>An image of the <emphasis>Lots in Account </emphasis> window.
+ <para>An image of the <emphasis>Lots in Account</emphasis> window.
</para>
</caption>
</mediaobject>
@@ -3244,39 +3271,35 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
<para>Using the lot management facility for the automatic calculation of capital gain or loss typically
follows these steps:
- </para>
<orderedlist>
<listitem>
- <para>Record the sale transaction using Net Pricing (but stop short of entering the Capital Gain
+ <simpara>Record the sale transaction using Net Pricing (but stop short of entering the Capital Gain
transaction as it will be created by scrubbing). See
<xref linkend="invest-sell-man-prof-sep-net" />.
- </para>
+ </simpara>
</listitem>
<!-- Manual Lot Creation and Linking -->
<listitem>
- <para><xref linkend="invest-sellManual" /> (Optional depending on cost method)
- </para>
+ <simpara><xref linkend="invest-sellManual" /> (Optional depending on cost method)</simpara>
</listitem>
<listitem>
<!-- Automatic Creation of Capital Gain Or Loss Transactions -->
- <para><xref linkend="invest-sellAuto" />
- </para>
+ <simpara><xref linkend="invest-sellAuto" /></simpara>
</listitem>
<listitem>
<!-- Change Orphaned Gains-CCC to Gain/Loss Account -->
- <para><xref linkend="invest-sellChgCapGainsAcct" />
- </para>
+ <simpara><xref linkend="invest-sellChgCapGainsAcct" /></simpara>
</listitem>
<listitem>
<!-- Run a Trial Balance -->
- <para><xref linkend="invest-sellTrialBal" /> report to ensure total debits balance to total credits
- </para>
+ <simpara><xref linkend="invest-sellTrialBal" /> report to ensure total debits balance to total credits.</simpara>
</listitem>
</orderedlist>
+ </para>
</sect3>
<sect3 id="invest-sellManual">
@@ -3285,17 +3308,16 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
<para>Before using this feature, ensure you have read <xref linkend="invest-sellConsiderations" />.
</para>
- <para>This functionality allows the manual linking of specfic buy and sell transactions. It may be used in
+ <para>This functionality allows the manual linking of specific buy and sell transactions. It may be used in
the case where a user wishes to use a different cost method than the automatic linking
- method (FIFO). Effectively, if one wishes the cost basis and capital gains in the Advanced
+ method (<acronym>FIFO</acronym>). Effectively, if one wishes the cost basis and capital gains in the Advanced
Portfolio Report to be consistent with the capital gains transactions created by
- scrubbing, manual lot creation only needs to be used when using LIFO or <quote>sale of
+ scrubbing, manual lot creation only needs to be used when using <acronym>LIFO</acronym> or <quote>sale of
designated lots</quote> (the same thing for securities as far as US personal tax law is
- concerned). This is because the scrub function can automatically do FIFO linking so there
+ concerned). This is because the scrub function can automatically do <acronym>FIFO</acronym> linking so there
is no need to do it manually and scrubbing cannot be used for average costing.
- </para>
- <para>See <xref linkend="invest-sellManualExample" />.
+ See <xref linkend="invest-sellManualExample" />.
</para>
</sect3>
@@ -3303,8 +3325,8 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
<title>Automatic Creation of Capital Gain Or Loss Transactions</title>
<note>
- <para>Do <emphasis>NOT</emphasis> do this unless you are using FIFO or LIFO to cost sales. See
- <xref linkend="invest-sellConsiderations" />
+ <para>Do <emphasis>not</emphasis> do this unless you are using <acronym>FIFO</acronym> or <acronym>LIFO</acronym> to cost sales. See
+ <xref linkend="invest-sellConsiderations" />.
</para>
</note>
@@ -3312,20 +3334,17 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
used to link buy transaction splits with sell transaction splits so the correct cost of
the securities sold can be determined. &app; will use any existing lots, and create new
lots for any buy transaction splits not already linked to a lot. Buy and sell transaction
- splits are linked to lots using FIFO method.
+ splits are linked to lots using <acronym>FIFO</acronym> method.
</para>
<para>See:
+ <itemizedlist>
+ <listitem><simpara><xref linkend="invest-sellAutoExample" />,</simpara></listitem>
+ <listitem><simpara><xref linkend="invest-sellAutoExample2" />,</simpara></listitem>
+ <listitem><simpara><xref linkend="invest-sellFifoSplit" />.</simpara></listitem>
+ </itemizedlist>
</para>
- <para><xref linkend="invest-sellAutoExample" />
- </para>
-
- <para><xref linkend="invest-sellAutoExample2" />
- </para>
-
- <para><xref linkend="invest-sellFifoSplit" />
- </para>
</sect3>
<sect3 id="invest-sellChgCapGainsAcct">
@@ -3336,7 +3355,7 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
because &app; doesn't know which capital gain or loss account should be used. After
scrubbing, the user should 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 Gain:IBM</emphasis>).
+ loss account (for example, <emphasis>Income:Capital Gain (Long Term):IBM</emphasis>).
</para>
<para>See <xref linkend="invest-sellChgCapGainsAcctExample" />.
@@ -3360,22 +3379,26 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
<tip>
<para>A Trial Balance may not balance due to some other problem. To determine if the cause of an imbalance
is from incorrectly accounting for capital gain/loss:
- </para>
-
- <para>If necessary, temporarily change the date of the sell transaction and the capital gain/loss
- transaction, so they are the only transactions for a particular date, then run the Trial
- Balance as at the day before. If the Trial Balance is still out by the same amount, it
- is not the capital gain/loss that is causing the problem.
- </para>
-
- <para>If you find a prior <emphasis>out of balance </emphasis> Trial Balance, keep running the Trial
- Balance report with different dates until you find the date it starts being out of
- balance. Temporarily change the transaction dates for each transaction on the problem
- date to the following day, then change the dates back to the correct date 1 at a time,
- running the Trial Balance each time, until you identify the problem transaction. When
- you change the date of a security sell transaction, you also need to change the date of
- the corresponding capital gain transaction as it is only the sum of these that will
- balance in the Trial Balance.
+ <orderedlist>
+ <listitem>
+ <para>If necessary, temporarily change the date of the sell transaction and the capital gain/loss
+ transaction, so they are the only transactions for a particular date, then run the Trial
+ Balance as at the day before. If the Trial Balance is still out by the same amount, it
+ is not the capital gain/loss that is causing the problem.
+ </para>
+ </listitem>
+ <listitem>
+ <para>If you find a prior <emphasis>out of balance</emphasis> Trial Balance, keep running the Trial
+ Balance report with different dates until you find the date it starts being out of
+ balance. Temporarily change the transaction dates for each transaction on the problem
+ date to the following day, then change the dates back to the correct date 1 at a time,
+ running the Trial Balance each time, until you identify the problem transaction. When
+ you change the date of a security sell transaction, you also need to change the date of
+ the corresponding capital gain transaction as it is only the sum of these that will
+ balance in the Trial Balance.
+ </para>
+ </listitem>
+ </orderedlist>
</para>
</tip>
</sect3>
@@ -3388,9 +3411,9 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
<orderedlist>
<listitem>
- <para>&app; implements only the First In/ First Out (FIFO) cost method when automatically linking buy
- transactions to sell transactions. I.e. The oldest securities are always sold first.
- The Last In First Out (LIFO) cost method may be used by manually linking the most
+ <para>&app; implements only the First In/ First Out (<acronym>FIFO</acronym>) cost method when automatically linking buy
+ transactions to sell transactions. That is the oldest securities are always sold first.
+ The Last In First Out (<acronym>LIFO</acronym>) cost method may be used by manually linking the most
recent buy security splits to the sell split before scrubbing.
</para>
</listitem>
@@ -3398,8 +3421,8 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
<listitem>
<para>The Advanced Portfolio Report does not use lot information when calculating costs, just the security
transaction splits. It calculates the cost basis and gains or losses using the
- selected <emphasis>Basis calculation method</emphasis> report option (Average, FIFO or
- LIFO). If one wishes the Advanced Portfolio Report costs and gains/losses to be
+ selected <emphasis>Basis calculation method</emphasis> report option (Average, <acronym>FIFO</acronym> or
+ <acronym>LIFO</acronym>). If one wishes the Advanced Portfolio Report costs and gains/losses to be
consistent with the capital gain/loss transactions created by scrubbing, the same cost
model must be used in both places.
</para>
@@ -3561,19 +3584,20 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
</orderedlist>
</sect3>
- <sect3 id="invest-sellManualExample">
- <title>Example 1: Manual Lot Creation and Linking</title>
+ <sect3>
+ <title>Examples</title>
+ <example id="invest-sellManualExample">
+ <title>Manual Lot Creation and Linking</title>
- <para>Here is an example of selling part of a security holding using the LIFO method. In this example, the
- most recent buy transaction (dated 01/07/2016, a reinvested dividend), is linked to a lot,
+ <para>Here is an example of selling part of a security holding using the <acronym>LIFO</acronym> method. In this example, the
+ most recent buy transaction (dated Jul. 1, 2016, a reinvested dividend), is linked to a lot,
along with the sell transaction, and the &app; scrub function is used to calculate capital
gain or loss and create the capital gain/loss transaction.
</para>
- <orderedlist>
- <listitem>
- <para>Open the security account's register.
- </para>
+ <procedure>
+ <step>
+ <simpara>Open the security account's register.</simpara>
<figure pgwide="1">
<title>Selling Shares - Capital Gains - Security register before scrubbing a single lot</title><screenshot id="invest-lots0reg">
@@ -3589,33 +3613,30 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
</imageobject>
<textobject>
- <phrase>Example of security register before lot scrubbing </phrase>
+ <phrase>Example of security register before lot scrubbing</phrase>
</textobject>
<caption>
- <para>An image of the Security Account register in transaction journal view, before lot scrubbing.
- </para>
+ <simpara>An image of the Security Account register in transaction journal view, before lot scrubbing.</simpara>
</caption>
</mediaobject>
</screenshot>
</figure>
- </listitem>
-
- <listitem>
- <para>Ensure all previous capital gain/loss transactions are separate transactions to the sell
+ </step>
+
+ <step>
+ <simpara>Ensure all previous capital gain/loss transactions are separate transactions to the sell
transactions which record the reduction in the number of shares and the value
- received.
- </para>
- </listitem>
-
- <listitem>
- <para>Select
+ received.</simpara>
+ </step>
+
+ <step><simpara>Select
<menuchoice>
<guimenu>Actions</guimenu> <guimenuitem>View Lots</guimenuitem>
</menuchoice>
to open the <guilabel>Lots in Account SSSS</guilabel> window where SSSS is the
security account.
- </para>
+ </simpara>
<figure pgwide="1">
<title>Selling Shares - Capital Gains - Lots before scrubbing a single lot</title><screenshot id="invest-lots1B4CreateLot">
@@ -3631,66 +3652,58 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
</imageobject>
<textobject>
- <phrase>Example of Lots in Account window before lot scrubbing </phrase>
+ <phrase>Example of Lots in Account window before lot scrubbing</phrase>
</textobject>
<caption>
- <para>An image of the <emphasis>Lots in Account </emphasis> window before lot scrubbing.
+ <para>An image of the <emphasis>Lots in Account</emphasis> window before lot scrubbing.
</para>
</caption>
</mediaobject>
</screenshot>
</figure>
- </listitem>
+ </step>
- <listitem>
- <para>Create a new lot using the <guimenu>New Lot</guimenu> button. Initially this lot is not linked to
- any buy or sell split.
- </para>
- </listitem>
+ <step><simpara>Create a new lot using the <guibutton>New Lot</guibutton> button. Initially this lot is not linked to
+ any buy or sell split.</simpara>
+ </step>
- <listitem>
- <para>Highlight the new lot in the <guilabel>Lots in This Account</guilabel> panel.
- </para>
- </listitem>
+ <step>
+ <simpara>Highlight the new lot in the <guilabel>Lots in This Account</guilabel> panel.</simpara>
+ </step>
- <listitem>
- <para>Highlight the buy split (dated 01/07/2016) of the security to be sold in the <guilabel>Splits
- free</guilabel> panel.
- </para>
- </listitem>
+ <step><simpara>Highlight the buy split (dated Jul. 1, 2016) of the security to be sold in the <guilabel>Splits
+ free</guilabel> panel.</simpara>
+ </step>
- <listitem>
- <para>Click the <guilabel>>></guilabel> button to link the buy split with the highlighted lot. The
- split moves from the <guilabel> Splits free</guilabel> panel to the <guilabel>Splits
- in Lot </guilabel> panel.
- </para>
- </listitem>
+ <step><simpara>Click the <guilabel>>></guilabel> button to link the buy split with the highlighted lot. The
+ split moves from the <guilabel>Splits free</guilabel> panel to the <guilabel>Splits
+ in Lot</guilabel> panel.
+ </simpara>
+ </step>
- <listitem>
- <para>Repeat the previous 2 steps for any other buy splits that should be included in the lot (in this
+ <step><simpara>Repeat the previous 2 steps for any other buy splits that should be included in the lot (in this
example, there is only 1 buy split in the sale).
- </para>
- </listitem>
+ </simpara>
+ </step>
- <listitem>
- <para>Highlight the sell split in the <guilabel>Splits free </guilabel> panel.
- </para>
- </listitem>
+ <step>
+ <simpara>Highlight the sell split in the <guilabel>Splits free</guilabel> panel.</simpara>
+ </step>
- <listitem>
- <para>Click the <guilabel>>></guilabel> button to link the sell split with the highlighted lot.
- </para>
- </listitem>
+ <step>
+ <simpara>Click the <guilabel>>></guilabel> button to link the sell split with the highlighted lot.</simpara>
+ </step>
- <listitem>
- <para>Check the lot <guilabel>Balance</guilabel> is as expected. I.e. in this example the lot balance
+ <step>
+ <simpara>Check the lot <guilabel>Balance</guilabel> is as expected. In this example the lot balance
should be zero as the number of securities sold in the lot, is matched with the same
number of security buys.
- </para>
+ </simpara>
<figure pgwide="1">
- <title>Selling Shares - Capital Gains - Lots before scrubbing a single lot, after manual linking</title><screenshot id="invest-lots2B4Scrub1Lot">
+ <title>Selling Shares - Capital Gains - Lots before scrubbing a single lot, after manual linking</title>
+ <screenshot id="invest-lots2B4Scrub1Lot">
<mediaobject>
<imageobject role="html">
<imagedata fileref="figures/investLots2_BeforeScrub1Lot.png"
@@ -3703,36 +3716,33 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
</imageobject>
<textobject>
- <phrase>Example of Lots in Account window before scrubbing a single lot
- </phrase>
+ <phrase>Example of Lots in Account window before scrubbing a single lot</phrase>
</textobject>
<caption>
- <para>An image of the <emphasis>Lots in Account </emphasis> window before scrubbing a single lot.
- </para>
+ <simpara>An image of the <emphasis>Lots in Account</emphasis> window before scrubbing a single lot.</simpara>
</caption>
</mediaobject>
</screenshot>
</figure>
- </listitem>
-
- <listitem>
- <para>Click the <guilabel>Scrub</guilabel> button (<emphasis>NOT </emphasis> the <guilabel>Scrub
- Account</guilabel> button).
- </para>
+ </step>
+ <step>
+ <simpara>Click the <guibutton>Scrub</guibutton> button (<emphasis>not</emphasis> the <guibutton>Scrub Account</guibutton> button.)
+ </simpara>
<para>The <guilabel>Lots in Account</guilabel> window has not changed after using the
<guilabel>Scrub</guilabel> button so no example screen image is supplied.
</para>
- </listitem>
+ </step>
- <listitem>
- <para>Close the <guilabel>Lots in Account SSSS</guilabel> window and return to the security account
+ <step>
+ <simpara>Close the <guilabel>Lots in Account SSSS</guilabel> window and return to the security account
register.
- </para>
+ </simpara>
<figure pgwide="1">
- <title>Selling Shares - Capital Gains - Register after manual linking and scrubbing a single lot</title><screenshot id="invest-lots2RegAftScrub1Lot">
+ <title>Selling Shares - Capital Gains - Register after manual linking and scrubbing a single lot</title>
+ <screenshot id="invest-lots2RegAftScrub1Lot">
<mediaobject>
<imageobject role="html">
<imagedata fileref="figures/investLots2_RegAfterScrub1Lot.png"
@@ -3745,68 +3755,62 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
</imageobject>
<textobject>
- <phrase>Example of Register after scrubbing a single lot </phrase>
+ <phrase>Example of Register after scrubbing a single lot</phrase>
</textobject>
<caption>
- <para>An image of the Register after scrubbing a single lot.
- </para>
+ <simpara>An image of the Register after scrubbing a single lot.</simpara>
</caption>
</mediaobject>
</screenshot>
</figure>
- </listitem>
+ </step>
- <listitem>
- <para>Continue to <xref linkend="invest-sellChgCapGainsAcct" />
- </para>
- </listitem>
- </orderedlist>
- </sect3>
+ <step>
+ <simpara>Continue to <xref linkend="invest-sellChgCapGainsAcct" />.</simpara>
+ </step>
+
+ </procedure>
+ </example>
- <sect3 id="invest-sellAutoExample">
- <title>Example 2: Automatic Creation of Capital Gain Or Loss Transactions</title>
+
+ <example id="invest-sellAutoExample">
+ <title>Automatic Creation of Capital Gain Or Loss Transactions</title>
- <para>Create the capital gains transaction by following these steps:
- </para>
+ <simpara>Create the capital gains transaction by following these steps:</simpara>
- <orderedlist>
- <listitem>
- <para>Open the security account's register.
- </para>
- </listitem>
+ <procedure>
+ <step>
+ <simpara>Open the security account's register.</simpara>
+ </step>
- <listitem>
- <para>Ensure any previous manually entered capital gain/loss transaction splits have been entered in
- separate transactions to the the sell transactions.
- </para>
- </listitem>
+ <step>
+ <simpara>Ensure any previous manually entered capital gain/loss transaction splits have been entered in
+ separate transactions to the the sell transactions.</simpara>
+ </step>
- <listitem>
- <para>Select
+ <step>
+ <simpara>Select
<menuchoice>
- <guimenu>Actions</guimenu> <guimenuitem>View Lots</guimenuitem>
+ <guimenu>Actions</guimenu><guimenuitem>View Lots</guimenuitem>
</menuchoice>
to open the <guilabel>Lots in Account SSSS</guilabel> window where SSSS is the
- security account.
- </para>
- </listitem>
+ security account.</simpara>
+ </step>
- <listitem>
- <para>If using LIFO, use the above procedure <xref linkend="invest-sellManual" /> to create a lot for each
+ <step>
+ <simpara>If using <acronym>LIFO</acronym>, use the above procedure <xref linkend="invest-sellManual" /> to create a lot for each
sell transaction, link the lot with the sell transaction and each of the buy
- transactions that make up the sale.
- </para>
- </listitem>
+ transactions that make up the sale.</simpara>
+ </step>
- <listitem>
- <para>Click the <guilabel>Scrub Account</guilabel> button which:
- </para>
+ <step>
+ <simpara>Click the <guilabel>Scrub Account</guilabel> button which:</simpara>
<itemizedlist>
<listitem>
<para>Creates lots for any buy transactions that are not already linked to a lot and links them to sell
- transactions splits using the FIFO method. As a transaction split can only be
+ transactions splits using the <acronym>FIFO</acronym> method. As a transaction split can only be
linked to 1 lot, if a sell transaction needs to be linked to multiple lots, the
sell transaction split is itself split into multiple subsplits. In the case of
multiple subsplits, it is possible to have different splits from the same
@@ -3816,65 +3820,61 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
</listitem>
<listitem>
- <para>Creates a separate transaction per lot for capital gain/loss.
- </para>
+ <simpara>Creates a separate transaction per lot for capital gain/loss.</simpara>
</listitem>
</itemizedlist>
- </listitem>
+ </step>
- <listitem>
- <para>Continue to <xref linkend="invest-sellChgCapGainsAcct" />
- </para>
- </listitem>
- </orderedlist>
- </sect3>
+ <step>
+ <simpara>Continue to <xref linkend="invest-sellChgCapGainsAcct" />.</simpara>
+ </step>
+ </procedure>
+ </example>
- <sect3 id="invest-sellAutoExample2">
- <title>Example 3: Automatic Creation of Capital Gain Or Loss Transactions, 2 Sales at Once</title>
- <para>Here is an example of FIFO scrubbing without manual lot creation. In this example, the transactions
+ <example id="invest-sellAutoExample2">
+ <title>Automatic Creation of Capital Gain Or Loss Transactions, 2 Sales at Once</title>
+
+ <para>Here is an example of <acronym>FIFO</acronym> scrubbing without manual lot creation. In this example, the transactions
for 2 sales are scrubbed at once but usually scrubbing would be performed after each sale.
One reason for scrubbing 2 sales at once, could be because there were multiple sales on
the same day.
+ <figure pgwide="1">
+ <title>Selling Shares - Capital Gains - Register before Scrub Account</title>
+ <screenshot id="invest2-lots0reg">
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="figures/invest2Lots0RegB4Scrub.png"
+ format="PNG" srccredit="Chris Good" width="510px"></imagedata>
+ </imageobject>
+
+ <imageobject role="fo">
+ <imagedata fileref="figures/invest2Lots0RegB4Scrub.png"
+ format="PNG" srccredit="Chris Good"></imagedata>
+ </imageobject>
+
+ <textobject>
+ <phrase>Example of security register before Scrub Account is used. </phrase>
+ </textobject>
+
+ <caption>
+ <simpara>An image of the Security Account register in transaction journal view, before Scrub Account is used.</simpara>
+ </caption>
+ </mediaobject>
+ </screenshot>
+ </figure>
</para>
- <figure pgwide="1">
- <title>Selling Shares - Capital Gains - Register before Scrub Account</title><screenshot id="invest2-lots0reg">
- <mediaobject>
- <imageobject role="html">
- <imagedata fileref="figures/invest2Lots0RegB4Scrub.png"
- format="PNG" srccredit="Chris Good" width="510px"></imagedata>
- </imageobject>
-
- <imageobject role="fo">
- <imagedata fileref="figures/invest2Lots0RegB4Scrub.png"
- format="PNG" srccredit="Chris Good"></imagedata>
- </imageobject>
-
- <textobject>
- <phrase>Example of security register before Scrub Account is used. </phrase>
- </textobject>
-
- <caption>
- <para>An image of the Security Account register in transaction journal view, before Scrub Account is used.
- </para>
- </caption>
- </mediaobject>
- </screenshot>
- </figure>
-
- <orderedlist>
- <listitem>
- <para>Select
+ <procedure>
+ <step><simpara>Select
<menuchoice>
<guimenu>Actions</guimenu> <guimenuitem>View Lots</guimenuitem>
</menuchoice>
to open the <guilabel>Lots in Account SSSS</guilabel> window where SSSS is the
- security account.
- </para>
-
+ security account.</simpara>
<figure pgwide="1">
- <title>Selling Shares - Capital Gains - Lots before Scrub Account</title><screenshot id="invest2-lots1B4ScrubAcct">
+ <title>Selling Shares - Capital Gains - Lots before Scrub Account</title>
+ <screenshot id="invest2-lots1B4ScrubAcct">
<mediaobject>
<imageobject role="html">
<imagedata fileref="figures/invest2Lots1B4Scrub.png"
@@ -3892,20 +3892,18 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
</textobject>
<caption>
- <para>An image of the <emphasis>Lots in Account </emphasis> window before Scrub Account is used.
- </para>
+ <simpara>An image of the <emphasis>Lots in Account</emphasis> window before Scrub Account is used.</simpara>
</caption>
</mediaobject>
</screenshot>
</figure>
- </listitem>
-
- <listitem>
- <para>Click the <guilabel>Scrub Account</guilabel> button.
- </para>
+ </step>
+ <step>
+ <simpara>Click the <guilabel>Scrub Account</guilabel> button.</simpara>
<figure pgwide="1">
- <title>Selling Shares - Capital Gains - Lots after Scrub Account</title><screenshot id="invest2-lots2AftScrubAcct">
+ <title>Selling Shares - Capital Gains - Lots after Scrub Account</title>
+ <screenshot id="invest2-lots2AftScrubAcct">
<mediaobject>
<imageobject role="html">
<imagedata fileref="figures/invest2Lots2LotsAftScrubAcct.png"
@@ -3918,7 +3916,7 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
</imageobject>
<textobject>
- <phrase>Example of Lots in Account window after using Scrub Account </phrase>
+ <phrase>Example of Lots in Account window after using Scrub Account</phrase>
</textobject>
<caption>
@@ -3935,15 +3933,13 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
reopened so all the lots show.
</para>
</note>
- </listitem>
-
- <listitem>
- <para>Close the <guilabel>Lots in Account SSSS</guilabel> window and return to the security account
- register.
- </para>
+ </step>
+ <step>
+ <simpara>Close the <guilabel>Lots in Account SSSS</guilabel> window and return to the security account register.</simpara>
<figure pgwide="1">
- <title>Selling Shares - Capital Gains - Register after Scrub Account</title><screenshot id="invest2-lots3AftScrubAcct">
+ <title>Selling Shares - Capital Gains - Register after Scrub Account</title>
+ <screenshot id="invest2-lots3AftScrubAcct">
<mediaobject>
<imageobject role="html">
<imagedata fileref="figures/invest2Lots3RegAftScrubAcct.png"
@@ -3956,11 +3952,11 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
</imageobject>
<textobject>
- <phrase>Example of security register after using Scrub Account </phrase>
+ <phrase>Example of security register after using Scrub Account</phrase>
</textobject>
<caption>
- <para>An image of the <emphasis>security register </emphasis> after using Scrub Account.
+ <para>An image of the <emphasis>security register</emphasis> after using Scrub Account.
</para>
</caption>
</mediaobject>
@@ -3973,25 +3969,24 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
sell transaction.
</para>
</note>
- </listitem>
+ </step>
- <listitem>
- <para>Continue to <xref linkend="invest-sellChgCapGainsAcct" />
- </para>
- </listitem>
- </orderedlist>
- </sect3>
+ <step>
+ <simpara>Continue to <xref linkend="invest-sellChgCapGainsAcct" />.</simpara>
+ </step>
+ </procedure>
+ </example>
- <sect3 id="invest-sellFifoSplit">
- <title>Example 4: Automatic Creation of Capital Gain Or Loss Transactions - After a Simple Stock Split</title>
+ <example id="invest-sellFifoSplit">
+ <title>Automatic Creation of Capital Gain Or Loss Transactions - After a Simple Stock Split</title>
- <para>Here is an example of FIFO scrubbing without manual lot creation/linking, where the Stock Split
+ <para>Here is an example of <acronym>FIFO</acronym> scrubbing without manual lot creation/linking, where the Stock Split
Assistant has been used for a simple stock split. In this example, 100 shares of security
XYZ were bought for $10.00 each, there was a simple 2 for 1 stock split for zero cost (so
the holding was then 200 shares @ $5.00 each), then all 200 shares were sold for $6.00
each.
</para>
-
+ <para>
<figure pgwide="1">
<title>Selling Shares - Capital Gains - Register after Scrub Account</title><screenshot id="investLotsSplitReg">
<mediaobject>
@@ -4066,45 +4061,40 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
</mediaobject>
</screenshot>
</figure>
-
- <para>The above screen shots show that scrubbing created:
</para>
-
- <para>2 lots. A separate lot for each buy (it essentially treats the stock split as a buy of 100 for no
- cost)
- </para>
-
- <para>2 capital gain transactions (one for each lot) on the date of the sale:
+ <para>The above screenshots show that scrubbing created:
+ <itemizedlist>
+ <listitem>
+ <simpara>2 lots. A separate lot for each buy (it essentially treats the stock split as a buy of 100 for no cost.)</simpara>
+ </listitem>
+ <listitem>
+ <simpara>2 capital gain transactions (one for each lot) on the date of the sale:</simpara>
+ <itemizedlist>
+ <listitem>
+ <simpara>Lot 0: Jul. 1, 2009 loss $400 (sale $600 − cost $1,000.)</simpara>
+ </listitem>
+ <listitem>
+ <simpara>Lot 1: Jul. 1, 2009 gain $600 (sale $600 − cost $0.)</simpara>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </itemizedlist>
</para>
- <itemizedlist>
- <listitem>
- <para>Lot 0: 1/7/2009 loss $400 (sale $600 − cost $1000)
- </para>
- </listitem>
-
- <listitem>
- <para>Lot 1: 1/7/2009 gain $600 (sale $600 − cost $0)
- </para>
- </listitem>
- </itemizedlist>
-
<para>Total gain $200 is correct. Whether the gain is a single long-term one or one each of long-term and
short-term or whether there's even a distinction depends on the user's tax jurisdiction
and the way the split is structured. If the user needs help figuring it out they should
consult a professional.
</para>
- </sect3>
- <sect3 id="invest-sellChgCapGainsAcctExample">
- <title>Example 5: Changing the Orphaned Gains-CCC to Gain/Loss Account</title>
-
- <orderedlist>
- <listitem>
- <para>Close the <guilabel>Lots in Account SSSS</guilabel> window if open and return to the security
- account register.
- </para>
+ </example>
+ <example id="invest-sellChgCapGainsAcctExample">
+ <title>Changing the Orphaned Gains-CCC to Gain/Loss Account</title>
+ <procedure>
+ <step>
+ <simpara>Close the <guilabel>Lots in Account SSSS</guilabel> window if open and return to the security
+ account register.</simpara>
<figure pgwide="1">
<title>Selling Shares - Capital Gains - Register after scrubbing a single lot</title><screenshot id="invest-lots4AftScrub1LotReg">
<mediaobject>
@@ -4123,29 +4113,33 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
</textobject>
<caption>
- <para>An image of the <emphasis>security register </emphasis> after scrubbing a single lot.
+ <para>An image of the <emphasis>security register</emphasis> after scrubbing a single lot.
</para>
</caption>
</mediaobject>
</screenshot>
</figure>
- </listitem>
-
- <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> 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 Gain:IBM</emphasis>).
- </para>
-
+ </step>
+
+ <step>
+ <simpara>Find each new <emphasis>Realized Gain/Loss</emphasis> transaction in the security account register
+ (they will have the same date as the sell transactions).
+ </simpara>
+ </step>
+
+ <step>
+ <simpara>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 (for example, <emphasis>Income:Capital Gain (Long Term):IBM</emphasis>).</simpara>
<tip>
- <para>You may like to split the capital gain/loss into taxable and non taxable parts if that is in accord
+ <simpara>You may like to split the capital gain/loss into taxable and non taxable parts if that is in accord
with your tax laws.
- </para>
+ </simpara>
</tip>
- </listitem>
- </orderedlist>
+ </step>
+ </procedure>
+
+
+ </example>
</sect3>
</sect2>
</sect1>
@@ -4208,8 +4202,8 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
<para>If you receive the dividend in the form of an automatic reinvestment, the transaction for this
should be handled within the stock or mutual fund account as income from
- <quote>Income:Dividend</quote> for the appropriate number of reinvested shares. This type of
- reinvest account is often referred to as a DRIP (Dividend Re-Investment Program).
+ <emphasis>Income:Dividends</emphasis> for the appropriate number of reinvested shares. This type of
+ reinvest account is often referred to as a <acronym>DRIP</acronym> (Dividend Re-Investment Program).
</para>
<para>As an example consider the following purchase of NSTAR (NST) stock with the dividends reinvested
@@ -4219,9 +4213,9 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
<para>Starting with the purchase of 100 shares on Jan. 3, 2005, all dividends will be reinvested and an
account is created to track the dividend to the specific stock. &app; simplifies the entry
by allowing calculations within the cells of the transaction. If the first dividend is
- $.29/share, enter $53.28 (purchase price + dividend) in the share <guilabel>Price</guilabel>
- cell and 100*.29 in the <guilabel>Buy</guilabel> cell. &app; will calculate for you the
- corresponding numer of <guilabel>Shares</guilabel>
+ $0.29/share, enter <userinput>53.28</userinput> (purchase price + dividend) in the share <guilabel>Price</guilabel>
+ cell and <userinput>100*0.29</userinput> in the <guilabel>Buy</guilabel> cell. &app; will calculate for you the
+ corresponding number of <guilabel>Shares</guilabel>.
</para>
<screenshot id="invest-dividendreinvest1">
@@ -4258,7 +4252,7 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
</para>
<para>A Return of Capital transaction can be entered in the stock register by entering the stock split
- with
+ with:
</para>
<informaltable>
@@ -4333,9 +4327,8 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
price database entry which could cause reports to be wrong. Check for and remove such an
unwanted entry from the price database using
<menuchoice>
- <guimenu>Tools </guimenu><guimenuitem>Price Editor</guimenuitem>
- </menuchoice>
- .
+ <guimenu>Tools</guimenu><guimenuitem>Price Database</guimenuitem>
+ </menuchoice>.
</para>
</tip>
</sect1>
@@ -4347,9 +4340,9 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
<para>Companies may split their stock for many reasons but the most common is that the price has risen
higher than management thinks is a reasonable price for many investors. Some of these splits
- are simple exchanges (eg 2 for 1 or 3 for 2) and some are complex exchanges with cash
+ are simple exchanges (for example, 2 for 1 or 3 for 2) and some are complex exchanges with cash
distributions. Splits may also result in fewer shares if the exchange rate is a reverse split
- (1 for 3 or .75 for 1).
+ (1 for 3 or 0.75 for 1).
</para>
<sect2 id="invest-simplesplit">
@@ -4412,39 +4405,36 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
<para>The next screen presents 5 fields in the Stock Splits Details window:
</para>
- <itemizedlist>
- <listitem>
- <para><guilabel>Date</guilabel> - Enter the date of the split.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Shares</guilabel> - The number of shares increased (or decreased) in the transaction.
- </para>
-
- <para>In our example it is a 2 for 1 split so the number of additional shares is the number of shares
- currently in the register.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Description</guilabel> - The Description should give a brief explanation of the
- transaction.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>New Price</guilabel> - If desired the new price of the stock, after the split, may be
- entered.
- </para>
- </listitem>
+ <variablelist>
+ <varlistentry>
+ <term>Date</term>
+ <listitem><simpara>Enter the date of the split.</simpara></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Shares</term>
+ <listitem><para>The number of shares increased (or decreased) in the transaction.
+ In this example, it is a 2 for 1 split so the number of additional shares is the number of shares
+ currently in the register.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Description</term>
+ <listitem><simpara>The Description should give a brief explanation of the transaction.</simpara></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>New Price</term>
+ <listitem><simpara>If desired the new price of the stock, after the split, may be entered.</simpara></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Currency</term>
+ <listitem><simpara>The currency of the transaction is required. This should be the same as the stock purchase currency.</simpara></listitem>
+ </varlistentry>
- <listitem>
- <para><guilabel>Currency</guilabel> - The currency of the transaction is required. This should be the same
- as the stock purchase currency.
- </para>
- </listitem>
- </itemizedlist>
+ </variablelist>
<para>Click on the <guibutton>Forward</guibutton> button.
</para>
@@ -4523,7 +4513,7 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
been paid in cash, therefore not entered into the AT&T stock register.
</para>
- <para>The conditions of the merger were .77942 share of SBC stock were exchanged for each share of
+ <para>The conditions of the merger were 0.77942 share of SBC stock were exchanged for each share of
AT&T stock. The merged company continued to use the symbol <quote>T</quote> from
AT&T.
</para>
@@ -4563,42 +4553,38 @@ url="https://www.gnucash.org/docs/v&series-stable;/C/gnucash-help/tool-lots.html
<para>The next screen presents 5 fields in the Stock Splits Details window:
</para>
- <itemizedlist>
- <listitem>
- <para><guilabel>Date</guilabel> - Enter the date of the split. Here we’ll enter November 18, 2005.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Shares</guilabel> - The number of shares increased (or decreased) in the transaction.
- </para>
-
- <para>In our example it is a .77942 for 1 split so the number of shares will decrease from the number of
- shares currently in the register. You may use &app;’s ability to perform
- calculations on an entry form by entering data directly (E.g.
- <quote>(.77942*100)−100</quote>) to calculate the decrease in shares from the
- split.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Description</guilabel> - The Description should give a brief explanation of the
- transaction.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>New Price</guilabel> - If desired the new price of the stock, after the split, may be
- entered.
- </para>
- </listitem>
-
- <listitem>
- <para><guilabel>Currency</guilabel> - The currency of the transaction is required. This should be the same
- as the stock purchase currency.
- </para>
- </listitem>
- </itemizedlist>
+ <variablelist>
+ <varlistentry>
+ <term>Date</term>
+ <listitem><simpara>Enter the date of the split. Here we’ll enter November 18, 2005.</simpara></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Shares</term>
+ <listitem><para>The number of shares increased (or decreased) in the transaction.
+ In this example it is a 0.77942 for 1 split so the number of shares will decrease from the number of
+ shares currently in the register. You may use &app;’s ability to perform
+ calculations on an entry form by entering data directly (
+ <userinput>0.77942*100 − 100</userinput>) to calculate the decrease in shares from the
+ split.</para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Description</term>
+ <listitem><simpara>The Description should give a brief explanation of the transaction.</simpara></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>New Price</term>
+ <listitem><simpara>If desired the new price of the stock, after the split, may be entered.</simpara></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Currency</term>
+ <listitem><simpara>The currency of the transaction is required. This should be the same as the stock purchase currency.</simpara></listitem>
+ </varlistentry>
+
+ </variablelist>
<para>Click on the <guibutton>Forward</guibutton> button.
</para>
Summary of changes:
docbook/gnc-docbookx.dtd | 1 +
guide/C/ch_invest.xml | 2752 +++++++++++++++++++++++-----------------------
2 files changed, 1385 insertions(+), 1368 deletions(-)
More information about the gnucash-changes
mailing list