1,583
edits
Changes
→Python Gramplet
{{grampsmanualcopyright}}
{{man index|Gramps 3.0 Wiki Manual - Navigation|Gramps 3.0 Wiki Manual - Reports|3.0}}
{{languages|Gramps_3.0_Wiki_Manual_-_Gramplets}} 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]].
= Gramplets =
[[Image:Mygramps.png|thumb|right|200px|Fig. 4.1 Gramplets View]]
*Reports provide a static output format of your data, typically for printing
Gramplets are the widgets that are part of GRAMPS and can be seen in the [[Gramps 3.0 Wiki Manual - Main Window#Gramplets View|Gramplet View]]. The widgets provide all kind of functionality that can be useful for the researcher.
When you first start the View you will see a the '''Welcome Message Gramplet ''' and a Stats the '''Top Surnames Gramplet'''.
[[Image:Detached.png|thumb|right|200px|Fig. 4.2 Detached Gramplets View]]
You can drag the Properties button (top left) of each gramplet to move it around the screen. Clicking the Properties will detach the gramplet from Gramplet View and place it in its own window. The window will stay open regardless of page (relationship, pedigree, etc). Closing the detached view will put it back onto the Gramplets 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 Gramplet View, you can change to a different view (such as the People or Pedigree View). In this way, you can use these gramplets to supplement a particular view with additional details and functionality provided by the gramplet.
*TODO Gramplet
*Statistics Gramplet
*Pedigree Gramplet
*Python Gramplet
*News Gramplet
*Relatives Gramplet
*Age on Date Gramplet
*Records Gramplet
*What's Next Gramplet
This section will describe each gramplet and its basic functionality. {{man warnnote|Changing settings|You can change the settings of some the Gramplets by editing the your '''~/.gramps/gramplets.ini''' file. But you can only do that when GRAMPS is not running. Be careful so Just bring up the ''gramplets.ini'' file in a text editor 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 GRAMPS. If you do not mess up your have an idea for additional Gramplets, please let us know!}} == Data Entry Gramplet == [[Image:DataEntryGramplet.png|thumb|right|150px|Data Entry Gramplet]] The Data Entry gramplet allows an easy method of editing previously added people, and adding new and related people in your family tree. The '''Surname, Given''' entry is a combined entry for just the surname and given names, separated by a comma. If you need more fine grained editing on the name, you can use the Edit icon once a person has been selected as the active person. The '''Death''' and '''Birth''' lines for both the ''Active person'' and ''New person'' are also a combined entry, allowing you to enter a date and place. The date (if one) is entered first in any format available to your GRAMPS installation, followed by the word "in" (in your language) and the location (if one). For example, the following are all valid entries for the birth or death entries: Jan 1, 1867 in Kingsport, TN about 1822 in Sweden in London, England, UK 1756/12/31 If a location has been previously used, then it will share that location with the others. If it is new, it will be created. A new person can be automatically added as a relation to the active person. You can add the new person as a parent, spouse, sibling, or child. The gramplet will guess at the best place to add the person. For example, it will add the new person to the first family available. The gramplet will also try to discern gender where needed, guessing that the "father" spouse of a family is male, and the "mother" spouse is female. If these guesses are incorrect, you should add your new person via the normal GRAMPS data entry method. If you would like to bring up the standard Edit Person window for the active person, simply click on the Edit button to the right of the Active person's name. If you would like to bring up the standard Edit Family window for the active person, click the Edit button to the right of the word "Family:" on the top row. This will bring up the first family (if the active person is the spouse in a family) or will bring up the active person's parents family, if known. If you begin an edit of the active person, then the active person data won't change until you either '''Save''' or '''Abandon''' your changes. The '''Copy Active Data''' will copy the entries of the active person to the entries for the new person. == Descendant Gramplet == [[Image:DescendantGramplet.png|thumb|right|150px|Fig. Descendant Gramplet]] ''Will appear only in the future in version GRAMPS 3.1.x'' The Descendent gramplet shows the direct descendants of the active person. The order of the spouses and children is that given in the GRAMPS editor. To change the order of spouses, click on ''Order'' on the Relationship view. To change the order of children, drag and drop them in the correct order in the Family edit window. This gramplet is based on the Descendant Report, available from the Textual Reports. The Descendant gramplet will update when you change the active person, or change family trees. It does not update automatically for edits or additions because this report is time-consuming to run. Minimizing a gramplet will prevent it from updating.
== Welcome Gramplet ==
[[Image:Todogadget.png|right|thumb|200px|Fig. 4.6 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 great because useful as the TODO info information stays within GRAMPS. In future versions, you will be able to save links to GRAMPS items (like people, events, and familes. This will allow you to keep a group of links that you are working on together.
You can open more TODO lists to save different kinds of topics or organize your info.
Change the title of the gramplet by editing the section name in ~/.gramps/gramplets.ini
== Statistics Gramplet ==
[[Image:Statgadget.png|right|thumb|200px|Fig. 4.7 Statistics Gramplet]]
The Statistics gramplet runs a copy of Statistics report. Double-click the code from phrases to bring up the Statistics reportmatching items.
Following information is provided to you in this Gramplet:
**Number of unique media objects
**Total size of media objects
**Missing Media Objects
As with all Gramplets if you click on the left hand side {{man button|Tool}} button you detach the window and if you add persons to your family tree, you will see the amount of individuals change dynamically.
== Pedigree Gramplet ==
[[Image:PedigreeGramplet.png|thumb|right|200px|Figure: 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.
== Python Gramplet ==
[[Image:Pythongadget.png|thumb|right|200px|Fig. 4.8 Python Shell]]
The '''Date''' entry is a date object constructor, and can be used for date arithmetic. For example, you might be interested in questions like:
> Date(2007, 12, 31) - 56
> Date(1703, 6, 1).to_calendar("hebrew")
5463-10-17 (Hebrew)
Another use for this Gramplet is for debugging. This gramplet makes a nice interface to the running GRAMPS system. You can inspect, and alter the system by entering Python commands. As a simple example, you can:
> self.clear_text() # clear the text in this window
> self.set_wrap(False) # new in GRAMPS 3.1: turn word wrap off
> self.set_wrap(True) # new in GRAMPS 3.1: turn word wrap on
== Quick View Gramplet ==
[[Image:Quickviewgramplet.png|thumb|right|150px|Fig. Quick View Gramplet]]
''New for version 3.1''
The Quick View gramplet allows you to run a Quick View, but it updates as you move from person to person. (Currently, only People Quick Views can be run).
You can run any of the [[Quick Views]] for a person.
You can change the options by clicking the Option button (top, left hand button of the Gramplet). Select '''Options''' and a list of options will appear. Press '''Save''' to apply the changes to the Quick View.
== News Gramplet ==
== Session Log Gramplet ==
[[Image:Loggadget.png|thumb|right|thumb|150px160px|Fig. 4.10 Session Log Gramplet]]
The session log keeps track of activity in this session.
[[Image:Calendargadget.png|right|thumb|200px|Fig 4.11 Calendar]]
The Calendar gramplet shows a monthly calendar, with current active person's events marked (in bold day numbers).
The actual date is highlighted.
== Age on Date Gramplet ==
[[Image:AgeOnDateGramplet.png|right|thumb|200px|Fig 4.13a Age On Date Gramplet]] 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 on that Date.The date must be entered in a format that GRAMPS accepts. [[Image:AgeOnReport.png|right|thumb|200px|Fig 4.13b Age On Date Quick Report]]
You can then sort by the age column, and double-click the row to view or edit.
== Relatives Gramplet ==
[[Image:RelativesGramplet.png|right|thumb|200px|Fig 4.12 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".
The names in this gramplet also allow you to call up the person editor directly, by right-clicking on any of the names.
== Records Gramplet ==
[[Image:RecordsGramplet.png|right|thumb|200px|Fig 4.16 Records Gramplet]]
''Will appear only in the future in version GRAMPS 3.1.x''
The Records Gramplet shows a number of interesting records (mostly age related) in your database, like oldest living person, youngest mother, etc.
<br clear="all"/>
== What's Next Gramplet ==
[[Image:WhatsNextGramplet.png|right|thumb|200px|Fig 4.17 What's Next Gramplet]]
''Will appear only in the future in version GRAMPS 3.1.x''
<br clear="all"/>
{{man index|Gramps 3.0 Wiki Manual - Navigation|Gramps 3.0 Wiki Manual - Reports|3.0}}
[[Category:Documentation]]
{{languages|Gramps_3.0_Wiki_Manual_-_Gramplets}}
