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

== What is a Gramplet? ==

<span id="definition">

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

Gramplets are the division of plug-ins (also called [http://wikipedia.org/wiki/Widget_engine widgets], plugins, addons, auxiliary components) that can be found in the '''[[Gramps_5.2_Wiki_Manual_-_Categories#Dashboard_Category|Dashboard Category]]''' ... or the '''[[#The_split-screen_Sidebar_.26_Bottombar|Sidebars]]''' and '''[[#The_split-screen_Sidebar_.26_Bottombar|Bottombars]]''' in other Navigator [[Gramps_Glossary#view|View Categories]]. They provide all kinds of functionality that can be useful for the researcher.

{{Man warn|Performance Drain|<i>'''Gramplets can 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 to a Gramplet Bar or the Dashboard as needed.}}

When you first start the [[Gramps_5.2_Wiki_Manual_-_Categories#Dashboard_Category|Dashboard Category]] you will see two default Gramplets; the '''{{man label|[[Gramps_5.2_Wiki_Manual_-_Gramplets#Welcome_Gramplet|Welcome to Gramps!]]}}''' Gramplet and the '''{{man label|[[Gramps_5.2_Wiki_Manual_-_Gramplets#Top_Surnames_Gramplet|Top Surnames Gramplet]]}}'''.

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.

===== &#x2699; Configurable Options =====

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.2_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]]

==== The split-screen Sidebar &amp; Bottombar ====

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

[[File:ToolbarIcon-OpenTheToolsDialog-50.png]]

{{man note|Want Additional Gramplets|To add more Gramplets follow the instructions on [[5.2_Addons|'''Third-Party Addons''']]. Check the list of the available reports [[5.2_Addons#Addon_List|'''here''']].}}

{{-}}

===Gramplet List===

{| class="wikitable sortable"

|-

This following sections describe each Gramplet and its basic functionality.

{{-}}

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

{{fan_charts}}

{{-}}

=== Age on Date ===

=== Calendar ===

The '''Calendar Gramplet''' shows a monthly calendar.

You may highlight and copy the individual text fields.

{{-}}

====Person Details====

=== Filter ===

Gramplet providing a filter specific to the Category.

*[[Gramps_5.2_Wiki_Manual_-_Gramplets#Filter|Filter]] gramplets

*Isotammi [[Addon:Isotammi_addons#Filter.2B|Filter+ gramplet addon]]

{{-}}

<span id="Person Filter"></span>

====People Filter====

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

{{-}}

====Geography Filter====

{{-}}

<span id="Source Filter"></span>

====Sources Filter====

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

Equivalent to the [[Gramps_5.2_Wiki_Manual_-_Filters#toc|built-in Custom Filter rules]]:

* ID : [[Gramps_5.2_Wiki_Manual_-_Filters#Repositories_with_Id_containing_.3Ctext.3E|Repositories with Id containing &lt;text>]]

* Type : <small>''Repositories matching parameters''</small>

* Address : <small>''Repositories matching parameters''</small>

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

{{-}}

====Person Gallery====

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

* Line Type menu: <abbr title="Unicode Transformation Format graphical symbols">UTF</abbr>, <abbr title="American Standard Code for Information Interchange text symbols">ASCII</abbr>; (default: ''UTF'')

=== Python Evaluation ===

{{man warn|Warning! Diagnostic Tool|Do not use this '''Debug''' feature on your working Family Tree. Always create a new empty Family Tree or a copy of your existing Family Tree for testing.<br />This option is only available when Gramps has been started using a developer [[Gramps_5.2_Wiki_Manual_-_Command_Line#Python_options|mode switch]]. It is not intended for general use and has limited safeguards.}}

==== See Also ====

* Debug submenu in the [[Gramps_5.2_Wiki_Manual_-_Navigation#Tools|Tools]] menu before version 4.0.2

* [[Contact#Mailing_lists|Gramps-devel]] maillist: [https://sourceforge.net/p/gramps/mailman/gramps-devel/thread/524D973D.9000604%40hotmail.com/#msg31477962 Converting tools to gramplets] - Oct 2013

{{-}}

=== Quick View ===

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

{{-}}

You can 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.

Gramplet showing residence events for the active person

{{-}}

====Person Residence====

See [[Gramps_5.2_Wiki_Manual_-_Gramplets#Residence|Residence]]

{{-}}

=== Statistics ===

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

**Males

**Females

**Individuals with unknown gender

**Incomplete names

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.

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 ===

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

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.

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.

{{-}}

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

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:

{{-}}

[[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 Home Person defines the focus

* You want to know at least the mother of each family with unmarried parents

* The closer the relationship to the Home Person, the more "urgent" the information gap is.