Gramps 5.2 Wiki Manual - Gramplets

From Gramps
Jump to: navigation, search
Previous Index Next

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

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.


What is a Gramplet?

Fig. 12.1 Dashboard Category view

A Gramplet is an expansion to the Gramps program that ideally works seamlessly as if it was a core feature. They actually become embedded as part of Gramps. But while the core features of a view are needed almost constantly, the bundled Gramplets extend the view in ways that are only needed occasionally. Gramplets provide a supplemental perspective of the Tree data which either: changes dynamically during the navigation of the Gramps Tree, or; provides interactivity to your genealogical data.

Gramplets are the division of plug-ins (also called widgets, plugins, addons, auxiliary components) that can be found in the Dashboard Category ... or the Sidebars and Bottombars in other Navigator View Categories. They provide all kinds of functionality that can be useful for the researcher.

A selection of built-in plugins are bundled and pre-installed with Gramps. The Gramps project hosts a selection of add-on plugins that might only be of interest to certain audiences.

There are also third-parties, such as The Taapeli Project in Finland, who hosts their own selection of Isotammi group add-on plug-ins developed to tune Gramps for their needs. Members of the Gramps community also share special purpose addons privately or via GitHub repositories. And, of course, users are invited to develop their own addons.

Performance Drain

Gramplets can slow down Gramps and can use a lot of memory.
Close any docked Gramplets that will not be of immediate use. (It is not necessary to uninstall them with the Plugin Manager.) Closed Gramplets can be re-added to a Gramplet Bar or the Dashboard as needed.

Aren't all Plugins also Gramplets?

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

All of these are plugin types. But Gramplets are subtype of plugins with more emphasis on the user interface. Gramplets add a capability or a different perspective to the View. They can be used to improve the workflow of a View.

The other plugins tend to interrupt the normal workflow to do another task. They also tend to be used more intermittently. A plugin might generate a static (even when hot-linked) snapshot of the data, be a way of doing mass change, or provide an alternative import/export/output system.

Some common Plugin types are:

  • Reports - provide a static output format of your data, typically for presentation
  • Quick Views - 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.

A deeper understanding of the different types of plugins can be gained by sorting the Addon List by Type and exploring the contrasting Descriptions.

Some of the more static types of plugins can be extended to work dynamically as a Gramplet.

Several plugins have evolved into multiple types. Some plugins are shells which layer extra capabilities around other plugins. The Quick View Gramplet is not a type of Quick View plugin. Instead, it is a dockable shell that shows a Quick View plugin and pushes the plugin to refresh as the context changes.

Tip: Configure the Quick View Gramplet Gramps-config.png

Use the Configure button to change which Quick View plugin will be displayed from the any of the various Navigator categories.

Starting with Gramplets

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

The Dashboard and Gramplet Split Bars of the Navigator Categories may have common and specific Gramplets.

  • Common Gramplets are applicable to any View ... and the data viewpoint is with respect to the Context of the Active Person and/or the Home Person. They can be docked on any Navigator Category View without making that View seem ambiguous.
  • Specific Gramplets need the context of particular Views to give context to their perspective of the data. The list in the Dashboard's Add a Gramplet submenu and the Gramplet Bar Menu will differ according active Category view and Gramplets installed.

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

This list is leftover from an earlier revision of the wiki. It is unclear where the items fit in this discussion.

  • Back references Gramplets - provide immediate visibility to data that tends be viewed occasionally and is buried in the interface... 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. 12.2 Dashboard Welcome Gramplet

The container controls for Gramplets are arranged a little differently in the Dashboard category View as opposed to the Sidebar and Bottombar. Being aware of how these Gramplet containers differ (and are similar) will let you focus on getting the high speed performance instead of wondering why it spun out of control.

Originally added in version 3, Gramplets in Dashboard category View are arranged in a configurable number of columns. The Sidebar and Bottombar split panes were selected from among later innovations proposed in GEPS 19. They were built on the Filter Sidebar of the 3.3 version. The Filter was converted to a Gramplet and pre-docked in the Sidebar.

Fig. 12.3 Detached Sidebar Welcome Gramplet

