View source for Ru:Gramps 5.1 Вики Руководство - Грамплеты

{{man index|Gramps 5.1 Wiki Manual - Plugin Manager|Gramps 5.1 Wiki Manual - Reports|5.1}}

{{languages/ru|Gramps_5.1_Wiki_Manual_-_Gramplets}}

{{#vardefine:chapter|10}}
{{#vardefine:figure|0}}

На этой странице находится описание Грамплетов, которые поставляются с Gramps.

{{man note|Дополнительные Грамлеты|с помощью которых можно расширить функционал Gramps, описаны на странице [[Third-party Addons|сторонних дополнений]].<br>Информация о создании своего собственного Грамплета расположена на [[Gramplets_development|станице]] для разработчиков.}}

= Что такое Грамплет? =
<span id="definition">
[[File:DashboardCategory-DashboardView-default-gramplets-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dashboard Category (Default View)]]

A Gramplet is an expansion to the core Gramps program that '''hopefully''' works seamlessly as a built-in feature. 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 plug-ins (also called [http://en.wikipedia.org/wiki/Widget_engine widgets], plugins, addons, auxiliary components) that become embedded as part of Gramps and can be found in the '''Dashboard Category''' ... or the '''Sidebars''' and '''Bottombars''' in other Navigator Categories. They provide all kinds of functionality that can be useful for the researcher.</span>
{{Man warn|Performance Drain|<i>'''Gramplets slow down Gramps and can use a lot of memory.'''</i><br>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 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 [[Gramps_5.1_Wiki_Manual_-_Plugin_Manager#Plugin_types|Plugin types]] are:
*Reports - provide a static output format of your data, typically for presentation
*[[Gramps_5.1_Wiki_Manual_-_Reports_-_part_8#Quick_Views|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 [[5.1_Addons#Addon_List|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 [[Gramps_5.1_Wiki_Manual_-_Reports_-_part_8#Quick_Views|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.

{{man tip |Tip: Configure the [[Gramps_5.1_Wiki_Manual_-_Gramplets#Quick_View|Quick View Gramplet]] [[File: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 [[Gramps_5.1_Wiki_Manual_-_Categories#Dashboard_Category|Dashboard Category]] you will see two default Gramplets; the '''{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Welcome_Gramplet|Welcome to Gramps!]]}}''' Gramplet and the '''{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Top_Surnames_Gramplet|Top Surnames Gramplet]]}}'''.

Since Gramps 4.2 extended some Dashboard features to other Navigator Categories, we 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 the View unambiguous. 
*Specific Gramplets need the context of particular Views to give context to their perspective of the data. The list of Add Gramplets menu will differ according active Category view and Gramplets installed.


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 {{man label|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 ==
[[File:WelcomegadgetBlur.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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 were later innovations built on the Filter Sidebar of the 3.3 version. The Filter was converted to a Gramplet'' and pre-docked in the Sidebar. 

[[File:Welcome-Gramplet-detached-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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.

[[File:DashboardCategory-gramplet-detached-example-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Detached Gramplets View]]
However, Gramplets can be undocked (detached, torn off) to float free from any of the three containers. When detached, an additional {{man button| Help}} button in the lower left will open the Gramplet's page on this website.  Clicking the {{man button| X}}&nbsp;button in the upper right corner will re-docks a detached Gramplet.  Clicking the similar {{man button| X}}&nbsp;button of a docked Gramplet will remove it from the pane.
<!-- This is in the WRONG place! We're still talking about how the containers for Gramplets work... not yet to using the Gramplet's themselves.

 {{man button| &or;}} (''Down Arrowhead'' button) also known as the '''Gramplet Bar Menu''' at the far top right of the bars titles, and then using one of the options from 


=== Hotlinked Gramplet data ===
Gramplet development is not subject to the approval of our [[5.1_Roadmap#Project_governance|benevolent dictator]] and so behaviors more variable.

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.
-->
=== The Dashboard Category View ===

In the [[Gramps_5.1_Wiki_Manual_-_Categories#Dashboard_Category|Dashboard]], you can drag the {{man button| Properties }}&nbsp;button (top left) of each Gramplet to reposition it in the Dashboard View area. You can click the {{man button| Properties }}&nbsp;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, 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 {{man button| X}}&nbsp;button above the Gramplet to remove it from the Dashboard.

==== &#x2699; Configurable Options ====
[[File:Menubar-View-overview-example-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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 [[File:Gramps-config.png]]{{man button|Configure...}}&nbsp;button, choose {{Man menu|View&nbsp;&#x27a1;&nbsp;Configure...}} from the View menu, or press the ''Configure active view'' [[Gramps_5.1_Wiki_Manual_-_Keybindings#Common_keybindings|keyboard keybinding]].
[[File:Whats_next-configure_dashboard-41.png|center|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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 &amp; Bottombar ===

Each of these split screens 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 has a 'down arrow' gadget to show a {{man menu|Gramplet Bar Menu}} with the same pop-up list of options.

To add a Gramplet to the stack tabs, select it from the {{man menu|Gramplet Bar Menu ->Add a gramplet}} submenu.

<span id="undock gramplet">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.</span> 

To remove the Gramplet from the stack tabs, select it from the {{man menu|Gramplet Bar Menu ->Remove a gramplet}} submenu or click the tab's 'X' button. (The 'X' is only accessible when 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.
==== &#x2699; Configurable Options ====
<!--
[[File:ToolbarIcon-OpenTheToolsDialog-50.png]] 

-->[[File:Menubar-View-overview-example-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} View menu]]

{{man note|Want Additional Gramplets|To add more Gramplets follow the instructions on [[5.1_Addons|'''Third-Party Addons''']]. Check the list of the available reports [[5.1_Addons#Addon_List|'''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 built-in Gramplets ==
Summary of all 36 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.

{{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] -->

<!--WIP / add links to relevant individual sections for each core Gramplet-->
{{-}}

{| class="wikitable sortable"
|-
! Gramplet
! [[Image:22x22-gramps-gramplet.png]] Dashboard
! [[Image:22x22-gramps-person.png]] People
! [[Image:22x22-gramps-relation.png]] Relationships
! [[Image:22x22-gramps-family.png]] Families
! [[Image:22x22-gramps-pedigree.png]] Charts
! [[Image:22x22-gramps-event.png]] Events
! [[Image:22x22-gramps-place.png]] Places
! [[Image:22x22-gramps-geo.png]] Geography
! [[Image:22x22-gramps-source.png]] Sources
! [[Image:22x22-gramps-citation.png]] Citations
! [[Image:22x22-gramps-repository.png]] Repositories
! [[Image:22x22-gramps-media.png]] Media
! [[Image:22x22-gramps-notes.png]] Notes
|-
|<!-- Gramplet --> id="0" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#2-Way_Fan_Chart|2-Way Fan Chart]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->
|<!-- Places Category -->
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="1" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Age_Stats|Age Stats]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="2" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Age_on_Date|Age on Date]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="3" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Ancestors|Ancestors]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->
|<!-- Places Category -->
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="4" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Attributes|Attributes]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="5" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Calendar|Calendar]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="6" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Children|Children]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->
|<!-- Places Category -->
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="7" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Citations|Citations]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="8" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Descendant_Fan|Descendant Fan]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->
|<!-- Places Category -->
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="9" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Descendants|Descendants]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->
|<!-- Places Category -->
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="10" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Details|Details]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="18a" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Encloses|Encloses]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->
|<!-- Relationships Category -->
|<!-- Families Category -->
|<!-- Charts Category -->
|<!-- Events Category -->
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="18b" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Enclosed_By|Enclosed By]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->
|<!-- Relationships Category -->
|<!-- Families Category -->
|<!-- Charts Category -->
|<!-- Events Category -->
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="11" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Events|Events]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->
|<!-- Places Category -->
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="11a" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Events_Coordinates|Events Coordinates]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->
|<!-- Places Category -->
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="12" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#FAQ|FAQ]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="13" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Fan_Chart|Fan Chart]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->
|<!-- Places Category -->
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="14" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Filter|Filter]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->
|<!-- Places Category -->
|<!-- Geography Category -->
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="15" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Gallery|Gallery]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="16" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Given_Name_Cloud|Given Name Cloud]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="17" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Image_Metadata|Image Metadata]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->
|<!-- Relationships Category -->
|<!-- Families Category -->
|<!-- Charts Category -->
|<!-- Events Category -->
|<!-- Places Category -->
|<!-- Geography Category -->
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="21" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Media_Preview|Media Preview]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->
|<!-- Relationships Category -->
|<!-- Families Category -->
|<!-- Charts Category -->
|<!-- Events Category -->
|<!-- Places Category -->
|<!-- Geography Category -->
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="19" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Notes|Notes]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="20" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Pedigree|Pedigree]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->
|<!-- Places Category -->
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="22" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Quick_View|Quick View]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="23" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Records|Records]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="24" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="25" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Relatives|Relatives]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->
|<!-- Places Category -->
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="26" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Residence|Residence]]}}
|<!-- Dashboard Category -->
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->
|<!-- Places Category -->
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->
|<!-- Citations Category -->
|<!-- Repositories Category -->
|<!-- Media Category -->
|<!-- Notes Category -->
|-
|<!-- Gramplet --> id="27" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Session_Log|Session Log]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="28" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#SoundEx|SoundEx]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="29" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Statistics|Statistics]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="30" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Surname_Cloud|Surname Cloud]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="31" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#To_Do|To Do]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="32" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Top_Surnames|Top Surnames]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="35" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Uncollected Objects|Uncollected Objects!]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="33" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Welcome|Welcome to Gramps!]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-
|<!-- Gramplet --> id="34" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#What.27s_Next|What's Next?]]}}
|<!-- Dashboard Category -->&diams;
|<!-- People Category -->&#x2714;
|<!-- Relationships Category -->&#x2714;
|<!-- Families Category -->&#x2714;
|<!-- Charts Category -->&#x2714;
|<!-- Events Category -->&#x2714;
|<!-- Places Category -->&#x2714;
|<!-- Geography Category -->&#x2714;
|<!-- Sources Category -->&#x2714;
|<!-- Citations Category -->&#x2714;
|<!-- Repositories Category -->&#x2714;
|<!-- Media Category -->&#x2714;
|<!-- Notes Category -->&#x2714;
|-<!-- Copy this section for any new core plugins -->
|<!-- Gramplet --> id="xx" |
|<!-- 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 -->
|-
|}
For more detailed information on using the installed Gramplets, see [[Gramps 5.1 Wiki Manual - Gramplets|Gramplets]].
{{-}}

=Gramplets=

This following sections describe each Gramplet and its basic functionality.
{{-}}
<!--WIP - need to check from here on eg sort if need into order-->
== 2-Way Fan Chart ==
[[File:2-WayFanChart-detached-gramplet-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 2-Way Fan Gramplet]]



* See also [[Gramps_5.1_Wiki_Manual_-_Categories#2-Way_Fan_View|2-Way Fan (Chart) View]]
{{-}}

== Age on Date ==

[[File:AgeOnDate-Gramplet-detached-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Age On Date Gramplet - detached example]]

The {{man label|Age on Date}} Gramplet allows you to enter a [https://en.wikipedia.org/wiki/Calendar_date Calendar date] in the {{man label|Date:}} entry field. If you select the {{man button|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.

{{-}}
[[File:AgeOnDate-Gramplet-QuickView-example-result-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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''.

{{-}}
* You can also drag a date to from [[Gramps_5.1_Wiki_Manual_-_Gramplets#Calendar|Calendar Gramplet]] to the {{man label|Age on Date}} Gramplets {{man label|Date:}} entry field to enter that date. 
* See also the [[Third-party_Addons|Third-party Addon]] [[Addon:DateCalculator|Date Calculator Gramplet]] which allows you to do date math.
{{-}}

== Age Stats ==
[[File:AgeStats-Gramplet-detached-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Age Stats Gramplet - detached example]]

The {{man label|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.

====&#x2699; Configurable Options====
[[File:AgeStats-Gramplet-configuration-tab-50.png|right|thumb|300px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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 {{man button|Configure active view}} button.
{{-}}

== Ancestors ==
[[File:Ancestors-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Ancestors Gramplet - detached example]]

Gramplet showing active person's ancestors.
{{-}}

== Attributes ==

[[File:Attributes-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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.
{{-}}
[[File:Atttribute-Gramplet-QuickView-example-result-50.png|right|350px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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 [[Gramps_5.1_Wiki_Manual_-_Gramplets#Attributes|Attributes]]
{{-}}
===Family Attributes===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Attributes|Attributes]]
{{-}}
===Event Attributes===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Attributes|Attributes]]
{{-}}
===Source Attributes===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Attributes|Attributes]]
{{-}}
===Citation Attributes===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Attributes|Attributes]]
{{-}}
===Media Attributes===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Attributes|Attributes]]
{{-}}

== Calendar ==
[[File:Calendar-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Calendar Gramplet - detached example]]

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

With the {{man button|<}} and {{man button|>}} buttons top left corner (month) you can change to the previous and next month.

With the {{man button|<}} and {{man button|>}} 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 [[Gramps_5.1_Wiki_Manual_-_Gramplets#Age on Date|Age on Date Gramplet]] to enter that date.
{{-}}

== Children ==
[[File:Children-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Children Gramplet - detached example]]

Gramplet showing the active persons children.

[[Gramps_5.1_Wiki_Manual_-_FAQ#How_do_I_change_the_order_of_children.3F|How do I change the order of children?]]
Use:
* The Family Editor [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Children|Children]] tab to change the order of children in the family.
* The third party addon [[Addon:BirthOrderTool|Birth Order Tool]] which allows bulk updates of the children order.
{{-}}
===Person Children===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Children|Children]]

Also shows the childs spouse if present.
{{-}}

===Family Children===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Children|Children]]
{{-}}

== Citations ==
[[File:Citation-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Citation Gramplet - detached example]]

Gramplet showing the active persons citations.
{{-}}
===Person Citations===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Citations|Citations]]
{{-}}
===Family Citations===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Citations|Citations]]
{{-}}
===Event Citations===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Citations|Citations]]
{{-}}
===Place Citations===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Citations|Citations]]
{{-}}
===Media Citations===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Citations|Citations]]
{{-}}

== Descendant Fan Chart==
[[File:DescendantFan-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Descendant Fan (chart) Gramplet - detached example]]

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

* See also: [[Gramps_5.1_Wiki_Manual_-_Categories#Descendant_Fan_View|Descendant Fan View]]
{{-}}

== Descendants ==
[[File:Descendants-Gramplet-detached-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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, [http://en.wikipedia.org/wiki/Drag-and-drop drag and drop] them in the correct order in the Family edit window.

This Gramplet is based on the [[Gramps_5.1_Wiki_Manual_-_Reports_-_part_6#Descendant_Report|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.
{{-}}

== Подробности ==
[[File:Details-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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: [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Gallery|Edit Person Editors - Gallery tab]]

You may highlight and copy the individual text fields.

{{-}}
===Person Details===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Details|Details]]
{{-}}
===Place Details===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Details|Details]]
{{-}}
===Repository Details===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Details|Details]]
{{-}}

== Encloses ==
[[File:Encloses-Gramplet-detached-example-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Encloses Gramplet - detached example]]

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

{{-}}
* See also [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Enclosed_By|Enclosed By]] tab
===Encloses Place Locations===

See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Locations|Locations]]
{{-}}

== Enclosed By==
[[File:EnclosedBy-Gramplet-detached-example-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Enclosed By Gramplet - detached example]]

Gramplet showing the locations enclosed by a place over time.

{{-}}
* See also [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Enclosed_By|Enclosed By]] tab
===Enclosed By Place Locations===

See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Locations|Locations]]
{{-}}

