[office/kmymoney/update-docs] doc: Second update to Reports Chapter of Handbook
Jack Ostroff
null at kde.org
Wed Jan 4 23:41:01 GMT 2023
Git commit b6e0f47b631df6229aec2d00df351d87ebe3ae71 by Jack Ostroff.
Committed on 04/01/2023 at 23:39.
Pushed by ostroffjh into branch 'update-docs'.
Second update to Reports Chapter of Handbook
M +349 -123 doc/details-reports.docbook
M +1 -1 doc/whatsnew.docbook
https://invent.kde.org/office/kmymoney/commit/b6e0f47b631df6229aec2d00df351d87ebe3ae71
diff --git a/doc/details-reports.docbook b/doc/details-reports.docbook
index d5db5f1d2..1b1940a79 100644
--- a/doc/details-reports.docbook
+++ b/doc/details-reports.docbook
@@ -326,145 +326,374 @@
<para>
The Report Configuration dialog has a number of tabs across the top, with
- subtabs below them. Each tab displays options for configuring different aspects of
- the report.
+ subtabs below them. Each tab displays options for configuring different
+ aspects of the report.
</para>
</sect2>
-<sect2><title>Report Tab</title>
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="report_configuration-reporttab.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Report Configuration -Report</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
- Note that this screenshot shows the old names of the Criteria and Result
- Tabs, which have been changed to Report and Filters. Different reports
- will show different subsets of the subtabs, appropriate for configuring
- that particular report. In addition, many of the subtabs shown under
- the Report Tab have been moved to the Filters Tab.
-</para>
-
-<sect3>
-<title>General Subtab</title>
+<sect2><title>Budgets</title>
<para>
- Here you set the basic properties of this report.
-<itemizedlist>
- <listitem><para>Report Name: Choose a name for this report.</para></listitem>
- <listitem><para>Comment: Enter a comment to help you remember the details of
- this report, or to distinguish reports with the same name.</para></listitem>
- <listitem><para>Convert values to base currency: Select this option to convert
- all values in the report to your base currency. Leave it unchecked to see
- values in their original currency. If currencies are not converted, then
- subtotals will not be shown.</para></listitem>
- <listitem><para>Mark as favorite report: Check this to cause this report to
- show up on the home page and in the group of <guilabel>Favorite
- Reports</guilabel>.</para></listitem>
-</itemizedlist>
-</para>
-</sect3>
-
-<sect3 id="details.reports.config.rowscolumns">
-<title>Rows/Columns Subtab</title>
-<para>
- This is where you configure the selection and organization of the rows and
- columns shown in the report. This tab presents different configuration
- options depending on the style of report you have selected.
+ The configuration dialog for reports which display amounts over time may
+ include budget related settings. These are only enabled if you do have one or
+ more budgets defined, and include a drop-down to to select one of those
+ budgets. If one is selected, the report will show the budgeted amount per
+ time period rather that the actual amounts from transaction in that period.
+ In addition, some reports may also give you the option of displaying both the
+ bugdeted and actual amounts, so you can compare them.
</para>
+</sect2>
+<sect2><title>Report Tab</title>
<para>
<screenshot>
<mediaobject>
<imageobject>
- <imagedata fileref="report_configuration-rowscolumns.png" format="PNG" />
+ <imagedata fileref="report_configuration-reporttab.png" format="PNG" />
</imageobject>
<textobject>
- <phrase>Report Configuration -Rows and Columns</phrase>
+ <phrase>Report Configuration -Report</phrase>
</textobject>
</mediaobject>
</screenshot>
+ Note that this screenshot shows the old names of the Criteria and Result Tabs,
+ which have been changed to Report and Filters. Different reports will show
+ different subsets of the subtabs, appropriate for configuring that particular
+ report. In addition, many of the subtabs have been moved from from the Report
+ Tab to the Filters Tab.
</para>
+<sect3>
+<title>General Subtab</title>
<para>
- For income/expense and net worth reports:
-<itemizedlist>
- <listitem><para>Columns: Choose how large of a time period each column should
- encompass</para></listitem>
- <listitem><para>Rows: Choose what kind of accounts to display as the rows of
- this report</para></listitem>
- <listitem><para>Detail: Choose the level of detail required for this
- report.</para></listitem>
-</itemizedlist>
-</para>
+ Here you set the basic properties of this report.
+ <itemizedlist>
+ <listitem>
+ <para>
+ Report Name: Choose a name for this report.
+ </para>
+ </listitem>
-<para>The following levels of detail are available:
-<itemizedlist>
- <listitem><para>All: Show every category or account.</para></listitem>
- <listitem><para>Top-Level: Show only the highest-level categories or accounts,
- and roll up the sums of the subordinates categories or accounts into those
- values.</para></listitem>
- <listitem><para>Groups: Show only the totals of the income, expenses, assets,
- or liabilities.</para></listitem>
- <listitem><para>Total: Show only the grand totals line.</para></listitem>
-</itemizedlist>
-</para>
+ <listitem>
+ <para>
+ Comment: Enter a comment to help you remember the details of
+ this report, or to distinguish reports with the same name.
+ </para>
+ </listitem>
-<para>
- For transaction reports:
-<itemizedlist>
- <listitem><para>Organize by: Choose how to group the transactions in this
- report.</para></listitem>
- <listitem><para>Show Columns: Choose which columns should be shown in the
- report. The date and transaction amount are always shown.</para></listitem>
- <listitem><para>Include only Tax Categories: Only show categories which have
- been marked as tax-related.</para></listitem>
- <listitem><para>Include only Investment Accounts: Only show transactions from
- investment accounts.</para></listitem>
- <listitem><para>Include only Loan Accounts: Only show transactions from loan
- accounts.</para></listitem>
-</itemizedlist>
+ <listitem>
+ <para>
+ Convert values to base currency: Select this option to convert all values
+ in the report to your base currency. Leave it unchecked to see values in
+ their original currency. If currencies are not converted, then subtotals
+ will not be shown.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Mark as favorite report: Check this to cause this report to show up on the
+ home page and in the group of <guilabel>Favorite Reports</guilabel>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Skip value if price is zero: This is only enabled for investments reports
+ which show prices instead of balances. Select this option to include
+ prices only if there is an actual price for the date. If not, 0 will be
+ shown. In the graph, the value will be skipped.
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
+</sect3>
+
+<sect3 id="details.reports.config.rowscolumns">
+<title>Rows/Columns Subtab</title>
+ <para>
+ This is where you configure the selection and organization of the rows and
+ columns shown in the report. This tab presents different configuration
+ options depending on the type of report you have selected.
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="report_configuration-rowscolumns.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Report Configuration -Rows and Columns</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+
+ <para>
+ For Income and Expenses and for Net Worth reports:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Budget: see discussion above
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Show totals column: Check this to display a column showing the total
+ for each row.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Show totals row: Check this to display a row showing the total for
+ each column.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Rows: Choose what kind of accounts to display as the rows of this
+ report
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Detail: Choose the level of detail required for this report. The
+ following levels of detail are available:
+ <itemizedlist>
+ <listitem>
+ <para>
+ All: Show every category or account.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Top-Level: Show only the highest-level categories or accounts,
+ and roll up the sums of the subordinate categories or accounts
+ into those values.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Groups: Show only the totals of the categories or accounts.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Totals: Show only the grand totals row.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Average days: Only enabled for relevant reports. Set how long of a
+ time period each column should encompass.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Columns: Choose how large of a time period each column should encompass
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Include scheduled transactions: Check this to include scheduled
+ transactions that have not yet been entered.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Include transfers: Unless you check this, transfers are excluded from
+ transaction reports.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Include unused accounts/categories: Unless you check this, rows which
+ would have zero values are not displayed.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+
+
+ <para>
+ For Transactions reports:
+ <itemizedlist>
+ <listitem>
+ <para>
+ Organize by: Choose how to group the transactions in this report.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Show Columns: Choose which transaction details should be shown in the
+ report. The date and transaction amount are always shown.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Include only Tax categories: Only show categories which have been
+ marked as tax-related.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Include only Investment accounts: Only show transactions from
+ investment accounts.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Include only Loan accounts: Only show transactions from Loan accounts.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Include transfers: Unless you check this, transfers are excluded from
+ transaction reports.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Hide Split Transaction Details: Do not display the detailed splits,
+ just the overall account details.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Hide Transactions: Do not display the transactions, leaving only the totals
+ displayed.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Hide Totals: Only display the transactions, not the totals.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
</sect3>
-</sect2>
-<sect2>
-<title>Chart Tab</title>
+<sect3>
+<title>Chart Subtab</title>
<para>
- This tab allows you to configure what the report should look like when it is
+ This tab allows you to configure what the report looks like when it is
displayed as a chart. See the <link linkend="details.reports.charts">Graphs
& Charts</link> section for more explanation of the charting functions.
-<itemizedlist>
- <listitem><para>Chart Type: The visual format of chart
- desired.</para></listitem>
- <listitem><para>Show grid lines: Whether to print horizontal and vertical grid
- lines on the chart.</para></listitem>
- <listitem><para>Draw values on chart: Whether to print the data values on the
- chart itself for chosen data points.</para></listitem>
- <listitem><para>Show chart by default: Whether this report should first be
- displayed as a chart when it's opened.</para></listitem>
- <listitem><para>Line width: The width of data lines on the
- chart.</para></listitem>
-</itemizedlist>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ Chart Type: The visual format of chart desired.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Chart Palette: Select from several possible color palettes for the
+ chart.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Show grid lines: Whether to display horizontal and vertical grid lines
+ on the chart for line, bar, and stacked bar charts; circular and
+ saggital grid lines for pie and ring charts.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Draw values on chart: Whether to print the data values on the chart for
+ chosen data points.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Show chart by default: Whether this report should first be displayed as
+ a chart when it's opened instead of as a tabular report.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Logarithmic vertial axis: Only enabled when relevant - use a logarithmic
+ instead of linear scale for the vertical axis.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Plot expenses downward: If not checked, then both income and expenses
+ are plotted upwards.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Line width: The width of data lines on the chart.
+ </para>
+ </listitem>
+ </itemizedlist>
+</para>
+</sect3>
+
+<sect3><title>Range Subtab</title>
+<sect4><title>Date range</title>
+<para>
+ Use this section to specify the date range of transactions to be included in
+ the report. The <guilabel>Range</guilabel> dropdown includes a large number
+ of predfined ranges, but you cans select <quote>User defined</quote> and
+ manually set <guilabel>From</guilabel> and <guilabel>To</guilabel>. The
+ <guilabel>Ticks</guilabel> dropdown specifies the placement of tick marks on
+ the horizontal (time) axis of the chart.
</para>
+</sect4>
+<sect4><title>Data range</title>
+<para>
+ This specifies the tick marks and divisions on the vertical axis of the chart.
+ It is generally best to leave the <guilabel>Range</guilabel> dropdown set to
+ <quote>Automatic</quote>.
+</para>
+</sect4>
+</sect3>
</sect2>
<sect2>
-<title>Other Tabs</title>
+<title>Filters Tab</title>
<para>
- The other tabs in this dialog are the same as in the Search Transactions
- interface. Please refer to
- the <link linkend="details.search">documentation</link> on that interface for
- details on the other tabs.</para>
+ The subtabs here are the same as the tabs in the Search Transactions
+ interface. Please refer to the <link
+ linkend="details.search">documentation</link> on that interface for details on
+ their use.
+</para>
</sect2>
-
</sect1>
<sect1 id="details.reports.charts">
@@ -477,18 +706,17 @@
Each report can be viewed in either textual form or graphical (chart) form.
The same report configuration parameters are used in either case. You can
easily jump back and forth between the textual and graphical forms by pressing
- the <guibutton>Chart</guibutton> or <guibutton>Report</guibutton> buttons
- along the top of the report view.
+ the <guibutton>Chart</guibutton> or <guibutton>Report</guibutton> button along
+ the top of the report.
</para>
<para>
- Care should be taken to limit the amount of data you choose to display on a
- chart. If you are not careful, using the same configuration for both textual
+ You should take care to limit the amount of data you choose to display on a
+ chart. If you are not careful, using the same configuration for both textual
and graphical forms means it's possible to configure a chart to be visually
- cluttered, unappealing, and uninformative. &kmymoney; will not force you to
+ cluttered, unappealing, and uninformative. &kmymoney; will not force you to
keep your charts readable and useful!
</para>
-
</sect2>
<sect2>
@@ -499,19 +727,19 @@
<para>
A line graph is one of the most simple forms of a chart. There is one line
- for each series. (Usually a series is a single account or category; see below
- for more details on that.) The time periods stretch out along the bottom axis,
- and the currency values are along the left.
+ for each series. (Usually a series is a single account or category; see below
+ for more details on that.) The time periods stretch out along the bottom
+ axis, and the currency values are along the left.
</para>
<para>
The detail level for each line is controlled in the <link
linkend="details.reports.config.rowscolumns">Rows/Columns</link> Tab of chart
configuration. If you choose the <quote>Top-Level</quote> detail level, there
- will be one line for each of the top-most accounts or categories which show
+ will be one line for each of the top-most accounts or categories, which shows
the sum total of all underlying accounts or categories. If you choose
- <quote>Groups</quote> it will instead show one line each for Income, Expenses,
- Assets, or Liabilities, depending on the other settings.
+ <quote>Groups</quote>, it will instead show one line for each Income, Expense,
+ Asset, or Liability depending on the other settings.
</para>
</sect3>
@@ -528,11 +756,11 @@
<title>Pie Chart</title>
<para>
- The pie chart is the most simple chart available. It shows only one time
- slice, as opposed to showing the values across time. This chart shows only
- the totals column of whatever report is selected. If your report is
- configured to NOT convert values to the base currency, there will be no totals
- column, and therefore this report is not useful.
+ The pie chart is the most simple chart available. It shows data at only one
+ time slice, as opposed to showing the values across time. This chart shows
+ the values from only the totals column of whatever report is selected. If
+ your report is configured to NOT convert values to the base currency, there
+ will be no totals column, and therefore this report is not useful.
</para>
</sect3>
@@ -544,8 +772,6 @@
<quote>ring</quote> for each time slice in the report.
</para>
</sect3>
-
</sect2>
-
</sect1>
</chapter>
diff --git a/doc/whatsnew.docbook b/doc/whatsnew.docbook
index c83471b09..6ec361a1d 100644
--- a/doc/whatsnew.docbook
+++ b/doc/whatsnew.docbook
@@ -90,6 +90,7 @@
<member><link linkend="details.investments">Investments</link></member>
<member><link linkend="details.currencies">Currencies</link></member>
<member><link linkend="details.reconcile">Reconciliation</link></member>
+ <member><link linkend="details.reports">Reports</link></member>
<member><link linkend="details.impexp">Importing and Exporting</link></member>
<member><link linkend="details.settings">Settings</link></member>
<member><link linkend="reference.menus">Reference: Menus</link></member>
@@ -98,7 +99,6 @@
</entry>
<entry valign="top">
<simplelist>
- <member><link linkend="details.reports">Reports</link></member>
<member><link linkend="details.loans">Loans</link></member>
<member><link linkend="details.budgets">Budgets</link></member>
<member><link linkend="details.forecast">Forecast</link></member>
More information about the kde-doc-english
mailing list