[gnue] r10092 - in trunk/gnue-reports: . doc samples
[email protected] Sat, 5 Dec 2009 14:54:53 -0600 (CST)
| Newsgroups | gmane.comp.cms.gnue.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: reinhard Date: 2009-12-05 14:54:52 -0600 (Sat, 05 Dec 2009) New Revision: 10092 Removed: trunk/gnue-reports/doc/Tech-Reference.sxw trunk/gnue-reports/samples/docbook/ trunk/gnue-reports/samples/location/ Modified: trunk/gnue-reports/AUTHORS trunk/gnue-reports/INSTALL trunk/gnue-reports/MANIFEST.in trunk/gnue-reports/README trunk/gnue-reports/TODO trunk/gnue-reports/setup.py Log: Updated documentation and samples. Modified: trunk/gnue-reports/AUTHORS =================================================================== --- trunk/gnue-reports/AUTHORS 2009-12-05 20:38:16 UTC (rev 10091) +++ trunk/gnue-reports/AUTHORS 2009-12-05 20:54:52 UTC (rev 10092) @@ -1,18 +1,4 @@ -Jason Cater <[email protected]>: - Primary Author - -James Thompson <[email protected]>: - Trigger Support - Miscellaneous Additions - -Derek Neighbors <[email protected]>: - XSL transformation scripts - -Bajusz Tamas <[email protected]> - XSLT-less SimpleTabulation filter - -A good bit of Reports is implemented using the GNUe-Common library. -So, in order to fully appreciate the work behind GNUe-Reports, be -sure to look at GNUe-Common's AUTHOR file, too :) - -If we've missed anyone, please let us know. +Bajusz Tamas <btami at freemail.hu> +Jason Cater <jcater at gnue.org> +Derek Neighbors <derek at gnue.org> +James Thompson <jamest at gnue.org> Modified: trunk/gnue-reports/INSTALL =================================================================== --- trunk/gnue-reports/INSTALL 2009-12-05 20:38:16 UTC (rev 10091) +++ trunk/gnue-reports/INSTALL 2009-12-05 20:54:52 UTC (rev 10092) @@ -1,80 +1,54 @@ -Installation instructions for GNUe Reports -========================================== +Installation instructions for GNU Enterprise Reports +==================================================== -Short Version -------------- -For the impatient... - -Install the following prerequisites: - - * Python 2.0 or later http://www.python.org/ - * GNUe-Common http://www.gnuenterprise.org/downloads/common - * Sablotron http://www.gingerall.com/charlie/ga/xml/p_sab.xml - * PySablot http://sourceforge.net/projects/pysablot/ - -Then, as root: - - $ python2 ./setup.py install (may also be python2.1 or python2.2) - $ cd /usr/local/gnue/etc - $ cp sample.gnue.conf gnue.conf - $ cp sample.report-filters.conf report-filters.conf - - -Introduction +Requirements ------------ -GNUe Reports is the primary reporting engine for GNU Enterprise. -It requires a few prerequisite packages to be installed prior to -installing reports. +To install gnue-reports, you need at least the following prerequisites +installed on your system [Debian packages in brackets]: -Currently, reports will only run in a command-line mode -- the -"server" implementation of GNUe Reports is still underway. This -means Reports is currently useful for evaluation or for small, -centralized (2-tier) sites. +* Python 2.3 or greater [python python-dev] +* GNUe Common 0.6.8 or greater [gnue-common] -Requirements ------------- +* at least one of the following database interfaces, depending on the database + you want to use (unless you run gnue-reports in a three tier environment with + gnue-appserver): + - psycopg2 (preferred for PostgreSQL) [python-psycopg2] + - psycopg (also possible for PostgreSQL) [python-psycopg] + - pyPgSQL (also possible for PostgreSQL) [python-pgsql] + - pygresql (also possible for PostgreSQL) [python-pygresql] + - python-mysqldb (for MySQL) [python-mysqldb] + - KInterbasDB (for Interbase/Firebird) [python-kinterbasdb] + - MaxDB (for MaxDB) [python-maxdb] + - PySQLite (for SQLite2) [python-sqlite] + - PySQLite2 (for SQLite3) [python-pysqlite2] + You can find more information about possible database backends on the web + page http://www.gnuenterprise.org/tools/common/databases/. -GNUe Reports needs some prerequisites to work. You need a database -managment system and the scripting language Python (version 2.0 or -higher). Most modern Unix platforms have a python package available. +You also need either a database server (one of those supported by GNUe) or GNUe +AppServer running on the local or on a remote machine, and in case of a +database server, you need the corresponding database client software installed +on the local machine. We very much recommend that you make sure that you can +access the database with the databases's normal client tools before you try to +install and run gnue-forms against a database server. -The following minimum programs are required for running GNUe-Reports: - Python 2.0 or later http://www.python.org/ - Sablotron http://www.gingerall.com/charlie/ga/xml/p_sab.xml - PySablot http://sourceforge.net/projects/pysablot/ - GNUe-Common http://www.gnuenterprise.org/downloads/common - - Installation ------------ -Run the following command: +* Make sure that you have write permission in the directory /usr/local and its + subdirectories. - python2 setup.py install +* From the shell prompt, change into the directory containing the file + "setup.py" and type "./setup.py install". If you have all prerequisites + installed, the installation process should run without errors. If any error + occures although you have fulfilled all dependencies described above, this is + probably a bug, either in the installation program or in the documentation. + Please report it. -If python2 is not found, try one of these alternates: - python2.1 setup.py install - python2.2 setup.py install - - -Configuration -------------- - -Make sure that you have a valid /usr/local/gnue/etc/gnue.conf and -a valid /usr/local/gnue/etc/report-filters.conf. Sample versions of -these files are installed by gnue-common as sample.gnue.conf and -sample.report-filters.conf. These samples will be sufficient for -most sites. Simply copy the sample files to the needed files. - -See the various sections below for setting up the "destinations" -(printers, email, file, and fax.) - - Support for the "printer" destination ------------------------------------- @@ -102,7 +76,6 @@ the printer "lp". - Support for the "file" destination ---------------------------------- @@ -129,7 +102,6 @@ $ gnue-reports --quiet -D file -d- --filter html | enscript -P lp - Support for the "email" destination ----------------------------------- @@ -156,7 +128,6 @@ attachment will be an "html" file. - Support for the "fax" destination --------------------------------- @@ -193,33 +164,3 @@ Reports, "--filter postscript" will be the logical choice. Until then, unless you've manually configured sendfax to convert html documents, "--filter text" is the only reasonable choice. - - -Debian Installation -------------------- - -To install on a Debian system, you need to apt-get the following packages -(these exist in Woody; I'm not sure about Potato): - - python2.1 - python2.1-dev - python2.1-egenix-mxdatetime - sablotron - libexpat1 - python2.1-psycopg (if needed -- for PostgreSQL support) - python2.1-mysqldb (if needed -- for MySQL support) - hylafax-client (if needed -- for Fax support) - -Also, grab the debs for PySablot from: - http://www.gnuenterprise.org/~jcater/debian/pysablot2.1_0.1-1_i386.deb - -and install as: - dpkg --install pysablot2.1_0.1-1_i386.deb - -You should now have all the prerequisites installed and can install -GNUe Common and GNUe Reports using: - - python2.1 setup.py install - - - Modified: trunk/gnue-reports/MANIFEST.in =================================================================== --- trunk/gnue-reports/MANIFEST.in 2009-12-05 20:38:16 UTC (rev 10091) +++ trunk/gnue-reports/MANIFEST.in 2009-12-05 20:54:52 UTC (rev 10092) @@ -6,6 +6,7 @@ include INSTALL include NEWS include README +include TODO include doc/* include doc/man/* @@ -18,13 +19,11 @@ include po/* -include samples/docbook/* include samples/labels/* include samples/dcl/* include samples/mailmerge/* include samples/foobulations/* include samples/php_client/* -include samples/location/* include samples/cross-tabulation/* include scripts/gnue-* Modified: trunk/gnue-reports/README =================================================================== --- trunk/gnue-reports/README 2009-12-05 20:38:16 UTC (rev 10091) +++ trunk/gnue-reports/README 2009-12-05 20:54:52 UTC (rev 10092) @@ -1,78 +1,32 @@ -GNUe Reports: A tool of the GNUe Project (www.gnue.org) +GNU Enterprise Reports: A tool of the GNU Enterprise Project +(www.gnuenterprise.org) + Introduction ------------ -GNUe Reports is a platform and output-independent reporting system. It reads an -XML-based report definition and generates arbitrary XML output that can further -be translated into any format for which there is an adapter. GNUe Reports -currently has outputs for Text, HTML, Label Stock, and CSV -- with PDF, -Postscript, and Gnumeric/Excel formats in the works. Reports can output directly -to a file, as an email attachment, to a printer, or to a HylaFax server. -Overview --------- -GNUe Reports is a data transformation and output tool. At its most basic -level, GNUe Reports transforms database data into arbitrarily complex XML. -This XML can then be transformed into whatever format desired. +GNUe Reports is a platform and output-independent reporting system. -GNUe Reports can output this XML directly to a file (for processing by -another program), or it can process the XML into its final format all from -the same command. For this extended functionality, GNUe Report implements -Filter Adapters and Destination Adapters. +It reads an XML-based report definition and generates arbitrary XML output that +can further be translated into any format for which there is an adapter. GNUe +Reports currently has outputs for Text, HTML, Label Stock, and CSV -- with PDF, +Postscript, and Gnumeric/Excel formats in the works. Reports can output +directly to a file, as an email attachment, to a printer, or to a HylaFax +server. -Filter Adapters take the resultant XML and process it in some way. The -currently supported Filter Adapters are: - * sablotron Uses Sablotron to perform XSL Transforms. A "filter" - XSLT script can be created that transforms GNUe Report's - XML output into another XML output (e.g., Abiword's XML, - XHTML, or some form of custom XML) or text output (Plain - Text, CSV, Postscript, etc.) There are currently examples - for XSLT scripts for HTML, plain text, and CSV formats - (and the beginnings of KSpread and Gnumeric support.) - - * merge_rtf This specialized adapter takes a template RTF file and - merges it with GNUe Reports' XML to create a merged RTF - file. The template RTF is a normal RTF file with any fields - denoted as ::field:: (two leading and two trailing colons.) - -Destination Adapters define various output mechanisms for GNUe Reports. -There are four primary adapter classes, File, Email, Printer, and Fax. -There are currently adapters for sendfax, bsd lpr, and HylaFax's sendfax. -It is trivial to add a custom adapter to GNUe Reports specific to your -setup. - -Given the two adapters, all of the following scenarios are currently -supported using a single report definition: - - * Print out a hard copy of a report, - * Fax a copy of a report to a client, - * Email an HTML version of the report to a coworker, - * Save the report as a comma separated (CSV) file to load into - your favorite spreadsheet program. - -Of course, any combination is supported, even combinations that make little -sense (e.g., faxing a CSV version of a report) - - Installation ------------ -For installation and configuration instructions, please read the -file INSTALL. -Compatability -------------- -GNUe Reports is known to work on the following platforms: - * Debian GNU/Linux 2.x/3.x - * RedHat Linux 7.x +For a number of operating systems, packages of GNUe Forms are available at +http://www.gnuenterprise.org/downloads/ that use the native installation tools +of these operating systems. It is recommended to use these packages if +possible. -GNUe Reports should work without issue on any Unix-compatable system -for which Python is available. This applies to most modern (and some -not-so-modern) distributions. It should also work on ANY platform for -which Python is available, but the gnue.conf may need to be tweaked for -these platforms (i.e., MacOS, MS-Windows, et al.) -- especially the -LprCommand and similar options. +To install GNUe Forms from the source package, follow the procedure described +in the file `INSTALL'. + License ------- GNU Enterprise is free software. See the file `COPYING' for the terms and Modified: trunk/gnue-reports/TODO =================================================================== --- trunk/gnue-reports/TODO 2009-12-05 20:38:16 UTC (rev 10091) +++ trunk/gnue-reports/TODO 2009-12-05 20:54:52 UTC (rev 10092) @@ -31,22 +31,3 @@ * Much work on the server side ( report definition directories, output dirs., assynchron report processing, scheduler support) - -ROADMAP - - - -0.1.0 - Trigger Support - -0.2.0 - Universal Report Markup - Format Mask Support - -0.3.0 - SortOptions ?? - Formula Support - -?.?.? - Start transformation sheets - Formula Support Deleted: trunk/gnue-reports/doc/Tech-Reference.sxw =================================================================== --- trunk/gnue-reports/doc/Tech-Reference.sxw 2009-12-05 20:38:16 UTC (rev 10091) +++ trunk/gnue-reports/doc/Tech-Reference.sxw 2009-12-05 20:54:52 UTC (rev 10092) @@ -1,26 +0,0 @@ -PK rF/á¥19 mimetypeapplication/vnd.sun.xml.writerPK rF/ content.xml¥]oÛ ï÷+Óvá.7M§ÒVª6ÕêJÛ%£að ÇÍ¿4kãLdÅâð÷^0¿zÉØ1m¸1¼!`(Êå6ÏÉmt ¯æëëä×ã -PiÊ QEÊI%{Ççï«»k #ÖkÞ"´L ¬Mpuºy ½µ.æÇÄ]ÒÌÂn3kBÊQ}¯ãñ 5lÝaÞ-nÙ¤k ñæ¶'Zj\ -Ò5à<oùTutUU£jâÉét~>ÐÒ9îzy\þ>ÊûÝe¾az¸lñ/f·}O<¸ëZ&ÖÃþy¢wdBO82¡-ì9à%ºwþç~ÕÛ§óAñèÎG4/;l§lLÃ<4±ÿP7Ê!uëÔMtDf1÷&÷Öçn®©Cª ¤8çbßÇ_åÜgÎkî'Pæ93àUàSoK| 2ßþÁBð nà£-LsCä;CïøÐpiå$ò¦7m£è~1¯Ýö§t÷ksßQn -÷* ¶c"îvóÛÁ;!Jcµ«©dÝÜYbI{ÄóTê:WdÙÜ%µßÇ]+B7; -OKµ»?'7À=¸zeJP¦A{3iÿÐzõÕÃDG®ùÅ_PK}¤2 PK rF/ - styles.xmlíXßoÛ6~ß_¡qØÞhÉNÜÚYkZ`@ÚKl´DYÜ$R )Ëé_¿#)J-Ë-ìiyH »ï~ðôÝñÛw»"¶T*&ø -M' -(EÂøf ^?âzw÷Ãí÷ïÿúò!iÊbz¸*(×XéתàËËo¿¿ÃÇòG¹ ÃûçûÀ=ß7F ÃQ»I¢tw{Â7dÈÕS®P¦uy¢.Ê,¢Ð=£ÆÀZâ-ÂÃ5ÝéQ´´`²>ãÛ"<<¤E TÜãSÑ¢ëºÔW9].áOáG!Òæ²Ëÿç$Þj=WÅÊñL&½º¨ífȹ+à¶M9ίEt¹JÎTä*ñ`8lvâð(í¯O]ùd1êÜ ÚóÅã;òÜïuKËÚT cçêîÖ°î8óL2Q¤ÂRR°üµïÙLÇpð-̲)<ãÐ-iüøq_H)Ô¯0'ìÅux¼¡J¯tîÆ3êÐ\ûä*oºÛ;m2ÜHRf,VÈK /DjW@"¦X$Áì+%ù -EétzÍx¡øñ¢)O¾Ã÷zس;H¥(ODm bèD-+Ú«ìW©ØWPOg Ë ßTd"ê@±¨¸Pɧ#·(Fø Ó[¯vÎÒû÷:.xnjHÕ EQætw:hÛj*ÍÆ¤Ò¼¨K¨°¬Â$/³6ûÞÖJËÛØµdÚ¼ÌB$`K¬×-a¨mE©ß ÚzÿÖDãíÿ§ÏC8}öZf -õHI®úBøXÒ0ÍMÊJeg 9IÚê¹1R0ý.+ëÊ9¬A -WÛnç8îy Ñäz9ïO¬~#POs|ÛOà=!2A'ï_JN>¢¿7¢Òn¼º=YN·4oÉ*¬ hàªS»'ÐÇSÖ³¬¯.²¾¾Èz~õ¬ß^d½¸Èzyõ4:ed`*æBSíËS¶©¤mÁ?ÀEkáv-É+Óg°sëÓv´=¶oãöuÓÆÿ.jÈ·eÂ3ñ~Ì»P}gàvÙQíltJSEµ]xozãc¨îÄ9Mu£[¯ÔÄùþ>éÇæÑÌEðÉbÜß*Míp.Tö&PYLnUÈÖ¢fù¶XLܽ<£ļ#gò^ÜF°(Bî¤yBjI»d"a*c·`ÔFi¤k¡á< -Só 1jdÙdl\»½¥½.× >»öd5î¾(¢¥wèJM¢èm¯ -þÒÀk -Ű&vµ\ÂH -/å$WJ»÷îØàä¶É`6ÿ¹»»íÚóSdÐðæ$%æµáþ1÷áw:ÞQ8àý¡ñ4zî ÂA÷è~à=þÈÝ¿PK(ÊÇ ¸ PK rF/·<[" " meta.xml<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE office:document-meta PUBLIC "-//OpenOffice.org//DTD OfficeDocument 1.0//EN" "office.dtd"><office:document-meta xmlns:office="http://openoffice.org/2000/office" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:meta="http://openoffice.org/2000/meta" office:version="1.0"><office:meta><meta:generator>OpenOffice.org 1.1.0 (Linux)</meta:generator><!--645(Build:8669)--><meta:creation-date>2003-10-06T14:11:13</meta:creation-date><dc:date>2003-10-06T14:11:35</dc:date><dc:language>en-US</dc:language><meta:editing-cycles>2</meta:editing-cycles><meta:editing-duration>PT15S</meta:editing-duration><meta:user-defined meta:name="Info 1"/><meta:user-defined meta:name="Info 2"/><meta:user-defined meta:name="Info 3"/><meta:user-defined meta:name="Info 4"/><meta:document-statistic meta:table-count="0" meta:image-count="0" meta:object-count="0" meta:page-count="1" meta:paragraph-count="2" meta:word-count="5" meta:character-count="32"/></office:meta></office:document-meta>PK rF/ settings.xmlÍY[s¢H~ß_áòº&SS1Q¼EÞè ¦ Fd~ýFMfîfUª6U¡OçÒç7ß©-pÞJõsEªaê1?¤Á4g_¤oßn~o?é£Yÿ®Æ^^BõEò³s´i?Ö,½&ÉòSéSIwÎ@Û£vmuß^o«#Y¾ëI5ixîs_jÝìE)iúuµ|+Í9¿Ê2>ìOCQyu/7,IH_ßèó<?Ï/JÚz³ÙËÕ -©ÇèKüv]^Hübµ7Ù7"·nVäkà³ãHèS[?¦(M!Îß´víù~ôjÑÅÒf 1¬K-åFþðyÔüÂ+>ïÂm4¾\5Ãîà0ïº~u}uuøpÎrûàX#àtËÁJ-døp|Lç!ÁZÂò`£DÒ#8ñê9Y´ÇÌÇ'?P|R/±ÿñüwL¹GR|Î,KÔ'Â<-Gxç¾`º¬__º'ð/zýPÐ4t >y訧NS%¨½/âE:9Zc³h_6¹<Ûa,Ò¶ÍYr¸-¨<Îݰuå@`+b=}#ñ?Çä¾åuï&ù¹ººÉÄ¡4ÿʪú~%hÀ -1òªÉ}H-ÜÆ¢uÀÛyçøÐÑcñ]9xãAC%LÀáp¢³(Np*z»ui!Øà.s÷Ý#,´²@Lâ(&ð½ªcî£'Ñól;¸l£Ð[£Wa¬RQú¨&¨Ä/C®pá°\Í8[yEÒëÒ#U';½¥øêR)J -©ÈOÜhR éc0îtcÚÄÔÿåßXñÑ'ªê#\¬òF¿ªááë«;PÕaÔmÓPfCu©S -tÿSq¦ÝdÎs7ÚÀHæB°>ï¦Í¬?ѵÙ(zÔ[x&!ÞpzßgÓ%éÔ{wjNdiüå?÷Wìo+ùC[Mõ<û\³Y8æ$÷Í ùø}pïuz©óìè~Zo i¯ÄÚÝ Ñ2]²âÁlêq\9£øÑy¶ ªjÆuïÂæèduì eÚ\/Ôøì¹KA×I2«}·x©¹eÖyi¤8t]UÁ>f·ùj´%ë4² -ñL5KªøH»¾Ú®»ñµ¥«Áæ´Ö{0µK½-ô ö|ÅlE»dvaÇnCÜ;IAæ8pÀï|ðA8`wg:66ôr-²LNðDÈ×¾²xoò©9m|Ï ßå»ëÃðe[>ß«ãÌÝÎx 6÷¢q0k4¹;½¼Æ$ûÌÁ¾¯jäj+EOÕÊH?êéOõºü -à¯VÆëSUÈóT¼ó3`Î|&²ÅÄÞ¸æ$òõ%øÏસj:o6˳h¼ëw{D -P)e¼ìgö×ôËǤ§8i#NÁ¿Ê<D<Y½y¢:aiÅ\01 sÙ¼¾]VåÖJïqBÕ4D´Qgå©WÑ90 PwÅ}±Ñ³$s çK\,K¼N¼¸åO×ÄÞÇÉd3µâ$ôjkÊ#âÎ@Ëý|>+k9¬VÔ=YérñWVÓanE*rè«*kÆ0~V o&(^íæ¯ÎSR¨¿cB:æÈÚ«-cPÁ²msmSqrþQCL5ä½ ËèÞõÔV;.æÚ ÊË©¿\#`ÚþCJÀÞòßä}¿´þPKÐ ¡ ¶ PK rF/ META-INF/manifest.xmlÒ±jÃ0à½O¡ÞnÓ©;Ä)ÚÚ3tö9ذÎiüöUÇ d dÄÝw¿àõ¹kÅz¯Ia!cd*[ksHa_¾E¯°^=%ÏY¾-¿èÑ -y^NQì7ï[bîÈäM£+¶? fe&>§º`#î¾@Àô$k®!à×feüåÂÙ-mðíì¿Äñ§¢ YjtKîÇ©Ö*âÑQ -ʹVWïñdjé#ÃPùÓk¦æ¦fhÛÈ)>¦w͸ºâ¡'¯Ætfo«5ÿþðP×óØ8Û«Çg%æ°¶´ ^-ÖêPKGþ ð PK rF/á¥19 mimetypePK rF/}¤2 D content.xmlPK rF/(ÊÇ ¸ - styles.xmlPK rF/·<[" " p meta.xmlPK rF/Ð ¡ ¶ ¸ settings.xmlPK rF/Gþ ð META-INF/manifest.xmlPK Z Ô \ No newline at end of file Modified: trunk/gnue-reports/setup.py =================================================================== --- trunk/gnue-reports/setup.py 2009-12-05 20:38:16 UTC (rev 10091) +++ trunk/gnue-reports/setup.py 2009-12-05 20:54:52 UTC (rev 10092) @@ -72,11 +72,9 @@ docfiles = self.allfiles ("doc") samp01files = self.allfiles ("samples/cross-tabulation") samp02files = self.allfiles ("samples/dcl") - samp03files = self.allfiles ("samples/docbook") - samp04files = self.allfiles ("samples/foobulations") - samp05files = self.allfiles ("samples/labels") - samp06files = self.allfiles ("samples/location") - samp07files = self.allfiles ("samples/mailmerge") + samp03files = self.allfiles ("samples/foobulations") + samp04files = self.allfiles ("samples/labels") + samp05files = self.allfiles ("samples/mailmerge") params ["data_files"] = \ [("share/gnue/filters/Labels", filterLabels), @@ -86,11 +84,9 @@ ("share/doc/gnue-reports", docfiles), ("share/doc/gnue-reports/examples/cross-tabulation", samp01files), ("share/doc/gnue-reports/examples/dcl", samp02files), - ("share/doc/gnue-reports/examples/docbook", samp03files), - ("share/doc/gnue-reports/examples/foobulations", samp04files), - ("share/doc/gnue-reports/examples/labels", samp05files), - ("share/doc/gnue-reports/examples/location", samp06files), - ("share/doc/gnue-reports/examples/mailmerge", samp07files)] + ("share/doc/gnue-reports/examples/foobulations", samp03files), + ("share/doc/gnue-reports/examples/labels", samp04files), + ("share/doc/gnue-reports/examples/mailmerge", samp05files)] params ["config_files"] = [("", ["etc/report-filters.conf"])]