Changes

[[Category:Plugins]][[Category:Developers/General]] ''This is a [[{{Third-party Pluginsplugin}}{{man tip|This addon|Third-party plugin]]. Currently, this is more of a proof-of-concept than a fully featured pluginaddon. This plugin addon is still useful given the limitations specified below.'' == Description ==<br>Source code for Gramps 3.4 available here: https://sourceforge.net/p/gramps-addons/code/HEAD/tree/branches/gramps34/contrib/FilteredReports/}}

The ''{{man label|Filtered Descendant Report'' }} is directly based on the ''{{man label|[[Gramps_{{Version manual}}_Wiki_Manual_-_Reports_-_part_6#Detailed_Descendant_Report|Detailed Descendant Report'']]}}. As such, itincludes all the options ''Detailed Descendant Report'' (which make sense) in addition to some new ones. Because multiplefamily branches can be included, the Henry and d'Aboville numbering systems may not be as usefuloptions were removed (considering that people common to more than one branch will get the number assigned to them when theyare first found). These numbering systems should probably be removed at some point.

The main difference is that a filter can be used to determine who to include in the report (so thatyou can have several family branches) instead of basing all the descendants from a single person. Thekey is to find at least one common person to all the rules in the filter. If at least one commonperson is found, the generations can be aligned so that it doesn't matter if the head of each branchis in the same generation.

In order to support this report, enhanced versions of some of the Gramps code is included so as tonot require modifications of the Gramps core itself. Hopefully, the The enhanced changes will find are finding theirway into the core, in which case they would be removed from so it's only a matter of time until this pluginwill no longer need to ship those changes. A list of enhancements canbe found after the list of differences.

{{man warn|'''CAVEAT''': in order for |the plugin UI filter is meant to work correctlybe an OR filter (At least one rule must apply), meaning that we are expecting the patch from bug #4593 needs report to be applied (untilconsist of one or more family branches, where each rule dictates the version start of Gramps with the change is released)a branch. This patch isn't necessary for the plugin to has NOT been stress tested over different varieties of rules. It does work,just for the case where changing with one or more rules and will treat the filter updates the Title fieldas if 'At least one rule must apply' is set (even if not). Seehttp://www.gramps-project.org/bugs/view.php?id=4593The plugin will complain if no common people are found across all rules.}}

{{man warn|'''CAVEAT''': |the filter only supported output file format currently is meant to be an OR filter (At least one rule must apply), meaning that we areexpecting ''OpenDocument Text Enhanced''. Running the report to consist of one or more family branches, where each rule dictates the start of a branch.This plugin has NOT been stress tested over different varieties of rules. It does work with one or morerules and any other output format will treat cause an error (because the filter as if other format backends haven'At least one rule must apply' is set (even if nott been updated to support the needed enhancements). The pluginwill complain if no common people are found across all rules.}}

{{man warn|'''CAVEAT''': |this is a second version, and as such has much missing that people might want. One obvious one is support for ALL backend report formats, not just ODF. Also, not currently possible to get the photo date to put into the caption. Also, no translation for messages (everything is currently English-only supported output file format currently ). This version is ''OpenDocument Text Enhanced''being released for Gramps v3. Runningthe plugin with 3 and to see if there is any other output format will cause an error (because the other format backends haven'tbeen updated interest outside myself :-&#x007b;}, and possibly to support get my enhancement changes into the needed enhancements)core if they seem useful.}}

== Differences ==from {{man label|Detailed Descendant Report}} are as follows:

As explained above, the filter can have one or more rules to allow multiple branches to be in the samereport. A person, common to ALL rules will align the generations. If no common person is found, anerror will be issued.

An added option allows the user to specify the report title. For ''Detailed Descendant Report'', thisis automatically set based on the name of the 'Center Person'. For ''Filtered Descendant Report'', this isautomatically set to the name of the selected filter, but can be overridden by the user.

This option (on the '''Content''' tab) tells the plugin whether to turn any http, https, or mailto links foundin text (i.e. notes, endnotes, etc.) to be real clickable links. Turning this option off results in thebehavior found in ''Detailed Descendant Report'' (that is, no URLs are made clickable). Turning it on willcause those URLs found to be clickable in the output file (if possible).

This option (on the '''Content''' tab) tells the plugin whether to add information to the report that hasbeen marked 'private'. Turning this option off results in the behavior found in''Detailed Descendant Report'' (that is, all information is included in the report). Turning it onwill cause the plugin to NOT include anything marked private. After all, what good is the private

This option (on the new '''Caption''' tab) specifies what should be in photo captions. The following variablesare available:  $c - FirstName LastName (excludes middle name if there is one) $C - LastNameFor full details on what can be specified, FirstName (excludes middle name if there is one) $p see the [[Gramps_{{Version manual}}_Wiki_Manual_- Photo date $P _Reports_- Photo date surround by parenthesis The difference between $p and $P is that if the caption "($p)" is specified and there is nodate for a given photo, you will wind up with "()", whereas $P would be a blank string (no empty parenthesis). '''CAVEAT''': currently, $p and $P display the date in U.S. format, that is "Month, Day Year" (depending on what'savailable) and ONLY when there is a single date (not span or range for example)_part_2|Substitution Values]] wiki page.

Images now appear in the report document exactly how they appear within the Gramps UI. That is, if an imagehas been cropped, it will be cropped the same way in the report. The ''Detailed Descendant Report''behavior was to just insert the image so that the report showed the entire image.

Turned image manipulation functions into a real class so that an image file only needs to be openedonce (instead of everytime every time an ImgManip function is called). Also added a method to return the imageDPI (if available). This supports showing cropped images in the report file.

=== SubstKeywords ===[[Category:Plugins]][[Category:Developers/General]]Added support for the following variables[[Category:  $c -> Name - FirstName LastName (NO middle name) $C -> Name - LastName, FirstName (NO middle name) $p -> Date of preferred photo $P -> Date of preferred photo surrounded by parenthesisReports]]