gnucash-docs maint: Multiple changes pushed
Frank H.Ellenberger
fell at code.gnucash.org
Sat Jan 30 18:56:53 EST 2021
Updated via https://github.com/Gnucash/gnucash-docs/commit/66642079 (commit)
via https://github.com/Gnucash/gnucash-docs/commit/ff55930c (commit)
from https://github.com/Gnucash/gnucash-docs/commit/3a3ff9fe (commit)
commit 66642079b334d8ac1040b2f69b086ec0f555039a
Author: Frank H. Ellenberger <frank.h.ellenberger at gmail.com>
Date: Sun Jan 31 00:56:40 2021 +0100
Guide: New year
diff --git a/help/C/gnucash-help.xml b/help/C/gnucash-help.xml
index 468d882..5e65872 100644
--- a/help/C/gnucash-help.xml
+++ b/help/C/gnucash-help.xml
@@ -21,7 +21,7 @@
<edition>v&manrevision;</edition>
<copyright>
- <year>2002-2020</year>
+ <year>2002-2021</year>
<holder>&appname; Documentation Team</holder>
</copyright>
commit ff55930cdf2ffebf15424b6ad9fac4866d1b9231
Author: Frank H. Ellenberger <frank.h.ellenberger at gmail.com>
Date: Sun Jan 31 00:53:01 2021 +0100
Update saved-reports location
diff --git a/help/C/Help_ch_Reports.xml b/help/C/Help_ch_Reports.xml
index 43369dc..3f42e2c 100644
--- a/help/C/Help_ch_Reports.xml
+++ b/help/C/Help_ch_Reports.xml
@@ -36,22 +36,21 @@
advanced portfolio view. This section will present an explanation of the main &app;
reports and how to adjust them.</para>
- <para>To run a report or chart, click on the <menuchoice><guimenu>Reports
- </guimenu></menuchoice> menu, then either select
+ <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>Once the report has opened, click on the <emphasis>toolbar</emphasis>
+ button <guibutton>Options</guibutton> 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
+ 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>
</tip>
@@ -67,17 +66,18 @@
<tip>
<para>If you cannot find a specific report to suit your requirements, you
may be able to use the <guilabel>Find Transaction</guilabel> assistant
- (<menuchoice><guimenu>Edit</guimenu><guimenuitem>Find</guimenuitem>
- </menuchoice>) to select a set of transactions, and then report them
- using <menuchoice><guimenu>Reports</guimenu><guimenuitem>Account Report
- </guimenuitem></menuchoice>. Further formatting or analysis may be done
+ (<menuchoice><guimenu>Edit</guimenu><guimenuitem>Find</guimenuitem></menuchoice>)
+ to select a set of transactions, and then report them
+ using <menuchoice><guimenu>Reports</guimenu>
+ <guimenuitem>Account Report</guimenuitem>
+ </menuchoice>. Further formatting or analysis may be done
by copying and pasting the report into a spreadsheet.
</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>
+ future use by clicking either the <guibutton>Save Report Configuration</guibutton>
+ or <guibutton>Save Report Configuration As...</guibutton>
button.
</para>
@@ -86,21 +86,26 @@
<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>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>
+ store your customized report options in a file below your home directory.
+ <!-- FIXME by adding the wiki page to the appendix -->
+ The exact location depends on your OS, its version and the &app; version.
+ See <ulink url="&url-wiki;Configuration_Locations#GTK_CONFIG_HOME">wiki:Configuration_Locations#GTK_CONFIG_HOME</ulink>,
+ <ulink url="&url-wiki;Configuration_Locations#GNC_DATA_HOME">GNC_DATA_HOME</ulink> and
+ <ulink url="&url-wiki;Configuration_Locations#In_GNC_DATA_HOME">Files in GNC_DATA_HOME</ulink>
+ Then it is <filename>GNC_DATA_HOME/saved-reports-<replaceable>version</replaceable></filename>.
</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.
+ 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
@@ -115,8 +120,7 @@
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>.
+ & Custom</guisubmenu><guimenuitem>Custom Multicolumn Report</guimenuitem></menuchoice>.
</para>
</sect2>
@@ -126,8 +130,8 @@
<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
+ window with the 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>
@@ -161,7 +165,7 @@
<para>&app; 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>
+ button on the <emphasis>toolbar</emphasis>.</para>
<note> <para>Check changed Graphic Engine Options</para></note>
@@ -182,8 +186,8 @@
<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,
+ 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>
@@ -218,9 +222,10 @@
<tip><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
+ dates in <menuchoice><guimenu>Edit</guimenu>
+ <guisubmenu>Preferences</guisubmenu>
+ <guimenuitem>Accounting Period</guimenuitem></menuchoice>
+ then select appropriate report date
options. See <xref linkend="prefs-accounting-period" />.</para>
</tip>
@@ -234,7 +239,7 @@
<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>
+ piechart only allows expense accounts to be selected.</para>
</listitem>
<listitem>
@@ -298,7 +303,7 @@
<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>
+ piechart - other accounts will be placed in a slice marked Other.</para>
</listitem>
<listitem>
@@ -310,9 +315,7 @@
<para>Display Columns: Choose columns to show from the register.</para>
</listitem>
</itemizedlist>
-
- </sect2>
-
+ </sect2>
</sect1>
<sect1 id="report-classes">
@@ -868,14 +871,14 @@
</para>
<para>For example given an account structure like
</para>
- <literallayout>
- Assets (type ASSET)
- Broker (type ASSET)
- Widget Stock (type STOCK)
- Income (type INCOME)
- Dividends (type INCOME)
- Widget Stock (type INCOME)
- </literallayout>
+<literallayout>
+Assets (type ASSET)
+ Broker (type ASSET)
+ Widget Stock (type STOCK)
+Income (type INCOME)
+ Dividends (type INCOME)
+ Widget Stock (type INCOME)
+</literallayout>
<para>A transaction that debits the "Assets:Broker" account and credits the "Income:Dividends:Widget Stock" account will count as income even though it doesn't have a split with account "Assets:Broker:Widget Stock".
</para>
<para>This only works if the parent account ("Assets:Broker" in this case) is a Bank or Asset account and the Income/Expense account has the same name as the stock account. It won't double count transactions that have a dummy split since they won't have exactly two split transactions.
@@ -1640,7 +1643,7 @@
<para>The report supports selecting a range of periods instead all of them. Periods that are out of range can be included in the 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>
+ <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>
@@ -1681,7 +1684,7 @@
<note><para> Verify !!! How customize printing with Gnome?</para></note>
<para>&app; is able to print reports and to export the reports to <acronym>HTML</acronym> (web) pages. The
- Print &app; Document dialog is accessed from the <guibutton>Print</guibutton> button on the <emphasis>Toolbar</emphasis> or
+ Print &app; 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>
@@ -1701,11 +1704,11 @@
<sect1 id="report-create">
<title>Creating Reports and Charts</title>
- <note><para>This section may need updating !!!</para> </note>
+ <note><para>This section may need updating !!!</para></note>
<para>It is possible to write reports if the current ones are not suitable. To do this
you will need to know Scheme (a LISP-like programming language), and it is an
- excellent idea to have a copy of the &app; source code available. </para>
+ excellent idea to have a copy of the &app; source code available.</para>
<para>The reporting interface is documented in the source code file
<filename>src/report/report-system/doc/report-html.txt</filename>.
Summary of changes:
help/C/Help_ch_Reports.xml | 99 ++++++++++++++++++++++++----------------------
help/C/gnucash-help.xml | 2 +-
2 files changed, 52 insertions(+), 49 deletions(-)
More information about the gnucash-changes
mailing list