16,736
edits
Changes
m
{{Stub}}
{{stub}}<!--WIP - need to check from here on eg sort if need into order-->
'''See also:'''
{{stub}}
{{stub}}
{{stub}}<!--update for gexiv2-->
{{stub}}
{{stub}}
Protected "Gramps 5.2 Wiki Manual - Gramplets": gramps 6.0 released ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))
This page details the functionality of the Gramplets that come with Gramps.
{{man note|For more Gramplets|that you can extend your Gramps functionality with, see [[Third-party Addons]].<br>For technical details about creating your own Gramplet, please see [[GrampletsGramplets_development|Gramplets for Developers]].}}
== What is a Gramplet? ==
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.
A [[Gramps_5.2_Wiki_Manual_-_Gramplets#Gramplet_List|selection of built-in plugins]] are bundled and pre-installed with Gramps. The Gramps project hosts a [[5.2_Addons#Addon_List|selection of add-on addon plugins]] that might only be of interest to certain audiences.
There are also third-parties, such as The Taapeli Project in Finland, who hosts their own selection of [[Addon:Isotammi_addons|Isotammi group add-on addon plug-ins]] developed to tune Gramps for their needs. Members of the Gramps community also share special purpose addons privately or via GitHub repositories. And, of course, users are [[Addons_development#Develop_your_addon|invited to develop their own addons]].</span>
{{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.}}
*Specific Gramplets need the context of particular Views to give context to their perspective of the data. The list in the Dashboard's Add a Gramplet submenu and the {{man button|∨}} Gramplet Bar Menu will differ according active Category view and Gramplets installed.
This list is leftover from an earlier revision of the wiki. It is unclear where the items fit in this discussion.
* Back references Gramplets - provide immediate visibility to data that tends be viewed occasionally and is buried in the interface... like the {{man label|references}} tab on object Editor.
===== ⚙ Configurable Options =====
[[File:Menubar-View-overview-example-5052.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...}} button, choose {{Man menu|View ➡ 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 & Bottombar ====
[[File:Bottombar-sidebar-drop-down-menu-5052.png|450px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramplet split-screens showing [[Gramps_5.2_Wiki_Manual_-_Main_Window#Gramplet_Bar_Menu|Gramplet Bar Menu]] with the unlabeled ''Down Arrowhead'' {{man button|∨}} pull-down menu button]]
Each of these split screen panes is a container of stacked Gramplet tabs. Like Windows with a tabbed section, each can show only a single tab at a time. But tabs can be added, re-ordered, undocked or disabled in a similar fashion to the Dashboard. However, instead of a Contextual Menu, each split-pane {{man menu|[[Gramps_5.2_Wiki_Manual_-_Main_Window#Gramplet_Bar_Menu|Gramplet Bar Menu]]}} has a ''Down Arrowhead'' {{man button|∨}} pull-down menu button to show the same pop-up list of options.
[[File:ToolbarIcon-OpenTheToolsDialog-50.png]]
-->[[File:Menubar-View-overview-example-5052.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} View menu]]
{{man note|Want Additional Gramplets|To add more Gramplets follow the instructions on [[5.2_Addons|'''Third-Party Addons''']]. Check the list of the available reports [[5.2_Addons#Addon_List|'''here''']].}}
{{-}}
===Gramplet List===
Click a Category header (twice) to sort the list and show that category's menu of available built-in Gramplet choices. (The actual menu will also include installed [[5.2_Addons#Addon_List|3rdThird-party addon]] Gramplets.)
{| 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]]
Chart consisting of both ascendants and descendants.
The '''2-Way Fan View''' view interactively displays the active person's ancestors and descendants in a pie chart format. The Descendant Fan provides a comprehensive and visually appealing way to explore and analyze an individual's descendants within your family tree.
{{fan_charts}}
{{-}}
=== Age on Date ===
=== Calendar ===
[[File:Calendar-Gramplet-detached-5052.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Calendar Gramplet - detached example]]
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.
======See Also ======*Gramps Glossary term: [[Gramps_Glossary#regex|Regular Expressions]] for pattern matching in searches
*[[Gramps_5.2_Wiki_Manual_-_Gramplets#Filter|Filter]] gramplets
*[[Gramps_5.2_Wiki_Manual_-_Filters#Which_filters_in_which_Category.3F|Which filters (rules) in which Category?]]
*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]]
[[File:Gallery-Gramplet-detached-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gallery Gramplet - detached example]]
Gramplet showing media objects. The first image is the primary active media object that is used in reports and the {{man label|[[Gramps_5.2_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Edit_Person_dialog|Edit Person dialog]]}}. You can use the context menu to right click and {{stubman menu|Make Active Media}}(Bug reported {{bug|10359}}<!-- does not seem to do anything? https://github.com/gramps-project/gramps/blob/8ca2326523ca3093c3a07c0182804f2ad8c5cb00/gramps/gui/widgets/photo.py#L92https://github.com/gramps-project/gramps/blob/8ca2326523ca3093c3a07c0182804f2ad8c5cb00/gramps/gui/editors/displaytabs/gallerytab.py#L169-->) Double-click on the picture to view it in the default image viewer application.
See also :* To change the primary media object for reports etc... use the {{man label|[[Gramps_5.2_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#GalleryEdit_Person_dialog|GalleryEdit Person dialog]] tab for {{man label|}}s [[Gramps_5.2_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Edit_Person_dialogGallery|Edit Person dialogGallery]] }}where you can change which image is the primary active media object for reports etc..tab.
{{-}}
====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
=== 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.}}
[[File:PythonEvaluation-Gramplet-detached-example-52.png|right|thumb|450px301px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Python Evaluation Gramplet - detached example]]The {{man label|Python Evaluation}} Gramplet window tool is intended to test Python scripts with Gramps data. Sample code for listing Gramps internal "[https://github.com/gramps-project/gramps/blob/master/gramps/gen/const.py constants]": <pre>import osimport sysfrom gramps.gen.const import * # Get all uppercase variables from the current namespaceENV = { name: value for name, value in locals().items() if name.isupper() and not name.startswith('_') and isinstance(value, str)} # Print each item in the dictionary, indicating if it's a hidden directoryfor key, value in ENV.items(): try: if os.path.isdir(value): if sys.platform.startswith('win'): import ctypes attrs = ctypes.windll.kernel32.GetFileAttributesW(value) hidden_status = "HIDDEN" if attrs != -1 and bool(attrs & 2) else "NOT HIDDEN" else: hidden_status = "HIDDEN" if os.path.basename(value).startswith('.') else "NOT HIDDEN" print(f"({hidden_status}) {key} : {value}") else: print(f"{key} : {value} (NOT A DIRECTORY)") except Exception as e: print(f"{key} : {value} (ERROR : {str(e)})")</pre>
==== See Also ====
* [[Addon:Python_Shell_Gramplet|Python Shell]] addon gramplet. Where possible, use the '''Python Shell''' instead of '''Python Eval'''. It has extra garbage collection functionality
* 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
* Where possible, use the Discourse -- Sample scripts:** [https://gramps.discourse.group/t/need-some-json-parsing-tools/6855/7 sample script to Parse selected JSON to CSV]** [Addonhttps:Python_Shell_Gramplet|Python Shell]//gramps.discourse.group/t/troubleshooting-gramps-paths-and-environmental-variables/5692 troubleshooting Gramps paths and environmental variables] addon gramplet instead. It has extra garbage collection functionality
{{-}}
=== Quick View ===
[[File:QuickView-Gramplet-detached-50.png|thumb|right|350px312px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Quick View Gramplet - detached example]]
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 run any of the built-in [[Gramps_5.2_Wiki_Manual_-_Reports_-_part_8#Quick_Views|Quick Views]] or [[5.2_Addons#Addon_List|add-onaddon]] QuickView reports.
{{-}}
[[File:QuickView-Gramplet-Configuration-tab-50.png|thumb|right|350px318px|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.
Gramplet showing residence events for the active person
{{-}}
====Person Residence====
See [[Gramps_5.2_Wiki_Manual_-_Gramplets#Residence|Residence]]
{{-}}
[[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 Home Person defines the focus
* Searches for gaps begin . The search begins with the Home Person's descendants and work works up the tree * The tree record for each person is expected to contain : the given name, surname, birth (with date and place), and death (with date and place of each person)* You want to know parents, their marriage (with date and place), and - if divorced - divorce date and place of each family with married parents
* You want to know at least the mother of each family with unmarried parents
* The closer the relationship to the Home Person, the more "urgent" the information gap is.