From: Alex R. <sh...@al...> - 2005-01-15 05:30:52
|
Hello, After some month of trying and failing, the transition to the improved report framework is mostly finished in HEAD. The new framework offers the following features: 1. Simpler API (application programming interface) for writing reports. In short, contributing the report is so much easier, now that a lot of common code has been factored out from plugins into the core of Gramp= s. A pair of classes with defined API can make your report automatically available as a standalone reprot, a book item, and a command-line report. 2. Report options are persistent. The options for each report are saved upon pressing OK in the report dialog, and are retireved next time you are using this report. If report has never been used, some options are initialized from the last used report (of different kind), as appropriate. 3. Options storage/retrieval is seamless across standalone reports and the book items. In other words, whatever options you have last used with TimeLine graph as a standalone report, same options will be recalled when you add TimeLine item to the book report. 4. Command line reports are now reailty! Options can be given to reports on the command line. Options that are not given are recalled from the last used options in the UI mode. At this time, all the reports should be working in HEAD. Any problems except for some issues below should be considered bugs and filed without mercy :-) Please give it a try, and post your feedback. The plan is to make a development release sometime soon after this weekend, so if something is terribly wrong please speak now! Remarks ------- 0. If you have older report_options.xml and books.xml in your ~/.gramps directory, you will need to move them elsewhere. Both have changed, and having old incompatible files can bring problems. 1. Custom paper sizes are not supported from the command line, and are not presistent. The named sizes should be all supported. 2. RelGraph.py is removed from CVS. There used to be two plugins providing similar versions of the same Relationship Graph: RelGraph and GraphViz. Now GraphViz is the only one left. Most of the extra options from RelGra= ph are now in GraphViz, except for the 'show family as stack' option. 3. The aforementioned GraphViz now registers itself both as a code generator producing the dot file, and (if the dot exectuable is found on the syste= m) as a graphical report producing picture (via running dot behind the scen= e). Same code is used to generate the report. =20 4. Command-line reports fall back to options saved from the UI runs, but running the command-line report does not save options. 5. To generate command-line reports, use the following calls: $ gramps -i your_datafile -a report -p option_str where 'option_str' is the string without spaces (or they must be quoted) listing name=3Dvalue pairs separated by comas. =20 A mandatory option is the report name. To find out the list of available names, try using any string e.g. "name=3Dblah". To find out what options= a particular report supports, use "name=3Dreport_name,show=3Dall" string. Finally, to find out what a particular option does and what the available values are, use the "name=3Dreportname,show=3Doption_name" string. 6. The external documentation about report options has been prepared before by Frode Jemtland, and that was an excellent start. In the course of transition, some changes have been made. Frode, if you could bring your superb reference up to date it would be great! I will send you a separate mail with the details of changes shortly. Thanks, Alex --=20 Alexander Roitman http://ebner.neuroscience.umn.edu/people/alex.html Dept. of Neuroscience, Lions Research Building 2001 6th Street SE, Minneapolis, MN 55455 Tel (612) 625-7566 FAX (612) 626-9201 |
From: Eero T. <eer...@ne...> - 2005-01-15 10:39:00
|
Hi, > After some month of trying and failing, the transition to the improved > report framework is mostly finished in HEAD. > > The new framework offers the following features: > > 1. Simpler API (application programming interface) for writing reports. > In short, contributing the report is so much easier, now that a lot > of common code has been factored out from plugins into the core of > Gramps. A pair of classes with defined API can make your report > automatically available as a standalone reprot, a book item, and a > command-line report. > > 2. Report options are persistent. The options for each report are saved > upon pressing OK in the report dialog, and are retireved next time > you are using this report. If report has never been used, some options > are initialized from the last used report (of different kind), as > appropriate. > > 3. Options storage/retrieval is seamless across standalone reports and > the book items. In other words, whatever options you have last used > with TimeLine graph as a standalone report, same options will be > recalled when you add TimeLine item to the book report. Is it possible to use same report multiple times in a Book, but with different options for each instance? I.e. are the last standalone report options used only as "defaults" for the book options? > 4. Command line reports are now reality! Options can be given to reports > on the command line. Options that are not given are recalled from the > last used options in the UI mode. > > At this time, all the reports should be working in HEAD. Any problems > except for some issues below should be considered bugs and filed without > mercy :-) Please give it a try, and post your feedback. The plan is to > make a development release sometime soon after this weekend, so if > something is terribly wrong please speak now! When I tested them a while ago, reports offered HTML stylesheet selection for formats that were not HTML (instead of paper options). > Remarks > ------- > 0. If you have older report_options.xml and books.xml in your ~/.gramps > directory, you will need to move them elsewhere. Both have changed, > and having old incompatible files can bring problems. > > 1. Custom paper sizes are not supported from the command line, and are > not persistent. The named sizes should be all supported. > > 2. RelGraph.py is removed from CVS. There used to be two plugins > providing similar versions of the same Relationship Graph: RelGraph and > GraphViz. Now GraphViz is the only one left. Most of the extra options > from RelGraph are now in GraphViz, except for the 'show family as stack' > option. If anybody has some wishes for this, I've thougth to fiddle a bit with it: - Move content options to separate frame from layout options - Add two more layout options supported by Graphviz > 3. The aforementioned GraphViz now registers itself both as a code > generator producing the dot file, and (if the dot exectuable is found on > the system) as a graphical report producing picture (via running dot > behind the scene). Same code is used to generate the report. > > 4. Command-line reports fall back to options saved from the UI runs, > but running the command-line report does not save options. > > 5. To generate command-line reports, use the following calls: > $ gramps -i your_datafile -a report -p option_str > where 'option_str' is the string without spaces (or they must be > quoted) listing name=value pairs separated by comas. Is it possible to give lists for multiple selectable items, or should each item have a separate option? (This is for the StatisticsChart improvement suggested by Don.) > A mandatory option is the report name. To find out the list of > available names, try using any string e.g. "name=blah". To find out what > options a particular report supports, use "name=report_name,show=all" > string. Finally, to find out what a particular option does and what the > available values are, use the "name=reportname,show=option_name" string. > > 6. The external documentation about report options has been prepared > before by Frode Jemtland, and that was an excellent start. In the course > of transition, some changes have been made. Frode, if you could bring > your superb reference up to date it would be great! I will send you a > separate mail with the details of changes shortly. - Eero |
From: Don A. <don...@co...> - 2005-01-15 16:02:37
|
Eero, > > 2. RelGraph.py is removed from CVS. There used to be two plugins > > providing similar versions of the same Relationship Graph: RelGraph and > > GraphViz. Now GraphViz is the only one left. Most of the extra options > > from RelGraph are now in GraphViz, except for the 'show family as stack' > > option. > > If anybody has some wishes for this, I've thougth to fiddle a bit with it: > - Move content options to separate frame from layout options > - Add two more layout options supported by Graphviz I'm sure that no one would object to this :-) > Is it possible to give lists for multiple selectable items, or should each > item have a separate option? (This is for the StatisticsChart improvement > suggested by Don.) > I'll see if I can come up with a control for this. Don |
From: Eero T. <eer...@ne...> - 2005-01-18 21:09:21
|
Hi, > > > 2. RelGraph.py is removed from CVS. There used to be two plugins > > > providing similar versions of the same Relationship Graph: RelGraph > > > and GraphViz. Now GraphViz is the only one left. Most of the extra > > > options from RelGraph are now in GraphViz, except for the 'show > > > family as stack' option. > > > > If anybody has some wishes for this, I've thougth to fiddle a bit with > > it: > > - Move content options to separate frame from layout options > > - Add two more layout options supported by Graphviz > > I'm sure that no one would object to this :-) I've now commited the following changes to the GraphViz report. Changes visible only to developers: - Remade option lists, there's now a new class that keeps them - Moved lists from different places in code to the new class User (GUI or command line) visible changes: - Content options are now on the Report tab, Layout/looks options are left to GraphViz tab - Added 'rankdir' option for graph direction and 'latin' option for fonts (visible only on command line, in GUI it's taken from selected pre-defined font and set whether labels need utf8->latin1 conversion) - Changed 'colorize' option to support color filling in addition to just outline color (nicer for on-screen docs) - Changed the options defaults slightly (e.g. "Default" font is now default, this is a bit contraversial) - Non-blood relation line changed from dashed to dotted - Changed three option names to be more understandable (on command line and in options_dict in code): - sfn -> showfamilies - repb -> placecause - incda -> incdate Yell now, if you're not happy e.g. with the font default option... More testing wouldn't hurt either. :) - Eero |
From: James A. T. <tr...@de...> - 2005-01-15 16:15:11
|
On Fri, Jan 14, 2005 at 11:30:49PM -0600, Alex Roitman wrote: > After some month of trying and failing, the transition to the improved > report framework is mostly finished in HEAD. This is great work Alex. Thanks. Any Debian (sid, testing) users out there can try out the latest features can install the package from http://people.debian.org/~treacy/gramps1.1/gramps_1.1-cvs.2005.01.15_all.deb Enjoy -- James (Jay) Treacy tr...@de... |
From: Alex R. <sh...@al...> - 2005-01-15 17:19:16
|
Eero, On Sat, Jan 15, 2005 at 12:51:17PM +0200, Eero Tamminen wrote: > > Is it possible to use same report multiple times in a Book, but with > different options for each instance? I.e. are the last standalone repor= t=20 > options used only as "defaults" for the book options? Yes, you can include as many instances of a single item into book as you want, all of them with different options. The last used options (from standalone _or_ another book item uses of this report) will be used to initialize the options. Then you may override them using the UI controls. > When I tested them a while ago, reports offered HTML stylesheet selection > for formats that were not HTML (instead of paper options). Oops -- this is still true for some formats. Thanks for reminding me, I should fix it. > Is it possible to give lists for multiple selectable items, or should eac= h=20 > item have a separate option? (This is for the StatisticsChart improvement > suggested by Don.) As I understand, you mean a way of selecting something like 'extract=3Dgender' and 'extract=3Dgender:name:age' , right? I'm already using coma as a separator, so we have to either use some other separator (colon?) or go with bit values: gender =3D 1 name =3D 2 age =3D 4 and so on, and give a single extract option of e.g. 'extract=3D7' for all of them. In this case, the user does not have to remember the numbers, as the plugin may calculate all posible combinations and print the value - explanation pairs for all of them. Which one makes more sense? Alex --=20 Alexander Roitman http://ebner.neuroscience.umn.edu/people/alex.html Dept. of Neuroscience, Lions Research Building 2001 6th Street SE, Minneapolis, MN 55455 Tel (612) 625-7566 FAX (612) 626-9201 |
From: Alex R. <sh...@al...> - 2005-01-15 20:24:55
|
On Sat, Jan 15, 2005 at 11:19:13AM -0600, Alex Roitman wrote: >=20 > > When I tested them a while ago, reports offered HTML stylesheet selecti= on > > for formats that were not HTML (instead of paper options). >=20 > Oops -- this is still true for some formats. Thanks for reminding me, > I should fix it. Should be fixed in CVS now. Alex --=20 Alexander Roitman http://ebner.neuroscience.umn.edu/people/alex.html Dept. of Neuroscience, Lions Research Building 2001 6th Street SE, Minneapolis, MN 55455 Tel (612) 625-7566 FAX (612) 626-9201 |
From: Eero T. <eer...@ne...> - 2005-01-16 11:46:00
|
Hi, > > > When I tested them a while ago, reports offered HTML stylesheet > > > selection for formats that were not HTML (instead of paper options). > > > > Oops -- this is still true for some formats. Thanks for reminding me, > > I should fix it. > > Should be fixed in CVS now. Verified! Could you look also into getting the viewer functionality to work again too, I mean the option to launch e.g. a PDF viewer automatically when format is PDF? Needing to use command line (or file manager) to check whether report was generated correctly is a minor inconvenience. :-) Some other problems I noticed with the reports in latest CVS version: - I need to select A4 as paper size in every report, selecting it in one report is not enough (and there's no Gramps preference for this). This works for orientation though... - In Family group report the title is written partially over the data. This happens at least when output is to PDF - Family Group report gave an error in OpenOffice 1.1.1 (SUSE 9.1): "Error reading document file <file name>: read error. Format error discovered in the file in sub-document content.xml at 62,25(row,col)" I was able to open (at last some) other reports though. I got also a Traceback from the "Comprehensive Ancestors" report: -------------- Traceback (most recent call last): File "/home/eero/garnome/share/gramps/docgen/PdfDoc.py", line 178, in close self.doc.build(self.story) File "/home/eero/garnome/share/gramps/docgen/PdfDoc.py", line 77, in build BaseDocTemplate.build(self,flowables) File "/usr/lib/python2.3/site-packages/reportlab/platypus/doctemplate.py", line 631, in build self.handle_flowable(flowables) File "/usr/lib/python2.3/site-packages/reportlab/platypus/doctemplate.py", line 573, in handle_flowable raise LayoutError("Flowable %s too large on page %d" % (f.identity(30), self.page)) LayoutError: Flowable <Table at 1103540940 1 rows x 3 cols> with cell(0,0) containing '<Paragraph at 1103541164>(no photo)' too large on page 4 ---------------- I used the example database for the testing. - Eero |
From: Eero T. <eer...@ne...> - 2005-01-15 20:31:55
|
Hi, > > Is it possible to give lists for multiple selectable items, or should > > each item have a separate option? (This is for the StatisticsChart > > improvement suggested by Don.) Don, I've decided to use checkboxes after all, I'll just put them onto a separate frame to save space like GraphViz does. > As I understand, you mean a way of selecting something like > 'extract=gender' and 'extract=gender:name:age' , right? Yes. > I'm already using comma as a separator, so we have to either use some > other separator (colon?) or go with bit values: > gender = 1 > name = 2 > age = 4 > and so on, and give a single extract option of e.g. 'extract=7' for > all of them. In this case, the user does not have to remember the > numbers, as the plugin may calculate all posible combinations and print > the value - explanation pairs for all of them. > > Which one makes more sense? Hm. Eventually the Statistics thing might have about dozen options for data items, so showing all the combinations (12!) wouldn't make sense. Requiring (command line) users to do bit-math could be annoying too. I guess I'll do this completely in the StatisticsChart module, and just give each multiselect option a different option name. Thanks! - Eero |
From: Alex R. <sh...@al...> - 2005-01-15 20:36:35
|
On Sat, Jan 15, 2005 at 10:44:19PM +0200, Eero Tamminen wrote: >=20 > Hm. Eventually the Statistics thing might have about dozen options for > data items, so showing all the combinations (12!) wouldn't make sense. > Requiring (command line) users to do bit-math could be annoying too. >=20 > I guess I'll do this completely in the StatisticsChart module, and just g= ive > each multiselect option a different option name. Sounds like a plan. This would be something like gender=3D1,age=3D0,name=3D1 etc, right? Alex --=20 Alexander Roitman http://ebner.neuroscience.umn.edu/people/alex.html Dept. of Neuroscience, Lions Research Building 2001 6th Street SE, Minneapolis, MN 55455 Tel (612) 625-7566 FAX (612) 626-9201 |
From: Eero T. <eer...@ne...> - 2005-01-15 21:42:34
|
Hi, > > Hm. Eventually the Statistics thing might have about dozen options for > > data items, so showing all the combinations (12!) wouldn't make sense. > > Requiring (command line) users to do bit-math could be annoying too. > > > > I guess I'll do this completely in the StatisticsChart module, and just > > give each multiselect option a different option name. > > Sounds like a plan. This would be something like > gender=1,age=0,name=1 > etc, right? Yes, I'll just add some common prefix to the names. As each one is going to have the effect that there's a new graph created in the report, the prefix is probably 'chart_'. :-) - Eero |