summaryrefslogtreecommitdiffstats
path: root/kugar/README
blob: 4ad64dfef535122efcc8baedeb065a0ae0d5bfa8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
Kugar - A report creation tool for KDE.

Current version: 1.3

The current maintainer
can be reached via Email: treat@kde.org
or visit http://www.koffice.org/kugar/

The former maintainer and the author of Kugar Report Designer
part can be reached via Email: adymo@kdevelop.org

The former maintainer and author of Kugar report viewer and konqueror
part can be reached via Email: phil@river-bank.demon.co.uk

The original author can be reached via Email: keidav@mutinybaysoftware.com
or visit http://www.mutinybaysoftware.com.  The original name of the package
was Metaphrast.


ABOUT KUGAR:

Current features:

* KDE GUI report designer.
* TQt report viewer widget for previewing reports from within a TQt application
  (WYSIWYG).
* KDE report viewer widget that utilizes KDE print dialog
* KDE report viewer utility.
* KPart report viewer component - view reports from within Konqueror.
* Report printing in Postscript.
* Database/datasource neutral, data is supplied to the report engine in XML.
* Open report definition files, report layout is stored in XML.
* Report Header/Footer.
* Page Header/Footer.
* Detail Section.
* Detail Header/Footer.
* Multiple Detail levels (unlimited).
* Grand totals: count, sum, average, variance and standard deviation.
* Report print progress and cancellation.
* Report rendering progress and cancellation.
* Complete implementation of (TQt) printer setup options.
* Additional formatting (negative numbers, currency, commas for numbers and
  dates).
* Direct database support.


DOCUMENTATION:

Included in docbook-xml format among with the koffice package.
Docs include tutorial, user documentation and developer documentation.

REQUIREMENTS:

The following items must be installed prior to building Kugar:

1. TQt
2. TDE


BUILDING KUGAR:

Basically:

    ./configure
    make
    make install

See the INSTALL file for details.


RUNNING A SAMPLE REPORT WITH KUGAR:

There are three sample templates and matching datafiles in ./samples.

The kugar program takes one or more data files on the commandline.

Example: kugar samples/sample1.kdf

To use Konqueror to display a sample, just click on the data file (with the
.kdf extension) from within Konqueror.

To create template file run Kugar Report Designer program (kudesigner).
To add report items and sections use toolbuttons and menus,
to edit their properties just right-click on them,
to delete - middle-click.