gnucash-docs maint: Bug-633590 Update and activate Reports chapter.
John Ralls
jralls at code.gnucash.org
Fri Oct 21 15:15:46 EDT 2016
Updated via https://github.com/Gnucash/gnucash-docs/commit/26328123 (commit)
from https://github.com/Gnucash/gnucash-docs/commit/aa5b26ca (commit)
commit 263281233a1cf8a4b3f40c15da358a7d118d37be
Author: David T <sunfish62 at yahoo.com>
Date: Fri Oct 21 16:24:23 2016 +0500
Bug-633590 Update and activate Reports chapter.
diff --git a/guide/C/ch_reports.xml b/guide/C/ch_reports.xml
index eeec533..0e08dc8 100644
--- a/guide/C/ch_reports.xml
+++ b/guide/C/ch_reports.xml
@@ -10,193 +10,588 @@
Translators:
(translators put your name and email here)
-->
- <chapter id="chapter_reports">
+ <chapter id="ch_reports">
<title>Reports</title>
- <para>
- </para>
+ <para><application>&app;</application> is a powerful double entry accounting software package that allows
+users to enter and track their money in a reliable manner. However, putting
+this information into <application>&app;</application> is only a part of the process. To be truly
+helpful, you need to be able to extract this information in meaningful ways.
+<application>&app;</application>'s reporting features allow you to just that.</para>
+<para><application>&app;</application>'s reporting features allow you to display nearly any group of
+transactions in a wide variety of formats. This makes it easy to answer
+questions about your finances, such as "How much did I spend on groceries
+last month?" or "How much did I earn in the previous six months?"</para>
+<para><application>&app;</application> includes a number of common report types, which can be modified to
+meet your specific needs. If these common reports are insufficient, it is
+possible to modify or even write your own custom reports (although this is
+not recommended for beginners).</para>
- <sect1 id="reports_concepts1">
- <title>Report Concepts</title>
- <para><application>&app;</application> has a powerful built-in report generation capabilities.</para>
- <para>The reports are presented in this chapter in the order that they appear in the Reports menu. Each section will follow a similar organization. First, a short introduction which explains what the report is intended to show, next the options for the report will be shown, and finally an example will be given.</para>
-
- <sect2 id="reports_overview2">
+ <sect1 id="rpt_concepts">
<title>Overview</title>
- <para>There are more than 20 standard reports pre-built in <application>&app;</application>, all available from the <guimenu>Reports</guimenu> pulldown menu in the main account window. </para>
- <table>
- <title>Report Overview - Assets & Liabilities</title>
- <tgroup cols="3">
- <tbody>
-
- <row>
- <entry><emphasis>Report Name</emphasis></entry>
- <entry><emphasis>Step Size</emphasis></entry>
- <entry><emphasis>Interval Summary</emphasis></entry>
- <entry><emphasis>Interval <quote>From</quote></emphasis></entry>
- <entry><emphasis>Interval <quote>To</quote></emphasis></entry>
- <entry><emphasis>Choose Accounts</emphasis></entry>
- <entry><emphasis>Default</emphasis></entry>
- <entry><emphasis>Format</emphasis></entry>
- </row>
-
- <row>
- <entry><emphasis>Advanced Portfolio</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Stock</emphasis></entry>
- <entry><emphasis>Text</emphasis></entry>
- </row>
-
- <row>
- <entry><emphasis>Asset Barchart</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Asset</emphasis></entry>
- <entry><emphasis>Barchart</emphasis></entry>
- </row>
-
- <row>
- <entry><emphasis>Asset Piechart</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Asset</emphasis></entry>
- <entry><emphasis>Piechart</emphasis></entry>
- </row>
-
- <row>
- <entry><emphasis>Average Balance</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Asset, Liability</emphasis></entry>
- <entry><emphasis>Barchart</emphasis></entry>
- </row>
-
- <row>
- <entry><emphasis>Balance Sheet</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>All</emphasis></entry>
- <entry><emphasis>Text</emphasis></entry>
- </row>
-
- <row>
- <entry><emphasis>Investment Portfolio</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Stock</emphasis></entry>
- <entry><emphasis>Text</emphasis></entry>
- </row>
-
- <row>
- <entry><emphasis>Liability Barchart</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Liability</emphasis></entry>
- <entry><emphasis>Barchart</emphasis></entry>
- </row>
-
- <row>
- <entry><emphasis>Liability Piechart</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Liability</emphasis></entry>
- <entry><emphasis>Piechart</emphasis></entry>
- </row>
-
- <row>
- <entry><emphasis>Networth Barchart</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Asset, Liability, Equity</emphasis></entry>
- <entry><emphasis>Barchart</emphasis></entry>
- </row>
-
- <row>
- <entry><emphasis>Price Scatterplot</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>Y</emphasis></entry>
- <entry><emphasis>-</emphasis></entry>
- <entry><emphasis>Scatterplot</emphasis></entry>
- </row>
-
- </tbody>
- </tgroup>
- </table>
-
- </sect2>
- </sect1>
-
- <sect1 id="reports_acctsum1">
- <title>Account Summary</title>
- <para>The account summary report is one of the most basic reports available. However, there is power in the simplicity. The report allows you to present a historical view of the value of your accounts.</para>
-
- <sect2 id="reports_acctsum_options2">
- <title>Options</title>
- <para>The account summary options are composed of 3 tabs, Accounts, Display, and General</para>
+ <para>There are many standard reports pre-built in <application>&app;</application>,
+ all available from the <guimenu>Reports</guimenu> pulldown menu in the main account window.</para>
+ <para>When you select a report from the list of reports, that report is first run
+ with its default settings. Once you have opened the report, you can modify its parameters by clicking on
+the Options button on the toolbar. Under Options, you will see the different
+settings that you can change for each report. Note that for different reports,
+the options will be different. </para>
+</sect1>
+
+<sect1 id="rpt_savedconfigsinfo">
+ <title>Saved Reports Configurations Concepts</title>
+ <para>Once you have modified a report to meet your needs, you may wish to save
+ that report for reuse at a later point. <application>&app;</application> allows custom
+ reports to be saved, using the Save Report Configuration command.</para>
+ <para>To save a report configuration:</para>
+<itemizedlist>
+<listitem><para>Go to the Reports Menu and choose the desired report.</para></listitem>
+<listitem><para>Change the settings on the report until it includes what is needed.</para></listitem>
+<listitem><para>Go to the General tab of the report's options and change the Report Name
+to something meaningful (Do not confuse this with the Report Title).</para></listitem>
+<listitem><para>Apply the changes and close the dialog.</para></listitem>
+<listitem><para>Click the Save Report Configuration or Save Report Configuration As... button</para></listitem>
+</itemizedlist>
+<para>This will store the report options in a file in your home directory.</para>
+<para>The first time you save a report with a name that has not already been saved,
+you can use either the Save Report Configuration or the Save Report
+Configuration As... button. You can modify the report name before saving it.</para>
+<para>Once a report has been saved with the current name, the Save Report Configuration button will immediately update the saved report configuration.
+Use the Save Report Configuration As button to save the current report
+configuration with a new name.</para>
+<para>Saved report configurations are available for use under the
+Reports->Saved Report Configurations entry. They will also be available for
+use on multicolumn reports.</para>
+<para>Saved report configurations can be deleted in the Saved Report Configurations
+dialog by clicking the trashcan icon.</para>
+<para>To edit saved report configurations, open the report via Reports->Saved Report
+Configurations, edit and apply the new options, and click Save Report
+Configuration.</para>
+</sect1>
+
+<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>
+
+<sect2 id="rpt_grp_assetsliabs">
+<title>Assets & Liabilities Group</title>
+<para>Reports in this group provide general information about assets and liabilities.</para>
+
+<sect3 id="rpt_advport">
+<title>Advanced Portfolio</title>
+<para>The Advanced Portfolio produces a report on commodity accounts
+(stock and mutual fund type accounts) using price information stored in the
+<application>&app;</application> price database and within the
+<application>&app;</application> transaction data. If you do not have stock
+price information in your file, the report will indicate an error. This report
+includes extended information about commodity holdings, including information
+about the basis, gain, and return of individual commodities.</para>
+</sect3>
+
+<sect3 id="rpt_assetbarchart">
+<title>Asset Barchart</title>
+<para>The Asset Barchart presents the value of assets on a monthly basis in
+barchart form. By default, the report displays the eight largest accounts that
+have specific asset types assigned to them, and it displays bars for
+the current financial period.</para>
+<para>Several settings on this report can greatly affect the information included.</para>
+<itemizedlist>
+<listitem><para>On the Accounts tab, the "Show Accounts until level" option changes how
+the report aggregates account totals. Change this value to see information at
+deeper levels of the account structure.</para></listitem>
+<listitem><para>On the Display tab, the "Maximum Bars" option will display more bars in
+the chart, allowing information for more accounts to display. Additionally,
+the "Show table" option enables the display of chart information in tabular
+form below the chart.</para></listitem>
+<listitem><para>On the General tab, the "Price Source" option can significantly
+affect the reported value of various commodities included in the report.</para></listitem>
+</itemizedlist>
+</sect3>
+
+<sect3 id="rpt_assetpiechart">
+<title>Asset Piechart</title>
+<para>The Asset Piechart presents the value of assets on a monthly basis in
+piechart form. By default, the report shows the seven largest accounts, that
+have specific asset types assigned to them, arranged in descending order by
+value as of the end of the current accounting period.</para>
+<para>Several settings on this report can greatly affect the information included.</para>
+<itemizedlist>
+<listitem><para>On the Accounts tab, the "Show Accounts until level" option changes how
+the report aggregates account totals. Change this value to see information at
+deeper levels of the account structure.</para></listitem>
+<listitem><para>On the Display tab, the "Maximum Slices" option will display more
+slices in the chart, allowing information for more accounts to display.</para></listitem>
+<listitem><para>On the General tab, the "Price Source" option can significantly
+affect the reported value of various commodities included in the report.</para></listitem>
+</itemizedlist>
+</sect3>
+
+<sect3 id="rpt_avgbalance">
+<title>Average Balance</title>
+<para>The Average Balance report displays monthly averages for the current accounting period.</para>
+</sect3>
+
+<sect3 id="rpt_balancesheet">
+<title>Balance Sheet</title>
+<para>The Balance Sheet lists Asset, Liability, and Equity account balances
+for all such accounts, and provides totals as of a given date. Balance sheets
+are commonly run for the last day of each fiscal year to give an overall sense
+of the financial condition of the entity.</para>
+</sect3>
+
+<sect3 id="rpt_generaljournal">
+<title>General Journal</title>
+<para>The General Journal produces a register of all transactions (beginning
+to end) in order by date, showing the accounts and the amounts involved, and
+totals the Net Change by all currencies and assets.</para>
+<para>This report is not customizable by date or account, though you can
+include more or fewer details about the individual transactions, and whether
+to include running balances and totals for the credits and debits. If you
+need a report restricted to particular accounts, consider the Transaction
+Report or open a particular account and choose the Account Transaction Report.</para>
+</sect3>
+
+<sect3 id="rpt_generalledger">
+<title>General Ledger</title>
+<para>The General Ledger produces information about all transactions
+for a selected set of accounts. 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_investport">
+<title>Investment Portfolio</title>
+<para>The Investment Portfolio produces a report of commodity accounts (that
+is, accounts with type "Stock" or "Mutual Fund"), giving holdings, price and
+value information about commodities in the file.</para>
+</sect3>
+
+<sect3 id="rpt_liabbarchart">
+<title>Liability Barchart</title>
+<para>The Liability Barchart presents the value of liabilities on a monthly basis in
+barchart form. By default, the report displays the eight largest accounts that
+have specific asset types assigned to them, and it displays bars for
+the current financial period.</para>
+<para>Several settings on this report can greatly affect the information included.</para>
+<itemizedlist>
+<listitem><para>On the Accounts tab, the "Show Accounts until level" option changes how
+the report aggregates account totals. Change this value to see information at
+deeper levels of the account structure.</para></listitem>
+<listitem><para>On the Display tab, the "Maximum Bars" option will display more bars in
+the chart, allowing information for more accounts to display. Additionally,
+the "Show table" option enables the display of chart information in tabular
+form below the chart.</para></listitem>
+<listitem><para>On the General tab, the "Price Source" option can significantly
+affect the reported value of various commodities included in the report.</para></listitem>
+</itemizedlist>
+</sect3>
+
+<sect3 id="rpt_liabpiechart">
+<title>Liability Piechart</title>
+<para>The Liability Piechart presents the value of liabilities on a monthly basis in
+piechart form. By default, the report shows the seven largest accounts, that
+have specific asset types assigned to them, arranged in descending order by
+value as of the end of the current accounting period.</para>
+<para>Several settings on this report can greatly affect the information included.</para>
+<itemizedlist>
+<listitem><para>On the Accounts tab, the "Show Accounts until level" option changes how
+the report aggregates account totals. Change this value to see information at
+deeper levels of the account structure.</para></listitem>
+<listitem><para>On the Display tab, the "Maximum Slices" option will display more
+slices in the chart, allowing information for more accounts to display.</para></listitem>
+<listitem><para>On the General tab, the "Price Source" option can significantly
+affect the reported value of various commodities included in the report.</para></listitem>
+</itemizedlist>
+</sect3>
+
+<sect3 id="rpt_networthbar">
+<title>Net Worth Barchart</title>
+<para>The Net Worth Barchart summarizes Asset accounts, Liability accounts, and
+overall Net Worth as bars on a graph on a monthly basis for the current
+financial period. This report provides a graphic overview of the file over time.</para>
+</sect3>
+
+<sect3 id="rpt_networthline">
+<title>Net Worth Linechart</title>
+<para>The Net Worth Linechart summarizes Asset accounts, Liability accounts, and
+overall Net Worth as a line graph on a monthly basis for the current financial
+period. This report provides a graphic overview of the file over time.</para>
+</sect3>
+
+<sect3 id="rpt_pricescatter">
+<title>Price Scatterplot</title>
+<para>The Price Scatterplot displays the value of one commodity relative to
+another commodity, for example the value of a stock relative to a currency.
+When first run, this report loads no data, and the report options must be
+changed to retrieve information from the file. Specifically, the "Price of
+Commodity" setting on the Price options tab must be changed to a specific
+commodity.</para>
+</sect3>
+</sect2>
+
+<sect2 id="rpt_grp_budget">
+<title>Budget Group</title>
+<para> Budget reports in <application>&app;</application> allow you to gather
+summary information related to budgets you may have created. In order for
+these reports to work, you must first create a budget. The reports in this
+group are specifically based on budget information. To use these reports, you
+need to have a budget saved in your file.</para>
+
+<sect3 id="rpt_budbalsht">
+<title>Budget Balance Sheet</title>
+<para></para>
+</sect3>
+
+<sect3 id="rpt_budbarchart">
+<title>Budget Barchart</title>
+<para></para>
+</sect3>
+
+<sect3 id="rpt_budflow">
+<title>Budget Flow</title>
+<para></para>
+</sect3>
+
+<sect3 id="rpt_budincstate">
+<title>Budget Income Statement</title>
+<para></para>
+</sect3>
+
+<sect3 id="rpt_budprofloss">
+<title>Budget Profit & Loss</title>
+<para></para>
+</sect3>
+
+<sect3 id="rpt_budreport">
+<title>Budget Report</title>
+<para></para>
+</sect3>
+</sect2>
+
+<sect2 id="rpt_grp_business">
+<title>Business Group</title>
+<para>Reports in this group provide general information about activities related
+to a business.</para>
+
+<sect3 id="rpt_customer">
+<title>Customer Report</title>
+<para></para>
+</sect3>
+
+<sect3 id="rpt_custsummary">
+<title>Customer Summary</title>
+<para>Customer Summary is a customer profit report that can help with job analysis by
+comparing the income and expenses for a specific customer.</para>
+<para>All invoices have an Owner in <application>&app;</application>, so invoices that are
+made will show a customer and show in the report. When creating a Bill, the Default
+Chargeback Customer is blank. To use the profit report, this field needs an entry,
+since this is the tag that decides the line to which
+to attach the expense. Left blank, the bill will be assigned to "No Customer."
+Similarly, when income is entered directly in a register rather than creating an
+invoice, it will also be assigned to "No Customer."</para>
+<para>Thus, if this report includes an entry for "No Customer", this means that the report
+may be inaccurate, as the results are not all properly labeled.</para>
+<para>Possible use scenarios include:</para>
+<itemizedlist>
+<listitem><para>Tracking retail sales from different cities</para></listitem>
+<listitem><para>Tracking rental properties</para></listitem>
+<listitem><para>Tracking types of business</para></listitem>
+<listitem><para>Tracking commission sales</para></listitem>
+</itemizedlist>
+<para>Each of these scenarios assumes that the account structure includes breakdowns
+for individual tracked categories. Changing settings on the Income and Expense
+tabs under Options can hone the information displayed. By default all income and
+expense accounts are included; however, since <application>&app;</application> can't really predict
+the names and classification of income and expense accounts, it must group them all
+into the "No Customer" entry.</para>
+<para>Note that inventory-based businesses won't benefit from this report because of its nature.</para>
+<para>Useful options:</para>
+<itemizedlist>
+<listitem><para>The Expense Accounts tab allows the selection of one or more expense accounts.</para></listitem>
+<listitem><para>The Income Accounts tab allows the selection of one or more income accounts.</para></listitem>
+<listitem><para>The Display tab allows sorting by name, profit percentage, or amount of profit.</para></listitem>
+</itemizedlist>
+</sect3>
+
+<sect3 id="rpt_easyinv">
+<title>Easy Invoice</title>
+<para></para>
+</sect3>
+
+<sect3 id="rpt_employee">
+<title>Employee Report</title>
+<para></para>
+</sect3>
+
+<sect3 id="rpt_fancyinv">
+<title>Fancy Invoice</title>
+<para></para>
+</sect3>
+
+<sect3 id="rpt_payaging">
+<title>Payable Aging</title>
+<para></para>
+</sect3>
+
+<sect3 id="rpt_prtinv">
+<title>Printable Invoice</title>
+<para></para>
+</sect3>
+
+<sect3 id="rpt_recaging">
+<title>Receivable Aging</title>
+<para>This report provides a listing of all customers, their current balance, and
+how much they have outstanding from invoices over different time periods—how
+much they owe from 0-30 days, from 31-60 days, from 61-90 days, and over 90 days.
+The report also contains links to each customer and to their current customer report.</para>
+</sect3>
+
+<sect3 id="rpt_vendor">
+<title>Vendor Report</title>
+<para></para>
+</sect3>
+</sect2>
+
+<sect2 id="rpt_grp_incexp">
+<title>Income & Expense Group</title>
+<para>Reports in this group provide information about Income and Expense</para>
+
+<sect3 id="rpt_cashflow">
+<title>Cash Flow</title>
+<para>This report shows the change in value for a set of accounts (the flow of cash)
+over a given period of time. By default, this report is based on accounts in Assets and
+Special Accounts, and covers the current financial period. The report enumerates
+all money coming in to and going out of the base accounts, broken down by the
+other account.</para>
+</sect3>
+
+<sect3 id="rpt_equity">
+<title>Equity Statement</title>
+<para>This report can be seen as extension of the Balance Sheet report. The
+Balance Sheet states the balance of Assets, Liabilities and Equity at a
+specific point of time. The Equity Statement focuses on the Equity Accounts
+by showing the cash flow to and from them for a given period of time.</para>
+<para>By balancing this cash flow with income, the report shows the available
+capital at the beginning and end of the selected time period.</para>
+</sect3>
+
+<sect3 id="rpt_expbarchart">
+<title>Expense Barchart</title>
+<para>The Expense Barchart presents the value of expenses on a monthly basis in
+barchart form. By default, the report displays the eight largest accounts that
+have specific expense types assigned to them, and it displays bars for
+the current financial period.</para>
+<para>Several settings on this report can greatly affect the information included.</para>
+<itemizedlist>
+<listitem><para>On the Accounts tab, the "Show Accounts until level" option changes how
+the report aggregates account totals. Change this value to see information at
+deeper levels of the account structure.</para></listitem>
+<listitem><para>On the Display tab, the "Maximum Bars" option will display more bars in
+the chart, allowing information for more accounts to display. Additionally,
+the "Show table" option enables the display of chart information in tabular
+form below the chart.</para></listitem>
+<listitem><para>On the General tab, the "Price Source" option can significantly
+affect the reported value of various commodities included in the report.</para></listitem>
+</itemizedlist>
+</sect3>
+
+<sect3 id="rpt_exppiechart">
+<title>Expense Piechart</title>
+<para>The Expense Piechart presents the value of expenses on a monthly basis in
+piechart form. By default, the report shows the seven largest accounts, that
+have specific expense types assigned to them, arranged in descending order by
+value as of the end of the current accounting period.</para>
+<para>Several settings on this report can greatly affect the information included.</para>
+<itemizedlist>
+<listitem><para>On the Accounts tab, the "Show Accounts until level" option changes how
+the report aggregates account totals. Change this value to see information at
+deeper levels of the account structure.</para></listitem>
+<listitem><para>On the Display tab, the "Maximum Slices" option will display more
+slices in the chart, allowing information for more accounts to display.</para></listitem>
+<listitem><para>On the General tab, the "Price Source" option can significantly
+affect the reported value of various commodities included in the report.</para></listitem>
+</itemizedlist>
+</sect3>
+
+<sect3 id="rpt_expdayoweek">
+<title>Expenses vs. Day of Week</title>
+<para>Expenses vs. Day of Week presents a pie chart showing the totals for
+selected expense accounts totaled by the day of the week of the transaction.
+The report options enable you to make some adjustments (such as accounts,
+display options, and the date range) but the account selector only allows
+expense accounts to be chosen. The report aggregates expense transactions by
+day of week, not by any other period or category. Due to these limitations,
+the report may be considered a demonstration or an example to someone wanting
+to examine the source code for composing a useful custom report.</para>
+</sect3>
+
+<sect3 id="rpt_incomebarchart">
+<title>Income Barchart</title>
+<para>The Income Barchart presents the value of income on a monthly basis in
+barchart form. By default, the report displays the eight largest accounts that
+have specific income types assigned to them, and it displays bars for
+the current financial period.</para>
+<para>Several settings on this report can greatly affect the information included.</para>
+<itemizedlist>
+<listitem><para>On the Accounts tab, the "Show Accounts until level" option changes how
+the report aggregates account totals. Change this value to see information at
+deeper levels of the account structure.</para></listitem>
+<listitem><para>On the Display tab, the "Maximum Bars" option will display more bars in
+the chart, allowing information for more accounts to display. Additionally,
+the "Show table" option enables the display of chart information in tabular
+form below the chart.</para></listitem>
+<listitem><para>On the General tab, the "Price Source" option can significantly
+affect the reported value of various commodities included in the report.</para></listitem>
+</itemizedlist>
+</sect3>
+
+<sect3 id="rpt_incexpchart">
+<title>Income & Expense Chart</title>
+<para></para>
+</sect3>
+
+<sect3 id="rpt_incomepiechart">
+<title>Income Piechart</title>
+<para>The Income Piechart presents the value of income on a monthly basis in
+piechart form. By default, the report shows the seven largest accounts, that
+have specific income types assigned to them, arranged in descending order by
+value as of the end of the current accounting period.</para>
+<para>Several settings on this report can greatly affect the information included.</para>
+<itemizedlist>
+<listitem><para>On the Accounts tab, the "Show Accounts until level" option changes how
+the report aggregates account totals. Change this value to see information at
+deeper levels of the account structure.</para></listitem>
+<listitem><para>On the Display tab, the "Maximum Slices" option will display more
+slices in the chart, allowing information for more accounts to display.</para></listitem>
+<listitem><para>On the General tab, the "Price Source" option can significantly
+affect the reported value of various commodities included in the report.</para></listitem>
+</itemizedlist>
+</sect3>
+
+<sect3 id="rpt_incstatement">
+<title>Income Statement</title>
+<para>This report lists Income and Expense account totals for a set period. By
+default, it shows all Expense and Income accounts down to 3 levels of
+sub-accounts for the current financial period.</para>
+<para>An Income Statement is also called a "Profit and Loss" report or "Revenue Statement."</para>
+<para>In earlier versions of <application>&app;</application>, this report was called
+"Profit & Loss," but with version 2, the report was renamed "Income Statement"
+to use more common accounting terminology.</para>
+<para>The Income Statement helps show where money is coming from and where it is
+going for a given time period.</para>
+</sect3>
+
+<sect3 id="rpt_incdayoweek">
+<title>Income vs. Day of Week</title>
+<para>Income vs. Day of Week presents a piechart showing the totals for selected
+income accounts totaled by the day of the week of the transaction. The report
+options enable you to make some adjustments (such as accounts, display options,
+and the date range) but the account selector only allows income accounts to be
+chosen. The report aggregates income transactions by day of week, not by any
+other period or category. Due to these limitations, the report may be
+considered a demonstration or an example to someone wanting to examine the
+source code for composing a useful custom report.</para>
+</sect3>
+
+<sect3 id="rpt_trialbal">
+<title>Trial Balance</title>
+<para>Trial Balance lists the ending balances in all accounts as of a particular
+date. It is typically run at the end of an accounting period and is primarily
+used to ensure that the total of all debits equals the total of all credits.</para>
+</sect3>
+</sect2>
+<sect2 id="rpt_grp_sampcust">
+<title>Sample & Custom Group</title>
+<para>The reports in this group offer examples on how reports can be customized
+or podified to suit personal need.</para>
- </sect2>
-
- <sect2 id="reports_acctsum_example2">
- <title>Example</title>
- <para></para>
- </sect2>
-
- </sect1>
-
- <sect1 id="reports_taxtxf1">
- <title>Tax Report / TXF Export</title>
- <para>
- </para>
- </sect1>
-
- <sect1 id="reports_1">
- <title>10.3 Creating Standard Reports and Graphs (How-To)</title>
- <para>
- </para>
- </sect1>
- <sect1 id="statement1">
- <title>10.4 Customizing (How-To)</title>
- <para>
- </para>
- </sect1>
- <sect1 id="adjustbal1">
- <title>10.5 Printing Reports and Graphs (How-To)</title>
- <para>
- </para>
- </sect1>
- <sect1 id="creditcard1">
- <title>10.6 Putting It All Together (Examples)</title>
- <para>
- </para>
- </sect1>
- </chapter>
\ No newline at end of file
+<sect3 id="rpt_custommulti">
+<title>Custom Multicolumn Report</title>
+<para>This report provides a base that allows several standard and custom
+reports to be combined into one view. Note that this report opens with an empty
+window; you must open the options and designate which reports to include for display.
+Once the reports have been selected, the settings for individual reports in the
+multicolumn display can be edited.</para>
+</sect3>
+<sect3 id="rpt_sample">
+<title>Sample Report with Examples</title>
+<para>This is a sample report that users can examine to learn how to write their own reports.</para>
+</sect3>
+
+<sect3 id="rpt_welcome">
+<title>Welcome Sample Report</title>
+<para>This report demonstrates how the Multicolumn Report can be use to create
+custom dashboard-type reports.</para>
+</sect3>
+</sect2>
+
+<sect2 id="rpt_grp_miscrpts">
+<title>Other Reports</title>
+<para>Several reports are included on the main Reports menu. These are described
+below.</para>
+
+<sect3 id="rpt_acctsummary">
+<title>Account Summary</title>
+<para>This lists the balances of all accounts and subaccounts as of a
+particular date. By default, this report shows accounts and totals
+down to third-level subaccounts.</para>
+<para>This report gives effectively the same information as the Chart of Accounts.
+You can use this report to export and print the Chart of Accounts.</para>
+<para>Note: To generate a report of account totals over a particular time period
+(especially if you do not close your books at regular intervals), you might
+consider using the Income Statement, or Cash Flow reports.</para>
+</sect3>
+
+<sect3 id="rpt_futsched">
+<title>Future Scheduled Transactions Summary</title>
+<para></para>
+</sect3>
+
+<sect3 id="rpt_taxtxf">
+<title>Tax Report & TXF Export</title>
+<para>Generates a report and a downloadable .txf file of taxable income and
+deductible expenses for a particular accounting period. To download the report
+data, choose the Export button on the toolbar and choose between html and .txf
+downloadable versions.</para>
+<para>To use this report, you must use Edit --> Tax Options to identify which
+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
+Configurations. "Saved Report Configurations" means sets of customized
+settings for standard reports.</para>
+<para>These sets must be saved by the user before they appear here. See
+Report Concepts above for instructions on how to save report configurations.</para>
+</sect3>
+
+<sect3 id="rpt_acctreport">
+<title>Account Report</title>
+<para>The Account Report menu entry only appears when an account register is
+the active tab. This report produces a list of all transactions in the open
+register.</para>
+<para>Note that if you conduct a search that retrieves several transactions, the
+results are displayed in a new search register, which can then be used to create
+a report for just those transactions.</para>
+</sect3>
+
+<sect3 id="rpt_accttxnrept">
+<title>Account Transaction Report</title>
+<para>This report also only appears when an account register is the active tab.
+However, this report only lists transactions that have been selected
+(e.g. by mouse click) in the current register. If no transactions are selected,
+an empty report will be generated.</para>
+</sect3>
+</sect2>
+</sect1>
+</chapter>
diff --git a/guide/C/gnucash-guide.xml b/guide/C/gnucash-guide.xml
index 094ce64..af1a542 100644
--- a/guide/C/gnucash-guide.xml
+++ b/guide/C/gnucash-guide.xml
@@ -18,18 +18,19 @@
<!ENTITY chapter7 SYSTEM "ch_cc.xml">
<!ENTITY chapter8 SYSTEM "ch_loans.xml">
<!ENTITY chapter9 SYSTEM "ch_invest.xml">
-<!ENTITY chapter10 SYSTEM "ch_capgain.xml">
-<!ENTITY chapter11 SYSTEM "ch_currency.xml">
-<!ENTITY chapter12 SYSTEM "ch_bus_intro.xml">
-<!ENTITY chapter13 SYSTEM "ch_bus_setup.xml">
-<!ENTITY chapter14 SYSTEM "ch_bus_ar.xml">
-<!ENTITY chapter15 SYSTEM "ch_bus_ap.xml">
-<!ENTITY chapter16 SYSTEM "ch_bus_pay.xml">
-<!ENTITY chapter17 SYSTEM "ch_budgets.xml">
-<!ENTITY chapter18 SYSTEM "ch_oth_assets.xml">
-<!ENTITY chapter19 SYSTEM "ch_dep.xml">
-<!ENTITY chapter20 SYSTEM "ch_python_bindings.xml">
-<!ENTITY chapter21 SYSTEM "ch_import_business_data.xml">
+<!ENTITY chapter10 SYSTEM "ch_reports.xml">
+<!ENTITY chapter11 SYSTEM "ch_capgain.xml">
+<!ENTITY chapter12 SYSTEM "ch_currency.xml">
+<!ENTITY chapter13 SYSTEM "ch_bus_intro.xml">
+<!ENTITY chapter14 SYSTEM "ch_bus_setup.xml">
+<!ENTITY chapter15 SYSTEM "ch_bus_ar.xml">
+<!ENTITY chapter16 SYSTEM "ch_bus_ap.xml">
+<!ENTITY chapter17 SYSTEM "ch_bus_pay.xml">
+<!ENTITY chapter18 SYSTEM "ch_budgets.xml">
+<!ENTITY chapter19 SYSTEM "ch_oth_assets.xml">
+<!ENTITY chapter20 SYSTEM "ch_dep.xml">
+<!ENTITY chapter21 SYSTEM "ch_python_bindings.xml">
+<!ENTITY chapter22 SYSTEM "ch_import_business_data.xml">
<!ENTITY appendixa SYSTEM "appendixa.xml">
<!ENTITY appendixb SYSTEM "appendixb.xml">
<!ENTITY appendixc SYSTEM "appendixc.xml">
@@ -497,10 +498,10 @@
&chapter9;
&chapter10;
&chapter11;
+&chapter12;
</part>
<part>
<title>Managing Business Finances</title>
-&chapter12;
&chapter13;
&chapter14;
&chapter15;
@@ -510,6 +511,7 @@
&chapter19;
&chapter20;
&chapter21;
+&chapter22;
</part>
<part>
<title>Appendices</title>
Summary of changes:
guide/C/ch_reports.xml | 767 +++++++++++++++++++++++++++++++++++-----------
guide/C/gnucash-guide.xml | 28 +-
2 files changed, 596 insertions(+), 199 deletions(-)
More information about the gnucash-changes
mailing list