4,602
edits
Changes
m
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-->.''
With Surrounding the {{man label|''month''}} label at the top left corner, the {{man button|<}} {{man tooltip|previous}} and {{man button|>}} {{man tooltip|next}} buttons top left corner (month) you can be used to change to the previous and next month.
With Surrounding the {{man label|''year''}} label at the top right corner, the {{man button|<}} {{man tooltip|previous}} and {{man button|>}} {{man tooltip|next}} buttons top right corner (year) you can be used to change to the previous and next year.
The information is presented in You can also drag a table showingday from the Calendar to the date fields (such as for the [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:*_detailed_-_part_2#New_Event_dialog|Event Editor]] or the [[Gramps_5.1_Wiki_Manual_-_Gramplets#Age on Date*Type*Place*Reference|Age on Date Gramplet]]) to enter that date. Similarly, a calendar day may also be dragged to the [[Gramps_5.1_Wiki_Manual_-_Navigation#Using_the_Clipboard|Clipboard]] where it will be stored in a plain text format.
You {{man tip|Localized Day of the week headers|The customary first day of the week can also drag a date be shown on calendar and which vary culturally. The calendar adapts to the date field of language setting. <br /><br />The feature will be included in the 5.2 release but can patched manually. ''See the [[Gramps_5https://gramps.discourse.1_Wiki_Manual_group/t/built-in-_Gramplets#Age calendar-gramplet/2080 Discourse forum discussion on Datethe Calendar Gramplet]''}} <!-- Prepared for insertion for version 5.2 {{man tip|Age The calendar columns are localized|The customary first day of the week shown on Date Gramplet]calendars varies culturally. The calendar adapts to the locality. If the first calendar column is for the wrong day of the week, contact the translator for your language and refer them to the [https://github.com/gramps-project/gramps/pull/1319#issuecomment-1002039348 <code>gtk/gtkcalendar</code> translation string] to enter that date.}}-->
* '''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]]
→Soundex what is this?: ad links to Soundex features
= What is a Gramplet? =
<span id="definition">
[[File:DashboardCategoryDashboardCategoryView-DashboardView-default-grampletsexample-50.png|right|thumb|400px450px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Dashboard Category (Default View)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-onsaddons, 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 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:{{#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 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.1_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.
To add a Gramplet to the stacked tabs, select it from the {{man menu|Gramplet Bar Menu {{man button|∨}} Add a gramplet}} submenu.
and many others. See [[Third-party Addons]] for more details.
= 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.
{{-}}
==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 addon]] Gramplets.)
{| class="wikitable sortable"
|-
! Gramplet
! [[Image:22x22-gramps-gramplet.png]] <small>Dashboard</small>! [[Image:22x22-gramps-person.png]] <small>People</small>! [[Image:22x22-gramps-relation.png]] <small>Relationships</small>! [[Image:22x22-gramps-family.png]] <small>Families</small>! [[Image:22x22-gramps-pedigree.png]] <small>Charts</small>! [[Image:22x22-gramps-event.png]] <small>Events</small>! [[Image:22x22-gramps-place.png]] <small>Places</small>! [[Image:22x22-gramps-geo.png]] <small>Geography</small>! [[Image:22x22-gramps-source.png]] <small>Sources</small>! [[Image:22x22-gramps-citation.png]] <small>Citations</small>! [[Image:22x22-gramps-repository.png]] <small>Repositories</small>! [[Image:22x22-gramps-media.png]] <small>Media</small>! [[Image:22x22-gramps-notes.png]] <small>Notes</small>
|-
|<!-- Gramplet --> id="0" |{{man label|[[Gramps_5.1_Wiki_Manual_-_Gramplets#2-Way_Fan_Chart|2-Way Fan Chart]]}}
|-
|<!-- 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!]]}}
[[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 ==
{{-}}
* You can also drag a date to from [[Gramps_5.1_Wiki_Manual_-_Gramplets#Calendar|Calendar Gramplet]] to the {{man label|Age on Date}} Gramplets {{man label|Date:}} entry field to enter that date.
* See also the [[Third-party_Addons|Third-party Addon]] [[Addon:DateCalculator|Date Calculator Gramplet]] which allows you to do date math.
{{-}}
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]]
{{-}}
[[File:Calendar-Gramplet-detached-50.png|right|thumb|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Calendar Gramplet - detached example]]
The '''Calendar Gramplet ''' shows a monthly calendar. Double-click a day to run the {{man label|On This Day}} Quick View.
Double-click a '''day''' to run the {{man label|[[Gramps_5.1_Wiki_Manual_-_Reports_-_part_8#On_This_Day|On This Day]]}} Quick View. The Quick View window shows you up to 3 table sections, the '''Events events (if any exist) of''' : the selected day: Events on this exact date and Other , other events on this Monththe same month/day in history as well as Other , and events in that year.
{{-}}
Use:
* The Family Editor [[Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_1#Children|Children]] tab to change the order of children in the family.
* The third party addon [[Addon:BirthOrderTool|Birth Order Tool]] which allows bulk updates of the children order.
{{-}}
===Person Children===
Gramplet showing active person's direct descendants as a fan chart.
{{-}}
Minimizing a Gramplet will prevent it from updating.
'''See also: [[Gramps_5.1_Wiki_Manual_-_Categories#Fan_Chart_View|Fan Chart View]]'''{{fan_charts}}
{{-}}
{{-}}
See also the third party:
* [[Addon:Edit Image Exif Metadata]] addon
=== Prerequisites ===
See also:
* [[Addon:NoteGramplet|Note Gramplet]] - Third party Addon
{{-}}
===Person Notes===
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; (default: ''100'')* Show Dates checkbox; (default: ''deselected'')* Line Type menu: <abbr title="Unicode Transformation Format graphical symbols">UTF</abbr>, <abbr title="American Standard Code for Information Interchange text symbols">ASCII</abbr>; (default: ''UTF'')
== Quick View ==
[[File:QuickView-Gramplet-Configuration-tabdetached-50.png|thumb|right|350px|Fig. {{#var:chapter}}.{{#vardefineecho:figure|{{#expr:{{#var:figure}}+1}}}} Quick View Gramplet - detached example]]
The Quick View Gramplet allows you Quick View reports to run update dynamically. Instead of a Quick Viewwindow with a static report, it the gramplet updates as you move from person to persondifferent active record is selected within the target Category. (When this Gramplet was introduced, it only supported running offered choosing Quick Views View Reports from the People category. Other A Configuration pop-up menu to select View categories are now supportedhas since been added.)
You can run any of the built-in [[Gramps_5.1_Wiki_Manual_-_Reports_-_part_8#Quick_Views|Quick Views]] for a personor [[5.1_Addons#Addon_List|add-on]] QuickView reports.
{{-}}
[[File:QuickView-Gramplet-detachedConfiguration-tab-50.png|thumb|right|350px|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.
{{-}}
See the following developer information if you are interested in creating your own:
==== Soundex what is this? ====
Soundex is the most widely known of all [httphttps://en.wikipedia.org/wiki/Phonetic_algorithm phonetic algorithms] which allow indexing of words by their sound, as pronounced in English. Soundex support is included with searching via a [[Gramps_5.1_Wiki_Manual_-_Filters#Soundex_match_of_People_with_the_.3Cname.3E|Soundex match of People with the <name>]] Custom Filter rule, a [[Gramps_5.1_Wiki_Manual_-_Gramplets#SoundEx|Soundex Gramplet]], and as a quality control for matching in the [[Gramps_5.1_Wiki_Manual_-_Tools#Find_Possible_Duplicate_People|Find Possible Duplicate People]] tool.
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 surnames may be found even when recorded under variant spellings.
{{-}}
See also the experimental [[Third-party Addons|Third-party Addon]]:
* [[Addon:ToDoNotesGramplet|ToDo Notes Gramplet]] available for the Dashboard that lists all To Do notes in the database, together with the object to which they are attached.
{{-}}
===Person To Do===
== 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]].
{{-}}
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:
* You want The Home Person defines the focus* Searches for gaps begin with the Home Person's descendants and work up the tree * The tree is expected to know first and last contain the given name, surname, birth date and place, and death date and place of each person* You want to know father, motherparents, their marriage 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 main personHome Person, the more "urgent" the information gap is.
* 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 -siblings are less "urgent" than siblings
You may copy the text from inside of this Gramplet by selecting it and pasting into an empty document.
