15,534
edits
Changes
no edit summary
Proposed changes for enhancing GRAMPS by adding a new GUI API that allows data to be displayed on the screen, with graphical objects such as tables, buttons, text entry, links, etc. This would effectively be able to turn a user plugin into an interface for moving, say, the active person in the main window, or, possibly, for user-defined data entry. . See [[Category:GEPSGramplets]]for development information, [[Gramps 3.1 Wiki Manual - Gramplets]] for information on using them, and [[Third-party Plugins]] for a list of additional Gramplets.
== Motivation ==
Allows users to add to the GRAMPS interface. A new page, currently called "My GrampsGramplets", would be created that allows for customized "gadgetsgramplets" that perform various functions (other than tools and reports). This might include: interactive shells, TODO lists, logs, debugging tools, and various "folders" for organizing groups of people, families, or other objects.
== Details ==
This should be all on one line. You can change the order (and leave some pages out) as well with this key. (You can also add pages multiple times, but that isn't as useful as the active object on one page will change it on another).
On start up, the file gadgetsgramplets.ini is looked for in the user's .gramps subdirectory. If it is not found, a set of gadgets gramplets are created, currently a Welcome Message Gadget with a welcome message Gramplet and a Stats GadgetGramplet.
[[Image:Mygramps.png]]
You can drag the Properties button (top left) of each gadget gramplet to move it around the screen. Clicking the Properties will (currently) detach the gadget gramplet from My Gramps 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 My Grampsthe Gramplets view. If you quit Gramps with a open gadgetgramplet, when you start gramps again, it will open automatically.
[[Image:Detached.png]]
You can add new gadgets gramplets by right clicking on an open space on My GrampsGramplets. You can also change the number of columns by right-clicking an open area on the My Gramps Gramplets page.
=== Gadgets Gramplets ===
What is a GRAMPS gadgetgramplet? A GRAMPS gadget gramplet is a view of data that either changes dynamically during the running of GRAMPS, or provides interactivity to your genealogical data. What is the difference between gadgetsgramplets, reports, quick views, and tools?
# Reports provide a static output format of your data, typically for printing
# Quick View provides a typically short, interactive listing derived from your data
# Tools provide a method of processing your data
# Gadgets Gramplets provide a dynamic view and interface to your data
There are currently 8 9 proof-of-concept gadgetsgramplets:
# Welcome GadgetGramplet# Top Surnames GadgetGramplet# Surname Cloud Gramplet# TODO GadgetGramplet# Statistics Gadget Gramplet # Python GadgetGramplet# News GadgetGramplet# Session Log GadgetGramplet# Calendar GadgetGramplet
This section will describe each gadget gramplet and its proposed functionality
==== Welcome Gadget Gramplet ====
[[Image:Welcomegadget.png]]
The welcome gadget gramplet gives an introductory message to new users, and some basic instructions.
TODO: add links to parts of manual, links to bring up windows.
==== Top Surnames Gadget Gramplet ====
[[Image:Topgadget.png]]
The top surnames gadget gramplet shows the top 10 (by default) used surnames. Double-click a surname to run the Same Surnames Quick ReportView.
Change the number of names displayed by editing this section in ~/.gramps/gadgetsgramplets.ini
==== Surname Cloud Gramplet ==== [[Image:Surnamecloud.png]] The surname cloud gramplet shows the top 100 (by default) used surnames. Double-click a surname to run the Same Surnames Quick View. Mouse over the name to see percentage and counts. Change the number of names displayed by editing this section in ~/.gramps/gramplets.ini ==== TODO Gadget Gramplet ====
[[Image:Todogadget.png]]
The TODO gadget gramplet is free form text. This is persistent between sessions. Open more than one to save different info. Change the title of the gadget gramplet by editing the section name in ~/.gramps/gadgetsgramplets.ini
==== Statistics Gadget Gramplet ====
[[Image:Statgadget.png]]
The Statistics gadget gramplet runs a copy of the code from the Statistics report.
==== Python Gadget Gramplet ====
[[Image:Pythongadget.png]]
The Python gadget gramplet brings up a Python Shell for interpreting python expressions. You can type most any (single line) Python expression. In addition, the environment has been populated with some useful variables, including '''self''' (this Python gadgetgramplet), '''Date''', '''uistate''' and '''dbstate'''. The '''Date''' entry is a date object constructor, and can be used for date arithmetic. For example, you might be interested in answering these questions:
What was the date 56 years ago:
1980-01-26
==== News Gadget Gramplet ====
[[Image:Newsgadget.png]]
The News gadget gramplet reads the wiki news page. TODO: add links and formatting.
==== Session Log Gadget Gramplet ====
[[Image:Loggadget.png]]
The session log keeps track of activity in this session. By default, it only shows each entry once. Change this behavior by editing this section in ~/.gramps/gadgetsgramplets.ini. Click a name to change the active person; double-click to bring up the edit page for that person.
==== Calendar Gadget Gramplet ====
[[Image:Calendargadget.png]]
The Calendar gadget gramplet shows a monthly calendar, with events marked (in bold day numbers). Double-click a day to run the "On This Day" Quick Report.
== Development ==
These are all defined in src/plugins/DefaultGadgetsDefaultGramplets.py
The simplest gadgetgramplet:
<pre>
gui.set_text("Hello world!")
register(type="gadgetgramplet", # case in-senstitive keyword "gadgetgramplet" name="Hello World GadgetGramplet", # gadget name, unique among gadgetsgramplets
height = 20, # default size
content = init, # function/class; takes guigadgetguigramplet title="Sample GadgetGramplet", # default title, user changeable
)
</pre>
Using the Gadget Gramplet class, however, provides more functionality. It has a number of method possibilities:
# init- run once, on construction
# main- run once per db change, main process (a generator-must use yield at least once. '''yield True''' means true that there is more; '''yield False''' means all done)
There are methods for saving/loading data, and interacting with the gui. More For more details to come.., see [[Gramplets]].
== Discussion ==
This type of proposal is discussed on these threads:
*http://www.nabble.com/A-ScreenDoc-idea-t847639.html *http://www.nabble.com/Re:-Interactive-Quick-Reports-(was-Notes-in-V3.0)-p12735768.html *http://www.nabble.com/QuickReports-and-TextBufDoc--tf4537797.html *http://www.nabble.com/Report-Interface-tf4559738.html
There is also a Feature Request to remind us:
*{{bug|1291}} Interactive Context Sensitive Data Explorers
