Difference between revisions of "Quick Views"

From Gramps
Jump to: navigation, search
m
(Notes)
 
(34 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Quick reports are reports that are available in the context menu's of person, family, ...  
+
Quick Views (previously called ''Quick reports'' but show up in "Available Gramps Update for Addons" as ''Quickreport'') are reports that are available in the context menu's of person, family, ...  
  
 
They are easy to make by users, even with limited coding knowledge.
 
They are easy to make by users, even with limited coding knowledge.
 +
 +
[[Image:GrampsQuickViewReportEdit-40.png|thumb|right|400px|Quick View context menu on Person Editor]]
  
 
==Introduction==  
 
==Introduction==  
[[Image:Gramps_quick_report_edit.png|thumb|right|Quick Report context menu on Person Editor]]
+
Many users want to produce a report quickly for their specific needs, but are hindered by the fact they do not want to learn python fully, nor the intricacies of a complicated program like Gramps.
Many users want to produce a report quickly for their specific needs, but are hindered by the fact they do not want to learn python fully, nor the intricacies of a complicated program like GRAMPS.  
+
 
 +
For them, starting in Gramps 3.0 a new tool has been constructed: the Quick Views. These reports are short textual reports that the user can register with Gramps, so they automatically appear in the context menu's.
  
For them, starting in GRAMPS 3.0 a new tool has been constructed: the quick reports. These reports are short textual reports that the user can register with GRAMPS, so they automatically appear in the context menu's.
 
 
Accompanying this, a [[Simple Access API|simple database access]] and simple document interface has been constructed, so as to hide as much complexity as possible.
 
Accompanying this, a [[Simple Access API|simple database access]] and simple document interface has been constructed, so as to hide as much complexity as possible.
  
 
==Where to store my quick report==
 
==Where to store my quick report==
A quick report is one single file. You can store it in your plugins directory. Go into your home folder and go to the hidden directory '''.gramps'''. In this directory you will find the '''plugins''' directory. Just add your plugin there, and it will appear within GRAMPS.  
+
A quick report is one single file. You can store it in your plugins directory. Go into your home folder and go to the hidden directory '''.gramps'''. In this directory you will find the '''plugins''' directory. Just add your plugin there, and it will appear within Gramps.  
  
 
For the terminal users, you can get there as follows:
 
For the terminal users, you can get there as follows:
Line 18: Line 20:
 
==Example 1==
 
==Example 1==
 
===Code===
 
===Code===
[[Image:Gramps_quick_report_view.png|thumb|right|Quick Report context menu on Person View]]
+
[[File:QuickViewReport-people-context-menu-popup-41.png|thumb|right|400px|Quick View context menu on Person View]]
 +
[[File:Siblings quick report result.png|thumb|right|400px|Quick View Report example result output]]
 +
 
 
How better than to learn something than using an example?  
 
How better than to learn something than using an example?  
Here it goes. We want a report to show all siblings of a person. That is, brothers and sisters from '''all''' families the person is part of. The quick report is then the following:
 
  
  26 from Simple import SimpleAccess, SimpleDoc
+
Here it goes. We want a report to show all siblings of a person.
  27 from gettext import gettext as _
+
 
  28 from PluginUtils import register_quick_report
+
That is, brothers and sisters from '''all''' families the person is part of.
  29 from ReportBase import CATEGORY_QR_PERSON
+
 
  30
+
The quick report is then the following:
  31 # define the formatting string once as a constant. Since this is reused
+
 
  32
+
{{-}}
  33 __FMT = "%-30s\t%-10s\t%s"
+
Create a python file named Siblings.py and add the following content:
  34
+
 
  35 def run(database, document, person):
+
{{out of date|this code is old, needs to be changed and tested}}
  36     """
+
 
  37     Loops through the families that the person is a child in, and display
+
<pre>
  38     the information about the other children.
+
#------------------------------------------------------------------------
  39     """
+
# File: Siblings.py
  40
+
#------------------------------------------------------------------------
  41     # setup the simple access functions
+
 
  42     sdb = SimpleAccess(database)
+
from gramps.gen.simple import SimpleAccess, SimpleDoc
  43     sdoc = SimpleDoc(document)
+
from gramps.gui.plug.quick import QuickTable
  44
+
from gramps.gen.ggettext import gettext as _
  45     # display the title
+
 
  46     sdoc.title(_("Siblings of %s") % sdb.name(person))
+
def run(database, document, person):
  47     sdoc.paragraph("")
+
     """
  48
+
     Loops through the families that the person is a child in, and display
  49    # display the header of a table
+
     the information about the other children.
  50    sdoc.header1(__FMT % (_("Sibling"), _("Gender"), _("Birth Date")))
+
     """
  51
+
 
  52     # grab our current id, so we can filter the active person out
+
     # setup the simple access functions
  53     # of the data
+
     sdb = SimpleAccess(database)
  54
+
     sdoc = SimpleDoc(document)
  55     gid = sdb.gid(person)
+
 
  56
+
     # display the title
  57     # loop through each family in which the person is a child
+
     sdoc.title(_("Siblings of %s") % sdb.name(person))
  58     for family in sdb.child_in(person):
+
     sdoc.paragraph("")
  59
+
 
  60         # loop through each child in the family
+
     # grab our current id, so we can filter the active person out
  61         for child in sdb.children(family):
+
     # of the data
  62
+
 
  63             # only display if this child is not the active person
+
     gid = sdb.gid(person)
  64             if sdb.gid(child) != gid:
+
 
  65                 sdoc.paragraph(__FMT % (
+
 
  66                        sdb.name(child),
+
    stab = QuickTable(sdb)
  67                         sdb.gender(child),
+
    sdoc.header1(_("Siblings"))
  68                         sdb.birth_date(child)))
+
    stab.columns(_("Person"),
  69
+
                _("Gender"),
  70 #------------------------------------------------------------------------
+
                _("Date"))
  71 #
+
 
  72 #
+
     # loop through each family in which the person is a child
  73 #
+
     for family in sdb.child_in(person):
  74 #------------------------------------------------------------------------
+
 
  75 register_quick_report(
+
         # loop through each child in the family
  76     name = 'a_unique_name_with_no_spaces',
+
         for child in sdb.children(family):
  77     category = CATEGORY_QR_PERSON,
+
 
  78    run_func = run,
+
             # only display if this child is not the active person
  79    translated_name = _("Siblings"),
+
             if sdb.gid(child) != gid:
  80    status = _("Stable"),
+
                 stab.row(child,
  81     description= _("Display a person's siblings."),
+
                         sdb.gender(child),
  82     author_name="your name",
+
                         sdb.birth_date(child))
  83     author_email="your email"
+
                document.has_data = True
  84     )
+
    stab.write(sdoc)
 +
</pre>
 +
 
 +
You will also need a Gramps registration file:
 +
 
 +
<pre>
 +
#------------------------------------------------------------------------
 +
# File: Siblings.gpr.py
 +
#------------------------------------------------------------------------
 +
 
 +
register(QUICKREPORT,
 +
     id    = 'siblings',
 +
     name  = _("Siblings"),
 +
     description = _("Display a person's siblings."),
 +
     version = '1.0',
 +
    gramps_target_version = '4.1',
 +
    status = STABLE,
 +
    fname = 'siblings.py',
 +
    authors = ["Donald N. Allingham"],
 +
     authors_email = ["don@gramps-project.org"],
 +
     category = CATEGORY_QR_PERSON,
 +
    runfunc = 'run'
 +
  )
 +
</pre>
  
 
===Analysis: registering the report===
 
===Analysis: registering the report===
The above code is GPL licensed, written by Don.
+
 
Let's analyse this. We start at the bottom where the report is registered with '''register_quick_report'''. This is the function GRAMPS will look for in your file. You need to give:
+
Let's analyse the above. We start at the bottom where the report is registered with '''register'''. This is the function Gramps will look for in your file. You need to give:
*{{man label|name}} = a unique name: a name GRAMPS identifies the plugin with, don't use spaces or strange symbols.
+
*{{man label|name}} = a unique name: a name Gramps identifies the plugin with, don't use spaces or strange symbols.
 
*{{man label|category}} = a special constant indicating where the report will be shown. You can use '''CATEGORY_QR_PERSON''' to see the report on person editor and view, or '''CATEGORY_QR_FAMILY''' to see the report on family editor or view.
 
*{{man label|category}} = a special constant indicating where the report will be shown. You can use '''CATEGORY_QR_PERSON''' to see the report on person editor and view, or '''CATEGORY_QR_FAMILY''' to see the report on family editor or view.
*{{man label|run_func}} = the function you create in this plugin and that GRAMPS will execute when the user selects your quick report in the menu
+
*{{man label|run_func}} = the function you create in this plugin and that Gramps will execute when the user selects your quick report in the menu
 
* {{man label|translated_name}} = the name of the report as it will appear in the menu
 
* {{man label|translated_name}} = the name of the report as it will appear in the menu
* {{man label|status}} = is your report '''Stable''' or '''Unstable'''. Not used at the moment. On distributing GRAMPS we only include stable reports.
+
* {{man label|status}} = is your report '''Stable''' or '''Unstable'''. Not used at the moment. On distributing Gramps we only include stable reports.
 
*{{man label|description}} = a description of what your plugin does. This appears in a tooltip over the menu
 
*{{man label|description}} = a description of what your plugin does. This appears in a tooltip over the menu
 
*{{man label|author_name}} = your name
 
*{{man label|author_name}} = your name
Line 95: Line 121:
  
 
===Analysis: the run function===
 
===Analysis: the run function===
 +
 
If the user clicks in the quick report menu on your report, the run function is executed with three parameters:
 
If the user clicks in the quick report menu on your report, the run function is executed with three parameters:
  
 
<center>
 
<center>
'''run_function(database, document, handle)'''
+
'''run(database, document, person)'''
 
</center>
 
</center>
  
So, your report recieved from gramps the database on which to work, the document on which to write, and the handle (=unique identifier) of the object the user is on. For a person quick report, this is a person handle, for family, a family handle.
+
So, your report received from gramps the database on which to work, the document on which to write, and the person of the object the user is on. For a person quick report, this is a person, for family, a family.
 
+
  
 
In this example, the function called is  
 
In this example, the function called is  
Line 108: Line 134:
  
 
===Analysis: accessing the data===
 
===Analysis: accessing the data===
Now that your plugin runs, you need to open the database, start the document, access data, and write it out.  
+
Now that your plugin runs, you need to open the database, start the document, access data, and write it out. We do this using the [[Simple Access API|Simple Database API]]. So,  
We do this using the [[Simple Access API|Simple Database API]]. So,  
+
 
  41    # setup the simple access functions
+
<pre>
  42    sdb = SimpleAccess(database)
+
# setup the simple access functions
  43    sdoc = SimpleDoc(document)
+
sdb = SimpleAccess(database)
 +
sdoc = SimpleDoc(document)
 +
</pre>
 +
 
 
prepares everything. Then we write a title on the document, an empty line under it, and a header, with the title, paragraph and header function:
 
prepares everything. Then we write a title on the document, an empty line under it, and a header, with the title, paragraph and header function:
  45    # display the title
 
  46    sdoc.title(_("Siblings of %s") % sdb.name(person))
 
  47    sdoc.paragraph("")
 
  49    # display the header of a table
 
  50    sdoc.header1(__FMT % (_("Sibling"), _("Gender"), _("Birth Date")))
 
Note that we use '''_''' for every string for translation, which comes from the line
 
  27 from gettext import gettext as _
 
You can replace this by
 
  46    sdoc.title("Siblings of %s" % sdb.name(person))
 
to just try it out for yourself, without a translation option.
 
  
As we will write a list, it is usefull to define the structure of your text one time, and reuse this. That is the '''__FMT''' constant, defined as
+
<pre>
  33 __FMT = "%-30s\t%-10s\t%s"
+
# display the title
So we have 30 spaces for the Sibling field, then a tab ('''\t'''), then 10 spaces for the Gender, another tab and the last stringfield for the birth date.
+
sdoc.title(_("Siblings of %s") % sdb.name(person))
 +
sdoc.paragraph("")
 +
</pre>
 +
 
 +
Note that we use '''_''' for every string for translation, which comes from the line:
 +
 
 +
<pre>
 +
from gramps.gen.ggettext import gettext as _
 +
</pre>
  
 
Everything is set up, now we write out the lines with all the siblings, leaving out the active person himself, as he is in the title field!
 
Everything is set up, now we write out the lines with all the siblings, leaving out the active person himself, as he is in the title field!
  52    # grab our current id, so we can filter the active person out
+
 
  53    # of the data
+
<pre>
  54
+
# grab our current id, so we can filter the active person out
  55    gid = sdb.gid(person)
+
# of the data
  56
+
 
  57    # loop through each family in which the person is a child
+
gid = sdb.gid(person)
  58    for family in sdb.child_in(person):
+
 
  59
+
# loop through each family in which the person is a child
  60        # loop through each child in the family
+
for family in sdb.child_in(person):
  61        for child in sdb.children(family):
+
 
  62
+
    # loop through each child in the family
  63            # only display if this child is not the active person
+
    for child in sdb.children(family):
  64            if sdb.gid(child) != gid:
+
 
  65                sdoc.paragraph(__FMT % (
+
        # only display if this child is not the active person
  66                        sdb.name(child),
+
        if sdb.gid(child) != gid:
  67                        sdb.gender(child),
+
            stab.row(child,
  68                        sdb.birth_date(child)))
+
                    sdb.gender(child),
 +
                    sdb.birth_date(child))
 +
            document.has_data = True
 +
stab.write(sdoc)
 +
</pre>
  
 
Here, the easy access classes from the [[Simple Access API]] have been used to quickly achieve what we want.
 
Here, the easy access classes from the [[Simple Access API]] have been used to quickly achieve what we want.
  
 
==Example 2==
 
==Example 2==
A second example can be found in the GRAMPS code. See [http://gramps.svn.sourceforge.net/viewvc/gramps/trunk/src/plugins/quickview/all_events.py?view=markup all_events.py]. In this report, all events for a person are printed, and all events for a family. Two quick reports are hence registered, one for person, and one for family.
+
 
 +
A second example can be found in the Gramps code. See [https://github.com/gramps-project/gramps/blob/master/gramps/plugins/quickview/all_events.py all_events.py]. In this report, all events for a person are printed, and all events for a family. Two quick reports are hence registered, one for person, and one for family.
  
 
==Notes==
 
==Notes==
  
The possibilities are enormous. If you are an experienced hacker, there is no need to limit yourself to the simple database API. Also, if you make a real report, you can at the same time register a quick report with default settings.
+
The possibilities are enormous. If you are an experienced programmer, there is no need to limit yourself to the simple database API. Also, if you make a real report, you can at the same time register a quick report with default settings.
 +
 
 +
See: [https://github.com/gramps-project/gramps/tree/master/gramps/plugins/quickview  https://github.com/gramps-project/gramps/tree/master/gramps/plugins/quickview]
  
 
[[Category:Developers/General]]
 
[[Category:Developers/General]]

Latest revision as of 17:53, 7 July 2015

Quick Views (previously called Quick reports but show up in "Available Gramps Update for Addons" as Quickreport) are reports that are available in the context menu's of person, family, ...

They are easy to make by users, even with limited coding knowledge.

Quick View context menu on Person Editor

Introduction

Many users want to produce a report quickly for their specific needs, but are hindered by the fact they do not want to learn python fully, nor the intricacies of a complicated program like Gramps.

For them, starting in Gramps 3.0 a new tool has been constructed: the Quick Views. These reports are short textual reports that the user can register with Gramps, so they automatically appear in the context menu's.

Accompanying this, a simple database access and simple document interface has been constructed, so as to hide as much complexity as possible.

Where to store my quick report

A quick report is one single file. You can store it in your plugins directory. Go into your home folder and go to the hidden directory .gramps. In this directory you will find the plugins directory. Just add your plugin there, and it will appear within Gramps.

For the terminal users, you can get there as follows:

cd ~/.gramps/grampsxx/plugins

Example 1

Code

Quick View context menu on Person View
Quick View Report example result output

How better than to learn something than using an example?

Here it goes. We want a report to show all siblings of a person.

That is, brothers and sisters from all families the person is part of.

The quick report is then the following:


Create a python file named Siblings.py and add the following content:

Gramps-notes.png
This page's factual accuracy may be compromised due to out-of-date information. Please help improve the Gramps Wiki as a useful resource by updating it.
#------------------------------------------------------------------------
# File: Siblings.py
#------------------------------------------------------------------------

from gramps.gen.simple import SimpleAccess, SimpleDoc
from gramps.gui.plug.quick import QuickTable
from gramps.gen.ggettext import gettext as _

def run(database, document, person):
    """
    Loops through the families that the person is a child in, and display
    the information about the other children.
    """

    # setup the simple access functions
    sdb = SimpleAccess(database)
    sdoc = SimpleDoc(document)

    # display the title
    sdoc.title(_("Siblings of %s") % sdb.name(person))
    sdoc.paragraph("")

    # grab our current id, so we can filter the active person out
    # of the data

    gid = sdb.gid(person)


    stab = QuickTable(sdb)
    sdoc.header1(_("Siblings"))
    stab.columns(_("Person"), 
                 _("Gender"), 
                 _("Date"))

    # loop through each family in which the person is a child
    for family in sdb.child_in(person):

        # loop through each child in the family
        for child in sdb.children(family):

            # only display if this child is not the active person
            if sdb.gid(child) != gid:
                stab.row(child,
                        sdb.gender(child),
                        sdb.birth_date(child))
                document.has_data = True
    stab.write(sdoc)

You will also need a Gramps registration file:

#------------------------------------------------------------------------
# File: Siblings.gpr.py
#------------------------------------------------------------------------

register(QUICKREPORT, 
    id    = 'siblings',
    name  = _("Siblings"),
    description =  _("Display a person's siblings."),
    version = '1.0',
    gramps_target_version = '4.1',
    status = STABLE,
    fname = 'siblings.py',
    authors = ["Donald N. Allingham"],
    authors_email = ["don@gramps-project.org"],
    category = CATEGORY_QR_PERSON,
    runfunc = 'run'
  )

Analysis: registering the report

Let's analyse the above. We start at the bottom where the report is registered with register. This is the function Gramps will look for in your file. You need to give:

  • name = a unique name: a name Gramps identifies the plugin with, don't use spaces or strange symbols.
  • category = a special constant indicating where the report will be shown. You can use CATEGORY_QR_PERSON to see the report on person editor and view, or CATEGORY_QR_FAMILY to see the report on family editor or view.
  • run_func = the function you create in this plugin and that Gramps will execute when the user selects your quick report in the menu
  • translated_name = the name of the report as it will appear in the menu
  • status = is your report Stable or Unstable. Not used at the moment. On distributing Gramps we only include stable reports.
  • description = a description of what your plugin does. This appears in a tooltip over the menu
  • author_name = your name
  • author_email= your email, so people can congratulate you with your work, or ask for bug fixes...

Analysis: the run function

If the user clicks in the quick report menu on your report, the run function is executed with three parameters:

run(database, document, person)

So, your report received from gramps the database on which to work, the document on which to write, and the person of the object the user is on. For a person quick report, this is a person, for family, a family.

In this example, the function called is

def run(database, document, person):

Analysis: accessing the data

Now that your plugin runs, you need to open the database, start the document, access data, and write it out. We do this using the Simple Database API. So,

# setup the simple access functions
sdb = SimpleAccess(database)
sdoc = SimpleDoc(document)

prepares everything. Then we write a title on the document, an empty line under it, and a header, with the title, paragraph and header function:

# display the title
sdoc.title(_("Siblings of %s") % sdb.name(person))
sdoc.paragraph("")

Note that we use _ for every string for translation, which comes from the line:

from gramps.gen.ggettext import gettext as _

Everything is set up, now we write out the lines with all the siblings, leaving out the active person himself, as he is in the title field!

# grab our current id, so we can filter the active person out
# of the data

gid = sdb.gid(person)

# loop through each family in which the person is a child
for family in sdb.child_in(person):

    # loop through each child in the family
    for child in sdb.children(family):

        # only display if this child is not the active person
        if sdb.gid(child) != gid:
            stab.row(child,
                     sdb.gender(child),
                     sdb.birth_date(child))
            document.has_data = True
stab.write(sdoc)

Here, the easy access classes from the Simple Access API have been used to quickly achieve what we want.

Example 2

A second example can be found in the Gramps code. See all_events.py. In this report, all events for a person are printed, and all events for a family. Two quick reports are hence registered, one for person, and one for family.

Notes

The possibilities are enormous. If you are an experienced programmer, there is no need to limit yourself to the simple database API. Also, if you make a real report, you can at the same time register a quick report with default settings.

See: https://github.com/gramps-project/gramps/tree/master/gramps/plugins/quickview