Git commit 059bd6a6a159bd635952307a97bf974d4ccb54c6 by Jack Ostroff. Committed on 03/02/2018 at 18:17. Pushed by ostroffjh into branch '5.0'.
Initial update to institutions and accounts docs for 5.0 M +- -- doc/account_options.png A +- -- doc/account_view.png M +31 -12 doc/details-accounts.docbook M +20 -14 doc/details-institutions.docbook M +- -- doc/institution_options.png M +- -- doc/institution_view.png M +- -- doc/newinst.png https://commits.kde.org/kmymoney/059bd6a6a159bd635952307a97bf974d4ccb54c6 diff --git a/doc/account_options.png b/doc/account_options.png index 9e74713f..ab0247dd 100644 Binary files a/doc/account_options.png and b/doc/account_options.png differ diff --git a/doc/account_view.png b/doc/account_view.png new file mode 100644 index 00000000..cd9a8b47 Binary files /dev/null and b/doc/account_view.png differ diff --git a/doc/details-accounts.docbook b/doc/details-accounts.docbook index 0ceaab74..ecfc426d 100644 --- a/doc/details-accounts.docbook +++ b/doc/details-accounts.docbook @@ -4,9 +4,10 @@ <authorgroup> <author> &Michael.T.Edwardes; &Michael.T.Edwardes.mail; </author> <author> &Roger.Lum; &Roger.Lum.mail; </author> + <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author> </authorgroup> - <date>2011-07-21</date> - <releaseinfo>4.6</releaseinfo> + <date>2018-02-01</date> + <releaseinfo>5.0.0</releaseinfo> </chapterinfo> <title>Accounts</title> @@ -15,10 +16,12 @@ <title>The Accounts View</title> <para> - The Accounts View provides a summary of all the accounts. There are four - different account categories: Asset, Liability, Income, and Expense. Typical - asset accounts include bank accounts, cash, and investments, while typical - liability accounts include credit cards and loans. + 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 + 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> @@ -27,6 +30,22 @@ </para> <para> +<screenshot> + <screeninfo>account view</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="account_view.png" format="PNG" /> + </imageobject> + <textobject> + <phrase>account view</phrase> + </textobject> + </mediaobject> +</screenshot> +</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 @@ -56,18 +75,18 @@ <para> <emphasis> NOTE: You must have a file open before you can create a new account. If you - do not have an existing file, you will need to create a <link - linkend="firsttime.3">new file</link>. + do not have an existing file, you will need to <link + linkend="firsttime.3">create one</link>. </emphasis> </para> <para> To create a new account, you can either select <menuchoice><guimenu>Account</guimenu><guimenuitem>New - account...</guimenuitem></menuchoice> from the menu or choose the - <guiicon><inlinemediaobject><imageobject><imagedata fileref="newacct.png" - format="PNG"/></imageobject><textobject> - <phrase>New</phrase></textobject></inlinemediaobject></guiicon> icon from the + account...</guimenuitem></menuchoice> from the menu or choose the <guilabel>New + account...</guilabel> icon <guiicon><inlinemediaobject><imageobject><imagedata + fileref="newacct.png" format="PNG"/></imageobject><textobject> + <phrase>New</phrase></textobject></inlinemediaobject></guiicon> from the toolbar. </para> diff --git a/doc/details-institutions.docbook b/doc/details-institutions.docbook index 12b805d6..6dfba20f 100644 --- a/doc/details-institutions.docbook +++ b/doc/details-institutions.docbook @@ -3,23 +3,28 @@ <chapterinfo> <authorgroup> <author> &Roger.Lum; &Roger.Lum.mail; </author> + <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author> </authorgroup> - <date>2010-07-25</date> - <releaseinfo>4.5</releaseinfo> + <date>2018-02-01</date> + <releaseinfo>5.0.0</releaseinfo> </chapterinfo> <title>Institutions</title> <para> - The Institutions screen provides a summary of all the accounts grouped under - their respective institutions. Asset accounts are symbolized with a black - arrow, and liability accounts are symbolized with a red arrow. + The Institutions view provides a summary of all the accounts grouped under + their respective institutions. The list accounts under any institution can be + expanded or collapsed by clicking on the arrow to the left of the institution + name. </para> <para> - The Institutions screen 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. + 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 --> </para> <para> @@ -88,8 +93,8 @@ <para> <emphasis> NOTE: You must have a file open before you can create a new institution. If - you do not have an existing file, you will need to create a <link - linkend="firsttime.3">new file</link>. + you do not have an existing file, you will need to <link + linkend="firsttime.3">create one</link>. </emphasis> </para> @@ -116,11 +121,12 @@ <guimenuitem>Edit account</guimenuitem> brings up a window allowing you to change an account's name, start date, associated banking institution, and parent account. Deleting an account is only possible if there are no - transactions associated with that account. Selecting + transactions associated with that account, and the account is not referred to + in any scheduled transaction. Selecting <guimenuitem>Reconcile...</guimenuitem> opens up the Reconcile Wizard, which - steps you through the process of comparing your bank account statements to - your electronic entries. More details, as well as information about the other - options is presented in the appropriate sections of this manual. + steps you through the process of comparing your account statement to your + electronic entries. More details, as well as information about the other + options, are presented in the appropriate sections of this manual. </para> <para> diff --git a/doc/institution_options.png b/doc/institution_options.png index 3f6e73a7..7b00e8cd 100644 Binary files a/doc/institution_options.png and b/doc/institution_options.png differ diff --git a/doc/institution_view.png b/doc/institution_view.png index 67b0aa6f..d1088119 100644 Binary files a/doc/institution_view.png and b/doc/institution_view.png differ diff --git a/doc/newinst.png b/doc/newinst.png index 833787d1..221ad036 100644 Binary files a/doc/newinst.png and b/doc/newinst.png differ