The split panes provide limited screenspace for docking Gramplets in the other Navigator categories. But, unlike the many columns of the Dashboard View, each new split pane is a single column, filled with a single Gramplet. (The pane still supports holding multiple Gramplets, it just uses Tabs to display them one at a time.)

The split pane approach reduces the need for flipping between Category Views... and that lightens the demands on the database.

Fig. 12.4 Detached Gramplet in the Dashboard View

However, Gramplets can be undocked (detached, torn off) to float free from any of the three containers. When detached, an additional Help button in the lower left will open the Gramplet's page on this website. Clicking the X button in the upper right corner will re-docks a detached Gramplet. Clicking the similar X button of a docked Gramplet will remove it from the pane.

The Dashboard Category View

In the Dashboard, you can drag the  Properties  button (top left) of each Gramplet to reposition it in the Dashboard View area. You can click the  Properties  button to detach (or ‘undock’) 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, they remain visible as you change to a different View (such as the People or Charts View). 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. Click the X button above the Gramplet to remove it from the Dashboard.

⚙ Configurable Options
Fig. 12.5 View menu

You can also change the number of columns by changing a Gramplets Layout tab setting in Configure Dashboard window. To open the window, click the Gramps-config.pngConfigure... button, choose View ➡ Configure... from the View menu, or press the Configure active view keyboard keybinding.

Fig. 12.6 Gramplet Configuration tabs

Each Gramplet docked in the Dashboard will also have a Configuration tab added. (But the same Gramplet may not have any Configuration options or tab when docked in the Sidebar or Bottombar.) The Dashboard provides extra options for each Gramplet to allow it be renamed, set to a fixed vertical size, or be maximized vertically in its column. The Configuration tab for Gramplets in docked in the Dashboard reflect at least these minimum options.

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

The split-screen Sidebar & Bottombar

Fig. 12.7 Gramplet split-screens showing Gramplet Bar Menu with the unlabeled Down Arrowhead pull-down menu button

Each of these split screen panes is a container of stacked Gramplet tabs. Like Windows with a tabbed section, each can show only a single tab at a time. But tabs can be added, re-ordered, undocked or disabled in a similar fashion to the Dashboard. However, instead of a Contextual Menu, each split-pane Gramplet Bar Menu has a Down Arrowhead pull-down menu button to show the same pop-up list of options.

To add a Gramplet to the stacked tabs, select it from the Gramplet Bar Menu Add a gramplet submenu.

To undock a tab, grab the tab title and drag out of the split-pane. To re-dock, click the Close button or the 'X' button.

To remove the Gramplet from the stack tabs, select it from the Gramplet Bar Menu Remove a gramplet submenu. (Alternatively, the × Close button will be accessible if the 'Show close button in gramplet tabs' checkbox in the Display tab of Preferences is selected.)

Curiously, the same Gramplets might be tabs in the different split-screen section of a View but be configured to show information differently. It is important to be aware that each Gramplet (whether stacked as a Tab or floating undocked) bogs down performance of Gramps. Use fewer Gramplets to make Gramps more responsive.

The lists of Gramplets that can be added to the stack of tabs in a split pane are filtered by those appropriate to that category.

⚙ Configurable Options
Fig. 12.8 View menu
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 default built-in Gramplets and the view categories in which each gramplet can be used.

Independently for each Category view mode container, the Gramplets can be added or removed using the following controls:

  • In the Dashboard Category, via the right-click context menu.
  • In all other Categories, via the drop-down Gramplet selection menus (Down Arrowhead button) on either the Bottombar or Sidebar.

There are no Menu options to add a Gramplet. This is because it would be ambiguous whether the Gramplet was to be added to that view mode's sidebar or bottombar.

Gramplet List

Click a Category header (twice) to sort the list and show that category's menu of available built-in Gramplet choices. (The actual menu will also include installed 3rd-party addon Gramplets.)

