Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

728910: Added more documentation for Budget Balance Sheet #327

Open
wants to merge 12 commits into
base: stable
Choose a base branch
from
Open

728910: Added more documentation for Budget Balance Sheet #327

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
3648454
728910: Added more documentation for Budget Balance Sheet
Aug 31, 2023
4c21d04
Revert "728910: Added more documentation for Budget Balance Sheet"
Sep 1, 2023
c92d073
728910: Moved Budgeted Balance Sheet technical details to the manual
Sep 1, 2023
b02c254
728910: Better formatting
Sep 1, 2023
e645b23
728910: switched to use glosslist, more formatting
Sep 1, 2023
81c8a76
728910: added link from guide to manual for Budget Balance Sheet
Sep 1, 2023
3036732
728910: clarified Unallocated Assets
Sep 1, 2023
6c44090
728910: fixed xml typo
Sep 1, 2023
af02c26
728910: better formatting of equations, cleared up 'existing equity' …
Sep 1, 2023
3d1c049
728910: turned - into − and dash into ‐
Sep 1, 2023
e3a3c3f
Revert "728910: turned - into − and dash into ‐"
Sep 5, 2023
e566836
728910: turned some minuses into &minus, others into colons
Sep 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 88 additions & 3 deletions C/guide/ch_budgets.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,10 +204,95 @@
<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>The Budgeted Balance Sheet is similar to the Balance Sheet (see <xref linkend="rpt_balancesheet"/>). 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. The report
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As we are formalizing the docs —see Text conventions— can you mark the first part as abstract and the description as glosslist?

<abstract><para>The <guilabel>Budgeted Balance Sheet</guilabel> is […] 
predictions made in the budget.</para></abstract>
<para>The report  contains the following elements:
  <glosslist>
  <title>Elements of Budgeted Balance Sheet</title>
  <glossentry>
    <glossterm>>Assets Section</glossterm>
      <glossdef>
        <para>The value shown for each account […]
        </para>
      </glossdef>
    </glossentry>
    …
  <glosslist>

See de/manual/ch_Tools_Assistants.xml for advanced usage of glosslists.

contains the following elements:

<itemizedlist>
<listitem>
<para><emphasis>Assets Section</emphasis> - The value shown for each account is its balance as of the start date of the selected budget, modified by the projected changes in this budget. So if all goes according to the budget, these balances would be the same as if you were to run a standard Balance Sheet as of the end date of the budget period.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After you finished your edts can you please run xmlformat over the file?
BTW runoff style (2 spaces after a full stop) is obsolete, but get also fixed by xmlformat.


<itemizedlist>
<listitem>
<para><emphasis>Existing Assets</emphasis> - the sum of all budgeted asset accounts as of the start date of the budget. This is equivalent to the Total Assets on the Balance Sheet when run for that start date.</para>
</listitem>
<listitem>
<para><emphasis>Allocated assets</emphasis> - the sum of all Asset row totals projected in the budget.</para>
</listitem>
<listitem>

<para><emphasis>Unallocated Assetss</emphasis> - This formula is:
<screen>
New Retained Earnings (all projected expenses subtracted from all projected income, per this budget)
- Allocated Assets (above)
- New Liabilities</screen>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screens are processed as verbatim. You don't want the indentation. Start in column 1.

BTW did you consider to use equation here and later?

</para>
</listitem>
</itemizedlist>

</para>
</listitem>

<listitem>
<para><emphasis>Liabilities Section</emphasis> - The value shown for each account is its balance as of the start date of the selected budget, modified by the projected changes in this budget. So if all goes according to the budget, these balances would be the same as if you were to run a standard Balance Sheet as of the end date of the budget period.

<itemizedlist>
<listitem>
<para><emphasis>Existing Liabilities</emphasis> - the sum of all budgeted liability accounts as of the start date of the budget. This is equivalent to the Total Liabilities on the Balance Sheet when run for that start date.</para>
</listitem>
<listitem>
<para><emphasis>New Liabilities</emphasis> - the sum of all Liability row totals projected in the budget.</para>
</listitem>
<listitem>
<para><emphasis>Total Liabilities</emphasis> - the Existing Liabilities plus the projected ones (both explained above).</para>
</listitem>
</itemizedlist>

</para>
</listitem>


<listitem>
<para><emphasis>Equity Section</emphasis> - The value shown for each account is its balance as of the start date of the selected budget, modified by the projected changes in this budget. So if all goes according to the budget, these balances would be the same as if you were to run a standard Balance Sheet as of the end date of the budget period.


<itemizedlist>
<listitem>
<para><emphasis>Existing Retained Earnings</emphasis> - Retained Earnings as of the start date of the given budget. This is equivalent to the Retained Earnings on the Balance Sheet when run for that start date.</para>
</listitem>
<listitem>
<para><emphasis>New Retained Earnings</emphasis> - The sum of budgeted Incomes minus the sum of budgeted Expenses. The profit predicted by this budget.</para>
</listitem>
<listitem>
<para><emphasis>Unrealized Losses</emphasis> - The total difference in value between all asset/liability accounts and their basis. This is equivalent to the same total in the Balance Sheet as of the start date of the budget.</para>
</listitem>
<listitem>
<para><emphasis>Existing Equity</emphasis> - The Total Equity from the Balance Sheet on the start date of the budget. The formula is:<screen>
The balance of the Equity accounts (matches that of the Balance Sheet for the start date of the budget)
+ Existing Retained Earnings
+ Unrealized Gain/Losses
</screen>
</para>
</listitem>
<listitem>
<para><emphasis>New Equity</emphasis> - The sum of projected amounts for equity accounts in the budget + New Retained Earnings</para>
</listitem>
<listitem>
<para><emphasis>Total Equity</emphasis> - Existing Equity + New Equity</para>
</listitem>
</itemizedlist>

</para>
</listitem>

<listitem>
<para><emphasis>Total Liabilities + Equity</emphasis> - Liabilities + Equity. Equals Total Assets
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps use <equation> also here?

</para></listitem>

</itemizedlist>
</para>

</sect2>
</sect1>
</chapter>