Gramps 3.0 Wiki Manual - Reports

From Gramps
Jump to: navigation, search

This sections describes 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: [http://www.gramps-project.org/...]), not via internal links.<br\> Also, only use the known conventions



Generating Reports

Reports are the most common form of the output produced by genealogical research. The majority of genealogical software puts a lot of emphasis on developing nice looking reports. GRAMPS is no exception in this regard, offering a choice of a variety of reports. GRAMPS can generate reports in a multitude of open formats, both text based and graphical. GRAMPS can also produce screen based reports that are convenient for viewing a summary of your database. Finally, GRAMPS can generate a web site suitable for immediate posting on the Internet. All of these are almost infinitely flexible. If you wish to modify or extend the default format of GRAMPS report, you can design and choose the style for each of your reports.

All reports can be accessed through the menu by choosing Reports ->Report Type ->Particular Report . Alternatively, you can browse the complete selection of available reports along with their brief descriptions in a Report Selection dialog invoked by clicking the Reports icon on the toolbar.

Substitution Values

Many of the graphical reports allow you to customize the information on the display. Variable substitutions are used to substitute date for a particular symbol. There are two styles of variables. The difference between the two styles is how empty data is handled.

The first style of variables are preceded by a '$'. If the variable evaluates to an empty string, the variable is replaced with the empty string. The second style of variables are preceded by a '%'. If the variable evaluates to an empty string, the line that contains the variable is removed from the output.

  • $n/%n

Displays the person's name in the form of FirstName LastName

  • $N/%N

Displays the person's name in the form of LastName, FirstName

  • $i/%i

Displays the GRAMPS ID associated with the person.

  • $b/%b

Displays the person's date of birth

  • $B/%B

Displays the person's place of birth

  • $d/%d

Displays the person's date of death

  • $D/%D

Displays the person's place of death

  • $s/%s

Displays the name of the person's preferred spouse in the form of FirstName LastName

  • $S/%S

Displays the name of the person's preferred spouse in the form of LastName, FirstName.

  • $m/%m

Displays the marriage date of the person and the preferred spouse.

  • $M/%M

Displays the place associated with the marriage of the person and the preferred spouse.

Substitution values can be combined:e.g. $n $i $b $B $d $D

this will give a lot of information in the displayed boxes.

Books

Currently, the only available report under this category is the Book Report.

The Book Report creates a single document (i.e. a Book) containing a collection of graphical and textual reports. Consequently, this allows for a very rich set of documents that GRAMPS can produce.

When Reports-->Books-->Book Report... is selected, the following book configuration dialog appears:

Fig. a.1 Book report

The Book name text entry field is used to save the book (a set of configured selections) for future use. The top pane Available items lists the items available for inclusion in the book. The bottom panel Current book lists the currently selected items in the order they will appear in the book.

The horizontal set of buttons by the Book name field operates on the whole book. Click the Clear button (clear the book) to clear all items from the current book. Click the Save button to save the current book (under the name typed in the Book name text entry field) for future use. This saves the current set of configured selections.

Gnome-important.png
Save configuration

Saving the book also saves the configuration for each item.


Click the Open button to load the book (Open previously created book) from the list of previously saved books.

Finally, click the Edit books button to invoke the editable list of available books (Manage previously created books).

The vertical set of buttons to the right of the bottom pane operates on the selected book item. Click the Add button to add selected item from the available list to the current book. Click the Remove button to remove an item from the current book. Use Up and Down to change the items order in the current book. Click the Setup button to configure the options of the selected item of the current book.

The configuration dialogs invoked by Setup are item-specific. If you choose not to configure the item, same defaults will be used for all needed options. The common option for almost all book items is the center person: the person on whom the item is centered. Thanks to this option, you can create a book with items centered on different people (e.g. your mom's and dad's ancestors as separate chapters). By default, the center person is set to the Active Person.

If all selections of the reports to be included are made, click the OK button. This will invoke a GRAMPS Book window. There is one tab with available Paper Options where you can change Size, and Orientation for the Paper Format and all Margins. Click box is available to change to metric values.

In the lower part of the window you can change some Document Options:

  • Output Format: drop down menu let you choose between: Open Document Text, PDF document or Print.... Click box is available to open in OpenOffice.org Word Processor
  • Filename: default value is /yourhomedir/book.odt. Click the Save as button and you can change the file name settings in the usual way.

Almost all items available for inclusion in the book are textual or graphical reports, and are therefore available in the form of standalone reports. The exception is the following items which are only available as book items:

  • Title Page

If you selected the Title page item and clicked the Add button to put this item in your book and you click Preferences button (Configure currently selected item) you will get a Title Page window. Two tabs are available: Text and Image. In the Text tab you have three text input fields available where you can change the Title, the subtitle and a Footer (default Copyright 2008).

The lower window part shows some Document Options: here you can choose the Style. You can choose the default style or click on the Style Editor... button. This brings up a Style Editor window where you can add and remove Styles.

TODO link to Style Editor window

In the Image tab an image can be optionally placed between the subtitle and the footer. There is Preview facility and with the from gallery... button you can select via the Select Media Object dialogue the image you want. You can also change the Size

Because of you can configure the various elements , this item can be used to create title pages for the whole book, its chapter, or even a single item.

  • Custom Text

This item produces a page with three paragraphs, each containing custom text: Initial Text, Middle Text and Final Text. The text input fields are expandable so you can really put all the text you want in there. The appearance of the text can be adjusted by using custom styles (see Document options Title Page). This item was meant to be used for epigraphs, dedications, explanations, notes, and so forth.

Graphical Reports

Graphical reports represent information in forms of charts and graphs. Most of the options are common among graphical reports, therefore they will be described only once, at the end of this section. The few options which are specific to a given report will be described directly in that report's entry.

The following graphical reports are currently available in GRAMPS:

Ancestor Tree

Fig. a.2 PDF Output ancestor tree

This report generates the chart of people who are ancestors of the Active Person.

  • Paper options: With the Paper Options you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.
  • Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A check box is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).
  • Report Options: First the Center Person is displayed. Using the Edit button you can select a different person. With the next input field Generations you can change the number of generations considered. The input field Display Format gives you the opportunity to change the default settings for the displayed entries (see Substitution Values).