== Events ==
[[File:Events-Gramplet-detached-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Events Gramplet - detached example]]

Gramplet showing the events for the active person.

Double click a row to edit the event.
{{-}}
===Person Events===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Events|Events]]
{{-}}
===Family Events===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Events|Events]]
{{-}}

== Events Coordinates ==
[[File:EventsCoordinates-Gramplet-detached-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Events Coordinates Gramplet - detached example]]

Gramplet showing the events coordinates for the active person.

Double click a row to edit the event.
{{-}}

== Fan Chart ==
[[File:FanChart-detached-gramplet-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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: [[Gramps_5.1_Wiki_Manual_-_Categories#Fan_Chart_View|Fan Chart View]]
{{-}}

== FAQ ==
[[File:FAQ-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} FAQ Gramplet - detached example]]

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

<!--links in gramplet to wiki are outdated/ provide links here also-->
{{-}}

== Filter ==


Gramplet providing a filter specific to the Category.

See also [[Gramps_5.1_Wiki_Manual_-_Filters#Which_filters_in_which_Category.3F|Which filters in which Category?]]
{{-}}
===Person Filter===

[[File:FilterGramplet-Person-detached-default-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Person - Filter Gramplet - detached - default]]



See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Filter|Filter]]
{{-}}

===Family Filter===

[[File:FilterGramplet-Family-detached-default-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Family - Filter Gramplet - detached - default]]


See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Filter|Filter]]
{{-}}

===Event Filter===

[[File:FilterGramplet-Event-detached-default-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Event - Filter Gramplet - detached - default]]


See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Filter|Filter]]
{{-}}

