Difference between revisions of "Addon:Descendant and Detailed Descendant Book Reports"

From Gramps
Jump to: navigation, search
(Created page with "Category:Plugins Category:Developers/General ''This is a Third-party plugin. Currently, it is mostly feature complete but could do with some more...")
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Plugins]]
 
[[Category:Developers/General]]
 
 
 
''This is a [[Third-party Plugins|Third-party plugin]]. Currently, it is mostly feature complete but could do with some more extensive testing.
 
''This is a [[Third-party Plugins|Third-party plugin]]. Currently, it is mostly feature complete but could do with some more extensive testing.
 
+
<hr>
== Description ==
 
  
 
[[Image:DescendantBook.png|thumb|right|400px|Sample Descendant Book Dialog]]
 
[[Image:DescendantBook.png|thumb|right|400px|Sample Descendant Book Dialog]]
  
the "Descendant Books" plugin consists of two book type plugins. Descendant Book and Detailed Descendant Book.
+
The "Descendant Books" plugin consists of two book type plugins. Descendant Book and Detailed Descendant Book.
 
Both reports are based directly of Descendant Report and Detailed Descendant Report, the main difference being
 
Both reports are based directly of Descendant Report and Detailed Descendant Report, the main difference being
instead of just producung a report based of the Center Person, it allows for the use of a built in Query or
+
instead of just producing a report based on the Center Person, it allows for the use of a built in Query or
 
Custom query. This idea is to produce as many descendant reports as is required to satisfy inclusion of all
 
Custom query. This idea is to produce as many descendant reports as is required to satisfy inclusion of all
 
individuals within the given query.
 
individuals within the given query.
Line 19: Line 15:
 
As there is a potential to produce more than one report the best place to include these reports is under
 
As there is a potential to produce more than one report the best place to include these reports is under
 
Books. If more than one report is produced a table of contents is generated to show how many reports there are.
 
Books. If more than one report is produced a table of contents is generated to show how many reports there are.
 +
If one only report is produced, no table of contents are generated.
  
 
'''CAVEAT''': Whilst the report should work against Gramps 3.3. out of the box it hasn't been extensively tested.
 
'''CAVEAT''': Whilst the report should work against Gramps 3.3. out of the box it hasn't been extensively tested.
Most of testing/development is against Gramps trunk (3.4).
+
Most of testing/development is against 3.4. This has not been tested at all against trunk (3.5+), as I do not have a
 +
gtk3 system that I can test/develop on. If some kind soul wishes to take up the mantle on that front I'd very much
 +
appreciate it.
  
== Common Uses ==
+
== Common uses ==
 
To date my most common usage is :
 
To date my most common usage is :
  
Line 33: Line 32:
 
Again really useful to get a complete accurate picture of the entire family tree of an individual, pretty
 
Again really useful to get a complete accurate picture of the entire family tree of an individual, pretty
 
much includes all cousins of this person. Up to now to print this you would first have to determine all the
 
much includes all cousins of this person. Up to now to print this you would first have to determine all the
possible ancestors of this person, and then manually generate a descendant report for each of these ancesotrs.
+
possible ancestors of this person, and then manually generate a descendant report for each of these ancestors.
 
By running this report we get all these reports generated in one go and a table of contents to boot !!
 
By running this report we get all these reports generated in one go and a table of contents to boot !!
  
== Differences to Descendant Reports ===
+
== Differences to Descendant Reports ==
Some of these differences I would hope end up in Trunk/Core, as such there are bug/feature requets logged
+
Some of these differences I would hope end up in Trunk/Core, as such there are bug/feature requests logged for
 
these. If the bugs are marked resolved then they've been integrated and you can ignore the reference here,
 
these. If the bugs are marked resolved then they've been integrated and you can ignore the reference here,
 
or better still ping me to remove this reference or edit this page your self and remove it.
 
or better still ping me to remove this reference or edit this page your self and remove it.
  
 
=== Detailed Descendant Report, Incorrect number sequence and printing of duplicates ===
 
=== Detailed Descendant Report, Incorrect number sequence and printing of duplicates ===
See bug report http://www.gramps-project.org/bugs/view.php?id=5259
+
See bug report {{bug|5259}}
  
 
=== Descendant Report traceback referencing NoneType person ===
 
