gnucash-docs maint: Document Mike Alexander mod to Advanced Portfolio Report

[Geert Janssens]

Updated	 via  https://github.com/Gnucash/gnucash-docs/commit/c615c874 (commit)
	from  https://github.com/Gnucash/gnucash-docs/commit/9124f1af (commit)



commit c615c874d2f4a2bd3b9f4f5076e095ac8a1e6a99
Author: Chris Good <chris.good at ozemail.com.au>
Date:   Sun Mar 1 15:16:04 2015 +1100

    Document Mike Alexander mod to Advanced Portfolio Report
    
    Mike has modified advanced-portfolio.scm so that in some
    circumstances it is not necessary to add a dummy stock split to an
    income transaction in order for the income to be automatically
    included. This was done as part of multiple bugs.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=744918

diff --git a/help/C/Help_ch_Reports.xml b/help/C/Help_ch_Reports.xml
index 6e8ab28..72876db 100644
--- a/help/C/Help_ch_Reports.xml
+++ b/help/C/Help_ch_Reports.xml
@@ -137,8 +137,29 @@
 
             <listitem><para><guilabel>Income</guilabel> — Total of all income transactions associated with a stock account.</para>
               <note>
-                <para>To include income from dividends which are not reinvested:</para>
-                <para>Ensure there is a dummy transaction split to the stock account with quantity 0 price 1 value 0 in the dividend transaction. You can just enter the dummy stock split with no values in the dividend account and it will create the transaction with price 1 even though you cannot see the Price column in that register.</para>
+                <para>To include income from dividends which are not reinvested (if there is no split to the stock account in the income transaction, the report has no way of associating the income with a particular stock) :
+                </para>
+		<para>Ensure there is a dummy transaction split to the stock         account with quantity 0, price 1 and value 0 in the dividend transaction. Enter the dummy stock split with no values in the dividend account and it will create the transaction with price 1 even though you cannot see the Price column in that register.
+		</para>
+                <para>In GnuCash 2.6.6, this report was modified to simplify the recording of dividend and interest payments. With this
+                change it may not be necessary to include the dummy stock split in the transaction. The report will find income (and expense) transactions that are in the parent account of the stock account being reported on. This is done by looking in the parent account for transactions that have exactly two splits (not counting trading account splits) where the other split is to an income or expense account with the same name as the stock's account.
+                </para>
+                <para>For example given an account structure like
+                </para>
+                <literallayout>
+                Assets (type ASSET)
+                  Broker (type ASSET)
+                    Widget Stock (type STOCK)
+                Income (type INCOME)
+                  Dividends (type INCOME)
+                    Widget Stock (type INCOME)
+                </literallayout>
+                <para>A transaction that debits the "Assets:Broker" account and credits the "Income:Dividends:Widget Stock" account will count as income even though it doesn't have a split with account "Assets:Broker:Widget Stock".
+                </para>
+                <para>This only works if the parent account ("Assets:Broker" in this case) is a Bank or Asset account and the Income/Expense account has the same name as the stock account. It won't double count transactions that have a dummy split since they won't have exactly two split transactions.
+                </para>
+                <para>It will not work if the income or expense account split is to a subaccount of the account with the same name as the stock account i.e. "Income:Dividends:Widget Stock:Franked"
+                </para>
 	      </note>
 	    </listitem>
 



Summary of changes:
 help/C/Help_ch_Reports.xml | 25 +++++++++++++++++++++++--
 1 file changed, 23 insertions(+), 2 deletions(-)