Difference between revisions of "Gramps 3.0 Wiki Manual - Reports"

From Gramps
Jump to: navigation, search
m (Narrated Web Site: copy changes, markup changes for 'Report Options')
Line 376: Line 376:
  
 
==== Introduction ====
 
==== Introduction ====
GRAMPS 2.0.6 introduced the Narrative Web generator. The new Narrative Web Site report provides improved functionality, support for web standards and additional features. Instead of using HTML templates to customize the pages, CSS style sheets are used.
+
GRAMPS 2.0.6 introduced the Narrative Web generator. The GRAMPS 3.0 Narrative 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.
  
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 family history.
+
==== Using the Report ====
 +
The Narrative 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...'''.
  
This report provides the user with a large number of options to allow for a wide range of customization. You can run this report view via the menu '''Reports-->Web Pages-->Narrated Web Site...'''.
+
The Narrative Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Options''', '''Page Generation''', '''Privacy''' and '''Advanced'''. Each of those tabs are reviewed below.
 +
{{man warn|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.}}
  
The Narrative Web Site report dialog window {{man label|Narrated Web Site}} has four tabs: '''Report Option''', '''Page Generation''','''Privacy''', and '''Advanced'''. Let's have a look on all those options.
+
==== Report Options ====
{{man warn|Entire Database|If you select as a filter your entire database, you must be aware that depending on the size of your database, the amount of web files that are generated can be huge. May be a better approach is to start with a filter (say ancestors of a certain person) so you can start to find out what the generated output is.}}
 
 
 
==== Report options ====
 
 
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]
 
[[Image:NWeb-Man-Nebr.jpg|right|250px|thumb|fig. c.2 Individual Detail Page in Nebraska Style]]
* check box archive: By default, the output files are written to the specified directory. Because of the number of files and directories that are created, it may be difficult to transfer the files to an external web host. To aid in this, you may directly create a gzip'd tar file to more easily upload the data. This is the format that should be used if you would like to take advantage of the free genealogy page hosting at the GRAMPS web hosting site. To select the gzip'd tar file, select the {{man label|Store web pages in .tar.gz archive}} option.
+
;Store web pages in .tar.gz archive
* Destination: the destination directory for the web files. Default value is the {{man label|/yourhomedirectory/NAVWEB}} directory. Genealogy records can generate a lot of files. Many web servers have a difficult time with many files in a single directory. The Narrative Web Generator strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated files names are not intuitive, but are unique per person. Subsequent runs will generate identical file names, making it easy to replace files.
+
:By default, the output files are written to the specified directory. Because of the number of files and directories that are created, it may be difficult to transfer the files to an external web host. To aid in this, you may directly create a gzip'd tar file to more easily upload the data. This is the format that should be used if you would like to take advantage of the free genealogy page hosting at the GRAMPS web hosting site. To select the gzip'd tar file, select the {{man label|Store web pages in .tar.gz archive}} option.
* Filter: Like the previous web page generator, and most of the other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but you are free to use the Custom Filter Editor tool to create your own.
+
;Destination
* Filter Person: becomes available only if you did not select the entire database. Use the {{man button|Edit}} button to select a different person.
+
:The destination directory for the web files. Default value is the {{man label|/yourhomedirectory/NAVWEB}} directory. Genealogy records can generate a lot of files. Many web servers have a difficult time with many files in a single directory. The Narrative Web Generator strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated files names are not intuitive, but are unique per person. Subsequent runs will generate identical file names, making it easy to replace files.
* Web site title: in this text field you can change the default value '''My Family Tree'''
+
;Filter
* File extension: the extension to be used for the web files. Choose between the {{man label|.html}} default value, and .htm, .shtml, .php, .php3, and .cgi.  
+
:Like the previous web page generator, and most of the other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but you are free to use the Custom Filter Editor tool to create your own.
* Copyright: The copyright to be used for the web files. International copyright law reserves all rights to your data. You own the data, and people must get your permission to use it. In genealogy, however, sharing data is a common ideal. It this case, you may wish to grant the user more rights. While the default for GRAMPS is to place a notice indicating that all rights are reserved, we give you the option to place your site under one of several of the Create Commons licenses. With a Creative Commons license, you grant user's certain permission to use your data without requiring them to contact you directly for permission. See the Creative Commons web site for more information. Choose between the {{man label|Standard Copyright}} default and seven other possibilities varying from Creative Commons -By attribution, Non-commercial to No copyright notice.
+
;Filter Person
* Character set encoding: The encoding to be used for the web files. Because of GRAMPS internationalization ability, the default character set for the HTML pages is {{man label|UTF-8}}. From the drop down menu list you can select a lot of {{man label|ISO-8859-}} encoding sets and even a {man label|koi8_r}} encoding set.This provides support for virtually all characters. The Apache web server is sometimes misconfigured to override the character set specified in an HTML page. This causes problems with the UTF-8 character set generated by GRAMPS, distorting characters on the screen.
+
:Filter Person is only available if you did not select the entire database. Use the {{man button|Edit}} button to select a different person.
 +
;Web site title
 +
:In this text field you can change the default value '''My Family Tree'''
 +
;File extension
 +
:The extension to be used for the web files. Choose between the {{man label|.html}} default value, and .htm, .shtml, .php, .php3, and .cgi.
 +
;Copyright
 +
:The copyright to be used for the web files. International copyright law reserves all rights to your data. You own the data, and people must get your permission to use it. In genealogy, however, sharing data is a common ideal. It this case, you may wish to grant the user more rights. While the default for GRAMPS is to place a notice indicating that all rights are reserved, we give you the option to place your site under one of several of the Create Commons licenses. With a Creative Commons license, you grant user's certain permission to use your data without requiring them to contact you directly for permission. See the Creative Commons web site for more information. Choose between the {{man label|Standard Copyright}} default and seven other possibilities varying from Creative Commons -By attribution, Non-commercial to No copyright notice.
 +
;Character set encoding
 +
:The encoding to be used for the web files. Because of GRAMPS internationalization ability, the default character set for the HTML pages is {{man label|UTF-8}}. From the drop down menu list you can select a lot of {{man label|ISO-8859-}} encoding sets and even a {man label|koi8_r}} encoding set.This provides support for virtually all characters. The Apache web server is sometimes misconfigured to override the character set specified in an HTML page. This causes problems with the UTF-8 character set generated by GRAMPS, distorting characters on the screen.
 
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}
 
{{man warn|1=Generating Pages...|2=If you hit the {{man button|OK}} button, the generation of the web pages will start. So first check all options on the other tabs: '''Page generation''', '''Privacy''', and '''Advanced'''.}}
If your web server is misconfigured and you do not have privilege to fix the configuration, you may solve this problem by overriding the default character set to match what your web server may be expecting.
+
:If your web server is misconfigured and you do not have privilege to fix the configuration, you may solve this problem by overriding the default character set to match what your web server may be expecting.
 
 
 
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]
 
[[Image:NWeb-Man-BasicSet.jpg|right|180px|thumb|fig. c.3 Basic Style - 5 Color Choices]]
==== Stylesheet ====
+
;Stylesheet
The style sheet to be used for the web page. GRAMPS provides seven built in style sheets for your web page. Each of these style sheets produces a unique look for your pages. At the moment you can choose between the '''Basic styles''': '''Ash''', '''Cypress''', '''Lilac''', '''Peach''', and '''Spruce''' and the style '''Mainz''' or '''Nebraska'''. Or you can use the '''No style sheet''' option. The generated style sheet is named ''narrative.css''. You may edit this file if you wish to further customize your site.
+
:The style sheet to be used for the web page. GRAMPS provides seven built in style sheets for your web page. Each of these style sheets produces a unique look for your pages. At the moment you can choose between the '''Basic styles''': '''Ash''', '''Cypress''', '''Lilac''', '''Peach''', and '''Spruce''' and the style '''Mainz''' or '''Nebraska'''. Or you can use the '''No style sheet''' option. The generated style sheet is named ''narrative.css''. You may edit this file if you wish to further customize your site.
 
+
:''figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0''
To give an impression on the available color schemes, images are included for the different styles and pages.
+
:If you make modifications to your style sheet, you need to be aware the regenerating the pages with the same output directory will overwrite your changes to this file. To prevent this from happening, make sure you choose {{man label|No style sheet}} for subsequent runs.
If you make modifications to your style sheet, you need to be aware the regenerating the pages with the same output directory will overwrite your changes to this file. To prevent this from happening, make sure you choose {{man label|No style sheet}} for subsequent runs.
+
;Include ancestor graph
* check box: Include ancestor graph: whether to include an ancestor graph on each individual page. If you click this box a ancestor graph will be shown. The amount of generations is determined by the next option.
+
:whether to include an ancestor graph on each individual page. If you click this box a ancestor graph will be shown. The amount of generations is determined by the next option.
* Graph generations: the number og generations to include in the ancestor graph. Default value {{man label|4}}. You can choose via the drop down list: 2, 3 4 or 5 generations.
+
;Graph generations
 
+
:the number og generations to include in the ancestor graph. Default value {{man label|4}}. You can choose via the drop down list: 2, 3 4 or 5 generations.
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.
+
: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.
  
 
==== Page Generation ====
 
==== Page Generation ====

Revision as of 16:50, 5 April 2008

This sections describes the different reports available in GRAMPS.


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



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.

Tango-Dialog-information.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

File:Ancestor.png
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

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.

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


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:
    • 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
Fig. a7 Results

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.


  • Ancestor Chart (Wall Chart): This report is similar to the Ancestor Chart report. It provides more options which make it useful for generating huge charts suitable for a poster or a wall chart. These options include the ability to compress the report (getting rid of an empty space) and the option to fit the whole chart on to a single page. In the latter case, the contents of the chart is scaled down appropriately.


Common options for graphical reports are the filename of the output, the format of the output, selected style, page size and orientation. Optionally, the reports can be immediately opened with the default application.

Tango-Dialog-information.png
Tip

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


Graphs

Family Lines Graph

Hourglass Graph

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.

The report produces files that 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 only code generator currently available in GRAMPS is the Relationship Graph producing the GraphViz description of the graph.

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. Specific options for this report include filter and number of generations considered, etc.


Ubuntu Gutsy users can get the deb package via Synaptic or the command line (actual version GraphViz 2.12)

Ubuntu Hardy will support the 2.16 version.

Tango-Dialog-information.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.


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

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.

Birthday and Anniversary Report

Complete Individual Report

This report provides individual summaries similar to that of the Individual Summary report. 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

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

Marker Report


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

Tango-Dialog-information.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 Narrative 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.

Using the Report

The Narrative 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 Narrative 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
By default, the output files are written to the specified directory. Because of the number of files and directories that are created, it may be difficult to transfer the files to an external web host. To aid in this, you may directly create a gzip'd tar file to more easily upload the data. This is the format that should be used if you would like to take advantage of the free genealogy page hosting at the GRAMPS web hosting site. To select the gzip'd tar file, select the Store web pages in .tar.gz archive option.
Destination
The destination directory for the web files. Default value is the /yourhomedirectory/NAVWEB directory. Genealogy records can generate a lot of files. Many web servers have a difficult time with many files in a single directory. The Narrative Web Generator strives to keep the number of files per directory to a manageable level. To do this, a hierarchy of directories is created. The generated files names are not intuitive, but are unique per person. Subsequent runs will generate identical file names, making it easy to replace files.
Filter
Like the previous web page generator, and most of the other GRAMPS reports, you can control what is included in the output by choosing a filter. Several default filters are provided for you, but you are free to use the Custom Filter Editor tool to create your own.
Filter Person
Filter Person is only available if you did not select the entire database. Use the Edit button to select a different person.
Web site title
In this text field you can change the default value My Family Tree
File extension
The extension to be used for the web files. Choose between the .html default value, and .htm, .shtml, .php, .php3, and .cgi.
Copyright
The copyright to be used for the web files. International copyright law reserves all rights to your data. You own the data, and people must get your permission to use it. In genealogy, however, sharing data is a common ideal. It this case, you may wish to grant the user more rights. While the default for GRAMPS is to place a notice indicating that all rights are reserved, we give you the option to place your site under one of several of the Create Commons licenses. With a Creative Commons license, you grant user's certain permission to use your data without requiring them to contact you directly for permission. See the Creative Commons web site for more information. Choose between the Standard Copyright default and seven other possibilities varying from Creative Commons -By attribution, Non-commercial to No copyright notice.
Character set encoding
The encoding to be used for the web files. Because of GRAMPS internationalization ability, the default character set for the HTML pages is UTF-8. From the drop down menu list you can select a lot of ISO-8859- encoding sets and even a {man label|koi8_r}} encoding set.This provides support for virtually all characters. The Apache web server is sometimes misconfigured to override the character set specified in an HTML page. This causes problems with the UTF-8 character set generated by GRAMPS, distorting characters on the screen.
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.

If your web server is misconfigured and you do not have privilege to fix the configuration, you may solve this problem by overriding the default character set to match what your web server may be expecting.
fig. c.3 Basic Style - 5 Color Choices
Stylesheet
The style sheet to be used for the web page. GRAMPS provides seven built in style sheets for your web page. Each of these style sheets produces a unique look for your pages. At the moment you can choose between the Basic styles: Ash, Cypress, Lilac, Peach, and Spruce and the style Mainz or Nebraska. Or you can use the No style sheet option. The generated style sheet is named narrative.css. You may edit this file if you wish to further customize your site.
figures c.1, c.2 and c.3 are examples of the styles currently included with GRAMPS 3.0
If you make modifications to your style sheet, you need to be aware the regenerating the pages with the same output directory will overwrite your changes to this file. To prevent this from happening, make sure you choose No style sheet for subsequent runs.
Include ancestor graph
whether to include an ancestor graph on each individual page. If you click this box a ancestor graph will be shown. The amount of generations is determined by the next option.
Graph generations
the number og generations to include in the ancestor graph. Default value 4. You can choose via the drop down list: 2, 3 4 or 5 generations.
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.

Page Generation

Here you can generate three additional pages by the web page generator. Initially, for all additional pages no note nor image is given. So must first make some media objects or notes. If those objects or notes exist, you can select those needed with the Select buttons on the very right hand side off the screen.

  • Home Page: you can add a Note and an Image. The Home page is a page that will display an image and a whatever text you wish. To enable this page, choose a Media Object from the Home Media/Note ID menu on the Page Generation tab. If the Media Object contains an image, the image is displayed at the top of the page. If the Media Object contains a Note, the Note's text is used for the text of the page.
  • Introduction Page: you can add a Note and an Image. Just choose the Media Object in the Introduction Media/Note ID menu.
  • Publisher contact Page : you can add a Note and an Image. Please use this page with caution, since you may consider your contact information to be private.
  • HTML user header and user footer: you can add Notes to have a customized header and footer on each of the generated pages.
  • three additional check boxes are available:
    • include images and media objects: whether to include/exclude a gallery of media objects.
    • include download page: whether to include a database download option.
    • Suppress GRAMPS ID: whether to include the GRAMPS ID of objects.

Privacy

Privacy of personal information is an important issue on the web today. GRAMPS tries to give you control over the information that is presented.

  • check box include records marked private: GRAMPS provides two options to control the privacy of your information. If you do not select the Include records marked private option, any data that is marked as private will not be displayed on the generated site.
  • Living People: The drop down menu let you choose between Exclude, Restrict, and Include. If you select Restrict information on living people , GRAMPS will attempt to determine which people have the potential of still being alive, and will omit these people from the database. Some countries have laws that indicate that a certain number of years must pass after someone's death before information can be published.
  • Years from death to consider living: in the input field you can give the amount of years to consider. The default value is 30 years. The Years to restrict from person's death option allows you to specify how many years a person must be deceased before the information is included. Please note that it is your responsibility to double check all information in the pages for any privacy information. GRAMPS cannot be held responsible for any privacy issues.

Advanced

fig. c.4 The default appearance of pages printed from a Narrative Website web page

in this tab page you can determine which columns will show up in your web pages. those options are controlled via check boxes.

  • 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
  • Organization of the web pages. A lot of files and directories are generated. Default you can find this directory structure under the NAVWEB directory.
    • Directories: Following directories are made: images, img, plc, ppl, src, srn, thumb. Each directory contains many subdirectories: /homedir/NAVWEB/src/1/5/15CF2WIFLGOGFRJMLY.html. This last file is unique. If you regenerate web pages or add records and regenerate your web site those file names remain the same.
    • HTML files: if you choose to generate HTML files following files will be generated: start page : index.html, gallery.html, if clicked a download.html page, places.html, sources.html, and surname_count.html.
    • CSS files: two style sheet files are generated: narrative.css and narrative-print.css
  • Customize your CSS files: You can alter and change the made CSS file very easy. The advantage of a style sheet is that changes you do on this text file, you see immediately the effects on the lay-out and color schemes.

You can customize your style sheet to provide additional formatting and positioning information to control sections.

Tango-Dialog-information.png
Do not forget to check the no style sheet option. Otherwise you will overwrite your custom style sheet.


Web Calendar

Previous [[Gramps {{{3}}} Wiki Manual| Index]] Next