[office/kmymoney/update-docs] doc: Initial update to Reports chapter of handbook
Jack Ostroff
null at kde.org
Wed Jan 4 23:41:01 GMT 2023
Git commit 1723eff9c3d97833ee34583f2735405fc8084fe3 by Jack Ostroff.
Committed on 02/01/2023 at 22:25.
Pushed by ostroffjh into branch 'update-docs'.
Initial update to Reports chapter of handbook
M +213 -103 doc/details-reports.docbook
https://invent.kde.org/office/kmymoney/commit/1723eff9c3d97833ee34583f2735405fc8084fe3
diff --git a/doc/details-reports.docbook b/doc/details-reports.docbook
index 9cb90e376..d5db5f1d2 100644
--- a/doc/details-reports.docbook
+++ b/doc/details-reports.docbook
@@ -3,13 +3,59 @@
<chapterinfo>
<authorgroup>
<author> &Ace.Jones; &Ace.Jones.mail; </author>
+ <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2010-07-25</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2022-12-31</date>
+ <releaseinfo>5.1</releaseinfo>
</chapterinfo>
<title>Reports</title>
+<sect1 id="details.reports.issues">
+<title>Known Issues</title>
+ <para>
+ Recent updates to this chapter bring it up to date as far as actually
+ selecting, configuring, viewing, exporting, and saving reports. However,
+ there are known issues with the content of some reports which will be
+ addressed in more detail in a future update, both of &kmymoney; itself as
+ well as this Handbook. These are listed below for your information, and to
+ avoid surprises and unnecessary bug reports.
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ In some Investment Reports, questions have been raised regarding the
+ methods used in the calculations related to capital gains, especially
+ unrealized gains or losses (the difference in value of currently held
+ securities compared to their original purchase cost.) This is
+ particularly true when the period of the report does not extend prior to
+ the purchase and after the sale of any security.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ In reports involving a data pivot (where columns represent time periods)
+ if currency conversions are involved, the conversions may not be applied
+ on the same dates when transactions are not grouped by dates. This can
+ lead to different values in different reports, where the values might be
+ expected to be the same.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Specifying closed accounts for inclusion in reports does not always work
+ as expected. Due to interactions between different parts of the report
+ configuration and generation, it is not always possible to include data
+ from accounts which are now closed, but which were open during the
+ specified time frame of the report.
+ </para>
+ </listitem>
+ </itemizedlist>
+</sect1>
+
<sect1 id="details.reports.avail">
<title>Available Reports</title>
@@ -35,45 +81,46 @@
<sect2>
<title>Income and Expenses</title>
<para>
- The reports in this section show your income and expenses either for the
- current month or for each month in the current year. Of course, the duration
- of the overall report and the duration captured by each column can be
- configured to your liking. Graphs and Pie Charts also may be produced.
+ These reports show your income and expenses for the current month or for each
+ month in the current year. Of course, the duration of the overall report and
+ the duration captured by each column can be configured to your liking. Graphs
+ and Pie Charts also may be produced.
</para>
</sect2>
<sect2>
<title>Net Worth</title>
<para>
- Here there are reports that describe your net worth, either at the current
- moment, every month for the current year, or every year of your history. In
- addition, there is a 7-day Cash Flow Forecast and a Net Worth Graph. There
- are also reports to get the balances for all of your accounts at any given
- point in time.
+ These reports describe your net worth, either at the current moment, every
+ month for the current year, or every year of your history. In addition, there
+ is a 7-day Cash Flow Forecast and a Net Worth Graph. There are also reports
+ to get the balances for all of your accounts at any given point in time. As
+ with the Income and Expenses Reports, time periods and groupings can be
+ configured as desired.
</para>
</sect2>
<sect2>
<title>Transactions</title>
<para>
- This section includes reports that list individual transactions. This is the
- best way to print your account register for a specific period of time. The
- transactions printed can be grouped together according to your liking by
+ These reports list individual transactions. This is the best way to print
+ your account register for a specific period of time. The transactions
+ included in a report can be grouped together according to your liking by
choosing the appropriate report, such as:
-<itemizedlist>
- <listitem><para>By Account</para></listitem>
- <listitem><para>By Category</para></listitem>
- <listitem><para>By Month or Week</para></listitem>
- <listitem><para>By Payee</para></listitem>
-</itemizedlist>
+ <itemizedlist>
+ <listitem><para>By Account</para></listitem>
+ <listitem><para>By Category</para></listitem>
+ <listitem><para>By Month or Week</para></listitem>
+ <listitem><para>By Payee</para></listitem>
+ </itemizedlist>
+ You can also choose the time period for the report.
</para>
-
</sect2>
<sect2>
<title>Cash Flow</title>
<para>
- The Cash Flow report is similar to a Transaction report, but it displays all
+ The Cash Flow Report is similar to a Transaction Report, but it displays all
cash-flow related transactions.
</para>
</sect2>
@@ -86,20 +133,20 @@
as shown in this partial list.
</para>
<itemizedlist>
- <listitem><para>Investment Transactions: Similar to a Transactions report,
- and includes the share price and quantities.</para></listitem>
- <listitem><para>Investment Holdings by Account: Shows the current shares,
- price, and value for each account.</para></listitem>
- <listitem><para>Investment Holdings by Type: Same as the previous report, but
- organizes the accounts by type (Stock, Mutual Fund, &etc;)</para></listitem>
+ <listitem><para> Investment Transactions: Similar to a Transactions Report,
+ and includes the share price and quantities. </para></listitem>
+ <listitem><para>Investment Holdings by Account: Shows the current shares,
+ price, and value for each account.</para></listitem>
+ <listitem><para>Investment Holdings by Type: Same as the previous report, but
+ organizes the accounts by type (Stock, Mutual Fund, &etc;)</para></listitem>
<listitem><para>Investment Performance by Account: Shows the annualized
- performance over any period of time. This performs a cash flow analysis of
- all money coming into and going out of the account. As a result, this is a
- very accurate picture of how well your investments are
- doing.</para></listitem>
- <listitem><para>Investment Performance by Type: Same as the previous report,
- but organizes the accounts by type (Stock, Mutual Fund,
- &etc;)</para></listitem>
+ performance over any period of time. This performs a cash flow analysis of
+ all money coming into and going out of the account. As a result, this is a
+ very accurate picture of how well your investments are
+ doing.</para></listitem>
+ <listitem><para>Investment Performance by Type: Same as the previous report,
+ but organizes the accounts by type (Stock, Mutual Fund,
+ &etc;)</para></listitem>
</itemizedlist>
<para>
@@ -110,27 +157,27 @@
<sect2>
<title>Taxes</title>
<para>
- The tax reports are just like the transactions reports, with the addition that
- only Tax related categories are included. This allows you to flag certain
- categories as being tax-related, and then get one big report at the end of the
- year to see them all in one place. They may be listed either by Category or by
- Payee, and for the last fiscal year.
+ The Tax Reports are just like the Transactions Reports, but only Tax related
+ categories are included. This allows you to flag certain categories as being
+ tax-related, and then get one big report at the end of the year to see them
+ all in one place. They may be listed either by Category or by Payee, and for
+ the last fiscal year.
</para>
</sect2>
<sect2>
<title>Budgeting</title>
<para>
- The budgeting reports are similar to net worth reports, but the reports can
- display the budget for a given year, or even compare it to the actual income
- and expenses for the same period.
+ These reports are similar to the Net Worth Reports, but they can display the
+ budget for a given year, and can compare it to the actual income and expenses
+ for the same period.
</para>
</sect2>
<sect2>
<title>Forecast</title>
<para>
- The forecast reports are just like the net worth reports, but they use the
+ These reports are just like the Net Worth Reports, but they use the
information to display forecast information. You can display the information
at various levels and for the time frame of your choosing.
</para>
@@ -163,16 +210,6 @@
also included on the financial summary page for even easier reference.
</para>
</sect2>
-
-<sect2>
-<title>Configuring Reports</title>
-<para>
- To access the report configuration dialog, bring up the report you wish to
- configure, and press the <guibutton>Configure</guibutton> button at the top of
- the report.
-</para>
-</sect2>
-
</sect1>
<sect1 id="details.reports.working">
@@ -180,28 +217,94 @@
<para>
There are a number of actions you can take on each report. You can access
- these by right-clicking the report name in the list of reports. Alternately,
- once you have run a report, there are buttons across the top of the view to
- invoke each of these:
+ some of these by right-clicking the report name in the list of reports, and
+ selecting the action from the context menu. These include:
</para>
<itemizedlist>
- <listitem><para>Chart: Only present if the report is capable of displaying a
- chart. Clicking this option toggles between the report and the
- chart.</para></listitem>
- <listitem><para>Configure: Change the properties of this report. You can
- customize the report to your liking and save it for future
- use.</para></listitem>
- <listitem><para>New: Create a new customized report based on the selected
- report.</para></listitem>
- <listitem><para>Copy: The report output can be copied to the clipboard to
- paste them in another application, like a spreadsheet, for further
- analysis.</para></listitem>
- <listitem><para>Export: Reports can be saved in &HTML; or CSV
- format.</para></listitem>
- <listitem><para>Delete: Customized reports can be deleted. The default
- reports that ship with &kmymoney; cannot be deleted.</para></listitem>
- <listitem><para>Close: Close the current report.</para></listitem>
+ <listitem>
+ <para>
+ Open: this runs the report and displays the results. This is the same
+ action as if you double clicked on the report name.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Print: this is the same as running the report and then selecting the
+ <menuchoice><guimenu>File</guimenu><guimenuitem>Print</guimenuitem></menuchoice>
+ menu item.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Configure: change the properties of this report. You can customize the
+ report to your liking and save it for future use. For more details, see
+ the next section.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ New report: this creates a copy of the report and opens the configuration
+ dialog.
+ </para>
+ </listitem>
+
+</itemizedlist>
+
+<para>
+ Alternately, once you have run a report, there are buttons across the top of
+ the view to invoke each of these actions:
+</para>
+
+<itemizedlist>
+ <listitem>
+ <para>
+ Chart: This is only enabled if the report is capable of displaying a
+ chart. Clicking on it toggles between the report and the chart.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Configure: as described above.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ New: as described above.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Copy: this copies the report output to the clipboard to paste it in
+ another application, like a spreadsheet, for further analysis or
+ manipulation.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Export: the content of a report can be saved in &HTML; or CSV format.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Delete: customized reports can be deleted. The default reports that ship
+ with &kmymoney; cannot be deleted.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Close: close the current report.
+ </para>
+ </listitem>
</itemizedlist>
</sect1>
@@ -212,20 +315,20 @@
<title>Working with custom reports</title>
<para>
You can configure the default reports or create your own from them by
- selecting 'New' and then configuring the new report. When you select
- 'Configure' you will be presented with the Report Tab. Initially, it is named
- the same as the old report with <quote>(Customized)</quote> added to the end. You
- can change the name to whatever you want. You can even name your custom
- reports the same as a default report, or the same as another custom
- report. Also, you can always use the Comment field to further distinguish
- reports.
+ selecting 'New' and then configuring the new report. When you select
+ 'Configure' you will be presented with the Report Configuration Dialog, with
+ the Report Tab selected. Initially, the new report is named the same as the
+ old report with <quote>(Customized)</quote> added to the end. You can change
+ the name to whatever you want. You can even name your custom reports the same
+ as a default report, or the same as another custom report. Also, you can
+ always use the Comment field to further distinguish reports.
</para>
<para>
- The Report Configuration dialog has a number of tabs across the top. Each tab
- displays options for configuring different aspects of the report.
+ 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.
</para>
-
</sect2>
<sect2><title>Report Tab</title>
@@ -240,45 +343,51 @@
</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>
<para>
- On this tab, you set the basic properties of this report.
+ 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.</para></listitem>
+ 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 if you'd
- like to see values in their original currency. If currencies are not
- converted, then subtotals will not be shown.</para></listitem>
+ 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>
-</sect2>
-
-<sect2 id="details.reports.config.rowscolumns">
-<title>Rows/Columns Tab</title>
+<sect3 id="details.reports.config.rowscolumns">
+<title>Rows/Columns Subtab</title>
<para>
- On this tab, you configure how you would like the rows and columns to be selected
- and organized. This tab presents different configuration options depending on
- the style of report you have selected.
+ 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.
</para>
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="report_configuration-rowscolumns.png" format="PNG" />
- </imageobject>
- <textobject>
+ </imageobject>
+ <textobject>
<phrase>Report Configuration -Rows and Columns</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+ </textobject>
+ </mediaobject>
+ </screenshot>
</para>
<para>
@@ -321,6 +430,7 @@
</itemizedlist>
</para>
+</sect3>
</sect2>
<sect2>
More information about the kde-doc-english
mailing list