Gramps 4.0 Wiki Manual - Reports - part 7

From Gramps
Revision as of 03:43, 16 October 2014 by Sam888 (talk | contribs) (remove {{out of date}} template)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
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: []), not via internal links.
Also, only use the known Typographical conventions

Previous Index Next

This section describes the Web Pages, Web Calendar and the Quick Reports as part of the different reports available in Gramps.

Back to Index of Reports.

Web Pages

Narrated Web Site

Fig. 11.7.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.


Gramps 2.0.6 introduced the Narrative Web generator. The Gramps 4.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.

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.

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. 11.7.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 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.
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.
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
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. 11.7.3 Basic Style - 5 Color Choices
Gramps provides seven built in style sheets for you to choose from to determine the appearance or your web pages. In Gramps 4.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 4.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.
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 [1].)
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 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. 11.7.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.


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
  • 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 GENDEX Wikipedia article.)

Web Calendar

Fig. 11.7.5 Web Calendar

The Web Calendar shows events for the selected individuals on a set of monthly calendars.

There are options to filter the individuals, to choose which years to include (by default, only the current year is included); whether to include only living people and whether to include birthdays or anniversaries or both; notes can be included on monthly pages and abbreviated pages can be included.

The report is designed to work with the Narrative Web Report. There is a 'Home' link on each page to the home page of the Narrative Web Report. There is also an option to include links from the individuals on the calendar to the same individual on the Narrated Web Site. Note that there are no links from the Narrated Web Site back to the Web Calendar.

Working with the Narrated Web Site requires that the two reports have been constructed in a compatible way by the user. There is no automated check that the two are compatible. If the pages are not compatible, then the user will likely get a 'Page not found' error.

Compatibility depends on:

  1. Including the same individuals in the two reports,
  2. Storing the pages in compatible directories.

In order to include the same individuals in the two reports, the same filters should be used, and similar options with regard to including living individuals (the Web Calendar does not have an option to remove 'private' information).

By default, the Narrated Web Site is stored in the directory "~/NAVWEB", and by default the Web Calendar is stored in the directory '~/WEBCAL'. If these defaults are retained, then the various links should work properly. If the directories have been changed, then the 'Home link' under the 'Content Options' and the 'Link prefix' under the 'Advanced Options' will need to be changed accordingly.

If the Web Calendar is to be used without an associated Narrative Web Site, then the text in the 'Home link' under the 'Content Options' should be deleted to ensure that no 'Home' link is generated.

Quick Views

Fig. 11.7.6 Quick View context menu on Person View

Quick views are popup windows that are available in the context menu's of person, family, ... They are easy to make by users, even with limited coding knowledge.

Many users want to produce a view 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.

These views 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.

Back to Index of Reports.

Previous Index Next