[office/kmymoney/Handbook-5.2] /: more on settings and other cleanup

Jack Ostroff null at kde.org
Thu Dec 28 00:44:50 GMT 2023


Git commit 095e442265648aa34b6095e85a640d5cbc74564d by Jack Ostroff.
Committed on 28/12/2023 at 01:44.
Pushed by ostroffjh into branch 'Handbook-5.2'.

more on settings and other cleanup

M  +6    -0    README-CONTRIBUTORS
A  +-    --    doc/config_plugins_csvimporter.png
A  +-    --    doc/config_plugins_ical.png
R  +-    --    doc/confirm_enter.png [from: doc/confirmenter.png - 100% similarity]
M  +9    -10   doc/details-forecast.docbook
M  +41   -20   doc/details-impexp-csv.docbook
M  +1    -1    doc/details-schedules.docbook
M  +91   -7    doc/details-settings.docbook

https://invent.kde.org/office/kmymoney/-/commit/095e442265648aa34b6095e85a640d5cbc74564d

diff --git a/README-CONTRIBUTORS b/README-CONTRIBUTORS
index 63f8e5a8a..9dcb2417d 100644
--- a/README-CONTRIBUTORS
+++ b/README-CONTRIBUTORS
@@ -116,6 +116,12 @@ This is in the order pulled in from index.docbook, with brief note on state of u
 Items which need to be addressed, but so far not sure where (or more likely in
 multiple places.
 
+- Some author entities seem NOT to be in the current contributor.entities, although
+  they had supposedly been added to svn quite a while ago.  Need to confirm all, and
+  re-add any which are not currently present.
+
+- Need to determine what to do about email address for deceased contributor.
+
 - Need consistency in capitalization of Xxx View.  What about View Selector?
 
 - In Institutuions and Accounts Views, balance is in currency of the account, total
diff --git a/doc/config_plugins_csvimporter.png b/doc/config_plugins_csvimporter.png
new file mode 100644
index 000000000..c5dd4ed7a
Binary files /dev/null and b/doc/config_plugins_csvimporter.png differ
diff --git a/doc/config_plugins_ical.png b/doc/config_plugins_ical.png
new file mode 100644
index 000000000..d6ebb6fa6
Binary files /dev/null and b/doc/config_plugins_ical.png differ
diff --git a/doc/confirmenter.png b/doc/confirm_enter.png
similarity index 100%
rename from doc/confirmenter.png
rename to doc/confirm_enter.png
diff --git a/doc/details-forecast.docbook b/doc/details-forecast.docbook
index 2be2f98a3..9072498dd 100644
--- a/doc/details-forecast.docbook
+++ b/doc/details-forecast.docbook
@@ -59,18 +59,17 @@
 </para>
 </sect1>
 
-<sect1 id="details.forecast.configure" >
-<title>Configuring the Forecast</title>
+<sect1 id="details.forecast.configure" ><title>Configuring the Forecast</title>
 
 <para>
-  The parameters used to calculate a Forecast, including the forecast method, can be set
-  in the <guilabel>Forecast view</guilabel> configuration dialog.  Since the forecast
-  functionality is implemented as a <link linkend="makingmostof.plugins">&kmymoney;
-  plugin</link>, you can reach this dialog by invoking the <menuchoice>
-  <guimenu>Settings</guimenu> <guimenuitem>Configure &kmymoney;...</guimenuitem>
-  </menuchoice> menu item, selecting <guilabel>Plugins</guilabel> on the left pane,
-  and clicking the <guilabel>configure</guilabel> icon next to <guilabel>Forecast
-  view</guilabel>.
+  The parameters used to calculate a Forecast, including the forecast method, can be
+  set in the <link linkend="details.settings.plugins.forecast"> <guilabel>Forecast
+  view</guilabel> </link> configuration dialog.  Since the forecast functionality is
+  implemented as a <link linkend="makingmostof.plugins">&kmymoney; plugin</link>, you
+  can reach this dialog by invoking the <menuchoice> <guimenu>Settings</guimenu>
+  <guimenuitem>Configure &kmymoney;...</guimenuitem> </menuchoice> menu item,
+  selecting <guilabel>Plugins</guilabel> on the left pane, and clicking the
+  <guilabel>configure</guilabel> icon next to <guilabel>Forecast view</guilabel>.
 </para>
 
 <para>
diff --git a/doc/details-impexp-csv.docbook b/doc/details-impexp-csv.docbook
index d8db233f2..23eb1b9ba 100644
--- a/doc/details-impexp-csv.docbook
+++ b/doc/details-impexp-csv.docbook
@@ -102,11 +102,20 @@
 <para>
   Each type of CSV file to be imported requires sepcification of several details
   regarding the expected formatting of the data, as described in the following
-  sections of this handbook.  Not only do the details differ for the different types
-  of data files imported, it is possilbe to need different configurations for the
-  same type of data from different sources.  So you do not need to enter all those
-  details each time you import a file, the CSV Importer allows you to specify the
-  details once, and save them in a named profile.
+  sections.  Not only do the details differ for the different types of data files
+  imported, it is possilbe to need different configurations for the same type of data
+  from different sources.  So you do not need to enter all those details each time
+  you import a file, the CSV Importer allows you to specify the details once, and
+  save them in a named profile.
+</para>
+
+<para>
+  The name of a CSV import profile is completely arbitrary, but will be easier to
+  remember if it reflects both the type of data being imported (bank, credit card,
+  investment, ...) and the source of the data.  There is no need to reference the
+  account into which the data is imported, and it is possible to use the same profile
+  for importing into more than one account, such as two checking accounts at the same
+  bank.
 </para>
 
 <para>
@@ -702,21 +711,21 @@
 <sect3 id="details.impexp.csv.config"><title>Configuration of CSV importer plugin</title>
 
 <para>
- A well-known drawback of QIF format is that it is a fairly loose format.
- With CSV files, there is this same problem, only more so, in that there  is
- no agreed standard at all.  With investment files, in particular, there is
- much more scope for variation in specifying the different types of activities
- represented in the data.  The plugin handles this by listing these activity
- types in a resource file, called <filename>csvimporterrc</filename>. The location
- of this file depends on your distribution. On a &Linux; system, this will be in
- <filename class="directory">$KDEHOME/share/config</filename> where
- <envar>$KDEHOME</envar> is usually <quote>.config</quote> within your home folder.
- If you are migrating from a version of &kmymoney; prior to 5.0 or later, the old
- location of <envar>$KDEHOME</envar> was <filename class="directory">.kde4</filename>.
- Using this resource file allows the user to add an activity type that the developer
- had not encountered. If the file does not exist when the importer first runs, the
- plugin will create a default version, containing a few of the more obvious
- descriptions.
+ A well-known drawback of QIF format is that it is a fairly loose format.  With CSV
+ files, there is this same problem, only more so, in that there is no agreed standard
+ at all.  With investment files, in particular, there is much more scope for
+ variation in specifying the different types of activities represented in the data.
+ The plugin handles this by listing these activity types in a resource file, called
+ <filename>csvimporterrc</filename>. The location of this file depends on your
+ opearintg system or distribution. On a &Linux; system, this will be <filename
+ class="directory">$KDEHOME/share/config</filename> where <envar>$KDEHOME</envar> is
+ usually <filename class="directory">.config</filename> within your home folder.  If
+ you are migrating from a version of &kmymoney; prior to 5.0, the old location of
+ <envar>$KDEHOME</envar> was <filename class="directory">.kde4</filename>, also
+ within your home folder.  Using this resource file allows the user to add an
+ activity type that the developer had not encountered. If the file does not exist
+ when the importer first runs, it will create a default version, containing a few of
+ the more obvious descriptions.
 </para>
 
 <para>
@@ -741,6 +750,18 @@
  &userlist; or developer list &devlist;, the developer will do his best to
  modify the plugin to handle it.
 </para>
+
+<sect4><title>CSV Importer configuration dialog</title>
+
+<para>
+  Finally, there are a few other items which may be configured in a dialog invoked
+  through the <link linkend="details.settings.plugins.csvimporter">CSV Importer
+  configuration dialog</link>, which can be invoked from the Plugins page of the main
+  KMyMoney configuration dialog.  This includes which items will be autodetected by
+  the importer and which profile will be used if you do have the importer export a
+  QIF file, as mentioned above.
+</para>
+</sect4>
 </sect3>
 </sect2>
 </sect1>
diff --git a/doc/details-schedules.docbook b/doc/details-schedules.docbook
index eb69e8bab..5c159e880 100644
--- a/doc/details-schedules.docbook
+++ b/doc/details-schedules.docbook
@@ -334,7 +334,7 @@
   <screenshot>
     <mediaobject>
       <imageobject>
-	<imagedata fileref="confirmenter.png" format="PNG" />
+	<imagedata fileref="confirm_enter.png" format="PNG" />
       </imageobject>
     </mediaobject>
   </screenshot>
diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook
index 01e40d17f..1962edff8 100644
--- a/doc/details-settings.docbook
+++ b/doc/details-settings.docbook
@@ -1113,8 +1113,10 @@
 
 <para>
   Until recently, there was only one plugin that required configuration, the Check
-  printing plugin.  Now, there are several plugins which require configuration.
-  These are described in the following sections.
+  printing plugin.  Now, there are several plugins which have configuration pages
+  which are invoked from this page.  These are listed in the following sections.
+  Note however, that many of them have already been described earlier in this
+  document.
 </para>
 
 <sect2 id="details.settings.plugins.printchecks"><title>Check printing plugin</title>
@@ -1145,6 +1147,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? -->
 <!-- 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());