=== Descendant Report traceback referencing NoneType person ===
See bug report http://www.gramps-project.org/bugs/view.php?id=5252
+
See bug report {{bug|5252}}
  
 
[[Image:DetailedDescendantBook.png|thumb|right|400px|Sample Detailed Descendant Book Dialog]]
 
[[Image:DetailedDescendantBook.png|thumb|right|400px|Sample Detailed Descendant Book Dialog]]
Line 67: Line 66:
  
 
== TODO ==
 
== TODO ==
1) Addition of a title page
+
# Addition of a title page
 +
# Addition of page numbers to Table of Contents (PDF/ODF only)
 +
# If 2 can be done, then put page numbers in references as well.
  
2) Addition of page numbers to Table of Contents (PDF/ODF only)
+
[[Category:Plugins]]
 
+
[[Category:Developers/General]]
3) If 2 can be done, then why not have page numbers listed in Report References.
+
[[Category:Reports]]

Revision as of 09:23, 24 September 2012

This is a Third-party plugin. Currently, it is mostly feature complete but could do with some more extensive testing.


Sample Descendant Book Dialog

The "Descendant Books" plugin consists of two book type plugins. Descendant Book and Detailed Descendant Book. Both reports are based directly of Descendant Report and Detailed Descendant Report, the main difference being instead of just producing a report based on the Center Person, it allows for the use of a built in Query or Custom query. This idea is to produce as many descendant reports as is required to satisfy inclusion of all individuals within the given query.

If for instance "Entire Database" is chosen as the query to use. Then the entire database is traversed and a unique list of ancestors is determined and then a descendant report for each of these ancestors is produced.

As there is a potential to produce more than one report the best place to include these reports is under Books. If more than one report is produced a table of contents is generated to show how many reports there are. If one only report is produced, no table of contents are generated.

CAVEAT: Whilst the report should work against Gramps 3.3. out of the box it hasn't been extensively tested. Most of testing/development is against 3.4. This has not been tested at all against trunk (3.5+), as I do not have a gtk3 system that I can test/develop on. If some kind soul wishes to take up the mantle on that front I'd very much appreciate it.

Common uses

To date my most common usage is :

Entire Database

I find that running of either report using the Entire database is really useful for highlighting potential people in my database that I've not linked up, dangling tree elements etc.

Ancestors of <person>

Again really useful to get a complete accurate picture of the entire family tree of an individual, pretty much includes all cousins of this person. Up to now to print this you would first have to determine all the possible ancestors of this person, and then manually generate a descendant report for each of these ancestors. By running this report we get all these reports generated in one go and a table of contents to boot !!

Differences to Descendant Reports

Some of these differences I would hope end up in Trunk/Core, as such there are bug/feature requests logged for these. If the bugs are marked resolved then they've been integrated and you can ignore the reference here, or better still ping me to remove this reference or edit this page your self and remove it.

Detailed Descendant Report, Incorrect number sequence and printing of duplicates

See bug report 5259

Descendant Report traceback referencing NoneType person

See bug report 5252

Sample Detailed Descendant Book Dialog

Descendant Report, Suppress duplicate families

Depending on the filter chosen, a number of Descendant reports may be produced to generate the book, and as a result of this the exact same dependent family tree could get printed in more than one report. This is not an issue if only running one report, but for the purpose of this book it just means potential wasting of paper, and potential confusion. With this in mind, any report contained in the book after the first one which contains a family that has already been printed (including any/all descendants of that family), will not get printed in subsequent reports but instead will have a reference to the exact report and location in that report.

Detailed Descendant Report, Suppress duplicate individuals.

If an individual has been printed already in a previous report, instead of printing all that individuals details just provide a reference to the report and location in that report where their details can be seen. Kind of similar to the "Same as person" output seen at the moment, except it spans reports.

Detailed Descendant Report Report Reference Section

If an individual appears in more than one report, then a new section is printed under that person indicating all the reports this person appears in.

TODO

  1. Addition of a title page
  2. Addition of page numbers to Table of Contents (PDF/ODF only)
  3. If 2 can be done, then put page numbers in references as well.