Gramps 5.1 Wiki Manual - Reports - part 5

From Gramps
Revision as of 18:47, 21 October 2020 by Bamaustin (talk | contribs) (Common Options: GraphViz links)
Jump to: navigation, search
Previous Index Next


Back to Index of Reports.



Fig. 11.5.1 Reports >Graphs>... Menu overview

This section describes the different Graphs available in Gramps.

Graphs

These reports are created using the Graphviz program. Therefore it is important that the Graphviz program is installed on your computer. On Linux you can use your package manager. (As of 2017-01-21 the latest Graphviz version is 2.40.1 / Released 25 December 2016).

Gnome-important.png
Reports and custom IDs

After a GEDCOM import, your database can use some non-standard IDs (ie. 123I or 456U not set on Edit --> Preferences on the ID Formats tab). If generated reports do not properly display data, then try Reorder Gramps IDs tool Tools-->Family Tree Processing-->Reorder Gramps IDs...

All three graph reports: Family Lines, Hourglass, and Relationship Graphs share common options: Graphviz Layout, Graphviz Options, and Note.

Also they share common options with the other reports common options: Paper Options and Document Options.

Common Options

There are also several GraphViz specific options related to pagination, color, and details of the graph.

This plugin uses the Graphviz graph visualization software. Graphviz takes the generated .gv files and creates the final files, such as .gif, .png, .pdf, .ps, etc.

Graphviz Layout

Fig. 11.5.2 Family Lines Graph - Graphs - Graphviz Layout - tab default options
  • Font family: Choose the font family. If international characters don't show, use FreeSans font. FreeSans is available from the NonGNU org.
    • Default
    • PostScript/ Helvetica
    • True Type/ FreeSans
  • Font size: (14 default) The font size, in points.
  • Graph Direction: Whether the graph goes from top to bottom or left to right
    • Vertical (top to bottom) (Default)
    • Vertical (bottom to top)
    • Horizontal (left to right)
    • Horizontal (right to left)
  • Number of Horizontal Pages: (1 default) Graphviz can create very large graphs by spreading the graph across a rectangular array of pages. This controls the number of pages in the array horizontally. Only valid for dot and pdf via Ghostscript.
  • Number of Vertical Pages: (1 default) Graphviz can create very large graphs by spreading the graph across a rectangular array of pages. This controls the number of pages in the array vertically. Only valid for dot and pdf via Ghostscript.
  • Paging Direction: (Bottom, left default) The order in which the graph pages are output. This option only applies if the horizontal pages or vertical pages are greater than 1.
  • Connecting lines: - How the lines between objects will be drawn. Choose from:
    • Straight
    • Curved (Default)
    • Orthogonal


Graphviz Options

Fig. 11.5.3 Family Lines Graph - Graphs - Graphviz Options - tab default options
  • Aspect Ratio: Affects greatly how the graph is laid out on the page. Specifically node spacing and scaling of the graph( see Advice 1:).
    • Compress to minimal minimal size
    • Fill the given area (default)
    • Expand uniformly

Advice 1:

If the graph is smaller than the print area:

  • Compress to minimal minimal size will not change the node spacing.
  • Fill the given area will increase the node spacing to fit the print area in both width and height.
  • Expand uniformly will increase the node spacing uniformly to preserve the aspect ratio.

If the graph is larger than the print area:

  • Compress to minimal minimal size will shrink the graph to achieve tight packing at the expense of symmetry.
  • Fill the given area will shrink the graph to fit the print area after first increasing the node spacing.
  • Expand uniformly will shrink the graph uniformly to fit the print area.

  • DPI: (72 default) dots-per-inch. When creating PostScript or PDF, use 72 DPI. Typically between 75 and 120 if generating .png or .gif files, but 300 or 600 if generating files to be printed. When creating images such as .gif or .png files for the web, try numbers such as 100 or 300 DPI.
  • Node Spacing: (0.20 default) The minimum amount of free space, in inches, between individual nodes. For vertical graphs, this corresponds to spacing between columns. For horizontal graphs, this corresponds to spacing between rows.
  • Rank Spacing: (0.20 default) The minimum amount of free space, in inches, between ranks. For vertical graphs, this corresponds to spacing between rows. For horizontal graphs, this corresponds to spacing between columns.
  • Use subgraphs (checkbox checked by default) Subgraphs can help Graphviz position spouses together, but with non-trivial graphs will result in longer lines and larger graphs.

Note

Fig. 11.5.4 Family Lines Graph - Graphs - Note - tab default options
  • Note to add to the graph: (Empty by default) This text will be added to the graph
  • Note location: - Whether the note will appear on top or bottom of the page.
    • Top (default)
    • Bottom
  • Note size: (32 default) The size of note text, in points.


Family Lines Graph

Gramps-notes.png
That Family Lines Graph does not display all of the people in the Family Tree.

