[office/kmymoney/Handbook-5.2] /: Initial changes for updating handbook for 5.2

Jack Ostroff null at kde.org
Mon Aug 14 22:01:00 BST 2023


Git commit 4d001e190980fb78c6909fef54bff07fa1dc9d50 by Jack Ostroff.
Committed on 06/08/2023 at 00:23.
Pushed by ostroffjh into branch 'Handbook-5.2'.

Initial changes for updating handbook for 5.2

A  +19   -0    README-CONTRIBUTORS
M  +2    -2    doc/firsttime.docbook
M  +5    -5    doc/index.docbook
M  +6    -3    doc/introduction.docbook
M  +19   -87   doc/whatsnew.docbook

https://invent.kde.org/office/kmymoney/-/commit/4d001e190980fb78c6909fef54bff07fa1dc9d50

diff --git a/README-CONTRIBUTORS b/README-CONTRIBUTORS
new file mode 100644
index 000000000..8911cd4c8
--- /dev/null
+++ b/README-CONTRIBUTORS
@@ -0,0 +1,19 @@
+This Handbook-5.2 branch is specifically for preparing the Handbook for the
+upcoming (but not yet scheduled) release of KMyMoney 5.2 from master branch.
+Use of a separate branch rather than working in master branch is intended to
+save the translators from extra work, as there are likely to be multiple
+edits to some sections, as well as reorganizations of the material.
+
+If you are interested in contributing, please contact
+ostroffjh at users.sourceforge.net so multiple people are not working on the
+same chapters at the same time.
+
+I expect that there will be changes ONLY in the doc subdirectory.
+
+Update of screenshots will be left for later in the process, but
+descriptions of what changes or new screenshots are needed can/should be
+placed below the existing or target location.
+
+At some point, I will add to this doc a list of which chapters have and have
+not been edited yet, and not use the list used for the 4 -> 5 changes in the
+What's New section.
\ No newline at end of file
diff --git a/doc/firsttime.docbook b/doc/firsttime.docbook
index f2a3fcae5..b7551516b 100644
--- a/doc/firsttime.docbook
+++ b/doc/firsttime.docbook
@@ -5,8 +5,8 @@
     <author> &Michael.T.Edwardes; &Michael.T.Edwardes.mail; </author>
     <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
   </authorgroup>
-  <date>2018-02-01</date>
-  <releaseinfo>5.0.0</releaseinfo>
+  <date>2023-08-15</date>
+  <releaseinfo>5.2.0</releaseinfo>
 </chapterinfo>
 
 <title>Using &kmymoney; for the first time</title>
diff --git a/doc/index.docbook b/doc/index.docbook
index f5fe41fa0..7006546c6 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -115,7 +115,7 @@
 
 <bookinfo>
 <title>The &kmymoney; Handbook</title>
-<subtitle>for &kmymoney; version 5.0</subtitle>
+<subtitle>for &kmymoney; version 5.2</subtitle>
 
 <authorgroup>
 <!-- This is just put in as an example.  For real documentation, please
