diff --git a/doc/details-categories.docbook b/doc/details-categories.docbook --- a/doc/details-categories.docbook +++ b/doc/details-categories.docbook @@ -3,17 +3,18 @@ &Roger.Lum; &Roger.Lum.mail; + &Michael.Carpino; &Michael.Carpino.mail; - 2014-08-30 - 4.7.01 + 2020-02-06 + 5.0.8 Categories - 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. @@ -30,15 +31,21 @@ Creating a category - To create a new category, either select Category - New category in the menu, or in the Categories - view, select a parent in the tree, right click and select the New - Category 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 + CategoryNew + category menu item; select a parent in the tree + in the Categories view, right-click and select the New + Category 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 Create new Category dialog. The + dialog contains three tabs: General, + Hiearachy, and Tax. 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. @@ -49,47 +56,42 @@ - - - - Enter the category name any notes and click on OK to - save the new category. To create a complete hierarchy of accounts, separate - the names by colons (:) as in Bills:Car:Gasoline. Editing a Category To edit a category, right-click on a category name, and choose - Edit category. A window comes up with three tabs: - General, Hierarchy and Tax. + Edit category. 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. - 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. - The Hierarchy tab allows you to change the parent category. - - 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. + + 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. - 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. @@ -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". @@ -141,11 +143,46 @@ To delete a category, select it in the tree, right click to bring up the popup - menu, and select Delete. 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 Delete. If the category has no + transactions, schedules, or budgets associated with it, it will be deleted. + + + + 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. + + + + 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. + + + + Note that deleting some categories may prompt both for where to reassign its + data and also whether or not to delete any sub-categories. + + + + +Open ledger for a category + + + 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. + + diff --git a/doc/index.docbook b/doc/index.docbook --- a/doc/index.docbook +++ b/doc/index.docbook @@ -39,6 +39,12 @@ ChristianDávid"> christian-david@web.de"> + + + MichaelCarpino"> + mfcarpino@gmail.com"> +