[kmymoney/5.0] doc: more doc changes for accounts for 5.0
Jack Ostroff
null at kde.org
Sat Feb 3 22:07:01 UTC 2018
Git commit 236c5db6c2c88a5dd469f5a7d64e78206c52542e by Jack Ostroff.
Committed on 03/02/2018 at 18:17.
Pushed by ostroffjh into branch '5.0'.
more doc changes for accounts for 5.0
M +44 -57 doc/details-accounts.docbook
M +118 -8 doc/details-institutions.docbook
https://commits.kde.org/kmymoney/236c5db6c2c88a5dd469f5a7d64e78206c52542e
diff --git a/doc/details-accounts.docbook b/doc/details-accounts.docbook
index ecfc426d..6b30aa0c 100644
--- a/doc/details-accounts.docbook
+++ b/doc/details-accounts.docbook
@@ -16,17 +16,21 @@
<title>The Accounts View</title>
<para>
- The Accounts View provides a summary of all the accounts. It is similar to the
- Institution view, except accounts are grouped under the Asset or Liability
+ The Accounts view provides a summary of all the accounts. It is similar to the
+ Institutions view, except accounts are grouped under the Asset and Liability
asset categories. Typical asset accounts include bank accounts, cash, and
investments, while typical liability accounts include credit cards and loans.
- <!-- FIXME: Income and Expense were previously mentioned here, but now
- explanation of them is deferred to Categories view. -->
</para>
<para>
- There are two ways to view the accounts: List or Icon view, which may be
- selected by clicking on the appropriate tab at the top of the view.
+ There are actually two other account categories: Income and
+ Expense. Categories are a way to organize your transaction; they are grouped
+ under either the Income or Expense account category) and are treated
+ internally by &kmymoney; as accounts. They are described in more detail in
+ the chapter on <link linkend="details.categories"> Categories</link>. The
+ Income and Expense account categories are always displayed in the Categories
+ view, but it is possible to <link linkend="details.settings">configure
+ &kmymoney;</link> to also display them on the Accounts view.
</para>
<para>
@@ -44,29 +48,13 @@
</para>
<para>
- <!-- FIXME: MUST RECONCILE WHICH CATEGORIES ARE DESCRIBE OR MENTIONED HERE AND
- WHICH DEFERRED FOR CATEGORIES VEIW -->
- In the List view, the accounts are grouped under four headings: Asset,
- Liability, Income, and Expense. List view shows the name and balance or value
- of each account. Income and Expense list the categories that each transaction
- is filed under, and provide similar functionality to the Categories
- screen. The options and features involving Income and Expense accounts are
- described in detail in the <link
- linkend="details.categories">Categories</link> chapter. The rest of this
- chapter will focus on Asset and Liability account functionality.
+ Similar to the Institutions view, the Accounts veiw displays several columns
+ with descriptive and summary information about each account. The rest of this
+ chapter will focus on Asset and Liability account functionality. Income and
+ Expense accounts, &ie;, Categories, are describe in the chapter on <link
+ linkend="details.categories"> Categories</link>.
</para>
-<para>
- In the Icon view, the Asset and Liability accounts are shown with icons
- indicating the account type. &kmymoney; initially places the icons
- alphabetically, but you can move the icons to any position you want, just by
- dragging the icon with the mouse. Note, however, that just moving an icon
- does not currently trigger &kmymoney; to think that any data has been changed.
- This means that you need to make some other change, such as editing an account
- or a transaction and saying OK (even without actually changing any data) so
- &kmymoney; allows you to save the file. The saved file will include the new
- icon positions.
-</para>
</sect1>
<sect1 id="details.accounts.create">
@@ -87,16 +75,10 @@
account...</guilabel> icon <guiicon><inlinemediaobject><imageobject><imagedata
fileref="newacct.png" format="PNG"/></imageobject><textobject>
<phrase>New</phrase></textobject></inlinemediaobject></guiicon> from the
- toolbar.
-</para>
-
-<para>
- Alternatively, to create an account using the accounts view, click on the
- Accounts icon 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.
+ toolbar. You can also create an account from the Accounts view; click on the
+ Accounts icon in the view selector and then right click on the Asset or
+ Liability tree icon and select <guimenuitem>New account...</guimenuitem> from
+ the popup menu.
</para>
<sect2 id="details.accounts.create.institution">
@@ -154,17 +136,17 @@
</screenshot>
</para>
-<para>
- This page is used to configure the type of account.
-</para>
-
<para>
First, enter a name for the account. This name will be used to identify it.
</para>
<para>
Next, select the type of account from one of the types available from the
- dropdown list:
+ dropdown list. Different account types are handled differently withing
+ &kmymoney;, so it is important to choose the correct type when creating the
+ account. Also, different type of accounts require different setup
+ information, and may display different pages in the new account setup wizard
+ to collect that information.
</para>
<variablelist>
@@ -222,7 +204,8 @@
<term>Investment</term>
<listitem>
<para>
- An account to manage an investment such as stocks or investment funds.
+ An account to manage an investment such as stocks, bonds, or mutual
+ funds.
</para>
</listitem>
</varlistentry>
@@ -231,7 +214,8 @@
<term>Asset</term>
<listitem>
<para>
- An account to manage an asset that does not fit in one of the above types.
+ An account to manage an asset that does not fit in one of the above
+ types.
</para>
</listitem>
</varlistentry>
@@ -240,9 +224,10 @@
<term>Liability</term>
<listitem>
<para>
- An account to manage a liability such as money you borrowed or a future
- expense. If interest needs to be calculated, you might be better using
- the Loan type above.
+ An account to manage a money you owe or a future expense that does not
+ fit in one of the above types. This is most commonly used for loans
+ with no interest. If interest needs to be calculated, you might be
+ better using the Loan type above.
</para>
</listitem>
</varlistentry>
@@ -254,13 +239,15 @@
<para>
Enter the date the account was opened or select it from the calendar using the
- icon to the right.
+ icon to the right. You will not be able to enter any transaction with a date
+ earlier than the account opening date, but you can change this date later, if
+ necessary.
</para>
<para>
- Enter the opening balance for the account. If this is an existing bank account
- this information can be found on your statement. If it is a new account, the
- opening balance can be left at zero.
+ Enter the opening balance for the account. If this is an existing bank
+ account, this information can be found on your statement. If it is a new
+ account, the opening balance can be left at zero.
</para>
<para>
@@ -269,7 +256,7 @@
</para>
<para>
- To proceed to the next step click on Next.
+ To proceed to the next step click on <guibutton>Next</guibutton>.
</para>
</sect2>
@@ -277,8 +264,10 @@
<title>Credit Card Accounts</title>
<para>
- When creating a Credit Card account, you can optionally have &kmymoney; create
- a <link linkend="details.schedules">scheduled transaction</link> for you.
+ When creating a Credit Card account, after entering the basic information and
+ clicking <guibutton>Next</guibutton>, you can optionally have &kmymoney;
+ create a <link linkend="details.schedules">scheduled transaction</link> for
+ you.
</para>
<para>
@@ -287,7 +276,6 @@
<imageobject>
<imagedata fileref="accwiz6.png" format="PNG" />
</imageobject>
-
<textobject>
<phrase>Account Wizard</phrase>
</textobject>
@@ -296,7 +284,7 @@
</para>
<para>
- If you want such a transaction generated, make sure the tick box is checked
+ If you want such a transaction generated, make sure the check box is selected
and enter the required information.
</para>
@@ -320,7 +308,6 @@
<imageobject>
<imagedata fileref="accwiz7.png" format="PNG" />
</imageobject>
-
<textobject>
<phrase>Account Wizard</phrase>
</textobject>
diff --git a/doc/details-institutions.docbook b/doc/details-institutions.docbook
index 6dfba20f..bb81c134 100644
--- a/doc/details-institutions.docbook
+++ b/doc/details-institutions.docbook
@@ -13,18 +13,16 @@
<para>
The Institutions view provides a summary of all the accounts grouped under
- their respective institutions. The list accounts under any institution can be
+ their respective institutions. The list of accounts under any institution can be
expanded or collapsed by clicking on the arrow to the left of the institution
- name.
+ name. The last listed institution is "Accounts with no institution assigned."
</para>
<para>
- The Institutions view displays several columns, including the type of account
- and the value of each account. It also shows the total value of all accounts
- in each institution. You can select which columns are shown by right clicking
- on any column heading and selecting or unselecting the checkbox next to the
- name of the column.
- <!-- need to add a description of all available columns -->
+ The Institutions view displays several columns, showing information about the
+ account. It also shows the total value of all accounts in each institution.
+ You can select which columns are shown by right clicking on any column heading
+ and selecting or unselecting the checkbox next to the name of the column.
</para>
<para>
@@ -41,6 +39,118 @@
</screenshot>
</para>
+<para>
+ The following columns are available in the Institutions view.
+</para>
+
+<variablelist>
+ <varlistentry>
+ <term>Account</term>
+ <listitem>
+ <para>
+ The name of the institution or account
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Type</term>
+ <listitem>
+ <para>
+ The type of account, ⪚, Savings, Checking, Credit Card, ...
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Tax</term>
+ <listitem>
+ <para>
+ An indication whether this account has been configured as important for
+ tax purposes.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>VAT</term>
+ <listitem>
+ <para>
+ An indication whether this account has been configured to apply a VAT on
+ transaction.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>CC (Cost Center)</term>
+ <listitem>
+ <para>
+ An indication that a cost center assignment is necessary under certain
+ conditions when entering a transaction for this account. This is a new
+ feature, which is not yet implemented, so this column is not currently
+ used.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Total Balance</term>
+ <listitem>
+ <para>
+ Another new feature, not yet implemented.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Posted Value</term>
+ <listitem>
+ <para>
+ This is the balance of the account as provided by the institution.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Total Value</term>
+ <listitem>
+ <para>
+ The balance of the account in &kmymoney;. Note that for Institutions,
+ this is the total of the balances for all accounts in that institution.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Number</term>
+ <listitem>
+ <para>
+ The account number, if one was entered.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Sort Code</term>
+ <listitem>
+ <para>
+ This shows the IBAN number, if there is a value entered in the
+ appropriate field on the Account information dialog.
+ </para>
+ </listitem>
+ </varlistentry>
+
+</variablelist>
+
+<para>
+ Note that many of these same columns are also available in other views, such
+ as the Accounts view. When you select or unselect a checkbox to display or
+ remove a column, you will see a popup asking if you want to show or remove
+ that column from all other views where it is present. If you check "No," you
+ will only change the display of that column in the current view.
+</para>
+
<sect1 id="details.institutions.institution">
<title>Institution Options</title>
More information about the kde-doc-english
mailing list