Last bigpatch.
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@2026 57a11ea4-9604-0410-9ed3-97b8803252fd
@ -82,7 +82,8 @@
|
||||
</li>
|
||||
|
||||
<li><b> <a href="xacc-reports.html">Reports</a>.</b> Display
|
||||
or output as HTML Balance or Profit/Loss reports.</li>
|
||||
or output as HTML Balance, Transaction, andProfit/Loss reports,
|
||||
as well as graphical account balance tracking (requires gnuplot).</li>
|
||||
</ul>
|
||||
|
||||
<h2>Advanced Features</h2>
|
||||
|
30
Docs/En/xacc-accountedit.html
Normal file
@ -0,0 +1,30 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>Editing Account Parameters</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Editing Account Parameters</h1>
|
||||
|
||||
<p>The "Edit Account" dialog box lets you change the properties of
|
||||
an account. You can access this via the "edit" button of the main
|
||||
window toolbar, the "Accounts" menu, or via the keyboard
|
||||
shortcuts. For a description of the uses of the various
|
||||
properties, see the information about <a
|
||||
href="xacc-accwin.html">new accounts</a>.</p>
|
||||
|
||||
<p><b>Account information</b> can be changed by typing in the appropriate
|
||||
field. The account type cannot be changed.</p>
|
||||
<p>A new <b>Parent Account</b> can be selected. Only those accounts that
|
||||
can legally become the parent of the present account are shown.</p>
|
||||
<p>The source for <b>Stock Quotes</b> can be selected. <EM>FIXME:
|
||||
could somebody who uses this feature please document it?</EM>></p>
|
||||
<p><b>Notes</b> about the account can be edited.</p>
|
||||
|
||||
|
||||
<hr><p> Return to <a href="xacc-main.html"> Main Documentation
|
||||
Page.</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
17
Docs/En/xacc-bal_tracker.html
Normal file
@ -0,0 +1,17 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
|
||||
<html>
|
||||
<head>
|
||||
<link rel="stylesheet" title="normal" type="text/css" href=
|
||||
"gnucash.css">
|
||||
<title>Balance Tracking Report</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Balance Tracking Report</h1>
|
||||
<p><em>FIXME: Document this report!</em>
|
||||
<hr>
|
||||
<p> Return to <a href="xacc-main.html"> Main Documentation
|
||||
Page.</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
21
Docs/En/xacc-balsheet.html
Normal file
@ -0,0 +1,21 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
|
||||
<html>
|
||||
<head>
|
||||
<link rel="stylesheet" title="normal" type="text/css" href=
|
||||
"gnucash.css">
|
||||
|
||||
<title>Balance Sheet</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Balance Sheet</h1>
|
||||
|
||||
<p>This report summarizes your assets, liabilities, and equity.</p>
|
||||
|
||||
<p>There are currently no options for this report, but the option
|
||||
to specify a date for which the balance sheet is to be calculated
|
||||
will be added soon.</p>
|
||||
|
||||
<p> Return to <a href="xacc-main.html"> Main Documentation
|
||||
Page.</a></p>
|
||||
</body>
|
||||
</html>
|
42
Docs/En/xacc-globalprefs.html
Normal file
@ -0,0 +1,42 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
|
||||
<html>
|
||||
<head>
|
||||
<link rel="stylesheet" title="normal" type="text/css" href=
|
||||
"gnucash.css">
|
||||
<title>Preferences</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Preferences</h1>
|
||||
<p>You can customize the behaviour of
|
||||
GnuCash by changing the settings in this dialog box.All settings
|
||||
are automatically saved so changes are preserved for future
|
||||
sessions.</p>
|
||||
|
||||
<p>To change settings, simply click to select the appropriate
|
||||
page, then make appropriate changes, and click the "Apply"
|
||||
button to see
|
||||
your changes take effect. Clicking "OK" applies changes, then
|
||||
closes the properties dialog box.
|
||||
them. The "Close" button simply closes the dialog box without
|
||||
applying the latest changes.</p>
|
||||
|
||||
<p>The settings are grouped into the following categories:</p>
|
||||
<ul><li><b>Account Fields:</b> sets which fields are displayed in
|
||||
the account list of the main window.</li>
|
||||
<li><b>Account Types:</b> sets which account types are displayed
|
||||
in the main window.</li>
|
||||
<li><b>General:</b> anything that doesn't fit anywhere
|
||||
else.</li>
|
||||
<li><b>International:</b> Options relating to date and time
|
||||
display formats.</li>
|
||||
<li><b>Register:</b> Options relating to the default appearance
|
||||
of account registers.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<hr><p> Return to <a href="xacc-main.html"> Main Documentation
|
||||
Page.</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
42
Docs/En/xacc-globalprops.html
Normal file
@ -0,0 +1,42 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
|
||||
<html>
|
||||
<head>
|
||||
<link rel="stylesheet" title="normal" type="text/css" href=
|
||||
"gnucash.css">
|
||||
<title>Preferences</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Preferences</h1>
|
||||
<p>You can customize the behaviour of
|
||||
GnuCash by changing the settings in this dialog box.All settings
|
||||
are automatically saved so changes are preserved for future
|
||||
sessions.</p>
|
||||
|
||||
<p>To change settings, simply click to select the appropriate
|
||||
page, then make appropriate changes, and click the "Apply"
|
||||
button to see
|
||||
your changes take effect. Clicking "OK" applies changes, then
|
||||
closes the properties dialog box.
|
||||
them. The "Close" button simply closes the dialog box without
|
||||
applying the latest changes.</p>
|
||||
|
||||
<p>The settings are grouped into the following categories:</p>
|
||||
<ul><li><b>Account Fields:</b> sets which fields are displayed in
|
||||
the account list of the main window.</li>
|
||||
<li><b>Account Types:</b> sets which account types are displayed
|
||||
in the main window.</li>
|
||||
<li><b>General:</b> anything that doesn't fit anywhere
|
||||
else.</li>
|
||||
<li><b>International:</b> Options relating to date and time
|
||||
display formats.</li>
|
||||
<li><b>Register:</b> Options relating to the default appearance
|
||||
of account registers.</li>
|
||||
</ul>
|
||||
|
||||
|
||||
<hr><p> Return to <a href="xacc-main.html"> Main Documentation
|
||||
Page.</a></p>
|
||||
|
||||
</body>
|
||||
</html>
|
@ -59,6 +59,8 @@
|
||||
|
||||
<li><a href="xacc-expense.html">Using Income/Expense
|
||||
Accounts</a></li>
|
||||
<li><a href="xacc-globalprefs.html">Customizing Gnucash's Appearance</a></li>
|
||||
<li><a href="xacc-accountedit.html">Changing Account Properties</a></li>
|
||||
</ul>
|
||||
|
||||
<h1> Extended Help/System Documentation</h1>
|
||||
|
@ -15,9 +15,11 @@
|
||||
accounts from here.</p>
|
||||
|
||||
<p> Below is a picture of the main window, with only the main
|
||||
accounts shown. Note how <b>ABC Bank</b> has been selected by
|
||||
highlighting. To show the detail accounts, click on the arrows
|
||||
on the left.</p>
|
||||
accounts shown. Note how <b>Business Expenses</b> has been selected by
|
||||
highlighting. The box with a cross in it,
|
||||
immediately to its left, shows that it has one
|
||||
or more detail accounts that are not shown at present.
|
||||
To show them, click on this box.</p>
|
||||
|
||||
<p> <img src="contract.gif"><br>
|
||||
</p>
|
||||
@ -32,7 +34,7 @@
|
||||
|
||||
<p> The <tt>Open Subaccounts</tt> menu item is interesting only
|
||||
if you choose an account with sub-accounts (detail accounts).
|
||||
Accounts with sub-accounts will always have arrows on thier
|
||||
Accounts with sub-accounts will always have a box on thier
|
||||
left. By choosing the <tt>Open Subaccounts</tt> menu item, a
|
||||
general ledger window is opened, which displays all
|
||||
transactions for the lead and the detail accounts. Note that
|
||||
|
20
Docs/En/xacc-pnl.html
Normal file
@ -0,0 +1,20 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
|
||||
<html>
|
||||
<head>
|
||||
<link rel="stylesheet" title="normal" type="text/css" href=
|
||||
"gnucash.css">
|
||||
|
||||
<title>Profit And Loss Statement</title>
|
||||
</head>
|
||||
<body>
|
||||
<h1>Profit and Loss Statement</h1>
|
||||
|
||||
<p>This report summarizes your sources of income and expenditure.</p>
|
||||
|
||||
<p>There are currently no options for this report, but the option
|
||||
to specify an accounting period will be added soon.</p>
|
||||
|
||||
<p> Return to <a href="xacc-main.html"> Main Documentation
|
||||
Page.</a></p>
|
||||
</body>
|
||||
</html>
|
@ -14,7 +14,7 @@
|
||||
<p> At present, GnuCash does not support any sort of printer
|
||||
output. However, you may create a printout of the register
|
||||
window contents by opening a register window and selecting <tt>
|
||||
Print... To File</tt> from the <tt>File</tt> menu.</p>
|
||||
Print... To File</tt> from the <tt>File</tt> menu. <a href="xacc-reports.html">Reports</a> can also be <a href="xacc-reports.html">exported as HTML</a>.
|
||||
|
||||
<h1> GnuCash as Web Server</h1>
|
||||
|
||||
|
@ -12,7 +12,7 @@
|
||||
<h1>Reconciliation Window</h1>
|
||||
|
||||
<p> The Reconciliation window is used to reconcile cleared
|
||||
transactins from a bank statement. Enter a dollar amount from
|
||||
transactions from a bank statement. Enter a dollar amount from
|
||||
your last bank statement in the box, and then click <tt>
|
||||
OK</tt> . The window will then show all unreconciled
|
||||
transactions since your last bank statment. The reconcile
|
||||
|
@ -10,23 +10,68 @@
|
||||
|
||||
<body>
|
||||
<h1>Register Window</h1>
|
||||
<img src="regwin-single.gif">
|
||||
<p> This is the "Register" or the "Ledger" window. Transactions are entered here.</p>
|
||||
<p>To enter a new transaction, just type into the last blank transaction.
|
||||
Use the mouse or the <a href="xacc-regwin_kbd.html">Register Keyboard Shortcuts</a>to move between fields, and hit the Enter key or click record to
|
||||
record the transaction:</p>
|
||||
<img src="regwin-single2.gif">
|
||||
<p> Notice how a the transaction has been recorded and a new, blank
|
||||
transaction has been created.</p>
|
||||
<p>You can edit existing transactions in a similar manner. GnuCash
|
||||
will prompt you to confirm any changes you make.</p>
|
||||
|
||||
<p> This is the "Register" or the "Ledger" window.</p>
|
||||
<h1>Manipulating transactions</h1>
|
||||
<p>You can manipulate transactions with the toolbar or the "Transaction"
|
||||
menu:
|
||||
<ul><li><b>Delete:</b> you can delete a transaction or an individual
|
||||
split.</li>
|
||||
<li><b>Cancel:</b> this reverts any changes you have made to the
|
||||
transaction you are currently entering/changing</li>
|
||||
<li><b>New:</b> this moves the cursor to the last line of the
|
||||
register where new transactions are entered</li>
|
||||
<li><b>Jump:</b> When placed over an existing transaction, it takes
|
||||
you to the corresponding register entry in the other register entry
|
||||
that this
|
||||
transaction appears in</li>
|
||||
<li><b>Transfer:</b>This is an alternative way to enter a transaction.
|
||||
You can do a transfer between any two accounts without opening
|
||||
up other registers.</li>
|
||||
<li><b>Close:</b>Closes this register</li></ul>
|
||||
|
||||
<p> Transactions are entered here.</p>
|
||||
<h1>Viewing Transactions</h1>
|
||||
|
||||
<p>The register can show transactions in a variety of different
|
||||
ways, controlled by entries on the "Register" menu.</p>
|
||||
<p>The register can display transactions in several different
|
||||
styles:</p>
|
||||
<ul><li><b>single-line mode:</b> transactions are displayed on a single line.</li>
|
||||
<li><b>double-line mode:</b> transactions are displayed over two lines,
|
||||
with more information about each transaction shown.</li>
|
||||
<li><b>multi-line mode:</b> transactions are displayed over multiple
|
||||
lines, allowing the display of multiple entries. This allows you
|
||||
to enter multi-split transactions (for instance, when you pay multiple bills with one check).</li>
|
||||
<li><b>auto-single and auto-double modes</b> are like single and
|
||||
double-line modes, except that the currently-edited transaction
|
||||
is displayed in multi-line form. This is a very convenient way
|
||||
of entering multi-account transactions.</li></ul>
|
||||
|
||||
<p> <em> Note: This documentation page needs to be "beefed
|
||||
up."</em></p>
|
||||
|
||||
<p> This is what the register window should look like:</p>
|
||||
<br>
|
||||
<img src="regwin-single.gif"> <br>
|
||||
<img src="regwin-double.gif"> <br>
|
||||
<img src="regwin-multi.gif">
|
||||
<hr>
|
||||
<p>To change the display style, to go the "Register" menu and select
|
||||
"style".</p>
|
||||
|
||||
<p>Existing transactions are normally displayed in date order, but
|
||||
this can also be changed with "Sort Order".
|
||||
You can also select a date rate from which transactions will be
|
||||
displayed with "Date Range".</p>
|
||||
<h1>Reconciliation</h1>
|
||||
|
||||
<p>Transactions are typically checked against bank statements - a
|
||||
process known as "reconciliation". GnuCash keeps track of
|
||||
the reconciliation status of each transaction.</p>
|
||||
<p>The reconciliation status of a transaction is shown by the
|
||||
reconciliation (R) field. 'c' indicates that a transaction
|
||||
has been reconciled, 'n' indicates that it has not. You can
|
||||
change the reconciliation status by clicking on a the 'r' field
|
||||
of the transaction.</p>
|
||||
<p> At the bottom of the account window, there are two running
|
||||
balances, the "cleared and reconciled" balance, and the "total"
|
||||
balance... the "cleared and reconciled" balance should
|
||||
@ -37,18 +82,7 @@
|
||||
<p> Reconciliation can be done in the <a href=
|
||||
"xacc-recnwin.html">Reconcile Window</a></p>
|
||||
|
||||
<p>(Not yet implemented) Transactions marked with <tt> y</tt>
|
||||
can not be edited without first changing this flag. This is
|
||||
because a reconciled transaction should be thought of as
|
||||
something that has been checked over, and therefore correct.
|
||||
Changing such a transaction should be difficult: we want to
|
||||
avoid accidental errors.</p>
|
||||
|
||||
<p>(Not yet implemented) Transactions marked with <tt>f</tt>
|
||||
are frozen, and cannot be edited under any circumstances. These
|
||||
have been "frozen" into an accounting period. That is, the
|
||||
books have been closed for this period; they may no longer be
|
||||
modified.</p>
|
||||
|
||||
|
||||
<h1>Stock Portfolios</h1>
|
||||
|
||||
|
@ -11,43 +11,57 @@
|
||||
<body>
|
||||
<h1>Reports</h1>
|
||||
|
||||
<p> There are presently two types of reports: a <b>Balance
|
||||
Sheet</b> and a <b>Profit and Loss Statement</b>.</p>
|
||||
<p>A variety of financial reports can be selected on the "Extensions"
|
||||
menu":
|
||||
<ul><li><a href="xacc-balsheet.html">Balance Sheet:</a>shows Assets,
|
||||
Liabilities and Equity.</li>
|
||||
<li><a href="xacc-pnl.html">Profit And Loss State:</a>shows Income
|
||||
and expenses over a selectable period <em>well, it will when
|
||||
I get around to adding period support</em>
|
||||
<li><a href="xacc-trans_report.html">Transaction Report</a>shows
|
||||
transactions in an account, presented in a variety of ways.</li>
|
||||
<li><a href="xacc-bal_tracker.html">Balance Tracker</a> tracks
|
||||
the balance of one or more accounts over time, and supports
|
||||
graphical output (if you have gnuplot installed).</li></ul>
|
||||
|
||||
<p> A Balance Sheet shows Assets, Liabilities and Equity. The
|
||||
sum of all Assets equals the sum of Liabilities and Equity.</p>
|
||||
<h1>The Report Window</h1>
|
||||
Once you select a report, a report window will appear:
|
||||
<p><img src="reportwin.gif"></p>
|
||||
<p>The report is displayed in a resizable, scrollable window. To
|
||||
control the report, you can use the toolbar buttons at the
|
||||
top of the window:
|
||||
<ul><li><b>Back</b> and <b>Forward</b> allow you to view the previous
|
||||
contents of the window, just like a web browser</li>
|
||||
<li><b>Parameters</b> pops up a dialog box allowing you to change the
|
||||
information presented in the report:
|
||||
<p><img src="report-option.gif"></p>
|
||||
<p>See the help for the individual reports for details of options
|
||||
available.</p></li>
|
||||
<li><b>Export</b> allows you to export the contents of the report
|
||||
as a HTML file for later viewing or printing.</li>
|
||||
<li><b>Close</b> closes the report window.</li></ul>
|
||||
<h1>Constructing custom reports</h1>
|
||||
|
||||
<p> A Profit and Loss Statement shows <a href=
|
||||
"xacc-expense.html"> Income and Expenses.</a> The sum of all
|
||||
Income minus all expenses is the Profit or Loss, which is the
|
||||
change in equity for the period in question.</p>
|
||||
|
||||
<p> The change in Equity from day to day (year to year)
|
||||
represents that day's (year's) profit or loss.</p>
|
||||
|
||||
<ul>
|
||||
<li><a href="report-baln.phtml">Click Here to Show Balance
|
||||
Sheet</a></li>
|
||||
|
||||
<li><a href="report-pnl.phtml">Click Here to Show Profit and
|
||||
Loss</a></li>
|
||||
|
||||
<li><a href="report-folio.phtml">Show Stock Portfolio
|
||||
Valuation</a></li>
|
||||
</ul>
|
||||
|
||||
<h1> New Reporting System</h1>
|
||||
|
||||
<p> <em> Note that a new reporting system with reports written
|
||||
in Scheme is under construction; once that starts to function,
|
||||
this document will need to be modified to describe how users
|
||||
are to use the reporting system.</em></p>
|
||||
|
||||
<p><em> There will also be a need to construct documentation to
|
||||
indicate how to construct new reports using the reporting
|
||||
system.</em></p>
|
||||
It is possible to write your own reports to meet your own needs, if
|
||||
you can program a little.
|
||||
You will need to know Scheme (a LISP-like programming language),
|
||||
and it is an excellent idea to have a copy of the Gnucash source code
|
||||
available.
|
||||
<P>The reporting interface is presently undocumented, but you can
|
||||
get a good idea of how it works by examining the file
|
||||
src/scm/report/hello-world.scm in the GnuCash source distribution.
|
||||
<P>You will also need to access data from the "engine" to get
|
||||
information for your report. This is performed by a set of Scheme
|
||||
wrapper functions that are documented in the file src/g-wrap/gnc.html.
|
||||
You may wish to examine some of the other reports in src/scm/report
|
||||
for an indication of how they are used.
|
||||
<P>At present, reports are produced by internally creating HTML and
|
||||
rendering this with a HTML widget. (Future versions of GnuCash
|
||||
will hopefully support a more flexible system).
|
||||
<P>If you need more information, or have developed a new report that
|
||||
may be of use to others, please contact the GnuCash development
|
||||
mailing list at <a href="mailto:gnucash-devel@gnucash.org">gnucash-devel@gnucash.org</a>.
|
||||
<hr>
|
||||
|
||||
<p> Return to <a href="xacc-main.html"> Main Documentation
|
||||
Page.</a></p>
|
||||
</body>
|
||||
|
33
Docs/En/xacc-trans_report.html
Normal file
@ -0,0 +1,33 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
|
||||
<html>
|
||||
<head>
|
||||
<link rel="stylesheet" title="normal" type="text/css" href=
|
||||
"gnucash.css">
|
||||
|
||||
<title>Transaction Report</title>
|
||||
</head>
|
||||
|
||||
<body>
|
||||
<h1>Transaction Report</h1>
|
||||
|
||||
<p>Transaction reports list details for transactions in a specified
|
||||
account over a specified period, in a convenient format for
|
||||
viewing and exporting.</p>
|
||||
<p>Options specifiable for this report include:</p>
|
||||
<ul><li><b>Account:</b> the account to do the report on.</li>
|
||||
<li><b>Date To and Date From:</b> the date range for the report
|
||||
to cover.</li>
|
||||
<li><b>Primary Sort Key:</b> the field to sort on first.</li>
|
||||
<li><b>Primary Sort Order:</b> the order in which to sort. "Ascending"
|
||||
specifies smallest/largest, alphabetical ordering, earliest->latest,
|
||||
or smallest amounts first. Descending produces the opposite effects.</li>
|
||||
<li><b>Secondary Sort Key:</b> the field to sort on if the primary
|
||||
sort keys are equal</li>
|
||||
<li><b>Secondary Sort Order:</b> the ordering on which to sort the
|
||||
secondary key.</b>
|
||||
</ul>
|
||||
<hr>
|
||||
<p> Return to <a href="xacc-main.html"> Main Documentation
|
||||
Page.</a></p>
|
||||
</body>
|
||||
</html>
|
BIN
Docs/appr-asset1.gif
Normal file
After Width: | Height: | Size: 11 KiB |
BIN
Docs/appr-asset2.gif
Normal file
After Width: | Height: | Size: 13 KiB |
BIN
Docs/appr-income.gif
Normal file
After Width: | Height: | Size: 9.6 KiB |
BIN
Docs/appr-main1.gif
Normal file
After Width: | Height: | Size: 7.1 KiB |
BIN
Docs/appr-main2.gif
Normal file
After Width: | Height: | Size: 7.6 KiB |
Before Width: | Height: | Size: 5.3 KiB After Width: | Height: | Size: 33 KiB |
BIN
Docs/depr-asset.gif
Normal file
After Width: | Height: | Size: 12 KiB |
BIN
Docs/depr-main.gif
Normal file
After Width: | Height: | Size: 7.4 KiB |
BIN
Docs/expand.gif
Before Width: | Height: | Size: 6.3 KiB After Width: | Height: | Size: 34 KiB |
BIN
Docs/recnwin.gif
Before Width: | Height: | Size: 7.3 KiB After Width: | Height: | Size: 66 KiB |
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 64 KiB |
BIN
Docs/regwin-single2.gif
Normal file
After Width: | Height: | Size: 65 KiB |
BIN
Docs/report-option.gif
Normal file
After Width: | Height: | Size: 9.8 KiB |
BIN
Docs/reportwin.gif
Normal file
After Width: | Height: | Size: 43 KiB |