gnucash-docs master: Help Documentation: Add Advanced Portfolio Rpt details

Geert Janssens gjanssens at code.gnucash.org
Fri Apr 4 09:57:45 EDT 2014


Updated	 via  https://github.com/Gnucash/gnucash-docs/commit/596153b4 (commit)
	from  https://github.com/Gnucash/gnucash-docs/commit/acb2c1e2 (commit)



commit 596153b477687564cee09090fa4e30bb08283581
Author: Chris Good <chris.good at ozemail.com.au>
Date:   Sun Mar 23 13:20:52 2014 +1100

    Help Documentation: Add Advanced Portfolio Rpt details
    
    Committer: Chris Good <chris.good at ozemail.com.au>

diff --git a/help/C/Help_ch_Reports.xml b/help/C/Help_ch_Reports.xml
index 133b5e5..6e8ab28 100644
--- a/help/C/Help_ch_Reports.xml
+++ b/help/C/Help_ch_Reports.xml
@@ -85,12 +85,136 @@
    <sect1 id="report-assets">
     <title>Assets & Liabilities</title>
 
-     <para>The Assets & Liabilities reports includes the Balance Sheet report,
-      Investment reports and the Net Worth report.</para>
+     <para>The Assets & Liabilities reports includes the Balance Sheet             report, Investment reports and the Net Worth report.</para>
 
       <itemizedlist>
+
        <listitem>
         <para>Advanced Portfolio:</para>
+
+        <para>Columns</para>
+          <itemizedlist>
+
+            <listitem><para><guilabel>Account</guilabel> — Stock Account</para>
+            </listitem>
+
+            <listitem><para><guilabel>Symbol</guilabel> — Ticker Symbol/Abbreviation as defined in the Security Editor. A report option can suppress this column.</para>
+            </listitem>
+
+            <listitem><para><guilabel>Listing</guilabel> — Type as defined in the Security Editor. A report option can suppress this column.</para>
+            </listitem>
+
+            <listitem><para><guilabel>Shares</guilabel> — Number of shares           (quantity). A report option sets how many decimal places to show.
+	    A report option can suppress this column.</para>
+            </listitem>
+
+            <listitem><para><guilabel>Price</guilabel> — Unit market price as at report date. A report option can suppress this column.</para>
+            </listitem>
+
+            <listitem><para><guilabel>Basis</guilabel> — Cost of all shares acquired by any means, including brokerage fees if the option to include them is checked. Report option <emphasis>Basis calculation method</emphasis> can be set to Average, LIFO or FIFO.</para>
+	    </listitem>
+
+            <listitem><para><guilabel>Value</guilabel> — Number of shares * Unit market price as at report date</para>
+            </listitem>
+
+            <listitem><para><guilabel>Money In</guilabel> — Sum of the cost of stock purchased, excluding stock acquired as part of a Dividend Reinvestment Plan. I.e. External money used to purchase shares.</para>
+	    </listitem>
+
+            <listitem><para><guilabel>Money Out</guilabel> — Money from selling shares or a spin off transaction.</para>
+	    </listitem>
+
+            <listitem><para><guilabel>Realized Gain</guilabel> — Money received for selling shares minus basis for shares sold, minus brokerage fees for the sale if the option to include them in basis is checked.</para>
+	    </listitem>
+
+            <listitem><para><guilabel>Unrealized Gain</guilabel> — Value less Basis for unsold shares</para>
+	    </listitem>
+
+            <listitem><para><guilabel>Total Gain</guilabel> — Realized Gain + Unrealized Gain</para>
+	    </listitem>
+
+            <listitem><para><guilabel>Rate of Gain</guilabel> — Total Gain / Money In * 100 (from <application>&app;</application> 2.6.1 onwards)</para>
+	    </listitem>
+
+            <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>
+	      </note>
+	    </listitem>
+
+            <listitem><para><guilabel>Brokerage Fees</guilabel> — Brokerage Fees</para>
+	    </listitem>
+
+            <listitem><para><guilabel>Total Return</guilabel> — Total Gain + Income</para>
+	    </listitem>
+
+            <listitem><para><guilabel>Rate of Return</guilabel> — Total Return / Money In * 100</para>
+	    </listitem>
+
+          </itemizedlist>
+
+        <para>Common report options are described in <xref linkend="report-custom"/></para>
+
+        <para>Report Specific Options</para>
+
+        <itemizedlist>	<!-- list of Tabs -->
+
+          <listitem><para>Accounts Tab</para>
+
+            <itemizedlist>
+
+              <listitem><para><guilabel>Include accounts with no shares</guilabel> — Unchecked (default) or checked.</para>
+              </listitem>
+
+            </itemizedlist>
+
+          </listitem>	<!-- end of Accounts Tab -->
+
+          <listitem><para>Display Tab</para>
+
+            <itemizedlist>
+
+              <listitem><para><guilabel>Show ticker symbols</guilabel> — Checked default) or unchecked. If unchecked, Symbol column will be omitted.</para>
+              </listitem>
+
+              <listitem><para><guilabel>Show listings</guilabel> — Checked (default) or unchecked. If unchecked, Listing column (source of shares price quotes) will be omitted.</para>
+              </listitem>
+
+              <listitem><para><guilabel>Show number of shares</guilabel> — Checked (default) or unchecked. If unchecked, Shares column will be omitted.</para>
+              </listitem>
+
+              <listitem><para><guilabel>Share decimal places</guilabel> — The number of decimal places to show in the number of shares. Default is 2.</para>
+              </listitem>
+
+              <listitem><para><guilabel>Show prices</guilabel> — Checked (default) or unchecked. If unchecked, Price column will be omitted.</para>
+              </listitem>
+
+            </itemizedlist>
+
+          </listitem>	<!-- end of Display Tab -->
+
+          <listitem><para>General Tab</para>
+
+            <itemizedlist>
+
+              <listitem><para><guilabel>Price Source</guilabel> — Nearest in time (default) or Most Recent.</para>
+              </listitem>
+
+              <listitem><para><guilabel>Basis calculation method</guilabel> — Average (default), FIFO or LIFO.</para>
+              </listitem>
+
+              <listitem><para><guilabel>Set preference for price list data</guilabel> — Checked (default): Use price list data. If there is no relevant price list data, transaction prices will be used and there will be a warning. Unchecked: Get prices from stock transactions.</para>
+              </listitem>
+
+              <listitem><para><guilabel>How to report brokerage fees</guilabel> — Include in basis (default), Include in gain or Ignore.</para>
+              </listitem>
+
+            </itemizedlist>
+
+          </listitem>
+
+        </itemizedlist>
+
        </listitem>
 
        <listitem>



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



More information about the gnucash-changes mailing list