Changes

Jump to: navigation, search

Gramps 4.0 Wiki Manual - Gramplets

2,541 bytes added, 03:41, 16 October 2014
remove {{out of date}} template
{{languages|Gramps_4.0_Wiki_Manual_-_Gramplets}}
 
{{#vardefine:chapter|10}}
{{#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]].
= Gramplets What is a Gramplet =[[Image:GrampletsDefault-40.png|right|thumb|400px|Fig. 7.1 Gramplets 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[[Image:GrampletsDefault-40. What is the difference between gramplets, reports, quick views, and tools?png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 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_-_Categories#Dashboard_Category|Dashboard Category]], [[#Gramplets_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?
*Reports provide a static output format of your data, typically for presentation
*Quick View provides a typically short, interactive listing derived from your data
*Gramplets provide a dynamic view and interface to your 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#Gramplets View|Gramplet View]] and [[#Sidebar_and_bottombar|Sidebars, Bottombars]]. The [http://en.wikipedia.org/wiki/Widget_engine widgets] provide all kind of functionality that can be useful for the researcher. }}
When you first start the Gramplets View you will see two default Gramplets; the '''Welcome Message Gramplet''' == General Usage and the '''Top Surnames Gramplet'''.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 one or more Gramplets are undocked from the Dashboard View, you can change to a different view (such as the People or Charts Views). In this way, you can use these gramplets to supplement a particular view with additional details and functionality provided by the gramplet. You can add new gramplets by right clicking on an open space on Dashboard view.
[[Image:Detached.png|right|400px|Fig. 7You can also change the number of columns by changing a setting in ''configure the active view'' to open the ''Configure Gramplets'' window, to change the Dashboard Layouts > Number of Columns.2 Detached Gramplets View]]
You can drag the Properties button (top left) of each If a link in a Gramplet is to move it around a specific person, then clicking the link will change the Gramplet View areaActive Person. You can click the Properties button Double-clicking such any link to detach the Gramplet from Gramplet View and place it in its own window. The window will stay open regardless of page a specific Gramps item (relationship, ancestry, etcsuch as person or family). Closing the detached view will put it back onto bring up the Gramplets viewEditor for that item. If you quit Gramps with To edit a open grampletlinked person without changing the Active Person, when you start gramps againright-click on the person link. Depending on the type of entry, it double-clicking any row in a Quick View table will open automaticallyeither select more specific data (drill down) or bring up the editor.
When one or more Gramplets are undocked from Double-clicking the Gramplet View, you can change to title of a different view (such as gramplet docked in the People or Ancestry Views). In this way, Dashboard Category allows you can use these gramplets to supplement a particular view with additional details and functionality provided by change the grampletdisplay title.
{{man note|Want Additional Gramplets|To get more Gramplets use the [[Gramps_4.0_Wiki_Manual_-_Plugin_Manager|'''Plugin Manager''']] to get additional [[4.0_Addons|'''Addons''']] for you. Check the list of the available reports [[4.0_Addons|'''here''']].}}
You can add new == Summary of gramplets by right clicking on an open space on Gramplets. You can also change the number of columns by right-clicking an open area on the Gramplets page.==
{{out of date|need to check number of gramplets in gramps 4.0}}
[[FileImage: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]][[FileImage: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
 
{{man note|Additional Gramplets |Starting with Gramps version 3.2 a new system was implemented to have even more Gramplets available. This system is controlled by the [[Gramps_4.0_Wiki_Manual_-_Plugin_Manager|'''Plugin Manager''']]. The Plugin Manager can get additional [[4.0_Addons|'''Addons''']] for you. Check the list of the available reports [[4.0_Addons|'''here''']].}}
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
If a link in a Gramplet is to a specific person, then clicking the link will change the Active Person. Double-clicking such any link to a specific Gramps item (such as person or family) will bring up the Editor for that item. To edit a linked person without changing the Active Person, right-click on the person link. Depending on the type of entry, double{{-clicking any row }} =Gramplets available in a Quick View table will either select more specific data (drill down) or bring up the editor.Dashboard Category=
This section When you first start the Dashboard Category you will describe each gramplet see two default Gramplets; the '''Welcome to Gramps (Message) Gramplet''' and its basic functionalitythe '''Top Surnames Gramplet'''.
{{man note|Changing settings|You can change This section describes each gramplet available from the settings of the Gramplets by editing your '''~/[[Gramps_4.gramps/gramplets.ini''' file. But you can only do that when GRAMPS is not running. Just bring up the ''gramplets.ini'' file in a text editor 0_Wiki_Manual_-_Categories#Dashboard_Category|Dashboard Category]] and make the desired changes. You can change the title of the Gramplet by changing the section name (surrounded by square brackets). These options will be able to be changed via the Gramplet View in the next version of GRAMPSits basic functionality. If you have an idea for additional Gramplets, please let us know!}}
{{-}}
== Age on Date Gramplet ==
[[Image:AgeOnDateGrampletAgeOnDate-detached-gramplet-40.png|left|thumb|350px|Fig. 7{{#var:chapter}}.3 {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Age On Date Gramplet]][[Image:AgeOnReportAgeOnDate-QV-ResultExample-gramplet-40.png|right|thumb|350px|Fig. 7{{#var:chapter}}.3a {{#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.
{{-}}
== Age Stats Gramplet ==
[[Image:AgeStatsGrampletAgeStats-detached-gramplet-40.png|right|thumb|350px400px|Fig. 7{{#var:chapter}}.4 Age Stats Gramplet]][[Image{{#vardefineecho:AgeStatsGrampletOptions.pngfigure|left|thumb|350px|Fig.7.5 {{#expr:{{#var:figure}}+1}}}} Age Stats Gramplet showing options]]
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.
You can change the [[Image:ToolbarConfigureTheView-AgeStats-Options-gramplet's options by detaching, and selection the options drop-down area, and pressing 40.png|left|thumb|250px|Fig. {{#var:chapter}}.{{man button#vardefineecho:figure|Save{{#expr:{{#var:figure}}.+1}}}} Age Stats Gramplet showing options]]
{{-}}
== Calendar Gramplet ==
[[Image:CalendargadgetCalendar-detached-gramplet-40.png|right|thumb|350px|Fig. 7{{#var:chapter}}.8 {{#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.
== Given Name Cloud Gramplet ==
[[Image:GivenNameCloudGrampletGivenNameCloud-detached-gramplet-40.png|thumb|right|350px|Fig. 7{{#var:chapter}}.11 {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Given Name Cloud Gramplet]]
Like the [[#Surname Cloud Gramplet|Surname Cloud Gramplet]], the Given Name Cloud gramplet shows the top most popular given names in your family tree. The 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.
== Quick View Gramplet ==
{{out of date|update image}}
[[Image:QuickviewgrampletQuickView-RelationToHomePersonQV-detached-gramplet-40.png|thumb|right|350px|Fig. 7{{#var:chapter}}.13 {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Quick View Gramplet]]
The Quick View gramplet allows you to run a Quick View, it updates as you move from person to person. (Currently, only People Quick Views can be run).
== Records Gramplet ==
[[Image:RecordsGrampletRecords-detached-gramplet-40.png|right|thumb|350px|Fig 7{{#var:chapter}}.14 {{#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.
== Session Log Gramplet ==
[[Image:LoggadgetSessionLog-detached-gramplet-40.png|thumb|right|350px|Fig. 7{{#var:chapter}}.16 {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Session Log Gramplet]]
The session log keeps track of activity in this session. It lists selected and edited objects.
== Statistics Gramplet ==
{{out of date|replace image}}[[Image:StatgadgetStatistics-detached-gramplet-40.png|right|thumb|350px|Fig. 7{{#var:chapter}}.17 {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Statistics Gramplet]]
The Statistics gramplet runs a Statistics report. Double-click the phrases to bring up the matching items.
== Surname Cloud Gramplet ==
[[Image:SurnamecloudSurnameCloud-detached-gramplet-40.png|thumb|right|350px|Fig. 7{{#var:chapter}}.18 {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Surname Cloud]]
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.
Change the number of names displayed by editing this section in ~/.gramps/gramps34gramps40/gramplets.ini
{{-}}
== TODO To Do Gramplet ==[[Image:TodogadgetToDoList-sidebar-gramplet-40.png|right|thumb|350px|Fig. 7.19 TODO Gramplet]] The TODO gramplet is free form text area. You can use this area to put some notes, remarks, things you should to get your research going. There are several other TODO programs (e.g. Tomboy e.a.) but this Gramplet is useful as the information stays within Gramps.  (In future versions, you will be able to save links to Gramps items (like people, events, and families. This will allow you to keep a group of links that you are working on together{{#var:chapter}}. {{bug#vardefineecho:figure|???{{#expr:{{#var:figure}})+1}}}} To Do Gramplet]]
The A To Do Gramplet is free form text is persistent between sessionsarea. The data is saved You can use this area to disk when put some notes, remarks, things you exit 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 Grampsdatabase.
You To Do Gramplets allow you to create notes and attach them to Gramps objects. For example, you can open more TODO lists add a Person To Do Gramplet to save different kinds the sidebar of topics or organize your infothe Person View. Notes added using this Gramplet will be attached to the currently active person. There is a To Do Gramplet for each Gramps primary object type.
Change There is also To Do gramplet available for the title of Dashboard that lists all To Do notes in the gramplet by editing database, together with the section name in ~/.gramps/gramps34/grampletsobject to which they are attached.ini
{{-}}
== Top Surnames Gramplet ==
[[Image:TopgadgetTopSurnames-detached-gramplet-40.png|thumb|right|350px|Fig. 7{{#var:chapter}}.20 {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Top 10 Surnames]]
The top surnames gramplet shows the top 10 (by default) used surnames.
== Welcome Gramplet ==
[[Image:WelcomegadgetWelcome-ToGramps-detached-gramplet-40.png|thumb|right|350px|Fig. 7{{#var:chapter}}.21 {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Welcome Gramplet]]
The welcome gramplet gives an introductory message to new users, and some basic instructions.
The welcome message describes what Gramps is, that the program is Open Source Software and how you start a [[Gramps_4.0_Wiki_Manual_-_Manage_Family_Trees|Family Tree]].
This information can also be found on the [[Main_PageMain_page|start page of Gramps]]
{{-}}
== What's Next Gramplet ==
{{out of date|mention tags can be used to ignore items}}
 [[Image:WhatsNextGrampletWhatIsNext-detached-gramplet-40.png|right|thumb|350px|Fig 7{{#var:chapter}}.22 {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} What's Next Gramplet]]
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:
{{-}}
= Gramplets available in the Sidebar and bottombar of other Categories
{{out of date|needs more info, may need to move around in article & mention how different from gramplet area?}}
Since Gramps 4.0 we have common and specific gramplets according active view (navigation/category).
* Children gramplet on Person views (also ancestry category and relations), family view
= Person =People Category ==  
=== Attributes Gramplet ===
[[Image:AttributesGrampletAttributes-detached-gramplet-40.png|left|thumb|350px|Fig. 7{{#var:chapter}}.6 {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Attributes Gramplet]]
[[Image:AttributesQV.png|right|350px|thumb|Fig. 7{{#var:chapter}}.7 {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Attributes Quick View]]
{{-}}
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.
{{-}}
=== Descendant Gramplet ===
[[Image:DescendantGrampletDescendant-detached-gramplet-40.png|thumb|right|350px|Fig. 7{{#var:chapter}}.9 {{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Descendant Gramplet]]
The Descendant gramplet shows the direct descendants of the active person.
{{-}}
=== Person details =={{out of date|empty section?}}=
== Fan Chart Gramplet ==
=== Fan Chart Gramplet === [[Image:FanChartGrampletFanChart-detached-gramplet-40.png|thumb|right|350px|Fig. 7{{#var:chapter}}.10 {{#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. 7{{#var:chapter}}.12 {{#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 7{{#var:chapter}}.15 {{#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".
{{-}}
= Place == Place details Places Category ==
= Media Object =
== Preview ==
Since Gramps 3.3 the preview moved to a gramplet.== 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).
:image.write() # write the Metadata
====Usage scenario====
My perferred way to use this addon is:
# Select an image from the left hand MediaView
====The interface=========Data Fields=====
;Photographer:
:Type in something about the image, the people in it or the location of the image. Non-latin characters are NOT allowed. ASCII characters only...
=====Buttons=====
#Save

Navigation menu