[kmymoney/5.0] doc: Update categories docbook (KMM)
Jack Ostroff
null at kde.org
Wed May 6 23:39:32 BST 2020
Git commit c8b799f590be9944b2372973730e3dd1aa2d7373 by Jack Ostroff.
Committed on 06/05/2020 at 22:39.
Pushed by ostroffjh into branch '5.0'.
Update categories docbook (KMM)
Summary:
Update Categories chapter of Handbook for 5.x
Merge branch '5.0' into docs
(Revision initially created including irrelevant commits. Hopefully it now just has the docbook updates.)
Test Plan: Ran CheckXML5 and meinproc5
Reviewers: kde-doc-english, #kmymoney, yurchor
Reviewed By: yurchor
Subscribers: yurchor, #kmymoney, kde-doc-english
Tags: #documentation
Differential Revision: https://phabricator.kde.org/D29428
M +81 -44 doc/details-categories.docbook
M +6 -0 doc/index.docbook
https://commits.kde.org/kmymoney/c8b799f590be9944b2372973730e3dd1aa2d7373
diff --git a/doc/details-categories.docbook b/doc/details-categories.docbook
index 8e38e0193..9612467e7 100644
--- a/doc/details-categories.docbook
+++ b/doc/details-categories.docbook
@@ -3,17 +3,18 @@
<chapterinfo>
<authorgroup>
<author>&Roger.Lum; &Roger.Lum.mail;</author>
+ <author>&Michael.Carpino; &Michael.Carpino.mail;</author>
</authorgroup>
- <date>2014-08-30</date>
- <releaseinfo>4.7.01</releaseinfo>
+ <date>2020-02-06</date>
+ <releaseinfo>5.0.8</releaseinfo>
</chapterinfo>
<title>Categories</title>
<para>
- The Categories screen provides a summary of all the existing categories under
- which transactions are filed. The categories are split into income and
- expense, and a balance is displayed for each category.
+ The Categories view provides a summary of all the existing categories in your
+ current database. The categories are split into income and expense, sorted
+ alphabetically, and shown along with the respective balance for each.
</para>
<para>
@@ -30,15 +31,21 @@
<title>Creating a category</title>
<para>
- To create a new category, either select <menuchoice><guimenu>Category</guimenu>
- <guimenuitem>New category</guimenuitem></menuchoice> in the menu, or in the Categories
- view, select a parent in the tree, right click and select the <guimenuitem>New
- Category</guimenuitem> option. Either way will open the Create new categories
- wizard. Enter the new category name, and select the currency if the default
- shown is not correct. In the Hierarchy tab, ensure the required parent
- account is selected. Finally, in the Tax tab, there is a check box to enable
- VAT support, and a check box to include this category in certain tax related
- reports.
+ There are 3 ways to create a new category: either select the
+ <menuchoice><guimenu>Category</guimenu><guimenuitem>New
+ category</guimenuitem></menuchoice> menu item; select a parent in the tree
+ in the Categories view, right-click and select the <guimenuitem>New
+ Category</guimenuitem> option, or directly type the name of the new category
+ when adding or editing a transaction in the Ledger. Doing any of these steps
+ will direct you to the <guilabel>Create new Category</guilabel> dialog. The
+ dialog contains three tabs: <guilabel>General</guilabel>,
+ <guilabel>Hiearachy</guilabel>, and <guilabel>Tax</guilabel>. The General tab
+ includes editable fields for the new category name, type, and currency (with
+ the default currency preselected,) as well as options for Last check number,
+ Notes, and a checkbox for Cost center assignment required. In the Hierarchy
+ tab, you are able to select the appropriate parent account for the category.
+ Finally, in the Tax tab, there are fields to enable and configure VAT support,
+ and a checkbox to include this category in tax related reports.
</para>
<para>
@@ -49,12 +56,6 @@
</imageobject>
</mediaobject>
</screenshot>
- </para>
-
-<para>
- Enter the category name any notes and click on <guibutton>OK</guibutton> to
- save the new category. To create a complete hierarchy of accounts, separate
- the names by colons (:) as in <emphasis>Bills:Car:Gasoline</emphasis>.
</para>
</sect1>
@@ -63,33 +64,34 @@
<para>
To edit a category, right-click on a category name, and choose
- <guimenuitem>Edit category</guimenuitem>. A window comes up with three tabs:
- General, Hierarchy and Tax.
+ <guimenuitem>Edit category</guimenuitem>. A window appears with the same
+ three tabs as the new category dialog: General, Hierarchy and Tax. Each tab
+ allows you to edit certain details of the category.
</para>
<para>
- The General tab allows you to edit the name of the category and any notes you
- entered when you created the category.
+ The General tab allows you to edit the name of the category, any notes you
+ entered when you created the category, the Last check number, and the state of
+ the Cost Center assignment required checkbox. The Type, Currency, and Price
+ entry cannot be changed from their initial values.
</para>
<para>
- The Hierarchy tab allows you to change the parent category.
-<!-- not ported to kde4 yet, uncomment if that is done,
- see https://bugs.kde.org/show_bug.cgi?id=272737
- You can also
- change the parent category from the main category page by dragging the
- category to a different parent.
--->
- You can change the parent category by clicking on another category in this
- view of the category hierarchy. In an earlier version of &kmymoney; it was possible to change the parent of
- a category by dragging and dropping. This functionality will return in a future version, but possibly not
- until the conversion of &kmymoney; to &kde; Frameworks.
+<!-- not ported to kde4 yet, much less Frameworks. Uncomment once that is done.
+ See https://bugs.kde.org/show_bug.cgi?id=272737
+ You can also change the parent category from the main category page by
+ dragging the category to a different parent. -->
+ The Hierarchy tab allows you to change the parent category by clicking on
+ another category in this view of the category hierarchy. In an earlier
+ version of &kmymoney; it was possible to change the parent of a category by
+ dragging and dropping. This functionality is expected to return in a future
+ version of the application.
</para>
<para>
- The Tax tab allows you to assign or change VAT category, or alter the
- automatic VAT assignment. It also allows you to toggle whether or not the
- category is included in certain tax related reports.
+ The Tax tab allows you to assign or change VAT details, or to alter the
+ automatic VAT assignment. It also allows the ability to toggle whether or not
+ the category is included in tax related reports.
</para>
</sect1>
@@ -117,7 +119,7 @@
Example: In Germany, there are three VAT percentages (0%, 7%, and 19%). So I
have a main category "VAT paid" and three subcategories, one for each
percentage rate. I create these on both the income and the expense sides so
- that I have eight categories in total. For the goods I buy, I select one of
+ that I have six categories in total. For the goods I buy, I select one of
the above mentioned categories as the "VAT category assignment".
</para>
@@ -141,11 +143,46 @@
<para>
To delete a category, select it in the tree, right click to bring up the popup
- menu, and select <guimenuitem>Delete</guimenuitem>. If there are any
- transactions assigned to this category, a popup will allow you to move these
- to another parent category. If you try to delete a parent category, a dialog
- allows the choice of either having the sub-categories moved up one level or
- alternatively having them all deleted at the same time.
+ menu, and select <guimenuitem>Delete</guimenuitem>. If the category has no
+ transactions, schedules, or budgets associated with it, it will be deleted.
+</para>
+
+<para>
+ If the category has any of those items, a popup will be displayed allowing you
+ to choose another category to which all those items can be reassigned before
+ the category is deleted.
+</para>
+
+<para>
+ If you delete a category which is the parent of any other categories, a dialog
+ will be displayed for you to choose whether to delete that category and all
+ its sub-categories or just the parent category. If you choose to just delete
+ the parent category, then all its sub-categories will be moved to its parent
+ category.
+</para>
+
+<para>
+ Note that deleting some categories may prompt both for where to reassign its
+ data and also whether or not to delete any sub-categories.
+</para>
+</sect1>
+
+<sect1 id="details.categories.open_ledger">
+<title>Open ledger for a category</title>
+
+<para>
+ By right-clicking on any category there is an option to open a ledger for that
+ category. You can also double-click on the category. When this option is
+ selected &kmymoney; will display a ledger with all the transactions for the
+ selected category. This allows you to quickly review all the transactions in
+ detail for the selected category. You can then right-click on any transaction
+ to obtain additional details about the specific transaction ultimately allowing
+ any editing that may be required. Note that you cannot edit a transaction in
+ the Category ledger; you need to switch to the ledger display for the other
+ account, using one of the selections in the popup menu when you right click on
+ the transaction.
+
</para>
</sect1>
</chapter>
+
diff --git a/doc/index.docbook b/doc/index.docbook
index 369c66d51..9a6094d68 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -39,6 +39,12 @@
<!ENTITY Christian.David "<personname><firstname>Christian</firstname><surname>Dávid</surname></personname>">
<!ENTITY Christian.David.mail "<email>christian-david at web.de</email>">
+ <!-- the following author entity was added to contributor.entities for the 5.0 release
+ it can be removed from this file once it is present in the kdelibs minimum version required by &kmymoney; -->
+
+ <!ENTITY Michael.Carpino "<personname><firstname>Michael</firstname><surname>Carpino</surname></personname>">
+ <!ENTITY Michael.Carpino.mail "<email>mfcarpino at gmail.com</email>">
+
<!-- the following entities have been added to user.entities in trunk and probably 4.7 branch of svn
they are only in the french branch, and are required for processing of the french documentation
they can be removed from this file once they are present in the kdelibs minimum version required by &kmymoney; -->
More information about the kde-doc-english
mailing list