gnucash-docs master: Multiple changes pushed
John Ralls
jralls at code.gnucash.org
Thu Mar 29 14:12:09 EDT 2018
Updated via https://github.com/Gnucash/gnucash-docs/commit/0aa3512d (commit)
via https://github.com/Gnucash/gnucash-docs/commit/09c85eeb (commit)
via https://github.com/Gnucash/gnucash-docs/commit/1afa19ea (commit)
via https://github.com/Gnucash/gnucash-docs/commit/dd91e512 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/d1a80db0 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/62b0a0cd (commit)
via https://github.com/Gnucash/gnucash-docs/commit/1248daf8 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/fffa817c (commit)
via https://github.com/Gnucash/gnucash-docs/commit/b9a2721b (commit)
via https://github.com/Gnucash/gnucash-docs/commit/7a0077d7 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/ab2539fc (commit)
via https://github.com/Gnucash/gnucash-docs/commit/8bb6d01a (commit)
via https://github.com/Gnucash/gnucash-docs/commit/98692dea (commit)
via https://github.com/Gnucash/gnucash-docs/commit/ab268fcd (commit)
from https://github.com/Gnucash/gnucash-docs/commit/6c7cad27 (commit)
commit 0aa3512d8e824d96f22f88f769911f756b88c416
Merge: 6c7cad2 09c85ee
Author: John Ralls <jralls at ceridwen.us>
Date: Thu Mar 29 11:06:11 2018 -0700
Merge Chris Lam's "Newbie Guide to the Transaction Report" into master.
commit 09c85eebaba63cdd89493a029388bfffdf8f91a3
Author: Christopher Lam <christopher.lck at gmail.com>
Date: Fri Mar 9 17:24:48 2018 +0800
Clarify <emphasis> and add version info
diff --git a/guide/C/ch_reports.xml b/guide/C/ch_reports.xml
index 4860869..4774274 100644
--- a/guide/C/ch_reports.xml
+++ b/guide/C/ch_reports.xml
@@ -111,7 +111,7 @@ Configuration.</para>
<listitem>
<para>Indenting of columns will indent the report columns for
easier understanding of grouping and sorting. (This is now
- enabled by default)</para>
+ enabled by default for Gnucash 3.0 onwards)</para>
</listitem>
<listitem>
<para>Subtotal table is useful to understand the relationship
@@ -757,24 +757,24 @@ an empty report will be generated.</para>
<orderedlist>
<listitem>
<para>Open the report options, from the
- <emphasis>Accounts</emphasis> tab, click the Expense
- placeholder account and <emphasis>Select
- Children</emphasis>.</para>
+ <guilabel>Accounts</guilabel> tab, click the Expense
+ placeholder account and <guibutton>Select
+ Children</guibutton>.</para>
</listitem>
<listitem>
- <para>From the <emphasis>General</emphasis> tab, Choose
+ <para>From the <guilabel>General</guilabel> tab, Choose
relative dates “Start of Previous Year†and “End of Previous
Yearâ€.</para>
</listitem>
<listitem>
- <para>From the <emphasis>Sorting</emphasis> tab, set
- <emphasis>Primary Key</emphasis> to Accounts, and enable
- <emphasis>Primary Key Subtotal</emphasis>.
+ <para>From the <guilabel>Sorting</guilabel> tab, set
+ <guilabel>Primary Key</guilabel> to Accounts, and enable
+ <guilabel>Primary Key Subtotal</guilabel>.
</para>
</listitem>
<listitem>
- <para>Set the <emphasis>Secondary Key</emphasis> to Date,
- and set the <emphasis>Secondary Key Subtotal</emphasis> to
+ <para>Set the <guilabel>Secondary Key</guilabel> to Date,
+ and set the <guilabel>Secondary Key Subtotal</guilabel> to
None. </para>
</listitem>
</orderedlist>
@@ -789,8 +789,8 @@ an empty report will be generated.</para>
also calculate monthly sums within each account.</para>
<orderedlist>
<listitem><para>Select options as above</para></listitem>
- <listitem><para>From the <emphasis>Sorting</emphasis> tab,
- set <emphasis>Secondary Key Subtotal</emphasis> to Monthly
+ <listitem><para>From the <guilabel>Sorting</guilabel> tab,
+ set <guilabel>Secondary Key Subtotal</guilabel> to Monthly
</para></listitem>
</orderedlist>
</sect3>
@@ -803,8 +803,8 @@ an empty report will be generated.</para>
</para>
<orderedlist>
<listitem><para>Select options as above</para></listitem>
- <listitem><para>From the <emphasis>Display</emphasis> tab,
- enable the <emphasis>Subtotal Table</emphasis>.</para>
+ <listitem><para>From the <guilabel>Display</guilabel> tab,
+ enable the <guilabel>Subtotal Table</guilabel>.</para>
</listitem>
</orderedlist>
</sect3>
@@ -818,9 +818,9 @@ an empty report will be generated.</para>
The filtering text may be either a standard string, or a POSIX regular
expression.</para>
<orderedlist>
- <listitem><para>From the <emphasis>Filter</emphasis> tab,
- complete the <emphasis>Account Name Filter</emphasis>, or
- <emphasis>Transaction Filter</emphasis>. Optionally toggle the
+ <listitem><para>From the <guilabel>Filter</guilabel> tab,
+ complete the <guilabel>Account Name Filter</guilabel>, or
+ <guilabel>Transaction Filter</guilabel>. Optionally toggle the
regular expression check boxes to toggle full POSIX regex
matching. Regular expressions will allow more complex
queries e.g. the transaction filter can be set to
@@ -836,20 +836,20 @@ an empty report will be generated.</para>
<para>This sortkey 'reconcile status' will separate reconciled,
cleared and unreconciled transactions. This report may be useful
in producing a printable reconciliation report.</para>
- <para>Alternatively, the <emphasis>Reconciliation Report
- </emphasis> will preset these defaults and requires only the
+ <para>Alternatively, the <guilabel>Reconciliation Report
+ </guilabel> will preset these defaults and requires only the
Accounts selection.
</para>
<orderedlist>
- <listitem><para>From the <emphasis>Accounts</emphasis> tab,
+ <listitem><para>From the <guilabel>Accounts</guilabel> tab,
select the relevant bank or credit card account</para></listitem>
- <listitem><para>From the <emphasis>General</emphasis> tab,
+ <listitem><para>From the <guilabel>General</guilabel> tab,
choose an appropriate date range e.g. past 3 months</para></listitem>
- <listitem><para>From the <emphasis>Sorting</emphasis> tab,
- set the <emphasis>Primary Key</emphasis> to Reconcile
- Status, <emphasis>Primary Key Subtotal</emphasis> to enabled,
- and set the <emphasis>Secondary Key</emphasis> to Date. The
- <emphasis>Secondary Date Subtotal</emphasis> is left to None
+ <listitem><para>From the <guilabel>Sorting</guilabel> tab,
+ set the <guilabel>Primary Key</guilabel> to Reconcile
+ Status, <guilabel>Primary Key Subtotal</guilabel> to enabled,
+ and set the <guilabel>Secondary Key</guilabel> to Date. The
+ <guilabel>Secondary Date Subtotal</guilabel> is left to None
</para></listitem>
</orderedlist>
</sect3>
commit 1afa19ea117a26553141fb3b51fd6a9e41ff4890
Author: Christopher Lam <christopher.lck at gmail.com>
Date: Tue Mar 6 06:42:51 2018 +0800
Finalise guide and help to document features in Gnucash 3.0
diff --git a/guide/C/ch_reports.xml b/guide/C/ch_reports.xml
index 0635b44..4860869 100644
--- a/guide/C/ch_reports.xml
+++ b/guide/C/ch_reports.xml
@@ -82,21 +82,24 @@ Configuration.</para>
<sect2 id="rpt_txnrept">
<title>Transaction Report</title>
<para>The Transaction Report is a fundamental report that allows
- users to retrieve a wide variety of useful information from the
- financial records. The report includes many features that allow
- powerful and flexible reporting from the single basic report.</para>
+ users to retrieve a wide variety of useful information from the
+ financial records. The report includes many features that allow
+ powerful and flexible reporting from the single basic
+ report.</para>
<itemizedlist>
- <listitem><para>Debit and Credit subtotals can be displayed, and
- within a grouping section, if debit totals > credit totals, the
- group subtotal will be displayed in the debit column.</para>
- </listitem>
<listitem>
- <para>Multiple data columns enable display of foreign currency
- and original currency in separate columns.</para>
+ <para>Debit and Credit subtotals can be displayed, and within
+ a grouping section, if debit totals > credit totals, the group
+ subtotal will be displayed in the debit column.</para>
+ </listitem>
+ <listitem>
+ <para>Multiple data columns enable display of transaction
+ amounts in report currency and original currency in separate
+ columns.</para>
</listitem>
<listitem>
<para>Additional sortkeys e.g. sort by reconcile status
- (unreconciled -> cleared -> reconciled), sort by weekday, allow
+ (unreconciled -> cleared -> reconciled), sort by weeks, allow
additional views into the financial records.</para>
</listitem>
<listitem>
@@ -107,18 +110,15 @@ Configuration.</para>
</listitem>
<listitem>
<para>Indenting of columns will indent the report columns for
- easier understanding of grouping and sorting. (This
- is now enabled by default)</para>
+ easier understanding of grouping and sorting. (This is now
+ enabled by default)</para>
</listitem>
<listitem>
<para>Subtotal table is useful to understand the relationship
- in the data e.g. account values in time series.</para>
- </listitem>
- <listitem>
- <para>Filter by Closing Transactions will disallow closing
- transactions (i.e. income & expense accounts to
- equity) which should not routinely be included in transaction reports.
- (This is now enabled by default.)</para>
+ in the data. This feature compiles the primary and secondary
+ subtotals into a table view, allowing additional insight into
+ financial records, e.g. account subtotals in different time
+ series.</para>
</listitem>
</itemizedlist>
<para>For further ideas on how to use the Transaction Report to produce
@@ -755,29 +755,38 @@ an empty report will be generated.</para>
basic transaction report format. To create this report:
</para>
<orderedlist>
- <listitem><para>Open the report options, from the
- <emphasis>Accounts</emphasis> tab, click the Expense
- placeholder account and <emphasis>Select Children</emphasis>.</para></listitem>
- <listitem><para>From the <emphasis>General</emphasis> tab,
- Choose relative dates “Start of Previous Year†and “End of
- Previous Yearâ€.</para></listitem>
- <listitem><para>From the <emphasis>Sorting</emphasis> tab,
- set <emphasis>Primary Key</emphasis> to Accounts, and enable
- <emphasis>Primary Key Subtotal</emphasis>.
- </para></listitem>
- <listitem><para>Set the <emphasis>Secondary Key</emphasis> to
- Date, and set the <emphasis>Secondary Key Subtotal</emphasis>
- to None. </para></listitem>
+ <listitem>
+ <para>Open the report options, from the
+ <emphasis>Accounts</emphasis> tab, click the Expense
+ placeholder account and <emphasis>Select
+ Children</emphasis>.</para>
+ </listitem>
+ <listitem>
+ <para>From the <emphasis>General</emphasis> tab, Choose
+ relative dates “Start of Previous Year†and “End of Previous
+ Yearâ€.</para>
+ </listitem>
+ <listitem>
+ <para>From the <emphasis>Sorting</emphasis> tab, set
+ <emphasis>Primary Key</emphasis> to Accounts, and enable
+ <emphasis>Primary Key Subtotal</emphasis>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>Set the <emphasis>Secondary Key</emphasis> to Date,
+ and set the <emphasis>Secondary Key Subtotal</emphasis> to
+ None. </para>
+ </listitem>
</orderedlist>
</sect3>
<sect3>
<title>Secondary level grouping</title>
- <para>The following will modify the above Transaction Report to use
- a secondary grouping strategy. The first grouping (i.e. Primary Key =
- Accounts, Subtotal = enabled) will group transactions from the same
- accounts, whereas the secondary grouping (i.e. Secondary Key = Date,
- Subtotal = Monthly) will also calculate monthly sums within each
- account.</para>
+ <para>The following will modify the above Transaction Report to
+ use a secondary grouping strategy. The first grouping
+ (i.e. Primary Key = Accounts, Subtotal = enabled) will group
+ transactions from the same accounts, whereas the secondary
+ grouping (i.e. Secondary Key = Date, Subtotal = Monthly) will
+ also calculate monthly sums within each account.</para>
<orderedlist>
<listitem><para>Select options as above</para></listitem>
<listitem><para>From the <emphasis>Sorting</emphasis> tab,
@@ -787,15 +796,15 @@ an empty report will be generated.</para>
</sect3>
<sect3>
<title>Using secondary grouping for periodic comparison</title>
- <para>The Display / Subtotal Summary Grid adds a subtotal summary
- table, which will ease comparison of accounts across date periods.
- This displays the same subtotal calculations as the main table,
- presented in a grid structure.
+ <para>The Display / Subtotal Table adds a subtotal summary
+ table, which will ease comparison of accounts across date
+ periods. This displays the same subtotal calculations as the
+ main table, presented in a grid structure.
</para>
<orderedlist>
<listitem><para>Select options as above</para></listitem>
<listitem><para>From the <emphasis>Display</emphasis> tab,
- enable the <emphasis>Subtotal Summary Grid</emphasis>.</para>
+ enable the <emphasis>Subtotal Table</emphasis>.</para>
</listitem>
</orderedlist>
</sect3>
@@ -822,24 +831,6 @@ an empty report will be generated.</para>
</orderedlist>
</sect3>
<sect3>
- <title>I want a list of transactions showing income transactions,
- grouped by day of week</title>
- <para>This report may be pertinent to businesses operating with
- variable daily income, e.g. food industry. The weekday sortkey will
- allow subtotal comparisons according to day of week.</para>
- <orderedlist>
- <listitem><para>From the <emphasis>Accounts</emphasis> tab,
- click Income, and Select Children</para></listitem>
- <listitem><para>From <emphasis>General</emphasis> tab,
- choose appropriate dates.</para></listitem>
- <listitem><para>From the <emphasis>Sorting</emphasis> tab,
- set <emphasis>Primary Key</emphasis> to Accounts, and
- <emphasis>Secondary Key</emphasis> to Date</para></listitem>
- <listitem><para>From the <emphasis>Sorting</emphasis> tab,
- set <emphasis>Secondary Key Subtotal</emphasis> to Weekday</para></listitem>
- </orderedlist>
- </sect3>
- <sect3>
<title>Using the Transaction Report to generate a
reconciliation statement.</title>
<para>This sortkey 'reconcile status' will separate reconciled,
diff --git a/help/C/Help_ch_Reports.xml b/help/C/Help_ch_Reports.xml
index 75fa84b..3ffcb48 100644
--- a/help/C/Help_ch_Reports.xml
+++ b/help/C/Help_ch_Reports.xml
@@ -491,6 +491,9 @@
</informaltable>
</listitem>
+ <listitem><para><guilabel>Subtotal Table</guilabel> will add a summary table
+ for the various subtotals generated in the report. It lists the same subtotals
+ generated in tabular form.</para></listitem>
<listitem><para><guilabel>Running Balance</guilabel> refers to the running balance
of the account holding the transaction.</para></listitem>
<listitem><para><guilabel>Totals</guilabel> will add a 'Grand Total' line
commit dd91e512fd77670740d4b46300174d41569a3843
Author: Christopher Lam <christopher.lck at gmail.com>
Date: Sun Jan 28 21:22:28 2018 +0800
Further WIP TR help & guide.
Move the TR guide to be last section of Standard Reports.
diff --git a/guide/C/ch_reports.xml b/guide/C/ch_reports.xml
index a59bbde..0635b44 100644
--- a/guide/C/ch_reports.xml
+++ b/guide/C/ch_reports.xml
@@ -121,7 +121,7 @@ Configuration.</para>
(This is now enabled by default.)</para>
</listitem>
</itemizedlist>
- <para>For further ideas on how to use the Transaction to produce
+ <para>For further ideas on how to use the Transaction Report to produce
common reports, see <link linkend='rpt_transaction'>Using the
Transaction Report</link>.</para>
</sect2>
@@ -654,9 +654,8 @@ However, this report only lists transactions that have been selected
an empty report will be generated.</para>
</sect3>
</sect2>
-</sect1>
-<sect1 id="rpt_transaction">
+<sect2 id="rpt_transaction">
<title>Using the Transaction Report</title>
<para>The Transaction Report can be heavily customised to produce most
reports appropriate for personal finance and business bookkeeping purposes.
@@ -746,8 +745,6 @@ an empty report will be generated.</para>
salary, paying utility bill), or transfers between assets and liability
accounts (representing movements between loans and assets, e.g. paying
credit card bill, receiving a loan).</para>
- <sect2>
- <title>Common scenarios</title>
<para>The following use cases will be illustrated, and the options to be
selected explained:</para>
<sect3>
@@ -819,7 +816,7 @@ an empty report will be generated.</para>
matching. Regular expressions will allow more complex
queries e.g. the transaction filter can be set to
(#gift|#travel) which will filter transactions with either
- #gift or #travel. They can be complex and are best learned
+ #gift or #travel. They can be complicated and are best learned
from external guides.</para>
</listitem>
</orderedlist>
diff --git a/help/C/Help_ch_Reports.xml b/help/C/Help_ch_Reports.xml
index 2a3e356..75fa84b 100644
--- a/help/C/Help_ch_Reports.xml
+++ b/help/C/Help_ch_Reports.xml
@@ -474,7 +474,8 @@
</listitem>
<listitem><para><guilabel>Use Full Other Account Name</guilabel> will enable
display of full corresponding account name.</para></listitem>
- <listitem><para><guilabel>Other Account Code</guilabel></para></listitem>
+ <listitem><para><guilabel>Other Account Code</guilabel> will enable display of corresponding
+ account code.</para></listitem>
<listitem><para><guilabel>Shares:</guilabel> Display number of shares</para></listitem>
<listitem><para><guilabel>Price:</guilabel> Display share prices</para></listitem>
@@ -517,11 +518,13 @@
<listitem><para><guilabel>Account Name Filter</guilabel> will include only selected accounts
containing the substring. Alternatively, if the next option is checked, the account name
filter will be matched according to full POSIX regular expressions.</para></listitem>
- <listitem><para><guilabel>Use regular expressions for account name filter</guilabel></para></listitem>
+ <listitem><para><guilabel>Use regular expressions for account name filter</guilabel> toggles
+ regular expressions for account name filter.</para></listitem>
<listitem><para><guilabel>Transaction Filter</guilabel> will include only transactions
which contain this substring in the description, notes, or memo. Alternatively if the
next option is checked, the filter will be matched using full POSIX regular expressions.</para></listitem>
- <listitem><para><guilabel>Use regular expressions for transaction filter</guilabel></para></listitem>
+ <listitem><para><guilabel>Use regular expressions for transaction filter</guilabel> toggles
+ regular expressions for the transaction filter.</para></listitem>
<listitem><para><guilabel>Reconcile Status</guilabel></para>
<informaltable>
<tgroup cols="2">
@@ -545,6 +548,7 @@
</tgroup>
</informaltable>
</listitem>
+ <listitem><para><guilabel>Reset defaults button:</guilabel> Reset all values to their defaults</para></listitem>
</itemizedlist>
</listitem>
@@ -629,8 +633,8 @@
<row><entry>Account Name</entry><entry>Sort and subtotal by account name</entry></row>
<row><entry>Account Code</entry><entry>Sort and subtotal by account code</entry></row>
<row><entry>Date</entry><entry>Sort by date</entry></row>
- <row><entry>Exact Time</entry><entry>Sort by exact time</entry></row>
<row><entry>Reconciled Date</entry><entry>Sort by the reconciled date</entry></row>
+ <row><entry>Reconciled Status</entry><entry>Sort by the reconciled status</entry></row>
<row><entry>Register Order</entry><entry>Sort as within the register</entry></row>
<row><entry>Other Account Name</entry><entry>Sort by account transferred from/to's name</entry></row>
<row><entry>Other Account Code</entry><entry>Sort by account transferred from/to's code</entry></row>
@@ -644,7 +648,7 @@
</listitem>
<listitem><para><guilabel>Primary Subtotal:</guilabel> Subtotal according to the primary key</para></listitem>
- <listitem><para><guilabel>Primary Subtotal for Date Key:</guilabel> Do a date subtotal. Only configurable if primary key is date, exact time or register order.
+ <listitem><para><guilabel>Primary Subtotal for Date Key:</guilabel> Do a date subtotal. Only configurable if primary key is date or reconciled date.
One of None, weekly, monthly, quarterly or yearly</para>
</listitem>
@@ -661,7 +665,7 @@
<listitem><para><guilabel>Secondary Key:</guilabel> Secondary Sort Key. Same options as Primary Key</para></listitem>
<listitem><para><guilabel>Secondary Subtotal:</guilabel> Subtotal according to the secondary key</para></listitem>
- <listitem><para><guilabel>Secondary Subtotal for Date Key:</guilabel> Do a date subtotal. Only configurable if primary key is date, exact time or register order.
+ <listitem><para><guilabel>Secondary Subtotal for Date Key:</guilabel> Do a date subtotal. Only configurable if primary key is date or reconciled date.
One of None, weekly, monthly, quarterly or yearly</para>
</listitem>
@@ -679,7 +683,7 @@
<listitem><para><guilabel>Show Account Code:</guilabel> Show the account code for subtotals and subtitles</para></listitem>
<listitem><para><guilabel>Show Account Description:</guilabel> Show the account description for subtitles</para></listitem>
<listitem><para><guilabel>Show Informal Debit/Credit Headers:</guilabel> Show informal names for debit/credit
- in the report. This requires that subtotal is enabled, and the primary or sortkey is account or account code.</para></listitem>
+ in the subtitles. This requires that subtotal is enabled, and the primary or sortkey is account or account code.</para></listitem>
<listitem><para><guilabel>Add indenting columns:</guilabel> Add columns to align transactions within the same
grouping together, and can be useful to highlight groups.</para></listitem>
<listitem><para><guilabel>Show subtotals only (hide transactional data):</guilabel> Will hide transactions.
commit d1a80db05d072ecc37e375e9c4b11d6620d7d95c
Author: Christopher Lam <christopher.lck at gmail.com>
Date: Sun Jan 28 19:24:33 2018 +0800
Work in progress. Augment Help for Transaction Report.
diff --git a/help/C/Help_ch_Reports.xml b/help/C/Help_ch_Reports.xml
index 790bb0d..2a3e356 100644
--- a/help/C/Help_ch_Reports.xml
+++ b/help/C/Help_ch_Reports.xml
@@ -424,18 +424,6 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Void Transactions:</guilabel> One of</para>
- <informaltable>
- <tgroup cols="2">
- <tbody>
- <row><entry>Non-void only</entry><entry>Show only non-voided transactions</entry></row>
- <row><entry>Void only</entry><entry>Show only voided transactions</entry></row>
- <row><entry>Both</entry><entry>Show both and include voided transactions in totals</entry></row>
- </tbody>
- </tgroup>
- </informaltable>
- </listitem>
-
<listitem><para><guilabel>Reset defaults button:</guilabel> Reset all values to their defaults</para>
</listitem>
</itemizedlist>
@@ -445,15 +433,23 @@
<listitem><para><emphasis>Display tab</emphasis></para>
<itemizedlist>
- <listitem><para><guilabel>Date</guilabel></para></listitem>
- <listitem><para><guilabel>Reconciled Date</guilabel></para></listitem>
- <listitem><para><guilabel>Num</guilabel></para></listitem>
- <listitem><para><guilabel>Description</guilabel></para></listitem>
- <listitem><para><guilabel>Memo</guilabel></para></listitem>
+ <listitem><para><guilabel>Date</guilabel> refers to the 'posted date' i.e.
+ effective date of a transaction.</para></listitem>
+ <listitem><para><guilabel>Reconciled Date</guilabel> refers to the 'date of
+ reconciliation' of a transaction.</para></listitem>
+ <listitem><para><guilabel>Num</guilabel> is commonly used for check
+ numbers.</para></listitem>
+ <listitem><para><guilabel>Description</guilabel> is a description of the transaction
+ </para></listitem>
+ <listitem><para><guilabel>Memo</guilabel> is the memo field of a transaction. This
+ can be used as a secondary description of a transaction.</para></listitem>
<listitem><para><guilabel>Notes:</guilabel> Display the notes if the memo is unavailable</para></listitem>
- <listitem><para><guilabel>Account Name</guilabel></para></listitem>
- <listitem><para><guilabel>Use Full Account Name</guilabel></para></listitem>
- <listitem><para><guilabel>Account Code</guilabel></para></listitem>
+ <listitem><para><guilabel>Account Name</guilabel> will print the account name
+ containing the transaction.</para></listitem>
+ <listitem><para><guilabel>Use Full Account Name</guilabel> if the account name is
+ enabled, this option will display the full account name hierarchy.</para></listitem>
+ <listitem><para><guilabel>Account Code</guilabel> this refers to the 'account code'
+ related to the account.</para></listitem>
<listitem><para><guilabel>Detail Level</guilabel>— One of</para>
<informaltable>
<tgroup cols="2">
@@ -476,7 +472,8 @@
<listitem><para><guilabel>Other Account Name:</guilabel> For multi-split transactions, this parameter should be unticked. See below for more details.</para>
</listitem>
- <listitem><para><guilabel>Use Full Other Account Name</guilabel></para></listitem>
+ <listitem><para><guilabel>Use Full Other Account Name</guilabel> will enable
+ display of full corresponding account name.</para></listitem>
<listitem><para><guilabel>Other Account Code</guilabel></para></listitem>
<listitem><para><guilabel>Shares:</guilabel> Display number of shares</para></listitem>
<listitem><para><guilabel>Price:</guilabel> Display share prices</para></listitem>
@@ -493,13 +490,16 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Running Balance</guilabel></para></listitem>
- <listitem><para><guilabel>Totals</guilabel></para></listitem>
+ <listitem><para><guilabel>Running Balance</guilabel> refers to the running balance
+ of the account holding the transaction.</para></listitem>
+ <listitem><para><guilabel>Totals</guilabel> will add a 'Grand Total' line
+ adding all transactions in the report.</para></listitem>
<listitem><para><guilabel>Sign Reverses:</guilabel> One of</para>
<informaltable>
<tgroup cols="2">
<tbody>
+ <row><entry>Global Preference</entry><entry>Use reversing option specified in global preference.</entry></row>
<row><entry>None</entry><entry>Do not display signs reversed</entry></row>
<row><entry>Credit Accounts</entry><entry>Reverse amount display for Liability, Payable, Equity, Credit Card and Income accounts</entry></row>
<row><entry>Income and Expense</entry><entry>Reverse amount display for Income and Expense accounts</entry></row>
@@ -508,10 +508,46 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Reset defaults button Reset all values to their defaults</guilabel></para></listitem>
+ <listitem><para><guilabel>Reset defaults button</guilabel> Reset all values to their defaults</para></listitem>
</itemizedlist>
</listitem>
+ <listitem><para><emphasis>Filter tab</emphasis></para>
+ <itemizedlist>
+ <listitem><para><guilabel>Account Name Filter</guilabel> will include only selected accounts
+ containing the substring. Alternatively, if the next option is checked, the account name
+ filter will be matched according to full POSIX regular expressions.</para></listitem>
+ <listitem><para><guilabel>Use regular expressions for account name filter</guilabel></para></listitem>
+ <listitem><para><guilabel>Transaction Filter</guilabel> will include only transactions
+ which contain this substring in the description, notes, or memo. Alternatively if the
+ next option is checked, the filter will be matched using full POSIX regular expressions.</para></listitem>
+ <listitem><para><guilabel>Use regular expressions for transaction filter</guilabel></para></listitem>
+ <listitem><para><guilabel>Reconcile Status</guilabel></para>
+ <informaltable>
+ <tgroup cols="2">
+ <tbody>
+ <row><entry>All</entry><entry>Show all transactions</entry></row>
+ <row><entry>Unreconciled</entry><entry>Unreconciled only</entry></row>
+ <row><entry>Cleared</entry><entry>Cleared only</entry></row>
+ <row><entry>Reconciled</entry><entry>Reconciled only</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </listitem>
+ <listitem><para><guilabel>Void Transactions:</guilabel> One of</para>
+ <informaltable>
+ <tgroup cols="2">
+ <tbody>
+ <row><entry>Non-void only</entry><entry>Show only non-voided transactions</entry></row>
+ <row><entry>Void only</entry><entry>Show only voided transactions</entry></row>
+ <row><entry>Both</entry><entry>Show both and include voided transactions in totals</entry></row>
+ </tbody>
+ </tgroup>
+ </informaltable>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+
<listitem><para><emphasis>General tab</emphasis></para>
<itemizedlist>
<listitem><para><guilabel>Report name:</guilabel> Enter a descriptive name for this report</para></listitem>
@@ -537,7 +573,8 @@
</listitem>
<listitem><para><guilabel>End Date:</guilabel> Enter or select a specific End Date,</para>
- <para>or select one of the following named end date options which will be used to determine the end date each time the report is run
+ <para>or select one of the following named end date options which will be used to
+ determine the end date each time the report is run
</para>
<informaltable>
<tgroup cols="2">
@@ -571,12 +608,17 @@
<listitem><para><guilabel>Common Currency:</guilabel> Convert all transactions into a common currency</para></listitem>
<listitem><para><guilabel>Report's currency:</guilabel> Select the currency to display values</para></listitem>
+ <listitem><para><guilabel>Show original currency amount</guilabel> Also show original currency amounts</para></listitem>
<listitem><para><guilabel>Table for Exporting:</guilabel> Formats the table for cut & paste exporting with extra cells</para></listitem>
+ <listitem><para><guilabel>Add options summary:</guilabel> Adds an informative text
+ describing options that were changed by user. This is mainly useful for
+ troubleshooting reports.</para></listitem>
<listitem><para><guilabel>Reset defaults button:</guilabel> Reset all values to their defaults</para></listitem>
</itemizedlist>
</listitem>
- <listitem><para><emphasis>Sorting tab</emphasis></para>
+
+ <listitem><para><emphasis>Sorting tab</emphasis></para>
<itemizedlist>
<listitem><para><guilabel>Primary Key:</guilabel> Primary Sort Key. One of</para>
@@ -601,8 +643,6 @@
</informaltable>
</listitem>
- <listitem><para><guilabel>Show Full Account Name:</guilabel> Show the full account name for subtotals and subtitles</para></listitem>
- <listitem><para><guilabel>Show Account Code:</guilabel> Show the account code for subtotals and subtitles</para></listitem>
<listitem><para><guilabel>Primary Subtotal:</guilabel> Subtotal according to the primary key</para></listitem>
<listitem><para><guilabel>Primary Subtotal for Date Key:</guilabel> Do a date subtotal. Only configurable if primary key is date, exact time or register order.
One of None, weekly, monthly, quarterly or yearly</para>
@@ -635,7 +675,15 @@
</tgroup>
</informaltable>
</listitem>
-
+ <listitem><para><guilabel>Show Full Account Name:</guilabel> Show the full account name for subtotals and subtitles</para></listitem>
+ <listitem><para><guilabel>Show Account Code:</guilabel> Show the account code for subtotals and subtitles</para></listitem>
+ <listitem><para><guilabel>Show Account Description:</guilabel> Show the account description for subtitles</para></listitem>
+ <listitem><para><guilabel>Show Informal Debit/Credit Headers:</guilabel> Show informal names for debit/credit
+ in the report. This requires that subtotal is enabled, and the primary or sortkey is account or account code.</para></listitem>
+ <listitem><para><guilabel>Add indenting columns:</guilabel> Add columns to align transactions within the same
+ grouping together, and can be useful to highlight groups.</para></listitem>
+ <listitem><para><guilabel>Show subtotals only (hide transactional data):</guilabel> Will hide transactions.
+ This may be useful for reports whereby only subtotals are required.</para></listitem>
<listitem><para><guilabel>Reset defaults button:</guilabel> Reset all values to their defaults</para></listitem>
</itemizedlist>
</listitem>
commit 62b0a0cd0eb50b26199a83a969818ec96dcc7a20
Author: Christopher Lam <christopher.lck at gmail.com>
Date: Sun Jan 28 18:10:27 2018 +0800
Add link from introduction to scenarios.
diff --git a/guide/C/ch_reports.xml b/guide/C/ch_reports.xml
index 7da420f..a59bbde 100644
--- a/guide/C/ch_reports.xml
+++ b/guide/C/ch_reports.xml
@@ -121,6 +121,9 @@ Configuration.</para>
(This is now enabled by default.)</para>
</listitem>
</itemizedlist>
+ <para>For further ideas on how to use the Transaction to produce
+ common reports, see <link linkend='rpt_transaction'>Using the
+ Transaction Report</link>.</para>
</sect2>
<sect2 id="rpt_grp_assetsliabs">
<title>Assets & Liabilities Group</title>
commit 1248daf8c49038e4b6b84dd1a1b922af981c6b43
Author: Christopher Lam <christopher.lck at gmail.com>
Date: Wed Jan 24 22:12:15 2018 +0800
Rewrite introduction to TR and move Q&A to a separate section
diff --git a/guide/C/ch_reports.xml b/guide/C/ch_reports.xml
index 54c86ae..7da420f 100644
--- a/guide/C/ch_reports.xml
+++ b/guide/C/ch_reports.xml
@@ -72,11 +72,56 @@ Configuration.</para>
<sect1 id="rpt_standardrpts">
<title>Standard Reports Overview</title>
- <para>The standard reports that are included in <application>&app;</application> are presented here
- in the order that they appear in the <guimenu>Reports</guimenu> menu. In each section, a short
- description for each report is given, which explains what the report is
- intended to show, and its primary purpose.</para>
-
+ <para>The standard reports that are included in <application>&app;</application> are presented
+ in this chapter. For each report, a short description is given, which
+ explains what the report is intended to show and its primary purpose.
+ We begin with a description of the Transaction Report, which is an
+ all-purpose report with many features and settings that allow
+ sophisticated examination of the data in a file. </para>
+
+ <sect2 id="rpt_txnrept">
+ <title>Transaction Report</title>
+ <para>The Transaction Report is a fundamental report that allows
+ users to retrieve a wide variety of useful information from the
+ financial records. The report includes many features that allow
+ powerful and flexible reporting from the single basic report.</para>
+ <itemizedlist>
+ <listitem><para>Debit and Credit subtotals can be displayed, and
+ within a grouping section, if debit totals > credit totals, the
+ group subtotal will be displayed in the debit column.</para>
+ </listitem>
+ <listitem>
+ <para>Multiple data columns enable display of foreign currency
+ and original currency in separate columns.</para>
+ </listitem>
+ <listitem>
+ <para>Additional sortkeys e.g. sort by reconcile status
+ (unreconciled -> cleared -> reconciled), sort by weekday, allow
+ additional views into the financial records.</para>
+ </listitem>
+ <listitem>
+ <para>Full text filter enabled for description, notes and
+ memo, and for account full names. This allows easier selection
+ of source account names and tailored reporting. Filters
+ can optionally use full POSIX regular expressions.</para>
+ </listitem>
+ <listitem>
+ <para>Indenting of columns will indent the report columns for
+ easier understanding of grouping and sorting. (This
+ is now enabled by default)</para>
+ </listitem>
+ <listitem>
+ <para>Subtotal table is useful to understand the relationship
+ in the data e.g. account values in time series.</para>
+ </listitem>
+ <listitem>
+ <para>Filter by Closing Transactions will disallow closing
+ transactions (i.e. income & expense accounts to
+ equity) which should not routinely be included in transaction reports.
+ (This is now enabled by default.)</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
<sect2 id="rpt_grp_assetsliabs">
<title>Assets & Liabilities Group</title>
<para>Reports in this group provide general information about assets and liabilities.</para>
@@ -579,13 +624,6 @@ form the taxing authority uses for each income or expense account. Note that
you can see but not modify the "Tax related" checkbox in Edit --> Edit Account.</para>
</sect3>
-<sect3 id="rpt_txnrept">
-<title>Transaction Report</title>
-<para>This report lists the transactions in selected accounts during a
-specified financial period. When first run, this report loads no data,
-and the report options must be changed to retrieve information from the file.</para>
-</sect3>
-
<sect3 id="rpt_savedrpts">
<title>Saved Report Configurations</title>
<para>Selecting this will open a dialog with a list of available Saved Report
@@ -616,295 +654,214 @@ an empty report will be generated.</para>
</sect1>
<sect1 id="rpt_transaction">
- <title>Transaction Report</title>
- <sect2 id="rpt_TR_new">
- <title>New in Gnucash 3.0</title>
- <para>The Transaction Report has undergone several major upgrades, bug
- fixes, and new features. It aims to be the most versatile report to retrieve
- useful information from the financial records.</para>
- <itemizedlist>
- <listitem>
- <para><emphasis>New!</emphasis> Debit and Credit subtotals are now
- displayed in the appropriate columns. Within a grouping section, if
- debit totals > credit totals, the group subtotal will be displayed in
- the debit column.</para>
- </listitem>
- <listitem>
- <para><emphasis>New!</emphasis> Multiple data columns enable display of
- foreign currency and original currency in separate columns.</para>
- </listitem>
- <listitem>
- <para><emphasis>New!</emphasis> Additional sortkeys e.g. sort by
- reconcile status (unreconciled -> cleared -> reconciled), sort by
- weekday, allow additional views into the financial records.</para>
- </listitem>
- <listitem>
- <para><emphasis>New!</emphasis> Full text filter enabled for
- description, notes and memo, and for account full names. This allows
- easier selection of source account names and tailored reporting. Filters
- can optionally use full POSIX regular expressions.</para>
- </listitem>
- <listitem>
- <para><emphasis>New!</emphasis> Indenting of columns will indent the
- report columns for easier understanding of grouping and sorting. (This
- is now enabled by default)</para>
- </listitem>
- <listitem>
- <para><emphasis>New!</emphasis> Subtotal table is useful to understand
- the relationship in the data e.g. account values in time series.</para>
- </listitem>
- <listitem>
- <para><emphasis>New!</emphasis> Filter by Closing Transactions will
- disallow closing transactions (i.e. income & expense accounts to
- equity) which should not routinely be included in transaction reports.
- (This is now enabled by default.)</para>
- </listitem>
- <listitem>
- <para><emphasis>New!</emphasis> Options Summary will print a list of
- report options that were changed by the user. This is mainly useful to
- troubleshoot reports.</para>
- </listitem>
- <listitem>
- <para>Bugs fixed - numerous bugs identified were fixed; e.g. sign
- display was fixed, correct grouping of periodic dates.</para>
- </listitem>
- </itemizedlist>
- </sect2>
- <sect2 id="rpt_TR_newbie">
- <title>The Newbie Guide to the Transaction Report</title>
- <para>The Transaction Report can be heavily customised to produce most
- reports appropriate for personal finance and business bookkeeping purposes.
- It aims to retrieve and filter information from the database, and present
- transactions and totals, useful for the user and the accountant.</para>
- <para>The following newbie guide to the Transaction Report will assume the
- user has set up the chart of accounts according to conventional bookkeeping
- practice. For example, the following describes a typical household book with
- skeleton accounts. Further accounts will undoubtedly be necessary.</para>
- <table>
- <title>CHART OF ACCOUNTS</title>
- <tgroup cols='2' align='left' colsep='1' rowsep='1'>
- <thead>
- <row>
- <entry>Account Name</entry>
- <entry>Account Type</entry>
- </row>
- </thead>
- <tbody>
- <row>
- <entry>Asset</entry>
- <entry>ASSET (placeholder)</entry>
- </row>
- <row>
- <entry>Asset:Bank</entry>
- <entry>BANK</entry>
- </row>
- <row>
- <entry>Asset:Property</entry>
- <entry>ASSET</entry>
- </row>
- <row>
- <entry>Liability</entry>
- <entry>LIABILITY (placeholder)</entry>
- </row>
- <row>
- <entry>Liability:Credit Card</entry>
- <entry>CREDIT CARD</entry>
- </row>
- <row>
- <entry>Liability:Home Loan</entry>
- <entry>LIABILITY</entry>
- </row>
- <row>
- <entry>Income</entry>
- <entry>INCOME (placeholder)</entry>
- </row>
- <row>
- <entry>Income:Salary</entry>
- <entry>INCOME</entry>
- </row>
- <row>
- <entry>Income:Interest</entry>
- <entry>INCOME</entry>
- </row>
- <row>
- <entry>Expense</entry>
- <entry>EXPENSE (placeholder)</entry>
- </row>
- <row>
- <entry>Expense:Groceries</entry>
- <entry>EXPENSE</entry>
- </row>
- <row>
- <entry>Expense:Auto</entry>
- <entry>EXPENSE</entry>
- </row>
- <row>
- <entry>Expense:Medical</entry>
- <entry>EXPENSE</entry>
- </row>
- <row>
- <entry>Equity</entry>
- <entry>EQUITY (placeholder)</entry>
- </row>
- <row>
- <entry>Equity:Opening Balances</entry>
- <entry>EQUITY</entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- <para>Conventionally, the oldest transaction would be equity transfers from
- Equity:Opening Balances to Asset and Liability Accounts. Most subsequent
- transactions would be transfers from Income/Expense accounts to
- Assets/Liability accounts (representing day-to-day activity e.g. receiving
- salary, paying utility bill), or transfers between assets and liability
- accounts (representing movements between loans and assets, e.g. paying
- credit card bill, receiving a loan).</para>
+ <title>Using the Transaction Report</title>
+ <para>The Transaction Report can be heavily customised to produce most
+ reports appropriate for personal finance and business bookkeeping purposes.
+ It aims to retrieve and filter information from the database, and present
+ transactions and totals, useful for the user and the accountant.</para>
+ <para>The following guide to the Transaction Report will assume the
+ user has set up the chart of accounts according to conventional bookkeeping
+ practice. For example, the following describes a typical household book with
+ skeleton accounts. Further accounts will undoubtedly be necessary.</para>
+ <table>
+ <title>Sample Chart of Accounts</title>
+ <tgroup cols='2' align='left' colsep='1' rowsep='1'>
+ <thead>
+ <row>
+ <entry>Account Name</entry>
+ <entry>Account Type</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Asset</entry>
+ <entry>ASSET (placeholder)</entry>
+ </row>
+ <row>
+ <entry>Asset:Bank</entry>
+ <entry>BANK</entry>
+ </row>
+ <row>
+ <entry>Asset:Property</entry>
+ <entry>ASSET</entry>
+ </row>
+ <row>
+ <entry>Liability</entry>
+ <entry>LIABILITY (placeholder)</entry>
+ </row>
+ <row>
+ <entry>Liability:Credit Card</entry>
+ <entry>CREDIT CARD</entry>
+ </row>
+ <row>
+ <entry>Liability:Home Loan</entry>
+ <entry>LIABILITY</entry>
+ </row>
+ <row>
+ <entry>Income</entry>
+ <entry>INCOME (placeholder)</entry>
+ </row>
+ <row>
+ <entry>Income:Salary</entry>
+ <entry>INCOME</entry>
+ </row>
+ <row>
+ <entry>Income:Interest</entry>
+ <entry>INCOME</entry>
+ </row>
+ <row>
+ <entry>Expense</entry>
+ <entry>EXPENSE (placeholder)</entry>
+ </row>
+ <row>
+ <entry>Expense:Groceries</entry>
+ <entry>EXPENSE</entry>
+ </row>
+ <row>
+ <entry>Expense:Auto</entry>
+ <entry>EXPENSE</entry>
+ </row>
+ <row>
+ <entry>Expense:Medical</entry>
+ <entry>EXPENSE</entry>
+ </row>
+ <row>
+ <entry>Equity</entry>
+ <entry>EQUITY (placeholder)</entry>
+ </row>
+ <row>
+ <entry>Equity:Opening Balances</entry>
+ <entry>EQUITY</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>Conventionally, the oldest transaction would be equity transfers from
+ Equity:Opening Balances to Asset and Liability Accounts. Most subsequent
+ transactions would be transfers from Income/Expense accounts to
+ Assets/Liability accounts (representing day-to-day activity e.g. receiving
+ salary, paying utility bill), or transfers between assets and liability
+ accounts (representing movements between loans and assets, e.g. paying
+ credit card bill, receiving a loan).</para>
+ <sect2>
+ <title>Common scenarios</title>
<para>The following use cases will be illustrated, and the options to be
selected explained:</para>
- <qandaset defaultlabel='none'>
- <qandaentry>
- <question>
- <para>How much did I spend on various expense accounts last year?</para>
- </question>
- <answer>
- <para>The following sequence will select all subaccounts from the
- parent Expense account, select appropriate dates, and sort by account
- and date. This will usually be the most useful basic transaction
- report format.
- </para>
- <orderedlist>
- <listitem><para><emphasis>Accounts</emphasis>: click Expense, and
- Select Children</para></listitem>
- <listitem><para><emphasis>General</emphasis>: Choose relative dates
- “Start of Previous Year†and “End of Previous Yearâ€</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis>: Primary Key: Accounts,
- Secondary Key: Date</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis>: Primary Key Subtotal:
- Enabled, Secondary Key Subtotal: None </para></listitem>
- </orderedlist>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>How much did I spend on various expenses, grouped by month?</para>
- </question>
- <answer>
- <para>The following will modify the above Transaction Report to use
- a secondary grouping strategy. The first grouping (i.e. Primary Key =
- Accounts, Subtotal = enabled) will group transactions from the same
- accounts, whereas the secondary grouping (i.e. Secondary Key = Date,
- Subtotal = Monthly) will also calculate monthly sums within each
- account.</para>
- <orderedlist>
- <listitem><para>Select options as above</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis>: Secondary Key
- Subtotal: Monthly</para></listitem>
- </orderedlist>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>How much did I spend on various expenses, with monthly
- comparison?</para>
- </question>
- <answer>
- <para>The Display / Subtotal Summary Grid adds a subtotal summary
- table, which will ease comparison of accounts across date periods.
- This displays the same subtotal calculations as the main table,
- presented in a grid structure.
- </para>
- <orderedlist>
- <listitem><para>As above</para></listitem>
- <listitem><para><emphasis>Display</emphasis>: Subtotal Summary Grid</para></listitem>
- </orderedlist>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>Can I select tagged accounts or transactions for reporting?</para>
- </question>
- <answer>
- <para>New to Gnucash 3.0, accounts and transactions can be filtered
- for reporting according to account full name (e.g. ":Business:" will
- select account structure Income:Business:Sales, Income:Business:Grants,
- Expenses:Business:Rent, Expenses:Business:Utilities) or transaction
- description/notes/memo (select transactions tagged #gift or #travel).
- The filtering text may be either a standard string, or a POSIX regular
- expression.
- </para>
- <orderedlist>
- <listitem><para><emphasis>Filter</emphasis>: Select either Account
- Name Filter, or Transaction Filter. Optionally toggle the regular
- expression check boxes to toggle full POSIX regex matching.</para></listitem>
- </orderedlist>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>I want a list of transactions showing my income for the year 1
- July 2015 to 30 June 2016, grouped by quarter</para>
- </question>
- <answer>
- <para>Generally, the Accounts selection box will be used to specify
- the source accounts containing transactions that require reporting.
- Selecting Income, then "Select Children" will include all
- subaccounts from the Income account, e.g. Income:Freelance,
- Income:Salary, Income:Interest can all be included. Please
- note the account list is saved between <application>&app;</application>
- sessions. If the account structure is modified (e.g. moving
- accounts, deleting/adding new accounts), the account selection
- must usually be recreated.</para>
- <orderedlist>
- <listitem><para><emphasis>Accounts</emphasis>: click Income, and
- Select Children</para></listitem>
- <listitem><para><emphasis>General</emphasis>: Choose absolute dates
- “01/07/2015†to “30/06/2016â€</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis>: Primary Key: Accounts,
- Secondary Key: Date</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis>: Primary Key Subtotal:
- Enabled, Secondary Date Subtotal: Quarter</para></listitem>
- </orderedlist>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>I want a list of transactions showing income transactions,
- grouped by day of week</para>
- </question>
- <answer>
- <para>This report may be pertinent to businesses operating with
- variable daily income, e.g. food industry. The weekday sortkey will
- allow subtotal comparisons according to day of week.</para>
- <orderedlist>
- <listitem><para>As above</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis>: Secondary Key
- Subtotal: Weekday</para></listitem>
- </orderedlist>
- </answer>
- </qandaentry>
- <qandaentry>
- <question>
- <para>I want to print my bank account or credit card transactions,
- similar to the reconciliation report.</para>
- </question>
- <answer>
- <para>This sortkey 'reconcile status' will separate reconciled,
- cleared and unreconciled transactions. This report may be useful in
- producing a printable reconciliation report.</para>
- <orderedlist>
- <listitem><para><emphasis>Accounts</emphasis>: select the relevant
- bank or credit card account</para></listitem>
- <listitem><para><emphasis>General</emphasis>: Choose appropriate dates
- e.g. past 3 months</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis>: Primary Key: Reconcile
- Status, Secondary Key: Date</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis> Secondary Date
- Subtotal: None</para></listitem>
- </orderedlist>
- </answer>
- </qandaentry>
- </qandaset>
+ <sect3>
+ <title>Using the Transaction Report to show previous year
+ expenses</title>
+ <para>The Transaction Report can show how much was spent on
+ expense accounts last year. This will usually be the most useful
+ basic transaction report format. To create this report:
+ </para>
+ <orderedlist>
+ <listitem><para>Open the report options, from the
+ <emphasis>Accounts</emphasis> tab, click the Expense
+ placeholder account and <emphasis>Select Children</emphasis>.</para></listitem>
+ <listitem><para>From the <emphasis>General</emphasis> tab,
+ Choose relative dates “Start of Previous Year†and “End of
+ Previous Yearâ€.</para></listitem>
+ <listitem><para>From the <emphasis>Sorting</emphasis> tab,
+ set <emphasis>Primary Key</emphasis> to Accounts, and enable
+ <emphasis>Primary Key Subtotal</emphasis>.
+ </para></listitem>
+ <listitem><para>Set the <emphasis>Secondary Key</emphasis> to
+ Date, and set the <emphasis>Secondary Key Subtotal</emphasis>
+ to None. </para></listitem>
+ </orderedlist>
+ </sect3>
+ <sect3>
+ <title>Secondary level grouping</title>
+ <para>The following will modify the above Transaction Report to use
+ a secondary grouping strategy. The first grouping (i.e. Primary Key =
+ Accounts, Subtotal = enabled) will group transactions from the same
+ accounts, whereas the secondary grouping (i.e. Secondary Key = Date,
+ Subtotal = Monthly) will also calculate monthly sums within each
+ account.</para>
+ <orderedlist>
+ <listitem><para>Select options as above</para></listitem>
+ <listitem><para>From the <emphasis>Sorting</emphasis> tab,
+ set <emphasis>Secondary Key Subtotal</emphasis> to Monthly
+ </para></listitem>
+ </orderedlist>
+ </sect3>
+ <sect3>
+ <title>Using secondary grouping for periodic comparison</title>
+ <para>The Display / Subtotal Summary Grid adds a subtotal summary
+ table, which will ease comparison of accounts across date periods.
+ This displays the same subtotal calculations as the main table,
+ presented in a grid structure.
+ </para>
+ <orderedlist>
+ <listitem><para>Select options as above</para></listitem>
+ <listitem><para>From the <emphasis>Display</emphasis> tab,
+ enable the <emphasis>Subtotal Summary Grid</emphasis>.</para>
+ </listitem>
+ </orderedlist>
+ </sect3>
+ <sect3>
+ <title>Use filtering to limit accounts and transactions</title>
+ <para>Accounts and transactions can be filtered for reporting
+ according to account full name (e.g. ":Business:" will
+ select account structure Income:Business:Sales, Income:Business:Grants,
+ Expenses:Business:Rent, Expenses:Business:Utilities) or transaction
+ description/notes/memo (select transactions tagged #gift).
+ The filtering text may be either a standard string, or a POSIX regular
+ expression.</para>
+ <orderedlist>
+ <listitem><para>From the <emphasis>Filter</emphasis> tab,
+ complete the <emphasis>Account Name Filter</emphasis>, or
+ <emphasis>Transaction Filter</emphasis>. Optionally toggle the
+ regular expression check boxes to toggle full POSIX regex
+ matching. Regular expressions will allow more complex
+ queries e.g. the transaction filter can be set to
+ (#gift|#travel) which will filter transactions with either
+ #gift or #travel. They can be complex and are best learned
+ from external guides.</para>
+ </listitem>
+ </orderedlist>
+ </sect3>
+ <sect3>
+ <title>I want a list of transactions showing income transactions,
+ grouped by day of week</title>
+ <para>This report may be pertinent to businesses operating with
+ variable daily income, e.g. food industry. The weekday sortkey will
+ allow subtotal comparisons according to day of week.</para>
+ <orderedlist>
+ <listitem><para>From the <emphasis>Accounts</emphasis> tab,
+ click Income, and Select Children</para></listitem>
+ <listitem><para>From <emphasis>General</emphasis> tab,
+ choose appropriate dates.</para></listitem>
+ <listitem><para>From the <emphasis>Sorting</emphasis> tab,
+ set <emphasis>Primary Key</emphasis> to Accounts, and
+ <emphasis>Secondary Key</emphasis> to Date</para></listitem>
+ <listitem><para>From the <emphasis>Sorting</emphasis> tab,
+ set <emphasis>Secondary Key Subtotal</emphasis> to Weekday</para></listitem>
+ </orderedlist>
+ </sect3>
+ <sect3>
+ <title>Using the Transaction Report to generate a
+ reconciliation statement.</title>
+ <para>This sortkey 'reconcile status' will separate reconciled,
+ cleared and unreconciled transactions. This report may be useful
+ in producing a printable reconciliation report.</para>
+ <para>Alternatively, the <emphasis>Reconciliation Report
+ </emphasis> will preset these defaults and requires only the
+ Accounts selection.
+ </para>
+ <orderedlist>
+ <listitem><para>From the <emphasis>Accounts</emphasis> tab,
+ select the relevant bank or credit card account</para></listitem>
+ <listitem><para>From the <emphasis>General</emphasis> tab,
+ choose an appropriate date range e.g. past 3 months</para></listitem>
+ <listitem><para>From the <emphasis>Sorting</emphasis> tab,
+ set the <emphasis>Primary Key</emphasis> to Reconcile
+ Status, <emphasis>Primary Key Subtotal</emphasis> to enabled,
+ and set the <emphasis>Secondary Key</emphasis> to Date. The
+ <emphasis>Secondary Date Subtotal</emphasis> is left to None
+ </para></listitem>
+ </orderedlist>
+ </sect3>
</sect2>
</sect1>
</chapter>
commit fffa817cd5d98a493d198f998fd77d79949a0735
Author: christopherlam <christopher.lck at gmail.com>
Date: Mon Jan 22 13:34:45 2018 +0800
typo - this is called subtotal summary grid
diff --git a/guide/C/ch_reports.xml b/guide/C/ch_reports.xml
index 2ba938f..54c86ae 100644
--- a/guide/C/ch_reports.xml
+++ b/guide/C/ch_reports.xml
@@ -816,7 +816,7 @@ an empty report will be generated.</para>
</para>
<orderedlist>
<listitem><para>As above</para></listitem>
- <listitem><para><emphasis>Display</emphasis>: Subtotal Table enabled</para></listitem>
+ <listitem><para><emphasis>Display</emphasis>: Subtotal Summary Grid</para></listitem>
</orderedlist>
</answer>
</qandaentry>
commit b9a2721b636f0d7bb8ef28dbc3b9870b8a82be38
Author: christopherlam <christopher.lck at gmail.com>
Date: Mon Jan 22 13:33:21 2018 +0800
fix typo - subtotal grid in Display tab
diff --git a/guide/C/ch_reports.xml b/guide/C/ch_reports.xml
index 21d8c2d..2ba938f 100644
--- a/guide/C/ch_reports.xml
+++ b/guide/C/ch_reports.xml
@@ -816,7 +816,7 @@ an empty report will be generated.</para>
</para>
<orderedlist>
<listitem><para>As above</para></listitem>
- <listitem><para><emphasis>General</emphasis>: Subtotal Table enabled</para></listitem>
+ <listitem><para><emphasis>Display</emphasis>: Subtotal Table enabled</para></listitem>
</orderedlist>
</answer>
</qandaentry>
commit 7a0077d7ec236c60f54bcbb1eaeeab60fd62cd41
Author: Christopher Lam <christopher.lck at gmail.com>
Date: Mon Jan 22 08:39:32 2018 +0800
improve wording for Q&A
diff --git a/guide/C/ch_reports.xml b/guide/C/ch_reports.xml
index 0230370..21d8c2d 100644
--- a/guide/C/ch_reports.xml
+++ b/guide/C/ch_reports.xml
@@ -770,8 +770,8 @@ an empty report will be generated.</para>
<answer>
<para>The following sequence will select all subaccounts from the
parent Expense account, select appropriate dates, and sort by account
- and date. This will usually be the most
- basic transaction report format.
+ and date. This will usually be the most useful basic transaction
+ report format.
</para>
<orderedlist>
<listitem><para><emphasis>Accounts</emphasis>: click Expense, and
@@ -790,9 +790,12 @@ an empty report will be generated.</para>
<para>How much did I spend on various expenses, grouped by month?</para>
</question>
<answer>
- <para>The following sequence will modify the above Transaction Report
- options to subdivide each account into monthly groups and separately
- produce subtotals.</para>
+ <para>The following will modify the above Transaction Report to use
+ a secondary grouping strategy. The first grouping (i.e. Primary Key =
+ Accounts, Subtotal = enabled) will group transactions from the same
+ accounts, whereas the secondary grouping (i.e. Secondary Key = Date,
+ Subtotal = Monthly) will also calculate monthly sums within each
+ account.</para>
<orderedlist>
<listitem><para>Select options as above</para></listitem>
<listitem><para><emphasis>Sorting</emphasis>: Secondary Key
@@ -806,10 +809,10 @@ an empty report will be generated.</para>
comparison?</para>
</question>
<answer>
- <para>The following sequence will add a subtotal summary table in a
- grid, which will ease comparison of accounts across date periods.
- The subtotal summary grid displays the same subtotal calculations as
- above, presented in a grid structure.
+ <para>The Display / Subtotal Summary Grid adds a subtotal summary
+ table, which will ease comparison of accounts across date periods.
+ This displays the same subtotal calculations as the main table,
+ presented in a grid structure.
</para>
<orderedlist>
<listitem><para>As above</para></listitem>
@@ -824,7 +827,7 @@ an empty report will be generated.</para>
<answer>
<para>New to Gnucash 3.0, accounts and transactions can be filtered
for reporting according to account full name (e.g. ":Business:" will
- select account structure Income:Business:Sales Income:Business:Grants,
+ select account structure Income:Business:Sales, Income:Business:Grants,
Expenses:Business:Rent, Expenses:Business:Utilities) or transaction
description/notes/memo (select transactions tagged #gift or #travel).
The filtering text may be either a standard string, or a POSIX regular
@@ -843,6 +846,15 @@ an empty report will be generated.</para>
July 2015 to 30 June 2016, grouped by quarter</para>
</question>
<answer>
+ <para>Generally, the Accounts selection box will be used to specify
+ the source accounts containing transactions that require reporting.
+ Selecting Income, then "Select Children" will include all
+ subaccounts from the Income account, e.g. Income:Freelance,
+ Income:Salary, Income:Interest can all be included. Please
+ note the account list is saved between <application>&app;</application>
+ sessions. If the account structure is modified (e.g. moving
+ accounts, deleting/adding new accounts), the account selection
+ must usually be recreated.</para>
<orderedlist>
<listitem><para><emphasis>Accounts</emphasis>: click Income, and
Select Children</para></listitem>
@@ -857,7 +869,7 @@ an empty report will be generated.</para>
</qandaentry>
<qandaentry>
<question>
- <para>I wish a list of transactions showing income transactions,
+ <para>I want a list of transactions showing income transactions,
grouped by day of week</para>
</question>
<answer>
@@ -873,7 +885,7 @@ an empty report will be generated.</para>
</qandaentry>
<qandaentry>
<question>
- <para>I wish to print my bank account or credit card transactions,
+ <para>I want to print my bank account or credit card transactions,
similar to the reconciliation report.</para>
</question>
<answer>
@@ -883,8 +895,8 @@ an empty report will be generated.</para>
<orderedlist>
<listitem><para><emphasis>Accounts</emphasis>: select the relevant
bank or credit card account</para></listitem>
- <listitem><para><emphasis>General</emphasis>: Choose absolute dates
- “01/07/2015†to “30/06/2016â€</para></listitem>
+ <listitem><para><emphasis>General</emphasis>: Choose appropriate dates
+ e.g. past 3 months</para></listitem>
<listitem><para><emphasis>Sorting</emphasis>: Primary Key: Reconcile
Status, Secondary Key: Date</para></listitem>
<listitem><para><emphasis>Sorting</emphasis> Secondary Date
commit ab2539fcc2ba6827ec19b5259727d0c8afb149a2
Author: Christopher Lam <christopher.lck at gmail.com>
Date: Mon Jan 22 08:31:12 2018 +0800
max-width 80
diff --git a/guide/C/ch_reports.xml b/guide/C/ch_reports.xml
index 0abacb6..0230370 100644
--- a/guide/C/ch_reports.xml
+++ b/guide/C/ch_reports.xml
@@ -1,10 +1,11 @@
<!--
(Do not remove this comment block.)
Version: 2.6.15
- Last modified: October 31, 2016
+ Last modified: January, 2018
Maintainers:
Chris Lyttle <chris at wilddev.net>
Chris Good <chris.good at ozemail.com.au>
+ Christopher Lam
Author:
Jon Lapham <lapham at extracta.com.br>
Originally designed by Carol Champagne.
@@ -618,41 +619,67 @@ an empty report will be generated.</para>
<title>Transaction Report</title>
<sect2 id="rpt_TR_new">
<title>New in Gnucash 3.0</title>
- <para>The Transaction Report has undergone several major upgrades, bug fixes, and new features. It aims to be the most versatile report to retrieve useful information from the financial records.</para>
+ <para>The Transaction Report has undergone several major upgrades, bug
+ fixes, and new features. It aims to be the most versatile report to retrieve
+ useful information from the financial records.</para>
<itemizedlist>
<listitem>
- <para><emphasis>New!</emphasis> Debit and Credit subtotals are now displayed in the appropriate columns. Within a grouping section, if debit totals > credit totals, the group subtotal will be displayed in the debit column.</para>
+ <para><emphasis>New!</emphasis> Debit and Credit subtotals are now
+ displayed in the appropriate columns. Within a grouping section, if
+ debit totals > credit totals, the group subtotal will be displayed in
+ the debit column.</para>
</listitem>
<listitem>
- <para><emphasis>New!</emphasis> Multiple data columns enable display of foreign currency and original currency in separate columns.</para>
+ <para><emphasis>New!</emphasis> Multiple data columns enable display of
+ foreign currency and original currency in separate columns.</para>
</listitem>
<listitem>
- <para><emphasis>New!</emphasis> Additional sortkeys e.g. sort by reconcile status (unreconciled -> cleared -> reconciled), sort by weekday, allow additional views into the financial records.</para>
+ <para><emphasis>New!</emphasis> Additional sortkeys e.g. sort by
+ reconcile status (unreconciled -> cleared -> reconciled), sort by
+ weekday, allow additional views into the financial records.</para>
</listitem>
<listitem>
- <para><emphasis>New!</emphasis> Full text filter enabled for description, notes and memo, and for account full names. This allows easier selection of source account names and tailored reporting. Filters can optionally use full POSIX regular expressions.</para>
+ <para><emphasis>New!</emphasis> Full text filter enabled for
+ description, notes and memo, and for account full names. This allows
+ easier selection of source account names and tailored reporting. Filters
+ can optionally use full POSIX regular expressions.</para>
</listitem>
<listitem>
- <para><emphasis>New!</emphasis> Indenting of columns will indent the report columns for easier understanding of grouping and sorting. (This is now enabled by default)</para>
+ <para><emphasis>New!</emphasis> Indenting of columns will indent the
+ report columns for easier understanding of grouping and sorting. (This
+ is now enabled by default)</para>
</listitem>
<listitem>
- <para><emphasis>New!</emphasis> Subtotal table is useful to understand the relationship in the data e.g. account values in time series.</para>
+ <para><emphasis>New!</emphasis> Subtotal table is useful to understand
+ the relationship in the data e.g. account values in time series.</para>
</listitem>
<listitem>
- <para><emphasis>New!</emphasis> Filter by Closing Transactions will disallow closing transactions (i.e. income & expense accounts to equity) which should not routinely be included in transaction reports. (This is now enabled by default.)</para>
+ <para><emphasis>New!</emphasis> Filter by Closing Transactions will
+ disallow closing transactions (i.e. income & expense accounts to
+ equity) which should not routinely be included in transaction reports.
+ (This is now enabled by default.)</para>
</listitem>
<listitem>
- <para><emphasis>New!</emphasis> Options Summary will print a list of report options that were changed by the user. This is mainly useful to troubleshoot reports.</para>
+ <para><emphasis>New!</emphasis> Options Summary will print a list of
+ report options that were changed by the user. This is mainly useful to
+ troubleshoot reports.</para>
</listitem>
<listitem>
- <para>Bugs fixed - numerous bugs identified were fixed; e.g. sign display was fixed, correct grouping of periodic dates.</para>
+ <para>Bugs fixed - numerous bugs identified were fixed; e.g. sign
+ display was fixed, correct grouping of periodic dates.</para>
</listitem>
</itemizedlist>
</sect2>
<sect2 id="rpt_TR_newbie">
<title>The Newbie Guide to the Transaction Report</title>
- <para>The Transaction Report can be heavily customised to produce most reports appropriate for personal finance and business bookkeeping purposes. It aims to retrieve and filter information from the database, and present transactions and totals, useful for the user and the accountant.</para>
- <para>The following newbie guide to the Transaction Report will assume the user has set up the chart of accounts according to conventional bookkeeping practice. For example, the following describes a typical household book with skeleton accounts. Further accounts will undoubtedly be necessary.</para>
+ <para>The Transaction Report can be heavily customised to produce most
+ reports appropriate for personal finance and business bookkeeping purposes.
+ It aims to retrieve and filter information from the database, and present
+ transactions and totals, useful for the user and the accountant.</para>
+ <para>The following newbie guide to the Transaction Report will assume the
+ user has set up the chart of accounts according to conventional bookkeeping
+ practice. For example, the following describes a typical household book with
+ skeleton accounts. Further accounts will undoubtedly be necessary.</para>
<table>
<title>CHART OF ACCOUNTS</title>
<tgroup cols='2' align='left' colsep='1' rowsep='1'>
@@ -726,23 +753,35 @@ an empty report will be generated.</para>
</tbody>
</tgroup>
</table>
- <para>Conventionally, the oldest transaction would be equity transfers from Equity:Opening Balances to Asset and Liability Accounts. Most subsequent transactions would be transfers from Income/Expense accounts to Assets/Liability accounts (representing day-to-day activity e.g. receiving salary, paying utility bill), or transfers between assets and liability accounts (representing movements between loans and assets, e.g. paying credit card bill, receiving a loan).</para>
- <para>The following use cases will be illustrated, and the options to be selected explained:</para>
+ <para>Conventionally, the oldest transaction would be equity transfers from
+ Equity:Opening Balances to Asset and Liability Accounts. Most subsequent
+ transactions would be transfers from Income/Expense accounts to
+ Assets/Liability accounts (representing day-to-day activity e.g. receiving
+ salary, paying utility bill), or transfers between assets and liability
+ accounts (representing movements between loans and assets, e.g. paying
+ credit card bill, receiving a loan).</para>
+ <para>The following use cases will be illustrated, and the options to be
+ selected explained:</para>
<qandaset defaultlabel='none'>
<qandaentry>
<question>
<para>How much did I spend on various expense accounts last year?</para>
</question>
<answer>
- <para>The following sequence will select all subaccounts from the parent Expense account,
- select appropriate dates, and sort by account and date. This will usually be the most
+ <para>The following sequence will select all subaccounts from the
+ parent Expense account, select appropriate dates, and sort by account
+ and date. This will usually be the most
basic transaction report format.
</para>
<orderedlist>
- <listitem><para><emphasis>Accounts</emphasis>: click Expense, and Select Children</para></listitem>
- <listitem><para><emphasis>General</emphasis>: Choose relative dates “Start of Previous Year†and “End of Previous Yearâ€</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis>: Primary Key: Accounts, Secondary Key: Date</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis>: Primary Key Subtotal: Enabled, Secondary Key Subtotal: None </para></listitem>
+ <listitem><para><emphasis>Accounts</emphasis>: click Expense, and
+ Select Children</para></listitem>
+ <listitem><para><emphasis>General</emphasis>: Choose relative dates
+ “Start of Previous Year†and “End of Previous Yearâ€</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis>: Primary Key: Accounts,
+ Secondary Key: Date</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis>: Primary Key Subtotal:
+ Enabled, Secondary Key Subtotal: None </para></listitem>
</orderedlist>
</answer>
</qandaentry>
@@ -751,22 +790,26 @@ an empty report will be generated.</para>
<para>How much did I spend on various expenses, grouped by month?</para>
</question>
<answer>
- <para>The following sequence will modify the above Transaction Report options
- to subdivide each account into monthly groups and separately produce subtotals.</para>
+ <para>The following sequence will modify the above Transaction Report
+ options to subdivide each account into monthly groups and separately
+ produce subtotals.</para>
<orderedlist>
<listitem><para>Select options as above</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis>: Secondary Key Subtotal: Monthly</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis>: Secondary Key
+ Subtotal: Monthly</para></listitem>
</orderedlist>
</answer>
</qandaentry>
<qandaentry>
<question>
- <para>How much did I spend on various expenses, with monthly comparison?</para>
+ <para>How much did I spend on various expenses, with monthly
+ comparison?</para>
</question>
<answer>
- <para>The following sequence will add a subtotal summary table in a grid, which
- will ease comparison of accounts across date periods. The subtotal summary grid
- displays the same subtotal calculations as above, presented in a grid structure.
+ <para>The following sequence will add a subtotal summary table in a
+ grid, which will ease comparison of accounts across date periods.
+ The subtotal summary grid displays the same subtotal calculations as
+ above, presented in a grid structure.
</para>
<orderedlist>
<listitem><para>As above</para></listitem>
@@ -779,57 +822,73 @@ an empty report will be generated.</para>
<para>Can I select tagged accounts or transactions for reporting?</para>
</question>
<answer>
- <para>New to Gnucash 3.0, accounts and transactions can be filtered for reporting according
- to account full name (e.g. ":Business:" will select account structure Income:Business:Sales
- Income:Business:Grants, Expenses:Business:Rent, Expenses:Business:Utilities) or transaction
- description/notes/memo (select transactions tagged #gift or #travel). The filtering text
- may be either a standard string, or a POSIX regular expression matcher.
+ <para>New to Gnucash 3.0, accounts and transactions can be filtered
+ for reporting according to account full name (e.g. ":Business:" will
+ select account structure Income:Business:Sales Income:Business:Grants,
+ Expenses:Business:Rent, Expenses:Business:Utilities) or transaction
+ description/notes/memo (select transactions tagged #gift or #travel).
+ The filtering text may be either a standard string, or a POSIX regular
+ expression.
</para>
<orderedlist>
- <listitem><para><emphasis>Filter</emphasis>: Select either Account Name Filter, or
- Transaction Filter. Optionally toggle the regular expression check boxes to toggle
- full POSIX regex matching.</para></listitem>
+ <listitem><para><emphasis>Filter</emphasis>: Select either Account
+ Name Filter, or Transaction Filter. Optionally toggle the regular
+ expression check boxes to toggle full POSIX regex matching.</para></listitem>
</orderedlist>
</answer>
</qandaentry>
<qandaentry>
<question>
- <para>I wish a list of transactions showing my income for the year 1 July 2015 to 30 June 2016, grouped by quarter</para>
+ <para>I want a list of transactions showing my income for the year 1
+ July 2015 to 30 June 2016, grouped by quarter</para>
</question>
<answer>
<orderedlist>
- <listitem><para><emphasis>Accounts</emphasis>: click Income, and Select Children</para></listitem>
- <listitem><para><emphasis>General</emphasis>: Choose absolute dates “01/07/2015†to “30/06/2016â€</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis>: Primary Key: Accounts, Secondary Key: Date</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis>: Primary Key Subtotal: Enabled, Secondary Date Subtotal: Quarter</para></listitem>
+ <listitem><para><emphasis>Accounts</emphasis>: click Income, and
+ Select Children</para></listitem>
+ <listitem><para><emphasis>General</emphasis>: Choose absolute dates
+ “01/07/2015†to “30/06/2016â€</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis>: Primary Key: Accounts,
+ Secondary Key: Date</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis>: Primary Key Subtotal:
+ Enabled, Secondary Date Subtotal: Quarter</para></listitem>
</orderedlist>
</answer>
</qandaentry>
<qandaentry>
<question>
- <para>I wish a list of transactions showing income transactions, grouped by day of week</para>
+ <para>I wish a list of transactions showing income transactions,
+ grouped by day of week</para>
</question>
<answer>
- <para>This report may be pertinent to businesses operating with variable daily income, e.g. food industry.
- The weekday sortkey will allow subtotal comparisons according to day of week.</para>
+ <para>This report may be pertinent to businesses operating with
+ variable daily income, e.g. food industry. The weekday sortkey will
+ allow subtotal comparisons according to day of week.</para>
<orderedlist>
<listitem><para>As above</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis>: Secondary Key Subtotal: Weekday</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis>: Secondary Key
+ Subtotal: Weekday</para></listitem>
</orderedlist>
</answer>
</qandaentry>
<qandaentry>
<question>
- <para>I wish to print my bank account or credit card transactions, similar to the reconciliation report.</para>
+ <para>I wish to print my bank account or credit card transactions,
+ similar to the reconciliation report.</para>
</question>
<answer>
- <para>This sortkey 'reconcile status' will separate reconciled, cleared and unreconciled transactions.
- This report may be useful in producing a printable reconciliation report.</para>
+ <para>This sortkey 'reconcile status' will separate reconciled,
+ cleared and unreconciled transactions. This report may be useful in
+ producing a printable reconciliation report.</para>
<orderedlist>
- <listitem><para><emphasis>Accounts</emphasis>: select the relevant bank or credit card account</para></listitem>
- <listitem><para><emphasis>General</emphasis>: Choose absolute dates “01/07/2015†to “30/06/2016â€</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis>: Primary Key: Reconcile Status, Secondary Key: Date</para></listitem>
- <listitem><para><emphasis>Sorting</emphasis> Secondary Date Subtotal: None</para></listitem>
+ <listitem><para><emphasis>Accounts</emphasis>: select the relevant
+ bank or credit card account</para></listitem>
+ <listitem><para><emphasis>General</emphasis>: Choose absolute dates
+ “01/07/2015†to “30/06/2016â€</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis>: Primary Key: Reconcile
+ Status, Secondary Key: Date</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis> Secondary Date
+ Subtotal: None</para></listitem>
</orderedlist>
</answer>
</qandaentry>
commit 8bb6d01acaf490f8bec9f731c06193f775d6eabf
Author: Christopher Lam <christopher.lck at gmail.com>
Date: Sun Jan 21 16:13:56 2018 +0800
add Q&A for txn text search
diff --git a/guide/C/ch_reports.xml b/guide/C/ch_reports.xml
index 973eaa3..0abacb6 100644
--- a/guide/C/ch_reports.xml
+++ b/guide/C/ch_reports.xml
@@ -776,6 +776,24 @@ an empty report will be generated.</para>
</qandaentry>
<qandaentry>
<question>
+ <para>Can I select tagged accounts or transactions for reporting?</para>
+ </question>
+ <answer>
+ <para>New to Gnucash 3.0, accounts and transactions can be filtered for reporting according
+ to account full name (e.g. ":Business:" will select account structure Income:Business:Sales
+ Income:Business:Grants, Expenses:Business:Rent, Expenses:Business:Utilities) or transaction
+ description/notes/memo (select transactions tagged #gift or #travel). The filtering text
+ may be either a standard string, or a POSIX regular expression matcher.
+ </para>
+ <orderedlist>
+ <listitem><para><emphasis>Filter</emphasis>: Select either Account Name Filter, or
+ Transaction Filter. Optionally toggle the regular expression check boxes to toggle
+ full POSIX regex matching.</para></listitem>
+ </orderedlist>
+ </answer>
+ </qandaentry>
+ <qandaentry>
+ <question>
<para>I wish a list of transactions showing my income for the year 1 July 2015 to 30 June 2016, grouped by quarter</para>
</question>
<answer>
@@ -802,14 +820,16 @@ an empty report will be generated.</para>
</qandaentry>
<qandaentry>
<question>
- <para>I wish to print my bank account or credit card transactions, reconciled first, then cleared, then unreconciled transactions</para>
+ <para>I wish to print my bank account or credit card transactions, similar to the reconciliation report.</para>
</question>
<answer>
+ <para>This sortkey 'reconcile status' will separate reconciled, cleared and unreconciled transactions.
+ This report may be useful in producing a printable reconciliation report.</para>
<orderedlist>
<listitem><para><emphasis>Accounts</emphasis>: select the relevant bank or credit card account</para></listitem>
<listitem><para><emphasis>General</emphasis>: Choose absolute dates “01/07/2015†to “30/06/2016â€</para></listitem>
<listitem><para><emphasis>Sorting</emphasis>: Primary Key: Reconcile Status, Secondary Key: Date</para></listitem>
- <listitem><para><emphasis>Secondary</emphasis> Date Subtotal: None</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis> Secondary Date Subtotal: None</para></listitem>
</orderedlist>
</answer>
</qandaentry>
commit 98692dea3128bf3ff7afb5bf8efa5c7f1b6e411b
Author: Christopher Lam <christopher.lck at gmail.com>
Date: Sun Jan 21 15:01:14 2018 +0800
convert option sequence to lists
diff --git a/guide/C/ch_reports.xml b/guide/C/ch_reports.xml
index 7ec40a6..973eaa3 100644
--- a/guide/C/ch_reports.xml
+++ b/guide/C/ch_reports.xml
@@ -728,16 +728,22 @@ an empty report will be generated.</para>
</table>
<para>Conventionally, the oldest transaction would be equity transfers from Equity:Opening Balances to Asset and Liability Accounts. Most subsequent transactions would be transfers from Income/Expense accounts to Assets/Liability accounts (representing day-to-day activity e.g. receiving salary, paying utility bill), or transfers between assets and liability accounts (representing movements between loans and assets, e.g. paying credit card bill, receiving a loan).</para>
<para>The following use cases will be illustrated, and the options to be selected explained:</para>
- <qandaset>
+ <qandaset defaultlabel='none'>
<qandaentry>
<question>
<para>How much did I spend on various expense accounts last year?</para>
</question>
<answer>
- <para>Accounts: click Expense, and Select Children</para>
- <para>General: Choose relative dates “Start of Previous Year†and “End of Previous Yearâ€</para>
- <para>Sorting: Primary Key: Accounts, Secondary Key: Date</para>
- <para>Sorting: Primary Key Subtotal: Enabled, Secondary Key Subtotal: None </para>
+ <para>The following sequence will select all subaccounts from the parent Expense account,
+ select appropriate dates, and sort by account and date. This will usually be the most
+ basic transaction report format.
+ </para>
+ <orderedlist>
+ <listitem><para><emphasis>Accounts</emphasis>: click Expense, and Select Children</para></listitem>
+ <listitem><para><emphasis>General</emphasis>: Choose relative dates “Start of Previous Year†and “End of Previous Yearâ€</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis>: Primary Key: Accounts, Secondary Key: Date</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis>: Primary Key Subtotal: Enabled, Secondary Key Subtotal: None </para></listitem>
+ </orderedlist>
</answer>
</qandaentry>
<qandaentry>
@@ -745,8 +751,12 @@ an empty report will be generated.</para>
<para>How much did I spend on various expenses, grouped by month?</para>
</question>
<answer>
- <para>As above</para>
- <para>Sorting: Secondary Key Subtotal: Monthly</para>
+ <para>The following sequence will modify the above Transaction Report options
+ to subdivide each account into monthly groups and separately produce subtotals.</para>
+ <orderedlist>
+ <listitem><para>Select options as above</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis>: Secondary Key Subtotal: Monthly</para></listitem>
+ </orderedlist>
</answer>
</qandaentry>
<qandaentry>
@@ -754,8 +764,14 @@ an empty report will be generated.</para>
<para>How much did I spend on various expenses, with monthly comparison?</para>
</question>
<answer>
- <para> As above</para>
- <para>General: Subtotal Table enabled</para>
+ <para>The following sequence will add a subtotal summary table in a grid, which
+ will ease comparison of accounts across date periods. The subtotal summary grid
+ displays the same subtotal calculations as above, presented in a grid structure.
+ </para>
+ <orderedlist>
+ <listitem><para>As above</para></listitem>
+ <listitem><para><emphasis>General</emphasis>: Subtotal Table enabled</para></listitem>
+ </orderedlist>
</answer>
</qandaentry>
<qandaentry>
@@ -763,10 +779,12 @@ an empty report will be generated.</para>
<para>I wish a list of transactions showing my income for the year 1 July 2015 to 30 June 2016, grouped by quarter</para>
</question>
<answer>
- <para>Accounts: click Income, and Select Children</para>
- <para>General: Choose absolute dates “01/07/2015†to “30/06/2016â€</para>
- <para>Sorting: Primary Key: Accounts, Secondary Key: Date</para>
- <para>Sorting: Primary Key Subtotal: Enabled, Secondary Date Subtotal: Quarter</para>
+ <orderedlist>
+ <listitem><para><emphasis>Accounts</emphasis>: click Income, and Select Children</para></listitem>
+ <listitem><para><emphasis>General</emphasis>: Choose absolute dates “01/07/2015†to “30/06/2016â€</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis>: Primary Key: Accounts, Secondary Key: Date</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis>: Primary Key Subtotal: Enabled, Secondary Date Subtotal: Quarter</para></listitem>
+ </orderedlist>
</answer>
</qandaentry>
<qandaentry>
@@ -774,8 +792,12 @@ an empty report will be generated.</para>
<para>I wish a list of transactions showing income transactions, grouped by day of week</para>
</question>
<answer>
- <para>As above</para>
- <para>Sorting: Secondary Key Subtotal: Weekday</para>
+ <para>This report may be pertinent to businesses operating with variable daily income, e.g. food industry.
+ The weekday sortkey will allow subtotal comparisons according to day of week.</para>
+ <orderedlist>
+ <listitem><para>As above</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis>: Secondary Key Subtotal: Weekday</para></listitem>
+ </orderedlist>
</answer>
</qandaentry>
<qandaentry>
@@ -783,10 +805,12 @@ an empty report will be generated.</para>
<para>I wish to print my bank account or credit card transactions, reconciled first, then cleared, then unreconciled transactions</para>
</question>
<answer>
- <para>Accounts: select the relevant bank or credit card account</para>
- <para>General: Choose absolute dates “01/07/2015†to “30/06/2016â€</para>
- <para>Sorting: Primary Key: Reconcile Status, Secondary Key: Date</para>
- <para>Secondary Date Subtotal: None</para>
+ <orderedlist>
+ <listitem><para><emphasis>Accounts</emphasis>: select the relevant bank or credit card account</para></listitem>
+ <listitem><para><emphasis>General</emphasis>: Choose absolute dates “01/07/2015†to “30/06/2016â€</para></listitem>
+ <listitem><para><emphasis>Sorting</emphasis>: Primary Key: Reconcile Status, Secondary Key: Date</para></listitem>
+ <listitem><para><emphasis>Secondary</emphasis> Date Subtotal: None</para></listitem>
+ </orderedlist>
</answer>
</qandaentry>
</qandaset>
commit ab268fcdaed8ea092a7b95c0c418cc41a8463be7
Author: Christopher Lam <christopher.lck at gmail.com>
Date: Fri Jan 19 23:19:01 2018 +0800
Add Newbie Guide to the TR
diff --git a/guide/C/ch_reports.xml b/guide/C/ch_reports.xml
index 7d4e3e4..7ec40a6 100644
--- a/guide/C/ch_reports.xml
+++ b/guide/C/ch_reports.xml
@@ -613,4 +613,183 @@ an empty report will be generated.</para>
</sect3>
</sect2>
</sect1>
+
+<sect1 id="rpt_transaction">
+ <title>Transaction Report</title>
+ <sect2 id="rpt_TR_new">
+ <title>New in Gnucash 3.0</title>
+ <para>The Transaction Report has undergone several major upgrades, bug fixes, and new features. It aims to be the most versatile report to retrieve useful information from the financial records.</para>
+ <itemizedlist>
+ <listitem>
+ <para><emphasis>New!</emphasis> Debit and Credit subtotals are now displayed in the appropriate columns. Within a grouping section, if debit totals > credit totals, the group subtotal will be displayed in the debit column.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>New!</emphasis> Multiple data columns enable display of foreign currency and original currency in separate columns.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>New!</emphasis> Additional sortkeys e.g. sort by reconcile status (unreconciled -> cleared -> reconciled), sort by weekday, allow additional views into the financial records.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>New!</emphasis> Full text filter enabled for description, notes and memo, and for account full names. This allows easier selection of source account names and tailored reporting. Filters can optionally use full POSIX regular expressions.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>New!</emphasis> Indenting of columns will indent the report columns for easier understanding of grouping and sorting. (This is now enabled by default)</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>New!</emphasis> Subtotal table is useful to understand the relationship in the data e.g. account values in time series.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>New!</emphasis> Filter by Closing Transactions will disallow closing transactions (i.e. income & expense accounts to equity) which should not routinely be included in transaction reports. (This is now enabled by default.)</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>New!</emphasis> Options Summary will print a list of report options that were changed by the user. This is mainly useful to troubleshoot reports.</para>
+ </listitem>
+ <listitem>
+ <para>Bugs fixed - numerous bugs identified were fixed; e.g. sign display was fixed, correct grouping of periodic dates.</para>
+ </listitem>
+ </itemizedlist>
+ </sect2>
+ <sect2 id="rpt_TR_newbie">
+ <title>The Newbie Guide to the Transaction Report</title>
+ <para>The Transaction Report can be heavily customised to produce most reports appropriate for personal finance and business bookkeeping purposes. It aims to retrieve and filter information from the database, and present transactions and totals, useful for the user and the accountant.</para>
+ <para>The following newbie guide to the Transaction Report will assume the user has set up the chart of accounts according to conventional bookkeeping practice. For example, the following describes a typical household book with skeleton accounts. Further accounts will undoubtedly be necessary.</para>
+ <table>
+ <title>CHART OF ACCOUNTS</title>
+ <tgroup cols='2' align='left' colsep='1' rowsep='1'>
+ <thead>
+ <row>
+ <entry>Account Name</entry>
+ <entry>Account Type</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Asset</entry>
+ <entry>ASSET (placeholder)</entry>
+ </row>
+ <row>
+ <entry>Asset:Bank</entry>
+ <entry>BANK</entry>
+ </row>
+ <row>
+ <entry>Asset:Property</entry>
+ <entry>ASSET</entry>
+ </row>
+ <row>
+ <entry>Liability</entry>
+ <entry>LIABILITY (placeholder)</entry>
+ </row>
+ <row>
+ <entry>Liability:Credit Card</entry>
+ <entry>CREDIT CARD</entry>
+ </row>
+ <row>
+ <entry>Liability:Home Loan</entry>
+ <entry>LIABILITY</entry>
+ </row>
+ <row>
+ <entry>Income</entry>
+ <entry>INCOME (placeholder)</entry>
+ </row>
+ <row>
+ <entry>Income:Salary</entry>
+ <entry>INCOME</entry>
+ </row>
+ <row>
+ <entry>Income:Interest</entry>
+ <entry>INCOME</entry>
+ </row>
+ <row>
+ <entry>Expense</entry>
+ <entry>EXPENSE (placeholder)</entry>
+ </row>
+ <row>
+ <entry>Expense:Groceries</entry>
+ <entry>EXPENSE</entry>
+ </row>
+ <row>
+ <entry>Expense:Auto</entry>
+ <entry>EXPENSE</entry>
+ </row>
+ <row>
+ <entry>Expense:Medical</entry>
+ <entry>EXPENSE</entry>
+ </row>
+ <row>
+ <entry>Equity</entry>
+ <entry>EQUITY (placeholder)</entry>
+ </row>
+ <row>
+ <entry>Equity:Opening Balances</entry>
+ <entry>EQUITY</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ <para>Conventionally, the oldest transaction would be equity transfers from Equity:Opening Balances to Asset and Liability Accounts. Most subsequent transactions would be transfers from Income/Expense accounts to Assets/Liability accounts (representing day-to-day activity e.g. receiving salary, paying utility bill), or transfers between assets and liability accounts (representing movements between loans and assets, e.g. paying credit card bill, receiving a loan).</para>
+ <para>The following use cases will be illustrated, and the options to be selected explained:</para>
+ <qandaset>
+ <qandaentry>
+ <question>
+ <para>How much did I spend on various expense accounts last year?</para>
+ </question>
+ <answer>
+ <para>Accounts: click Expense, and Select Children</para>
+ <para>General: Choose relative dates “Start of Previous Year†and “End of Previous Yearâ€</para>
+ <para>Sorting: Primary Key: Accounts, Secondary Key: Date</para>
+ <para>Sorting: Primary Key Subtotal: Enabled, Secondary Key Subtotal: None </para>
+ </answer>
+ </qandaentry>
+ <qandaentry>
+ <question>
+ <para>How much did I spend on various expenses, grouped by month?</para>
+ </question>
+ <answer>
+ <para>As above</para>
+ <para>Sorting: Secondary Key Subtotal: Monthly</para>
+ </answer>
+ </qandaentry>
+ <qandaentry>
+ <question>
+ <para>How much did I spend on various expenses, with monthly comparison?</para>
+ </question>
+ <answer>
+ <para> As above</para>
+ <para>General: Subtotal Table enabled</para>
+ </answer>
+ </qandaentry>
+ <qandaentry>
+ <question>
+ <para>I wish a list of transactions showing my income for the year 1 July 2015 to 30 June 2016, grouped by quarter</para>
+ </question>
+ <answer>
+ <para>Accounts: click Income, and Select Children</para>
+ <para>General: Choose absolute dates “01/07/2015†to “30/06/2016â€</para>
+ <para>Sorting: Primary Key: Accounts, Secondary Key: Date</para>
+ <para>Sorting: Primary Key Subtotal: Enabled, Secondary Date Subtotal: Quarter</para>
+ </answer>
+ </qandaentry>
+ <qandaentry>
+ <question>
+ <para>I wish a list of transactions showing income transactions, grouped by day of week</para>
+ </question>
+ <answer>
+ <para>As above</para>
+ <para>Sorting: Secondary Key Subtotal: Weekday</para>
+ </answer>
+ </qandaentry>
+ <qandaentry>
+ <question>
+ <para>I wish to print my bank account or credit card transactions, reconciled first, then cleared, then unreconciled transactions</para>
+ </question>
+ <answer>
+ <para>Accounts: select the relevant bank or credit card account</para>
+ <para>General: Choose absolute dates “01/07/2015†to “30/06/2016â€</para>
+ <para>Sorting: Primary Key: Reconcile Status, Secondary Key: Date</para>
+ <para>Secondary Date Subtotal: None</para>
+ </answer>
+ </qandaentry>
+ </qandaset>
+ </sect2>
+</sect1>
</chapter>
diff --git a/help/C/Help_ch_Reports.xml b/help/C/Help_ch_Reports.xml
index 50f56c0..790bb0d 100644
--- a/help/C/Help_ch_Reports.xml
+++ b/help/C/Help_ch_Reports.xml
@@ -1,7 +1,8 @@
<!--
(Do not remove this comment block.)
Version: 2.0.x
- Last modified: December 7th 2009
+ Last modified: January 20th 2017
+ modified: December 7th 2009
modified: May 13th 2007
modified: November 28th 2006
modified: August 12th 2006
@@ -463,7 +464,7 @@
</tgroup>
</informaltable>
<note>
- <para>Before stable version 2.8.0
+ <para>Before stable version 3.0
<emphasis>Detail Level</emphasis> was called <emphasis>Style</emphasis> on the General tab.</para>
</note>
@@ -563,7 +564,7 @@
</tbody>
</tgroup>
</informaltable>
- <note><para>In stable version 2.8.0, the <emphasis>Style</emphasis> option will be renamed to <emphasis>Detail Level</emphasis>
+ <note><para>In stable version 3.0, the <emphasis>Style</emphasis> option will be renamed to <emphasis>Detail Level</emphasis>
and moved to the Display tab.</para>
</note>
</listitem>
@@ -645,7 +646,7 @@
<title>Displaying Split Account Details</title>
<para>This is controled by the <emphasis>Detail Level</emphasis> option on the Display tab.</para>
<note>
- <para>In stable versions before 2.8.0 this option was called <emphasis>Style</emphasis> on the General tab.</para>
+ <para>In stable versions before 3.0 this option was called <emphasis>Style</emphasis> on the General tab.</para>
</note>
<para>In <emphasis>Single</emphasis> line mode, there's only one line per transaction. So you can have
the account name on one side of the equation and
Summary of changes:
guide/C/ch_reports.xml | 268 ++++++++++++++++++++++++++++++++++++++++++---
help/C/Help_ch_Reports.xml | 130 +++++++++++++++-------
2 files changed, 348 insertions(+), 50 deletions(-)
More information about the gnucash-changes
mailing list