Difference between revisions of "Gramps 3.1 Wiki Manual - Reports"

From Gramps
Jump to: navigation, search
Line 33: Line 33:
 
# People with common ancestor with Smith, Edwin Michael  
 
# People with common ancestor with Smith, Edwin Michael  
  
 
==Graphs==
 
 
This reports are realted to [http://www.graphviz.org/ GraphViz].
 
 
{{man warn|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 --> Identifiants ID'''). If generated reports do not properly display data, then try [[Gramps_3.1_Wiki_Manual_-_Tools#Reorder_GRAMPS_ID|Reorder GRAMPS IDs tool]] ('''Tools-->Database Processing-->Reorder GRAMPS IDs''').}}
 
 
 
===<u>Family Lines Graph</u>===
 
[[Image:Familylines.gif|thumb|left|250px|Fig. 8.16 Example of a graph generated using FamilyLines.py, without thumbnail images.]]
 
[[Image:Familylines with thumbnails.gif|thumb|right|250px|Fig. 8.17 Example of a graph generated using FamilyLines.py, with thumbnail images.]]
 
<br clear="all" />
 
The FamilyLines.py plugin was created to generate easy-to-follow graphs.  Note that FamilyLines does not display all of the people in the database -- instead, this plugin generates smaller family trees, with many options to try and restrict the number of people included.
 
 
A typical use of this plugin is to generate simplified graphs printed on large plotters.
 
 
====Options GraphViz====
 
[[Image:Familylines_graphviz.png|thumb|250px|Fig. 8.18 GraphViz]]
 
This plugin uses [http://www.graphviz.org/ GraphViz].  GraphViz takes the .gv files and creates the final files, such as .gif, .png, .pdf, .ps, etc.
 
This first tab allows several GraphViz options to be set:
 
* ''Width'': the width, in inches, of the final image.  Set to a large number if generating .png or .gif files.
 
* ''Height'': the height, in inches, of the final image.  Set to a large number if generating .png or .gif files.
 
* ''DPI'': dots-per-inch.  Typically between 75 and 120 if generating .png or .gif files, but 300 or 600 if generating files to be printed.
 
* ''Row spacing'': the whitespace to leave, in inches, between rows.
 
* ''Columns spacing'': the whitespace to leave, in inches, between columns
 
* ''Graph direction'': whether the tree grows from left-to-right, or right-to-left.
 
* ''Ratio'': GraphViz uses this to determine how to position items.  Only trial-and-error will help you determine the best option to use.  (When in doubt, '''compress''' tends to work well.)
 
<br clear=right>
 
 
====People of Interest====
 
[[Image:Familylines_people.png|thumb|right|250px|Fig. 8.19 People of Interest]]
 
The FamilyLines.py plugin 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 "+" and "-" to add/remove people of interest.  When in doubt, try adding your grandparents as a starting place.
 
* ''Follow parents to determine family lines'':  when selected, this causes FamilyLines.py to follow the parents to determine the full list of people of interest.  You most likely want this selected.
 
* ''Follow children to determine family lines'':  when selected, this causes FamilyLines.py to follow the children of the people of interest.
 
* ''Try to remove extra people and families'': when selected, this option causes FamilyLines.py to aggressively attempt to remove extra ancestors and families from the family tree.
 
<br clear=right>
 
 
====Family Colours====
 
[[Image:Familylines_family.png|thumb|right|250px|Fig. 8.20 Family Colors]]
 
Select the colour to use for people with a specific surname.  Click on "+" or "-" to add a surname.  Double-click on a surname to edit the colour.
 
<br clear=right>
 
 
====Individuals====
 
[[Image:Familylines_individuals.png|thumb|right|250px|Fig. 8.21 Individuals]]
 
* ''Males'', ''Females'', ''Unknown'': the colour to use for people whose surname doesn't match any of the names on the "Family Colours" tab.
 
* ''Families'': the colour to use for families (weddings).
 
* ''Limit the number of parents'': if selected, then the number of ancestors will be limited by the amount shown.  This can only be selected if "Follow parents" has also been selected on the "People of Interest" tab.
 
* ''Limit the number of children'': if selected, then the number of children will be limited by the amount shown.  This can only be selected if "Follow children" has also been selected on the "People of Interest" tab.
 
<br clear=right>
 
 
====Options====
 
[[Image:Familylines_options.png|thumb|right|250px|Fig. 8.22 Options]]
 
* ''Include dates'': date of birth, date of death, and marriage dates will be included in the graph when this is selected.
 
* ''Include places'': place of birth, place of death, and place of marriage will be included in the graph when this is selected.
 
* ''Include the number of children'': marriage text will include the total number of children when this is selected.
 
* ''Include researcher and date'': a label will be placed at the bottom of the graph when this is selected.
 
* ''Include private records'': people and events marked as private will be included in the graph when this is selected.
 
<br clear=right>
 
 
====Generating graphs====
 
Once FamilyLines.py produces the .gv output file (defaults to ''./familylines.gv''), the GraphViz package will be necessary to create the final output file.  If GraphViz isn't already installed, you can download it from [http://www.graphviz.org/ http://www.graphviz.org/].
 
 
Some common examples of commands used to generate graphs from the familylines.dot file are:
 
 
dot -v -Tgif -ofamilylines.gif familylines.dot
 
dot -v -Tpng -ofamilylines.png familylines.dot
 
dot -v -Tpcl -ofamilylines.pcl familylines.dot
 
dot -v -Tps -ofamilylines.ps familylines.dot
 
 
<br clear="all"/>
 
 
===<u>Hourglass Graph</u>===
 
 
[[Image:Hourglass report.png|right|250px|thumb|Fig. 8.23 Hourglass Graph of Smith John Hjalmar]]
 
 
Generate an hourglass graph using the GraphViz generator.
 
 
User can set maximum Descendant Generations and maximum Ancestor Generations
 
 
<br clear="all"/>
 
 
===<u>Relationship Graph</u>===
 
 
The Relationship Graph creates a complex relationship graph in GraphViz format and then converts into graphical output running it through the GraphViz ''dot'' tool behind the scene. Specific options for this report include filter, options for dates and places for the events, and whether to include URLs and IDs for individuals and families. There are also several GraphViz-specific options related to pagination, color, and details of the graph.
 
This plugin uses [http://www.graphviz.org/ GraphViz].  GraphViz takes the .gv files and creates the final files, such as .gif, .png, .pdf, .ps, etc.
 
====Graph Options====
 
Via the menu: {{man label|Reports->Graphs->RelationshipGraph...}}. You will be presented a {{man label|Relationship Graph}} window where you can change all the settings.
 
The window is divided into two parts. One part provides for all the different tabs available, the other part has the {{man label|Document Options}}. 
 
 
====Paper Options====
 
[[Image:Relgraf1.png|right|250px|thumb|Fig. 8.24 paper Options]]
 
 
This first tab as usual in reports regulates the Paper Format and the Margins.
 
 
A check box controles whether you have metric sizes or not.
 
 
Relationship Graphs can rapidly become '''very large'''.
 
 
Setting the paper format is essential for succes.
 
 
====Report Options====
 
[[Image:Relgraf2.png|right|thumb|250px|Fig. 8.25 Report Options]]
 
Some important options here:
 
*''Filter'': Standard options here are the entire database ('''not recommended!'''), Descendants of, Descendant families of, Ancestors of, People with common ancestor with, or a custum made filter.
 
*''Filter Person'': If you use a custom filter, no Person can be choosen. Otherwise choose the correct person here. There are several tick boxes here:
 
** Include Birth, Marriage and Death dates
 
** Limit dates to years only
 
** Use place when no date
 
** Include URLs
 
** Include IDs
 
** Include thumbnail images of people: checking this box gives you another input field {{man label|Thumbnail Location}}
 
*''Thumbnail Location'': only active when last check box was checked: above or beside the name are the possibilities
 
 
====Graph Style====
 
[[Image:Relgraf3.png|right|thumb|250px|Fig. 8.26 Graph Style]]
 
*''Graph coloring'': Males will be shown in blue, females with red. If the sex of an individual is unknown it will be shown with gray. Options are:
 
** Colored outline
 
** B&W outline
 
** Color fill
 
*''Arrowhead direction'': Choose the direction that the arrow point: Descendants <- Ancestors, Descendants -> Ancestors, Descendants <-> Ancestors, Descendants - Ancestors
 
** Use rounded corners: Use rounded corners to differentiate between women and men
 
** Indicate non-birth relationships with dotted lines: No-birth relationships wiil shown up as dotted lines in the graph.
 
** Show family nodes: Families will show up as ellipses, linked to parents and children.
 
 
====GraphViz Layout====
 
[[Image:Relgraf4.png|right|thumb|250px|Fig. 8.27 GraphViz Layout]]
 
*''Font family'': Choose the font family. If international characters don't show, use '''FreeSans''' font. FreeSans is available from [http://www.nongnu.org/freefont/ the NonGNU org].
 
** Default
 
** PostScript/ Helvetica
 
** True Type/ FreeSans
 
*''Font size'': The font size in points
 
*''Graph Direction'': Whether the graph goes from top to bottom or left to right
 
** Vertical (top to bottom)
 
** Vertical (bottom to top)
 
** Horizontal (left to right)
 
** Horizontal (right to left)
 
*''Number of Horizontal Pages'': 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'': 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'': The order in which the graph pages are output. This option only applies if the horizontal pages or vertical pages are greater than 1.
 
 
====GraphViz Options====
 
[[Image:Relgraf5.png|right|thumb|250px|Fig. 8.28 GraphViz Options]]
 
* ''Aspect Ratio'': '''Affects greatly''' how the graph is layed out on the page.
 
** Minimal Size
 
** Fill the given area
 
** Use the optimal number of pages
 
* ''DPI'': dots-per-inch.  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. When creating PostScript or PDF, use 72 DPI.
 
* ''Node Spacing'': The minimum ammount 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. Default is 0.20''.
 
* ''Rank Spacing'': The minimum ammount 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. Default is 0.20''.
 
 
====Note====
 
[[Image:Relgraf6.png|right|thumb|250px|Fig. 8.29 Note]]
 
* Note to add to the graph: This text will be added to the graph
 
* Note Location : Whether the note will appear on top or bottom of the page
 
* Note size: The size of note text, in points
 
<br clear=right>
 
 
====Document Options====
 
 
*''Output Format'': available formats are: PDF (both Ghostscript and GraphViz), PostScript, SVG, SVGz, JPEG, GIF, PNG and GraphViz gv file
 
*''Filename'': choose where the file will be saved and under which file name
 
 
====''.gv'' files====
 
If you use {{man label|.gv}} files you must realize that those files are meant to be processed by other programs. By themselves, the files will not provide meaningful information; the files must first be processed by another program.
 
 
The GraphViz ''''dot'''' tool can transform the graph into postscript, jpeg, png, vrml, svg, and other formats. GraphViz tools are freely available from the [http://www.graphviz.org/ GraphViz site].
 
 
So make sure you have '''Graphviz''' installed. Use your package manager on Linux.
 
 
 
On Ubuntu Hardy the actual version is '''2.16.3ubuntu2'''. The file is only 1.2 MB and provides a lot of commands like: ''dot'', ''gvcolor'', ''dijkstra'' ....
 
 
 
Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)
 
 
 
{{man tip|1=Tip|2=If you are not interested in GraphViz code itself and just want to generate graphical output, GRAMPS can do it for you under the hood. }}
 
 
You can find a detailled explanation in a tutorial [http://www.gramps-project.org/wiki/index.php?title=Howto:_Make_a_relationship_chart How to make a relationship chart]
 
 
====Example====
 
[[Image:Relgrafexample.png|right|thumb|350px|Fig. 8.30 Example of Descendant Families of...]]
 
 
 
Let's make a simple example. We want a relationship graph with the Descendant Families of a certain person.
 
 
# First check that this person is the ''active person''. (You change this later but this is handier)
 
# Go via the menu {{man label|Reports->Graphs->Realtionship Graph...}}
 
# Papersize : A4 metric landscape: we know there will be not too much people on the graph, so this is ok
 
# Report Options: filter: Descendant Families of...  check include dates, limited to years and we want ID's as well
 
# Graph Style : Color fill, ronded corners and show Family Nodes
 
# GraphViz Layout: Font size: 15 pts  FreeSans Direction: top to bottom
 
# GraphViz Options: Fill given area dpi 133
 
# Note : we add title on the top  size: 18 pts
 
# Output Format: we want a JPEG file and after making of the graph to open a Image Viewer.
 
 
 
 
The result you can see in the image on the right hand side..
 
  
 
==Text Reports==
 
==Text Reports==
Line 759: Line 559:
 
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.1_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]
 
The information given in this report is the same as in the [http://www.gramps-project.org/wiki/index.php?title=Gramps_3.1_Wiki_Manual_-_Gramplets#Statistics_Gramplet Statistics_Gramplet]
  
== Web Pages ==
 
 
===<u>Narrated Web Site</u>===
 
 
[[Image:NWeb-Man-Mainz.jpg|right|250px|thumb|fig. 8.40 Individual List Page in Mainz Style]]
 
One of the reports in this category is the Narrated Web Site report. It generates a web site (that is, a set of linked web pages), for a set of selected individuals.
 
 
====Introduction====
 
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.1 Narrated Web Site report provides improved functionality, support for web standards and additional features. The new report creates pages that closely follow the World Wide Web Consortium&#8217;s Recommendations for XHTML 1.0 Strict and CSS 1. These recommendations include a separation of content from presentation. Due to this practice, the style and appearance of the new web pages can be completely controlled from one CSS stylesheet without altering individual pages.
 
 
More information is now displayed about each person, along with information about sources, places, and media objects. Introduction pages can be added to provide additional information, such as a family history.
 
 
Genealogy records can generate a lot of files. Many web servers have a difficult time with a large number of files in a single directory. The Narrated Web report strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated file names are not intuitive, but are unique for each person. Subsequent runs will generate identical file names, making it easy to update specific files.
 
 
If you have trouble transfering the files to an external web host, you can create a single gzip'd tar file to more easily upload the data. (Please use this method if you would like to use the GRAMPS web hosting site.)
 
 
To select the gzip'd tar file, select the Store web pages in .tar.gz archive option.
 
 
====Using the Report====
 
The Narrated Web Site report provides the user with options that allow a wide range of customization. You can run this report via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.
 
 
The Narrated Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below.
 
{{man warn|Entire Database|Be aware that if you select your entire database as a filter a large number of files will be generated (depending on the size of your database). It is recommended to start with a filter (for example: ancestors of a certain person) to simplify the output while you learn about the plugin.}}
 
 
====Report Options====
 
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|Fig. 8.41 Individual Detail Page in Nebraska Style]]
 
;Store web pages in .tar.gz archive
 
:The large number of files and directories in this web output may make it difficult to transfer the files to an external web host. GRAMPS has the capability of saving all of your Narrative Web files in one compressed archive using the gzip and tar formats (casually known as a &#8216;tarball&#8217;). This single file can quickly be transferred to your server. Unfortunately not all web servers support saving web files in this way, so contact your hosting provider for more information.
 
 
:The free genealogy site hosting provided by the GRAMPS organization will only accept your files in a compressed archive. Learn more about free genealogy site hosting here: http://library.gramps-project.org
 
;Destination
 
:The output of the Narrative Web report is by default saved here {{man label|/yourhomedirectory/NAVWEB}}. This option allows you to save your report output to a destination of your choice.
 
;Filter
 
:Like the previous web page generator and other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but custom filters can be made for your specific needs. Learn more about custom filters here: [[Filter]].
 
Any person matching this filter who is not excluded due to the privacy rules, will be included in the output. The default filter includes all people in the database.
 
;Filter Person
 
:This option is inactive if the primary Filter option is set to &#8216;Entire Database&#8217;. Filters are generally subject to how one specific individual relates to other individuals. This option allows you to specify the primary individual. Use the {{man button|Edit}} button to select any individual in your database.
 
;Web site title
 
:The default site title value is '''My Family Tree'''. You can enter a custom site title in this option.
 
;File extension
 
:The file extension to be used for the web files. Choose between the {{man label|.html}} default value, .htm, .shtml, .php, .php3, or .cgi.
 
;Copyright
 
:When creating a public a web site it is important to specify the copyright conditions under which you are publishing your data. International copyright law reserves all rights of your data to your discretion. You own the data and individuals must have your permission if they wish to reuse that data. In genealogical research sharing data with other researchers is a common practice. By default the Narrative Web report uses an '''All Rights Reserved''' copyright. Other options include the Creative Commons licenses, offering a wide range of use restrictions or none at all. Learn more about the Creative Commons at http://creativecommons.org/
 
;Character set encoding
 
:GRAMPS is an international application developed with multiple languages and translations in mind. Because of this the default character set for HTML pages is {{man label|UTF-8}}, which supports a wide range of international characters and symbols. From the drop down menu list you can select from a variety of {{man label|ISO-8859-}} encoding sets or even a {{man label|koi8_r}} encoding set. There is support for virtually all popular character set encodings. If you are having problems with character presentation in your web pages it could be a matter of selecting a compatible character set encoding for your web server environment.
 
[[Image:NWeb-Man-BasicSet.jpg|right|250px|thumb|Fig. 8.42 Basic Style - 5 Color Choices]]
 
;Stylesheet
 
:GRAMPS provides seven built in style sheets for you to choose from to determine the appearance or your web pages. In GRAMPS 3.1 you can choose between '''Basic''' (Ash, Cypress, Lilac, Peach or Spruce color schemes), '''Mainz''', or '''Nebraska''' styles. There is also the option of not including a stylesheet ('''No style sheet'''). Regardless of the style you choose, the style sheet file name is ''narrative.css''. You may edit this file to further customize the appearance of your web pages.
 
:If you make modifications to your style sheet be aware that regenerating your pages with the same output destination will overwrite your custom style sheet. To preserve your custom style sheet through subsequent web page updates select {{man label|No style sheet}}.
 
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.1''
 
;Include ancestor graph
 
:Checking this box will include an ancestor graph on each individual&#8217;s detail page if they have defined ancestors in your database.
 
;Graph generations
 
:This option is inactive if the "Include ancestor graph" option is not checked. The default number of generations shown in the ancestor graphs is {{man label|4}} with options of 2, 3, 4 or 5.
 
 
:The individuals represented in the ancestor graphs are the same individuals whose information is provided elsewhere in your web pages.
 
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}
 
 
====Page Generation====
 
The Narrated Web Site report can be set to generate three supplemental pages: '''Home''', '''Introduction''' and '''Publisher Contact'''. From this tab you can activate the pages and assign Media or Notes items to each page. By default no content (media or text) is assigned to these pages. Content for these pages must originate as Media or Notes items. If the desired items have already been added to your database you will be able to choose them from a list of Notes or Image Objects.
 
;Home Page, Introduction and Publisher Contact
 
:These pages will display an individual Media Object and/or a Note of your choice. To enable any of these pages choose a Media Object and/or Note by way of the selection button to the right of the corresponding page listing.
 
 
:Please use the Publisher contact page with caution if you are publishing your web pages on a publicly accessible web server.
 
;HTML user header and HTML user footer
 
:These elements will display an individual Note of your choice. The HTML user header text will appear directly below the site title on every web page. The HTML user footer text will appear within the footer, above the copyright statement on every web page. (This feature is in rapid development currently and may be subject to dramatic change in upcoming releases of GRAMPS.)
 
;Include images and media objects
 
:This option determines whether to include/exclude a gallery of media objects on your website.
 
;Include download page
 
:This option determines whether to include a page titled "Downloads". This page will be blank and is provided in case you would like to offer downloads of databases, media objects or references to your visitors.
 
;Suppress GRAMPS ID
 
:This option determines whether to include the GRAMPS ID of objects in your web page output.
 
 
====Privacy====
 
Privacy of personal information is an important issue. GRAMPS provides tools and settings that give you control over the privacy of your data.
 
;Include records marked private
 
:If your intention is to provide a complete record of your research, checking this box will include all entries marked '''private''' along with the rest of your database.
 
;Living People
 
:You can control the display of sensitive information based on whether or not an individual is currently alive. However, since GRAMPS is a research tool, it is likely that there are individuals with no known date of death in your database. To deduce if an individual is ''possibly still alive'' GRAMPS employs an algorithm that compares death dates, birth dates, baptism/christening dates, death dates of ancestors and birth dates of ancestors. The algorithm assumes that each individual is ''possibly still alive'' unless the cross-referenced dates make the individual&#8217;s ''possibility of being alive'' unlikely.
 
:*'''Include''' &#8211; Include all information of all individuals even if they are ''possibly still alive''
 
:*'''Exclude''' &#8211; Exclude all information of all individuals who are ''possibly still alive''
 
:*'''Restrict''' &#8211; Exclude all information of all individuals who are ''possibly still alive'', but display their relationship with other individuals while replacing their first name with the word &#8220;Living&#8221;
 
;Years from death to consider living
 
:This option is inactive if the "Living People" option is set to '''Include'''. Some countries have laws that specify a certain number of years after death before an individual's information can be published. Here you can specify the number of years after death needed to comply with such laws. The default value is 30 years.
 
 
[[Image:NWeb-Man-Print.jpg|right|250px|thumb|fig. 8.43 The default appearance of pages printed from a Narrative Website web page]]
 
 
:Please note that compliance with privacy laws and individuals' privacy concerns is the researcher&#8217;s responsibility. GRAMPS cannot be held responsible for privacy law compliance or other privacy issues.
 
 
====Advanced====
 
The current advanced settings primarily address the amount of information displayed on the Surname detail and Individual index web pages. They are simple on-or-off options which can be understood with little explanation.
 
* include a link to home person on every page
 
* include a column for birth dates on the index pages
 
* include a column for death dates on the index pages
 
* include a column for partners on the index pages
 
* include a column for parents on the index pages
 
* include a column for half-siblings on the index pages
 
 
(Coming in GRAMPS 3.2: Include GENDEX file (/gendex.txt). This option creates a GENDEX file placed at the top of the website. You can see sites which support this format and read more about it at the [http://en.wikipedia.org/wiki/GENDEX|GENDEX Wikipedia article].)
 
 
<br clear="all"/>
 
 
===<u>Web Calendar</u>===
 
 
see [[#Calendar|Calendar]]
 
 
== Quick Reports ==
 
[[Quick_Reports|Quick reports]] are reports that are available in the context menu's of person, family, ... They are easy to make by users, even with limited coding knowledge.
 
 
[[Image:Gramps_quick_report_view.png|thumb|right|Fig. 8.44 Quick Report context menu on Person View]]
 
Many users want to produce a report quickly for their specific needs, but are hindered by the fact they do not want to learn python fully, nor the intricacies of a complicated program like GRAMPS.
 
 
For them, starting in GRAMPS 3.1 a new tool has been constructed: the quick reports. These reports are short textual reports that the user can register with GRAMPS, so they automatically appear in the context menu's.
 
Accompanying this, a [[Simple Access API|simple database access]] and simple document interface has been constructed, so as to hide as much complexity as possible.
 
  
 
<br clear="all"/>
 
<br clear="all"/>

Revision as of 16:20, 5 October 2009

This section describes all the different reports available in GRAMPS.


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



  1. Generating Reports
  2. Substitution Values
  3. Books
  4. Graphical Reports
  5. Graphs
  6. Text Reports
  7. Web Pages and Quick Reports


Common Options

  • pid: The center person for the filter (ex: Smith, Edwin Michael)
  • filter: Determines what people are included in the report
  1. Entire Database
  2. Descendants of Smith, Edwin Michael
  3. Descendant Families of Smith, Edwin Michael
  4. Ancestors of Smith, Edwin Michael
  5. People with common ancestor with Smith, Edwin Michael


Text Reports

Text reports represent the desired information as formatted text. Most of the options are common among text reports, therefore they will be described only once, at the end of this section.

Common options

Common options for text reports are the filename of the output, the format of the output, selected style, page size and orientation. For HTML reports, there is no page information. Instead, HTML options include the choice of the HTML template, either available in GRAMPS or a custom template defined by you. Optionally, the reports can be immediately opened with the default application.

Tango-Dialog-information.png
Tip

The options used in reports are persistent: each report remembers its options used last time.


The options which are specific to a given report will be described directly in that report's entry and on Command line references.

The following text reports are currently available in GRAMPS:

Ahnentafel Report

This report lists the Active Person and his or her ancestors along with their vital data.

The people are numbered in a special way which is an established standard called Ahnentafel.

The Active Person is given number 1. His or her father and mother have numbers 2 and 3, respectively.

This rule holds for every person while going back in generations: father's parents are numbered 4 and 5, and mother's parents are numbered 6 and 7, fathers always numbered with even and mothers with odd numbers.

Therefore, for any person having number N in this tree, the numbers of father and mother are 2N and 2N+1, respectively.

   person = n
   father = 2n
   mother = 2n+1

Each entry will consist of a single paragraph, and should contain the following contents:

  • Person number.
  • Person's name.
  • Birth Information, if available.
  • Death Information, if available.
  • Burial Information, if available


Paper options

With the Paper Options you can change :

  • Paper format (Size and Orientation)
  • Margins (Left, Right, Top and Bottom)

and whether to use metric values or not.

Document Options

  • Output Format: choose the output format:
    • HTML document
    • LaTex
    • Open Document Text
    • PDF document
    • Print...
    • RTF document
    • plain text document

With the checkbox you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).

  • Filename: default value is /home/<username>/ancestor_report.pdf.
  • Style: default default style . With the Style Editor... you can add Document Styles.

Report Options

Fig. 8.31 Report Options
  • Center Person: the center person for the report.
  • Generations: The number of generations to include in the report. Default : 10 generations
  • Check Box: Page break between generations: Whether to start a new page after each generation.
  • Check Box: Add linebreak after each name: Indicates if a line break should follow the name.
  • Check Box: Compress Tree: whether or not compress the tree.
Fig. 8.32 Ahnentafel Report Result


Birthday and Anniversary Report

This report gives the same information as a calender report but in text format.

Paper options

With the Paper Options you can change :

    • Paper format (Size and Orientation)
    • Margins (Left, Right, Top and Bottom)

and whether to use metric values or not.

Document Options

    • Output Format: choose the output format:
      • HTML document
      • LaTex
      • Open Document Text
      • PDF document
      • Print...
      • RTF document
      • plain text document

With the checkbox you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).

    • Filename: default value is /home/<username>/birtday_report.pdf.
    • Style: default default style . With the Style Editor... you can add Document Styles.

Report Options

Fig. 8.34 Report Options

Final Result:

Fig. 8.33 Birthday Report Result


Complete Individual Report

This report provides individual summaries similar to that of the Individual Summary report (gramps 2.0.x).

Paper options

With the Paper Options you can change :

  • Paper format (Size and Orientation)
  • Margins (Left, Right, Top and Bottom)

and whether to use metric values or not.

Document Options

  • Output Format: choose the output format:
    • HTML document
    • LaTex
    • Open Document Text
    • PDF document
    • Print...
    • RTF document
    • plain text document

With the checkbox you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).

  • Filename: default value is /home/<username>/complete_individual_report.pdf.
  • Style: default default style . With the Style Editor... you can add Document Styles.

Report Options

The advantage of this report is the specific filter option. Depending on the filter choice (Active Person only, his or her descendants, his or her ancestors, or entire database), the report may contain from one to many individual summaries. Another option for this report is the inclusion of source information when listing events.

Descendant Report

This report presents the descendants of the Active Person with a brief description in indented style.

Paper options

With the Paper Options you can change :

  • Paper format (Size and Orientation)
  • Margins (Left, Right, Top and Bottom)

and whether to use metric values or not.

Document Options

  • Output Format: choose the output format:
    • HTML document
    • LaTex
    • Open Document Text
    • PDF document
    • Print...
    • RTF document
    • plain text document

With the checkbox you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).

  • Filename: default value is /home/<username>/descendant_report.pdf.
  • Style: default default style . With the Style Editor... you can add Document Styles.

Report Options

Fig. 8.35 Descendant Report

The only specific option concerns the number of forward generations to consider.

Example Result:



Detailed Ancestral Report

This report covers in detail the ancestors of the active person, including a range of vital data as well as marriages. It shares many of its properties with the Detailed Descendant Report (see below).

Paper options

With the Paper Options you can change :

  • Paper format (Size and Orientation)
  • Margins (Left, Right, Top and Bottom)

and whether to use metric values or not.

Document Options

  • Output Format: choose the output format:
    • HTML document
    • LaTex
    • Open Document Text
    • PDF document
    • Print...
    • RTF document
    • plain text document

With the checkbox you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).

  • Filename: default value is /home/<username>/detailed_ancestral_report.pdf.
  • Style: default default style . With the Style Editor... you can add Document Styles.

Report Options

Fig. 8.36 Detailed Ancestral Report

The report is structured with the Ahnentafel standard numbering. Specific options: number of backward generations to consider, whether to include siblings, whether to include notes, as well as a variety of options regarding the exact contents to present.

Example Result:



Detailed Descendant Report

This report covers in detail the descendants of the active person, following the genealogical tradition of textual descendant reports. It aims to provide all important features expected to be found in the classic descendency formats and has received influence from various sources. The GRAMPS team considers as one of its objectives the viability of this report's adoption by professional genealogical institutions worldwide. As a consequence this is a highly customizeable report.

Paper options

With the Paper Options you can change :

  • Paper format (Size and Orientation)
  • Margins (Left, Right, Top and Bottom)

and whether to use metric values or not.

Document Options

  • Output Format: choose the output format:
    • HTML document
    • LaTex
    • Open Document Text
    • PDF document
    • Print...
    • RTF document
    • plain text document

With the checkbox you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).

  • Filename: default value is /home/<username>/detailed_descendant_report.pdf.
  • Style: default default style . With the Style Editor... you can add Document Styles.

Report Options

Fig. 8.37 Detailed Descendant Report

The report includes a range of vital information, marriages and (optionally) notes and spouses' information. Among the numerous options are the number of forward generations to consider, whether to compute ages, the text-style between complete-sentenced and succinct, and whether to include images. The report utilizes Henry-style numbering by default, and offers Register-style numbering as an option.

If you are a professional genealogist and feel that this report lacks something in order to be usable by your institution, feel free to submit a feature request at http://bugs.gramps-project.org. That goes also for amateur genealogists with improvement ideas of course.

Example Result:



End of Line Report

This provides a list a person's last known ancestors with the pedigree line, order by generations.

Paper options

With the Paper Options you can change :

  • Paper format (Size and Orientation)
  • Margins (Left, Right, Top and Bottom)

and whether to use metric values or not.

Document Options

  • Output Format: choose the output format:
    • HTML document
    • LaTex
    • Open Document Text
    • PDF document
    • Print...
    • RTF document
    • plain text document

With the checkbox you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).

  • Filename: default value is /home/<username>/end_of_line_report.pdf.
  • Style: default default style . With the Style Editor... you can add Document Styles.



Family Group Report

This creates a family group report, showing information on a set of parents and their children.

Paper options

With the Paper Options you can change :

  • Paper format (Size and Orientation)
  • Margins (Left, Right, Top and Bottom)

and whether to use metric values or not.

Document Options

  • Output Format: choose the output format:
    • HTML document
    • LaTex
    • Open Document Text
    • PDF document
    • Print...
    • RTF document
    • plain text document

With the checkbox you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).

  • Filename: default value is /home/<username>/family_group_report.pdf.
  • Style: default default style . With the Style Editor... you can add Document Styles.

Report Options

Specific options: the spouse (available only if the Active Person has more than one spouse).



Kinship Report

This provides the kinship of selected person according to level search (hight, down generations) set by user.

Paper options

With the Paper Options you can change :

  • Paper format (Size and Orientation)
  • Margins (Left, Right, Top and Bottom)

and whether to use metric values or not.

Document Options

  • Output Format: choose the output format:
    • HTML document
    • LaTex
    • Open Document Text
    • PDF document
    • Print...
    • RTF document
    • plain text document

With the checkbox you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).

  • Filename: default value is /home/<username>/kinship_report.pdf.
  • Style: default default style . With the Style Editor... you can add Document Styles.



Marker Report

This lists primary objets (person, family, notes) who match the selected marker.

Paper options

With the Paper Options you can change :

  • Paper format (Size and Orientation)
  • Margins (Left, Right, Top and Bottom)

and whether to use metric values or not.

Document Options

  • Output Format: choose the output format:
    • HTML document
    • LaTex
    • Open Document Text
    • PDF document
    • Print...
    • RTF document
    • plain text document

With the checkbox you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).

  • Filename: default value is /home/<username>/marker_report.pdf.
  • Style: default default style . With the Style Editor... you can add Document Styles.



Number of Ancestors

This report displays the number of ancestors of the active person.

Just choose a person and click on the menu Report-->Text-->Number of Ancestors....

Paper options

With the Paper Options you can change :

  • Paper format (Size and Orientation)
  • Margins (Left, Right, Top and Bottom)

and whether to use metric values or not.

Document Options

  • Output Format: choose the output format:
    • HTML document
    • LaTex
    • Open Document Text
    • PDF document
    • Print...
    • RTF document
    • plain text document

With the checkbox you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).

  • Filename: default value is /home/<username>/number_of_ancestors_report.pdf.
  • Style: default default style . With the Style Editor... you can add Document Styles.

The report

Fig. 8.38 Number of Ancestors


The window will show up listing the details:

generation 1 has 1 individual : 100% : this is the person you started with generation 2 has 2 individuals : 100% : both parents are known


generation 8 has 35 individuals : 27.34 % : this means from the (2**7) 128 possible ancestors in generation 8 27% are known.

Total ancestors in generation 2 to .. is also given in numbers and percentages.

With the Close button you close the window and this report.


Place Report

Produces a report according to places selected by the user. It will list related person and event to the selected place.

Paper options

With the Paper Options you can change :

  • Paper format (Size and Orientation)
  • Margins (Left, Right, Top and Bottom)

and whether to use metric values or not.

Document Options

  • Output Format: choose the output format:
    • HTML document
    • LaTex
    • Open Document Text
    • PDF document
    • Print...
    • RTF document
    • plain text document

With the checkbox you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).

  • Filename: default value is /home/<username>/place_report.pdf.
  • Style: default default style . With the Style Editor... you can add Document Styles.

Records Report

The Records report shows a number of interesting records (mostly age related) in your database, like oldest living person, youngest mother, etc.

Paper options

With the Paper Options you can change :

  • Paper format (Size and Orientation)
  • Margins (Left, Right, Top and Bottom)

and whether to use metric values or not.

Document Options

  • Output Format: choose the output format:
    • HTML document
    • LaTex
    • Open Document Text
    • PDF document
    • Print...
    • RTF document
    • plain text document

With the checkbox you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).

  • Filename: default value is /home/<username>/records_report.pdf.
  • Style: default default style . With the Style Editor... you can add Document Styles.

Report Options

Selection of the records to print is possible, and a reasonable list of "positive records" is preselected (most people would regard, for example, a long marriage as a positive record, while an early divorce would rather be seen as a negative record).

Caveats:

  • If the option to underline the call name is selected, the report uses <u>...</u> to achieve this. This only works with CairoDoc based output (direct printing, PDF export) and HTML output.


Summary of the Database

This report displays the overall statistics concerning number of individuals of each gender, various incomplete entries statistics, as well as family and media statistics.

You can run this report via the menu Report-->Text-->Summary of the database....

Paper options

With the Paper Options you can change :

  • Paper format (Size and Orientation)
  • Margins (Left, Right, Top and Bottom)

and whether to use metric values or not.

Document Options

  • Output Format: choose the output format:
    • HTML document
    • LaTex
    • Open Document Text
    • PDF document
    • Print...
    • RTF document
    • plain text document

With the checkbox you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).

  • Filename: default value is /home/<username>/summary_report.pdf.
  • Style: default default style . With the Style Editor... you can add Document Styles.

Report Options

Fig. 8.39 Summary
  • Individuals: the numbers in the different categories are shown
    • Number of individuals:
    • Males:
    • Females:
    • Individuals with unknown gender:
    • Individuals with incomplete names:
    • Individuals missing birth dates:
    • Disconnected individuals:
  • Family information:
    • number of families:
    • Unique surnames:
  • Media Objects:
    • Individuals with Media Objects:
    • Total number of media object references:
    • Number of unique media objects:
    • Total size of media objects: in bytes
  • Missing Media Objects: this will show the full path and file names of any missing media object.

The information given in this report is the same as in the Statistics_Gramplet



Previous Index Next