===Place Filter===

[[File:FilterGramplet-Place-detached-default-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Place - Filter Gramplet - detached - default]]


See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Filter|Filter]]
{{-}}

===Source Filter===

[[File:FilterGramplet-Source-detached-default-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Source - Filter Gramplet - detached - default]]


See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Filter|Filter]]
{{-}}

===Citation Filter===

[[File:FilterGramplet-Citation-detached-default-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Citation - Filter Gramplet - detached - default]]


See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Filter|Filter]]
{{-}}

===Repository Filter===

[[File:FilterGramplet-Repository-detached-default-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Repository - Filter Gramplet - detached - default]]


See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Filter|Filter]]
{{-}}

===Media Filter===

[[File:FilterGramplet-Media-detached-default-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Media - Filter Gramplet - detached - default]]


See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Filter|Filter]]
{{-}}

===Notes Filter===

[[File:FilterGramplet-Notes-detached-default-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Notes - Filter Gramplet - detached - default]]


See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Filter|Filter]]
{{-}}

== Gallery ==
[[File:Gallery-Gramplet-detached-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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.


See also [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Gallery|Gallery]] tab for {{man label|[[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Edit_Person_dialog|Edit Person dialog]] }}where you can change which image is the primary active media object for reports etc...
{{-}}
===Person Gallery===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Gallery|Gallery]]
{{-}}
===Family Gallery===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Gallery|Gallery]]
{{-}}
===Event Gallery===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Gallery|Gallery]]
{{-}}
===Place Gallery===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Gallery|Gallery]]
{{-}}
===Source Gallery===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Gallery|Gallery]]
{{-}}
===Citation Gallery===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Gallery|Gallery]]
{{-}}

