15,534
edits
Changes
→Usage
{{Third-party plugin}}
[[Image:DescendantsLines.png|thumb|300pxright|450px|Lines of descendants chart]][[Image:DescendantsLines-m-ep-.png|thumb|300pxright|450px|DescendantsLines, Left-aligned text style, example Gramps data, inc_marriages and inc_places.]][[Image:JohnShakespeare-DescendantsLines.png|thumb|300pxright|450px|Shakespeare family tree, DescendantsLines, inc_marriages]][[Image:JohnShakespeare-DescendantsLines-ep.png|thumb|300pxright|450px|Shakespeare family tree, DescendantsLines, Left-aligned text style, including event places]]
'''DescendantsLines''' is an addon for Gramps which generates a graphical descendants tree using orthogonal edges and routing ("square edges").
* Open Gramps
* Select the report using the menu option {{man menu|Reports -> Graphical Reports -> Descendants Lines...}}
* 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.
=== Options ===
DescendantsLines has the following option tabs available to change: There are option and tree combinations which may generate overlapping edges and nodes. If using the inc_marriages option the S_DOWN - S_UP difference may need to be increased by 5-15 units depending on the tree. ==== Paper Options ==== ==== Report Options ====* output_fmt - The output format (PNG, SVG, PDF or PS)* output_fn - The options output filename * max_gen - Maximum number of generations to include. (0 for unlimited){{stub}} ==== Display ==== * name_format - The name format* inc_dnum - Whether to use d'Aboville descendant numbering system* use_colors - Whether to use colored names indicating person gender in the output. * text style - The predefined output style{{stub}}* inc_places - Whether to include event places in the output* inc_marriages - Whether to include marriage information in the addon DescendantsLines areoutput ==== Replace ==== * Replace Display Format: 'Replace this'/'with this': ie:United States of America/USA==== S & F Options ====
* S_DOWN - The length of the vertical edges from descendant to spouse-bar
* S_UP - The length of the vertical edges from spouse-bar to spouse
* S_VPAD - Length of vertical padding spacing between spouse and spouse-bar (?)
* SP_PAD - Length of padding spacing between spouses
* F_PAD - Length of padding spacing between families (?)
* FL_PAD - Length of padding spacing between S_UP edges (vertical edges from spouse-bar to spouse) and O_DOWN edges (vertical edges from spouse-bar to child-bar)
==== O, C & Text Options ==== * OL_PAD -The number of ??? pad
* O_DOWN - The length of the vertical edges from spouse-bar to child-bar
* C_PAD - Length of padding spacing between children
* C_UP - The length of the vertical edges from child to child-bar
* MIN_C_WIDTH - Minimal width of child cells
* TEXT_PAD - Length of text padding
* TEXT_LINE_PAD - Length of text line padding
=== Examples ===
=== Ideas ===
Feel free to contribute or improve DescendantsLines.
* Think of optional tree compression algorithms.
* Add option to include divorces.
* Cairo provides hyperlink support. Names could be hyperlinks to html complete individual reports or to web report pages.
* 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.
* The hardcoded number option limits can be altered by users, by altering the code.
* <s>Add option to include event places.</s>(done in Gramps-addons)
* <s>Add option to include marriage information.</s> (done in Gramps-addons)
* <s>Using the library get_event_or_fallback() methods from gen.utils.</s> (done in Gramps-addons)
* <s>Add optional generation limit.</s> (done in Gramps-addons)
* <s>Make the XML export smaller. Use filter.</s> (done in Gramps-addons)
* <s>Add option for output format. (PNG, SVG, PDF or PS)</s> (done in Gramps-addons)
* <s>Add boolean option use_colors.</s> (done in Gramps-addons)
* <s>Use gen.display.name.displayer.</s> (done in Gramps-addons)
* <s>Add option for name display format.</s> (done in Gramps-addons trunk)
* <s>Add style variables and option, ref. text alignment, etc.</s> (done in Gramps-addons)
* <s>Use Gramps family order.</s> (done in Gramps-addons)
* <s>Add option to use d'Aboville descendants numbering system.</s> (done in Gramps-addons trunk)
==== Command Line Interface ====
=== Current limitations ===
=== Needs ===
=== Libraries ===
The program DescendantsLines, as the script in which it is based, is written in Python, using PyCairo and the Python XML library. Many Gramps modules are also used.
== Issues ==
* See [[DescendantsLines#Current_limitations|Current limitations]]
* {{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
* Help button does not link here.
== See also ==