Finally three check boxes are available: scale to fit on a single page, include blank pages and compress chart.

Gnome-important.png
Single page vs. multiple pages

Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!

Calendar

Fig. a.1 Calendar Paper Options


This report produces a calendar with birthdays and anniversaries on a page by month.

  • 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.




Fig. a.1 Calendar Document Options


  • Document Options:
    • Output Format: choose the output format:
      • Open Document Text
      • PDF document
      • PostScript
      • Print...
      • SVG (Scalable Vector Graphics). A check box is available were 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>/calendar.pdf.
    • Style: default default style . With the Style Editor... you can add Document Styles.




Fig. a.1 Calendar Report Options
  • Report Options:
    • Year of calendar: for which year you want the calendar to be build.
    • Filter: select filter to restrict people that appear on the calendar
      • Entire Database : not recommended!
      • Descendants of ...
      • Descendant Families of ...
      • Ancestors of ...
      • People with common ancestors with ...
      • any custom filter who have made
    • Center Person: the center person for the report
    • Name Format: Select the format to display names: choose between:
      • Surname, Given Patronymic
      • Given Surname
      • Patronymic, Given
      • Given
    • Country for holidays: Select the country to see associated holidays choose between:
      • Don't include holidays: default value
      • Canada / China / Deutschland / Finland / France / Sverige - röda dagar / United States / Ceska republika
    • First day of week:
    • Birthday surname:
    • Checkboxes:
      • Include only living people: include only living people in the calendar
      • Include birthdays: include birthdays in the calendar
      • Include anniversaries: include anniversaries in the calendar

Fig. a.1 Calendar Text Options




  • Text Options: here you can fill in three lines of text that will be put at the bottom of the page.
    • Text Area 1: First line of text at bottom of calendar default value : My Calendar
    • Text Area 2: Second line of text at bottom of calendar default value: Produced by GRAMPS
    • Text Area 3: Third line of text at bottom of calendar default value: http://gramps-project.org/



Fig. a.1 Calendar Result

Final Result:








The final result can be seen on the right side.







Calendar tools holidays explains how to add or change the holidays appearing on the output of the calendar plugin.

Descendant Tree

This report generates a graph of people who are descendants of the Active Person. Specific options include the format of the displayed entries.


This report produces a calendar with birthdays and anniversaries on a page by month.

  • 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:
      • Open Document Text
      • PDF document
      • PostScript
      • Print...
      • SVG (Scalable Vector Graphics). A check box is available were 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>/descend_chart.pdf.
    • Style: default default style . With the Style Editor... you can add Document Styles.

Fig. a.1 Tree Options
  • Tree Options:
    • Center Person: the center person for the tree.
    • Generations: The number of generations to include in the tree. Default : 10 generations
    • Display format: Display format for the outputbox. Default is
$n
b. $b
d. $d
    • Check Box: Scale to fit on a single page.
    • Check Box: Include Blank Pages.
    • Check Box: Compress Tree: whether or not compress the tree.

Fig. a.1 Descendant Tree Result

Final Result:








The final result can be seen on the right side.



Gnome-important.png
Single page vs. multiple pages

Depending whether you checked the fit on single page box, the output will be spread over one or more pages. If the amount of included generations is high (say 10) the output on a single page will be very difficult to read on a single (A4) page. On the other hand if you do not checked this box you will end up with a lot of pages!