== Given Name Cloud ==
[[File:GivenNameCloud-Gramplet-detached-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Given Name Cloud Gramplet - detached example]]

Like the [[#Surname Cloud Gramplet|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 ==
[[File:ImageMetadata-Gramplet-detached-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Image Metadata Gramplet - example]]

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).
{{-}}
See also the third party:
* [[Addon:Edit Image Exif Metadata]]

=== 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]<br>or install gexiv2 from your local Linux repository.<br>MS-Windows users, this is depends on which installer you used.<br>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...

<!--update for gexiv2-->
Pyexiv2 can be used from the command line interface (cli) as well, and from within a python script:
# import the pyexiv2 library
#: from pyexiv2 import ImageMetadata, ExifTag
# specify your image
#: image = ImageMetadata("/home/user/image.jpg")
# read the image
#: image.read()

Exif, IPTC, XMP metadata reference tags can be found [http://www.exiv2.org/metadata.html 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:
# install pyexiv2
# Install this addon
# Restart Gramps
# Click Views from the Menu bar, and select Media Views
# Open the Side Bar
# Slide the available empty right view to about half the screen.
# Right click text to the Side Bar tab, and select Add a Gramplet
# Select Image Metadata Gramplet
# Select an image from the left hand MediaView
{{-}}

== Media Preview ==
[[File:MediaPreview-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Media Preview Gramplet - detached example]]

Gramplet shows a preview of a single media object.
{{-}}
See  [[Gramps_5.1_Wiki_Manual_-_Categories#Media_Category|Media Category]]

== Notes ==
[[File:Notes-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Notes Gramplet - detached example]]

Gramplet showing the active persons notes.

See also:
* [[Addon:NoteGramplet|Note Gramplet]] - Third party Addon
{{-}}
===Person Notes===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Notes|Notes]]
{{-}}
===Family Notes===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Notes|Notes]]
{{-}}
===Event Notes===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Notes|Notes]]
{{-}}
===Place Notes===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Notes|Notes]]
{{-}}
===Source Notes===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Notes|Notes]]
{{-}}
===Citation Notes===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Notes|Notes]]
{{-}}
===Repository Notes===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Notes|Notes]]
{{-}}
===Media Notes===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Notes|Notes]]
{{-}}