Gramplet 22x22-gramps-gramplet.png Dashboard 22x22-gramps-person.png People 22x22-gramps-relation.png Relationships 22x22-gramps-family.png Families 22x22-gramps-pedigree.png Charts 22x22-gramps-event.png Events 22x22-gramps-place.png Places 22x22-gramps-geo.png Geography 22x22-gramps-source.png Sources 22x22-gramps-citation.png Citations 22x22-gramps-repository.png Repositories 22x22-gramps-media.png Media 22x22-gramps-notes.png Notes
2-Way Fan Chart
Age Stats 🗹
Age on Date 🗹
Calendar 🗹
Descendant Fan
Enclosed By
Events Coordinates
Fan Chart
Given Name Cloud 🗹
Image Metadata
Media Preview
Quick View 🗹 ⚙ ♦ ⚙ ♦ ⚙ ♦ ⚙ ♦ ⚙ ♦ ⚙ ♦ ⚙ ♦ ⚙ ♦ ⚙ ♦ ⚙ ♦ ⚙ ♦ ⚙ ♦ ⚙
Records 🗹
Session Log 🗹
SoundEx 🗹
Statistics 🗹
Surname Cloud 🗹
To Do 🗹
Top Surnames 🗹
Welcome to Gramps! 🗹
What's Next? 🗹
Python Evaluation! 🗹
Uncollected Objects! 🗹
Symbol Meaning
Dangerous. Available in debug mode only
listed in gramplet menu for view
🗹 different container behavior
♦ ⚙ category specific configuration options
category specific interface
Content based on active record or category

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


This following sections describe each Gramplet and its basic functionality.


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

2-Way Fan Chart

Fig. 12.9 2-Way Fan Gramplet

See also:

Age on Date

Fig. 12.10 Age On Date Gramplet - detached example

The Age on Date Gramplet allows you to enter a Calendar date in the Date: entry field. If you select the Run the Gramplet will compute the ages for everyone in your Family Tree living on that Date and will show the results in a separate Quick View report dialog. The date must be entered in a calendar format that Gramps accepts eg: YYYY-MM-DD .

  • No configuration options are available for this gramplet.

Fig. 12.11 Age On Date Gramplet - Quick View - result example

From the resulting Quick View report dialog you can sort by the Person, Age or Status columns. Right clicking the row opens a context menu that allows you to Copy all rows to the clipboard; or to See the person details in the Person Editor, or Make the person active.

Age Stats

Fig. 12.12 Age Stats Gramplet - detached example

The Age Stats Gramplet shows statistics in the form of three text graphs grouped in 5 years age span breakdowns (use the vertical scroll bar to see the other two graphs):

  • Lifespan Age Distribution - for all people having valid birth and death dates.
  • Father - Child Age Diff Distribution - shows the age difference between child and father where both individuals have valid birth dates.
  • Mother - Child Age Diff Distribution - shows the age difference between child and mother where both individuals have valid birth dates.

Rolling over a chart row will display a hint with the count of offspring matching the row's range.

Double-clicking a row in any of the statistics graphs opens a Quick Report of the offspring categorized by that row. You can sort the Quick Report by the Name, Birth Date and Name Type columns.

Right-clicking the Quick View report row displays a context menu for copying the list, opening the Person Editor or activating the person.

⚙ Configurable Options
Fig. 12.13 Age Stats Gramplet - from Charts Configuration tab defaults

Adjustable graph scaling limits

  • Maximum Age 1-150; (110 default)
  • Maximum Age of mother at birth: 1-150; (40 default)
  • Maximum Age of father at birth: 1-150; (60 default)
  • Chart Width: 1-150; (60 default)

In the Dashboard View, the Gramplet may be detached by clicking the Configure active view button.

See also

  • An upgrade has been developed for the 5.2 version of Gramps.See the screen capture


Fig. 12.14 Ancestors Gramplet - detached example

Gramplet showing active person's ancestors.


Fig. 12.15 Attributes Gramplet

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.

Fig. 12.16 Attributes Gramplet - Quick View example result

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


Fig. 12.17 Calendar Gramplet - detached example

The Calendar Gramplet shows a monthly calendar.

Surrounding the month label at the top left corner, the < previous and > next buttons can be used to change the month.

Surrounding the year label at the top right corner, the < previous and > next buttons can be used to change the year.

