Changes

Jump to: navigation, search

Addon:DescendantsLines

13,304 bytes added, 17 January
no edit summary
  {{Third-party plugin}}[[File:DescendantsLines GalileoGenealogy.png|thumb|right|450px|Descendants Lines - Galileo Galilei's Genealogy example]]The {{man label|Descendants Lines}} Graphical Report addon generates a graphical descendants tree using orthogonal edges and routing ("square edges") in vertical mode only in which children in a family are ordered from left to right following the Gramps child order; and families are ordered right to left, top to bottom, following the Gramps family order. == Usage == * Open Gramps* Select the report using the menu option {{man menu|Reports -> Graphical Reports -> Descendants Lines...}}* On the Report Options tab choose the output path for the {{man label|Destination:}} <code>$GRAMPSHOME/Descendants Lines.png</code>(default).** Note: That ''Document Options'' {{man label|Filename:}} option will contain an empty file after the report is run.* Note: If the script is run in "debug mode" it generates copious terminal output such as "Unknown event type: ..." or "Unknown spouse: ...". These warnings are harmless. === Options === {{man label|Descendants Lines}} has the following option tabs available to change: ==== Paper Options ====See also [[Gramps_{{man version}}_Wiki_Manual_-_Reports - part 4#Common options|common options]]{{-}}==== Report Options ====[[File:DescendatsLines1_report.png|thumb|right|450px|Report Options]]* {{man label|Center Person:}}* {{man label|Output format:}} - The output format (PNG, SVG, PDF or PS)* {{man label|Destination:}} <code>$GRAMPSHOME/Descendants Lines.png</code>(default). The output filename* {{man label|Generations:}} - Maximum number of generations to include. (0 for unlimited)** {{man label|[ ] Use d'Aboville descendant numbering System}} - Whether to use [[Genealogical Numbering Systems#d'aboville|d'Aboville]] descendant numbering system.** {{man label|[ ] Include an image}}* {{man label|Max Image height:}}* {{man label|Max Image width:}}* {{man label|Image Location:}}{{-}} ==== Report Options(2) ====[[File:DescendatsLines2_report2.png|thumb|right|450px|Report Options (2)]]* {{man label|[ ] Colour Name by Gender}} - Whether to use colored names indicating person gender in the output.* {{man label|[ ] Use alternate events if primary events are not found}} - for example, if there is no Birth event, a Baptism or Christening event may be substituted. For Death Events, a Burial may be substituted.* {{man label|[ ] Sort Events by Date}}* {{man label|Text Style:}} - The predefined output style* {{man label|Maximum Note Length:}} - limits the length of notes.{{-}} ==== Display Options ====[[File:DescendatsLines3_display.png|thumb|right|450px|Display Options]]* {{man label|[ ] Box around Person's block}}* {{man label|[ ] All Person's blocks have the same height}}* {{man label|[ ] All Person's blocks have the same width}}* {{man label|[ ] Colour blocks by Generation}}* {{man label|Descend block colour intensity:}}* {{man label|Spouse block colour intensity:}}{{-}} ==== Display Formats ====[[File:DescendatsLines4_display-formats.png|thumb|right|450px|Display Formats]]* {{man label|Name Display Format:}} - The name format. See [[Gramps_{{Version manual}}_Wiki_Manual_-_Reports_-_part_2|Formatting]] for more detail. * {{man label|Descendant Display Format:}} - the default settings provide for several event types and their dates and places. By changing the contents of this box, you can elect to include Events of various types, and include the dates or places and their format. See [[Gramps_{{Version manual}}_Wiki_Manual_-_Reports_-_part_2|Formatting]] for more detail.* {{man label|Spouse Display Format:}} - the default settings provide for several event types and their dates and places. By changing the contents of this box, you can elect to include Events of various types, and include the dates or places and their format. See [[Gramps_{{Version manual}}_Wiki_Manual_-_Reports_-_part_2|Formatting]] for more detail.{{-}}  ==== Replace Options ====[[File:DescendatsLines5_replace.png|thumb|right|450px|Replace Options]]* {{man label|Replace Display Format 'Replace this'/'with this':}} ie: United States of America/USA{{-}} ==== Spouse and Family Options ====[[File:DescendatsLines6_spouse.png|thumb|right|450px|Spouse and Family Options]]* {{man label|Vertical edge descendant to spouse-bar}}* {{man label|Vertical edge spouse-bar to spouse}}* {{man label|Vertical space spouse-bar to other spouse}}* {{man label|Horizontal space descendant to spouse}}* {{man label|Horizontal space family to family}}* {{man label|Horizontal distance spouse to family edge}}{{-}} ==== Children Options ====[[File:DescendatsLines7_children.png|thumb|right|450px|Children Options]]* {{man label|OL_PAD}} - The number of ??? pad* {{man label|Vertical edge spouse-bar to child-bar}}* {{man label|Children distance}}* {{man label|Vertical edge child to child-bar}}* {{man label|MIN_C_WIDTH}}* {{man label|Space around text}}* {{man label|Space between lines of text}}{{-}} ==== Header and Footer Options ====[[File:DescendatsLines8_header.png|thumb|right|450px|Header and Footer Options]]* {{man label|Title text}}* {{man label|Footer text}}* {{man label|Title and footer coefficient}}{{-}} ==== Privacy Options ====[[File:DescendatsLines9_privacy.png|thumb|right|450px|Privacy Options]]* {{man label|[ ] Protect People, Images or Events that are marked Private}}* {{man label|Privacy text:}} <code>Private</code>(default){{-}} === Examples ===[[File:DescendantsLines.png|thumb|right|450px|Lines of descendants chart]][[File:DescendantsLines-m-ep-.png|thumb|right|450px|DescendantsLines, Left-aligned text style, example Gramps data, inc_marriages and inc_places.]][[File:JohnShakespeare-DescendantsLines.png|thumb|right|450px|Shakespeare family tree, DescendantsLines, inc_marriages]][[File:JohnShakespeare-DescendantsLines-ep.png|thumb|right|450px|Shakespeare family tree, DescendantsLines, Left-aligned text style, including event places]]* [[File:DescendantsLines-m-ep.pdf]] -- DescendantsLines, example Gramps data, inc_marriages and inc_places, PDF output.* [[File:DescendantsLines-left.pdf]] -- DescendantsLines, Left-aligned text style, example Gramps data, use_colors, inc_marriages and inc_places, PDF output.* [[File:Charlemagne-DescendantsLines.pdf]] -- DescendantsLines addon, inc_marriages and inc_places, PDF output, presenting a family tree of Charlemagne starting from Chloderic King of Cologne.* [[File:PepinOfHerstal-DescendantsLines-left-dnum.pdf]] --DescendantsLines Gramps addon, Left-aligned text style, d'Aboville numbering (inc_dnum), descendants of Pepin of Herstal or Pepin II, PDF output. Data from Charlemagne GEDCOM at [http://www.genealogyforum.com/gedcom/gedr1434.htm] [https://web.archive.org/web/20081203144416/http://www.genealogyforum.com/gedcom/gedr1434.htm] === Tree compression and or modification===SVG format trees can be compressed and or modified manually using the program Inkscape, using the select and path tools; or using other SVG manipulating program. PNG format trees can be compressed manually by manipulating the image. == Development ==There is an in-development migration of this Gtk/cairo code to a draw plugin working into Gramps (font, style, path, canvas, output formats). This migration, DescendantsLines, does not use the Document interface of Gramps. Draft version is available on [[Addons_development|Addons]] repository. [https://github.com/gramps-project/addons-source/tree/master/DescendantsLines addons-source/tree/master/DescendantsLines] The idea is keeping Gramps XML parsing, but with a copy of the active database and use of current report environment (output formats, style, path). === Ideas ===Feel free to contribute or improve DescendantsLines. * This addon may with time become a general orthogonal family tree drawing resource for Gramps, for a View, etc., and outside Gramps as well. The PyCairo code can be connected to a view.* Think of optional tree compression algorithms.* Add option to include divorces.* Add option to include spouse parents.* Add option to include spouse ancestries.** Add option to include arbitrary spouse ancestries.* Add option to include arbitrary ancestries.* Add option to include notes.* Add option to include sources.* Add option to include images.* Add horizontal mode.* Add optional text wrap width.* Add optional text width with use of ellipses.* Cairo provides hyperlink support. Names could be hyperlinks to html complete individual reports or to web report pages.* The hardcoded number option limits can be altered by users, by altering the code. ==== Command Line Interface ==== Gramps provides a cli support for running reports and tools [[Gramps {{Version manual}} Wiki Manual - Command Line]]. * {{bug|4114}}: Would like to use stdin and stdout for command line import/export. === Current limitations ===* The addon DescendantsLines does not use the Gramps document interface (''Document Options''). (perhaps the Gramps document interface options should be hidden)* DestinationOption does not have the usual error handling and user checking (e.g. for overwriting files)* Partial quoting of xml-syntax-like data. Data which resembles xml syntax (tags, etc) may cause error.* Script ignores role on event (was added in 2007)* Script ignores localized date handlers (using ISO date format, date quality in english)* Memory limitation with a large database (DOM parsing)* The last pixel column of each secondary line of each entry is wrong coloured (red instead black)* Size limit: Cairo surface size limit. (32767 for height and 32767 for width [http://comments.gmane.org/gmane.comp.lib.cairo/21068])* Some PDF output size limit (currently crossing this limit will result in an empty PDF file) === Needs === ==== Pass 1: generate a tmp XML with only data needed for the report, to load it as input ==== # Enable Person selection (Gramps ID) - ''done''# Generate a temp Gramps XML database matching 'IsDescendantFamilyOf' filter rule - ''done''# Input path - ''done'' (need to set ''@[email protected]'': ''path_to_SVN/src'' on ''const.py'')# Clean-up - ''done''  * simple Gramps XML template with events, persons, families objects (only export primary event role reference).<!--* key/filter issues remain, currently export all persons to XML file.-->* 'localized' dates (does not follow last DTD, which uses english and ISO format).<!--* a basic persons list print for draw report: this avoids empty returns when generating the report and could help to check what is missing (see above).* output path and format are hardcoded: $GRAMPSHOME/DescendantsLines.png .--> '''FINISHED''' - it works fine! ==== Pass 2: use draw report environment ==== # Generate a plugins/docgen/PNGDrawDoc.py file {{bug|4447}}# Move Gtk code to draw report (if possible)#REDIRECTMove cairo code to draw report (if possible)# Output path# Clean-up, pylint, etc ... ==== Pass 2 (Alternate): use of user-defined (mega)-widgets ==== # Have a look at mega-widget request and implementation {{bug|2393}}# Output path through mega-widget# Clean-up, pylint, etc ...  ==== Pass 2 (Alternate): use a DestinationOption ==== # Use a DestinationOption# Ignore standard Filename option {{bug|5545}} === Development History ===*2007: Adam Sampson created a standalone python script for parsing data.gramps ([[Gramps XML]]). [http://offog.org/darcs/misccode/familytree][https://web.archive.org/web/20150915215133/http://offog.org/git/misccode/familytree]*2010: this script needs some updates for avoiding minor issues. A modified script is available from the sourceforge addons repository. [https://sourceforge.net/p/gramps-addons/code/HEAD/tree/trunk/contrib/DescendantsLines/] === Libraries ===The program DescendantsLines, as the script in which it is based, is written in Python, using the following prerequistes PyCairo and the Python XML library. Many Gramps modules are also used. == Issues ==* See [[Addon:DescendantsLines#Current_limitations|Current limitations]] * {{bug|5545}} Add a way for CATEGORY_DRAW reports to turn Gramps Document Interface Options off* {{bug|5823}} DescendentsLines does not display a marriage date when one spouse is unknown* {{bug|5965}} report produced with stale name from previous gramps session* {{bug|10390}} Display options in DescendantsLinesgraphical report do not work as advertised * Help button does not link here. See: [https://gramps-project.org/bugs/tag_view_page.php?tag_id=275 Tag: DescendantsLines] on Bugtracker ===inc_marriages option?===This page mentions a "inc_marriages" option but none of the option tabs have that setting , was it removed? Or is it now called "Spouse Display Format" {{man tip|There are option and tree combinations which may generate overlapping edges and nodes.|If using the <code>inc_marriages</code> option the <code>[[Addon:DescendantsLines#S_.26_F_Options|S_DOWN - S_UP]]</code> difference may need to be increased by 5-15 units depending on the tree.}} == See also ==* [[Addon:Family Tree]] - generates horizontal orthogonal graphical trees.* [[Addon:TimelinePedigreeView]] - displays horizontal orthogonal graphical trees. [[Category:Plugins]][[Category:Developers/General]][[Category:Reports]]
1,527
edits

Navigation menu