Git commit 999d156de1316fd2d46075804b8c4b64c391bf7d by Jack Ostroff. Committed on 06/03/2024 at 17:43. Pushed by ostroffjh into branch 'Handbook-5.2'.
more fixups M +2 -0 README-CONTRIBUTORS A +- -- doc/config_xml_storage.png M +44 -0 doc/details-reports.docbook M +1 -5 doc/details-search.docbook M +22 -43 doc/details-settings.docbook M +1 -1 doc/details-tags.docbook A +- -- doc/reports_configuration_plugin.png https://invent.kde.org/office/kmymoney/-/commit/999d156de1316fd2d46075804b8c4b64c391bf7d diff --git a/README-CONTRIBUTORS b/README-CONTRIBUTORS index c290a42217..8ca6fc7e0c 100644 --- a/README-CONTRIBUTORS +++ b/README-CONTRIBUTORS @@ -322,6 +322,8 @@ multiple places. - Budget View has buttons labelled Upd and Res. Should these be expanded to Update and Reset? +- Should iCalendar be mentioned anywhere other than the Settings chapter? + This is a list of potential enhancements I came up with while reviewing the handbook, but have not yet posted either as wishlist bugs, entries to any Issue on invent, or elsewhere. diff --git a/doc/config_xml_storage.png b/doc/config_xml_storage.png new file mode 100644 index 0000000000..06fc49833c Binary files /dev/null and b/doc/config_xml_storage.png differ diff --git a/doc/details-reports.docbook b/doc/details-reports.docbook index 78103094c2..0a80e6937d 100644 --- a/doc/details-reports.docbook +++ b/doc/details-reports.docbook @@ -483,6 +483,50 @@ linkend="details.search">Search Transactions</link> section for details on those tabs.</para> </sect2> + +<sect2 id="details.reports.config.plugin"><title>Report Plugin Configuration</title> +<para> + Behind the scenes, Reports are actually implemented as a plugin in &kmymoney;, and + there are some items which can be configured through the <link + linkend="details.settings.plugins.reports">Reports View Plugin Configuration</link> + dialog. +</para> + +<screenshot> + <screeninfo>report plugin configuration</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="reports_configuration_plugin.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>report plugin configuration</phrase> + </textobject> + </mediaobject> +</screenshot> + +<para> + <guilabel>Maximum number of legend items to display</guilabel> limits the number of + items to list in the legend of the graph or chart display of a report. This can be + useful if there are enough items that the legend would otherwise overwhelm the main + display. +</para> + +<para> + <guilabel>Charts line width</guilabel> is the default width in pixels of any lines + in the chart display of a report. +</para> + +<para> + <guilabel>Charts palette</guilabel> gives some choice in the array of colors used + in graphs and chart displays of a report. +</para> + +<para> + Since the graph and chart displays of reports are shown using HTML, the + <guilabel>Default CSS file</guilabel> lets you provide a css file to customize + these displays. +</para> +</sect2> </sect1> <sect1 id="details.reports.charts"><title>Graphs & Charts</title> diff --git a/doc/details-search.docbook b/doc/details-search.docbook index 0e85c97996..b2eefcef12 100644 --- a/doc/details-search.docbook +++ b/doc/details-search.docbook @@ -244,7 +244,7 @@ </para> <para> - Tags that are marked for search are indicated with a box. If you click the + Tags that are marked for search are indicated with a checked box. If you click the <guibutton>Select all</guibutton> button, all tags are marked for searching. If you click the <guibutton>Select none</guibutton> button, no tags will be marked for searching. Individual tags can be marked or unmarked by clicking on the checkbox @@ -255,10 +255,6 @@ If you check the <guilabel>Select transactions without tags</guilabel> box, only transactions with no tag will be selected. </para> - -<para> - <!-- FIXME: need to mention known issues with searching on tags in splits --> -</para> </sect2> <sect2 id="details.search.payee"><title>Payee</title> diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook index a21f27fdc2..7726862570 100644 --- a/doc/details-settings.docbook +++ b/doc/details-settings.docbook @@ -44,9 +44,8 @@ </mediaobject> </screenshot> -<!-- I would prefer to use a more consistent hierarchy and use of levels on this - page. For example, when to use sectX and when variablelist. For now, I'm - minimizing changes. --> +<!-- FIXME: I prefer a more consistent hierarchy and use of levels on this page, such + as with use sectX and variablelist. For now, I minimize changes. --> <variablelist> <varlistentry> <term><guilabel>Autosave options</guilabel></term> @@ -330,9 +329,6 @@ </sect1> <sect1 id="details.settings.home"><title>Home</title> -<!-- FIXME: For consistency, <sect2> should only be used for tabs. I'm too lazy to - convert this to a variablelist now, which would require subsuming the lower - levels to paras. --> <sect2><title>Home page display sections</title> <screenshot> @@ -947,13 +943,13 @@ </variablelist> </sect2> -<sect2><title> </title> -<!-- FIXME: This is a good example of problems with the current mix of sect and - variablelist, as this sect with no title gives inadequate spacing between the - previous and this list entry, even with , so it looks like they belong - together. I consider using literallayout a bad solution. I'm open to - suggestions on how to deal with this. Not using sect2 for boxes might help, - but would be a lot of effort. --> +<sect2><title>Ungrouped Item</title> +<!-- FIXME: This is a good example of problems with the current mix of sectX and + variablelist. Without a title, this sect has inadequate spacing above it. so + it looks like it is part of the previous group, but the actual title does not + match the lack of title in the actual config dialog. I'm open to suggestions on + how to deal with this. Not using sect2 for boxes might help, but would be a lot + of effort. Perhaps just adding a box and title to the config dialog? --> <literallayout> </literallayout> <variablelist> @@ -1141,8 +1137,8 @@ <ulink url="https://doc.qt.io/qt-5/richtext-html-subset.html">here</ulink>. </para> -<!-- FIXME: do we want to actually include any of these here, and if so, with how - much detail? --> +<!-- FIXME: do we want to actually include these checkwriting variables here, and if + so, with how much detail? --> <!-- info from source code on substitution variables. Future exercise to list/describe them here. // data about the user checkHTML.replace("$OWNER_NAME", file->user().name()); @@ -1225,7 +1221,6 @@ </sect2> <sect2><title>iCalendar</title> -<!-- FIXME: This isn't mentioned anywhere else. SHould it be? --> <para> &kmymoney; is capable of exporting a file inb then <quote>iCalendar</quote> format, so you can import your scheduled transactions into &korganizer;, or another @@ -1284,39 +1279,23 @@ </para> </sect2> -<sect2><title>Reports view</title> -<!-- FIXME: this needs better incorporation into the Reports Chapter. It is currently - not mentioned there at all. --> +<sect2 id="details.settings.plugins.reports"><title>Reports view</title> <para> - This provides a dialog where you can configure some default values to be used when displaying - <link linkend="details.reports">Reports</link>. -</para> - -<para> - <guilabel>Maximum number of legend items to display</guilabel> limits the number of - items to list in the legend of the graph of chart display of a report. -</para> - -<para> - <guilabel>Charts line width</guilabel> is the default width in pixels of any lines - in the chart display of a report. -</para> - -<para> - <guilabel>Charts palette</guilabel> gives some choice in the array of colors used - in graphs and chart displays of a report. -</para> - -<para> - Since the graph and chart form of reports are shown using HTML, the - <guilabel>Default CSS file</guilabel> lets you provide a css file to customize - these displays. + This provides a dialog where you can configure some default values to be used when + displaying <link linkend="details.reports">Reports</link>. The details are + described with the other <link linkend="details.reports.config.plugin">Report + Configuration</link> settings. </para> </sect2> <sect2><title>XML Storage</title> <para> - <!-- FIXME: still needs writing..... --> + The default storage of your data is in &XML; format, described in the chapter on + <link linnkend="details.formats">File Formats</link>. Because the code which reads + and saves your data is implemented as a plugin, the configuration dialog which + controls some aspects of this storage is accessed through the Plugin section of the + general KMyMoney Configuration, although it is described in the above linked + section. </para> </sect2> </sect1> diff --git a/doc/details-tags.docbook b/doc/details-tags.docbook index 2417ec219f..28e60322d7 100644 --- a/doc/details-tags.docbook +++ b/doc/details-tags.docbook @@ -5,7 +5,7 @@ <author>&Cristian.Onet; &Cristian.Onet.mail;</author> <author>&Michael.Carpino; &Michael.Carpino.mail;</author> </authorgroup> - <date>2023-08-30</date> + <date>2024-02-060</date> <releaseinfo>5.2.0</releaseinfo> </chapterinfo> <title>Tags</title> diff --git a/doc/reports_configuration_plugin.png b/doc/reports_configuration_plugin.png new file mode 100644 index 0000000000..8d4358373a Binary files /dev/null and b/doc/reports_configuration_plugin.png differ