Double-click a day to run the On This Day Quick View. The Quick View window shows up to 3 table sections, the events (if any exist) of: the exact date, other events on the same month/day in history, and events in that year.

You can also drag a day from the Calendar to the date fields (such as for the Event Editor or the Age on Date Gramplet) to enter that date. Similarly, a calendar day may also be dragged to the Clipboard where it will be stored in a plain text format.

Localized Day of the week headers

The customary first day of the week can be shown on calendar and which vary culturally. The calendar adapts to the language setting.

The feature will be included in the 5.2 release but can patched manually. See the Discourse forum discussion on the Calendar Gramplet


Fig. 12.18 Children Gramplet - detached example

Gramplet showing the active persons children.

How do I change the order of children? Use:

  • The Family Editor Children tab to change the order of children in the family.
  • The third party addon Birth Order Tool which allows bulk updates of the children order.

Person Children

See Children

Also shows the childs spouse if present.

Family Children

See Children


Fig. 12.19 Citation Gramplet - detached example

Gramplet showing the active persons 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. 12.20 Descendant Fan (chart) Gramplet - detached example

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

See also:


Fig. 12.21 Descendants Gramplet - detached example

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.

Moving the mouse over a person will show a tooltip summary which includes the death date.


Fig. 12.22 Details Gramplet - detached example

Gramplet showing details of the active 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: If available 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. To change the primary active image see: Edit Person Editors - Gallery tab

You may highlight and copy the individual text fields.


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

Person Details

See Details

Place Details

See Details

Repository Details

See Details


Fig. 12.23 Encloses Gramplet - detached example

Gramplet showing the hierarchical locations of a place it encloses over time.

Encloses Place Locations

See Enclosed By

Enclosed By

Fig. 12.24 Enclosed By Gramplet - detached example

Gramplet showing the locations hierarchically enclosed by a place over time.

Enclosed By Place Locations

See Encloses


Fig. 12.25 Events Gramplet - detached example

Primarily designed as an alternative to opening a Edit Object dialog layout tab .

Double click a row to edit the event.

See Events

Family Events

Gramplet added in the Person category will show the events for the active Family.

Person Events

Gramplet added in the Person category will show the events for the active person.

Events Coordinates

Primarily designed to verify that the key data exists to plot the Events in the Geography view. Beyond the coordinates, a date and event type are needed for some of the animated views.

Right-click a row to open a context menu to edit the event or place.

Family Events Audit

Fig. 12.26 Events Coordinates Gramplet - detached example

Gramplet added in the Family category will show the Events for the active Family.

Person Events Audit

Gramplet added in the Person category will show the Events for the active person.

Fan Chart

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

See also:


Fig. 12.28 FAQ Gramplet - detached example

The FAQ Gramplet (Frequently Asked Questions) shows a list of common questions, and links to their answers from the Gramps Wiki (requires an internet connection).

This gramplet shows a manually curated list of Frequently Asked Questions hyperlinked to answers in articles of the Gramps wiki. The list is collated from new user postings to the Gramps User maillist that must be answered repeatedly.

The idea is to make the answers to the most common question easier to find, the primary objective is to let new users start using Gramps more quickly.

See Also

  • Bug Report 11742: Dashboard FAQ links are obsolete (resolved)
  • Bug Report 11997: how to add/update FAQs



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

Gramplet providing a filter specific to the Category.

See Also

People Filter

Fig. 12.29 People - Filter Gramplet - detached - default

Equivalent to the built-in Custom Filter rules:

Families Filter

Fig. 12.30 Families - Filter Gramplet - detached - default

Equivalent to the built-in Custom Filter rules:

Charts Filter

Fig. 12.31 Charts - Filter Gramplet - detached - default (Same as People Filter)

The diagrams in Charts need the context of connecting records to define the connections between blocks. So rather than only displaying only the matching records in the Charts view modes, Filters for the Charts still displays all the records but dims the non-matching ones.

Interface is the same as the People Filter Gramplet

Events Filter

Fig. 12.32 Events - Filter Gramplet - detached - default

Equivalent to the built-in Custom Filter rules:

Places Filter

