r23339 - gnucash-docs/trunk - Add budget documentation
Geert Janssens
gjanssens at code.gnucash.org
Sat Oct 26 06:08:19 EDT 2013
Author: gjanssens
Date: 2013-10-26 06:08:19 -0400 (Sat, 26 Oct 2013)
New Revision: 23339
Trac: http://svn.gnucash.org/trac/changeset/23339
Modified:
gnucash-docs/trunk/guide/C/ch_budgets.xml
gnucash-docs/trunk/help/C/Help_ch_Customize.xml
gnucash-docs/trunk/help/C/Help_ch_GUIMenus.xml
Log:
Add budget documentation
GnuCash help:
* 9.3.2: Clarify that the 'default budget' option is for budget reports
* Add a section about budgets to Chapter 4.
* Added link to "book options" in case users don't know what that is
GnuCash guide:
* 15.3: Describe budgeted income statement and budgeted balance sheet
reports from a conceptual perspective. Note: This doesn't necessarily
document the way these reports work in GnuCash.
Author: Robert Ratliff <ratliff.bobby at gmail.com>
Modified: gnucash-docs/trunk/guide/C/ch_budgets.xml
===================================================================
--- gnucash-docs/trunk/guide/C/ch_budgets.xml 2013-10-26 09:28:22 UTC (rev 23338)
+++ gnucash-docs/trunk/guide/C/ch_budgets.xml 2013-10-26 10:08:19 UTC (rev 23339)
@@ -178,5 +178,26 @@
you have created multiple budgets, you can use the Budget Report
Options to select which budget to use in the report.
</para>
+ <para>Two other types of budget reports are commonly used in the
+ small business setting. They are the <emphasis>Budgeted Income
+ Statement</emphasis> and the <emphasis>Budgeted Balance
+ Sheet</emphasis>.</para>
+ <sect2>
+ <title>Budgeted Income Statement</title>
+ <para>The budgeted income statement is similar to the income
+ statement. Both show the revenues and expenses for a given period
+ as well as the profit, which is the difference revenue - expenses.
+ The income statement is based on historical data, but the
+ <emphasis>budgeted</emphasis> income statement is based on the
+ predictions made in the budget.</para>
+ </sect2>
+ <sect2>
+ <title>Budgeted Balance Sheet</title>
+ <para>The budgeted balance sheet is similar to the balance sheet.
+ Both show the assets, liabilities, and equity. The difference is
+ that the balance sheet is based on historical data, and the
+ <emphasis>budgeted</emphasis> balance sheet is based on the
+ predictions made in the budget.</para>
+ </sect2>
</sect1>
</chapter>
Modified: gnucash-docs/trunk/help/C/Help_ch_Customize.xml
===================================================================
--- gnucash-docs/trunk/help/C/Help_ch_Customize.xml 2013-10-26 09:28:22 UTC (rev 23338)
+++ gnucash-docs/trunk/help/C/Help_ch_Customize.xml 2013-10-26 10:08:19 UTC (rev 23339)
@@ -1305,7 +1305,7 @@
<title>Budgeting Book Options Tab</title>
<para>The <guilabel>Budgeting</guilabel> tab allows you to specify the
- budget to be used when none has otherwise been specified.</para>
+ budget to be used for reports when none has otherwise been specified.</para>
</sect2>
<sect2 id="business-book-options">
Modified: gnucash-docs/trunk/help/C/Help_ch_GUIMenus.xml
===================================================================
--- gnucash-docs/trunk/help/C/Help_ch_GUIMenus.xml 2013-10-26 09:28:22 UTC (rev 23338)
+++ gnucash-docs/trunk/help/C/Help_ch_GUIMenus.xml 2013-10-26 10:08:19 UTC (rev 23339)
@@ -703,6 +703,14 @@
</row>
<row>
+ <entry namest="c2">
+ <para><guimenuitem>Copy Budget</guimenuitem></para></entry>
+
+ <entry namest="c3">
+ <para>Copy a budget.</para></entry>
+ </row>
+
+ <row>
<entry><guimenuitem>New Account...</guimenuitem></entry>
<entry nameend="c3" namest="c2">
@@ -2643,6 +2651,15 @@
</row>
<row>
+ <entry namest="c2">
+ <para><guimenuitem>Copy Budget</guimenuitem></para></entry>
+
+ <entry namest="c3">
+ <para>Copy a budget.</para></entry>
+ </row>
+
+
+ <row>
<entry><para>
<menuchoice>
<shortcut>
@@ -3558,6 +3575,15 @@
<para>Opens an existing budget.</para></entry>
</row>
+ <row>
+ <entry namest="c2">
+ <para><guimenuitem>Copy Budget</guimenuitem></para></entry>
+
+ <entry namest="c3">
+ <para>Copy a budget.</para></entry>
+ </row>
+
+
<row>
<entry><para><guimenuitem>Reset Warnings...</guimenuitem></para></entry>
@@ -4292,6 +4318,343 @@
</sect1>
+<sect1>
+ <title>Budget Window</title>
+ <para><menuchoice><guimenu>Actions</guimenu><guisubmenu>Budget</guisubmenu>
+ <guimenuitem>Open Budget</guimenuitem></menuchoice> will open the
+ default budget or offer you a choice if there is more than one budget.
+ A new tab will open with the budget displayed.</para>
+
+ <sect2 id="budget-menus">
+ <title>Budget Window Menus</title>
+ <para>Here are some menu items that are particularly useful to working with budgets.</para>
+ <sect3 id="budget-menus-edit">
+ <title>Budget Window - Edit menu</title>
+ <table frame="topbot" id="budget-menus-edit-items">
+ <title><guimenu>Edit</guimenu> Menu - Special items for the budget window.</title>
+
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry><para>Menu Item</para></entry>
+
+ <entry><para>Description</para></entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry><para><guimenuitem>Estimate Budget</guimenuitem></para></entry>
+
+ <entry><para>Estimate a budget value for the selected
+ accounts from past transactions.</para></entry>
+ </row>
+
+ <row>
+ <entry><para><guimenuitem>Delete Budget</guimenuitem></para></entry>
+
+ <entry><para>Delete this budget.</para></entry>
+ </row>
+
+ <row>
+ <entry><para><guimenuitem>Budget Options</guimenuitem></para></entry>
+
+ <entry><para>Edit this budget's options.</para></entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </sect3>
+ <sect3 id="budget-menus-actions">
+ <title>Budget Window - Actions menu</title><para></para>
+ <table frame="topbot" id="budget-menus-actions-items">
+ <title><guimenu>Actions</guimenu> Menu - Items in the standard menu that relate to budgets.</title>
+ <tgroup align="left" cols="3">
+ <colspec colname="c1" ></colspec>
+ <colspec colname="c2" ></colspec>
+ <colspec colname="c3" ></colspec>
+
+ <thead>
+ <row>
+ <entry><para>Menu Item</para></entry>
+
+ <entry align="center" nameend="c3"
+ namest="c2">Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry><para><menuchoice><guisubmenu>Budget</guisubmenu><guimenuitem/></menuchoice></para></entry>
+
+ <entry align="center" nameend="c3" namest="c2">
+ <para>Opens the Budget sub-menu to select budget actions.</para></entry>
+ </row>
+
+
+ <row>
+ <entry namest="c2">
+ <para><guimenuitem>New Budget</guimenuitem></para></entry>
+
+ <entry namest="c3">
+ <para>Create a new budget and open it in a new tab.</para>
+ </entry>
+ </row>
+ <row>
+ <entry namest="c2">
+ <para><guimenuitem>Open Budget</guimenuitem></para></entry>
+
+ <entry namest="c3">
+ <para>If no budget exists, create a new budget and open it.
+ If only one budget exists, open it; otherwise user selects one to open.</para>
+ </entry>
+ </row>
+ <row>
+ <entry namest="c2">
+ <para><guimenuitem>Copy Budget</guimenuitem></para></entry>
+
+ <entry namest="c3">
+ <para>If no budgets exist yet, just open a new budget.
+ If only one budget exists, create a copy of it; otherwise user selects one to copy.
+ If a copy is made, then the copy is opened in a new tab.</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+ </sect3>
+ <sect3 id="budget-menus-reports">
+ <title>Budget Window - Reports menu</title>
+ <note><title>Using more than one budget</title>
+ <para>
+ When there is more than one budget, the reports will use the
+ budget selected in book options by default. See
+ <xref linkend="book-options"></xref> and
+ <xref linkend="budgeting-book-options"></xref> for more details.
+ After the report is displayed, the budget it uses can be changed
+ in the report options <guilabel>General</guilabel> tab.</para>
+ </note>
+ <table frame="topbot" id="budget-menus-reports-items">
+ <title><guimenu>Reports</guimenu> Menu - Items in the standard menu that relate to budgets.</title>
+
+ <tgroup align="left" cols="3">
+ <colspec colname="c1" ></colspec>
+ <colspec colname="c2" ></colspec>
+ <colspec colname="c3" ></colspec>
+
+ <thead>
+ <row>
+ <entry><para>Menu Item</para></entry>
+
+ <entry align="center" nameend="c3"
+ namest="c2">Description</entry>
+ </row>
+ </thead>
+
+ <tbody>
+ <row>
+ <entry><para><menuchoice><guisubmenu>Budget</guisubmenu><guimenuitem/></menuchoice></para></entry>
+
+ <entry align="center" nameend="c3" namest="c2">
+ <para>Opens the Budget sub-menu to select a budget report.</para></entry>
+ </row>
+
+
+ <row>
+ <entry namest="c2">
+ <para><guimenuitem>Budget Balance Sheet</guimenuitem></para></entry>
+
+ <entry namest="c3">
+ <para></para>
+ </entry>
+ </row>
+ <row>
+ <entry namest="c2">
+ <para><guimenuitem>Budget Barchart</guimenuitem></para></entry>
+
+ <entry namest="c3">
+ <para></para>
+ </entry>
+ </row>
+ <row>
+ <entry namest="c2">
+ <para><guimenuitem>Budget Flow</guimenuitem></para></entry>
+
+ <entry namest="c3">
+ <para>This report includes information from one budget period at a time.
+ The left column of numbers shows the budgeted amounts, and the right column
+ of numbers shows the actual amounts. It only shows certain accounts, those that
+ have no sub-accounts.</para>
+ </entry>
+ </row>
+ <row>
+ <entry namest="c2">
+ <para><guimenuitem>Budget Income Statement</guimenuitem></para></entry>
+
+ <entry namest="c3">
+ <para></para>
+ </entry>
+ </row>
+ <row>
+ <entry namest="c2">
+ <para><guimenuitem>Budget Profit & Loss</guimenuitem></para></entry>
+
+ <entry namest="c3">
+ <para>This report is identical to the Budget Income Statement report.</para>
+ </entry>
+ </row>
+ <row>
+ <entry namest="c2">
+ <para><guimenuitem>Budget Report</guimenuitem></para></entry>
+
+ <entry namest="c3">
+ <para>The budget report shows all accounts and all periods. For each period
+ it gives the budgeted amount and the actual amount. There is an option to add
+ another column showing the difference (budgeted - actual).</para>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+
+
+ </sect3>
+
+ </sect2>
+ <sect2 id="tools-budget-toolbar">
+ <title>Budget Window Toolbar Buttons</title>
+
+ <para>The <guilabel>Budget</guilabel> window has a
+ <emphasis>Toolbar</emphasis> to quickly access
+ common functions used with budgeting.</para>
+
+ <table frame="topbot">
+ <title><guilabel>Budget</guilabel> Window <emphasis>Toolbar</emphasis></title>
+
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry><para><emphasis>Toolbar</emphasis> Button</para></entry>
+
+ <entry><para>Description</para></entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry><para>
+ <menuchoice>
+ <shortcut>
+ <keycombo><keycap>Ctrl</keycap><keycap>S</keycap></keycombo>
+ </shortcut>
+ <guimenuitem>Save</guimenuitem>
+ </menuchoice>
+ </para></entry>
+
+ <entry><para>Save the current budget.</para></entry>
+ </row>
+
+ <row>
+ <entry><para>
+ <menuchoice>
+ <shortcut>
+ <keycombo><keycap>Ctrl</keycap><keycap>W</keycap></keycombo>
+ </shortcut>
+ <guimenuitem>Close</guimenuitem>
+ </menuchoice>
+ </para></entry>
+
+ <entry><para>Close the <guilabel>Budget</guilabel> window.</para></entry>
+ </row>
+
+ <row>
+ <entry><para><guibutton>Options</guibutton></para></entry>
+
+ <entry><para>Edit this budget's options.</para></entry>
+ </row>
+
+ <row>
+ <entry><para><guibutton>Estimate</guibutton></para></entry>
+
+ <entry><para>Estimate a budget value for the selected
+ accounts from past transactions.</para></entry>
+ </row>
+
+ <row>
+ <entry><para><guibutton>Delete</guibutton></para></entry>
+
+ <entry><para>Delete this budget.</para></entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+
+ </sect2>
+ <sect2 id="budget-widget">
+ <title>Budget Window Main Display</title>
+ <para>The budget window contains a list of accounts down the left
+ hand side, and a set of columns down the right hand side that
+ represent budget values. Each column corresponds to a budget
+ <emphasis>period</emphasis>.
+ The number of periods for a budget can be changed using the
+ <guilabel>Budget Options</guilabel> dialog.</para>
+
+ <procedure><title>Entering a budget value</title>
+ <step><para><emphasis>Click</emphasis> the row corresponding to the
+ account you wish to budget</para></step>
+ <step><para>Choose the period this value is for, and <emphasis>click</emphasis>
+ in the cell corresponding to that period</para></step>
+ <step><para>Type the value in the cell</para></step>
+ <step><para>Press <keycombo><keycap>Enter</keycap></keycombo> to
+ finish editing the value.</para></step>
+ </procedure>
+
+ </sect2>
+ <sect2 id="budget-options">
+ <title>Budget Options</title>
+
+ <table frame="topbot">
+ <title>Budget options</title>
+
+ <tgroup cols="2">
+ <thead>
+ <row>
+ <entry><para>Option</para></entry>
+
+ <entry><para>Description</para></entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry><para>Budget Name</para></entry>
+ <entry><para>The budget name is used in the tab's name
+ and also in any reports you create with the budget.</para></entry>
+ </row>
+ <row>
+ <entry><para>Notes</para></entry>
+ <entry><para>A description of the budget.</para></entry>
+ </row>
+ <row>
+ <entry><para>Budget Period</para></entry>
+ <entry><para>The budget period includes when the budget
+ starts (start date) and how long each budget period lasts.</para></entry>
+ </row>
+ <row>
+ <entry><para>Number of Periods</para></entry>
+ <entry><para>The number of periods in the budget.</para></entry>
+ </row>
+
+ </tbody>
+ </tgroup>
+ </table>
+ </sect2>
+ </sect1>
+
</chapter>
More information about the gnucash-changes
mailing list