SVN commit 1238898 by ostroffjh:
Update budgets chapter to reflect past UI changes.
M +148 -61 details-budgets.docbook
--- trunk/extragear/office/doc/kmymoney/details-budgets.docbook #1238897:1238898
@@ -3,9 +3,10 @@
&Colin.Wright; &Colin.Wright.mail;
+ &Jack.H.Ostroff; &Jack.H.Ostroff.mail;
- 2010-07-25
- 4.5
+ 2011-06-29
+ 4.6
Budgets
@@ -46,8 +47,10 @@
- &kappname; provides a number of reports which compare actual income and
- expenses against the entered Budgets.
+ &kappname; provides a number of reports which compare actual income
+ and expenses against the entered Budgets. These are described in
+ more detail in
+ another section.
@@ -59,14 +62,25 @@
pane at the left hand side of your &kappname; window.
+
+ There are two major sections to the budget window. These are
+ described in more detail below. On the left, the main section
+ displays the list of budgets you have created. Above that are
+ buttons for creating, renaming, and deleting budgets. On the right,
+ there are three sections. At the top is the Accounts List. At the
+ bottom is a display of the amounts assigned to the budget for the
+ category selected in the Accounts List above. Between those two
+ areas are some additional controls for managing the budget.
+
+
-Creating, changing, and deleting budgets
+Viewing, creating, renaming, and deleting budgets
- This section of the Budgets window displays the list of Budgets contained in
- the current file. If no Budget has yet been created the list will display a
- single empty Budget called "Budget <year>" where <year> is the
- current fiscal year. The list of Budgets has two columns:
+ This section of the Budgets window displays the list of Budgets
+ contained in the current &kappname; file. If no Budget has yet been
+ created the list will be empty. The list of Budgets has two
+ columns:
@@ -80,7 +94,10 @@
Year
- Fiscal year of the Budget
+ Fiscal year of the Budget. Note that the starting month
+ and day of the fiscal year can be specified in
+ the Configure
+ $kappname; dialog.
@@ -90,18 +107,22 @@
different Budget you can click on the Budget in the list. Alternatively, when
the list has focus, you can select a different Budget using the up and down
keys. If you have made changes to a Budget and then select a different budget
- &kappname; will ask you whether you want to discard the changes.
+ &kappname; will ask you whether you want to save or discard the changes.
- There are five buttons above the list of Budgets.
+ There are three buttons above the list of Budgets.
New
- Create a new budget
+
+ Create a new, empty budget. The default name of a new budget
+ is "Budget <year>" where <year> is the current
+ fiscal year.
+
@@ -110,9 +131,8 @@
Edit the name of the selected Budget.
- You can also edit the name of a Budget by clicking on the name of
- the selected Budget or double-clicking on the name of a different
- Budget.
+ You can also edit the name of a Budget by double-clicking
+ on the name of a Budget in the list.
@@ -123,6 +143,8 @@
+
@@ -148,7 +171,7 @@
New Budget
- Create a new, blank Budget.
+ Create a new, empty Budget.
@@ -162,8 +185,8 @@
Change budget year
- Displays a window with a list of years to select a different budget
- year.
+ Displays a window with a list of years to select a
+ different fiscal year for the budget.
@@ -182,6 +205,17 @@
Budget.
+
+
+ Budget based on forecast
+
+ Fills in budget amounts based on data from &kappname;'s
+ Forecast values. See the section on
+ Forecasts for
+ more information.
+
+
+
@@ -189,10 +223,12 @@
Account List
- The Account List displays the list of Income and Expense Categories. As in
- other places in &kappname; the list is organized in a tree structure. The list
- can be expanded or collapsed to show or hide Subcategories within a
- Category. The Account List has a number of columns:
+ The Account List displays the list of Income and Expense Categories.
+ (Remember, within &kappname;, categories are treated as a special
+ type of account.) As in other places in &kappname;, the list is
+ organized in a tree structure. The list can be expanded or collapsed
+ to show or hide Subcategories within a Category. The Account List
+ has a number of columns:
@@ -209,6 +245,8 @@
+
- Balance
+ Total BalanceCurrent balance of Account. Blank for Categories
- Value
+ Total ValueTotal yearly value in the Budget. If an Account has Subaccounts and
the Account's list of Subaccounts is collapsed the value displayed is
@@ -240,27 +279,47 @@
+
- The Account List can be filtered using "Hide unused Categories". In Budgets
- this hides any Categories for which no value has been assigned to the Category
- or any of its Subcategories.
+ Below the Account list are several controls. The Update and Revert
+ buttons are described further below. The collapse and expand
+ buttons collapse or expand the entire Account List.
+
+
+ The Account List can be filtered in two ways. Checking the "Hide
+ unused categories" checkbox hides any Categories for which no value
+ has been assigned to the Category or any of its Subcategories. To
+ the right of this, is an unlabelled text box. Only categories which
+ include whatever is typed in this box are listed, but their parent
+ categories are also listed.
+
+
+
+ Note that changing either the "Hide unused budget categories" or the
+ filter value is likley to change the list of Categories display.
+ You may need to re-expand the list to see all the Categories that
+ should be displayed with the current settings..
+
+
Assignments
- The Assignments area shows the value for the selected Account.
+ The Assignments area shows the values for the Category selected in
+ the Accounts List.
Account
- Displays the name of the selected Account. If the Account is a
- Subaccount, the full name of the selected Account is displayed in the
- Account:Subaccount format.
+ Displays the name of the selected Category. If the
+ Category is a Subcategory, its full name is displayed in the
+ Category:Subcategory format.
@@ -274,11 +333,27 @@
Include subaccounts
- In Reports show actual income or expenses in Subcategories belonging
- to the Category against the Category instead of the Subcategory.
+ If this is checked, then Reports show actual income or
+ expenses in Subcategories belonging to the Category against
+ the Category instead of the Subcategory.
- If a Subcategory has a value defined in the Budget the income and
- expenses are shown against the Subcategory.
+ If a Subcategory has a value defined in the Budget, then
+ the income and expenses are shown against the
+ Subcategory.
+
+ If the Account selected in the Accounts List has its
+ Subaccounts collapsed, although its Total Value will show the
+ sum of the Total Values for all its Subaccounts, the amounts
+ in the Assignments area may still show 0, unless this box has
+ been checked or an amount has explicitly been assigned to the
+ Category.
+
+ In general, for you will either check this box and assign
+ values to the Category and not to any of its Subcategories, or
+ not check the box, and assign values to the Subcategories but
+ not the Category. If any Subcategories have assigned amounts
+ when this box is checked, then those amounts are rolled up to
+ the Category.
@@ -331,7 +406,6 @@
-
@@ -339,15 +413,14 @@
For performance reasons, changes made to a Budget are not saved
- immediately. Instead, they first have to be stored using the Update button and
- then permanently saved using the &kappname; Save.
+ immediately. Instead, they must first be stored using the Update
+ button and then permanently saved using the &kappname; Save.
When a Budget's values are first modified, the Update and Revert buttons are
enabled. Multiple changes can be made to the Budget. Pressing Update will
- store the changes, disable the Update and Revert buttons and enable the
- &kappname; Save.
+ store the changes and disable the Update and Revert buttons.
@@ -374,49 +447,63 @@
&kappname; provides a number of reports to compare actual income and expenses
- against Budgets. These are listed in Reports under "Budgeting". There are two
- types of Reports:
+ against a Budget. These are listed in Reports under "Budgeting". There are two
+ types of Bidget Reports:
Budget only
- Reports displaying values from a Budget: Monthly Budget
- Displays the monthly values from a Budget. Yearly Budget Displays the
- monthly values from a Budget, with yearly total.
+ These reports display values from a Budget.
+
+
+ Monthly Budget
+ Displays the monthly values from a Budget.
+
+
+ Yearly Budget
+ Displays the monthly values from a Budget,
+ with yearly total.
+
+
- Compare Budget and Actual
- Reports comparing values from a Budget to actual income and expenses. In
- each budget report you can find the columns Budget, Actual and
- Difference. Each report differs in the period that is shown:
+ Budget vs. Actual
+ These reports compare values from a Budget to
+ actual income and expenses. In each budget report you can find
+ the columns Budget, Actual, and Difference. Each report differs
+ in the period that is shown.
- Budget vs. Actual This Year:
+ Budget vs. Actual This YearFrom the beginning of the year until today
- Budget vs. Actual This Year (YTM):
- From the beginning of the year until the last day of the previous month
+ Budget vs. Actual This Year (YTM)
+ From the beginning of the year until the last
+ day of the previous month
- Yearly Budgeted vs. Actual:
- From January 1st until December 31st
+ Monthly Budgeted vs. Actual
+ From the beginning of the year until the last
+ day of the current month
- Monthly Budgeted vs. Actual:
- From the beginning of the year until the last day of the current month
+ Yearly Budgeted vs. Actual
+ From January 1st until December 31st
- Yearly Budgeted vs. Actual (Graph):
- Same as the previous report but it shows the graph by default
+ Yearly Budgeted vs. Actual (Graph)
+ Same as the previous report but it shows the
+ graph by default
- These reports provide a base from which custom reports can be created by
- changing the date range and Budget, among other options.
+ These reports provide a base from which custom reports can
+ be created by changing the date range and Budget, among other
+ options.