Skip to content

Commit ff55930

Browse files
committed
Update saved-reports location
1 parent 3a3ff9f commit ff55930

File tree

1 file changed

+51
-48
lines changed

1 file changed

+51
-48
lines changed

help/C/Help_ch_Reports.xml

Lines changed: 51 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -36,22 +36,21 @@
3636
advanced portfolio view. This section will present an explanation of the main &app;
3737
reports and how to adjust them.</para>
3838

39-
<para>To run a report or chart, click on the <menuchoice><guimenu>Reports
40-
</guimenu></menuchoice> menu, then either select
39+
<para>To run a report or chart, click on the
40+
<menuchoice><guimenu>Reports</guimenu></menuchoice> menu, then either select
4141
a report (it will open with standard options), or click on <guibutton>
4242
Saved Report Configuration</guibutton> to select a report you have
4343
previously configured and saved.
4444
</para>
4545

46-
<para>Once the report has opened, click on the <guibutton>Options
47-
</guibutton> toolbar button to
48-
configure the report as needed, for example to set the report date or
49-
select accounts.
46+
<para>Once the report has opened, click on the <emphasis>toolbar</emphasis>
47+
button <guibutton>Options</guibutton> to configure the report as needed,
48+
for example to set the report date or select accounts.
5049
</para>
5150

5251
<tip><para>If you intend to save a report configuration, you
53-
should choose a named report date option such as <emphasis>Today
54-
</emphasis>rather than enter a specific date so it is not necessary to
52+
should choose a named report date option such as <emphasis>Today</emphasis>
53+
rather than enter a specific date so it is not necessary to
5554
enter a specific date again in future reports.</para>
5655
</tip>
5756

@@ -67,17 +66,18 @@
6766
<tip>
6867
<para>If you cannot find a specific report to suit your requirements, you
6968
may be able to use the <guilabel>Find Transaction</guilabel> assistant
70-
(<menuchoice><guimenu>Edit</guimenu><guimenuitem>Find</guimenuitem>
71-
</menuchoice>) to select a set of transactions, and then report them
72-
using <menuchoice><guimenu>Reports</guimenu><guimenuitem>Account Report
73-
</guimenuitem></menuchoice>. Further formatting or analysis may be done
69+
(<menuchoice><guimenu>Edit</guimenu><guimenuitem>Find</guimenuitem></menuchoice>)
70+
to select a set of transactions, and then report them
71+
using <menuchoice><guimenu>Reports</guimenu>
72+
<guimenuitem>Account Report</guimenuitem>
73+
</menuchoice>. Further formatting or analysis may be done
7474
by copying and pasting the report into a spreadsheet.
7575
</para>
7676
</tip>
7777

7878
<para>After you have configured a report, you can save the configuration for
79-
future use by clicking either the <guibutton>Save Report Configuration
80-
</guibutton> or <guibutton>Save Report Configuration As...</guibutton>
79+
future use by clicking either the <guibutton>Save Report Configuration</guibutton>
80+
or <guibutton>Save Report Configuration As...</guibutton>
8181
button.
8282
</para>
8383

@@ -86,21 +86,26 @@
8686

8787
<para>To save a report configuration for future use, while the required
8888
report tab is selected, go to the report options, select the
89-
<emphasis>General</emphasis> tab and change the <emphasis>Report Name
90-
</emphasis> to a meaningful unique name. Do not confuse this with the
89+
<emphasis>General</emphasis> tab and change the <emphasis>Report Name</emphasis>
90+
to a meaningful unique name. Do not confuse this with the
9191
<emphasis>Report Title</emphasis> which prints at the top of a report.
9292
</para>
9393

