gnucash-docs maint: Explain buttons in Report Options dialog - Bug 649283
Frank H. Ellenberger
fell at code.gnucash.org
Mon Jan 25 18:38:35 EST 2016
Updated via https://github.com/Gnucash/gnucash-docs/commit/77011fa2 (commit)
from https://github.com/Gnucash/gnucash-docs/commit/62d92acb (commit)
commit 77011fa2329f28d070d3bd203f6e8fa811a1f0a8
Author: Chris Good <chris.good at ozemail.com.au>
Date: Mon Jan 25 23:47:11 2016 +0100
Explain buttons in Report Options dialog - Bug 649283
Add extra info about running and saving reports
Order reports like the reports menu
Add missing reports
Refer to Charts instead of Graphs
diff --git a/help/C/Help_ch_Reports.xml b/help/C/Help_ch_Reports.xml
index 0b40348..0daf5c4 100644
--- a/help/C/Help_ch_Reports.xml
+++ b/help/C/Help_ch_Reports.xml
@@ -21,28 +21,289 @@
<chapter id="Reports">
<title>Reports And Charts</title>
- <note><para>This section is a <quote>work in process</quote> all of the material has not been reviewed for V2.0.
+ <note><para>This section is a <quote>work in process</quote>. All of the material has not been reviewed for V2.0.
While it may not be strictly accurate, it is at least a "guide".</para></note>
+ <sect1 id="report-intro">
+ <title>Introduction</title>
+
<para>Reports and Charts give <application>&app;</application> the ability to present an overview of financial
data in various ways. This can range from a simple summary of account totals to an
advanced portfolio view. This section will present an explanation of the main <application>&app;</application>
reports and how to adjust them.</para>
- <para><application>&app;</application> has classified the main types of reports into four major classes. These
- are all available under the Reports menu.</para>
+ <para>To run a report or chart, click on the <menuchoice><guimenu>Reports
+ </guimenu></menuchoice> menu, then either select
+ a report (it will open with standard options), or click on <guibutton>
+ Saved Report Configuration</guibutton> to select a report you have
+ previously configured and saved.
+ </para>
+
+ <para>Once the report has opened, click on the <guibutton>Options
+ </guibutton> toolbar button to
+ configure the report as needed, for example to set the report date or
+ select accounts.
+ </para>
+
+ <tip><para>If you intend to save a report configuration, you
+ should choose a named report date option such as <emphasis>Today
+ </emphasis>rather than enter a specific date so it is not necessary to
+ enter a specific date again in future reports.</para>
+
+ <para>If you often run a report with a date as at the start or end of an
+ accounting period, set the accounting period start and end dates in
+ <menuchoice><guimenu>Edit</guimenu><guisubmenu>Preferences</guisubmenu>
+ <guimenuitem>Accounting Period</guimenuitem></menuchoice> then select
+ appropriate report date options.
+ </para>
+ </tip>
+
+ <para>After you have configured a report, you can save the configuration for
+ future use by clicking either the <guibutton>Save Report Configuration
+ </guibutton> or <guibutton>Save Report Configuration As...</guibutton>
+ button.
+ </para>
+
+ <sect2 id="report-saving">
+ <title>Saving a Report Configuration</title>
+
+ <para>To save a report configuration for future use, while the required
+ report tab is selected, go to the report options, select the
+ <emphasis>General</emphasis> tab and change the <emphasis>Report Name
+ </emphasis> to a meaningful unique name. Do not confuse this with the
+ <emphasis>Report Title</emphasis> which prints at the top of a report.
+ </para>
+
+ <para>Click the <guibutton>Save Report Configuration</guibutton> or
+ <guibutton>Save Report Configuration As...</guibutton> button. This will
+ store your customized report options in a file in your home directory.
+ E.g. Linux: <emphasis>~/.gnucash/saved-reports-[versioninfo]</emphasis>
+ </para>
+
+ <para>The first time you save a report with a name that has not already
+ been saved, you can use either the <guibutton>Save Report Configuration
+ </guibutton> or the <guibutton>Save Report Configuration As...
+ </guibutton> button. You can modify the report name before saving it.
+ </para>
+
+ <para>After a report configuration for a specific name has been saved, the
+ <guibutton>Save Report Configuration</guibutton> button will immediately
+ update the saved report configuration without giving the opportunity to
+ save the configuration with a new name. Use the <guibutton>Save Report
+ Configuration As...</guibutton> button to save the current report
+ configuration with a new name.
+ </para>
+
+ <para>After your customized report has been saved, it is available for use
+ by the <menuchoice><guimenu>Reports</guimenu><guimenuitem>Saved Report
+ Configurations</guimenuitem></menuchoice> menu and it will also be listed
+ when starting <menuchoice><guimenu>Reports</guimenu><guisubmenu>Sample
+ & Custom</guisubmenu><guimenuitem>Custom Multicolumn Report
+ </guimenuitem></menuchoice>.
+ </para>
+
+ </sect2>
+
+ <sect2 id="report-working">
+ <title>Working with Saved Report Configurations</title>
+
+ <para>Selecting <menuchoice><guimenu>Reports</guimenu><guimenuitem>Saved
+ Report Configurations</guimenuitem></menuchoice> will open a dialog
+ window with a list of the <emphasis>Saved Report Configurations
+ </emphasis> you have previously created. In this
+ context <emphasis>Saved Report Configurations</emphasis> means the set of
+ customized settings for standard reports.
+ </para>
+
+ <para>The <emphasis>Saved Report Configurations</emphasis> window lists
+ each of your previously saved report configurations, and 3 small buttons
+ at the end of each. These buttons perform the following actions
+ </para>
+
+ <itemizedlist>
+ <listitem><para>Load (and run) report configuration. Double clicking a
+ report configuration also performs this action.</para>
+ </listitem>
+
+ <listitem><para>Edit report configuration name. This enables a report
+ configuration to be renamed.</para>
+ </listitem>
+
+ <listitem><para>Delete report configuration.</para>
+ </listitem>
+
+ </itemizedlist>
+
+ </sect2>
+
+ </sect1>
+
+ <sect1 id="report-config">
+ <title>Configuring Reports and Charts</title>
+
+ <para><application>&app;</application> reports have many configuration
+ options. First, run the original report itself. Then,
+ access the report options with the <guibutton>Options</guibutton>
+ button on the toolbar.</para>
+
+ <note> <para>Check changed Graphic Engine Options</para></note>
+
+ <sect2 id="report-opt-btns">
+ <title>Report Options Buttons</title>
+
+ <para>After modifying report options, either</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Click the <guibutton>OK</guibutton> button to apply the changes,
+ regenerate the report and
+ close the options window.</para>
+
+ <para>or</para>
+ </listitem>
+
+ <listitem>
+ <para>Click the <guibutton>Apply</guibutton> button to apply the
+ changes, regenerate the report and leave the options window open for
+ possible further changes. In this case, both the <guibutton>Apply
+ </guibutton> and <guibutton>OK</guibutton> buttons will be disabled,
+ indicating changes have been applied, until further changes are made.
+ </para>
+
+ <para>or</para>
+ </listitem>
+
+ <listitem>
+ <para>Click the <guibutton>Cancel</guibutton> button to close the
+ options window without applying any unapplied changes.</para>
+ </listitem>
+ </itemizedlist>
+
+ </sect2>
+
+ <sect2 id="report-common">
+ <title>Common Report Options</title>
+
+ <para>Many reports share similar options. Some common ones include:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Report Name: Set the title of the report. This is also used to print the
+ report for later viewing.</para>
+ </listitem>
+
+ <listitem>
+ <para>Date Options: Reports typically specify either a single date, or a date
+ range, for the report. Dates can be specified in two ways, either directly
+ (using the date selector), or by selecting a relative date from the menu.
+ Relative dates allow you to specify dates like <guilabel>Beginning of this year</guilabel> or
+ <guilabel>Today</guilabel>.</para>
+ </listitem>
+
+ <listitem>
+ <para>Step Size: This option is used on bar charts to determine the interval which
+ each bar represents. Typical values are daily, weekly, monthly, and yearly.</para>
+ </listitem>
+
+ <listitem>
+ <para>Accounts: Select the appropriate accounts for the report. Note that in some
+ reports only certain types of accounts can be selected. For example, an expense
+ piechart only allows expense accounts to be selected. </para>
+ </listitem>
+
+ <listitem>
+ <para>Show Long Account Names: This option allows displaying either short account
+ names (for example, Power) or long account names (for example, Utilities:Power).
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>Include Subaccounts?: Summary reports typically have an include all
+ subaccounts option, which if selected ensures that all subaccounts are included
+ if the parent account is.</para>
+ </listitem>
+
+ <listitem>
+ <para>Depth: This option allows the selection of how many levels the report
+ displays subaccounts. If the subaccounts go deeper than selected, an overall value
+ for all the subaccounts is calculated and included in a total. To make sure every
+ account selected is individually displayed, select <guibutton>All</guibutton>.</para>
+ </listitem>
+
+ <listitem>
+ <para>Style Sheet: Select a Style Sheet. Style sheets control how reports are
+ displayed. At the moment, there are four style sheets: <guilabel>Default</guilabel>, <guilabel>Easy</guilabel>,
+ <guilabel>Footer</guilabel> and <guilabel>Technicolor</guilabel>.
+ You can customize each of these from the <menuchoice><guimenu>Edit</guimenu><guimenuitem>Style
+ Sheets...</guimenuitem></menuchoice> menu item.
+ This is described in the Changing Style Sheets section. <xref linkend="change-style"></xref></para>
+ </listitem>
+
+ <listitem>
+ <para>Plot Dimensions: There are width and height options for most charts, which
+ specify the displayed dimensions (in pixels).</para>
+ </listitem>
+
+ <listitem>
+ <para>Report Currency: Select the report currency. Generally, values will be
+ converted to this currency for display.</para>
+ </listitem>
+
+ <listitem>
+ <para>Price Source: Select how stock and currency prices are calculated in this
+ report. Choose between a weighted average of prices over all transactions, prices
+ at current values, or prices at the time of the report date.</para>
+ </listitem>
- <sect1 id="report-general">
+ <listitem>
+ <para>Totals: Charts display totals in the chart legend if this option is selected.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>Maximum Slices: Controls the maximum number of slices displayed in a
+ piechart - other accounts will be placed in a slice marked Other. </para>
+ </listitem>
+
+ <listitem>
+ <para>Maximum Bars: Controls the maximum number of bars displayed in a barchart.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>Display Columns: Choose columns to show from the register.</para>
+ </listitem>
+ </itemizedlist>
+
+ </sect2>
+
+ </sect1>
+
+ <sect1 id="report-classes">
+ <title>Reports Listed By Class</title>
+
+ <para><application>&app;</application> has classified the main types of
+ reports into major classes. These
+ are all available under the Reports menu.</para>
+
+ <sect2 id="report-general">
<title>General Reports</title>
- <para>The General Reports include the Account Summary Report, Custom Reports, the Tax Schedule Report and <acronym>TXF</acronym> Export, and the Transaction Report and also the reports in the Sample & Custom menu.</para>
+ <para>The General Reports include the Account Summary Report, the Future
+ Scheduled Transactions Summary, the Tax Schedule Report and <acronym>
+ TXF</acronym> Export, and the Transaction Report and also the reports in the Sample & Custom menu.</para>
- <sect2>
+ <sect3>
<title>Account Summary</title>
<para> </para>
- </sect2>
+ </sect3>
+
+ <sect3>
+ <title>Future Scheduled Transactions Summary</title>
+ <para> </para>
+ </sect3>
- <sect2 id="report-taxreport">
+ <sect3 id="report-taxreport">
<title>Tax Schedule Report and <acronym>TXF</acronym> Export</title>
<para>The tax schedule report lists all taxable income and deductible expense amounts used in the preparation of US Income Tax returns. The purpose of the report is to provide a complete audit trail for these amounts. The report is intended to be used by a tax payer to manually prepare his or her own tax return, or alternatively, to be provided to a tax preparer for that purpose. The report can also be used to generate an export of all tax related income and expenses to a <acronym>TXF</acronym> (Tax eXchange Format) file (this is in addition to exporting to the <acronym>HTML</acronym> format that all reports allow). The <acronym>TXF</acronym> file can be imported into tax filing programs such as TaxCut or TurboTax. The report should be run, inspected carefully for errors or omissions, and then corrections made to transactions, report settings, currency conversion rates or the account structure as needed. This process should be repeated as often as needed until all the amounts on the report are correct before a final version is used and saved along with the tax returns.</para>
@@ -57,16 +318,16 @@
also must set the <acronym>TXF</acronym> category of each tax related account. The Income Tax
Information dialog is described in the <xref linkend="set-tax-options"></xref> section.</para></note>
- </sect2>
+ </sect3>
- <sect2>
+ <sect3>
<title>Transaction Report</title>
<para>This report lists transactions in selected accounts during a specified financial period. Two fields may be optionally
used for sorting and totalling.
</para>
- <sect3 id="report-txrpt-opts">
+ <sect4 id="report-txrpt-opts">
<title>Report Options</title>
<figure>
@@ -332,9 +593,9 @@
</itemizedlist>
</listitem>
</itemizedlist>
- </sect3>
+ </sect4>
- <sect3 id="report-txrpt-splits">
+ <sect4 id="report-txrpt-splits">
<title>Displaying Split Account Details</title>
<para>This is controled by the <emphasis>Style</emphasis> option on the General tab.</para>
<note>
@@ -415,38 +676,17 @@
<para><emphasis>Use Full Other Account Name</emphasis> has no effect in <emphasis>Multi-Line</emphasis> mode.</para>
- </sect3>
-
- </sect2>
-
- <sect2>
- <title>Welcome Sample Report</title>
- <para> </para>
- </sect2>
-
- <sect2>
- <title>Custom Multicolumn Report</title>
- <para>This report is used to place multiple reports
- into a single report window to examine a set of financial information at a glance.
- </para>
- </sect2>
-
- <sect2>
- <title>Sample Graphs</title>
- <para> </para>
- </sect2>
+ </sect4>
- <sect2>
- <title>Sample Report with Examples</title>
- <para> </para>
- </sect2>
-
- </sect1>
+ </sect3>
+
+ </sect2>
- <sect1 id="report-assets">
+ <sect2 id="report-assets">
<title>Assets & Liabilities</title>
- <para>The Assets & Liabilities reports includes the Balance Sheet report, Investment reports and the Net Worth report.</para>
+ <para>The Assets & Liabilities reports includes the Balance Sheet
+ report, Investment reports and the Net Worth report.</para>
<itemizedlist>
@@ -535,7 +775,7 @@
</itemizedlist>
- <para>Common report options are described in <xref linkend="report-custom"/></para>
+ <para>Common report options are described in <xref linkend="report-config"/></para>
<para>Report Specific Options</para>
@@ -679,7 +919,7 @@
</listitem>
<listitem>
- <para>General Journal:</para>
+ <para>Balance Sheet using eguile-gnc:</para>
</listitem>
<listitem>
@@ -687,6 +927,10 @@
</listitem>
<listitem>
+ <para>General Ledger:</para>
+ </listitem>
+
+ <listitem>
<para>Investment Portfolio: This report summarizes the value of the stocks in
the current portfolio.</para>
</listitem>
@@ -713,67 +957,10 @@
<para>Price Scatterplot:</para>
</listitem>
</itemizedlist>
- </sect1>
-
- <sect1 id="report-income">
- <title>Income & Expense</title>
-
- <para>The Income & Expense reports includes the Cash Flow and Income Statement reports.</para>
-
- <itemizedlist>
- <listitem>
- <para>Budget Report:</para>
- </listitem>
-
- <listitem>
- <para>Cash Flow:</para>
- </listitem>
-
- <listitem>
- <para>Equity Statement:</para>
- </listitem>
-
- <listitem>
- <para>Expense Barchart:</para>
- </listitem>
-
- <listitem>
- <para>Expense Piechart:</para>
- </listitem>
-
- <listitem>
- <para>Expense vs Day of Week:</para>
- </listitem>
-
- <listitem>
- <para>Income Barchart:</para>
- </listitem>
- <listitem>
- <para>Income & Expense Chart:</para>
- </listitem>
+ </sect2>
- <listitem>
- <para>Income Statement: This report summarizes sources of income and expenditure.
- (This report was called Profit & Loss in gnucash-1.8.)</para>
- </listitem>
-
- <listitem>
- <para>Income Statement:</para>
- </listitem>
-
- <listitem>
- <para>Income vs Day of Week:</para>
- </listitem>
-
- <listitem>
- <para>Trial Balance: This report summarizes sources of income and expenditure.</para>
- </listitem>
- </itemizedlist>
-
- </sect1>
-
- <sect1 id="report-biz">
+ <sect2 id="report-biz">
<title>Business Reports</title>
<para>The Business Reports includes Customer and Vendor Reports and Printable
@@ -785,6 +972,10 @@
</listitem>
<listitem>
+ <para>Customer Summary:</para>
+ </listitem>
+
+ <listitem>
<para>Easy Invoice:</para>
</listitem>
@@ -797,6 +988,10 @@
</listitem>
<listitem>
+ <para>Job Report:</para>
+ </listitem>
+
+ <listitem>
<para>Payable Aging:</para>
</listitem>
@@ -809,123 +1004,169 @@
</listitem>
<listitem>
+ <para>Tax Invoice:</para>
+ </listitem>
+
+ <listitem>
<para>Vendor Report:</para>
</listitem>
</itemizedlist>
- </sect1>
-
- <sect1 id="report-custom">
- <title>Customizing Reports and Graphs</title>
+ </sect2>
- <para><application>&app;</application> reports have many options
- for customization. First, run the original report itself. Then,
- access the report options with the <guibutton>Options</guibutton>
- button on the toolbar.</para>
+ <sect2 id="report-income">
+ <title>Income & Expense</title>
- <note> <para>Check changed Graphic Engine Options and describe Saving Customized Reports</para></note>
-<!--
- suggest how to save report options E.g. Choose definite options when you
- want to see an Income Statement, so you want to save them for future and
- not to choose all the time.
+ <para>The Income & Expense reports includes the Cash Flow and Income Statement reports.</para>
- File -> Add Report (in 2.0.5).
- But first, you must change the title of the report in the options. -->
+ <itemizedlist>
+ <listitem>
+ <para>Cash Flow:</para>
+ </listitem>
- <para>Many reports share similar sorts of options. Some common ones include:</para>
+ <listitem>
+ <para>Equity Statement:</para>
+ </listitem>
- <itemizedlist>
- <listitem>
- <para>Report Name: Set the title of the report. This is also used to print the
- report for later viewing.</para>
- </listitem>
+ <listitem>
+ <para>Expense Barchart:</para>
+ </listitem>
- <listitem>
- <para>Date Options: Reports typically specify either a single date, or a date
- range, for the report. Dates can be specified in two ways, either directly
- (using the date selector), or by selecting a relative date from the menu.
- Relative dates allow you to specify dates like <guilabel>Beginning of this year</guilabel> or
- <guilabel>Today</guilabel>.</para>
- </listitem>
+ <listitem>
+ <para>Expense Piechart:</para>
+ </listitem>
- <listitem>
- <para>Step Size: This option is used on bar charts to determine the interval which
- each bar represents. Typical values are daily, weekly, monthly, and yearly.</para>
- </listitem>
+ <listitem>
+ <para>Expense vs Day of Week:</para>
+ </listitem>
- <listitem>
- <para>Accounts: Select the appropriate accounts for the report. Note that in some
- reports only certain types of accounts can be selected. For example, an expense
- piechart only allows expense accounts to be selected. </para>
- </listitem>
+ <listitem>
+ <para>Income & Expense Chart:</para>
+ </listitem>
- <listitem>
- <para>Show Long Account Names: This option allows displaying either short account
- names (for example, Power) or long account names (for example, Utilities:Power).
- </para>
- </listitem>
+ <listitem>
+ <para>Income Barchart:</para>
+ </listitem>
- <listitem>
- <para>Include Subaccounts?: Summary reports typically have an include all
- subaccounts option, which if selected ensures that all subaccounts are included
- if the parent account is.</para>
- </listitem>
+ <listitem>
+ <para>Income Piechart:</para>
+ </listitem>
- <listitem>
- <para>Depth: This option allows the selection of how many levels the report
- displays subaccounts. If the subaccounts go deeper than selected, an overall value
- for all the subaccounts is calculated and included in a total. To make sure every
- account selected is individually displayed, select <guibutton>All</guibutton>.</para>
- </listitem>
+ <listitem>
+ <para>Income Statement: This report summarizes sources of income and expenditure.
+ (This report was called Profit & Loss in gnucash-1.8.)</para>
+ </listitem>
- <listitem>
- <para>Style Sheet: Select a Style Sheet. Style sheets control how reports are
- displayed. At the moment, there are four style sheets: <guilabel>Default</guilabel>, <guilabel>Easy</guilabel>,
- <guilabel>Footer</guilabel> and <guilabel>Technicolor</guilabel>.
- You can customize each of these from the <menuchoice><guimenu>Edit</guimenu><guimenuitem>Style
- Sheets...</guimenuitem></menuchoice> menu item.
- This is described in the Changing Style Sheets section. <xref linkend="change-style"></xref></para>
- </listitem>
+ <listitem>
+ <para>Income vs Day of Week:</para>
+ </listitem>
- <listitem>
- <para>Plot Dimensions: There are width and height options for most graphs, which
- specify the displayed dimensions (in pixels).</para>
- </listitem>
+ <listitem>
+ <para>Profit & Loss: This is the same report as the Income Statement but with a different title.</para>
+ </listitem>
- <listitem>
- <para>Report Currency: Select the report currency. Generally, values will be
- converted to this currency for display.</para>
- </listitem>
+ <listitem>
+ <para>Trial Balance: This report summarizes sources of income and expenditure.</para>
+ </listitem>
+ </itemizedlist>
- <listitem>
- <para>Price Source: Select how stock and currency prices are calculated in this
- report. Choose between a weighted average of prices over all transactions, prices
- at current values, or prices at the time of the report date.</para>
- </listitem>
+ </sect2>
+
+ <sect2 id="report-sample">
+ <title>Sample & Custom</title>
- <listitem>
- <para>Totals: Charts display totals in the chart legend if this option is selected.
- </para>
- </listitem>
+ <sect3>
+ <title>Welcome Sample Report</title>
+ <para> </para>
+ </sect3>
- <listitem>
- <para>Maximum Slices: Controls the maximum number of slices displayed in a
- piechart - other accounts will be placed in a slice marked Other. </para>
- </listitem>
+ <sect3>
+ <title>Custom Multicolumn Report</title>
+ <para>This report is used to place multiple reports
+ into a single report window to examine a set of financial information at a glance.
+ </para>
+ </sect3>
- <listitem>
- <para>Maximum Bars: Controls the maximum number of bars displayed in a barchart.
- </para>
- </listitem>
+ <sect3>
+ <title>Sample Report with Examples</title>
+ <para> </para>
+ </sect3>
- <listitem>
- <para>Display Columns: Choose columns to show from the register.</para>
- </listitem>
- </itemizedlist>
- </sect1>
+ </sect2>
+ <sect2 id="report-budget">
+ <title>Budget</title>
+
+ <sect3>
+ <title>Budget Balance Sheet</title>
+ <para> </para>
+ </sect3>
+
+ <sect3>
+ <title>Budget Barchart</title>
+ <para> </para>
+ </sect3>
+
+ <sect3>
+ <title>Budget Flow</title>
+ <para> </para>
+ </sect3>
+
+ <sect3>
+ <title>Budget Income Statement</title>
+ <para> </para>
+ </sect3>
+
+ <sect3>
+ <title>Budget Profit & Loss</title>
+ <para> </para>
+ </sect3>
+
+ <sect3>
+ <title>Budget Report</title>
+ <para>This report is used to compare budgeted and real amounts for selected accounts. It allows you to review how well you follow the budget.</para>
+ <para>The report is generated as a table in which each row represents an account and each set of columns shows the <emphasis>budgeted amount</emphasis>, the <emphasis>real amount</emphasis>, and the <emphasis>difference</emphasis> between them for each report period.</para>
+ <para>Each entry in the <emphasis>real amount</emphasis> column is the sum of all the splits in the row's account over the column's period. For example, if the report is set up for monthly periods, the column is for May, and the row is for Expences:Groceries, then the value will be the sum of all Expenses:Groceries splits for that May.</para>
+ <para>The report supports selecting a range of periods instead all of them. Periods that are out of range can be included in report as the consolidated columns around the selected range. This allows you to focus on particular periods, for example the current one, and is especially useful for budgets with many periods. For example, if you have a 12 period budget you can make a 3 column report with the format "(all periods before columns set) (current period columns set) (all periods after columns set)" that is easily fits on the screen and allows you to match values with account names.</para>
+ <para><emphasis>Budget report options</emphasis></para>
+ <para>
+ <note><para>Here we describe only options that are specific for the Budget Report. You can find information about standard parameters in <xref linkend="report-config"/>.</para> </note>
+ <itemizedlist>
+ <listitem><para><emphasis>Show budget</emphasis> - include the budgeted values for the period</para></listitem>
+ <listitem><para><emphasis>Show actual</emphasis> - include the real values for the period</para></listitem>
+ <listitem><para><emphasis>Show difference</emphasis> - include the difference between budgeted and real values for the period. Enabling this option does not force including budgeted and actual values in report</para></listitem>
+ <listitem><para><emphasis>Show Column with totals</emphasis> - Adds a final column set containing budgeted, real value, and difference columns summing those values across all periods of the report.</para></listitem>
+ <listitem><para><emphasis>Rollup budget amounts to parent</emphasis> - not used in report, can be deleted or should be fixed</para></listitem>
+ <listitem><para><emphasis>Include accounts with zero total balances and budget values</emphasis> - enables display of accounts with no budget or splits in any period.</para></listitem>
+ <listitem><para><emphasis>Budget</emphasis> - Select the budget to use for report generation</para></listitem>
+ <listitem><para><emphasis>Report for range of budget periods</emphasis> - Enables reporting on a subset of the budget by selecting a beginning and an ending period.</para></listitem>
+ <listitem><para><emphasis>Range start</emphasis> - a combobox with a list of variants how to select start period:
+ <orderedlist>
+ <listitem><para><emphasis>First</emphasis> - select first budget period</para></listitem>
+ <listitem><para><emphasis>Previous</emphasis> - select previous period.</para></listitem>
+ <listitem><para><emphasis>Current</emphasis> - select current period.</para></listitem>
+ <listitem><para><emphasis>Next</emphasis> - select next period.</para></listitem>
+ <listitem><para><emphasis>Last</emphasis> - select last budget period</para></listitem>
+ <listitem><para><emphasis>Manual</emphasis> - enables spinbox where you can select exact period</para></listitem>
+ </orderedlist></para>
+ <note><para>The <emphasis>current</emphasis>, <emphasis>previous</emphasis>, and <emphasis>next</emphasis> options select the period based on the date on which the report is run, with <emphasis>current</emphasis> being the period in which the date falls, <emphasis>previous</emphasis> being the one before that, and <emphasis>next</emphasis> the period after. If the current date falls outside the date range covered by the budget, the <emphasis>first</emphasis> or <emphasis>last</emphasis> period will be used as appropriate.</para></note>
+ </listitem>
+ <listitem><para><emphasis>Exact start period</emphasis> - options for select exact start period, enabled only if range start option is set to <emphasis>Manual</emphasis></para></listitem>
+ <listitem><para><emphasis>Range end</emphasis> - a combobox with a list of variants how to select end period. Values are the same as in <emphasis>Range start</emphasis> options</para></listitem>
+ <listitem><para><emphasis>Exact end period</emphasis> - the same as <emphasis>Exact start period</emphasis> but for the end of range</para></listitem>
+ <listitem><para><emphasis>Include collapsed periods before selected</emphasis> - if on, then includes in report all budget periods, that are before selected period range, as a single consolidated column set</para></listitem>
+ <listitem><para><emphasis>Include collapsed periods after selected</emphasis> - if on, then includes in report all budget periods, that are after selected period range, as a single consolidated column set.</para></listitem>
+ </itemizedlist>
+ </para>
+
+ </sect3>
+
+ </sect2>
+
+ </sect1>
+
<sect1 id="report-print">
- <title>Printing or Exporting Reports and Graphs</title>
+ <title>Printing or Exporting Reports and Charts</title>
<note><para> Verify !!! How customize printing with Gnome?</para></note>
@@ -933,7 +1174,8 @@
Print <application>&app;</application> Document dialog is accessed from the <guibutton>Print</guibutton> button on the <emphasis>Toolbar</emphasis> or
go to <menuchoice><guimenu>File</guimenu><guimenuitem>Print</guimenuitem></menuchoice> in the menu. To Export a report to a web page (<acronym>HTML</acronym>) select
the <guibutton>Export</guibutton> button on the <emphasis>Toolbar</emphasis> and type in a file name.</para>
-
+
+ <para>Most reports, being presented in HTML, can also be copied and pasted into a spreadsheet.</para>
<para>The Print <application>&app;</application> Document dialog is used to select which Printer to send the
print job to or to print to a File. It also contains a Preview button to view the
@@ -947,7 +1189,7 @@
</sect1>
<sect1 id="report-create">
- <title>Creating Reports and Graphs</title>
+ <title>Creating Reports and Charts</title>
<note><para>This section may need updating !!!</para> </note>
Summary of changes:
help/C/Help_ch_Reports.xml | 634 +++++++++++++++++++++++++++++++--------------
1 file changed, 438 insertions(+), 196 deletions(-)
More information about the gnucash-changes
mailing list