== Pedigree ==
[[File:Pedigree-Gramplet-detached-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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.
====&#x2699; Configurable Options====
* Maximum generations: 1 to 100 limit; (''100'')
* Show Dates checkbox; (''deselected'')
* Line Type menu: <abbr title="Unicode Transformation Format graphical symbols">UTF</abbr>, <abbr title="American Standard Code for Information Interchange text symbols">ASCII</abbr>; (''UTF'')

== Quick View ==
[[File:QuickView-Gramplet-Configuration-tab-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Quick View Gramplet - detached example]]

The Quick View Gramplet allows you to run a Quick View, it updates as you move from person to person. (When this Gramplet was introduced, it only supported running Quick Views from the People category. Other categories are now supported.)

You can run any of the [[Gramps_5.1_Wiki_Manual_-_Reports_-_part_8#Quick_Views|Quick Views]] for a person.
{{-}}
[[File:QuickView-Gramplet-detached-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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 {{man label|Options}} on the top row, and a list of options will appear. Press {{man button|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:
* [[Gramps_5.1_Wiki_Manual_-_Reports_-_part_8#Making_your_own_Quick_view|Making your own Quick view]].
{{-}}

== Records ==
[[File:Records-Gramplet-detached-50.png|right|thumb|350px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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'''
# van Dosselaere, Egidius and Rechters, Petronella (382 years, 1 month)
# de Richter, Petrus and Asscericx, Catharina (379 years, 9 months)
{{-}}

An identical [[Gramps_5.1_Wiki_Manual_-_Reports_-_part_6#Records_Report|Records Report]] is also available.

== References ==
[[File:References-Gramplet-detached-50.png|right|thumb|350px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} References Gramplet - detached example]]
Gramplet showing the active persons References.

{{-}}
===Person References===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Family References===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Event References===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Place References===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Source References===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Citation References===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Repository References===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Media References===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Note References===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}

== Relatives ==
[[File:Relatives-Gramplet-detached-50.png|right|thumb|350px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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)
{{-}}

== Residence ==

[[File:ResidenceGramplet-Person-detached-example-50.png|right|thumb|450px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Person - Residence Gramplet - detached - example]]

Gramplet showing residence events for the active person

{{-}}
===Person Residence===


See [[Gramps_5.1_Wiki_Manual_-_Gramplets#Residence|Residence]]
{{-}}

== Session Log ==
[[File:SessionLog-Gramplet-detached-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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 {{man label|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 ==
[[File:SoundEx-Gramplet-detached-50.png|thumb|right|300px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} SoundEx Gramplet - detached example]]

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

From the {{man label|SoundEx Gramplet}} window you can either choose a {{man label|Name:}} from the list by shown by selecting the down {{man button|\/}} 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 {{man button|Help}} button is available which brings you to this page. With the {{man button|Close}} button (or using the keyboard shortcut {{man key press|Alt|C}}) you close the {{man label|SoundEx Gramplet}} window.
{{-}}
==== Soundex what is this? ====

Soundex is the most widely known of all [http://en.wikipedia.org/wiki/Phonetic_algorithm 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).

{|{{prettytable}}  
!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 [http://www.archives.gov/research/census/soundex.html NARA Soundex Indexing page] to learn more about Soundex Indexing System.
{{-}}

== Statistics ==
[[File:Statistics-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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 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 {{man button|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 [[Gramps_5.1_Wiki_Manual_-_Reports_-_part_6#Database_Summary_Report|Database Summary Report]]
{{-}}

== Surname Cloud ==
[[File:SurnameCloud-Gramplet-detached-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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 {{man label|Same Surnames Quick View}}. This will open the {{man label|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.
{{-}}
[[File:SurnameCloud-Gramplet-Configuration-tab-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Surname Cloud Gramplet - Configuration tab shown]]

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

== To Do ==
[[File:ToDo-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} To Do Gramplet - detached example]]

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 Addons|Third-party Addon]]: 
* [[Addon:ToDoNotesGramplet|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 [[Gramps_5.1_Wiki_Manual_-_Gramplets#To Do|To Do]]
{{-}}
===Family To Do===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#To Do|To Do]]
{{-}}
===Event To Do===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#To Do|To Do]]
{{-}}
===Place To Do===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#To Do|To Do]]
{{-}}
===Source To Do===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#To Do|To Do]]
{{-}}
===Citation To Do===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#To Do|To Do]]
{{-}}
===Repository To Do===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#To Do|To Do]]
{{-}}
===Media To Do===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#To Do|To Do]]
{{-}}

== Top Surnames ==
[[File:TopSurnames-Gramplet-detached-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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 {{man label|Same Surnames Quick View}}. This opens the {{man label|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. 
{{-}}

Advanced:
* Change the number of names displayed by editing this section in <code>~/.gramps/gramps50/gramplets.ini</code>
{{-}}

== Uncollected Objects ==
{{man warn|Only shown if you are using Gramps in developer mode.}}
[[File:UncollectedObjects-Gramplet-detached-example-50.png|right|thumb|450px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Uncollected Objects Gramplet - detached example]]

The {{man label|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.
{{-}}

== Welcome ==
[[File:Welcome-Gramplet-detached-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Welcome Gramplet - detached example]]

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 [[Gramps_5.1_Wiki_Manual_-_Manage_Family_Trees|Family Tree]].

This information can also be found on the [[Main_page|start page of Gramps]]
{{-}}

== What's Next ==
[[File:WhatsNext-Gramplet-detached-50.png|right|thumb|350px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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:
* 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.
{{-}}
[[File:WhatsNext-Gramplet-Configuration-tab-50.png|right|thumb|350px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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

{{-}}
{{man index|Gramps 5.1 Wiki Manual - Plugin Manager|Gramps 5.1 Wiki Manual - Reports|5.1}}
{{languages/ru|Gramps_5.1_Wiki_Manual_-_Gramplets}}

{{grampsmanualcopyright/ru}}

[[Category:Ru:Documentation]]