Instead, this Graph report generates smaller family trees, with many options to try and restrict the number of people included.

Fig. 11.5.5 Family Lines Graph - Graphs - example output overview

Generate an Family Lines Graph using the Graphviz generator.

A typical use of this report is to generate simplified graphs to be printed on large format printing plotters.

To create a Family Lines Graph from the menu select Reports ->Graphs -> Family Lines Graph... and then from the People of Interest tab select at least one person from the Select Person selector dialog and the report will suggest if possible a second related person via the Select Person - Also include <Person Name> warning dialog select No or Yes depending on what you decide and then select OK to generate the report.
See also common options

Report Options

Fig. 11.5.6 Family Lines Graph - Graphs - Report Options - tab default options
  • Follow parents to determine "Family lines" Parents and their ancestors will be considered when determining "Family Lines"(checkbox checked by default)
  • Follow children to determine "Family lines" (checkbox checked by default)
  • Try to remove extra people and families People and families not directly related to people of interest will be removed when determining "family lines".(checkbox checked by default)
  • Arrowhead direction: Choose the direction that the arrows point:
    • Descendants <- Ancestors(default) - arrows point to the to the Descendants.
    • Descendants -> Ancestors - arrows point to the to the Ancestors.
    • Descendants <-> Ancestors - arrows point to both.
    • Descendants - Ancestors - None (no arrows are shown)
  • Graph colouring: - Males will be shown with blue, females with red, unless otherwise set above for filled. If the sex of an individual is unknown it will be shown with gray.
    • B&W outline - Black and white outline
    • Coloured outline
    • Colour fill (default)
  • Use rounded corners to differentiate between women and men (checkbox unchecked by default)
  • Gramps ID: whether to include Gramps IDs.
    • Do not include default
    • include


Report Options (2)

Fig. 11.5.7 Family Lines Graph - Graphs - Report Options (2) - tab default options
  • Name Format: - Select the format to display the names. This choice in normally taken from the default setting in Edit > Display tab for Name format:. Or to override that setting for the report choose from:
    • Default - (in a new Family Tree this is normally Surname, Given Suffix )
    • Surname, Given Suffix
    • Given Surname Suffix
    • Given
    • Main Surnames, Given Patronymic Suffix
    • SURNAME, Given (Common)
  • Include data marked private (checkbox checked by default) - Whether to include private data.
  • Living People: - How to handle (information about) living people
    • Included, and all data (default)
    • Full names, but data removed
    • Given names replaced, and data removed
    • Complete names replaced, and data removed
    • Not included
  • Years from death to consider living: 0(default) - Whether to restrict data on recently dead people.
  • Translation: The translation to be used for the report. Language selector showing all languages supported by Gramps. Defaults to the language you are using Gramps in.
  • Date format: The format and language for dates, with examples
    • Default - Choose this option to use the default set in Edit > Display tab for Date format: option.
    • YYYY-MM-DD(ISO)(2018-03-14) (default for report)
    • Numerical(14/3/2018)
    • Month Day, Year(March 14, 2018)
    • MON DAY, YEAR(Mar 14, 2018)
    • Day Month Year(14 March 2018)
    • DAY MON YEAR(14 Mar 2018)


People of Interest

Fig. 11.5.8 Family Lines Graph - Graphs - People of Interest - tab default options

The graph works by starting with a list of "people of interest". This initial list of people is then used to find both ancestors and descendants.

  • People of interest: click on STOCK_ADD and STOCK_REMOVE to add/remove people of interest. When in doubt, try adding your grandparents as a starting point.
  • Limit the number of ancestors (checkbox unchecked by default)
    • 50 default. The maximum number of ancestors to include. The maximum is for the total number of people, not generations to be displayed on the chart.
  • Limit the number of descendants (checkbox unchecked by default)
    • 50 default. The maximum number of ancestors to include. The maximum is for the total number of people, not generations to be displayed on the chart.


Include

Fig. 11.5.9 Family Lines Graph - Graphs - Include - tab default options
  • Include dates: date of birth, date of death, and marriage dates will be included in the graph when this is selected. (checkbox checked by default)
  • Limit dates to years only: from the above only show the years.(checkbox unchecked by default)
  • Include places: place of birth, place of death, and place of marriage will be included in the graph when this is selected.(checkbox checked by default)
  • Include the number of children: marriage text will include the total number of children when this is selected.(checkbox unchecked by default)
  • Include thumbnail images of people (checkbox checked by default)
  • Thumbnail location:
    • Above the name (Default)
    • Beside the name
  • Thumbnail size:
    • Normal (default)
    • Large


Family Colours

