Gramps 4.1 Wiki Manual - Reports - part 7

From Gramps
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: [https://www.gramps-project.org/...]), not via internal links.
Also, only use the known Typographical conventions


Previous Index Next




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

Back to Index of Reports.

Web Pages

Narrated Web Site

The Narrated Web Site report generates a web site (that is, a set of linked web pages), for a set of selected individuals.

Fig. 11.7.1 Narrated Web Site report - sample output - Individual List Page using the Mainz StyleSheet


Introduction

Fig. 11.7.2 Narrated Web Site report - sample output - Individual Detail Page using Nebraska StyleSheet

The Narrated Web Site report introduced in Gramps 4.1 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 transferring 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 six tabs: Report Options, Page Generation, Privacy, Download, Advanced Options and Place Map Options. Each of those tabs are reviewed below.

Fig. 11.7.3 The default appearance of pages printed from a Narrative Website web page
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. 11.7.4 Narrated Web Site Report - Report Options
Fig. 11.7.5 Basic Style - 5 Color Choices
  • Checkbox unchecked: 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.
  • 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.
  • Web site title: Default:My Family Tree
The title of the web site. You can enter a custom site title in this option.
  • Filter: 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
Any person matching this filter who is not excluded due to the privacy rules, will be included in the output.
  • Filter Person: The center person for the report.
  • Name Format: Select the format to display the names. Choose from Default / Surname, Given Suffix / Given Surname Suffix / Given / Main Surnames, Given Patronymic Suffix / SURNAME, Given (Common)
  • 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/
  • Stylesheet
Gramps provides seven built in style sheets for you to choose from to determine the appearance or your web pages. In Gramps 4.1 you can 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 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.
  • Navigation Menu Layout:
Choose which layout for the Navigation Menus.
  • Horizontal -- Default
  • Vertical -- Left Side
  • Fade -- Webkit Browsers Only
  • Drop-Down -- Webkit Browsers Only
  • Citation Referent Layout
Determine the default layout for the Source Page's Citation Referents section
  • Normal Outline Style (Default)
  • Drop-Down -- Webkit Browsers Only
  • Check Box: 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.
  • 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 note, Home Page images, Introduction note, Introduction image, Publisher Contact note, Publisher Contact image
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, 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.
  • Check box:Include images and media objects
This option determines whether to include/exclude a gallery of media objects on your website.
  • Check box: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.
  • Max width of initial image: Default:800
This allows you to set the maximum width of the image shown on the media page. Set to 0 for no limit.
  • Max height of initial image: Default:800
This allows you to set the maximum height of the image shown on the media page. Set to 0 for no limit.
  • Check Box: 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.

  • Check box:Include records 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.
  • 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 – Exclude 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: The default value is 30 years.
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.
Gnome-important.png
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.

Download

  • Check Box: Include download page: Whether to include a database download option.
  • Download Filename: File to be used for downloading.
  • Description for download: Give a description for this file. Default:Smith Family Tree
  • Download Filename: File to be used for downloading.
  • Description for download: Give a description for this file. Default:Johnson Family Tree

Advanced 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-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
  • Include link to active person on every page: (If they have a webpage)
  • 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 half and/ or step-siblings on the individual pages
  • Sort all children in birth order
  • Include family pages
  • Include event pages
  • Include repository 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.)
  • Include address book pages

Place Map Options

  • Map Service: Choose your choice of map service for creating the Place Map Pages
    • Google
    • OpenStreetMap
  • Check Box: Include Place map on Place Pages: Whether to include a place map on the Place Pages, where Latitude/ Longitude are available.
  • Check Box: 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.
  • Google/ FamilyMap Option: Select which option that you would like to have for the Google Maps Family map pages...
    • Family Links
    • Drop
    • Markers


Web Calendar

Fig. 11.7.6 Web Calendar Report - default HTML output using the Basic-Ash Style Sheet

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

Introduction

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

Gramps-notes.png
Note

That there are no links from the Narrated Web Site Report back to the Web Calendar Report.

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:

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

Report Options

Fig. 11.7.7 Web Calendar - Report Options dialog.
  • Destination: The destination directory for the web files
  • Calendar Title: The title of the calendar. Default: My Family Calendar
  • Filter: 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 filter.
  • Name Format: Select the format to display the names. Choose from Default / Surname, Given Suffix / Given Surname Suffix / Given / Main Surnames, Given Patronymic Suffix / SURNAME, Given (Common)
  • File extension: The extension to be used for the web files.
    • .html (Default)
    • .htm
    • .shtml
    • .php
    • .php3
    • .cgi
  • Copyright: The copyright to be used for the web files.
    • Standard copyright (Default)
    • Creative Commons - By attribution
    • Creative Commons - By attribution, No derivations
    • Creative Commons - By attribution, Share-alike
    • Creative Commons - By attribution, Non-Commercial
    • Creative Commons - By attribution, Non-Commercial, No derivations
    • Creative Commons - By attribution, Non-Commercial, Share-alike
    • No copyright notice
  • StyleSheet: The stylesheet to be used for the web pages.
    • Basic-Ash (Default)
    • Basic-Blue
    • Basic-Cypress
    • Basic-Lilac
    • Basic-Peach
    • Basic-Spruce
    • Mainz
    • Nebraska
    • No style sheet
    • Visually Impaired

Content Options

  • Check Box: Create multiple year calendars
    • Start Year for the Calendar(s): (Defaults to current year)
    • End Year for the Calendars(s): (Defaults to current year)
  • Country for holidays: Select the country to see associated holidays.
  • Birthday surname: Select married women's displayed surname.
    • Wives use their own surname (Default)
    • Wives use husband's surname (from first family listed)
    • Wives use husband's surname (from last family listed)
  • First day of week: Select the first day of the week for the calendar. Default: Sunday
  • Home link: The link to be included to direct the user to main page of the web site. Default: ../../Family Tree 1_NAVWEB/index.html
  • Check Box: Include only living people.
  • Check Box: Include birthdays
  • Check Box: Include anniversaries

Jan - Jun Notes

Select an existing note for the month.

  • January Note:
  • February Note:
  • March Note:
  • April Note:
  • May Note:
  • June Note:

Jul - Dec Notes

Select an existing note for the month:

  • July Note:
  • August Note:
  • September Note:
  • October Note:
  • November Note:
  • December Note:

Advanced Options

  • Character set encoding: The encoding to be used for the web files
    • Unicode UTF-8 (recommended) (Default)
    • ISO-8859-1
    • 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
  • Check Box: Create "Year At A Glance" Calendar
  • Check Box: Create one day event pages for Year At A Glance Calendar
  • Check Box: Link to Narrated Web Report
    • Link prefix: A Prefix on the links to take you to Narrated Web Report. Default: ../../Family Tree 1_NAVWEB/



Back to Index of Reports.


Previous Index Next