[kde-doc-english] [kmymoney/add-onlinebanking] doc: First round of Handbook changes for upcoming 4.7 release.
Christian Dávid
christian-david at web.de
Wed Sep 24 19:31:09 UTC 2014
Git commit 7577202d1a3d916bca9140b6f2bce4492c4ce3ef by Christian Dávid, on behalf of Jack Ostroff.
Committed on 31/08/2014 at 00:09.
Pushed by christiand into branch 'add-onlinebanking'.
First round of Handbook changes for upcoming 4.7 release.
M +4 -4 doc/credits.docbook
M +4 -4 doc/details-formats.docbook
M +36 -5 doc/details-settings.docbook
M +30 -3 doc/faq.docbook
M +7 -6 doc/firsttime.docbook
M +4 -5 doc/index.docbook
M +19 -10 doc/installation.docbook
M +5 -4 doc/introduction.docbook
M +18 -2 doc/reference.docbook
M +9 -2 doc/whatsnew.docbook
http://commits.kde.org/kmymoney/7577202d1a3d916bca9140b6f2bce4492c4ce3ef
diff --git a/doc/credits.docbook b/doc/credits.docbook
index f5cd4a0..91279bb 100644
--- a/doc/credits.docbook
+++ b/doc/credits.docbook
@@ -1,20 +1,20 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="credits">
<chapterinfo>
- <date>2011-07-20</date>
- <releaseinfo>4.6</releaseinfo>
+ <date>2014-08-30</date>
+ <releaseinfo>4.7.01</releaseinfo>
</chapterinfo>
<title>Credits</title>
<para>
Program Copyright © 2000, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
- 2010, 2011 The KMyMoney Development Team
+ 2010, 2011, 2012, 2013, 2014 The KMyMoney Development Team
</para>
<para>
Documentation Copyright © 2000, 2001, 2003, 2004, 2005, 2006, 2007, 2008,
- 2009, 2010, 2011 The KMyMoney Development Team
+ 2009, 2010, 2011, 2012, 2013, 2014 The KMyMoney Development Team
</para>
<sect1 id="credits.original">
diff --git a/doc/details-formats.docbook b/doc/details-formats.docbook
index 1e35dd5..5ca88e9 100644
--- a/doc/details-formats.docbook
+++ b/doc/details-formats.docbook
@@ -4,8 +4,8 @@
<authorgroup>
<author> &Thomas.Baumgart; &Thomas.Baumgart.mail; </author>
</authorgroup>
- <date>2010-07-25</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2014-08-30</date>
+ <releaseinfo>4.7.01</releaseinfo>
</chapterinfo>
<title>File Formats</title>
@@ -156,8 +156,8 @@
case you lose your own private key. This is possible because the data is not
only encrypted for your own key, but also for the &kappname; recover key. This
key is only available to selected &kappname; developers (at the time of
- writing only to the author). As of the release of &kappname; version 4.5, the
- release key is set to expire on 3 January 2015.
+ writing only to the author). As of the release of &kappname; version 4.7, the
+ recover key is set to expire on 3 January 2015.
</para>
<para>
diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook
index 6abbe3a..0d7dfb0 100644
--- a/doc/details-settings.docbook
+++ b/doc/details-settings.docbook
@@ -4,8 +4,8 @@
<authorgroup>
<author> &Roger.Lum; &Roger.Lum.mail; </author>
</authorgroup>
- <date>2010-07-25</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2014-08-30</date>
+ <releaseinfo>4.7.01</releaseinfo>
</chapterinfo>
<title id="details.settings.title">&kappname; Settings</title>
@@ -747,9 +747,40 @@
<title id="details.settings.plugins.title">Plugins</title>
<para>
- These options allow you to modify the behavior of any installed
- plugins. Currently, the only choice is to enable or disable the &kappname;
- plugins you have installed.
+ These options allow you to modify the behavior of any installed plugins. For
+ most plugins, the only choice is to enable or disable it, although there is
+ also an <guibutton>Info</guibutton> button which will show the plugin version
+ and author. Further information on configuring and using these plugins may be
+ found in the separate sections for <link linkend="details.impexp.csv">CSV
+ Import</link> and <link linkend="details.impexp.ofx">OFX Import</link>
+ plugins. It is also true for the <link
+ linkend="details.reconcile">Reconciliation report</link>, although that report
+ is only a minor part of the larger reconciliation process. The one plugin
+ that does require a configuration step is the Print Check plugin.
</para>
+
+<sect2 id="details.settings.plugins.printchecks">
+<title>Print check plugin</title>
+
+<para>
+ This plugin is inlcuded with the source of &kappname;, and should always be
+ enabled. It allows printing of a check based on the data from a selected
+ transaction, with the layout controlled by an html template. Usually, the
+ template is matched to pre-printed checks. When you click on the
+ <guibutton>configure</guibutton> (a small wrench), the <guilabel>Print
+ check</guilabel>configuration dialog is displayed. At the top is a text box
+ for the path to the selected template. To the right of that is a button which
+ brings up a file chooser, to select an alternative template file.
+</para>
+
+<para>
+ A template file is an html file, which is used with specific strings to
+ reference the fields from the transaction or from the current account and
+ institution to show where they will be printed on the check. &kappname; is
+ shipped with several template files. You should either be able to use one of
+ them, or modify one to suit your needs. The default value of the template
+ file will show you the directory which contains the sample files.
+</para>
+</sect2>
</sect1>
</chapter>
diff --git a/doc/faq.docbook b/doc/faq.docbook
index 8933d8d..bc33955 100644
--- a/doc/faq.docbook
+++ b/doc/faq.docbook
@@ -4,8 +4,8 @@
<authorgroup>
<author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2010-07-25</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2014-08-30</date>
+ <releaseinfo>4.7.01</releaseinfo>
</chapterinfo>
<title>Questions and Answers</title>
@@ -221,6 +221,21 @@
<qandaentry>
<question>
+ <para>I compiled from source, but the version number in the Help->About
+ dialog no longer gets changed to show the latest git commit, like it used
+ to?</para>
+ </question>
+ <answer>
+ <para>You probably ran <command>$ make</command> without running <command>$
+ cmake</command> or <command>$ ccmake</command> first. If you update the
+ code, using <command>$ git pull</command>, one of those two commands is
+ necessary to put the updated version number/git commit in the right place.
+</para>
+ </answer>
+</qandaentry>
+
+<qandaentry>
+ <question>
<para>Will &kappname; work on my X/&ubuntu; desktop? Will &kappname; work
without a full KDE desktop?</para>
</question>
@@ -259,7 +274,7 @@
<para>Why is there no translation for 'my' language?</para>
</question>
<answer>
- <para>First, &kappname; uses the &kde; settings for language, so first, make
+ <para>&kappname; uses the &kde; settings for language, so first, make
sure that your region and language settings are correct. If they are, the
most likely reason is that no one has offered to translate it yet.
Translating &kde;/&Qt;-based applications is very simple, and does not
@@ -303,6 +318,18 @@
</answer>
</qandaentry>
+<qandaentry>
+ <question>
+ <para>Why isn't there an easy way to print some scheduled transactions, or
+ part of the ledger, or ...</para>
+ </question>
+ <answer>
+ <para>Look in the <link linkend="details.reports.avail">Reports</link>
+ section. Many of the reports actually provide an easy way to print thing you
+ can't quite do directly from the ledger or other screens.</para>
+ </answer>
+</qandaentry>
+
</qandadiv>
</qandaset>
diff --git a/doc/firsttime.docbook b/doc/firsttime.docbook
index 2fef99b..07cfba2 100644
--- a/doc/firsttime.docbook
+++ b/doc/firsttime.docbook
@@ -4,8 +4,8 @@
<authorgroup>
<author> &Michael.T.Edwardes; &Michael.T.Edwardes.mail; </author>
</authorgroup>
- <date>2010-07-25</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2014-08-30</date>
+ <releaseinfo>4.7.01</releaseinfo>
</chapterinfo>
<title>Using &kappname; for the first time</title>
@@ -52,8 +52,8 @@
<para>
All tips have been extracted from the Frequently Asked Questions list (FAQ)
that provides more detailed help and can be found on the project <ulink
- url="http://kmymoney2.sourceforge.net/faq.html">website</ulink> and in this
- manual.
+ url="http://www.kmymoney.org/faq.php">website</ulink> and in <link
+ linkend="faq">this manual</link>.
</para>
<para>
@@ -781,8 +781,9 @@ transactions this is currently empty.</para>
bug (or file a wish-list or enhancement request) directly at the <ulink
url="http://bugs.kde.org">&kde; bug reporting web page</ulink>. Reports
should be filed against the product <quote>kmymoney4</quote>.
- <quote>kmymoney2</quote> is specifically for bugs in the 1.0.x versions of the
- application.
+ <quote>kmymoney2</quote> was specifically for bugs in the 1.0.x versions of the
+ application, and as those versions are no longer supported, it is closed for
+ further bug reporting.
</para>
<para>
diff --git a/doc/index.docbook b/doc/index.docbook
index 19295cf..1126b3a 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -16,7 +16,6 @@
from entities/general.entities and $LANG/user.entities. -->
<!ENTITY devlist "<email>kmymoney-devel at kde.org</email>">
<!ENTITY userlist "<email>kmymoney at kde.org</email>">
- <!ENTITY olduserlist "<email>kmymoney2-user at lists.sourceforge.net</email>">
<!-- the following author entities have been added to contributor.entities in 4.5 branch and trunk of svn
they can be removed from this file once they are present in the kdelibs minimum version required by &kappname; -->
@@ -123,7 +122,7 @@
<bookinfo>
<title>The &kappname; Handbook</title>
-<subtitle>for &kappname; version 4.6</subtitle>
+<subtitle>for &kappname; version 4.7</subtitle>
<authorgroup>
<!-- This is just put in as an example. For real documentation, please
@@ -170,8 +169,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>2011-07-04</date>
-<releaseinfo>4.06.00</releaseinfo>
+<date>2014-08-30</date>
+<releaseinfo>4.07.01</releaseinfo>
<!-- Abstract about this handbook -->
@@ -181,7 +180,7 @@ Do NOT change these in the translation. -->
</para>
<para>
- This handbook describes &kappname; version 4.6.
+ This handbook describes &kappname; version 4.7.
</para>
</abstract>
diff --git a/doc/installation.docbook b/doc/installation.docbook
index 8a115a1..51ddf48 100644
--- a/doc/installation.docbook
+++ b/doc/installation.docbook
@@ -4,8 +4,8 @@
<authorgroup>
<author>&Jack.H.Ostroff; &Jack.H.Ostroff.mail;</author>
</authorgroup>
- <date>2011-07-20</date>
- <releaseinfo>4.6</releaseinfo>
+ <date>2014-08-30</date>
+ <releaseinfo>4.7.01</releaseinfo>
</appendixinfo>
<title>Installation</title>
@@ -20,16 +20,24 @@
<title>How to obtain &kappname;</title>
<para>
- Although &kappname; has existed for a number of years, we are still working on
- full integration into &kde;. Early stable versions (1.0.x) required libraries
- from &kde; 3, and so were not available in many Linux distributions, which had
- already migrated to &kde; 4. However, with the release of version 4.5 in
- August 2010, &kappname; could be easily compiled and installed on any version
- of &kde; 4.3 or higher. The current version, 4.6, requires &kde; 4.3,
+ &kappname; has existed for a number of years, and we have worked very hard on
+ full integration into &kde;. The earliest stable versions (1.0.x) required
+ libraries from &kde; 3, and so were not available in many Linux distributions,
+ which had already migrated to &kde; 4. However, with the release of version
+ 4.5 in August 2010, &kappname; could be easily compiled and installed on any
+ version of &kde; 4.3 or higher. The current version, 4.7, requires &kde; 4.6,
specifically kdelibs and kdepimlibs.
</para>
<para>
+ Althouh work has begun porting &kappname; to the new KDE Frameworks 5, this is
+ still very early, and not yet usable. Hopefully it will be available in the
+ 5.0 version, which we expect to release in early 2015. Until then, if you are
+ specifically interested in following this work, you should subscribe to the
+ developers mailing list &devlist;.
+</para>
+
+<para>
The rest of this section will describe installing &kappname; using the
standard software installation process for your Linux distribution. The
following section will discuss compiling from source.
@@ -82,8 +90,9 @@
check out a recent bug fix or new feature, you can download a tarball which is
a snapshot of the development repository. You can also check the source
directly out of the repository. The version 4.x source is in &kde; Git. (The
- version 1.0.x source is in SourceForge cvs, but it is no longer being
- developed.) Instructions for access are on the project home page.
+ version 1.0.x source was in SourceForge cvs, but it is no longer being
+ developed or supported at all.) Instructions for access are on the project
+ home page.
</para>
<warning>
diff --git a/doc/introduction.docbook b/doc/introduction.docbook
index 227ad1d..d497ed9 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>2010-07-19</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2014-08-30</date>
+ <releaseinfo>4.7.01</releaseinfo>
</chapterinfo>
<title>Introduction</title>
@@ -12,8 +12,9 @@
<para>
Put simply, &kappname; is a personal finance manager for &kde;. It enables
- users of open source operating systems to keep careful track of their personal
- finances by providing a broad array of financial features and tools.
+ users of open source operating systems and applications to keep careful track
+ of their personal finances by providing a broad array of financial features
+ and tools.
</para>
<para>
diff --git a/doc/reference.docbook b/doc/reference.docbook
index e0f99cf..0b21b3a 100644
--- a/doc/reference.docbook
+++ b/doc/reference.docbook
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="UTF-8"?>
<chapter id="reference">
<chapterinfo>
- <date>2010-07-25</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2014-08-30</date>
+ <releaseinfo>4.7.01</releaseinfo>
</chapterinfo>
<title>Reference</title>
@@ -672,6 +672,22 @@
<para><action>Selects all transactions on the register.</action></para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term><menuchoice>
+ <guimenu>Transaction</guimenu><guimenuitem>Print check</guimenuitem>
+ </menuchoice></term>
+ <listitem>
+ <para>
+ <action>Prints the contents of the selected transaction in the displayed
+ register, formatted according to the selected template.</action> Note
+ that this menu choice is only present if a transaction is selected in
+ the register. See the section on configuring the <link
+ linkend="details.settings.plugins">Print check</link> plugin for more
+ information.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</sect2>
diff --git a/doc/whatsnew.docbook b/doc/whatsnew.docbook
index a1513a0..e12766d 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>2011-07-21</date>
- <releaseinfo>4.6</releaseinfo>
+ <date>2014-08-30</date>
+ <releaseinfo>4.7.01</releaseinfo>
</chapterinfo>
<title>What's new in this release</title>
@@ -14,6 +14,13 @@
</para>
<para>
+ In addition to numerous bug fixes, this version also includes new features and
+ functionality. Although all new features have had some testing, this is
+ considered a development release, in preparation for a full release 4.8 early
+ in 2015.
+</para>
+
+<para>
Here are some of the new features found in this release:
</para>
More information about the kde-doc-english
mailing list