4,599
edits
Changes
m
== Summary of built-in Gramplets ==Summary of all 36 default builtin built-in Gramplets and the view categories they in which each gramplet can be used in.
Depending on the Independently for each Category view mode container, the Gramplets can be added or removedusing the following controls:* Via In the Dashboard Category, via the right -click context menu on the Dashboard Category.* In all other Categories , via the dropdown menudrop-down Gramplet selection menus {{man button|∨}} (''Down Arrowhead''s button) on either of the Bottombar or Sidebar.
{{man menu|No ''There are no Menu option options to add a Gramplet . This is available.}}<!-- Need feature request should appear under Menu > Edit > [Add a because it would be ambiguous whether the Gramplet was to be added to that view mode's sidebar / Add a Gramplet to or bottombar] --> {{stub}}<!--WIP / add links to relevant individual sections for each core Gramplet-->.''
* '''See also: [[Gramps_5.1_Wiki_Manual_-_Categories#Descendant_Fan_View|Descendant Fan View]]'''{{fan_charts}}
{{stub}}
This information can also be found on the [[Main_page|start page of Gramps]]
→Age Stats: note 5.2 patch of Stats gramplet
{{man index|Gramps 5.1 Wiki Manual - Plugin Manager|Gramps 5.1 Wiki Manual - Reports|5.1}}
{{languages|Gramps_5.1_Wiki_Manual_-_Gramplets}}
{{#vardefine:chapter|1012}}
{{#vardefine:figure|0}}
This page details the functionality of the Gramplets that come with Gramps.
[[File:DashboardCategory-DashboardView-default-gramplets-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dashboard Category (Default View)]]
A [[Gramps_Glossary#gramplet|Gramplet ]] is an expansion to the core Gramps program that '''hopefully''' works seamlessly as a built-in feature. 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 plug-ins (also called [http://en.wikipedia.org/wiki/Widget_engine widgets], plugins, add-ons, auxiliary components) that become embedded as part of Gramps and can be found in the '''Dashboard Category''' ... or the '''Sidebars''' and '''Bottombars''' in other Navigator Categories. They provide all kinds of functionality that can be useful for the researcher.</span>
{{Man warn|Performance Drain|<i>'''Gramplets 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 as needed.}}
The split pane approach reduces the need for flipping between Category Views... and that lightens the demands on the database.
[[File:DashboardCategory-gramplet-detached-example-50.png|right|thumb|400px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Detached Gramplets Gramplet in the Dashboard View]]
However, Gramplets can be undocked (detached, torn off) to float free from any of the three containers. When detached, an additional {{man button| Help}} button in the lower left will open the Gramplet's page on this website. Clicking the {{man button| X}} button in the upper right corner will re-docks a detached Gramplet. Clicking the similar {{man button| X}} button of a docked Gramplet will remove it from the pane.
<!-- This is in the WRONG place! We're still talking about how the containers for Gramplets work... not yet to using the Gramplet's themselves.
=== The Dashboard Category View ===
In the [[Gramps_5.1_Wiki_Manual_-_Categories#Dashboard_Category|Dashboard]], you can drag the {{man button| Properties }} button (top left) of each Gramplet to reposition it in the Dashboard View area. You can click the {{man button| Properties }} button to detach (or ''‘undock’'') the Gramplet from Dashboard View and place it in its own window. The window will stay open regardless of page (relationships, charts, 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, they remain visible as you change to a different View (such as the People or Charts View). In this way, you can use these Gramplets to supplement a particular View with additional details and functionality provided by the Gramplet.
=== The split-screen Sidebar & Bottombar ===
[[File:Bottombar-sidebar-drop-down-menu-50.png|450px|thumb|right|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{Stub{#var:figure}}+1}} }} Gramplet split-screens showing [[Gramps_5.1_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 screens 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.1_Wiki_Manual_-_Main_Window#Gramplet_Bar_Menu|Gramplet Bar Menu]]}} has a 'down arrow' gadget to show a Down Arrowhead'' {{man menubutton|Gramplet Bar Menu∨}} with pull-down menu button to show the same pop-up list of options.
To add a Gramplet to the stack stacked tabs, select it from the {{man menu|Gramplet Bar Menu ->{{man button|∨}} Add a gramplet}} submenu.
<span id="undock gramplet">To undock a tab, grab the tab title and drag out of the split-pane. To re-dock, click the Close button or the 'X' button.</span>
To remove the Gramplet from the stack tabs, select it from the {{man menu|Gramplet Bar Menu ->{{man button|∨}} Remove a gramplet}} submenu or click . (Alternatively, the tab's 'X' {{man button|×}} Close button. (The 'X' is only will be accessible when if the 'Show close button in gramplet tabs' checkbox in the [[Gramps_5.1_Wiki_Manual_-_Settings#Display|Display ]] tab of Preferences is selected.)
Curiously, the same Gramplets might be tabs in the different split-screen section of a View but be configured to show information differently. It is important to be aware that each Gramplet (whether stacked as a Tab or floating undocked) bogs down performance of Gramps. Use fewer Gramplets to make Gramps more responsive.
and many others. See [[Third-party Addons]] for more details.
{{-}}
==Built-in 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.1_Addons#Addon_List|3rd-party add-on]] Gramplets.)
{| class="wikitable sortable"
|-
|-
|<!-- Gramplet --> id="35" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Uncollected Objects|Uncollected Objects!]]}}
|<!-- Dashboard Category -->&diams#9888;|<!-- People Category -->�|<!-- Relationships Category -->�|<!-- Families Category -->✔|<!-- Charts Category -->�|<!-- Events Category -->�|<!-- Places Category -->�|<!-- Geography Category -->�|<!-- Sources Category -->�|<!-- Citations Category -->�|<!-- Repositories Category -->�|<!-- Media Category -->�|<!-- Notes Category -->�
|-
|<!-- Gramplet --> id="33" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#Welcome|Welcome to Gramps!]]}}
|-
|}
For more detailed information on using the installed Gramplets, see [[Gramps 5.1 Wiki Manual - Gramplets#Gramplets|Gramplets]].
{{-}}
[[File:2-WayFanChart-detached-gramplet-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} 2-Way Fan Gramplet]]
'''See also:'''{{stubfan_charts}} * See also [[Gramps_5.1_Wiki_Manual_-_Categories#2-Way_Fan_View|2-Way Fan (Chart) View]]
{{-}}
== Age on Date ==
In the Dashboard View, the Gramplet may be detached by clicking the {{man button|Configure active view}} button.
=== See also ===
* An upgrade has been developed for the 5.2 version of Gramps.See the [[:File:AgeStats-Gramplet-detached-51.png#Summary|screen capture]]
{{-}}
Gramplet showing active person's direct descendants as a fan chart.
{{-}}
Minimizing a Gramplet will prevent it from updating.
Moving the mouse over a person will show a tooltip summary which includes the death date.
{{-}}
===Encloses Place Locations===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#LocationsEnclosed_By|LocationsEnclosed By]]
{{-}}
===Enclosed By Place Locations===
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#LocationsEncloses|LocationsEncloses]]
{{-}}
Minimizing a Gramplet will prevent it from updating.
'''See also: [[Gramps_5.1_Wiki_Manual_-_Categories#Fan_Chart_View|Fan Chart View]]'''{{fan_charts}}
{{-}}
== FAQ ==
[[File:FAQ-Gramplet-detached-50.png|right|thumb|350px300px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} FAQ Gramplet - detached example]]
The {{man label|FAQ Gramplet}} (Frequently Asked Questions) shows a list of common questions, and links to their answers from the Gramps Wiki (requires an internet connection).
This gramplet shows a manually curated list of '''Frequently Asked Questions''' hyperlinked to answers in articles of the Gramps wiki. The list is collated from new user postings to the [[Contact#Mailing_lists|Gramps User maillist]] that must be answered repeatedly. The idea is to make the answers to the most common question easier to find, the primary objective is to let new users start using Gramps more quickly. ===See Also===* Bug Report {{stubbug|11742}}<!--: Dashboard FAQ links in gramplet are obsolete (resolved)* Bug Report {{bug|11997}}: how to wiki are outdatedadd/ provide links here also-->update FAQs
{{-}}
[[File:GivenNameCloud-Gramplet-detached-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Given Name Cloud Gramplet - detached example]]
Like the [[#Surname Cloud GrampletSurname_Cloud|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.
The Gramplet splits up given names into words (broken up by spaces). For example "Sarah Elizabeth" would appear under both "Sarah" and "Elizabeth".
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, right-click to edit the person. At the bottom of the Gramplet the number of people per generation is listed. Birth and death dates are shown next to each person's name. Double-click the Generation number to see the matching individuals.
Using the the content of the Pedigree in another program requires a bit of effort Open a contextual pop-up menu by right-clicking anywhere in the gramplet except a hotlink. Or, you can begin a drag selection from the same inert areas. Copy the highlighted text the OS clipboard from that same context menu. (The keybinding for 'Copy' will not work.) When you paste the text into another text editing program, you may need change the font to a non-proportional font to preserve the indentation. Some online services collapse leading spaces when you post a chunk of text. Preserving the indentation for such services may require replacing doubled spaces with doubled placeholder characters... like periods/full stops.
====⚙ Configurable Options====
* Maximum generations: 1 to 100 limit; (''100'')
[[File:References-Gramplet-detached-50.png|right|thumb|350px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} References Gramplet - detached example]]
Gramplet showing the active persons References.
{{-}}
===Person References===
* Person References : Gramplet showing the backlink references for a person
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Family References===
* Family References : Gramplet showing the backlink references for a family
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Event References===
* Event References : Gramplet showing the backlink references for an event
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Place References===
* Place References : Gramplet showing the backlink references for a place
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Source References===
* Source References : Gramplet showing the backlink references for a source
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Citation References===
* Citation References : Gramplet showing the backlink references for a citation
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Repository References===
* Repository References : Gramplet showing the backlink references for a repository
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Media References===
* Media References : Gramplet showing the backlink references for a media object
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
===Note References===
* Note References : Gramplet showing the backlink references for a note
See [[Gramps_5.1_Wiki_Manual_-_Gramplets#References|References]]
{{-}}
== Residence ==
[[File:ResidenceGramplet-Person-detached-example-50.png|right|thumb|450px|Fig . {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Person - Residence Gramplet - detached - example]]
Gramplet showing residence events for the active person
This Gramplet generates SoundEx codes for the names of people in the database.
From the {{man label|SoundEx Gramplet}} window you can either choose a {{man label|Name:}} from the list by pop-up menu shown by selecting the down {{man button|\/▼}} arrowarrowhead, (triangle) or you can type a name into the text field.
The name you type in can be any name ... even a name not present in your Family Tree.
The result is shown automatically eg: The SoundEx code for ''Simpson'Simpson'is '' is S512''
A {{man button|Help}} button is available which brings you to this page. With the {{man button|Close}} button (or using the keyboard shortcut {{man key press|Alt|C}}) you close dismiss the {{man label|SoundEx Gramplet}} window.
{{-}}
==== Soundex what is this? ====
Soundex is the most widely known of all [http://en.wikipedia.org/wiki/Phonetic_algorithm phonetic algorithms] which allow indexing of words by their sound, as pronounced in English.
The Soundex equivalent is a coded surname (last name) index based on the way a surname sounds rather than the way it is spelled. Surnames that sound the same, but are spelled differently, like SMITH and SMYTH, have the same code and are filed together. The Soundex coding system was developed so that you can find a surname surnames may be found even though it may have been when recorded under various variant spellings.
First applied to the 1880 censusUS Census, Soundex is a phonetic "sound index", not a strictly alphabetical one. Its The key feature is that it codes surnames (last names) based on the way a name sounds rather than on how it is spelled. It The Soundex phonetic coding system pre-dates computers and was to help researchers find a surname quickly even though it may have received different spellings.
Those doing census lookups must use the same method to encode and tabulate surnames as the census takers workers did when they generated the database.
To search for a particular surname, you must first work out its codeencoding equivalent.
*'''Basic Soundex Coding Rule:'''
[[File:ToDo-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} To Do Gramplet - detached example]]
The '''To Do Gramplet is ''' displays a free form text areashowing the contents of Note objects of the "To Do" type. 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.
To Do Gramplets allow you to create notes and attach them to Gramps objects. For example, you can add a Person To Do Gramplet to the sidebar of the 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.
== Uncollected Objects ==
{{man warn|Only shown if you are Diagnostic Tool|This option is only available when Gramps has been started using Gramps in developer modeswitch. It is not intended for general use and has limited safeguards.}}
[[File:UncollectedObjects-Gramplet-detached-example-50.png|right|thumb|450px|Fig {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Uncollected Objects Gramplet - detached example]]
[[File:Welcome-Gramplet-detached-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Welcome Gramplet - detached example]]
The '''Welcome to Gramps!''' 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_5.1_Wiki_Manual_-_Manage_Family_Trees|Family Tree]].
{{-}}
== What's Next ==
[[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 closer the common ancestor is from the main person, the more "urgent" the information is (e.g. nephews are considered more "urgent" than uncles, even though both have a distance of 3 generations, because for nephews the common ancestor is father/mother, while for uncles, the common ancestor is grandfather/grandmother)
* Marriage data and personal data of the spouse is slightly less "urgent" than personal data of the directly related person
* Half brothers siblings are less "urgent" than brotherssiblings
You may copy the text from inside of this Gramplet by selecting it and pasting into an empty document.
{{-}}
[[File:WhatsNext-Gramplet-Configuration-tab-50.png|right|thumb|350px|Fig . {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} What's Next? Gramplet - Configuration tab shown]]
The Gramplet can ignore previously verified events by making use of some custom Tags. The tags are selected in the Gramplets configuration. For example you can tag the following to be ignored:
