Difference between revisions of "Gramps 4.2 Wiki Manual - Gramplets"

From Gramps
Jump to: navigation, search
(Quick View)
m (Protected "Gramps 4.2 Wiki Manual - Gramplets" ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite)))
 
(12 intermediate revisions by 3 users not shown)
Line 28: Line 28:
 
* Filter Gramplet is like the previous filter sidebar
 
* Filter Gramplet is like the previous filter sidebar
 
* Common models for Notes, Gallery, Sources, Citations, Events
 
* Common models for Notes, Gallery, Sources, Citations, Events
* Children Gramplet on Person views (also ancestry category and relations), family view
+
* Children Gramplet on Person views (also charts category and relationships category), families view
  
 
== General Usage and Configuration ==
 
== General Usage and Configuration ==
Line 34: Line 34:
 
[[Image:GrampletDetached-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Detached Gramplets View]]
 
[[Image:GrampletDetached-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Detached Gramplets View]]
  
In Dashboard You can drag the Properties button (top left) of each Gramplet to move it around the Dashboard View area. You can click the Properties button to detach the Gramplet from Dashboard View and place it in its own window. The window will stay open regardless of page (relationship, ancestry, etc). Closing the detached view will put it back onto the Dashboard view. If you quit Gramps with a open Gramplet, when you start gramps again, it will open automatically.
+
In Dashboard You can drag the Properties button (top left) of each Gramplet to move it around the Dashboard View area. You can click the Properties button to detach the Gramplet from Dashboard View and place it in its own window. The window will stay open regardless of page (relationships, charts, etc). Closing the detached view will put it back onto the Dashboard view. If you quit Gramps with a open Gramplet, when you start gramps again, it will open automatically.
  
 
When one or more Gramplets are undocked from the Dashboard View, you can change to a different view (such as the People or Charts Views). In this way, you can use these Gramplets to supplement a particular view with additional details and functionality provided by the Gramplet.
 
When one or more Gramplets are undocked from the Dashboard View, you can change to a different view (such as the People or Charts Views). In this way, you can use these Gramplets to supplement a particular view with additional details and functionality provided by the Gramplet.
Line 68: Line 68:
 
{{man menu|No Menu option to add a Gramplet is available.}}<!-- Need feature request should appear under Menu > Edit > [Add a Gramplet to sidebar / Add a Gramplet to bottombar] -->
 
{{man menu|No Menu option to add a Gramplet is available.}}<!-- Need feature request should appear under Menu > Edit > [Add a Gramplet to sidebar / Add a Gramplet to bottombar] -->
  
{{stub}}<!--WIP / add links to relevant individual sections for each core Gramplet-->
+
 
 
{{-}}
 
{{-}}
  
Line 554: Line 554:
 
|-
 
|-
 