Fig. 12.33 Places - Filter Gramplet - detached - default

Equivalent to the built-in Custom Filter rules:

Geography Filter

Fig. 12.34 Geography - Filter Gramplet - detached - default (Same as Places Filter)

Interface is the same as the Places Filter Gramplet

Sources Filter

Fig. 12.35 Sources - Filter Gramplet - detached - default

Equivalent to the built-in Custom Filter rules:

Citations Filter

Fig. 12.36 Citations - Filter Gramplet - detached - default

Equivalent to the built-in Custom Filter rules:



Repositories Filter

Fig. 12.37 Repositories - Filter Gramplet - detached - default

Equivalent to the built-in Custom Filter rules:

Media Filter

Fig. 12.38 Media - Filter Gramplet - detached - default

Equivalent to the built-in Custom Filter rules:

Notes Filter

Fig. 12.39 Notes - Filter Gramplet - detached - default

Equivalent to the built-in Custom Filter rules:


Fig. 12.40 Gallery Gramplet - detached example

Gramplet showing media objects. The first image is the primary active media object that is used in reports and the Edit Person dialog.


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

See also Gallery tab for Edit Person dialog where you can change which image is the primary active media object for reports etc...

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. 12.41 Given Name Cloud Gramplet - detached example

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. 12.42 Image Metadata Gramplet - example

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


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.
MS-Windows users, this is depends on which installer you used.
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...


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

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

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


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"] = # 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

Media Preview

Fig. 12.43 Media Preview Gramplet - detached example

Gramplet shows a preview of a single media object.
See Media Category


Fig. 12.44 Notes Gramplet - detached example

Gramplet showing the active persons notes.

See also:

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


Fig. 12.45 Pedigree Gramplet - detached example

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. At the bottom of the Gramplet the number of people per generation is listed. Birth and death dates are shown next to each person's name. Double-click the Generation number to see the matching individuals.

Using the content of the Pedigree in another program requires a bit of effort Open a contextual pop-up menu by right-clicking anywhere in the gramplet except a hotlink. Or, you can begin a drag selection from the same inert areas. Copy the highlighted text the OS clipboard from that same context menu. (The keybinding for 'Copy' will not work.) When you paste the text into another text editing program, you may need change the font to a non-proportional font to preserve the indentation. Some online services collapse leading spaces when you post a chunk of text. Preserving the indentation for such services may require replacing doubled spaces with doubled placeholder characters... like periods/full stops.

⚙ Configurable Options

  • Maximum generations: 1 to 100 limit; (default: 100)
  • Show Dates checkbox; (default: deselected)
  • Line Type menu: UTF, ASCII; (default: UTF)

Python Evaluation

Warning! Diagnostic Tool

Do not use this Debug feature on your working Family Tree. Always create a new empty Family Tree or a copy of your existing Family Tree for testing.
This option is only available when Gramps has been started using a developer mode switch. It is not intended for general use and has limited safeguards.

Fig 12.46 Python Evaluation Gramplet - detached example

The Python Evaluation window tool is intended to test Python scripts with Gramps data.

Sample code for listing Gramps internal "constants":

import os
import sys
from gramps.gen.const import *

