mirror of
https://github.com/Gnucash/gnucash.git
synced 2025-02-25 18:55:30 -06:00
updating documentation to detail new features.
git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@4199 57a11ea4-9604-0410-9ed3-97b8803252fd
This commit is contained in:
Robert Graham Merkel
parent
92a7486177
commit
73c08b34fd
13
ChangeLog
13
ChangeLog
@ -1,3 +1,16 @@
|
||||
2001-05-15 Robert Graham Merkel <rgmerk@mira.net>
|
||||
|
||||
* doc/sgml/C/xacc-reports.sgml, xacc-about.sgml, xacc-dateinput.sgml,
|
||||
xacc-account-summary.sgml, xacc-balancesheet.sgml, xacc-common-report-options.sgml
|
||||
xacc-mainwin.sgml: update documentation for new features.
|
||||
|
||||
* doc/sgml/C/xacc-asset-liability-barcharts.sgml: new file. Placeholder
|
||||
at this stage.
|
||||
|
||||
* doc/sgml/C/xacc-asset-liability-piecharts.sgml, xacc-gnome-mdi.sgml,
|
||||
xacc-income-expense-barcharts.sgml, xacc-income-expense-piecharts.sgml,
|
||||
xacc-multicolumn-view-reports.sgml: ditto.
|
||||
|
||||
2001-05-15 Dave Peticolas <dave@krondo.com>
|
||||
|
||||
* src/doc/design/engine.texinfo: update docs
|
||||
|
||||
@ -10,20 +10,28 @@ GNUCASH_SGML_FILES = \
|
||||
xacc-acctypes.sgml \
|
||||
xacc-adjbalwin.sgml \
|
||||
xacc-apar.sgml \
|
||||
xacc-asset-liability-barcharts.sgml \
|
||||
xacc-asset-liability-piecharts.sgml \
|
||||
xacc-balancereport.sgml \
|
||||
xacc-balancesheet.sgml \
|
||||
xacc-chartofaccts.sgml \
|
||||
xacc-commodity.sgml \
|
||||
xacc-common-report-options.sgml \
|
||||
xacc-currencyhandling.sgml \
|
||||
xacc-dateinput.sgml \
|
||||
xacc-depreciation.sgml \
|
||||
xacc-dochack.sgml \
|
||||
xacc-doubleentry.sgml \
|
||||
xacc-euro.sgml \
|
||||
xacc-gnome-mdi.sgml \
|
||||
xacc-gpl.sgml \
|
||||
xacc-incomeexpense.sgml \
|
||||
xacc-income-expense-barcharts.sgml \
|
||||
xacc-income-expense-piecharts.sgml \
|
||||
xacc-locatingtxns.sgml \
|
||||
xacc-mainwin.sgml \
|
||||
xacc-multicolumn-view-reports.sgml \
|
||||
xacc-net-worth-barchart.sgml \
|
||||
xacc-newacctwin.sgml \
|
||||
xacc-pnl.sgml \
|
||||
xacc-portfolio-report.sgml \
|
||||
|
||||
@ -4,8 +4,11 @@
|
||||
<!entity xaccacctypes system "xacc-acctypes.sgml">
|
||||
<!entity xaccnewacctwin system "xacc-newacctwin.sgml">
|
||||
<!entity xaccadjbalwin system "xacc-adjbalwin.sgml">
|
||||
<!entity xaccassetbarcharts "xacc-asset-liability-barcharts.sgml">
|
||||
<!entity xaccassetpiecharts "xacc-asset-liability-piecharts.sgml">
|
||||
<!entity xaccapar system "xacc-apar.sgml">
|
||||
<!entity xacccommodity system "xacc-commodity.sgml">
|
||||
<!entity xacccommonreportoptions system "xacc-common-report-options.sgml">
|
||||
<!entity xaccdepreciation system "xacc-depreciation.sgml">
|
||||
<!entity xaccbalancereport system "xacc-balancereport.sgml">
|
||||
<!entity xaccbalancesheet system "xacc-balancesheet.sgml">
|
||||
@ -13,12 +16,17 @@
|
||||
<!entity xaccdoubleentry system "xacc-doubleentry.sgml">
|
||||
<!entity xacceuro system "xacc-euro.sgml">
|
||||
<!entity xaccdateinput system "xacc-dateinput.sgml">
|
||||
<!entity xaccgnomemdi system "xacc-gnome-mdi.sgml">
|
||||
<!entity xaccincomeexpense system "xacc-incomeexpense.sgml">
|
||||
<!entity xaccincomeexpensebarcharts system "xacc-income-expense-barcharts.sgml">
|
||||
<!entity xaccincomeexpensepiecharts system "xacc-income-expense-piecharts.sgml">
|
||||
<!entity xacclocatingtxns system "xacc-locatingtxns.sgml">
|
||||
<!entity xaccmulticolumnviewreports system "xacc-multicolumn-view-reports.sgml">
|
||||
<!entity xaccpreferences system "xacc-preferences.sgml">
|
||||
<!entity xaccchartofaccts system "xacc-chartofaccts.sgml">
|
||||
<!entity xaccuserdocs system "xacc-userdocs.sgml">
|
||||
<!entity xaccmainwin system "xacc-mainwin.sgml">
|
||||
<!entity xaccnetworthbarchart system "xacc-net-worth-barchart.sgml">
|
||||
<!entity xaccpnl system "xacc-pnl.sgml">
|
||||
<!entity xaccportfolioreport system "xacc-portfolio-report.sgml">
|
||||
<!entity xaccprintcheck system "xacc-print-check.sgml">
|
||||
@ -42,13 +50,14 @@
|
||||
<!entity xaccgpl system "xacc-gpl.sgml">
|
||||
<!entity bofamym system "bofa-mym.sgml">
|
||||
]>
|
||||
|
||||
<BOOK ID="index">
|
||||
<TITLE>GnuCash User Manual</TITLE>
|
||||
|
||||
&xaccabout;
|
||||
&xaccaccountedit;
|
||||
&xaccacctypes;
|
||||
&xaccassetbarcharts;
|
||||
&xaccassetpiecharts;
|
||||
&xaccnewacctwin;
|
||||
&xaccadjbalwin;
|
||||
&xaccapar;
|
||||
@ -56,16 +65,21 @@
|
||||
&xaccbalancereport;
|
||||
&xaccbalancesheet;
|
||||
&xacccommodity;
|
||||
&xacccommonreportoptions;
|
||||
&xacccurrencyhandling;
|
||||
&xaccdoubleentry;
|
||||
&xacceuro;
|
||||
&xaccdateinput;
|
||||
&xaccincomeexpense;
|
||||
&xaccincomeexpensebarcharts;
|
||||
&xaccincomeexpensepiecharts;
|
||||
&xacclocatingtxns;
|
||||
&xaccpreferences;
|
||||
&xaccchartofaccts;
|
||||
&xaccuserdocs;
|
||||
&xaccmainwin;
|
||||
&xaccmulticolumnviewreports;
|
||||
&xaccnetworthbarchart;
|
||||
&xaccpnl;
|
||||
&xaccportfolioreport;
|
||||
&xaccprintcheck;
|
||||
|
||||
@ -79,11 +79,28 @@ merges duplicate transactions.
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para><emphasis><link linkend="xacc-reports">Reports</link>.</emphasis> Display
|
||||
or output as HTML Balance, Transaction, and Profit/Loss
|
||||
reports, as well as graphical account balance tracking.
|
||||
<para><emphasis>Gnome MDI Interface</emphasis></para>
|
||||
<para>Have multiple views of your financial data, arranged how you want
|
||||
them, in one or more windows that stay around through GnuCash sessions.
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para><emphasis><link linkend="xacc-reports">Reports</link>.</emphasis> Display,
|
||||
export as HTML, or print a variety of reports, including Balance Sheet, Account
|
||||
Summary, Profit and Loss, Stock Portfolios, and Transaction Reports. Reports
|
||||
are saved from session to session, and rolling reports are possible with
|
||||
relative dates. GnuCash also supports a variety of customizable, printable,
|
||||
bar and pie charts.
|
||||
</para>
|
||||
</listitem>
|
||||
|
||||
<listitem>
|
||||
<para><emphasis>Gnome MDI Interface</emphasis></para>
|
||||
<para>Have multiple views of your financial data, arranged how you want
|
||||
them, in one or more windows that stay around through GnuCash sessions.
|
||||
</para>
|
||||
</listitem>
|
||||
</itemizedlist>
|
||||
|
||||
</para>
|
||||
|
||||
15
doc/sgml/C/xacc-asset-liability-barcharts.sgml
Normal file
15
doc/sgml/C/xacc-asset-liability-barcharts.sgml
Normal file
@ -0,0 +1,15 @@
|
||||
<article id="xacc-asset-liability-barcharts">
|
||||
<artheader>
|
||||
<title>Asset and Liability Barcharts</title>
|
||||
</artheader>
|
||||
<sect1>
|
||||
<title>Asset and Liability Barcharts</title>
|
||||
<para><emphasis>PICTURES NEEDED!!!!</emphasis>
|
||||
</para>
|
||||
<para>This is not yet documented.</para>
|
||||
</sect1>
|
||||
</article>
|
||||
|
||||
<!-- Local variables: -->
|
||||
<!-- sgml-parent-document: "gnucash.sgml" -->
|
||||
<!-- End: -->
|
||||
15
doc/sgml/C/xacc-asset-liability-piecharts.sgml
Normal file
15
doc/sgml/C/xacc-asset-liability-piecharts.sgml
Normal file
@ -0,0 +1,15 @@
|
||||
<article id="xacc-asset-liability-piecharts">
|
||||
<artheader>
|
||||
<title>Asset and Liability Piecharts</title>
|
||||
</artheader>
|
||||
<sect1>
|
||||
<title>Asset and Liability Piecharts</title>
|
||||
<para><emphasis>PICTURES NEEDED!!!!</emphasis>
|
||||
</para>
|
||||
<para>This is not yet documented.</para>
|
||||
</sect1>
|
||||
</article>
|
||||
|
||||
<!-- Local variables: -->
|
||||
<!-- sgml-parent-document: "gnucash.sgml" -->
|
||||
<!-- End: -->
|
||||
@ -13,13 +13,21 @@
|
||||
|
||||
</PARA>
|
||||
<PARA>This report summarizes your assets, liabilities, and
|
||||
equity.
|
||||
equity. According to the accounting equation, your assets
|
||||
should equal the sum of your liabilities and equity. If that
|
||||
is not the case, there is some kind of internal imbalance in
|
||||
your accounts.
|
||||
|
||||
</PARA>
|
||||
<PARA>You can select the date for which the balance sheet is to be
|
||||
calculated up to using the "preferences" toolbar button. The
|
||||
default is today.
|
||||
|
||||
</PARA>
|
||||
<PARA>Note that while you <EMPHASIS>can</EMPHASIS> select specific
|
||||
accounts for this report, unless you know exactly what you are
|
||||
doing it is unwise and highly likely to give you misleading and
|
||||
incorrect figures.
|
||||
</PARA>
|
||||
</SECT1>
|
||||
</ARTICLE>
|
||||
|
||||
@ -1,10 +1,10 @@
|
||||
|
||||
<ARTICLE ID="XACC-DATEINPUT">
|
||||
<ARTHEADER>
|
||||
<TITLE>Date Data Input</TITLE>
|
||||
<TITLE>Date Accelerator Keys</TITLE>
|
||||
</ARTHEADER>
|
||||
<SECT1>
|
||||
<TITLE> Date Input</TITLE>
|
||||
<TITLE> Date Accelerator Keys</TITLE>
|
||||
<PARA> The date cell handles the following accelerator keys:
|
||||
|
||||
<ITEMIZEDLIST>
|
||||
|
||||
15
doc/sgml/C/xacc-gnome-mdi.sgml
Normal file
15
doc/sgml/C/xacc-gnome-mdi.sgml
Normal file
@ -0,0 +1,15 @@
|
||||
<article id="xacc-gnome-mdi">
|
||||
<artheader>
|
||||
<title>The Gnome MDI</title>
|
||||
</artheader>
|
||||
<sect1>
|
||||
<title>The Gnome MDI</title>
|
||||
<para><emphasis>PICTURES NEEDED!!!!</emphasis>
|
||||
</para>
|
||||
<para>This is not yet documented.</para>
|
||||
</sect1>
|
||||
</article>
|
||||
|
||||
<!-- Local variables: -->
|
||||
<!-- sgml-parent-document: "gnucash.sgml" -->
|
||||
<!-- End: -->
|
||||
15
doc/sgml/C/xacc-income-expense-barcharts.sgml
Normal file
15
doc/sgml/C/xacc-income-expense-barcharts.sgml
Normal file
@ -0,0 +1,15 @@
|
||||
<article id="xacc-income-expense-barcharts">
|
||||
<artheader>
|
||||
<title>Income & Expense Barcharts</title>
|
||||
</artheader>
|
||||
<sect1>
|
||||
<title>Income & Expense Barcharts</title>
|
||||
<para><emphasis>PICTURES NEEDED!!!!</emphasis>
|
||||
</para>
|
||||
<para>This is not yet documented.</para>
|
||||
</sect1>
|
||||
</article>
|
||||
|
||||
<!-- Local variables: -->
|
||||
<!-- sgml-parent-document: "gnucash.sgml" -->
|
||||
<!-- End: -->
|
||||
15
doc/sgml/C/xacc-income-expense-piecharts.sgml
Normal file
15
doc/sgml/C/xacc-income-expense-piecharts.sgml
Normal file
@ -0,0 +1,15 @@
|
||||
<article id="xacc-income-expense-piecharts">
|
||||
<artheader>
|
||||
<title>Income & Expense Piecharts</title>
|
||||
</artheader>
|
||||
<sect1>
|
||||
<title>Income & Expense Piecharts</title>
|
||||
<para><emphasis>PICTURES NEEDED!!!!</emphasis>
|
||||
</para>
|
||||
<para>This is not yet documented.</para>
|
||||
</sect1>
|
||||
</article>
|
||||
|
||||
<!-- Local variables: -->
|
||||
<!-- sgml-parent-document: "gnucash.sgml" -->
|
||||
<!-- End: -->
|
||||
@ -1,14 +1,14 @@
|
||||
<ARTICLE ID="XACC-MAINWIN">
|
||||
|
||||
<ARTHEADER>
|
||||
<TITLE>Main Window</TITLE>
|
||||
<TITLE>Account Window</TITLE>
|
||||
</ARTHEADER>
|
||||
|
||||
<PARA>This is the main account window. You control your set of
|
||||
<PARA>This is an account window. You control your set of
|
||||
accounts from here.
|
||||
|
||||
</PARA>
|
||||
<PARA>Below is a picture of the main window, with only the main
|
||||
<PARA>Below is a picture of an account window, with only the main
|
||||
accounts shown. Note how <EMPHASIS>Business Expenses</EMPHASIS> has been
|
||||
selected by highlighting. The box with a cross in it,
|
||||
immediately to its left, shows that it has one or more detail
|
||||
|
||||
15
doc/sgml/C/xacc-multicolumn-view-reports.sgml
Normal file
15
doc/sgml/C/xacc-multicolumn-view-reports.sgml
Normal file
@ -0,0 +1,15 @@
|
||||
<article id="xacc-multicolumn-view-reports">
|
||||
<artheader>
|
||||
<title>Multicolumn Views</title>
|
||||
</artheader>
|
||||
<sect1>
|
||||
<title>Multicolumn Views</title>
|
||||
<para><emphasis>PICTURES NEEDED!!!!</emphasis>
|
||||
</para>
|
||||
<para>This is not yet documented.</para>
|
||||
</sect1>
|
||||
</article>
|
||||
|
||||
<!-- Local variables: -->
|
||||
<!-- sgml-parent-document: "gnucash.sgml" -->
|
||||
<!-- End: -->
|
||||
@ -1,26 +1,37 @@
|
||||
|
||||
<ARTICLE ID="XACC-PORTFOLIO-REPORT">
|
||||
<ARTHEADER>
|
||||
<TITLE>Stock Portfolio Report</TITLE>
|
||||
</ARTHEADER>
|
||||
<SECT1>
|
||||
<TITLE> Stock Portfolio Report</TITLE>
|
||||
<PARA> <INLINEMEDIAOBJECT>
|
||||
<IMAGEOBJECT>
|
||||
<IMAGEDATA FILEREF="image/report-folio.png">
|
||||
</IMAGEOBJECT>
|
||||
</INLINEMEDIAOBJECT>
|
||||
|
||||
</PARA>
|
||||
<PARA>This report summarizes the value of the stocks in your
|
||||
<article id="XACC-PORTFOLIO-REPORT">
|
||||
<artheader>
|
||||
<title>Stock Portfolio Report</title>
|
||||
</artheader>
|
||||
<sect1>
|
||||
<title> Stock Portfolio Report</title>
|
||||
<para> <inlinemediaobject>
|
||||
<imageobject>
|
||||
<imagedata fileref="image/report-folio.png">
|
||||
</imageobject>
|
||||
</inlinemediaobject>
|
||||
</para>
|
||||
<para>This report summarizes the value of the stocks in your
|
||||
current portfolio.
|
||||
|
||||
</PARA>
|
||||
<PARA>There are currently no options for this report.
|
||||
|
||||
</PARA>
|
||||
</SECT1>
|
||||
</ARTICLE>
|
||||
</para>
|
||||
<para>Options supported by this report include the following:
|
||||
<itemizedlist>
|
||||
<listitem><para><emphasis><link linkend="xacc-options-accounts">
|
||||
Accounts</link></emphasis></para></listitem>
|
||||
<listitem><para><emphasis><link linkend="xacc-options-report-title">
|
||||
Report Title</link></emphasis></para></listitem>
|
||||
<listitem><para><emphasis><link linkend="xacc-options-style-sheet">
|
||||
Stylesheet</link></emphasis></para></listitem>
|
||||
<listitem><para><emphasis><link linkend="xacc-options-date">
|
||||
Date</link></emphasis></para></listitem>
|
||||
<listitem><para><emphasis><link linkend="xacc-options-report-currency">
|
||||
Report Currency</link></emphasis></para></listitem>
|
||||
<listitem><para><emphasis<link linkend="xacc-options-price-source">
|
||||
Price Source</link></emphasis></para></listitem>
|
||||
</itemizedlist>
|
||||
</para>
|
||||
</sect1>
|
||||
</article>
|
||||
|
||||
<!-- Local variables: -->
|
||||
<!-- sgml-parent-document: "gnucash.sgml" -->
|
||||
|
||||
@ -11,10 +11,18 @@ menu:
|
||||
<itemizedlist>
|
||||
|
||||
<listitem><para><link linkend="xacc-balancesheet"> Balance Sheet:
|
||||
</link> shows Assets, Liabilities and Equity. </para> </listitem>
|
||||
</link> shows Assets, Liabilities and Equity. </para>
|
||||
<para><link linkend="xacc-net-worth-barchart">Net Worth
|
||||
Barchart</link>shows your net worth in a graphical environment.
|
||||
If you examine just assets or liabilities, <link linkend="xacc-asset-liability-barcharts">
|
||||
barcharts</link> showing data over time are available, as are
|
||||
<link linkend="xacc-asset-liability-piecharts">piecharts</link>.
|
||||
|
||||
<listitem><para><link linkend="xacc-pnl"> Profit And Loss State:
|
||||
</link> shows Income and expenses over a selectable period. </para>
|
||||
</link> shows Income and/or Expenses over a selectable period. </para>
|
||||
<para>
|
||||
There are also <link linkend="xacc-income-expense-barcharts">bar</link>
|
||||
and <link linkend="xacc-income-expense-piecharts">pie</link> charts.</para>
|
||||
</listitem>
|
||||
|
||||
<listitem> <para><link linkend="xacc-trans-report"> Transaction Report
|
||||
@ -31,11 +39,9 @@ linkend="xacc-txf-export">export a .TXF file</link> that can be imported
|
||||
to TaxCut or TurboTax. </para>
|
||||
</listitem>
|
||||
|
||||
<listitem> <para><application>Balance Tracker</application> tracks the
|
||||
balance of one or more accounts over time, and supports graphical
|
||||
output (if you have <application>gnuplot</application> installed).
|
||||
</para> </listitem>
|
||||
|
||||
<listitem> <para><link linkend="xacc-balancereport">Balance
|
||||
Tracker</link> tracks the balance of one or more accounts over time,
|
||||
with the option of displaying both tables and a bar chart.</para>
|
||||
</itemizedlist>
|
||||
|
||||
</para>
|
||||
@ -43,7 +49,11 @@ output (if you have <application>gnuplot</application> installed).
|
||||
<sect1 id="xacc-reportwindow">
|
||||
<title> The Report Window</title>
|
||||
|
||||
<para> Once you select a report, a report window will appear: </para>
|
||||
<para> Once you select a report, a report will appear. This
|
||||
may appear as a seperate top-level window, as a notebook tab,
|
||||
or in the main window, selectable for viewing through the "Window"
|
||||
menu. This is controllable <link linkend="xacc-gnome-mdi">using
|
||||
the MDI interface.</link></para>
|
||||
|
||||
<para><inlinemediaobject>
|
||||
<imageobject>
|
||||
@ -62,7 +72,7 @@ window:
|
||||
</emphasis> allow you to view the previous contents of the window,
|
||||
just like a web browser </para> </listitem>
|
||||
|
||||
<listitem> <para> <emphasis>Parameters</emphasis> pops up a dialog box
|
||||
<listitem> <para> <emphasis>Options</emphasis> pops up a dialog box
|
||||
allowing you to change the information presented in the report:
|
||||
</para>
|
||||
|
||||
@ -85,9 +95,15 @@ later viewing or printing. </para> </listitem>
|
||||
|
||||
</itemizedlist>
|
||||
|
||||
</para>
|
||||
</sect1>
|
||||
|
||||
<sect1 id="xacc-multiple-reports">
|
||||
<title> Multiple Reports In A Window</title> <para>GnuCash allows you
|
||||
to place multiple reports into a single report window, allowing you to
|
||||
examine a set of financial information at a glance. This functionality
|
||||
is provided with the <link linkend="xacc-multicolumn-view-report">
|
||||
Multicolumn View</link> special report.</para></sect1>
|
||||
|
||||
<sect1 id="xacc-customreports">
|
||||
<title> Constructing custom reports</title>
|
||||
|
||||
@ -111,11 +127,13 @@ examine some of the other reports in <filename> src/scm/report
|
||||
</filename> for an indication of how they are used.
|
||||
</para>
|
||||
|
||||
<para>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). </para>
|
||||
<para>At present, reports are produced by calling a HTML-generation API,
|
||||
which outputs a dialect of HTML and rendering this with a HTML widget. This
|
||||
has limitations (particularly when trying to align objects precisely,
|
||||
as might be necessary for printing onto pre-printed invoices for example),
|
||||
so in the future an additional report generation interface may be needed.</para>
|
||||
|
||||
</sect1>
|
||||
</sect1>
|
||||
</article>
|
||||
<!-- Local variables: -->
|
||||
<!-- sgml-parent-document: "gnucash.sgml" -->
|
||||
|
||||
Loading…
Reference in New Issue
Block a user