15,534
edits
Changes
remove {{out of date}} template
{{languages|Gramps_4.0_Wiki_Manual_-_Gramplets}}
{{#vardefine:chapter|910}}
{{#vardefine:figure|0}}
This page details the functionality of the Gramplets. If you would like to read more technical details about writing your own Gramplet, please see [[Gramplets]]. For more Gramplets that you can extend your Gramps functionality with, see [[Third-party Plugins]].
= What is a Gramplet =
[[Image:GrampletsDefault-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Gramplets Dashboard Category (Default View)]]
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 [http://en.wikipedia.org/wiki/Widget_engine widgets] that are part of Gramps and can be seen in the [[Gramps_4.0_Wiki_Manual_-_Main_Window_Categories#Gramplets_CategoryDashboard_Category|Gramplets Dashboard Category]], [[#Sidebar_and_bottombarGramplets_available_in_the_Sidebar_and_bottombar_of_other_Categories|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?
{{-}}
== General Usage and Configuration == [[Image:GrampletDetached-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Detached Gramplets View]] 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 (relationship, ancestry, 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 you first start one or more Gramplets are undocked from the Gramplets Category Dashboard View, you will see two default Gramplets; the '''Welcome can change to Gramps a different view (Messagesuch as the People or Charts Views) Gramplet''' . In this way, you can use these gramplets to supplement a particular view with additional details and functionality provided by the '''Top Surnames Gramplet'''gramplet.
[[Image:Default.gramplets.gramps.bar.relationships.and.charts.views.png|thumb|left|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Default gramplets available from the Gramps bar (side & bottom) Sidebar and Bottombar on the Relationships View Category and Charts ViewsCategory]][[Image:Default-gramplets.png|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Default gramplets available on Gramplets ViewDashboard Category]]
These are 18 26 default gramplets:
# Age Stats Gramplet - see view age span graphs
# Age on Date Gramplet - see the people alive and their ages on a particular date
# Attributes Gramplets - see active person's attributes
# Birthdays Gramplet
# Calendar Gramplet - see people's events on a particular date, or in a month in the past
# Census Gramplet
# Clipboard Gramplet
# Deep Connections Gramplet - relationships
# Descendant Count Gramplet
# Descendants Gramplet - see the active person's descendants
# Fan Chart Gramplet - see the active person's pedigree, in a circular fan chart
# Given Name Cloud Gramplet - most popular given namesas a "text cloud"# Import Gramplet# Latest Changes Gramplet# Pedigree Gramplet - see a complete pedigree in compressed texttex
# Quick View - run a Quick View on the current person
# Records Gramplet - see world's records of your data
# Related relatives Gramplet - see partners being relatives
# Relatives Gramplet - see the relatives of the active person
# Session Log Gramplet - keep track of what you have done, and what records you have vistedvisited
# Statistics Gramplet - see stats on the database
# Surname Cloud Gramplet - most popular surnames as a "text cloud"
# Welcome Gramplet - a Gramps welcome message
# What's Next Gramplet - what needs to be done next
Here you can see the other gramplets currently available:
*Clock Gramplet - a nice example of grafical gramplet
*Data Entry Gramplet - edit active person's name, birth date and place, death date and place, and add people
*Note Gramplet - see and edit active person's primary Person Note
*Python Gramplet - a Python shell
=Gramplets available in the Gramplets Dashboard Category=
{{-}}
[[Image:AgeOnDate-detached-gramplet-40.png|left|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Age On Date Gramplet]]
[[Image:AgeOnReportAgeOnDate-QV-ResultExample-gramplet-40.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Age On Date Quick Report]]
This Gramplet gives you the possibility of entering a date in an entry field. If you click {{man button|Run}} the Gramplet will compute the ages for everyone in your Family Tree living on that Date. The date must be entered in a format that Gramps accepts.
You can then sort the Quick Report by the age column, Name and double-click Age columns. Right clicking the row to view or editopens a context menu for opening Person Editor and activating the person.
{{-}}
[[Image:AgeStats-detached-gramplet-40.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Age Stats Gramplet]]
The Age Stats gramplet shows graphs of the breakdown of particular 5 years age spans, of three stats: all people, difference between father and child and difference between mother and child. Clicking on a row will bring up the associated peoplein Quick Report. Double clicking a row in a stats opens a Quick Report of all people contained in the row. You can sort the Quick Report by the Name, Birth Date and Name Type columns. Right clicking the row opens a context menu for opening Person Editor and activating the person.
You can change the gramplet's options by selecting from toolbar the ''configure active view'' button.
== Calendar Gramplet ==
[[Image:CalendargadgetCalendar-detached-gramplet-40.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Calendar]]
The Calendar gramplet shows a monthly calendar. Double-click a day to run the {{man label|On This Day}} Quick View.
== Records Gramplet ==
[[Image:RecordsGrampletRecords-detached-gramplet-40.png|right|thumb|350px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Records Gramplet]]
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.
{{-}}
== TODO To Do Gramplet ==[[Image:TODOListToDoList-detachedsidebar-gramplet-40.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} TODO To Do Gramplet]]
{{-}}
== What's Next Gramplet ==
[[Image:WhatIsNext-detached-gramplet-40.png|right|thumb|350px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} What's Next Gramplet]]
{{-}}
=Gramplets available in the Sidebar and bottombar of other Categories =
Since Gramps 4.0 we have common and specific gramplets according active view (navigation/category).
== People Category ==
=== Attributes Gramplet ===
[[Image:AttributesGrampletAttributes-detached-gramplet-40.png|left|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Attributes Gramplet]]
[[Image:AttributesQV.png|right|350px|thumb|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Attributes Quick View]]
=== Descendant Gramplet ===
[[Image:DescendantGrampletDescendant-detached-gramplet-40.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Descendant Gramplet]]
The Descendant gramplet shows the direct descendants of the active person.
=== Person details ===
=== Fan Chart Gramplet ===
[[Image:FanChartGrampletFanChart-detached-gramplet-40.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Fan Chart Gramplet]]
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.
=== Pedigree Gramplet ===
[[Image:PedigreeGrampletPedigree-detached-gramplet-40.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Pedigree 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, double-clicked (or right-click) to edit the person. This Gramplet also shows at the bottom of the gramplet the number of people per generation. Double-click the Generation number to see the matching individuals.
=== Relatives Gramplet ===
[[Image:RelativesGrampletRelatives-detached-gramplet-40.png|right|thumb|350px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Relatives Gramplet]]
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 Gramps database. 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".
== Places Category ==
== Media Category ==
=== Image Metadata Gramplet ===
[[Image:Image_Metadata_GrampletImageMetadata-detached-gramplet-40.png|thumb|right|250px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Image Metadata Gramplet]]
The Image Metadata Gramplet offers an easy interface to add, edit, and remove Image Exif Metadata from your images (*.jpg, *.png. *.tiff, *.exv, *.nef, *.psd, *.pgf).