Gramps 5.2 Wiki Manual - Reports - part 7

Previous

Index

Next

Languages:

English • Deutsch • español • suomi • français • עברית • македонски • Nederlands • русский • shqip • slovenčina

Back to Index of Reports.

Fig. 13.7.1 Reports >Web Pages>... Menu overview

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

Web Pages

Narrated Web Site

For this report to work requires that the optional prerequisite PyICU be installed

See:

Prerequisites for Narrated Web Site

Do you really want to use the entire Family Tree database

Be aware that if you select the Entire Database filter option for your Family Tree database that a large number of files will be generated (depending on the size of your Family Tree database). It is recommended to start with a smaller filter (for example: ancestors of a certain person) to simplify the output while you learn about the Narrated Web Site Report.

Fig. 13.7.2 Narrated Web Site - Web Pages - Individuals (index) page - default HTML output - example

The Narrated Web Site report generates a web site (that is, a set of linked web pages), for a set of selected individuals and 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 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.

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

Generating Pages...

When you select the OK button, the generation of the web pages will start. So first check all options on the each of the Dialog tabs

Dialog tabs

The Narrated Web Site report dialog has the following tabs each are reviewed below.

Report Options

Fig. 13.7.3 Narrated Web Site - Web Pages - Report Options - tab default options

Store web pages in .tar.gz archive (Checkbox unchecked by default) If you have trouble transferring the files to an external web host, you can create a single gzip'd tar file to more easily upload the data. 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 and uncompressed on the website host. Unfortunately not all web servers support saving web files in this way, so contact your hosting provider for more information.
Destination: (~/yourhomedirectory/<Family Tree Name>+NAVWEB default) The destination directory for the web files.
Web site title: (My Family Tree default) The title of the web site. You can enter a custom site title in this option. Strongly suggested you change this from the default
Filter: (Any person matching this filter who is not excluded due to the privacy rules, will be included in the output.) choose between
- Entire Database (Default)
- Descendants of active person
- Descendant families of active person
- Ancestors of active person
- People with common ancestor with active person
Filter Person: The center person for the report. (defaults to Active person)
- Show the relationship between the current person and the active person (Checkbox unchecked by default) - For each person page.

Please note that compliance with privacy laws and individuals' privacy concerns is your responsibility as the researcher.

The Gramps project cannot be held responsible for privacy law compliance or other privacy issues. Privacy of personal information is an important issue.

Gramps provides tools and settings that give some control over the privacy of your data... but these controls were built to meet the regional considerations for that tool's programmer. You are responsible for verifying compliance before publication.

Living People How to handle 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.
- Exclude – (Default) Excludes all information of all individuals who are possibly still alive
- Include Last Name Only
- Include Full Name Only
- Include – Include all information of all individuals even if they are possibly still alive
Years from death to consider living: (30 default) This option is inactive if the "Living People" option is set to Include.

Privacy requirements can extend after Death. Laws vary regionally

Some countries have laws that specify a certain number of years after death before an individual's information can be published. Here you can comply with such laws by specifying the number of years after death to continue to apply Privacy redactions.

Include data marked private: Whether to include private objects. 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. (checkbox unchecked by default)

HTML Options

Fig. 13.7.4 Narrated Web Site - Web Pages - HTML Options - tab default options