9494
<para>Click the <guibutton>Save Report Configuration</guibutton> or
9595
<guibutton>Save Report Configuration As...</guibutton> button. This will
96-
store your customized report options in a file in your home directory.
97-
E.g. Linux: <emphasis>~/.gnucash/saved-reports-[versioninfo]</emphasis>
96+
store your customized report options in a file below your home directory.
97+
<!-- FIXME by adding the wiki page to the appendix -->
98+
The exact location depends on your OS, its version and the &app; version.
99+
See <ulink url="&url-wiki;Configuration_Locations#GTK_CONFIG_HOME">wiki:Configuration_Locations#GTK_CONFIG_HOME</ulink>,
100+
<ulink url="&url-wiki;Configuration_Locations#GNC_DATA_HOME">GNC_DATA_HOME</ulink> and
101+
<ulink url="&url-wiki;Configuration_Locations#In_GNC_DATA_HOME">Files in GNC_DATA_HOME</ulink>
102+
Then it is <filename>GNC_DATA_HOME/saved-reports-<replaceable>version</replaceable></filename>.
98103
</para>
99104

100105
<para>The first time you save a report with a name that has not already
101-
been saved, you can use either the <guibutton>Save Report Configuration
102-
</guibutton> or the <guibutton>Save Report Configuration As...
103-
</guibutton> button. You can modify the report name before saving it.
106+
been saved, you can use either the <guibutton>Save Report Configuration</guibutton>
107+
or the <guibutton>Save Report Configuration As...</guibutton>
108+
button. You can modify the report name before saving it.
104109
</para>
105110

106111
<para>After a report configuration for a specific name has been saved, the
@@ -115,8 +120,7 @@
115120
by the <menuchoice><guimenu>Reports</guimenu><guimenuitem>Saved Report
116121
Configurations</guimenuitem></menuchoice> menu and it will also be listed
117122
when starting <menuchoice><guimenu>Reports</guimenu><guisubmenu>Sample
118-
&amp; Custom</guisubmenu><guimenuitem>Custom Multicolumn Report
119-
</guimenuitem></menuchoice>.
123+
&amp; Custom</guisubmenu><guimenuitem>Custom Multicolumn Report</guimenuitem></menuchoice>.
120124
</para>
121125

122126
</sect2>
@@ -126,8 +130,8 @@
126130

127131
<para>Selecting <menuchoice><guimenu>Reports</guimenu><guimenuitem>Saved
128132
Report Configurations</guimenuitem></menuchoice> will open a dialog
129-
window with a list of the <emphasis>Saved Report Configurations
130-
</emphasis> you have previously created. In this
133+
window with the list of the <emphasis>Saved Report Configurations</emphasis>
134+
you have previously created. In this
131135
context <emphasis>Saved Report Configurations</emphasis> means the set of
132136
customized settings for standard reports.
133137
</para>
@@ -161,7 +165,7 @@
161165
<para>&app; reports have many configuration
162166
options. First, run the original report itself. Then,
163167
access the report options with the <guibutton>Options</guibutton>
164-
button on the toolbar.</para>
168+
button on the <emphasis>toolbar</emphasis>.</para>
165169

166170
<note> <para>Check changed Graphic Engine Options</para></note>
167171

@@ -182,8 +186,8 @@
182186
<listitem>
183187
<para>Click the <guibutton>Apply</guibutton> button to apply the
184188
changes, regenerate the report and leave the options window open for
185-
possible further changes. In this case, both the <guibutton>Apply
186-
</guibutton> and <guibutton>OK</guibutton> buttons will be disabled,
189+
possible further changes. In this case, both the <guibutton>Apply</guibutton>
190+
and <guibutton>OK</guibutton> buttons will be disabled,
187191
indicating changes have been applied, until further changes are made.
188192
</para>
189193

@@ -218,9 +222,10 @@
218222