Fig. 11.5.10 Family Lines Graph - Graphs - Family Colours - tab default options
  • Family colors: Select the color to use for people with a specific surname. Two columns are available: Surname and Color. Click on STOCK_ADD or STOCK_REMOVE to add a surname from the Select surname window, select a surname and press OK. To edit the surname color double-click on a surname and from the Select color for [Surname Selected] window choose from the shown colors and then select Select.


Individuals

Fig. 11.5.11 Family Lines Graph - Graphs - Individuals - tab default options

You can select a color for each of the following from the Pick a Color window and then select the Select button.

  • Males: the colour to use for males.
  • Females: the colour to use for females.
  • Unknown: the colour to used when gender is unknown (and for people whose surname doesn't match any of the names on the "Family Colours" tab.)
  • Families: the colour to use for families (weddings).


Hourglass Graph

Fig. 11.5.12 Hourglass Graph - Graphs - example output overview

Generate an hourglass graph using the Graphviz generator. Go to Reports -> Graph -> Hourglass Graph....
See also common options

Report Options

Fig. 11.5.13 Hourglass Graph - Graphs - Report Options - tab default options
  • Center Person: the center person for the report, defaults to the current active person.
    • Select a different person button. - Change the center person.
  • Max Descendant Generations: default 10
  • Max Ancestor Generations: default 10
  • Arrowhead direction: Choose the direction that the arrows point:
    • Descendants <- Ancestors(default) - arrows point to the to the Descendants.
    • Descendants -> Ancestors - arrows point to the to the Ancestors.
    • Descendants <-> Ancestors - arrows point to both.
    • Descendants - Ancestors - None (no arrows are shown)
  • Graph colouring: - Males will be shown with blue, females with red, unless otherwise set above for filled. If the sex of an individual is unknown it will be shown with gray.
    • B&W outline - Black and white outline
    • Coloured outline
    • Colour fill (default)
  • Use rounded corners to differentiate between women and men (checkbox unchecked by default)
  • Gramps ID: whether to include Gramps IDs.
    • Do not include default
    • include


Report Options (2)

Fig. 11.5.14 Hourglass Graph - Graphs - Report Options (2) - tab default options
  • Name Format: - Select the format to display the names. This choice in normally taken from the default setting in Edit > Display tab for Name format:. Or to override that setting for the report choose from:
    • Default - (in a new Family Tree this is normally Surname, Given Suffix )
    • Surname, Given Suffix
    • Given Surname Suffix
    • Given
    • Main Surnames, Given Patronymic Suffix
    • SURNAME, Given (Common)
  • Include data marked private (checkbox checked by default) - Whether to include private data.
  • Living People: - How to handle (information about) living people
    • Included, and all data (default)
    • Full names, but data removed
    • Given names replaced, and data removed
    • Complete names replaced, and data removed
    • Not included
  • Years from death to consider living: 0(default) - Whether to restrict data on recently dead people.
  • Translation: The translation to be used for the report. Language selector showing all languages supported by Gramps. Defaults to the language you are using Gramps in.
  • Date format: The format and language for dates, with examples
    • Default - Choose this option to use the default set in Edit > Display tab for Date format: option.
    • YYYY-MM-DD(ISO)(2018-03-14) (default for report)
    • Numerical(14/3/2018)
    • Month Day, Year(March 14, 2018)
    • MON DAY, YEAR(Mar 14, 2018)
    • Day Month Year(14 March 2018)
    • DAY MON YEAR(14 Mar 2018)


Graph Style

Fig. 11.5.15 Hourglass Graph - Graphs - Graph Style - tab default options

You can select a color for each of the following from the Pick a Color window and then select the Select button.

  • Males: the colour to use for males.
  • Females: the colour to use for females.
  • Unknown: the colour to used when gender is unknown (and for people whose surname doesn't match any of the names on the "Family Colours" tab.)
  • Families: the colour to use for families (weddings).

Force Ahnentafel order

Ahnentafel number visible


Relationship Graph

Fig. 11.5.16 Relationship Graph - Graphs - example output overview

The Relationship Graph creates a complex relationship graph in Graphviz format.

Via the menu: Reports-> Graphs- >Relationship Graph.... You will be presented with a Relationship Graph window where you can change all the settings.
See also common options

Report Options

Fig. 11.5.17 Relationship Graph - Graphs - Report Options - tab default options
  • Filter: - Select the filter to be applied to the report. Choose from:
    • Entire Database (Default) (Not recommended!)
    • Descendants of active person
    • Descendant families of active person
    • Ancestors of active person
    • People with common ancestor with active person
    • Any custom made filter you have created will be listed below the other choices.
  • Filter Person: The center person for the filter. Defaults to the Active Person. If you use a custom filter, no Person can be chosen.
    • Select a different person button. - Change the filter person.
  • Arrowhead direction: Choose the direction that the arrows point:
    • Descendants <- Ancestors(default) - arrows point to the to the Descendants.
    • Descendants -> Ancestors - arrows point to the to the Ancestors.
    • Descendants <-> Ancestors - arrows point to both.
    • Descendants - Ancestors - None (no arrows are shown)
  • Graph colouring: - Males will be shown with blue, females with red, unless otherwise set above for filled. If the sex of an individual is unknown it will be shown with gray.
    • B&W outline - Black and white outline
    • Coloured outline
    • Colour fill (default)
  • Use rounded corners: Use rounded corners to differentiate between women and men (checkbox unchecked by default)
  • Gramps ID: whether to include Gramps IDs.
    • Do not include default
    • include


Report Options (2)

Fig. 11.5.18 Relationship Graph - Graphs - Report Options (2) - tab default options
  • Name Format: - Select the format to display the names. This choice in normally taken from the default setting in Edit > Display tab for Name format:. Or to override that setting for the report choose from:
    • Default - (in a new Family Tree this is normally Surname, Given Suffix )
    • Surname, Given Suffix
    • Given Surname Suffix
    • Given
    • Main Surnames, Given Patronymic Suffix
    • SURNAME, Given (Common)
  • Include data marked private (checkbox checked by default) - Whether to include private data.
  • Living People: - How to handle (information about) living people
    • Included, and all data (default)
    • Full names, but data removed
    • Given names replaced, and data removed
    • Complete names replaced, and data removed
    • Not included
  • Years from death to consider living: 0(default) - Whether to restrict data on recently dead people.
  • Translation: The translation to be used for the report. Language selector showing all languages supported by Gramps. Defaults to the language you are using Gramps in.
  • Date format: The format and language for dates, with examples
    • Default - Choose this option to use the default set in Edit > Display tab for Date format: option.
    • YYYY-MM-DD(ISO)(2018-03-14) (default for report)
    • Numerical(14/3/2018)
    • Month Day, Year(March 14, 2018)
    • MON DAY, YEAR(Mar 14, 2018)
    • Day Month Year(14 March 2018)
    • DAY MON YEAR(14 Mar 2018)


Include

Fig. 11.5.19 Relationship Graph - Graphs - Include - tab default options
  • Dates and/or Places: - Whether to include dates and/or places
    • Do not include any dates or places (default)
    • Include (birth, marriage, death) dates, but no places
    • Include (birth, marriage, death) dates, and place
    • Include (birth, marriage, death) dates, and place if no dates
    • Include (birth, marriage, death) years, but no places
    • Include (birth, marriage, death) years, and places
    • Include (birth, marriage, death) places, but no dates
    • Include (birth, marriage, death) dates and places on same line
  • Include URLs (checkbox unchecked by default)
  • Include relationship to center person (checkbox unchecked by default)
  • Include thumbnail images of people (checkbox unchecked by default)
  • Thumbnail location: Where the thumbnail image should appear relative to the name
    • Above the name (Default)
    • Beside the name
  • Include occupation: Whether to include the last occupation
    • Do not include any occupation (default)
    • Include description of most recent occupation
    • Include date, description and place of all occupations


Graph Style

Fig. 11.5.20 Relationship Graph - Graphs - Graph Style - tab default options

You can select a color for each of the following from the Pick a Color window and then select the Select button.

  • Males: the colour to use for males.
  • Females: the colour to use for females.
  • Unknown: the colour to used when gender is unknown (and for people whose surname doesn't match any of the names on the "Family Colours" tab.)
  • Families: the colour to use for families (weddings).
  • Indicate non-birth relationships with dotted lines (checkbox checked by default) - Shows adopted relationships.
  • Show family nodes (checkbox checked by default)


Example

Fig. 11.5.21 Relationship Graph - Graphs - example output overview

Let us make a simple example. We want a relationship graph with the Descendant Families of a certain person.

  1. First check that this person is the active person. (You change this later but this is handier)
  2. Go via the menu Reports->Graphs->Relationship Graph...
  3. Papersize : A4 metric landscape: we know there will be not too many people on the graph, so this is ok
  4. Report Options: filter: Descendant Families of..., Color fill, Use rounded corners
  5. Graph Style : Show Family Nodes
  6. Graphviz Layout: Font size: 15 pts FreeSans Direction: top to bottom
  7. Graphviz Options: Fill given area dpi 133
  8. Note : we add title on the top size: 18 pts
  9. Output Format: we want a JPEG file.

The results are similar to the image shown to the right of here.
See also:



Back to Index of Reports.

Previous Index Next
Gnome-important.png Special copyright notice: All edits to this page need to be under two different copyright licenses:

These licenses allow the Gramps project to maximally use this wiki manual as free content in future Gramps versions. If you do not agree with this dual license, then do not edit this page. You may only link to other pages within the wiki which fall only under the GFDL license via external links (using the syntax: [https://www.gramps-project.org/...]), not via internal links.
Also, only use the known Typographical conventions