Open main menu

Gramps β

Changes

Gramps 6.0 Wiki Manual - Gramplets

1,619 bytes added, 02:30, 26 October 2025
Quick View
=== General Usage and Configuration ===
[[File:WelcomegadgetBlurWelcomeToGramps-Gramplet-docked-in-dashboard-60.png|right|thumb|400px450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Example Gramplet Docked on Dashboard Welcome Grampletshowing controls at top]]
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.
The split pane approach reduces the need for flipping between Category Views... and that lightens the demands on the database.
[[File:DashboardCategory-gramplet-detached-and-docked-example-5060.png|right|thumb|400px450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Detached Gramplet in the Dashboard View(with docked Gramplet underneath]]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 websiteand {{man button| Close}} button on the lower right. Clicking the {{man button| X}} button in the upper right corner will re-docks a detached Gramplet. Clicking the similar {{man button| X}} 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.
[[File:Menubar-View-overview-example-60.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_6.0_Wiki_Manual_-_Keybindings#Common_keybindings|keyboard keybinding]].
[[File:Whats_nextWhats-configure_dashboardnext-41gramplet-configure-dashboard-60.png|center|thumb|400px450px|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.
== Summary of Gramplets ==
Summary of all default built-in builtin Gramplets and the view categories in which each gramplet can be used.
Independently for each Category view mode container, the Gramplets can be added or removed using the following controls:
{{-}}
===Gramplet List===
Click a Category header (twice) to sort the list and show that category's menu of available built-in builtin Gramplet choices. (The actual menu will also include installed [[6.0_Addons#Addon_List|Third-party addon]] Gramplets.)
{| class="wikitable sortable"
|-
{{-}}
====Age Stats - Quick View====
{{stub}}<!-- test and rename section -->
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.
{{-}}
=====Attributes Quick View=====
{{stub}}<!-- test and rename section -->
[[File:Atttribute-Gramplet-QuickView-example-result-50.png|right|450px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Attributes Gramplet - Quick View example result]]
=== Children ===
[[File:ChildrenChildrenGramplet-GrampletPeopleCategoryView-detached-50example-60.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Children Gramplet - detached examplewith tooltip]]
Gramplet showing the active persons childrenfrom '''all marriages'''. Children are displayed as ordered in the family record(s).  Double-click on a row to edit the selected child. Select a column title to sort temporarily until you exit Gramps.
[[Gramps_6.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 Use the [[Gramps_6.0_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Children|Children]] tab in the Family Editor to change the order of children in the active family.* The Use the third-party addon {{man label|[[Addon:BirthOrderTool|Sort Children in Birth Order Toolorder]] }} tool which allows bulk updates of the children order. See also:* This [[Gramps_6.0_Wiki_Manual_-_Gramplets#Children|Children]] gramplet in the [[Gramps_6.0_Wiki_Manual_-_Categories#People_Category|People Category]] views displays all children from '''all marriages''' for the active person. Children are displayed as ordered in the family record(s).
{{-}}
====Person Children====
See [[Gramps_6.0_Wiki_Manual_-_Gramplets#Children|Children]]
Also the <code>Spouse</code> column shows the childs spouse if presentwhich other parent the active person had the child with.(and is not the spouse of the listed child!)
{{-}}
=== Details ===
[[File:Details-Gramplet-detached-50example-60.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Details " Gramplet - detached examplewith context menu]]
Gramplet showing details and image of the active person.
Provides a brief non editable summary of the selected person for example:
* ''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_6.0_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Gallery|Edit Person Editors - Gallery tab]]
 
You can use the context menu to right click and {{man menu|Make Active Media}}
You may highlight and copy the individual text fields.
======General usage ======
Enter the term to be searched for and adjust any required options and then select the {{man button|Find}} button to see the result(s) if any.
{{stub}}<!-- add section or redirect on general usage of these filter gramplets -->
*[[Gramps_6.0_Wiki_Manual_-_Filters#Which_filters_in_which_Category.3F|Which filters (rules) in which Category?]]
*Gramps Glossary term: [[Gramps_Glossary#regex|Regular Expressions]] for pattern matching in searches
*Third -party ''Isotammi'' [[Addon:Isotammi_addons#Filter.2B|Filter+ gramplet addon]]
{{-}}
<span id="Person Filter"></span>
====People Filter====
[[File:FilterGramplet-Person-detached-default-60.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} People - "Filter Gramplet" - detached - default]]
Equivalent to the [[Gramps_6.0_Wiki_Manual_-_Filters#toc|built-in builtin Custom Filter rules]]:
*{{man label|Name}} : [[Gramps_6.0_Wiki_Manual_-_Filters#People_with_the_.3Cname.3E|People with a name matching &lt;text>]]
*{{man label|ID}} : [[Gramps_6.0_Wiki_Manual_-_Filters#People_with_.3Cid.3E|People with Id containing &lt;text>]]
{{man note|''Use of [[Gramps_6.0_Wiki_Manual_-_Filters#Regular_Expressions|regular expressions]]'' only works on '''some''' fields}}
{{-}}
<span id="Family Filter"></span>
====Families Filter====
[[File:FilterGramplet-Family-detached-default-60.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Families - "Filter Gramplet" - detached - default]]
Equivalent to the [[Gramps_6.0_Wiki_Manual_-_Filters#toc|built-in builtin Custom Filter rules]]:
* ID : [[Gramps_6.0_Wiki_Manual_-_Filters#Families_having_child_with_id_containing_.3Ctext.3E|Families with Id containing &lt;text>]]
* Father :[[Gramps_6.0_Wiki_Manual_-_Filters#Families_with_father_with_the_.3Cname.3E|Families with father matching the &lt;regex_name>]]
====Events Filter====
[[File:FilterGramplet-Event-detached-default-60.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Events - Filter Gramplet - detached - default]]
Equivalent to the [[Gramps_6.0_Wiki_Manual_-_Filters#toc|built-in builtin Custom Filter rules]]:
* ID : [[Gramps_6.0_Wiki_Manual_-_Filters#Events_with_Id_containing_.3Ctext.3E|Events with Id containing &lt;text>]]
* Description : [[Gramps_6.0_Wiki_Manual_-_Filters#Events_matching_parameters|Events matching parameters]]
====Places Filter====
[[File:FilterGramplet-Place-detached-default-60.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Places - Filter Gramplet - detached - default]]
Equivalent to the [[Gramps_6.0_Wiki_Manual_-_Filters#toc|built-in builtin Custom Filter rules]]:
* ID : [[Gramps_6.0_Wiki_Manual_-_Filters#Places_with_Id_containing_.3Ctext.3E|Places with Id containing &lt;text>]]
* Name : [[Gramps_6.0_Wiki_Manual_-_Filters#Places_matching_parameters|Places matching parameters]]
====Sources Filter====
[[File:FilterGramplet-Source-detached-default-60.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Sources - Filter Gramplet - detached - default]]
Equivalent to the [[Gramps_6.0_Wiki_Manual_-_Filters#toc|built-in builtin Custom Filter rules]]:
* ID : [[Gramps_6.0_Wiki_Manual_-_Filters#Sources_with_Id_containing_.3Ctext.3E|Sources with Id containing &lt;text>]]
* Title : [[Gramps_6.0_Wiki_Manual_-_Filters#Sources_matching_parameters|Sources matching parameters]]<!--[[Gramps_6.0_Wiki_Manual_-_Filters#Sources_with_title_containing_.3Ctext.3E|Sources with title containing &lt;text>]]-->
====Citations Filter====
[[File:FilterGramplet-Citation-detached-default-60.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Citations - Filter Gramplet - detached - default]]
Equivalent to the [[Gramps_6.0_Wiki_Manual_-_Filters#toc|built-in builtin Custom Filter rules]]:
'''Source:'''
====Repositories Filter====
[[File:FilterGramplet-Repository-detached-default-60.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Repositories - "Filter Gramplet" - detached - default]]
Equivalent to the [[Gramps_6.0_Wiki_Manual_-_Filters#toc|built-in builtin Custom Filter rules]]:
* ID : [[Gramps_6.0_Wiki_Manual_-_Filters#Repositories_with_Id_containing_.3Ctext.3E|Repositories with Id containing &lt;text>]]
* Name : [[Gramps_6.0_Wiki_Manual_-_Filters#Repositories_matching_parameters|Repositories matching parameters]]
====Media Filter====
[[File:FilterGramplet-Media-detached-default-60.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Media - Filter Gramplet - detached - default]]
Equivalent to the [[Gramps_6.0_Wiki_Manual_-_Filters#toc|built-in builtin Custom Filter rules]]:
* ID : [[Gramps_6.0_Wiki_Manual_-_Filters#Media_objects_with_Id_containing_.3Ctext.3E|Media objects with Id containing &lt;text>]]
* Title : [[Gramps_6.0_Wiki_Manual_-_Filters#Media_objects_matching_parameters|Media objects matching parameters]]
====Notes Filter====
[[File:FilterGramplet-Notes-detached-default-60.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Notes - Filter Gramplet - detached - default]]
Equivalent to the [[Gramps_6.0_Wiki_Manual_-_Filters#toc|built-in builtin Custom Filter rules]]:
* ID : [[Gramps_6.0_Wiki_Manual_-_Filters#Notes_with_Id_containing_.3Ctext.3E|Notes with Id containing &lt;text>]]
* Text : [[Gramps_6.0_Wiki_Manual_-_Filters#Notes_matching_parameters|Notes matching parameters]]
The {{man label|Given Name Cloud}} Gramplet shows the top most popular given names in your family tree. The font 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 [[Gramps_6.0_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Preferred_Name_section|preferred given names ]] into words (broken up by spaces)unless a connector (such as a hyphen or non-breaking space) has been specified to bridge between the names to create a compound name. 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.
* [[#Surname_Cloud|Surname Cloud Gramplet]]
====Given Name Cloud Quick View====
{{stub}}<!-- test and rename section -->
=== Image Metadata ===
[[File:ImageMetadata-Gramplet-detached-50example-60.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} "Image Metadata " Gramplet - example]]<!-- to recreate use data from example.gramps "Gunnlaugur_Larusson_-_Yawn.jpg" photo ID: O0009 -->
The {{man label|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]]
[[File:QuickView-Gramplet-detached-50.png|thumb|right|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Quick View Gramplet - detached example]]
The {{man label|Quick View }} Gramplet allows the selected [[Gramps_6.0_Wiki_Manual_-_Reports_-_part_8#Quick_Views|Quick View report]] to be updated dynamically as active records are changed. Instead of a window with a static report, the gramplet updates as different active records are selected within the target Category. (When this Gramplet was introduced, it only offered choosing Quick View Reports from the People category. A Configuration pop-up menu to select View categories has since been added.)
You can run any of the builtin [[Gramps_6.0_Wiki_Manual_-_Reports_-_part_8#Quick_Views|Quick Views]] or [[6.0_Addons#Addon_List|addon]] QuickView reports.
You may copy the text from inside of this Gramplet by selecting it and pasting into an empty document.
{{-}}
====&#x2699; Configurable Options====
[[File:WhatsNext-Gramplet-Configuration-tab-50.png|right|thumb|450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} What's Next? Gramplet - Configuration tab shown]]
15,091
edits