|<!-- Gramplet --> id="32" |{{man label|[[Gramps_4.2_Wiki_Manual_-_Gramplets#Top_Surnames|Top Surnames]]}}
 
|<!-- Gramplet --> id="32" |{{man label|[[Gramps_4.2_Wiki_Manual_-_Gramplets#Top_Surnames|Top Surnames]]}}
 +
|<!-- Dashboard Category -->X
 +
|<!-- People Category -->X
 +
|<!-- Relationships Category -->X
 +
|<!-- Families Category -->X
 +
|<!-- Charts Category -->X
 +
|<!-- Events Category -->X
 +
|<!-- Places Category -->X
 +
|<!-- Geography Category -->X
 +
|<!-- Sources Category -->X
 +
|<!-- Citations Category -->X
 +
|<!-- Repositories Category -->X
 +
|<!-- Media Category -->X
 +
|<!-- Notes Category -->X
 +
|-
 +
|<!-- Gramplet --> id="35" |{{man label|[[Gramps_4.2_Wiki_Manual_-_Gramplets#Uncollected Objects|Uncollected Objects!]]}}
 
|<!-- Dashboard Category -->X
 
|<!-- Dashboard Category -->X
 
|<!-- People Category -->X
 
|<!-- People Category -->X
Line 621: Line 636:
 
This following sections describe each Gramplet and its basic functionality.
 
This following sections describe each Gramplet and its basic functionality.
 
{{-}}
 
{{-}}
{{stub}}<!--WIP - need to check from here on-->
+
 
 
== Age on Date ==
 
== Age on Date ==
  
Line 633: Line 648:
 
You can also drag a date to from [[Gramps_4.2_Wiki_Manual_-_Gramplets#Calendar|Calendar Gramplet]] to the '''Age on Date''' Gramplets date field to enter that date.  
 
You can also drag a date to from [[Gramps_4.2_Wiki_Manual_-_Gramplets#Calendar|Calendar Gramplet]] to the '''Age on Date''' Gramplets date field to enter that date.  
  
See also the [[Third-party Addon]] [[DateCalculator|Date Calculator Gramplet]] which allows you to do date math.
+
See also the [[Third-party_Addons|Third-party Addon]] [[DateCalculator|Date Calculator Gramplet]] which allows you to do date math.
 
{{-}}
 
{{-}}
  
Line 758: Line 773:
  
 
== Details ==
 
== Details ==
{{stub}}
+
 
 
[[File:Details-gramplet-42.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Details Gramplet]]
 
[[File:Details-gramplet-42.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Details Gramplet]]
  
Line 820: Line 835:
  
 
== FAQ ==
 
== FAQ ==
{{stub}}<!--links in gramplet to wiki are outdated-->
+
 
 
[[File:Faq-gramplet-42.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} FAQ Gramplet]]
 
[[File:Faq-gramplet-42.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} FAQ Gramplet]]
  
Line 827: Line 842:
  
 
== Filter ==
 
== Filter ==
{{stub}}
+
 
  
 
Gramplet providing a filter specific to the Category.
 
Gramplet providing a filter specific to the Category.
Line 889: Line 904:
  
 
== Gallery ==
 
== Gallery ==
{{stub}}
+
 
 
Gramplet showing media objects
 
Gramplet showing media objects
 
{{-}}
 
{{-}}
Line 923: Line 938:
 
[[Image:ImageMetadata-detached-gramplet-40.png|thumb|right|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Image Metadata Gramplet]]
 
[[Image:ImageMetadata-detached-gramplet-40.png|thumb|right|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Image Metadata Gramplet]]
  
The Image Metadata Gramplet offers an interface to add, edit, and remove [https://en.wikipedia.org/wiki/Exchangeable_image_file_format Image Exif Metadata] from your images (*.jpg, *.png. *.tiff, *.exv, *.nef, *.psd, *.pgf).
+
The Image Metadata Gramplet offers an interface to look at [https://en.wikipedia.org/wiki/Exchangeable_image_file_format Image Exif Metadata] from your images (*.jpg, *.png. *.tiff, *.exv, *.nef, *.psd, *.pgf).
 
{{-}}
 
{{-}}
===The interface===
 
====Data Fields====
 
;Photographer:
 
:The name of the person or company taking the image
 
 
;Select Date
 
:Will bring up a calendar, and double-click on a date. The time will be filled in as the current time
 
 
;Date
 
:The Date/ Time needs to be typed in as a very specific format:
 
:Year Mon Day Hour:Minutes:Seconds
 
:1826 Apr 12 14:06:00
 
 
;Copyright
 
:Can be anything that you please... Ex: (C) 2010 Smith and Wesson
 
 
;Subject
 
:Please enter keywords that describe the picture.  Do NOT add a space after the comma. Ex. : Census,Milwaukee,Oregon
 
 
;Latitude/ Longitude
 
:Latitude/ Longitude data can be entered in one of two ways:
 
:# Degrees Minutes Seconds Ex.: 10 59 14
 
:#:In this format, you will need to select latitude reference, and longitude reference
 
:#:If the Latitude begins with a negative number, select 'S' as Lat. Ref. or 'N' if a positive number.  If the Longitude begins with a negative number, select 'W' as the Long. Ref. or 'E' if a positive number.
 
:# Decimal, Ex. : -34.25954
 
:#:In this format, the Latitude and Longitude reference will be selected for you after you click Convert GPS  Coordinates or press the Save button.  For foreign countries that might use a ", " instead of a ".", please use the "."
 
 
;Description
 
:Type in something about the image, the people in it or the location of the image.  Non-latin characters are NOT allowed.  ASCII characters only...
 
 
====Buttons====
 
#Save
 
#:Will write the metadata to the image, and convert latitude/ longitude if it is in decimal format.
 
#Clear
 
#:Will clear all data fields
 
#Convert GPS Coordinates
 
#:will convert Latitude/ Longitude if it is in decimal format
 
 
My favorite source for GPS Coordinates is: http://www.gpsvisualizer.com/geocode
 
  
 
=== Prerequisites ===
 
=== Prerequisites ===
 
{{man tip|Special Note|Before being able to use this Gramplet/Addon, you will need to download and install [https://wiki.gnome.org/Projects/gexiv2 gexiv2]
 
{{man tip|Special Note|Before being able to use this Gramplet/Addon, you will need to download and install [https://wiki.gnome.org/Projects/gexiv2 gexiv2]
or install gexiv2 from your local Linux repository.  Windows user, there is an installer for you.  Ubuntu, use the Universe repository to find gexiv2.'''<br>Also see [[GEPS_029:_GTK3-GObject_introspection_Conversion#GExiv2_for_Image_metadata|GExiv2 for Image metadata]]}}
+
or install gexiv2 from your local Linux repository.  Windows users, this is already present in your installation.  Ubuntu, use the Universe repository to find gexiv2.'''<br>Also see [[GEPS_029:_GTK3-GObject_introspection_Conversion#GExiv2_for_Image_metadata|GExiv2 for Image metadata]]}}
  
 
Once you have installed gexiv2, see above for directions to download and install this addon...
 
Once you have installed gexiv2, see above for directions to download and install this addon...
  
{{stub}}<!--update for gexiv2-->
+
 
 
Pyexiv2 can be used from the command line interface (cli) as well, and from within a python script:
 
Pyexiv2 can be used from the command line interface (cli) as well, and from within a python script:
 
# import the pyexiv2 library
 
# import the pyexiv2 library
Line 1,006: Line 982:
 
# Select an image from the left hand MediaView
 
# Select an image from the left hand MediaView
 
{{-}}
 
{{-}}
 +
 
== Locations ==
 
== Locations ==
 
[[File:Locations-gramplet-42.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Locations Gramplet]]
 
[[File:Locations-gramplet-42.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Locations Gramplet]]
Line 1,060: Line 1,037:
  
 
== Quick View ==
 
== Quick View ==
 +
 
[[Image:QuickView-RelationToHomePersonQV-detached-gramplet-40.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Quick View Gramplet]]
 
[[Image:QuickView-RelationToHomePersonQV-detached-gramplet-40.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Quick View Gramplet]]
  
Line 1,107: Line 1,085:
  
 
== References ==
 
== References ==
{{stub}}
+
 
 
Gramplet showing the References.
 
Gramplet showing the References.
 
{{-}}
 
{{-}}
Line 1,141: Line 1,119:
 
[[Image:Relatives-detached-gramplet-40.png|right|thumb|350px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Relatives Gramplet]]
 
[[Image:Relatives-detached-gramplet-40.png|right|thumb|350px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Relatives Gramplet]]
  
This Gramplet shows all direct relatives of the active person. It's intended use is as a navigation help, an alternative way to move through your Gramps database. If you detach the Gramplet, and place it next to Gramps, it will allow you to use it to easily change the content of the current "person view".
+
This Gramplet shows all direct relatives of the active person. It's intended use is as a navigation help, an alternative way to move through your family tree in Gramps . If you detach the Gramplet, and place it next to Gramps, it will allow you to use it to easily change the content of the current "Person view".
  
If you are working in the ancestry views, the active person is the left-most person. By clicking a name in the relatives Gramplet, you can easily change the active person, and all person view in the other window will update. As the relatives Gramplet shows all spouses, all children and all parents, this offers an alternative way of navigating your data.
+
If you are working in the charts category Pedigree view, the active person is the left-most person. By clicking a name in the relatives Gramplet, you can easily change the active person, and all person view in the other window will update. As the relatives Gramplet shows all spouses, all children and all parents, this offers an alternative way of navigating your data.
  
 
The names in this Gramplet also allow you to call up the person editor directly, by right-clicking on any of the names.
 
The names in this Gramplet also allow you to call up the person editor directly, by right-clicking on any of the names.
 +
 +
The Relatives Gramplet can be added to the following categories:
 +
* People Category
 +
* Relationships Category
 +
* Charts Category
 +
* Geography Category (selected views only)
 
{{-}}
 
{{-}}
 +
 
== Residence ==
 
== Residence ==
{{stub}}
+
 
  
 
Gramplet showing residence events for a person
 
Gramplet showing residence events for a person
Line 1,327: Line 1,312:
 
{{-}}
 
{{-}}
  
 +
== Uncollected Objects ==
 +
 +
{{-}}
 
== Welcome ==
 
== Welcome ==
 
[[Image:Welcome-ToGramps-detached-gramplet-40.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Welcome Gramplet]]
 
[[Image:Welcome-ToGramps-detached-gramplet-40.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Welcome Gramplet]]
Line 1,336: Line 1,324:
 
This information can also be found on the [[Main_page|start page of Gramps]]
 
This information can also be found on the [[Main_page|start page of Gramps]]
 
{{-}}
 
{{-}}
 +
 
== What's Next ==
 
== What's Next ==
 
[[File:WhatIsNext-detached-gramplet-40.png|right|thumb|350px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} What's Next Gramplet]]
 
[[File:WhatIsNext-detached-gramplet-40.png|right|thumb|350px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} What's Next Gramplet]]

Latest revision as of 04:11, 26 June 2018

Previous Index Next


This page details the functionality of the Gramplets that come with Gramps.

Gramps-notes.png
For more Gramplets

that you can extend your Gramps functionality with, see Third-party Addons.
For technical details about creating your own Gramplet, please see Gramplets for Developers.

Contents

What is a Gramplet

Fig. 10.1 Dashboard Category (Default View)

A Gramps Gramplet is a view of data that either changes dynamically during the running of Gramps, or provides interactivity to your genealogical data. Gramplets are the widgets that are part of Gramps and can be seen in the Dashboard Category, Sidebars and Bottombars in other Navigator Categories, they provide all kinds of functionality that can be useful for the researcher.

What is the difference between Gramplets, reports, quick views, and tools?

  • Reports provide a static output format of your data, typically for presentation
  • Quick View provides a typically short, interactive listing derived from your data
  • Tools provide a method of processing your data
  • Gramplets provide a dynamic view and interface to your data


When you first start the Dashboard Category you will see two default Gramplets; the Welcome to Gramps! Gramplet and the Top Surnames Gramplet.

Since Gramps 4.2 we have common and specific Gramplets according active view (navigation/category).

  • Back references Gramplets are like the references tab on object Editor.
  • Filter Gramplet is like the previous filter sidebar
  • Common models for Notes, Gallery, Sources, Citations, Events
  • Children Gramplet on Person views (also charts category and relationships category), families view

General Usage and Configuration

Fig. 10.2 Detached Gramplets View

In Dashboard You can drag the Properties button (top left) of each Gramplet to move it around the Dashboard View area. You can click the Properties button to detach the Gramplet from Dashboard View and place it in its own window. The window will stay open regardless of page (relationships, charts, etc). Closing the detached view will put it back onto the Dashboard view. If you quit Gramps with a open Gramplet, when you start gramps again, it will open automatically.

When one or more Gramplets are undocked from the Dashboard View, you can change to a different view (such as the People or Charts Views). In this way, you can use these Gramplets to supplement a particular view with additional details and functionality provided by the Gramplet.

You can add new Gramplets by right clicking on an open space on Dashboard view.

You can also change the number of columns by changing a setting in configure the active view to open the Configure Gramplets window, to change the Dashboard Layouts > Number of Columns. You can also per added gramplet change its window dimensions and optionally other properties.

If a link in a Gramplet is to a specific person, then clicking the link will change the Active Person. Double-clicking such any link to a specific Gramps item (such as person or family) will bring up the Editor for that item. To edit a linked person without changing the Active Person, right-click on the person link. Depending on the type of entry, double-clicking any row in a Quick View table will either select more specific data (drill down) or bring up the editor.

Double-clicking the title of a Gramplet docked in the Dashboard Category allows you to change the display title.

Gramps-notes.png
Want Additional Gramplets

To add more Gramplets follow the instructions on Third-Party Addons. Check the list of the available reports here.

In addition, there are a number of Third party Gramplets that you can easily install and use. These include:

  • Headline News Gramplet - current, breaking news from Gramps
  • Data Entry Gramplet - edit active person's name, birth date and place, death date and place, and add people
  • Python Gramplet - a Python shell
  • FAQ Gramplet - frequently asked questions
  • Note Gramplet - see and edit active person's primary Person Note

and many others. See Third-party Addons for more details.

Summary of Gramplets

Summary of all 34 default builtin Gramplets and the categories they can be used in.

Depending on the Category the Gramplets can be added or removed

  • Via the right click context menu on the Dashboard Category.
  • In all other Categories the dropdown menu's on either of the Bottombar or Sidebar.

No Menu option to add a Gramplet is available.



Gramplet Dashboard Category People Category Relationships Category Families Category Charts Category Events Category Places Category Geography Category Sources Category Citations Category Repositories Category Media Category Notes Category
Age Stats X X X X X X X X X X X X X
Age on Date X X X X X X X X X X X X X
Ancestors X X X X
Attributes X X X X X X X X X
Calendar X X X X X X X X X X X X X
Children X X X X X
Citations X X X X X X X X
Descendant Fan X X X X
Descendants X X X X
Details X X X X X X
Events X X X X X
FAQ X X X X X X X X X X X X X
Fan Chart X X X X
Filter X X
Gallery X X X X X X X X X
Given Name Cloud X X X X X X X X X X X X X
Image Metadata X
Locations X
Notes X X X X X X X X X X X
Pedigree X X X X
Preview X
Quick View X X X X X X X X X X X X X
Records X X X X X X X X X X X X X
References X X X X X X X X X X X X
Relatives X X X X
Residence X X X X
Session Log X X X X X X X X X X X X X
SoundEx X X X X X X X X X X X X X
Statistics X X X X X X X X X X X X X
Surname Cloud X X X X X X X X X X X X X
To Do X X X X X X X X X X X X
Top Surnames X X X X X X X X X X X X X
Uncollected Objects! X X X X X X X X X X X X X
Welcome to Gramps! X X X X X X X X X X X X X
What's Next? X X X X X X X X X X X X X

For more detailed information on using the installed Gramplets, see Gramplets.

Gramplets

This following sections describe each Gramplet and its basic functionality.

Age on Date

Fig. 10.3 Age On Date Gramplet
Fig. 10.4 Age On Date Quick Report

This Gramplet gives you the possibility of entering a date in an entry field. If you click Run the Gramplet will compute the ages for everyone in your Family Tree living on that Date. The date must be entered in a format that Gramps accepts.

You can sort the Quick Report by the Name and Age columns. Right clicking the row opens a context menu for opening Person Editor and activating the person.

You can also drag a date to from Calendar Gramplet to the Age on Date Gramplets date field to enter that date.

See also the Third-party Addon Date Calculator Gramplet which allows you to do date math.

Age Stats

Fig. 10.5 Age Stats Gramplet

The Age Stats Gramplet shows graphs of the breakdown of 5 years age spans, of three stats: all people, difference between father and child and difference between mother and child. Clicking on a row will bring up the associated people in Quick Report.

Double clicking a row in a stats opens a Quick Report of all people contained in the row. You can sort the Quick Report by the Name, Birth Date and Name Type columns. Right clicking the row opens a context menu for opening Person Editor and activating the person.

You can change the Gramplets options by selecting from toolbar the configure active view button.

Fig. 10.6 Age Stats Gramplet showing options


Ancestors

Fig. 10.7 Ancestors Gramplet

Gramplet showing active person's ancestors.

Attributes

Fig. 10.8 Attributes Gramplet
Fig. 10.9 Attributes Quick View


The Attributes Gramplet shows all of the attributes for the current, active person. Double click on the name of the attribute, and you will run a Quick View that shows all of the people that have that attribute, and the values for it. You can sort the Quick View by the attribute value by clicking on the column name.

In the Quick View, highlight the entry to change the active person (which will then change the Attributes Gramplet), and double-click the Quick View entry to bring up the Edit Person dialog window.

Person Attributes

See Attributes

Family Attributes

See Attributes

Event Attributes

See Attributes

Source Attributes

See Attributes

Citation Attributes

See Attributes

Media Attributes

See Attributes

Calendar

Fig. 10.10 Calendar

The Calendar Gramplet shows a monthly calendar. Double-click a day to run the On This Day Quick View.

With the < and > buttons top left corner (month) you can change to the previous and next month.

With the < and > buttons top right corner (year) you can change to the previous and next year.

The Quick View window shows you the Events of the selected day: Events on this exact date and Other events on this Month/day in history as well as Other events in that year.

The information is presented in a table showing:

  • Date
  • Type
  • Place
  • Reference

You can also drag a date to the date field of the Age on Date Gramplet to enter that date.

Children

Fig. 10.11 Children Gramplet on People Category View.(Shows additional spouse column)

Gramplet showing the children of a person.

Person Children

See Children

Also shows the childs spouse if present.

Family Children

See Children

Citations

Fig. 10.12 Citations Gramplet

Gramplet showing the citations.

Person Citations

See Citations

Family Citations

See Citations

Event Citations

See Citations

Place Citations

See Citations

Media Citations

See Citations

Descendant Fan Chart

Fig. 10.13 Descendant Fan (chart) Gramplet

Gramplet showing active person's direct descendants as a fan chart.

Descendants

Fig. 10.14 Descendants Gramplet

The Descendants Gramplet shows the direct descendants of the active person.

The order of the spouses and children is that given in the Gramps editor. To change the order of spouses, click on Order on the Relationship view. To change the order of children, drag and drop them in the correct order in the Family edit window.

This Gramplet is based on the Descendant Report, available from the Textual Reports.

The Descendants Gramplet will update when you change the active person, or change family trees. It does not update automatically for edits or additions because this report is time-consuming to run.

Minimizing a Gramplet will prevent it from updating.

Details

Fig. 10.15 Details Gramplet

Gramplet showing details of a person.

Provides a brief non editable summary of the selected person for example:

  • Name: of person
  • Also Known As:
  • Other Name:
  • Father:
  • Mother:
  • Birth:
  • Death:
  • Burial:
  • Image: The primary image will be shown to the right of the details, otherwise a cross will indicate the image is missing, you may double click the image to open it in an external viewer.


Person Details

See Details

Place Details

See Details

Repository Details

See Details

Events

Fig. 10.16 Events Gramplet

Gramplet showing the events for a person

Person Events

See Events

Family Events

See Events

Fan Chart

Fig. 10.17 Fan Chart Gramplet

The Fan Chart Gramplet shows the direct ancestors of the active person in a circular format. It is similar to the Pedigree View, but shown around the center/active person, and further generations spiralling out.

Click on a parent in the chart and they will expand or contract above their child. Right-click on a person and you can:

  • select that person to be the active person
  • edit the person which allows through Person Editor add children to person's families
  • select from among the person's relatives to be the active person
  • add partners (families) to person
  • copy name, birth and death of person into clipboard

Clicking in an open area (non-person) and dragging the mouse will allow you to rotate the chart about the center. In Gramps 4.2, you may also left-click and drag in the center to reposition the fan chart.

A black edge on the outer radius of the chart indicates more parents for that person. A black circle in the center indicates that the center person has children.

The Fan Chart Gramplet will update when you change the active person, or change family trees.

Minimizing a Gramplet will prevent it from updating.

FAQ

Fig. 10.18 FAQ Gramplet

Gramplet showing frequently asked questions

Filter

Gramplet providing a filter specific to the Category.

See also Which filters in which Category?

Person Filter

Fig. 10.19 Person Filter - dialog

See Filter

Family Filter

Fig. 10.20 Family Filter - dialog

See Filter

Event Filter

Fig. 10.21 Event Filter - dialog

See Filter

Place Filter

Fig. 10.22 Place Filter - dialog

See Filter

Source Filter

Fig. 10.23 Source Filter - dialog

See Filter

Citation Filter

Fig. 10.24 Citation Filter - dialog

See Filter

Repository Filter

Fig. 10.25 Repository Filter - dialog

See Filter

Media Filter

Fig. 10.26 Media Filter - dialog

See Filter

Notes Filter

Fig. 10.27 Notes Filter - dialog

See Filter

Gallery

Gramplet showing media objects

Person Gallery

See Gallery

Family Gallery

See Gallery

Event Gallery

See Gallery

Place Gallery

See Gallery

Source Gallery

See Gallery

Citation Gallery

See Gallery

Given Name Cloud

Fig. 10.28 Given Name Cloud Gramplet

Like the Surname Cloud Gramplet, the Given Name Cloud Gramplet shows the top most popular given names in your family tree. The size of the name indicates how popular it is. Mouse over the name to see the exact count, and the percent of people in the family tree that have that name.

The Gramplet splits up given names into words (broken up by spaces). For example "Sarah Elizabeth" would appear under both "Sarah" and "Elizabeth".

Double-click on the given name to bring up a Quick View of all of the matching people.

Image Metadata

Fig. 10.29 Image Metadata Gramplet

The Image Metadata Gramplet offers an interface to look at Image Exif Metadata from your images (*.jpg, *.png. *.tiff, *.exv, *.nef, *.psd, *.pgf).

Prerequisites

Tango-Dialog-information.png
Special Note

Before being able to use this Gramplet/Addon, you will need to download and install gexiv2 or install gexiv2 from your local Linux repository. Windows users, this is already present in your installation. Ubuntu, use the Universe repository to find gexiv2.
Also see GExiv2 for Image metadata


Once you have installed gexiv2, see above for directions to download and install this addon...


Pyexiv2 can be used from the command line interface (cli) as well, and from within a python script:

  1. import the pyexiv2 library
    from pyexiv2 import ImageMetadata, ExifTag
  2. specify your image
    image = ImageMetadata("/home/user/image.jpg")
  3. read the image
    image.read()

Exif, IPTC, XMP metadata reference tags can be found here.

Example:

image["Exif.Image.Artist"] # Artist
Smith and Johnson's Photography Studio
image["Exif.Image.DateTime"] # DateTime
1826 Apr 12 14:00:00
image["Exif.Image.DateTime"] = datetime.datetime.now() # Add DateTime
image.write() # write the Metadata

Usage scenario

The preferred way to use this addon is:

  1. install pyexiv2
  2. Install this addon
  3. Restart Gramps
  4. Click Views from the Menu bar, and select Media Views
  5. Open the Side Bar
  6. Slide the available empty right view to about half the screen.
  7. Right click text to the Side Bar tab, and select Add a Gramplet
  8. Select Image Metadata Gramplet
  9. Select an image from the left hand MediaView


Locations

Fig. 10.30 Locations Gramplet

Gramplet showing the locations of a place over time.

Place Locations

See Locations

Notes

Fig. 10.31 Notes Gramplet

Gramplet showing the notes.

Person Notes

See Notes

Family Notes

See Notes

Event Notes

See Notes

Place Notes

See Notes

Source Notes

See Notes

Citation Notes

See Notes

Repository Notes

See Notes

Media Notes

See Notes

Pedigree

Fig. 10.32 Pedigree Gramplet

The Pedigree Gramplet shows a compressed view of the active person's direct ancestors. It defaults to going back 100 generations. The names can be clicked to change the active person, right-click to edit the person. This Gramplet also shows at the bottom of the Gramplet the number of people per generation. Double-click the Generation number to see the matching individuals.

Gramps-notes.png
New Feature

In Gramps 4.2, you can now see birth and death dates next to a person's name.


Preview

Fig. 10.33 Preview Gramplet

Gramplet showing a preview of a media object.

Quick View

Fig. 10.34 Quick View Gramplet

The Quick View Gramplet allows you to run a Quick View, it updates as you move from person to person. (Currently, only People Quick Views can be run).

You can run any of the Quick Views for a person.

You can change the options by clicking the Option button (top, left hand button of the Gramplet) which will detach the Gramplet and bring it up an a window. Select Options on the top row, and a list of options will appear. Press Save to apply the changes to the Quick View. You may then close the window to reattach the Gramplet.

See the following developer information if you are interested in creating your own Making your own Quick view.

Records

Fig 10.35 Records Gramplet

The Records Gramplet shows a number of interesting facts about the records (mostly age related) from your database. The list shows the top three for each element.

  • Person Records:
    • Youngest living person
    • Oldest living person
    • Person died at youngest age
    • Person died at oldest age
    • Person married at youngest age
    • Person married at oldest age
    • Person divorced at youngest age
    • Person divorced at oldest age
    • Youngest father
    • Youngest mother
    • Oldest father
    • Oldest mother
  • Family Records
    • Couple with most children
    • Living couple married most recently
    • Living couple married most long ago
    • Shortest past marriage
    • Longest past marriage


The list is not only interesting on its own, it is also a good sanity check of the data. For some items you have to fill in some additional information.

This following example shows that there was a marriage event (thus calculation of the offset) but none of the persons had a death event. Even if the date is not known, just enter a death event for one of the partners and the list will be corrected.

Living couple married most long ago

  1. van Dosselaere, Egidius and Rechters, Petronella (382 years, 1 month)
  2. de Richter, Petrus and Asscericx, Catharina (379 years, 9 months)


An identical Records Report is also available.

References

Gramplet showing the References.

Person References

See References

Family References

See References

Event References

See References

Place References

See References

Source References

See References

Citation References

See References

Repository References

See References

Media References

See References

Note References

See References

Relatives

Fig 10.36 Relatives Gramplet

This Gramplet shows all direct relatives of the active person. It's intended use is as a navigation help, an alternative way to move through your family tree in Gramps . If you detach the Gramplet, and place it next to Gramps, it will allow you to use it to easily change the content of the current "Person view".

If you are working in the charts category Pedigree view, the active person is the left-most person. By clicking a name in the relatives Gramplet, you can easily change the active person, and all person view in the other window will update. As the relatives Gramplet shows all spouses, all children and all parents, this offers an alternative way of navigating your data.

The names in this Gramplet also allow you to call up the person editor directly, by right-clicking on any of the names.

The Relatives Gramplet can be added to the following categories:

  • People Category
  • Relationships Category
  • Charts Category
  • Geography Category (selected views only)


Residence

Gramplet showing residence events for a person

Person Residence

See Residence

Session Log

Fig. 10.37 Session Log Gramplet

The session log keeps track of activity in this session. It lists selected and edited objects.

Click a name once to make this person the active person. Double-click on a name or family brings up the edit page for that object. In addition, if you want to edit a person, but don't want to change the active person, you can right-click on the person's name.

This Gramplet is handy because you can very quickly change the active person, or edit the object, from the session list.

SoundEx

Fig. 10.38 SoundEx Gramplet

This Gramplet generates SoundEx codes for the names of people in the database.

From the SoundEx Gramplet window you can either choose a Name: from the list by shown by selecting the down \/ arrow, or you can type a name into the text field.

The name you type in can be any name even a name not present in your Family Tree.

The result is shown automatically eg:The SoundEx code for Simpson is S512

A Help button is available which brings you to this page. With the Close button (or using the keyboard shortcut Alt+C) you close the SoundEx Gramplet window.

Soundex what is this?

Soundex is the most widely known of all phonetic algorithms which allow indexing of words by their sound, as pronounced in English.

The Soundex is a coded surname (last name) index based on the way a surname sounds rather than the way it is spelled. Surnames that sound the same, but are spelled differently, like SMITH and SMYTH, have the same code and are filed together. The Soundex coding system was developed so that you can find a surname even though it may have been recorded under various spellings.

First applied to the 1880 census, Soundex is a phonetic index, not a strictly alphabetical one. Its key feature is that it codes surnames (last names) based on the way a name sounds rather than on how it is spelled. It was to help researchers find a surname quickly even though it may have received different spellings.

Those doing census lookups must use the same method to encode surnames as the census takers did when they generated the database.

To search for a particular surname, you must first work out its code.

  • Basic Soundex Coding Rule:

Every Soundex code consists of a letter and three numbers, such as W-252. The letter is always the first letter of the surname. The numbers are assigned to the remaining letters of the surname according to the Soundex guide shown below. Zeroes are added at the end if necessary to produce a four-character code. Additional letters are disregarded. Examples: Washington is coded W-252 (W, 2 for the S, 5 for the N, 2 for the G, remaining letters disregarded). Lee is coded L-000 (L, 000 added).

Number Represents the Letters
1 B, F, P, V
2 C, G, J, K, Q, S, X, Z
3 D, T
4 L
5 M, N
6 R

Disregard the letters A, E, I, O, U, H, W, and Y.

  • Additional Soundex Coding Rules:
    • Names With Double Letters: If the surname has any double letters, they should be treated as one letter. For example:
      • Gutierrez is coded G-362 (G, 3 for the T, 6 for the first R, second R ignored, 2 for the Z).
    • Names with Letters Side-by-Side that have the Same Soundex Code Number: If the surname has different letters side-by-side that have the same number in the Soundex coding guide, they should be treated as one letter. Examples:
      • Pfister is coded as P-236 (P, F ignored, 2 for the S, 3 for the T, 6 for the R).
      • Jackson is coded as J-250 (J, 2 for the C, K ignored, S ignored, 5 for the N, 0 added).
      • Tymczak is coded as T-522 (T, 5 for the M, 2 for the C, Z ignored, 2 for the K). Since the vowel "A" separates the Z and K, the K is coded.
    • Names with Prefixes: If a surname has a prefix, such as Van, Con, De, Di, La, or Le, code both with and without the prefix because the surname might be listed under either code. Note, however, that Mc and Mac are not considered prefixes.For example, VanDeusen might be coded two ways:V-532 (V, 5 for N, 3 for D, 2 for S) or D-250 (D, 2 for the S, 5 for the N, 0 added).
    • Consonant Separators: If a vowel (A, E, I, O, U) separates two consonants that have the same Soundex code, the consonant to the right of the vowel is coded. Example:Tymczak is coded as T-522 (T, 5 for the M, 2 for the C, Z ignored (see "Side-by-Side" rule above), 2 for the K). Since the vowel "A" separates the Z and K, the K is coded. If "H" or "W" separate two consonants that have the same Soundex code, the consonant to the right of the vowel is not coded. Example: Ashcraft is coded A-261 (A, 2 for the S, C ignored, 6 for the R, 1 for the F). It is not coded A-226.

Please visit the NARA Soundex Indexing page to learn more about Soundex Indexing System.

Statistics

Fig. 10.39 Statistics Gramplet

The Statistics Gramplet runs a Statistics report. Double-click the phrases to bring up the matching items.

Following information is provided to you in this Gramplet:

  • Individuals
    • Number of individuals
    • Males
    • Females
    • Individuals with unknown gender
    • Individuals with incomplete names
    • Individuals with missing birth dates
    • Disconnected individuals
  • Family information
    • Number of families
    • Unique surnames
  • Media objects
    • Individuals with media objects
    • Total numbers of media object references
    • Number of unique media objects
    • Total size of media objects
    • Missing Media Objects

As with all Gramplets if you click on the left hand side Tool button you detach the window and if you add persons to your family tree, you will see the amount of individuals change dynamically.

The information given in this Gramplet is the same as in the Database Summary Report

Surname Cloud

Fig. 10.40 Surname Cloud

The Surname Cloud Gramplet shows the top 100 (by default) used surnames. The name font size is proportional to the amount of people with the same name.

Double-click a surname to run the Same Surnames Quick View. This will open the Quick View window where you can find all people with a matching or alternate name. Person, birth date and name type are given.

If you mouse over the name you see the percentage of occurrence and total counts.

Change the number of names displayed by editing this section in ~/.gramps/gramps42/gramplets.ini

To Do

Fig. 10.41 To Do Gramplet

The To Do Gramplet is free form text area. You can use this area to put some notes, remarks, things you should to get your research going. There are several other To Do programs (e.g. Tomboy e.a.) but these Gramplets are useful as the information stays within the Gramps database.

To Do Gramplets allow you to create notes and attach them to Gramps objects. For example, you can add a Person To Do Gramplet to the sidebar of the Person View. Notes added using this Gramplet will be attached to the currently active person. There is a To Do Gramplet for each Gramps primary object type.

See also the experimental Third-party Addon ToDo Notes Gramplet available for the Dashboard that lists all To Do notes in the database, together with the object to which they are attached.

Person To Do

See To Do

Family To Do

See To Do

Event To Do

See To Do

Place To Do

See To Do

Source To Do

See To Do

Citation To Do

See To Do

Repository To Do

See To Do

Media To Do

See To Do

Top Surnames

Fig. 10.42 Top 10 Surnames

The Top Surnames Gramplet shows the top 10 (by default) used surnames.

The top ten is presented as follows:

  • Surname
  • percentage
  • occurrences

The list gives you also the Total unique surnames in the database as well as the total number of people in your database.

Double-click a surname to run the Same Surnames Quick View. This opens the Quick View window, which gives the people with the surname you double-clicked.

A table is presented which shows all people with a matching name or alternate name. Person's name, ID, birth date and name type is given.

Change the number of names displayed by editing this section in ~/.gramps/gramps42/gramplets.ini

Uncollected Objects


Welcome

Fig. 10.43 Welcome Gramplet

The Welcome Gramplet gives an introductory message to new users, and some basic instructions.

The welcome message describes what Gramps is, that the program is Open Source Software and how you start a Family Tree.

This information can also be found on the start page of Gramps

What's Next

Fig 10.44 What's Next Gramplet

The What's Next Gramplet displays a list of the "most urgent" information gaps in your family tree. It is based on the following assumptions:

  • You want to know first and last name, birth date and place, and death date and place of each person
  • You want to know father, mother, marriage date and place, and - if divorced - divorce date and place of each family with married parents
  • You want to know at least the mother of each family with unmarried parents
  • The closer the relationship to the main person, the more "urgent" the information gap is.
  • The closer the common ancestor is from the main person, the more "urgent" the information is (e.g. nephews are considered more "urgent" than uncles, even though both have a distance of 3 generations, because for nephews the common ancestor is father/mother, while for uncles, the common ancestor is grandfather/grandmother)
  • Marriage data and personal data of the spouse is slightly less "urgent" than personal data of the directly related person
  • Half brothers are less "urgent" than brothers

You may copy the text from inside of this Gramplet by selecting it and pasting into an empty document.

Fig 10.45 What's Next Gramplets configuration options

The Gramplet can ignore previously verified events by making use of some custom Tags. The tags are selected in the Gramplets configuration. For example you can tag the following to be ignored:

  • that a person is complete
  • that a family is complete
  • that a person or family should be ignored for shortening lists


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