Difference between revisions of "Gramps 5.0 Wiki Manual - Gramplets"
(→Attributes) |
m (Clear stub template from locked old user manual page in support of https://gramps.discourse.group/t/gramps-5-1-wiki-manual-stub-eradication/2938) |
||
(86 intermediate revisions by 2 users not shown) | |||
Line 68: | Line 68: | ||
{{man menu|No Menu option to add a Gramplet is available.}}<!-- Need feature request should appear under Menu > Edit > [Add a Gramplet to sidebar / Add a Gramplet to bottombar] --> | {{man menu|No Menu option to add a Gramplet is available.}}<!-- Need feature request should appear under Menu > Edit > [Add a Gramplet to sidebar / Add a Gramplet to bottombar] --> | ||
− | + | <!--WIP / add links to relevant individual sections for each core Gramplet--> | |
{{-}} | {{-}} | ||
Line 250: | Line 250: | ||
|<!-- Citations Category --> | |<!-- Citations Category --> | ||
|<!-- Repositories Category -->X | |<!-- Repositories Category -->X | ||
+ | |<!-- Media Category --> | ||
+ | |<!-- Notes Category --> | ||
+ | |- | ||
+ | |<!-- Gramplet --> id="18a" |{{man label|[[Gramps_5.0_Wiki_Manual_-_Gramplets#Encloses|Encloses]]}} | ||
+ | |<!-- Dashboard Category --> | ||
+ | |<!-- People Category --> | ||
+ | |<!-- Relationships Category --> | ||
+ | |<!-- Families Category --> | ||
+ | |<!-- Charts Category --> | ||
+ | |<!-- Events Category --> | ||
+ | |<!-- Places Category -->X | ||
+ | |<!-- Geography Category --> | ||
+ | |<!-- Sources Category --> | ||
+ | |<!-- Citations Category --> | ||
+ | |<!-- Repositories Category --> | ||
+ | |<!-- Media Category --> | ||
+ | |<!-- Notes Category --> | ||
+ | |- | ||
+ | |<!-- Gramplet --> id="18b" |{{man label|[[Gramps_5.0_Wiki_Manual_-_Gramplets#Enclosed_By|Enclosed By]]}} | ||
+ | |<!-- Dashboard Category --> | ||
+ | |<!-- People Category --> | ||
+ | |<!-- Relationships Category --> | ||
+ | |<!-- Families Category --> | ||
+ | |<!-- Charts Category --> | ||
+ | |<!-- Events Category --> | ||
+ | |<!-- Places Category -->X | ||
+ | |<!-- Geography Category --> | ||
+ | |<!-- Sources Category --> | ||
+ | |<!-- Citations Category --> | ||
+ | |<!-- Repositories Category --> | ||
|<!-- Media Category --> | |<!-- Media Category --> | ||
|<!-- Notes Category --> | |<!-- Notes Category --> | ||
|- | |- | ||
|<!-- Gramplet --> id="11" |{{man label|[[Gramps_5.0_Wiki_Manual_-_Gramplets#Events|Events]]}} | |<!-- Gramplet --> id="11" |{{man label|[[Gramps_5.0_Wiki_Manual_-_Gramplets#Events|Events]]}} | ||
+ | |<!-- Dashboard Category --> | ||
+ | |<!-- People Category -->X | ||
+ | |<!-- Relationships Category -->X | ||
+ | |<!-- Families Category -->X | ||
+ | |<!-- Charts Category -->X | ||
+ | |<!-- Events Category --> | ||
+ | |<!-- Places Category --> | ||
+ | |<!-- Geography Category -->X | ||
+ | |<!-- Sources Category --> | ||
+ | |<!-- Citations Category --> | ||
+ | |<!-- Repositories Category --> | ||
+ | |<!-- Media Category --> | ||
+ | |<!-- Notes Category --> | ||
+ | |- | ||
+ | |<!-- Gramplet --> id="11a" |{{man label|[[Gramps_5.0_Wiki_Manual_-_Gramplets#Events_Coordinates|Events Coordinates]]}} | ||
|<!-- Dashboard Category --> | |<!-- Dashboard Category --> | ||
|<!-- People Category -->X | |<!-- People Category -->X | ||
Line 358: | Line 403: | ||
|<!-- Notes Category --> | |<!-- Notes Category --> | ||
|- | |- | ||
− | |<!-- Gramplet --> id=" | + | |<!-- Gramplet --> id="21" |{{man label|[[Gramps_5.0_Wiki_Manual_-_Gramplets#Media_Preview|Media Preview]]}} |
|<!-- Dashboard Category --> | |<!-- Dashboard Category --> | ||
|<!-- People Category --> | |<!-- People Category --> | ||
Line 365: | Line 410: | ||
|<!-- Charts Category --> | |<!-- Charts Category --> | ||
|<!-- Events Category --> | |<!-- Events Category --> | ||
− | |<!-- Places Category --> | + | |<!-- Places Category --> |
|<!-- Geography Category --> | |<!-- Geography Category --> | ||
|<!-- Sources Category --> | |<!-- Sources Category --> | ||
|<!-- Citations Category --> | |<!-- Citations Category --> | ||
|<!-- Repositories Category --> | |<!-- Repositories Category --> | ||
− | |<!-- Media Category --> | + | |<!-- Media Category -->X |
|<!-- Notes Category --> | |<!-- Notes Category --> | ||
|- | |- | ||
Line 401: | Line 446: | ||
|<!-- Repositories Category --> | |<!-- Repositories Category --> | ||
|<!-- Media Category --> | |<!-- Media Category --> | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
|<!-- Notes Category --> | |<!-- Notes Category --> | ||
|- | |- | ||
Line 651: | Line 681: | ||
This following sections describe each Gramplet and its basic functionality. | 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 == | == 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]] | [[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.0_Wiki_Manual_-_Categories#2-Way_Fan_View|2-Way Fan (Chart) View]] | * See also [[Gramps_5.0_Wiki_Manual_-_Categories#2-Way_Fan_View|2-Way Fan (Chart) View]] | ||
Line 681: | Line 711: | ||
[[File:AgeStats-Gramplet-detached-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Age Stats Gramplet - detached example]] | [[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 scroll | + | 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''' | + | * '''Lifespan Age Distribution''' - for all people having valid birth and death dates. |
− | * ''Father - Child Age Diff Distribution'' - shows the age difference between father | + | * '''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 mother | + | * '''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. | |
− | [[File:AgeStats-Gramplet-configuration-tab-50.png|right|thumb|300px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Age Stats Gramplet - Configuration tab defaults]] | + | |
+ | 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==== | ||
+ | [[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. | |
{{-}} | {{-}} | ||
Line 707: | Line 745: | ||
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. | 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. | 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=== | ===Person Attributes=== | ||
See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Attributes|Attributes]] | See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Attributes|Attributes]] | ||
Line 730: | Line 769: | ||
== Calendar == | == 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. | The Calendar Gramplet shows a monthly calendar. Double-click a day to run the {{man label|On This Day}} Quick View. | ||
Line 750: | Line 789: | ||
== Children == | == Children == | ||
− | [[File: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.0_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.0_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 [[BirthOrderTool|Birth Order Tool]] which allows bulk updates of the children order. | ||
{{-}} | {{-}} | ||
===Person Children=== | ===Person Children=== | ||
Line 765: | Line 809: | ||
== Citations == | == Citations == | ||
− | [[File: | + | [[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 citations. | + | Gramplet showing the active persons citations. |
{{-}} | {{-}} | ||
===Person Citations=== | ===Person Citations=== | ||
Line 786: | Line 830: | ||
== Descendant Fan Chart== | == Descendant Fan Chart== | ||
− | [[File: | + | [[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. | Gramplet showing active person's direct descendants as a fan chart. | ||
Line 794: | Line 838: | ||
== Descendants == | == 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 Descendants Gramplet shows the direct descendants of the active person. | ||
Line 808: | Line 852: | ||
== Details == | == Details == | ||
− | + | [[File:Details-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Details Gramplet - detached example]] | |
− | [[File:Details- | ||
− | Gramplet showing details of | + | Gramplet showing details of the active person. |
Provides a brief non editable summary of the selected person for example: | Provides a brief non editable summary of the selected person for example: | ||
Line 823: | Line 866: | ||
* ''Burial:'' | * ''Burial:'' | ||
− | * ''Image'': | + | * ''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.0_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=== | ===Person Details=== | ||
Line 833: | Line 879: | ||
===Repository Details=== | ===Repository Details=== | ||
See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Details|Details]] | See [[Gramps_5.0_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.0_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Enclosed_By|Enclosed By]] tab | ||
+ | ===Encloses Place Locations=== | ||
+ | |||
+ | See [[Gramps_5.0_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.0_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#Enclosed_By|Enclosed By]] tab | ||
+ | ===Enclosed By Place Locations=== | ||
+ | |||
+ | See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Locations|Locations]] | ||
{{-}} | {{-}} | ||
== Events == | == Events == | ||
− | [[File: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=== | ===Person Events=== | ||
Line 845: | Line 917: | ||
===Family Events=== | ===Family Events=== | ||
See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Events|Events]] | See [[Gramps_5.0_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. | ||
{{-}} | {{-}} | ||
Line 872: | Line 952: | ||
== FAQ == | == FAQ == | ||
− | + | [[File:FAQ-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} FAQ Gramplet - detached example]] | |
− | [[File: | ||
− | Gramplet | + | 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 == | == Filter == | ||
− | + | ||
Gramplet providing a filter specific to the Category. | Gramplet providing a filter specific to the Category. | ||
Line 887: | Line 968: | ||
===Person Filter=== | ===Person Filter=== | ||
− | [[File: | + | [[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.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | ||
{{-}} | {{-}} | ||
+ | |||
===Family Filter=== | ===Family Filter=== | ||
− | [[File: | + | [[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.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | ||
{{-}} | {{-}} | ||
+ | |||
===Event Filter=== | ===Event Filter=== | ||
− | [[File: | + | [[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.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | ||
{{-}} | {{-}} | ||
+ | |||
===Place Filter=== | ===Place Filter=== | ||
− | [[File: | + | [[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.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | ||
{{-}} | {{-}} | ||
+ | |||
===Source Filter=== | ===Source Filter=== | ||
− | [[File: | + | [[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.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | ||
{{-}} | {{-}} | ||
+ | |||
===Citation Filter=== | ===Citation Filter=== | ||
− | [[File: | + | [[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.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | ||
{{-}} | {{-}} | ||
+ | |||
===Repository Filter=== | ===Repository Filter=== | ||
− | [[File: | + | [[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.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | ||
{{-}} | {{-}} | ||
+ | |||
===Media Filter=== | ===Media Filter=== | ||
− | [[File: | + | [[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.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | ||
{{-}} | {{-}} | ||
+ | |||
===Notes Filter=== | ===Notes Filter=== | ||
− | [[File: | + | [[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.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Filter|Filter]] | ||
Line 941: | Line 1,040: | ||
== Gallery == | == 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 | + | |
+ | 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.0_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Gallery|Gallery]] tab for {{man label|[[Gramps_5.0_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=== | ===Person Gallery=== | ||
Line 964: | Line 1,067: | ||
== Given Name Cloud == | == 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. | 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. | ||
Line 972: | Line 1,075: | ||
Double-click on the given name to bring up a Quick View of all of the matching people. | Double-click on the given name to bring up a Quick View of all of the matching people. | ||
{{-}} | {{-}} | ||
+ | |||
== Image Metadata == | == 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). | 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: | ||
+ | * [[Edit Image Exif Metadata]] addon | ||
=== Prerequisites === | === Prerequisites === | ||
− | {{man tip|Special Note|Before being able to use this Gramplet/Addon, you will need to download and install [https://wiki.gnome.org/Projects/gexiv2 gexiv2] | + | {{man tip|Special Note|Before being able to use this Gramplet/Addon, you will need to download and install [https://wiki.gnome.org/Projects/gexiv2 gexiv2]<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]]}} |
− | or install gexiv2 from your local Linux repository. | ||
Once you have installed gexiv2, see above for directions to download and install this addon... | Once you have installed gexiv2, see above for directions to download and install this addon... | ||
− | + | <!--update for gexiv2--> | |
Pyexiv2 can be used from the command line interface (cli) as well, and from within a python script: | Pyexiv2 can be used from the command line interface (cli) as well, and from within a python script: | ||
# import the pyexiv2 library | # import the pyexiv2 library | ||
Line 1,020: | Line 1,125: | ||
{{-}} | {{-}} | ||
− | == | + | == Media Preview == |
− | [[File: | + | [[File:MediaPreview-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Media Preview Gramplet - detached example]] |
− | Gramplet | + | Gramplet shows a preview of a single media object. |
− | |||
− | |||
− | |||
{{-}} | {{-}} | ||
+ | See [[Gramps_5.0_Wiki_Manual_-_Categories#Media_Category|Media Category]] | ||
== Notes == | == Notes == | ||
− | [[File: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 notes. | + | Gramplet showing the active persons notes. |
{{-}} | {{-}} | ||
===Person Notes=== | ===Person Notes=== | ||
Line 1,060: | Line 1,163: | ||
== Pedigree == | == Pedigree == | ||
− | [[ | + | [[File:Pedigree-Gramplet-detached-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Pedigree Gramplet - detached example]] |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | Gramplet | + | The Pedigree Gramplet shows a compressed view of the active person's direct ancestors. It defaults to going back 100 generations. The names can be clicked to change the active person, right-click to edit the person. 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. |
− | + | ====⚙ 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 == | == 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. (Currently, only People Quick Views can be run). | The Quick View Gramplet allows you to run a Quick View, it updates as you move from person to person. (Currently, only People Quick Views can be run). | ||
You can run any of the [[Gramps_5.0_Wiki_Manual_-_Reports_-_part_8#Quick_Views|Quick Views]] for a person. | You can run any of the [[Gramps_5.0_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. | 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.0_Wiki_Manual_-_Reports_-_part_8#Making_your_own_Quick_view|Making your own Quick view]]. | + | |
+ | {{-}} | ||
+ | See the following developer information if you are interested in creating your own: | ||
+ | * [[Gramps_5.0_Wiki_Manual_-_Reports_-_part_8#Making_your_own_Quick_view|Making your own Quick view]]. | ||
{{-}} | {{-}} | ||
== Records == | == 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. | 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. | ||
Line 1,122: | Line 1,224: | ||
== References == | == 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 References. | + | Gramplet showing the active persons References. |
+ | |||
{{-}} | {{-}} | ||
===Person References=== | ===Person References=== | ||
Line 1,154: | Line 1,257: | ||
== Relatives == | == 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". | 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". | ||
Line 1,170: | Line 1,273: | ||
== Residence == | == Residence == | ||
− | |||
− | Gramplet showing residence events for | + | [[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=== | ===Person Residence=== | ||
+ | |||
+ | |||
See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Residence|Residence]] | See [[Gramps_5.0_Wiki_Manual_-_Gramplets#Residence|Residence]] | ||
{{-}} | {{-}} | ||
== Session Log == | == 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. | The session log keeps track of activity in this session. It lists selected and edited objects. | ||
Line 1,187: | Line 1,294: | ||
This Gramplet is handy because you can very quickly change the active person, or edit the object, from the session list. | This Gramplet is handy because you can very quickly change the active person, or edit the object, from the session list. | ||
{{-}} | {{-}} | ||
+ | |||
== SoundEx == | == SoundEx == | ||
− | [[File: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. | This Gramplet generates SoundEx codes for the names of people in the database. | ||
Line 1,257: | Line 1,365: | ||
== Statistics == | == 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. | 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: | Following information is provided to you in this Gramplet: | ||
− | *Individuals | + | *'''Individuals''' |
**Number of individuals | **Number of individuals | ||
**Males | **Males | ||
**Females | **Females | ||
**Individuals with unknown gender | **Individuals with unknown gender | ||
− | ** | + | **Incomplete names |
**Individuals with missing birth dates | **Individuals with missing birth dates | ||
**Disconnected individuals | **Disconnected individuals | ||
− | *Family information | + | *'''Family information''' |
**Number of families | **Number of families | ||
**Unique surnames | **Unique surnames | ||
− | *Media objects | + | *'''Media objects''' |
**Individuals with media objects | **Individuals with media objects | ||
**Total numbers of media object references | **Total numbers of media object references | ||
Line 1,286: | Line 1,394: | ||
== Surname Cloud == | == 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. | 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. | ||
Line 1,293: | Line 1,401: | ||
If you mouse over the name you see the percentage of occurrence and total counts. | 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 == | == 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. | 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. | 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]] [[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. | + | See also the experimental [[Third-party Addons|Third-party 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=== | ===Person To Do=== | ||
Line 1,331: | Line 1,443: | ||
== Top Surnames == | == 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 Surnames Gramplet shows the top 10 (by default) used surnames. | ||
Line 1,345: | Line 1,457: | ||
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. | A table is presented which shows all people with a matching name or alternate name. Person's name, ID, birth date and name type is given. | ||
+ | {{-}} | ||
− | Change the number of names displayed by editing this section in <code>~/.gramps/ | + | Advanced: |
+ | * Change the number of names displayed by editing this section in <code>~/.gramps/gramps50/gramplets.ini</code> | ||
{{-}} | {{-}} | ||
== Uncollected Objects == | == 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 == | == 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 Gramplet gives an introductory message to new users, and some basic instructions. | ||
Line 1,363: | Line 1,483: | ||
== What's Next == | == What's Next == | ||
− | [[File: | + | [[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: | 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: | ||
Line 1,375: | Line 1,495: | ||
You may copy the text from inside of this Gramplet by selecting it and pasting into an empty document. | You may copy the text from inside of this Gramplet by selecting it and pasting into an empty document. | ||
− | + | {{-}} | |
− | [[File: | + | [[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: | 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: |
Latest revision as of 23:42, 27 October 2022
Previous | Index | Next |
Languages: |
English • Deutsch • français • македонски • Nederlands • polski • русский • shqip |
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. |
Contents
- 1 What is a Gramplet
- 2 Gramplets
- 2.1 2-Way Fan Chart
- 2.2 Age on Date
- 2.3 Age Stats
- 2.4 Ancestors
- 2.5 Attributes
- 2.6 Calendar
- 2.7 Children
- 2.8 Citations
- 2.9 Descendant Fan Chart
- 2.10 Descendants
- 2.11 Details
- 2.12 Encloses
- 2.13 Enclosed By
- 2.14 Events
- 2.15 Events Coordinates
- 2.16 Fan Chart
- 2.17 FAQ
- 2.18 Filter
- 2.19 Gallery
- 2.20 Given Name Cloud
- 2.21 Image Metadata
- 2.22 Media Preview
- 2.23 Notes
- 2.24 Pedigree
- 2.25 Quick View
- 2.26 Records
- 2.27 References
- 2.28 Relatives
- 2.29 Residence
- 2.30 Session Log
- 2.31 SoundEx
- 2.32 Statistics
- 2.33 Surname Cloud
- 2.34 To Do
- 2.35 Top Surnames
- 2.36 Uncollected Objects
- 2.37 Welcome
- 2.38 What's Next
What is a Gramplet
A Gramps Gramplet is a view of data that either changes dynamically during the running of Gramps, or provides interactivity to your genealogical data. Gramplets are the widgets that are part of Gramps and can be seen in the Dashboard Category, Sidebars and Bottombars in other Navigator Categories, they provide all kinds of functionality that can be useful for the researcher.
What is the difference between Gramplets, reports, quick views, and tools?
- Reports provide a static output format of your data, typically for presentation
- Quick View provides a typically short, interactive listing derived from your data
- Tools provide a method of processing your data
- Gramplets provide a dynamic view and interface to your data
When you first start the Dashboard Category you will see two default Gramplets; the Welcome to Gramps! Gramplet and the Top Surnames Gramplet.
Since Gramps 4.2 we have common and specific Gramplets according active view (navigation/category).
- Back references Gramplets are like the references tab on object Editor.
- Filter Gramplet is like the previous filter sidebar
- Common models for Notes, Gallery, Sources, Citations, Events
- Children Gramplet on Person views (also charts category and relationships category), families view
General Usage and Configuration
In Dashboard You can drag the Properties button (top left) of each Gramplet to move it around the Dashboard View area. You can click the Properties button to detach the Gramplet from Dashboard View and place it in its own window. The window will stay open regardless of page (relationships, charts, etc). Closing the detached view will put it back onto the Dashboard view. If you quit Gramps with a open Gramplet, when you start gramps again, it will open automatically.
When one or more Gramplets are undocked from the Dashboard View, you can change to a different view (such as the People or Charts Views). In this way, you can use these Gramplets to supplement a particular view with additional details and functionality provided by the Gramplet.
You can add new Gramplets by right clicking on an open space on Dashboard view. Click the 'X' above the Gramplet to remove it from the Dashboard.
You can also change the number of columns by changing a setting in configure the active view to open the Configure Gramplets window, to change the Dashboard Layouts > Number of Columns. You can also per added gramplet change its window dimensions and optionally other properties.
If a link in a Gramplet is to a specific person, then clicking the link will change the Active Person. Double-clicking such any link to a specific Gramps item (such as person or family) will bring up the Editor for that item. To edit a linked person without changing the Active Person, right-click on the person link. Depending on the type of entry, double-clicking any row in a Quick View table will either select more specific data (drill down) or bring up the editor.
Double-clicking the title of a Gramplet docked in the Dashboard Category allows you to change the display title.
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 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.
No Menu option to add a Gramplet is available.
Gramplet | Dashboard Category | People Category | Relationships Category | Families Category | Charts Category | Events Category | Places Category | Geography Category | Sources Category | Citations Category | Repositories Category | Media Category | Notes Category |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2-Way Fan Chart | X | X | X | X | |||||||||
Age Stats | X | X | X | X | X | X | X | X | X | X | X | X | X |
Age on Date | X | X | X | X | X | X | X | X | X | X | X | X | X |
Ancestors | X | X | X | X | |||||||||
Attributes | X | X | X | X | X | X | X | X | X | ||||
Calendar | X | X | X | X | X | X | X | X | X | X | X | X | X |
Children | X | X | X | X | X | ||||||||
Citations | X | X | X | X | X | X | X | X | |||||
Descendant Fan | X | X | X | X | |||||||||
Descendants | X | X | X | X | |||||||||
Details | X | X | X | X | X | X | |||||||
Encloses | X | ||||||||||||
Enclosed By | X | ||||||||||||
Events | X | X | X | X | X | ||||||||
Events Coordinates | X | X | X | X | X | ||||||||
FAQ | X | X | X | X | X | X | X | X | X | X | X | X | X |
Fan Chart | X | X | X | X | |||||||||
Filter | X | X | |||||||||||
Gallery | X | X | X | X | X | X | X | X | X | ||||
Given Name Cloud | X | X | X | X | X | X | X | X | X | X | X | X | X |
Image Metadata | X | ||||||||||||
Media Preview | X | ||||||||||||
Notes | X | X | X | X | X | X | X | X | X | X | X | ||
Pedigree | X | X | X | X | |||||||||
Quick View | X | X | X | X | X | X | X | X | X | X | X | X | X |
Records | X | X | X | X | X | X | X | X | X | X | X | X | X |
References | X | X | X | X | X | X | X | X | X | X | X | X | |
Relatives | X | X | X | X | |||||||||
Residence | X | X | X | X | |||||||||
Session Log | X | X | X | X | X | X | X | X | X | X | X | X | X |
SoundEx | X | X | X | X | X | X | X | X | X | X | X | X | X |
Statistics | X | X | X | X | X | X | X | X | X | X | X | X | X |
Surname Cloud | X | X | X | X | X | X | X | X | X | X | X | X | X |
To Do | X | X | X | X | X | X | X | X | X | X | X | X | |
Top Surnames | X | X | X | X | X | X | X | X | X | X | X | X | X |
Uncollected Objects! | X | X | X | X | X | X | X | X | X | X | X | X | X |
Welcome to Gramps! | X | X | X | X | X | X | X | X | X | X | X | X | X |
What's Next? | X | X | X | X | X | X | X | X | X | X | X | X | X |
For more detailed information on using the installed Gramplets, see Gramplets.
Gramplets
This following sections describe each Gramplet and its basic functionality.
2-Way Fan Chart
- See also 2-Way Fan (Chart) View
Age on Date
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.
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 Calendar Gramplet to the Age on Date Gramplets Date: entry field to enter that date.
- See also the Third-party Addon Date Calculator Gramplet which allows you to do date math.
Age Stats
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
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.
Ancestors
Gramplet showing active person's ancestors.
Attributes
The Attributes Gramplet shows all of the attributes for the current, active person. Double click on the name of the attribute, and you will run a Quick View that shows all of the people that have that attribute, and the values for it. You can sort the Quick View by the attribute value by clicking on the column name.
In the Quick View, highlight the entry to change the active person (which will then change the Attributes Gramplet), and double-click the Quick View entry to bring up the Edit Person dialog window.
Person Attributes
See Attributes
Family Attributes
See Attributes
Event Attributes
See Attributes
Source Attributes
See Attributes
Citation Attributes
See Attributes
Media Attributes
See Attributes
Calendar
The Calendar Gramplet shows a monthly calendar. Double-click a day to run the On This Day Quick View.
With the < and > buttons top left corner (month) you can change to the previous and next month.
With the < and > buttons top right corner (year) you can change to the previous and next year.
The Quick View window shows you the Events of the selected day: Events on this exact date and Other events on this Month/day in history as well as Other events in that year.
The information is presented in a table showing:
- Date
- Type
- Place
- Reference
You can also drag a date to the date field of the Age on Date Gramplet to enter that date.
Children
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
Citations
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
Gramplet showing active person's direct descendants as a fan chart.
- See also: Descendant Fan View
Descendants
The Descendants Gramplet shows the direct descendants of the active person.
The order of the spouses and children is that given in the Gramps editor. To change the order of spouses, click on Order on the Relationship view. To change the order of children, drag and drop them in the correct order in the Family edit window.
This Gramplet is based on the Descendant Report, available from the Textual Reports.
The Descendants Gramplet will update when you change the active person, or change family trees. It does not update automatically for edits or additions because this report is time-consuming to run.
Minimizing a Gramplet will prevent it from updating.
Details
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.
Person Details
See Details
Place Details
See Details
Repository Details
See Details
Encloses
Gramplet showing the locations of a place it encloses over time.
- See also Enclosed By tab
Encloses Place Locations
See Locations
Enclosed By
Gramplet showing the locations enclosed by a place over time.
- See also Enclosed By tab
Enclosed By Place Locations
See Locations
Events
Gramplet showing the events for the active person.
Double click a row to edit the event.
Person Events
See Events
Family Events
See Events
Events Coordinates
Gramplet showing the events coordinates for the active person.
Double click a row to edit the event.
Fan Chart
The Fan Chart Gramplet shows the direct ancestors of the active person in a circular format. It is similar to the Pedigree View, but shown around the center/active person, and further generations spiralling out.
Click on a parent in the chart and they will expand or contract above their child. Right-click on a person and you can:
- select that person to be the active person
- edit the person which allows through Person Editor add children to person's families
- select from among the person's relatives to be the active person
- add partners (families) to person
- copy name, birth and death of person into clipboard
Clicking in an open area (non-person) and dragging the mouse will allow you to rotate the chart about the center. In Gramps 5.0, 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: Fan Chart View
FAQ
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).
Filter
Gramplet providing a filter specific to the Category.
See also Which filters in which Category?
Person Filter
See Filter
Family Filter
See Filter
Event Filter
See Filter
Place Filter
See Filter
Source Filter
See Filter
Citation Filter
See Filter
Repository Filter
See Filter
Media Filter
See Filter
Notes Filter
See Filter
Gallery
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 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
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
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:
- Edit Image Exif Metadata addon
Prerequisites
Special Note Before being able to use this Gramplet/Addon, you will need to download and install gexiv2 |
Once you have installed gexiv2, see above for directions to download and install this addon...
Pyexiv2 can be used from the command line interface (cli) as well, and from within a python script:
- 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 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
Gramplet shows a preview of a single media object.
See Media Category
Notes
Gramplet showing the active persons notes.
Person Notes
See Notes
Family Notes
See Notes
Event Notes
See Notes
Place Notes
See Notes
Source Notes
See Notes
Citation Notes
See Notes
Repository Notes
See Notes
Media Notes
See Notes
Pedigree
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.
⚙ Configurable Options
- Maximum generations: 1 to 100 limit; (100)
- Show Dates checkbox; (deselected)
- Line Type menu: UTF, ASCII; (UTF)
Quick View
The Quick View Gramplet allows you to run a Quick View, it updates as you move from person to person. (Currently, only People Quick Views can be run).
You can run any of the Quick Views for a person.
You can change the options by clicking the Option button (top, left hand button of the Gramplet) which will detach the Gramplet and bring it up an a window. Select Options on the top row, and a list of options will appear. Press Save to apply the changes to the Quick View. You may then close the window to reattach the Gramplet.
See the following developer information if you are interested in creating your own:
Records
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 Records Report is also available.
References
Gramplet showing the active persons References.
Person References
See References
Family References
See References
Event References
See References
Place References
See References
Source References
See References
Citation References
See References
Repository References
See References
Media References
See References
Note References
See References
Relatives
This Gramplet shows all direct relatives of the active person. It's intended use is as a navigation help, an alternative way to move through your family tree in Gramps . If you detach the Gramplet, and place it next to Gramps, it will allow you to use it to easily change the content of the current "Person view".
If you are working in the charts category Pedigree view, the active person is the left-most person. By clicking a name in the relatives Gramplet, you can easily change the active person, and all person view in the other window will update. As the relatives Gramplet shows all spouses, all children and all parents, this offers an alternative way of navigating your data.
The names in this Gramplet also allow you to call up the person editor directly, by right-clicking on any of the names.
The Relatives Gramplet can be added to the following categories:
- People Category
- Relationships Category
- Charts Category
- Geography Category (selected views only)
Residence
Gramplet showing residence events for the active person
Person Residence
See Residence
Session Log
The session log keeps track of activity in this session. It lists selected and edited objects.
Click a name once to make this person the active person. Double-click on a name or family brings up the edit page for that object. In addition, if you want to edit a person, but don't want to change the active person, you can right-click on the person's name.
This Gramplet is handy because you can very quickly change the active person, or edit the object, from the session list.
SoundEx
This Gramplet generates SoundEx codes for the names of people in the database.
From the SoundEx Gramplet window you can either choose a Name: from the list by shown by selecting the down \/ arrow, or you can type a name into the text field.
The name you type in can be any name even a name not present in your Family Tree.
The result is shown automatically eg:The SoundEx code for Simpson is S512
A Help button is available which brings you to this page. With the Close button (or using the keyboard shortcut Alt+C) you close the SoundEx Gramplet window.
Soundex what is this?
Soundex is the most widely known of all phonetic algorithms which allow indexing of words by their sound, as pronounced in English.
The Soundex is a coded surname (last name) index based on the way a surname sounds rather than the way it is spelled. Surnames that sound the same, but are spelled differently, like SMITH and SMYTH, have the same code and are filed together. The Soundex coding system was developed so that you can find a surname even though it may have been recorded under various spellings.
First applied to the 1880 census, Soundex is a phonetic index, not a strictly alphabetical one. Its key feature is that it codes surnames (last names) based on the way a name sounds rather than on how it is spelled. It was to help researchers find a surname quickly even though it may have received different spellings.
Those doing census lookups must use the same method to encode surnames as the census takers did when they generated the database.
To search for a particular surname, you must first work out its code.
- Basic Soundex Coding Rule:
Every Soundex code consists of a letter and three numbers, such as W-252. The letter is always the first letter of the surname. The numbers are assigned to the remaining letters of the surname according to the Soundex guide shown below. Zeroes are added at the end if necessary to produce a four-character code. Additional letters are disregarded. Examples: Washington is coded W-252 (W, 2 for the S, 5 for the N, 2 for the G, remaining letters disregarded). Lee is coded L-000 (L, 000 added).
Number | Represents the Letters |
---|---|
1 | B, F, P, V |
2 | C, G, J, K, Q, S, X, Z |
3 | D, T |
4 | L |
5 | M, N |
6 | R |
Disregard the letters A, E, I, O, U, H, W, and Y.
- Additional Soundex Coding Rules:
- Names With Double Letters: If the surname has any double letters, they should be treated as one letter. For example:
- Gutierrez is coded G-362 (G, 3 for the T, 6 for the first R, second R ignored, 2 for the Z).
- Names with Letters Side-by-Side that have the Same Soundex Code Number: If the surname has different letters side-by-side that have the same number in the Soundex coding guide, they should be treated as one letter. Examples:
- Pfister is coded as P-236 (P, F ignored, 2 for the S, 3 for the T, 6 for the R).
- Jackson is coded as J-250 (J, 2 for the C, K ignored, S ignored, 5 for the N, 0 added).
- Tymczak is coded as T-522 (T, 5 for the M, 2 for the C, Z ignored, 2 for the K). Since the vowel "A" separates the Z and K, the K is coded.
- Names with Prefixes: If a surname has a prefix, such as Van, Con, De, Di, La, or Le, code both with and without the prefix because the surname might be listed under either code. Note, however, that Mc and Mac are not considered prefixes.For example, VanDeusen might be coded two ways:V-532 (V, 5 for N, 3 for D, 2 for S) or D-250 (D, 2 for the S, 5 for the N, 0 added).
- Consonant Separators: If a vowel (A, E, I, O, U) separates two consonants that have the same Soundex code, the consonant to the right of the vowel is coded. Example:Tymczak is coded as T-522 (T, 5 for the M, 2 for the C, Z ignored (see "Side-by-Side" rule above), 2 for the K). Since the vowel "A" separates the Z and K, the K is coded. If "H" or "W" separate two consonants that have the same Soundex code, the consonant to the right of the vowel is not coded. Example: Ashcraft is coded A-261 (A, 2 for the S, C ignored, 6 for the R, 1 for the F). It is not coded A-226.
- Names With Double Letters: If the surname has any double letters, they should be treated as one letter. For example:
Please visit the NARA Soundex Indexing page to learn more about Soundex Indexing System.
Statistics
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 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
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.
You can change the number of names displayed by configuring the view for this gramplet.
To Do
The To Do Gramplet is free form text area. You can use this area to put some notes, remarks, things you should to get your research going. There are several other To Do programs (e.g. Tomboy e.a.) but these Gramplets are useful as the information stays within the Gramps database.
To Do Gramplets allow you to create notes and attach them to Gramps objects. For example, you can add a Person To Do Gramplet to the sidebar of the Person View. Notes added using this Gramplet will be attached to the currently active person. There is a To Do Gramplet for each Gramps primary object type.
See also the experimental Third-party Addon:
- ToDo Notes Gramplet available for the Dashboard that lists all To Do notes in the database, together with the object to which they are attached.
Person To Do
See To Do
Family To Do
See To Do
Event To Do
See To Do
Place To Do
See To Do
Source To Do
See To Do
Citation To Do
See To Do
Repository To Do
See To Do
Media To Do
See To Do
Top Surnames
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.
Advanced:
- Change the number of names displayed by editing this section in
~/.gramps/gramps50/gramplets.ini
Uncollected Objects
Only shown if you are using Gramps in developer mode. |
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.
Welcome
The Welcome Gramplet gives an introductory message to new users, and some basic instructions.
The welcome message describes what Gramps is, that the program is Open Source Software and how you start a Family Tree.
This information can also be found on the start page of Gramps
What's Next
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.
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 |
Languages: |
English • Deutsch • français • македонски • Nederlands • polski • русский • shqip |
Special copyright notice: All edits to this page need to be under two different copyright licenses:
These licenses allow the Gramps project to maximally use this wiki manual as free content in future Gramps versions. If you do not agree with this dual license, then do not edit this page. You may only link to other pages within the wiki which fall only under the GFDL license via external links (using the syntax: [https://www.gramps-project.org/...]), not via internal links. |