Open main menu

Gramps β

Changes

Gramps 5.2 Wiki Manual - Gramplets

1,211 bytes added, 23:10, 23 March 2025
m
Protected "Gramps 5.2 Wiki Manual - Gramplets": gramps 6.0 released ([Edit=Allow only administrators] (indefinite) [Move=Allow only administrators] (indefinite))
*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.
{{Stub}}
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.
{{-}}
{{stub}}<!--WIP - need to check from here on eg sort if need into order-->
=== 2-Way Fan Chart ===
[[File:2-WayFanChart-detached-gramplet-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 2-Way Fan Gramplet]]
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.
'''See also:'''
{{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.
{{stub}}
{{-}}
====Person Details====
=== Filter ===
{{stub}}
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?]]
[[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...
{{stub}}<!--update for gexiv2-->
Pyexiv2 can be used from the command line interface (cli) as well, and from within a python script:
# import the pyexiv2 library
==== 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
{{-}}
Gramplet showing residence events for the active person
{{stub}}
{{-}}
====Person Residence====
{{stub}}
See [[Gramps_5.2_Wiki_Manual_-_Gramplets#Residence|Residence]]
{{-}}