@@ -1175,33 +1179,113 @@
 -->
 </sect2>
 
-<sect2><title>CSV Importer</title>
+<sect2 id="details.settings.plugins.csvimporter"><title>CSV Importer</title>
 
 <para>
+  Some aspects of configuring the CSV Importer plugin have already been discussed
+  <link linkend="details.settings.plugins.csvimporter">here</link>.  However, there
+  is also a dialog which can be invoked here.
 
+  <screenshot>
+    <screeninfo>Configure CSV Importer Plugin</screeninfo>
+    <mediaobject>
+      <imageobject>
+	<imagedata fileref="config_plugins_csvimporter.png" format="PNG" />
+      </imageobject>
+      <textobject>
+	<phrase>Configure CSV Importer Plugin</phrase>
+      </textobject>
+    </mediaobject>
+  </screenshot>
 </para>
+
+<sect3><title>Autodetecting</title>
+<para>
+  It is generally best to let the plugin autodetect the field delimiter, decimal
+  symbol, and date format.  However, it is possible to disable this behavior for each
+  of these items by unchecking the appropriate box.
+</para>
+
+<para>
+  In some cases, a csv file to be imported contains the name of the account somewhere
+  in the first lines of the file.  You can request the plugin to automatically look
+  for this by checking the appropriate box, separately for banking and for investment
+  imports.
+</para>
+</sect3>
+
+<sect3><title>QIF export profile</title>
+<para>
+  Although it is currently better just to use the QIF exporter plugin directly, it is
+  still possible to have the CSV Importer export a QIF file.  In this case, you can
+  use this dropdown to select the default QIF export profile to use.
+</para>
+</sect3>
 </sect2>
 
