From: Alex R. <sh...@al...> - 2004-12-22 02:44:33
|
Hello world, I would like to announce that the result of two-month of lame work on the report options branch has finally resulted in merging changes back to HEAD. The goals of the changes were as follows: 1. Allow reports remembering their options. If one always uses certain paper size, format, and orientation, it might be annoying to set it everytime. More so for report-specific options which cannot be set in the overall Gramps' prefs. 2. Allow book items remember the options that were set in the corresponding item when the same standalone report was run. If you like standalone TimeLine report with certain options, chance are that you will also want to use them when generating TimeLine as a part of the book. 3. Allow command line reports. It was requested on numerous occasions and is indeed a sweet functionality. 4. While we're at it, simplify report plugin API to make writing new reports as easy as possible. While writing a report still requires knowledge of Python and the API for Gramps database and its objects, there's little now that one has to do to actually make it available as a standalone report, book item, and command line report. As of now, all of these seem to have been acomplished. The results can be seen in HEAD, although only two reports are converted to new scheme at this moment. The rest is to follow soon.=20 For the GUI user, things should look same as before, except the options are remembered from the last time. If a particular report has never been run before, some options will be set to the last-used options from any report (where it makes sense, e.g. paper size/format). The new command-line stuff will probably see more change in the future. So far errors are not handled gracefully, so missing a mandatory option will result in an error. It might not yet be clear which options are mandatory, and the man page and the Manual are not up to date yet, so don't even bother looking :-) In short, you need to give some data to gramps to enable command-line functionality. The reports are generated using '-a report' option. Options for reports are given using '-p option_string' where option string lists 'option_name=3Doption_value,opt_name2=3Dvalue2,name3=3Dvalue3'= etc. Some help is provided. Here are few examples: $ gramps -i example/gramps -a report Importing: file example/gramps, format gramps-xml. Performing action: report. Ignoring invalid options string. Report name not given. Please use name=3Dreportname $ gramps -i example/gramps -a report -p name=3Dwhatever Importing: file example/gramps, format gramps-xml. Performing action: report. Using options string: name=3Dwhatever Unknown report name. Available names are: book ftm_descendant_report timeline Cleaning up. Exiting. $ gramps -i example/gramps -a report -p name=3Dtimeline,show=3Dall Importing: file example/gramps, format gramps-xml. Performing action: report. Using options string: name=3Dtimeline,show=3Dall Available options: style off title of papero filter sortby template papers id Use 'show=3Doption' to see description and acceptable values Cleaning up. Exiting. As we stabilize the use of command line, the man page and manual will be brought up to date on this. In closing, I would like to give great thanks to Frode Jemtland for taking time and effort to document all the options that are used in the reports, and to Eero Tamminen for hepling with many a great advice as to how to simplify the report API. Please test this and post the bugs as you encounter them, as well as your suggestions, when you have a chance. I might stop responding in a couple of days, but will certainly be back in January. Happy holidays everybody, 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...> - 2004-12-22 02:51:22
|
On top of what I said a minute ago: Because of the changes, the ~/.gramps/books.xml file containing book definitions is no longer valid. If you have book definitions you'd like to keep and not re-create anew, copy it to a safe location and manually convert it to a new format. The new format is much clearer, since both name and the type of the data is explicitly stated. Alex On Tue, Dec 21, 2004 at 08:44:30PM -0600, Alex Roitman wrote: >=20 > I would like to announce that the result of two-month of lame work on the > report options branch has finally resulted in merging changes back to HEA= D. --=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: James A. T. <tr...@de...> - 2004-12-22 04:34:22
|
On Tue, Dec 21, 2004 at 08:44:30PM -0600, Alex Roitman wrote: > Please test this and post the bugs as you encounter them, as well as your > suggestions, when you have a chance. I might stop responding in a couple > of days, but will certainly be back in January. In the goal of making it easier for people to test all this cool stuff I have uploaded a debian package to http://people.debian.org/~treacy/gramps1.1/gramps_1.1-cvs.2004.12.21_all.deb Enjoy. -- James (Jay) Treacy tr...@de... |
From: Alex R. <sh...@al...> - 2004-12-22 04:57:02
|
James, On Tue, Dec 21, 2004 at 11:28:04PM -0500, James A. Treacy wrote: > On Tue, Dec 21, 2004 at 08:44:30PM -0600, Alex Roitman wrote: > > Please test this and post the bugs as you encounter them, as well as yo= ur > > suggestions, when you have a chance. I might stop responding in a couple > > of days, but will certainly be back in January. >=20 > In the goal of making it easier for people to test all this cool stuff I = have > uploaded a debian package to > http://people.debian.org/~treacy/gramps1.1/gramps_1.1-cvs.2004.12.21_all.= deb Great! I have just committed some changes to HEAD, so it might be worth it to rebuild the deb. Sorry for the hassle. 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 |