219223
<tip><para>If you often run a report with a date as at the start or end
220224
of an accounting period, set the accounting period start and end
221-
dates in <menuchoice><guimenu>Edit</guimenu><guisubmenu>
222-
Preferences</guisubmenu><guimenuitem>Accounting Period
223-
</guimenuitem></menuchoice> then select appropriate report date
225+
dates in <menuchoice><guimenu>Edit</guimenu>
226+
<guisubmenu>Preferences</guisubmenu>
227+
<guimenuitem>Accounting Period</guimenuitem></menuchoice>
228+
then select appropriate report date
224229
options. See <xref linkend="prefs-accounting-period" />.</para>
225230
</tip>
226231

@@ -234,7 +239,7 @@
234239
<listitem>
235240
<para>Accounts: Select the appropriate accounts for the report. Note that in some
236241
reports only certain types of accounts can be selected. For example, an expense
237-
piechart only allows expense accounts to be selected. </para>
242+
piechart only allows expense accounts to be selected.</para>
238243
</listitem>
239244

240245
<listitem>
@@ -298,7 +303,7 @@
298303

299304
<listitem>
300305
<para>Maximum Slices: Controls the maximum number of slices displayed in a
301-
piechart - other accounts will be placed in a slice marked Other. </para>
306+
piechart - other accounts will be placed in a slice marked Other.</para>
302307
</listitem>
303308

304309
<listitem>
@@ -310,9 +315,7 @@
310315
<para>Display Columns: Choose columns to show from the register.</para>
311316
</listitem>
312317
</itemizedlist>
313-
314-
</sect2>
315-
318+
</sect2>
316319
</sect1>
317320

318321
<sect1 id="report-classes">
@@ -868,14 +871,14 @@
868871
</para>
869872
<para>For example given an account structure like
870873
</para>
871-
<literallayout>
872-
Assets (type ASSET)
873-
Broker (type ASSET)
874-
Widget Stock (type STOCK)
875-
Income (type INCOME)
876-
Dividends (type INCOME)
877-
Widget Stock (type INCOME)
878-
</literallayout>
874+
<literallayout>
875+
Assets (type ASSET)
876+
Broker (type ASSET)
877+
Widget Stock (type STOCK)
878+
Income (type INCOME)
879+
Dividends (type INCOME)
880+
Widget Stock (type INCOME)
881+
</literallayout>
879882
<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".
880883
</para>
881884
<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 @@
16401643
<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>
16411644
<para><emphasis>Budget report options</emphasis></para>
16421645
<para>
1643-
<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>
1646+
<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>
16441647
<itemizedlist>
16451648
<listitem><para><emphasis>Show budget</emphasis> - include the budgeted values for the period</para></listitem>
16461649
<listitem><para><emphasis>Show actual</emphasis> - include the real values for the period</para></listitem>
@@ -1681,7 +1684,7 @@
16811684
<note><para> Verify !!! How customize printing with Gnome?</para></note>
16821685

16831686
<para>&app; is able to print reports and to export the reports to <acronym>HTML</acronym> (web) pages. The
1684-
Print &app; Document dialog is accessed from the <guibutton>Print</guibutton> button on the <emphasis>Toolbar</emphasis> or
1687+
Print &app; Document dialog is accessed from the <guibutton>Print</guibutton> button on the <emphasis>toolbar</emphasis> or
16851688
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
16861689
the <guibutton>Export</guibutton> button on the <emphasis>Toolbar</emphasis> and type in a file name.</para>
16871690

@@ -1701,11 +1704,11 @@
17011704
<sect1 id="report-create">
17021705
<title>Creating Reports and Charts</title>
17031706

1704-
<note><para>This section may need updating !!!</para> </note>
1707+
<note><para>This section may need updating !!!</para></note>
17051708

17061709
<para>It is possible to write reports if the current ones are not suitable. To do this
17071710
you will need to know Scheme (a LISP-like programming language), and it is an
1708-
excellent idea to have a copy of the &app; source code available. </para>
1711+
excellent idea to have a copy of the &app; source code available.</para>
17091712

17101713
<para>The reporting interface is documented in the source code file
17111714
<filename>src/report/report-system/doc/report-html.txt</filename>.

0 commit comments

Comments
 (0)