-<sect2><title>Forecast view</title>
+<sect2 id="details.settings.plugins.forecast"><title>Forecast view</title>
 
 <para>
+  This is described in the <link linkend="details.forecast.configure">Configuring the
+  Forecast</link> section of the <link linkend="details.forecast">Forecast
+  Chapter.</link>
 </para>
 </sect2>
 
 <sect2><title>iCalendar</title>
+<!-- FIXME:  isn't this mentioned anywhere else? -->
 
 <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
+  calendar program, so you can be reminded of scheduled transactions.  Actually
+  exporting the file is done with the <menuchoice> <guimenu>File</guimenu>
+  <guisubmenu>Export</guisubmenu> <guimenuitem>Schedules to iCalendar</guimenuitem>
+  </menuchoice>menu item.
+  
+  <screenshot>
+    <screeninfo>Configure iCalendar export</screeninfo>
+    <mediaobject>
+      <imageobject>
+	<imagedata fileref="config_plugins_ical.png" format="PNG" />
+      </imageobject>
+      <textobject>
+	<phrase>Configure iCalendar export</phrase>
+      </textobject>
+    </mediaobject>
+  </screenshot>
+</para>
+
+<para>
+  The exported file will contain one event for each scheduled transaction.  There are
+  controls to configure whether to have the calender show reminders for the events,
+  as well as how many reminders, and how far ahead of the events the reminders are
+  created, although these seem not to currently have any effect on the file created.
+</para>
+
+<para>
+  The final field on the dialog allows you to specify the default name and path of
+  the exported file.  As usual, you can either type the full path, or click the file
+  selector icon at the right and get a file selector dialog.  Currently, the file
+  save dialog does default to the folder specified here, but you still need to enter
+  the actual file name at the time of export.
 </para>
 </sect2>
 
 <sect2 id="details.settings.plugins.kbanking"><title>KBanking</title>
 
+<para>
+  Since both this and the Configure Aqbanking page are minimal, should both just
+  point to the same link currently in the other section?
+</para>
+
 <para>
   This plugins adds support for HBCI/FinTs, OFX and PayPal online banking to
   KMyMoney.  However, configuring this plugin is not done through this dialog, but
-  through the <link linkend="reference.menus.settings.help">Settings</link> menu,
-  with the <menuchoice> <guimenu>Settings</guimenu> <guisubmenu>Configure
-  Aqbanking...</guisubmenu> </menuchoice> menu item.
+  through the <link linkend="reference.menus.settings.help">
+  <guilabel>Settings</guilabel> </link> menu, with the <menuchoice>
+  <guimenu>Settings</guimenu> <guisubmenu>Configure Aqbanking...</guisubmenu>
+  </menuchoice> menu item.
 </para>
 </sect2>
 


More information about the kde-doc-english mailing list