Gramps 4.2 Wiki Manual - Reports - part 7

From Gramps
Jump to: navigation, search
Previous Index Next


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

Back to Index of Reports.

Web Pages

Narrated Web Site

Gramps-notes.png

Please update or expand this section.


Gnome-important.png
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. 11.7.1 Narrated Web Site report - sample output - Individual List Page using the Mainz StyleSheet

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

Gnome-important.png
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 window Narrated Web Site has six tabs each are reviewed below.

Report Options
Fig. 11.7.2 Report Options
Fig. 11.7.3 Basic Style - 5 Color Choices
  • Checkbox: 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)
  • 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)
  • File extension: The file extension to be used for the web files. Choose between .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.
  • 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 Referent 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)
  • 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.


Page Generation
Fig. 11.7.4 Page Generation
Narrative Web gallery example showing image reference regions

The following options can be set to generate three supplemental pages: Home, Introduction and Contact(Publisher Contact). From this tab you can also 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 that you have previously created. 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: Display an individual Note of your choice.
  • Home Page images: 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. Please use the Publisher contact page with caution if you are publishing your web pages on a publicly accessible web server.
  • Publisher Contact image: Display an individual Media Object of your choice.Please use the Publisher contact page with caution if you are publishing your web pages on a publicly accessible web server.
  • HTML user header: Display an individual Note of your choice. This text will appear directly below the site title on every web page.
  • HTML user footer: Display an individual Note of your choice. This text will appear within the footer, above the copyright statement on every web page.
  • 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 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)
  • 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. Set to 0 for no limit.
  • Max height of initial image: (600 default) This allows you to set the maximum height of the image (in pixels) shown on the media page. Set to 0 for no limit.
  • Suppress Gramps ID: This option determines whether to include the Gramps ID of objects in your web page output. (checkbox unchecked by default)


Privacy
Gnome-important.png
Please note that compliance with privacy laws and individuals' privacy concerns is as a researcher your responsibility.

The Gramps project cannot be held responsible for privacy law compliance or other privacy issues.

Fig. 11.7.5 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 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)
  • 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.
Gnome-important.png
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.


Download
Fig. 11.7.6 Download
  • Include download page: Whether to include a database download option. (checkbox unchecked by default)
  • Download Filename: Select the file to be used for downloading of database.
  • Description for download: (Smith Family Tree default) Give a description for this file.
  • Download Filename: Select the file to be used for downloading of database.
  • Description for download:(Johnson Family Tree default) Give a description for this file.


Advanced Options
Fig. 11.7.7 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) (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)
  • Sort all children in birth order(checkbox unchecked by default)
  • Include family pages(checkbox unchecked by default)
  • Include event 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)


Place Map Options
Fig. 11.7.8 Place Map Options
  • Map Service: Choose your choice of map service for creating the Place Map Pages
    • Google (default)
    • OpenStreetMap
  • 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


Example Web Site output

Fig. 11.7.9 The default appearance of pages printed from a Narrative Website web page


Home

(optional page)

Introduction

(optional page)

Individuals

(default page)

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


Surnames

(default page)

Families

(optional page)

Events

(optional page)

Places

(default page)

Sources

(default page)

Repositories

(optional page)

Media

(default page)

Thumbnails

(default page)

Download

(optional page)

Address Book

(optional page)

Contact

(optional page)

Web Calendar

Gramps-notes.png

Please update or expand this section.


Gnome-important.png
Note

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

Fig. 11.7.11 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. 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. 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:

  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 "~/<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 the text in the 'Home link' under the 'Content Options' should be deleted to ensure that no 'Home' link is generated.

Dialog tabs

The Web Calendar report dialog window Narrated Web Site has five tabs each are reviewed below.

Report Options
Fig. 11.7.12 Report Options
  • Destination: ~/yourhomedirectory/<Family Tree Name>+WEBCAL The destination directory for the web files.
  • Calendar Title: (My Family Calendar default) The title of the 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. (Default: Active person)
  • Name format: Select the format to display the names. Choose from Surname, Given Suffix(default) / 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
Fig. 11.7.13 Content Options
  • Create multiple year calendars (checkbox unchecked by default)
    • 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. (Defaults to blank)
  • First day of week: Select the first day of the week for the calendar. (Default: Sunday)
  • 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)
  • Home link: (../../Family Tree 1_NAVWEB/index.html default) The link to be included to direct the user to main page of the web site.
  • Include birthdays (checkbox checked by default)
  • Include anniversaries (checkbox checked by default)


Jan - Jun Notes
Fig. 11.7.14 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
Fig. 11.7.15 Jul - Dec Notes

Select an existing note for the month:

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


Advanced Options
Fig. 11.7.16 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
  • Create "Year At A Glance" Calendar (checkbox unchecked by default)
  • Create one day event pages for Year At A Glance Calendar (checkbox unchecked by default)
  • Link to Narrated Web Report (checkbox unchecked by default)
    • Link prefix: ../../Family Tree 1_NAVWEB/ A Prefix on the links to take you to Narrated Web Report.


Example Web Site output


Back to Index of Reports.


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.
Also, only use the known conventions