File extension: The extension to be used for the web files.
- .html (Default)
- .htm
- .shtml
- .php
- .php3
- .cgi
Copyright: (Standard copyright default) 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. 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/
StyleSheet: Gramps provides seven built in style sheets for you to choose from to determine the appearance or your web pages. Choose between Basic (Ash, Blue, 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 can be found in css/narrative-screen.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. If you want your own stylesheet, you can copy one of the existing stylesheet in $HOME/.gramps/css/. This directory doesn't exist. You must create it before copying your future stylesheet. Change its name. If you ask for a new report, this new stylesheet will be added to the list of preexisting stylesheets.
Navigation Menu Layout: Choose which layout for the Navigation Menus. (Only available for selected Stylesheets)
- Horizontal -- Default
- Vertical -- Left Side
- Fade -- Webkit Browsers Only
- Drop-Down -- Webkit Browsers Only
Citation Referents Layout: Determine the default layout for the Source Page's Citation Referents section
- Normal Outline Style (Default)
- Drop-Down -- Webkit Browsers Only
Include ancestor's tree: Checking this box will include an ancestor graph on each individual’s detail page if they have defined ancestors in your database. (checkbox checked by default) ( Note: Narrated Website Ancestry Tree Design Notes discusses creating a compact Ancestry trees using the Buchheim/Walker algorithm.)
- You can change the number of generations shown from the Display tabs Graph generations: option.
Add previous/next (checkbox unchecked by default) - adds links to the navigation bar.
This is a secure site (https) (checkbox unchecked by default)
Toggle sections (checkbox unchecked by default) - Check if you want to open/close a section

Display

Fig. 13.7.5 Narrated Web Site - Web Pages - Display - tab default options

Name Format: Select the format to display the names. Choose from Surname, Given Suffix / Given Surname Suffix / Given / Main Surnames, Given Patronymic Suffix / SURNAME, Given (Common)
Do we use multiple translations? (checkbox unchecked by default) - Whether to display the narrative web in multiple languages. See the translation tab to add a new languages to the default one defined in the next field.
Translation: - The translation to be used for the report.
Date format: - The format and language for dates, with examples.
Gramps ID: - Option determines whether to hide or show the Gramps ID of objects in your web page output.
- Do not include (default)
- Include
Tags: - Whether to include tags
- Do not include (default)
- Include
Sort all children in birth order(checkbox unchecked by default) - Whether to display children in birth order or in entry order?
Do we display coordinates in the places list?(checkbox unchecked by default) - Whether to display latitude/longitude in the places list?
Sort places references either by date or by name(checkbox unchecked by default) - Sort the places references by date or by name. Not set means by date.
Graph generations :This option is inactive if the Include ancestor's tree option on the HTML Options tab 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.
Include narrative notes just after name, gender(checkbox checked by default) - Unchecked will show them just before attributes.

Page Generation

Fig. 13.7.6 Narrated Web Site - Web Pages - Page Generation - tab default options

The Page Generation tab provides options for creation of commonly expected supplemental webpages and annotations common to all webpages throughout the generated website.

The first options are used to control generation of three supplemental pages: Home (Home webpage), Introduction (FAQ or About Us webpage) and Publisher Contact (Contact Us webpage).

Each of supplemental pages may be assigned a specific Media or Note item. By default, no content (neither media nor text from a Note) is assigned to these pages.

Content for these pages must originate as Media or Notes items that have been created before running the report. Once the desired items have been added to your Tree, you will be able to choose them from a list of Notes or Media Objects.

Planning for sustainability

These special-purpose items do not need to have References associated with any other record in the Tree. However, you might find it helpful to add a Source your generated Website as a distinct Source (marked as Private) to your Tree.
This private Source could use the References as a special-purpose item checklist... with an added Note to document the options used to generate the Narrated Website.
Add another note documenting any idiosyncracies encountered when publishing the site.
Such internal documentation makes reproducing the same appearance easier when generating website updates in the future.

Home page note: Display an individual Note of your choice.
Home page image: Display an individual Media Object of your choice.
Introduction note: Display an individual Note of your choice.
Introduction image: Display an individual Media Object of your choice.
Publisher contact note: Display an individual Note of your choice.
Publisher contact image: Display an individual Media Object of your choice.

Privacy & Spam Exposure Risk

Please use the Publisher contact page with caution if you will be publishing your web pages on a publicly accessible web server. Consider using a single-use (disposable) eMailbox or secure form mail system.

HTML user header: Display an individual Note of your choice. This annotation text will appear directly below the site title on every web page.
HTML user footer: Display an individual Note of your choice. This annotation text will appear within the footer, above the copyright statement on every web page.
PHP user session: A note to use for starting the php session. This option will be available only if the .php file extension is selected.

Extra Pages

Fig. 13.7.7 Narrated Web Site - Web Pages - Extra Pages - tab default options

Extra page name: (blank) - Your extra page name like it is shown in the menubar.
Your extra page path: (blank) - Your extra page path without extension.
- find folder button

Images Generation

Fig. 13.7.8 Narrated Web Site - Web Pages - Image Generation - tab default options

Include images and media objects This option determines whether to include/exclude a gallery of media objects on your website. (checkbox checked by default)
Create the images index This option allows you to create the images index. (checkbox unchecked by default)
Include unused images and media objects This option determines whether to include/exclude a gallery of unused media objects on your website. (checkbox unchecked by default)
Create and only use thumbnail- sized images : This option allows you to create only thumbnail images instead of full-sized images on the Media Page. This will allow you to have a much smaller total upload size to your web hosting site. (checkbox unchecked by default)
Create the thumbnail index : This option allows you to create the thumbnail index (checkbox unchecked by default)
Max width of initial image: (800 default) This allows you to set the maximum width of the image (in pixels) shown on the media page.

Considerations for choosing image width

The width options need further expansion but discussions on the MailLists provide some added insight.

See also:
(Gramps-devel) NarrativeWeb and large images - Mk II

Some idiosyncratic browser support for images on iPad has been reported:
(Gramps-users) Narrated website images don't appear on iPad [SOLVED]

If the image contains regions, the size will be resized to max_width. If the width of an image is less than max_width, no resizing will occurs.

Fig. 13.7.9 Example of image reference regions - Media tab of HTML output for "Narrative Web" Report

Note that image reference regions are also displayed in the Narrative Web HTML pages created with Gramps. There are no special options necessary for this feature, other than the existence of reference regions for 1 or more images. Narrative Web displays reference regions for people and place objects only.

Download

Fig. 13.7.10 Narrated Web Site - Web Pages - Download - tab default options

Include download page: Whether to include a database download option. (checkbox unchecked by default)
How many downloads: (2 default) The number of download files to include in the download page
Download Filename #1: Select the file to be used for downloading of database.
Description for download: (Family Tree #1 default) Give a description for this file.
Download Filename #2: Select the file to be used for downloading of database.
Description for download:(Family Tree #2 default) Give a description for this file.
Download Filename #3: Select the file to be used for downloading of database.
Description for download:(Family Tree #3 default) Give a description for this file.

Advanced Options

Fig. 13.7.11 Narrated Web Site - Web Pages - Advanced Options - tab default options

These settings address the amount of information displayed on the Surname detail and Individual index web pages.

Character set encoding: The encoding to be used for the web files.
- Unicode UTF-8 (recommended) (Default)
- ISO-8859-1 - ISO/IEC character set standard: Part 1 (Latin 1: Western European)
- ISO-8859-2
- ISO-8859-3
- ISO-8859-4
- ISO-8859-5
- ISO-8859-6
- ISO-8859-7
- ISO-8859-8
- ISO-8859-9
- ISO-8859-10
- ISO-8859-13
- ISO-8859-14
- ISO-8859-15
- koi8_r - Kod Obmena Informatsiey, 8 bit ("Code for Information Exchange - 8 bit")
Include link to active person on every page: (If they have a webpage) (checkbox unchecked by default)
Include a column for birth dates on the index pages(checkbox checked by default)
Include a column for death dates on the index pages(checkbox unchecked by default)
Include a column for partners on the index pages(checkbox unchecked by default)
Include a column for parents on the index pages(checkbox unchecked by default)
Include half and/ or step-siblings on the individual pages(checkbox unchecked by default)

Include

Fig. 13.7.12 Narrated Web Site - Web Pages - Include - tab default options

Include family pages(checkbox unchecked by default)
Include event pages(checkbox unchecked by default)
Include places pages(checkbox unchecked by default)
Include unused place pages(checkbox unchecked by default)
Include sources pages(checkbox unchecked by default)
Include repository pages(checkbox unchecked by default)
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.(checkbox unchecked by default)
Include address book pages(checkbox unchecked by default)
Include the statistics page(checkbox unchecked by default)

Place Map Options

Fig. 13.7.13 Narrated Web Site - Web Pages - Place Map Options - tab default options

Map Service: Choose your choice of map service for creating the Place Map Pages
- OpenStreetMap (default)
- Stamen Map
- Google : For this option to work requires a Google maps API key to be entered. To apply for one goto the Google maps platform ( https://cloud.google.com/maps-platform/ ) and select "Get Started" (top right corner) and follow the instructions (may involve a credit card) and then select the "Credentials" option on the "API Manager" menu . Then click on the "Create Credentials" button on the "Credentials" window. Click on "API Key "on the next pop-up window. Copy the generated API key to your clipboard and paste in to Gramps "Google maps API key:" field. I strongly suggest that after generating and placing your report online that you go back to the google maps platform and Click the "Restrict key" button on the API key created window and add your domain (this will stop other website hijacking your api key and making you pay! These new Google Maps API changes came into affect from the 11th of June 2018. see the pricing table https://cloud.google.com/maps-platform/pricing/sheet/ "You also get a recurring $200 credit on your billing account each month to offset your usage costs, and you can set usage limits to protect against unexpected cost increases"
Include Place map on Place Pages: Whether to include a place map on the Place Pages, where Latitude/ Longitude are available. (checkbox unchecked by default)
Include Family Map Pages with all places shown on the map: Whether or not to add an individual page map showing all the places on this page. This will allow you to see how your family traveled around the country. (checkbox unchecked by default)
Google/ FamilyMap Option: Select which option that you would like to have for the Google Maps Family map pages...
- Family Links (default)
- Drop
- Markers
Google maps API key: The API key used for the Google maps. This key is mandatory and must be valid
How to get the API key: https://developers.google.com/maps/documentation/javascript/get-api-key

To get a "Google maps API key:"

visit https://cloud.google.com/maps-platform/pricing/sheet/ as a cost may be involved as well as the use of a credit card

Stamen Options:
Stamen maps API key:
How to get the API key:
openlayers version to use:
Coordinates format:

Other inclusion (CMS, web calendar, PHP)

Fig. 13.7.14 Narrated Web Site - Web Pages - Other inclusion (CMS, web calendar, PHP) - tab default options

Do we include these pages in a CMS web? (Checkbox unchecked by default)
- URI: /NAVWEB (default) - Where do you place your website ?
Include the news and updates page? (Checkbox checked by default) Whether to include a page with the last updates
Max days for updates: 1 (default) - You want to see the last updates on how many days?
Max number of updates per object to show: 1 (default) - How many updates do you want to see max?

Translations

Fig. 13.7.15 Narrated Web Site - Web Pages - Translations - tab default options

This article's content is incomplete or a placeholder stub.
Please update or expand this section.

Calendar Options

Fig. 13.7.16 Narrated Web Site - Web Pages - Calendar Options - tab default options

This article's content is incomplete or a placeholder stub.
Please update or expand this section.

Example Web Site output

The following sections show the default appearance of web pages the Narrative Website web page report.

This article's content is incomplete or a placeholder stub.
Please update or expand this section.

Home

(optional page)

Introduction

(optional page)

Individuals

Individuals (index) (default page) Filename: individuals.html

Fig. 13.7.17 Narrated Web Site - Web Pages - Individuals (index) page - default HTML output - example

Surnames

Surnames (index) (default page) Filename: index.html

Surnames count

Surnames (count index - sorted by "Number of People" column) (default page) Filename: surnames_count.html

Families

(optional page)

Events

(optional page)

Places

Places (index) (default page) Filename: places.html

Sources

Sources (index) (default page) Filename: sources.html

Repositories

(optional page)

Media

(default page)

Thumbnails

(default page)

Download

(optional page)

Address Book

(optional page)

Contact

(optional page)

Updates

Updates (default page) Filename: updates.html

HTML Code type Notes

In this subsection, the word tag does not refer to Gramps marker tags but instead refer to HTML formatting tags!

Notes set to the HTML Code type will be inserted under the object to which they are attached. This allows special

The HTML chunks must be well-formed, with all tags properly closed, to avoid conflicts with the rest of the webpage generated by the report. Only insert tags in a HTML Code-type Note that would normally be contained within the body of a HTML document.

The following tags will always be ignored: html, meta, doctype, head, meta, title, link, script, body

all other tags will be available : i, a, p, ol, ul, div, h1-h7, button, svg, table, tr, td, …

This article's content is incomplete or a placeholder stub.
Please update or expand this section.

Prerequisites for Narrated Web Site

For Gramps 5.2.x, you need to install Pyicu version ?.? and above and the associated packages.

Possible problems

Report shows "Failed Loading Plugin" name 'localAlphabeticIndex' is not defined : do you have the prerequisite pyicu installed ? (gramps -v from the command line may help you)
Other : Report a bug

Web Calendar

The Narrated Web Site Report does not hyperlink back into the Web Calendar Report.

Fig. 13.7.18 Web Calendar Report - Web Pages - default Calendar for December 2018 - HTML output

The Web Calendar shows events for the selected individuals on a set of monthly calendars. You can run this report via the menu Reports > Web Pages > Web Calendar....

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 Site Report. If selected there is a 'Home' link on each page to the home page of the Narrative Web Site Report. There is also an option to include links from the individuals on the calendar to the same individual on the Narrated Web Site.

Working with the Narrated Web Site Report 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:

Including the same individuals in the two reports,
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 Report is stored in the directory "~/<Family Tree Name>+NAVWEB", and by default the Web Calendar is stored in the directory "~/<Family Tree Name>+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 uncheck the Link to Narrated Web Report option on the Advanced Options tab this will ensure that no 'Home' link is generated.

This article's content is incomplete or a placeholder stub.
Please update or expand this section.