@@ -137,7 +137,7 @@ and use `&George.N.Ugnacious; &George.N.Ugnacious.mail;' in the author element.
 </authorgroup>
 
 <copyright>
-<year>2000-2018</year>
+<year>2000-2023</year>
 <holder>The &kmymoney; Development Team</holder>
 </copyright>
 <!-- Translators: put here the copyright notice of the translation -->
@@ -152,8 +152,8 @@ Please respect the format of the date (YYYY-MM-DD) and of the version
 (V.MM.LL), it could be used by automation scripts.
 Do NOT change these in the translation. -->
 
-<date>2018-01-13</date>
-<releaseinfo>5.0.0</releaseinfo>
+<date>2023-08-15</date>
+<releaseinfo>5.2.0</releaseinfo>
 
 <!-- Abstract about this handbook -->
 
@@ -163,7 +163,7 @@ Do NOT change these in the translation. -->
 </para>
 
 <para>
-  This handbook describes &kmymoney; version 5.0.
+  This handbook describes &kmymoney; version 5.2.
 </para>
 </abstract>
 
diff --git a/doc/introduction.docbook b/doc/introduction.docbook
index 063edffd3..f45c8743a 100644
--- a/doc/introduction.docbook
+++ b/doc/introduction.docbook
@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <chapter id="introduction">
 <chapterinfo>
-  <date>2018-01-13</date>
-  <releaseinfo>5.0.0</releaseinfo>
+  <date>2023-08-15</date>
+  <releaseinfo>5.2.0</releaseinfo>
 </chapterinfo>
 
 <title>Introduction</title>
@@ -61,7 +61,10 @@
   As a personal finance manager, &kmymoney; is not intended to scale to the
   needs of an average business.  A small business might find sufficient
   functionality to use &kmymoney;, but features such as accounts-receivable and
-  accounts-payable are not directly supported.  However, it would be possible to
+  accounts-payable are not directly supported.  Most if not all the data needed
+  for a small business, such as for reports for audit and taxation purposes is
+  present, but may need to be extracted using various reports and then processed
+  and assembled into the required formats.  In addition, it would be possible to
   create client, supplier, document, or other features through plugins.
 </para>
 
diff --git a/doc/whatsnew.docbook b/doc/whatsnew.docbook
index 5c4b7b353..7a8f5b99d 100644
--- a/doc/whatsnew.docbook
+++ b/doc/whatsnew.docbook
@@ -1,8 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <chapter id="whatsnew">
 <chapterinfo>
-  <date>2019-04-04</date>
-  <releaseinfo>5.0.4</releaseinfo>
+  <date>2023-08-15</date>
+  <releaseinfo>5.2.0</releaseinfo>
 </chapterinfo>
 <title>What's new in this release</title>
 
@@ -11,112 +11,44 @@
 
 <para>
   As with every release, the &kmymoney; development team continues to work hard
-  to make each version better and easier to use in every way.  This is the third
-  release in the 5.1 series, and most of the activity has been directed to
-  fixing bugs.
+  to make each version better and easier to use in every way.  Many bugs have
+  been fixed since the previous stable release of 5.1.4; several areas of the
+  program have seen functional enhancements; but the major noticeable change from
+  the 5.1 series of releases is in the ledger - more details below.
 </para>
 
 <para>
-  As of 5.1, the conversion to using &kde-frameworks; is essentially complete,
-  although that and the work to update many of the underlying libraries used by
-  the application are behind the scenes and not directly visible to the end
-  user.  The general look and feel should be stable, although some minor changes
-  may still occur.  The basic functionality of the program also remains the
-  same, aside from intentional improvements and additions.
+  The conversion to using &kde-frameworks; was essentially complete in the 5.1.x
+  releases, with much of that work behind the scenes and not directly visible to the
+  end user.  The general look and feel should remain stable, although some minor
+  changes still occur.  The basic functionality of the program also remains the same,
+  aside from intentional improvements and additions.
 </para>
 
 <para>
-  In past releases, this page of the manual has included a list of many of the
+  In past releases, this section of the manual has included a list of many of the
   specific bug fixes and functional enhancements.  However, rather than
   duplicating that information, you can find it directly in the <ulink
   url="https://kmymoney.org/changelog.html">Changelog</ulink>.
 </para>
 
 <para>
-  Since the release of 5.0, there have been some changes which will need
-  adjustments on the user's side if you are upgrading from 4.8.x or an older
-  version.  However, we expect that most users have converted to 5.x by now.
+  The 5.0.x and 5.1.x series included some changes needing adjustments on the
+  user's side, if they were upgrading from 4.8.x or an older version.  However,
+  we expect that most users have converted to 5.x by now.  Specifically, there
+  should be no adjustments needed by users converting from 5.1.x to 5.2.
 </para>
 
-<itemizedlist>
-  <listitem><para> For some time now, the program searches for the templates for
-  the printcheck plugin in different locations than previously.  If this is
-  still an issue for you, you need to account for this in the plugins setting
-  dialog, <link linkend="details.settings.plugins">see this section for more
-  details</link>.  </para></listitem>
-</itemizedlist>
 </sect1>
 
 <sect1>
 <title>Updates to this Handbook</title>
-
-<para>
-  While we continue to make progress, there are still chapters of this handbook which
-  have not been updated to reflect all changes in the program which are visible to
-  the user as of 5.0.  Each chapter does identify the release of &kmymoney; for which
-  it was last updated, but we present the complete list here, as a quick reference.
-</para>
-
 <para>
-  However, please note that extent to which the chapters which have not been
-  explicitly updated do or do not reflect the current operation of the program
-  depends on how much that area of the program has changed between the 4.8 and the
-  5.0 and 5.1 releases.  
+  This section used to talk about the lack of complete handbook update from 4.x
+  to 5.x.  The intent is that the handbook be fully updated for 5.2, so this
+  section should hopefully be able to be removed before release.
 </para>
-  
-<informaltable frame="none">
-  <tgroup cols="2">
-    <thead>
-      <row>
-	<entry><para>Chapters updated for 5.x</para></entry>
-	<entry><para>Chapters not yet updated for 5.x</para></entry>
-      </row>
-    </thead>
-    <tbody>
-      <row>
-	<entry valign="top">
-	  <simplelist>
-	    <member><link linkend="introduction">Introduction</link></member>
-	    <member><link linkend="whatsnew">What's new in this release</link></member>
-	    <member><link linkend="makingmostof">Making the most of &kmymoney;</link></member>
-	    <member><link linkend="firsttime">Using &kmymoney; for the first time</link></member>
-	    <member><link linkend="details.institutions">Institutions</link></member>
-	    <member><link linkend="details.accounts">Accounts</link></member>
-	    <member><link linkend="details.categories">Categories</link></member>
-	    <member><link linkend="details.tags">Tags</link></member>
-	    <member><link linkend="details.payees">Payees</link></member>
-	    <member><link linkend="details.reconcile">Schedules</link></member>
-	    <member><link linkend="details.ledgers">Ledgers</link></member>
-	    <member><link linkend="details.investments">Investments</link></member>
-	    <member><link linkend="details.settings">Settings</link></member>
-	    <member><link linkend="faq">Questions and Answers</link></member>
-	    <member><link linkend="reference.menus">Reference: Menus</link></member>
-	    <member><link linkend="credits">Credits</link></member>
-	  </simplelist>
-	</entry>
-	<entry valign="top">
-	  <simplelist>
-	    <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.loans">Loans</link></member>
-	    <member><link linkend="details.budgets">Budgets</link></member>
-	    <member><link linkend="details.forecast">Forecast</link></member>
-	    <member><link linkend="details.search">Search Transactions</link></member>
-	    <member><link linkend="details.formats">File Formats</link></member>
-	    <member><link linkend="details.database">Database</link></member>
-	    <member><link linkend="reference.widgets">Reference: Widgets</link></member>
-	  </simplelist>
-	</entry>
-      </row>
-    </tbody>
-  </tgroup>
-</informaltable>
-<para>
 
-</para>
 </sect1>
-
   
 </chapter>



More information about the kde-doc-english mailing list