diff --git a/ChangeLog b/ChangeLog index 04a4d2b452..d81c5d3302 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,16 @@ +2001-05-15 Robert Graham Merkel + + * 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 * src/doc/design/engine.texinfo: update docs diff --git a/doc/sgml/C/Makefile.am b/doc/sgml/C/Makefile.am index f895875290..d765d0f2ef 100644 --- a/doc/sgml/C/Makefile.am +++ b/doc/sgml/C/Makefile.am @@ -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 \ diff --git a/doc/sgml/C/gnucash.sgml b/doc/sgml/C/gnucash.sgml index 7b6a01cc63..fa3e15242e 100644 --- a/doc/sgml/C/gnucash.sgml +++ b/doc/sgml/C/gnucash.sgml @@ -4,8 +4,11 @@ + + + @@ -13,12 +16,17 @@ + + + + + @@ -42,13 +50,14 @@ ]> - GnuCash User Manual &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; diff --git a/doc/sgml/C/xacc-about.sgml b/doc/sgml/C/xacc-about.sgml index f6ff8d991d..fb0cfc637e 100644 --- a/doc/sgml/C/xacc-about.sgml +++ b/doc/sgml/C/xacc-about.sgml @@ -79,11 +79,28 @@ merges duplicate transactions. -Reports. Display - or output as HTML Balance, Transaction, and Profit/Loss - reports, as well as graphical account balance tracking. +Gnome MDI Interface +Have multiple views of your financial data, arranged how you want +them, in one or more windows that stay around through GnuCash sessions. + + + + +Reports. 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. + + +Gnome MDI Interface +Have multiple views of your financial data, arranged how you want +them, in one or more windows that stay around through GnuCash sessions. + + diff --git a/doc/sgml/C/xacc-asset-liability-barcharts.sgml b/doc/sgml/C/xacc-asset-liability-barcharts.sgml new file mode 100644 index 0000000000..27e2352aa4 --- /dev/null +++ b/doc/sgml/C/xacc-asset-liability-barcharts.sgml @@ -0,0 +1,15 @@ +
+ +Asset and Liability Barcharts + + +Asset and Liability Barcharts +PICTURES NEEDED!!!! + +This is not yet documented. + +
+ + + + diff --git a/doc/sgml/C/xacc-asset-liability-piecharts.sgml b/doc/sgml/C/xacc-asset-liability-piecharts.sgml new file mode 100644 index 0000000000..8f4ac5faec --- /dev/null +++ b/doc/sgml/C/xacc-asset-liability-piecharts.sgml @@ -0,0 +1,15 @@ +
+ +Asset and Liability Piecharts + + +Asset and Liability Piecharts +PICTURES NEEDED!!!! + +This is not yet documented. + +
+ + + + diff --git a/doc/sgml/C/xacc-balancesheet.sgml b/doc/sgml/C/xacc-balancesheet.sgml index 5d044c8c3f..4c5482b306 100644 --- a/doc/sgml/C/xacc-balancesheet.sgml +++ b/doc/sgml/C/xacc-balancesheet.sgml @@ -13,13 +13,21 @@ 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. 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. + +Note that while you can 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. diff --git a/doc/sgml/C/xacc-dateinput.sgml b/doc/sgml/C/xacc-dateinput.sgml index 31c3663f19..4950746010 100644 --- a/doc/sgml/C/xacc-dateinput.sgml +++ b/doc/sgml/C/xacc-dateinput.sgml @@ -1,10 +1,10 @@
-Date Data Input +Date Accelerator Keys - Date Input + Date Accelerator Keys The date cell handles the following accelerator keys: diff --git a/doc/sgml/C/xacc-gnome-mdi.sgml b/doc/sgml/C/xacc-gnome-mdi.sgml new file mode 100644 index 0000000000..c1da2b33ba --- /dev/null +++ b/doc/sgml/C/xacc-gnome-mdi.sgml @@ -0,0 +1,15 @@ +
+ +The Gnome MDI + + +The Gnome MDI +PICTURES NEEDED!!!! + +This is not yet documented. + +
+ + + + diff --git a/doc/sgml/C/xacc-income-expense-barcharts.sgml b/doc/sgml/C/xacc-income-expense-barcharts.sgml new file mode 100644 index 0000000000..6741307f2d --- /dev/null +++ b/doc/sgml/C/xacc-income-expense-barcharts.sgml @@ -0,0 +1,15 @@ +
+ +Income & Expense Barcharts + + +Income & Expense Barcharts +PICTURES NEEDED!!!! + +This is not yet documented. + +
+ + + + diff --git a/doc/sgml/C/xacc-income-expense-piecharts.sgml b/doc/sgml/C/xacc-income-expense-piecharts.sgml new file mode 100644 index 0000000000..3c0380c05b --- /dev/null +++ b/doc/sgml/C/xacc-income-expense-piecharts.sgml @@ -0,0 +1,15 @@ +
+ +Income & Expense Piecharts + + +Income & Expense Piecharts +PICTURES NEEDED!!!! + +This is not yet documented. + +
+ + + + diff --git a/doc/sgml/C/xacc-mainwin.sgml b/doc/sgml/C/xacc-mainwin.sgml index 05fc2a9dbe..3fd40dc561 100644 --- a/doc/sgml/C/xacc-mainwin.sgml +++ b/doc/sgml/C/xacc-mainwin.sgml @@ -1,14 +1,14 @@
-Main Window +Account Window -This is the main account window. You control your set of +This is an account window. You control your set of accounts from here. -Below is a picture of the main window, with only the main +Below is a picture of an account window, with only the main accounts shown. Note how Business Expenses has been selected by highlighting. The box with a cross in it, immediately to its left, shows that it has one or more detail diff --git a/doc/sgml/C/xacc-multicolumn-view-reports.sgml b/doc/sgml/C/xacc-multicolumn-view-reports.sgml new file mode 100644 index 0000000000..63bd270c81 --- /dev/null +++ b/doc/sgml/C/xacc-multicolumn-view-reports.sgml @@ -0,0 +1,15 @@ +
+ +Multicolumn Views + + +Multicolumn Views +PICTURES NEEDED!!!! + +This is not yet documented. + +
+ + + + diff --git a/doc/sgml/C/xacc-portfolio-report.sgml b/doc/sgml/C/xacc-portfolio-report.sgml index ec8599ebf5..530785c009 100644 --- a/doc/sgml/C/xacc-portfolio-report.sgml +++ b/doc/sgml/C/xacc-portfolio-report.sgml @@ -1,26 +1,37 @@ - -
- -Stock Portfolio Report - - - Stock Portfolio Report - - - - - - - -This report summarizes the value of the stocks in your +
+ +Stock Portfolio Report + + + Stock Portfolio Report + + + + + + +This report summarizes the value of the stocks in your current portfolio. - -There are currently no options for this report. - - - -
+ +Options supported by this report include the following: + + + Accounts + + Report Title + + Stylesheet + + Date + + Report Currency + + Price Source + + + +
diff --git a/doc/sgml/C/xacc-reports.sgml b/doc/sgml/C/xacc-reports.sgml index 7ec60b2e9d..99b119ea26 100644 --- a/doc/sgml/C/xacc-reports.sgml +++ b/doc/sgml/C/xacc-reports.sgml @@ -11,10 +11,18 @@ menu: Balance Sheet: - shows Assets, Liabilities and Equity. + shows Assets, Liabilities and Equity. +Net Worth +Barchartshows your net worth in a graphical environment. +If you examine just assets or liabilities, +barcharts showing data over time are available, as are +piecharts. Profit And Loss State: - shows Income and expenses over a selectable period. + shows Income and/or Expenses over a selectable period. + +There are also bar +and pie charts. Transaction Report @@ -31,11 +39,9 @@ linkend="xacc-txf-export">export a .TXF file that can be imported to TaxCut or TurboTax. - Balance Tracker tracks the -balance of one or more accounts over time, and supports graphical -output (if you have gnuplot installed). - - + Balance +Tracker tracks the balance of one or more accounts over time, +with the option of displaying both tables and a bar chart. @@ -43,7 +49,11 @@ output (if you have gnuplot installed). The Report Window - Once you select a report, a report window will appear: + 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 using +the MDI interface. @@ -62,7 +72,7 @@ window: allow you to view the previous contents of the window, just like a web browser - Parameters pops up a dialog box + Options pops up a dialog box allowing you to change the information presented in the report: @@ -85,9 +95,15 @@ later viewing or printing. - + + Multiple Reports In A Window 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 +Multicolumn View special report. + Constructing custom reports @@ -111,11 +127,13 @@ examine some of the other reports in src/scm/report for an indication of how they are used. -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). +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. - +