# Get all uppercase variables from the current namespace
ENV = {
    name: value for name, value in locals().items()
    if name.isupper() and not name.startswith('_') and isinstance(value, str)

# Print each item in the dictionary, indicating if it's a hidden directory
for key, value in ENV.items():
        if os.path.isdir(value):
            if sys.platform.startswith('win'):
                import ctypes
                attrs = ctypes.windll.kernel32.GetFileAttributesW(value)
                hidden_status = "HIDDEN" if attrs != -1 and bool(attrs & 2) else "NOT HIDDEN"
                hidden_status = "HIDDEN" if os.path.basename(value).startswith('.') else "NOT HIDDEN"
            print(f"({hidden_status})    {key}  :    {value}")
            print(f"{key}  :    {value}     (NOT A DIRECTORY)")
    except Exception as e:
        print(f"{key}  :    {value}     (ERROR :    {str(e)})")

See Also

Quick View

Fig. 12.47 Quick View Gramplet - detached example

The Quick View Gramplet allows Quick View reports to update dynamically as the selected. Instead of a window with a static report, the gramplet updates different active record is selected within the target Category. (When this Gramplet was introduced, it only offered choosing Quick View Reports from the People category. A Configuration pop-up menu to select View categories has since been added.)

You can run any of the built-in Quick Views or add-on QuickView reports.

Fig. 12.48 Quick View Gramplet - Configuration tab shown

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:


Fig 12.49 Records Gramplet - detached example

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.


Fig 12.50 References Gramplet - detached example

Gramplet showing the active persons References.

Person References

  • Person References : Gramplet showing the backlink references for a person

See References

Family References

  • Family References : Gramplet showing the backlink references for a family

See References

Event References

  • Event References : Gramplet showing the backlink references for an event

See References

Place References

  • Place References : Gramplet showing the backlink references for a place

See References

Source References

  • Source References : Gramplet showing the backlink references for a source

See References

Citation References

  • Citation References : Gramplet showing the backlink references for a citation

See References

Repository References

  • Repository References : Gramplet showing the backlink references for a repository

See References

Media References

  • Media References : Gramplet showing the backlink references for a media object

See References

Note References

  • Note References : Gramplet showing the backlink references for a note

See References


Fig 12.51 Relatives Gramplet - detached example

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)


Fig. 12.52 Person - Residence Gramplet - detached - example

Gramplet showing residence events for the active person


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

Person Residence


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

See Residence

Session Log

Fig. 12.53 Session Log Gramplet - detached example

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.


Fig. 12.54 SoundEx Gramplet - detached example

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 pop-up menu shown by selecting the down arrowhead, (triangle) 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 dismiss 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. Soundex support is included with searching via a Soundex match of People with the <name> Custom Filter rule, a Soundex Gramplet, and as a quality control for matching in the Find Possible Duplicate People tool.

The Soundex equivalent 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 surnames may be found even when recorded under variant spellings.

First applied to the 1880 US Census, Soundex is a "sound index", not a strictly alphabetical one. The key feature is that it codes surnames (last names) based on the way a name sounds rather than on how it is spelled. The Soundex phonetic coding system pre-dates computers and 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 and tabulate surnames as the census workers did when they generated the database.

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

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


Fig. 12.55 Statistics Gramplet - detached example

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 other gender — ⚡new for version 5.2
    • Individuals with unknown gender
    • 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. 12.56 Surname Cloud Gramplet - detached example

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.

Fig. 12.57 Surname Cloud Gramplet - Configuration tab shown

You can change the number of names displayed by configuring the view for this gramplet.

To Do

Fig. 12.58 To Do Gramplet - detached example

The To Do Gramplet displays a free form text area showing the contents of Note objects of the "To Do" type. The Type of To Do note is filtered to the current category.

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.

Top Surnames

Fig. 12.59 Top Surnames Gramplet - detached example

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.

Uncollected Objects

Warning! Diagnostic Tool

Do not use this Debug feature on your working Family Tree. Always create a new empty Family Tree or a copy of your existing Family Tree for testing.
This option is only available when Gramps has been started using a developer mode switch. It is not intended for general use and has limited safeguards.

Fig 12.60 Uncollected Objects Gramplet - detached example

The Uncollected Objects Gramplet is intended to list the low-level Python objects that are left around in memory and cannot be (easily) automatically deleted when they are no longer in use. Developers use it to try to identify the source of memory 'leaks', which cause Gramps to continually use more and more memory, the longer it is used.

Because the tool is trying to display objects that might still be getting deleted, it sometimes has some trouble.


Fig. 12.61 Welcome Gramplet - detached example

The Welcome to Gramps! 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.

What's Next

Fig. 12.62 What's Next? Gramplet - detached example

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:

  • The Home Person defines the focus
  • Searches for gaps begin with the Home Person's descendants and work up the tree
  • The tree is expected to contain the given name, surname, birth date and place, and death date and place of each person
  • You want to know parents, their 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 Home 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-siblings are less "urgent" than siblings

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

Fig. 12.63 What's Next? Gramplet - Configuration tab shown

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