Fan Chart

Fig. a.3 Options Fan chart

This report produces a chart resembling a fan, with Active person in the center, parents the semicircle next to it, grandparents in the next semicircle, and so on, for a total of five generations.

Fig. a.4 Fan chart
  • Paper options: With the Paper Options you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.
  • Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A check box is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).
  • Report Options: First the Center Person is displayed. Using the Edit button you can select a different person. With the next input field Generations you can change the number of generations considered.

Next input field Type of graph: choose via the drop down menu: full, half , or quarter circle. Next input field Background color: choose white or generation dependant. Next input field Orientation of radial text : choose upright or roundabout

Statistics Chart

Fig. a.5 Statistics chart

This report can collect and display a wealth of statistical data about your database. Specific options include filter, sorting methods, and additional birth- and gender-based limit for inclusion into statistics. You can also set the minimum number of items to qualify for the bar chart, so that the charts with fewer items will generate a pie chart instead. The Chart Selection tab allows you to check which charts you want to include in your report.

  • Paper options: With the Paper Options you can change Paper format (Size and Orientation) and margins (Left, Right, Top and Bottom) and use metric values or not.
  • Document options: choose the output format: Open Document Text, PDF document, PostScript, Print..., or SVG (Scalable Vector Graphics). A check box is available were you can indicate to open the made document with OpenOffice.org Word Processor or a Document Viewer (PDF file).
  • Report Options:
    • Filter: determines what people are included in the report. You can choose the entire Database, or descendants of a certain person, people with a common ancestor as... or a default/common made filter.
    • Filter person: The center person for the filter: only available if as filter not entire database selected. Edit button let you choose another filter person.
    • Sort chart items by: Select how the statistical data is sorted: Choose Item count or item name from the drop down list.
    • check box: sort in reverse order
    • People born after: Birth year from which to include people: fill in a year to start from
    • People born before: Birth year until which to include people: fill in a year
    • check box: Whether to include people without known birth years
    • Gender included: Select which genders are included into statistics. Choose both, men, or women.
    • Max. items for a pie: With fewer items pie chart and legend will be used instead of a bar chart. Choose a number from the drop down list.
Fig. a.6 Statistics chart options
  • Charts 1: 9 check boxes are available to include charts with indicated data:
Fig. a.6 Results
Fig. a7 Results
    • Age
    • Death place
    • Death month
    • Age when first child born
    • Title
    • Age when last child born
    • Birth month
    • Age at marriage
    • Age at death
  • Charts 2: 10 check boxes are available to include charts with indicated data:
    • Event type
    • Number of children
    • Marriage place
    • Number of relationships
    • Surname
    • Death year
    • Gender
    • Forename
    • Birth year
    • Birth place


If all needed info is filled in click on OK to start the data collecting. A progress bar will be shown: Collecting Data... ->Sorting Data...->Saving charts...





The image shows the result of Age of first child for all women born between 1500 and 2008. For most (576) persons personal information was missing, for some birth information was missing, but for 33 women their first child was born at age 20. With the detailed iformation further analysis can be done: calculate average, std. dev. etc.

Timeline Chart

This report outputs the list of people with their lifetimes represented by intervals on a common chronological scale. Specific options include filter, sorting method, and the title of the report.




Graphs

This reports are realted to GraphViz.

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 --> Identifiants ID). If generated reports do not properly display data, then try Reorder GRAMPS IDs tool (Tools-->Database Processing-->Reorder GRAMPS IDs).


Family Lines Graph

Example of a graph generated using FamilyLines.py, without thumbnail images.
Example of a graph generated using FamilyLines.py, with thumbnail images.

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.





Fig. xx
  • GraphViz Options:This plugin uses GraphViz. GraphViz takes the .dot 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.)



Fig. xx People of Interest
  • 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.



  • Family Colours
Fig. xx 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.


  • Individuals
Fig. 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.



  • Options
Fig. xx 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.



  • Generating graphs

Once FamilyLines.py produces the .dot output file (defaults to ./familylines.dot), 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/.

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
Smith John Hjalmar as center person

Hourglass Graph

Generate an hourglass graph using the GraphViz generator.

User can set maximum Descendant Generations and maximum Ancestor Generations

Relationship Graph

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 GraphViz. GraphViz takes the .dot files and creates the final files, such as .gif, .png, .pdf, .ps, etc.

Graph Options

Via the menu: Reports->Graphs->RelationshipGraph.... You will be presented a 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 Document Options.

Fig. xx paper Options
  • 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.



Fig. xx Report Options
  • 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 Thumbnail Location
    • Thumbnail Location: only active when last check box was checked: above or beside the name are the possibilities



Fig. xx Graph Style
  • 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.

Fig. xx GraphViz Layout
  • GraphViz Layout
    • 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: 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, postcript 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, postcript 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.

