[kmymoney/5.0] doc: Update next section of doc (First time use) for 5.0
Jack Ostroff
null at kde.org
Thu Feb 1 22:51:15 UTC 2018
Git commit fadb5bf7b150f4ef3ddf7e506229aae8846efed7 by Jack Ostroff.
Committed on 01/02/2018 at 21:35.
Pushed by ostroffjh into branch '5.0'.
Update next section of doc (First time use) for 5.0
M +111 -65 doc/firsttime.docbook
M +- -- doc/newfile-2.png
M +- -- doc/newfile-3.png
M +- -- doc/newfile-4.png
M +- -- doc/newfile-5.png
M +- -- doc/newfile-6.png
M +- -- doc/newfile.png
https://commits.kde.org/kmymoney/fadb5bf7b150f4ef3ddf7e506229aae8846efed7
diff --git a/doc/firsttime.docbook b/doc/firsttime.docbook
index d0c210e9..4938b95a 100644
--- a/doc/firsttime.docbook
+++ b/doc/firsttime.docbook
@@ -3,9 +3,10 @@
<chapterinfo>
<authorgroup>
<author> &Michael.T.Edwardes; &Michael.T.Edwardes.mail; </author>
+ <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2014-08-30</date>
- <releaseinfo>4.7.01</releaseinfo>
+ <date>2018-02-01</date>
+ <releaseinfo>5.0.0</releaseinfo>
</chapterinfo>
<title>Using &kmymoney; for the first time</title>
@@ -60,6 +61,18 @@
Please click on <guibutton>Close</guibutton> to close the Tip of the Day
dialog.
</para>
+
+<note>
+ <para>
+ When you run &kmymoney;, it might not look exactly like the screenshots in
+ this manual. Many details, such as fonts, colors, and icons, can be
+ customized, either using the
+ <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
+ &kmymoney;...</guimenuitem></menuchoice> dialog or the KDE System Settings
+ application, depending on your operating system.
+ </para>
+</note>
+
</sect1>
<sect1 id="firsttime.mainwindow">
@@ -106,7 +119,7 @@
</para>
<para>
- The view selector contains the following icons
+ The view selector may contain the following icons
</para>
<itemizedlist>
@@ -172,7 +185,7 @@
</textobject>
</inlinemediaobject>
</guiicon>
- Schedules: Your recurring bills and deposits.
+ Scheduled Transactionss: Your recurring bills and deposits.
</para>
</listitem>
@@ -222,7 +235,8 @@
</textobject>
</inlinemediaobject>
</guiicon>
- Payees: All Payees used by &kmymoney;.
+ Payees: All Payees used by &kmymoney;. These are all the people or
+ organizations you pay money to or receive money from.
</para>
</listitem>
@@ -270,8 +284,8 @@
</textobject>
</inlinemediaobject>
</guiicon>
- Reports: A collection of useful reports, providing alternate views of your
- financial data.
+ Reports: A collection of useful reports, providing alternate, customizable
+ views of your financial data.
</para>
</listitem>
@@ -320,7 +334,7 @@
</inlinemediaobject>
</guiicon>
Outbox: Used by the online banking module to provide feedback on running
- processes. This is a view provided by the KBanking plugin and may not be
+ processes. This view is provided by the KBanking plugin and may not be
present on your system.
</para>
</listitem>
@@ -345,7 +359,8 @@
<menuchoice><guimenu>File</guimenu><guimenuitem>New</guimenuitem></menuchoice>
from the menu or choose the <inlinemediaobject><imageobject><imagedata
fileref="new.png"/></imageobject><textobject><phrase>New</phrase></textobject></inlinemediaobject>
- icon from the toolbar.
+ icon from the toolbar. In addition, if the main welcome page is displayed,
+ you can also select the first link: "Get started and setup accounts."
</para>
<para>
@@ -391,7 +406,12 @@
currency you use day to day and which will be used for your reports), select
the appropriate entry from the list provided and press
<guibutton>Next</guibutton>. A default will be selected from &kmymoney; based
- upon your locale settings.
+ upon your locale settings. If you don't see your currency, be sure to look
+ through the entire list, in case it it simply not sorted as you might expect.
+</para>
+
+<para>
+ In the following example, US Dollar has been selected as the base currency.
</para>
<para>
@@ -428,18 +448,18 @@
</para>
<para>
- Enter the name of the account and a possible reference number assigned by the
- institution managing the account. Enter the opening date of the account and
- the opening balance of the account. For example, you want to use &kmymoney;
- to manage all your finances as of 2008-01-01, then enter the balance of the
- account at the beginning of this date. The number can possibly be obtained
- from a paper statement. Also enter the name and routing number of the
- institution, though this information is optional and only required for online
- banking purposes.
+ Enter the name of the account and a possible account or reference number
+ assigned by the institution managing the account. Enter the opening date of
+ the account and the opening balance of the account. For example, you want to
+ use &kmymoney; to manage all your finances as of 2008-01-01, then enter the
+ balance of the account at the beginning of this date. The number can possibly
+ be obtained from a paper statement. Also enter the name and routing number of
+ the institution, though this information is optional and only required for
+ online banking purposes.
</para>
<para>
- In case you don't want to setup an initial account, please uncheck the check box
+ In case you don't want to setup an initial account, please uncheck the check box.
</para>
<para>
@@ -462,12 +482,13 @@
<para>
- Choose the appropriate country and account template(s). Multiple templates,
- even from multiple countries can be selected using a combination of
- &Ctrl; and &Shift; together with the left mouse
- button. The account hierarchy to be setup will be shown in a preview part of
- the wizard. In case you cannot find a template that suits your needs, don't
- select a template.
+ Choose the appropriate country and account template(s). Each template provides
+ a different set of categories for organizing your finances. Multiple
+ templates, even from different countries, can be selected using a combination
+ of &Ctrl; and &Shift; together with the left mouse button. The account
+ hierarchy to be setup will be shown in a preview part of the wizard. In case
+ you cannot find a template that suits your needs, don't select a template at
+ this time, and you can manually set up categories later.
</para>
<para>
@@ -476,7 +497,9 @@
</para>
<para>
- The next page of the wizard allows you to setup user preferences. Press
+ The next page of the wizard allows you to setup user preferences. If you
+ select the checkbox, the application settings dialog will be displayed after
+ you have completed the account setup wizard. Press
<guibutton>Next</guibutton> if you are done and want to proceed.
</para>
@@ -495,10 +518,11 @@
</para>
<para>
- The last page of the wizard allows you to select the filename that will be
- used to store your financial data. An initial filename will be constructed out
- of your HOME folder and user name. In case the file exists, a warning will be
- displayed which reminds you to select a name of a non-existing file.
+ The last page of the wizard allows you to select the location and filename
+ that will be used to store your financial data. Initial values will be
+ constructed out of your HOME folder and user name. In case the file exists, a
+ warning will be displayed which reminds you to select a name of a non-existing
+ file.
</para>
<para>
@@ -521,18 +545,13 @@
open it.
</para>
-<!--
-<para>After &kmymoney; has finished loading the default accounts your financial
-summary will be displayed. As you have defined no accounts to hold your
-transactions this is currently empty.</para>
--->
</sect1>
<sect1 id="firsttime.4">
<title>Creating accounts</title>
<para>
- You can create an account in one of two ways, both of which are described here:
+ There are multiple ways you can create an account, which are described here:
</para>
<variablelist>
@@ -554,19 +573,32 @@ transactions this is currently empty.</para>
To create an account using the accounts view click on the Accounts icon
<guiicon><inlinemediaobject><imageobject><imagedata
fileref="accounts_view.png"/></imageobject></inlinemediaobject></guiicon>
- in the view selector and then right click on the Asset tree icon in the
- right hand view and select <guimenuitem>New account</guimenuitem> from
- the popup menu. The Asset tree holds all of your accounts that are an
- asset. Assets, and all the other account types, are discussed in more
- detail later in this manual.
+ in the view selector to display the Accounts View. Right click on the
+ eitehr the Asset tree icon or the Liability tree icon in the right hand
+ view and select <guimenuitem>New account</guimenuitem> from the popup
+ menu. The Asset tree holds all of your accounts that are an asset, such
+ as savings and investments. Liabilities are accounts that represent
+ money you owe, such as loand and credit cards. These and all the other
+ account types are discussed in more detail later in this manual.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Using the toolbar</term>
+ <listitem>
+ <para>
+ If the <guibutton>New Account...</guibutton> button is displayed on the
+ toolbar, you can click it to create an account.
</para>
</listitem>
</varlistentry>
+
</variablelist>
<tip>
<para>
- Note that &kmymoney; uses the context menus a lot throughout the whole
+ Note that &kmymoney; uses context menus a lot throughout the whole
application. If you find yourself stuck trying to figure out how to do
something, try right-clicking where you would expect to see a feature.
</para>
@@ -576,13 +608,13 @@ transactions this is currently empty.</para>
Creating a new account by either method opens the <emphasis>New Account
Wizard</emphasis>. This wizard will take you step by step through the process
of creating an account, gathering the required information at each step. To
- navigate through the pages click on the <guibutton>Back</guibutton> and
- <guibutton>Next</guibutton> buttons.
+ navigate through the pages click on the <guibutton>Next</guibutton> and
+ <guibutton>Back</guibutton> buttons.
</para>
<para>
- Create an account using either of the two previously mentioned methods to
- continue. A full description of creating accounts can be found in the <link
+ Create an account using any of the previously mentioned methods to continue.
+ A full description of creating accounts can be found in the <link
linkend="details.accounts">Accounts</link> section.
</para>
@@ -667,10 +699,12 @@ transactions this is currently empty.</para>
<title>Quicken Interchange Format (QIF) Import</title>
<para>
- If you currently use a financial manager application, &kmymoney; can import an
- account's transactions as long as they are in the Quicken Interchange Format
- (QIF). Most financial programs can export this format and the different
- applications methods of exporting QIF is not discussed here for brevity.
+ If you currently use another financial manager application, &kmymoney; can
+ import an account's transactions as long as they can be exported or saved in a
+ format &kmymoney; understands. The most common of these is the Quicken
+ Interchange Format (QIF). Most financial programs can export this format,
+ although the different applications' methods of exporting QIF is not discussed
+ here for brevity.
</para>
<para>
@@ -743,14 +777,14 @@ transactions this is currently empty.</para>
<para>
To backup your file through &kmymoney; Select
<guimenuitem>Backup</guimenuitem> from the <guimenu>File</guimenu> menu and
- enter the folder where you wish the file to be copied to. If the folder
+ enter the folder where you wish the file to be saved. If the folder
needs mounting first and you have the sufficient privileges then check the
tick box labeled <guilabel>Mount this directory before backing up</guilabel>
and click on <guibutton>OK</guibutton>.
</para>
<para>
- The file will be copied to the folder specified with the current date appended
+ The file will be saved to the folder specified with the current date appended
to the filename so it is easy to see the date the file was backed up.
</para>
</sect1>
@@ -766,8 +800,9 @@ transactions this is currently empty.</para>
</para>
<para>
- For a complete description of all the available line options, see the man page
- for &kmymoney;. However, there are two special cases which we describe here.
+ For a complete description of all the available command line options, see the
+ man page for &kmymoney;. However, there are two special cases which we
+ describe here.
</para>
<formalpara><title><command>kmymoney -n</command></title>
@@ -834,14 +869,16 @@ transactions this is currently empty.</para>
<quote>kmymoneyrc</quote>. This file will be in a directory with other &kde;
application configuration files. On a &Linux; system, this will be in
<quote>$KDEHOME/share/config</quote> where <quote>$KDEHOME</quote> is usually
- <quote>.kde4</quote> within your home directory.
+ <quote>.config</quote> within your home directory. If you are migrating from
+ a version of &kmymoney; prior to 5.0 to 5.0 or later, the old location
+ of<quote>$KDEHOME</quote> was <quote>.kde4</quote>.
</para>
<sect3 id="firsttime.newpc.settings.plugins">
<title>Moving plugin settings</title>
<para>
- If you have run any &kmymoney; plugins, such as the csv importer or exporter,
+ If you have run any &kmymoney; plugin, such as the csv importer or exporter,
it may also have created a configuration file in that same directory, such as
csvimporterrc or csvexporterrc. These should also be copied to the new
computer.
@@ -854,11 +891,18 @@ transactions this is currently empty.</para>
configuration file, to be sure the plugin behaves as you expect.
</para>
+<para>
+ Note that when upgrading from a previous version to version 5.0 or higher, the
+ location of the template files used by the plugin for printing checks has
+ changed. Please consult the release notes or the project <ulink
+ url="http://www.kmymoney.org/faq.php">website</ulink> for more details.
+</para>
+
<note>
<para>
These instructions are solely for moving your &kmymoney; data and settings.
However, there may be important items which are stored by &kde; and not by
- &kmymoney;, such as any passwords stored in kwallet. Moving other parts of
+ &kmymoney;, such as passwords stored in kwallet. Moving other parts of
your &kde; setup is beyond the scope of this manual, although many of the
relevant files are also stored under <quote>$KDEHOME</quote>.
</para>
@@ -875,8 +919,13 @@ transactions this is currently empty.</para>
<para>
For general questions or comments about &kmymoney;, there is a users' mailing
- list &userlist;. In addition, you can contact the developers through their
- mailing list &devlist;.
+ list &userlist;. (<ulink
+ url="https://mail.kde.org/mailman/listinfo/kmymoney">more details
+ here</ulink>.) In addition, you can contact the developers through their
+ mailing list &devlist;. (<ulink
+ url="https://mail.kde.org/mailman/listinfo/kmymoney-devel"> more deatils
+ here</ulink>.) Since replies are often sent only to the list, you may not get
+ any response unless you subscribe to one of the lists before sending to it,
</para>
<para>
@@ -893,11 +942,8 @@ transactions this is currently empty.</para>
Bug</guimenuitem></menuchoice> and filling in the required information.
However, in case you have any difficulties with that method, you can report a
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> 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.
+ url="http://bugs.kde.org">&kde; bug reporting web site</ulink>. Reports
+ should be filed against the product <quote>kmymoney</quote>.
</para>
<para>
@@ -928,7 +974,7 @@ transactions this is currently empty.</para>
Bug</guimenuitem></menuchoice> menu choice will fill this in automatically,
but if you would prefer not to use this interface, there are several items
you need to include in the report. We will need to know what operating
- system you are using (&Linux;, &MacOS;, or &Windows;), the version of &kde;
+ system you are using (&Linux;, &MacOS;, or &Windows;), the version of &kde;,
and the version of &kmymoney; you're running, and either the version of
&MacOS; or &Windows; or the name and version of your &Linux; distribution
and the version of your kernel.
diff --git a/doc/newfile-2.png b/doc/newfile-2.png
index 8f30eeaa..df44f3fe 100644
Binary files a/doc/newfile-2.png and b/doc/newfile-2.png differ
diff --git a/doc/newfile-3.png b/doc/newfile-3.png
index 071cc52f..b12a6fd3 100644
Binary files a/doc/newfile-3.png and b/doc/newfile-3.png differ
diff --git a/doc/newfile-4.png b/doc/newfile-4.png
index c5b25669..a11ba3eb 100644
Binary files a/doc/newfile-4.png and b/doc/newfile-4.png differ
diff --git a/doc/newfile-5.png b/doc/newfile-5.png
index bc9eed1a..5fd99be4 100644
Binary files a/doc/newfile-5.png and b/doc/newfile-5.png differ
diff --git a/doc/newfile-6.png b/doc/newfile-6.png
index b916c445..ada3d76a 100644
Binary files a/doc/newfile-6.png and b/doc/newfile-6.png differ
diff --git a/doc/newfile.png b/doc/newfile.png
index c3e5eaf6..69874ac2 100644
Binary files a/doc/newfile.png and b/doc/newfile.png differ
More information about the kde-doc-english
mailing list