Fig. xx GraphViz Options
  • 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.

Fig. xx Note
  • 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


Document Options

  • Output Format: available formats are: PDF (both Ghostscript and GraphViz), PostScript, SVG, SVGz, JPEG, GIF, PNG and GraphViz Dot File
  • Filename: choose where the file will be saved and under which file name

.Dot files

If you use .dot 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 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)


Gnome-important.png
Tip

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 How to make a relationship chart

Example

Fig. xx Example of Descendant Families of...


Let's 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->Realtionship Graph...
  3. Papersize : A4 metric landscape: we know there will be not too much people on the graph, so this is ok
  4. Report Options: filter: Descendant Families of... check include dates, limited to years and we want ID's as well
  5. Graph Style : Color fill, ronded corners and 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 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 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. The options which are specific to a given report will be described directly in that report's entry.

The following text reports are currently available in GRAMPS:

Ahnentafel Report

Fig. a.1 Report Options

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:
    • 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. a.1 Ahnentafel Report Result

Final Result:


















Birthday and Anniversary Report

Fig. a.1 Report Options

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:

see calender report options


Fig. a.1 Birthday Report Result

Final Result:


















Complete Individual Report

This report provides individual summaries similar to that of the Individual Summary report (gramps 2.0.x). 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 produces a brief description of descendants of the Active Person. Specific options: number of forward generations to consider.

Detailed Ancestral Report

This report covers in detail the ancestors of the active person. It includes vital data (birth and death) as well as marriages. Specific options: number of backward generations to consider, as well as a variety of options regarding the exact contents to include.

Detailed Descendant Report

This report covers in detail the descendants of the active person. It includes vital (birth and death) information as well as marriages. Specific options: number of forward generations to consider.

End of Line Report

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

Family Group Report

This creates a family group report, showing information on a set of parents and their children. 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.

Marker Report

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

Records Report

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

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.



Deprecated

  • Comprehensive Ancestors Report: This report produces a comprehensive description of ancestors of the Active Person. The highlights of this report include elaborate layout, images of children, present and former spouses, and source citations. Specific options: number of backward generations to consider, whether to cite sources, and whether to break pages between generations.
  • FTM Style Ancestral Report: This report creates an ancestral report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her ancestors It includes vital information as well as marriages, children, and notes. Specific options: number of backward generations to consider.
  • FTM Style Descendant Report: This report creates a descendant report similar to that produced by the Family Tree Maker (tm) program. It covers in detail the Active Person and his/her descendants. It includes vital information as well as marriages, children, and notes. Specific options: number of forward generations to consider.
  • Individual Summary: This report produces a detailed summary on the active person. The report includes all the facts known to the database about that person.

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.

Gnome-important.png
Tip

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


View

View reports are representing overall summaries of the database information available immediately for on-screen viewing. The following view reports are currently available in GRAMPS:

Not Related

Fig. a.a Not related

This report will find people who are not related to the selected person. You can run this view via the menu Reports-->View-->Not Related....

You will get a Not related to '...' window which shows a list of all the people that are NOT related to the selected person.

This list gives you:

  • Name
  • ID
  • Parents
  • Marker

With the right arrow button and down arrow button you can collapse or expand the list. Double clicking on a person will bring up the detailed person edit window or family edit window.

If you select a person you can use the Marker text field: 3 choices are possible: blank (you can fill in whatever suits you), TODO, and NotRelated. With the Apply you can apply the selected marker to the person. This marker will then show up in the right hand side column.

Number of Ancestors

Fig. a.a Number of Ancestors


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


Just choose a person and click on the menu Report-->View-->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.

Summary of the Database

Fig. a.b Summary

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-->View-->Summary of the database....

  • 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

Web Pages

Narrated Web Site

fig. c.1 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.0 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’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 Narrated Web Site has four tabs: Report Options, Page Generation, Privacy and Advanced. Each of those tabs are reviewed below.

Gnome-important.png
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

fig. c.2 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 ‘tarball’). 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 /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 ‘Entire Database’. Filters are generally subject to how one specific individual relates to other individuals. This option allows you to specify the primary individual. Use the 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 .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 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 ISO-8859- encoding sets or even a 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.
fig. c.3 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.0 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 No style sheet.
figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0
Include ancestor graph
Checking this box will include an ancestor graph on each individual’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 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.
Gnome-important.png
Generating Pages...

If you hit the 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’s possibility of being alive unlikely.
  • Include – Include all information of all individuals even if they are possibly still alive
  • Exclude – Exclude all information of all individuals who are possibly still alive
  • Restrict – 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 “Living”
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.
fig. c.4 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’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

Web Calendar

see Calendar

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.

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.0 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 database access and simple document interface has been constructed, so as to hide as much complexity as possible.

Previous Index Next