User:Sam888

From Gramps - Free Genealogy Software
Jump to: navigation, search

Hi, I generally aim to help the developers who can program; I do alot of non-development work for the Gramps project including: testing and bug triage, website maintenance, writing and updating documentation on the wiki for new releases, building the third party addons as needed.

Volunteer Website Administrator

Manage and monitor the website (not Github)

Discourse Trial

Investigate replacing the mailing list on Sourceforge and trial using Discourse at https://gramps.discourse.group/

Migration from sourceforge mailing list

Things to do

Addons

Bug Triage

Unofficial bug triager.

Cleanup Started: 201409 Completed 20150523 with life in between...

Gramps Bugtracker: https://gramps-project.org/bugs/

CI Test

Improving CI

Coverage

Gramps User Manual

The Gramps User manual is a mix of the following:

  • Reference manual
  • User guide
  • Tutorials (how to?)
  • 8888 / 9042 / 10919 [Review]Gramps Help button User Manual wiki-links (In progress)

Update for Gramps 5.1

Gramps 5.1 User manual

Ensure that any new functionality is covered by user documentation.

Update (almost) all images
  • Started: 2019-0x-xx
  • Completed:

Remaining 10 image links:


Update and improve text to match the interface
  • Started: 2019-0x-xx
  • Completed:

also manually test all user accessible parts of Gramps (done as part of above two)

Notes on User manual update

Notes on various regressions, papercuts and annoyances noticed during the user manual update.

When I have time, issues and feature request will be created for the following if required.

#################### As at 20191107 #################
************Bugs**************************************
[](Bug# )graphical reports - calendar - information overflows boxes (pdf) (ms-windows tested only)
[](Bug# )when you try to run "Extract Event Description" the "Undo history warning" dialog disappears behind The "Tool Selection" dialog (ms-windows only checked)
[](Bug# )Merge (people) dialog does not grow larger when you expand the "Detailed Selection" section out.

[] update url's from http to https where possible eg: [ https://github.com/gramps-project/gramps/blob/maintenance/gramps51/gramps/gen/config.py ] see: 
register('behavior.web-search-url', 'http://google.com/#&q=%(text)s')
URL_HOMEPAGE = "http://gramps-project.org/"
URL_MAILINGLIST = "http://sourceforge.net/mail/?group_id=25770"    <<<<<< change to : https://sourceforge.net/p/gramps/mailman/
URL_BUGHOME = "http://gramps-project.org/bugs"

%%%%%%%% Help related bugs
[](Bug# )[Fix user wiki - rename sections]encloses & enclosed by gramplets - help links goto:

https://gramps-project.org/wiki/index.php?title=Gramps_5.1_Wiki_Manual_-_Gramplets#Place_Enclosed_By

https://gramps-project.org/wiki/index.php?title=Gramps_5.1_Wiki_Manual_-_Gramplets#Place_Encloses

************Papercuts - Enhancements******************
%%%%%%%% All for Help finding improvement see issue 10919 %%%%%%%%%%%%%
[] context menu's (right click) add an entry for "Help" at the bottom of each? 
[] Add help url to context menu entry for "About: XXXXX" (as was done on addon views)
    [] Dashboard Category (grampletview)  ( gramps/gui/widgets/grampletpane.py : def _button_press( )
        [] Also show context menu ###>>> when no database is loaded! <<<###
           See https://gramps-project.org/bugs/view.php?id=10594
    [] Chart Category views
            [] 2 way fan chart
            [] fan chart (ancestors)
            [] descendant fan chart
    [] Each of the "list" & "grouped list" views
            [] Relationships Category view
            [] Families Category view
            [] Events View
            [] Citations List View
            [] Repository List View
            [] Media List View
            [] Notes List View
            [] People Category
                [] Tree View - Grouped People
                [] Tree View - People List View
            [] Places Category
                [] Places List View
                [] Places Tree View
            [] Sources Category
                [] Citation Tree View
                [] Sources List View
    [] Geography views
        [] All known places
        [] All known places for one Family
        [] Have they been able to meet ?
        [] All places related to Events
        [] All known places for one Person
            [] All known places for one person with graphical information (KML files)
        [] Every residence or move for a person and any descendants
        [] Have these two families been able to meet ?
    [] category drop down under navigator? (or change it to a context menu that you click in an empty section of the navigator section?)
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%...........................................................
[](Feature# )for the "filter" gramplets name each one (shown on Title bar when detached) and provide working help link (then update screenshots and link to wiki)
[](feature# )"Add Rule dialog": if you select a filter then select a top level category of filter" the right hand window shows random stuff from previous filters (suggest displaying a blank area only)

[] (Bug#) dashboard - order of default Gramplets is different on ms-windows  versus linux? eg: top [surnames|welcome] on win 10 - how do you guarantee order ( have a look at geography view icons on toolbar each time the views order is different, which does not help with keybindings!)

[] On each "autobackup/report/export assistant wizard/make backup xml/import/export view as..." options the "File Name:" location should default to the OS's home/documents & media directory  "~" [Linux/Mac OS/MS-Windows (C:\Users\<~username>\Documents) Media> (C:\Users\<username>\Pictures ) ]  eg:  Gtk.FileChooser.set_current_folder()
see recent issue where user overwrote report_settings.xml with a report on Macosx!

[] add a menu option under "Help" to "Open folder locations"? to aid with helping people for "user directory" etc "Media directory"  (see recent difficulty with finding user directory 
https://gramps-project.org/bugs/view.php?id=10370

[] For "Paper_Options" if the user is not in [Myanmar, Liberia, or the United States] and comes from a country that uses metric set paper to A4 automatically!
https://gramps-project.org/bugs/view.php?id=1703
https://gramps-project.org/wiki/index.php?title=Gramps_5.1_Wiki_Manual_-_Reports_-_part_4#Paper_Options

'''The International System of Units has been adopted as the official system of weights and measures by all nations in the world except for Myanmar, Liberia, and the United States, while the United States is the only industrialised country where the metric system is not the predominant system of units.'''
https://en.wikipedia.org/wiki/Metric_system#International_System_of_Units

[] text reports - Place Report  - use the active selected place by default and then allow people to change (keep it consistent with how other reports are.)

[] Graph report - Family Lines - consider having "People of Interest" tab first so it's obvious that something has to be selected / or bring this report in line with others so that the Active person is already selected at a minimum.

[] For each report determine what the optimal page settings are and use them as defaults

[] for each report be able to have separate settings per report for the page settings!

[] text reports- Database Summary Report - is not very useful as it does not name the "Family Tree" the summary is for or a date for reference.  and it's missing an actual summary of other information eg citation/repository's it can provide more information

[] text reports - "Records Report" is not very useful as it does not name the "Family Tree"  or the date produced

[] for clarity suggest adding the word "List" to the list views (this will make it easier to support people) (see my suggestion previous unmerged PR)

[] Make toolbar icons insensitive (grey them out) when not needed or available to use eg: empty list  

[] If the list view is empty, add a greyed out single (non select-able) entry that instructs the user to add to the list?

[] Tool Selection dialog - needs help button

[] when running a second instance of gramps if you attempt to open a family tree that's open in the first instance the break lock dialog should have an additional button option to open as read only.

[] "Books reports"  dialog change the name of the second section from "Current book" to Current book items" (aids in legibility of user manual!)

[] "Family Trees" Manager button (displays "Connect to a recent database" when you hover over it) Change it to "Connect to a recent  Family Tree"

[] "Family Trees" Manager - Archive (RCS) the "Revision comment" dialog should be renamed to "Archive version comment" and the label "Version description" should be the same?

[] No Menu option to add/delete/restore a Gramplet is available.

[] Gramps CLI info "gramps -v" needs a section that list third-party addons with version numbers and if prerequisites have been met.

[] keybinding on Categories only goes 0 to 9(citations) and we now have 13 categories :( So repositories/media/notes have no shortcut (maybe ctl+shift+<number> ?  ctl plus / minus?   [SM- ok: ctl + n = next category / ctl + p = previous category]

[] age on date gramplett - awkward wording on the resulting "quick view"

[] "Family Tree Manager" for the status column the status icons need tooltips or just use words

[] Sort Events tool has no feedback on completion!

[] narweb spelling of the tab "Html options" should be "HTML Options" to keep it consistent.

[] report options tabs issues with repeating names (due to tab reorganization!) think of better single word names!

[](feature# )For the "Web Reports" have the report test first that the file path to write to exist instead of attempting to generate the website and then after awhile failing!  eg: manually type in a non existent file path and run the report.

@@@@@@@@@@@@@@User [email protected]@@@@@@@@@@@@@@@@@@@@@@@@@@@@
[] Using a wiki for the user manual has already been shown that it does not make translating the manual any easier! (find a simpler way so as to not waste a translators time) as well as the overhead of maintaining the mediawiki!

[] Note that page 20 ( Gramps_5.1_Wiki_Manual_-_Reports_-_part_1 ) will be merged to ( Gramps_5.1_Wiki_Manual_-_Reports ) later as Gramps code needs to update for all subsequent pages!!)

[] geography view rename:
	* "The map" tab to "Map Common"
	* rename each of the tabs for the views so they either have the name of the view in full on the tab or the name appears as a text line.

[] @prculley Originally when I created that the "Add>New" menu I had intended for each option to initially switch to that particular list view and then present the editor and once the new item was created for it to be the active highlighted item in the list view, so that users could link the action they have taken with the result instead of having to search for it afterward? Do you know if this is or something similar is possible?

prcully>>(Almost) Anything is possible ;-)...   I'm pretty sure that would take some code to do both switch views (do whatever clicking on item on left side does) and then invoke Editor.  And then finally change active to new whatever.   Probably only four lines of code for each editor.

.................................................................................................
[] for addon prerequistes have a look at converting them to use "depends_on = "  like in the following addons
https://github.com/gramps-project/addons-source/search?utf8=%E2%9C%93&q=depends_on&type=
https://github.com/gramps-project/gramps/search?utf8=%E2%9C%93&q=depends_on&type=

which can be a comma separated list for multiple dependencies/prerequisites (so that addons that share prerequisites import the same library?) (maybe move spell check into an addon etc? tip of the day... possibilities...)

depends_on = ["libwebconnect"]

mentioned in the following
https://sourceforge.net/p/gramps/mailman/message/27070037/
''In your gpr file, you can have a line like:

depends_on = ["libwebconnect"]

which is a list of id's from other gpr files. This example will ensure
that libwebconnect is loaded before your plugin. If it can't be found,
or you have a cycle, then your plugin won't be loaded.

If it is a common function, perhaps libhtml is the right place to put
it, and you can put a depends_on on that.

-Doug''


example output is on terminal only:

Cannot resolve the following plugin dependencies:
   Plugin 'UK Web Connect Pack' requires: ['libwebconnect']

[](feature)  For plugins/addons if prerequisites not available display a page stating why/what is missing that includes the addon description and a url to the support page.

..............Unsorted................................
[] Only documented behavior should be supported. Ensure that clear documentation is a requirement for contributions enhancing Gramps (Part of the PR)

[] '''Configuration Files''' Add advanced appendix that mentions the assorted files eg: Custom filters (custom_filter.xml) and report setting (?.xml) and how they are not being backed up for migration and backup?  also ( recent-files-gramps.xml )  
see:
	* https://gramps-project.org/wiki/index.php?title=Gramps_5.1_Wiki_Manual_-_Reports_-_part_1
	Report Settings
	The settings chosen when generating a report is stored in the users profile, in .gramps/report_options.xml, and will be used as default settings when generating the next report. If there is a need to revert to the default options for any reason, this file can simply be deleted. 

############## Website admin ####################################
[] Godaddy Server resources issue: Appdata images!
https://gramps-project.org/wiki/index.php?title=Category:AppData
(Consider another location eg github! as still causing code:500 server errors)

############## Addons #################
[] Add on Graphical Report - Descendants Lines -Error writing to Output Stream  (turn off document options and make sure report defaults to the documents directory (reported a few times on the mailing list)  / also report defaults to png but is able to output svg according to the wiki help page.

[] PedigreeChart help url addon goes to
https://gramps-project.org/wiki/index.php?title=Gramps_5.1_Wiki_Manual_-_Reports#Pedigree_Chart
instead of:
https://gramps-project.org/wiki/index.php?title=PedigreeChart

[] PedigreeChart addon printing for PDF is poor eg look at the cut off title.

.............................................................
[] htree - cherry-pick changes to addon-source master

[] rebase "Timeline pedigreeview" on pedigreeview or visa versa?
.............................................................
[] FIX Timeline pedigreeview  & htree when I select "About" from context menu.

(gramps.exe:6340): Gtk-WARNING **: Can't set a parent on widget which has a parent
.........................................................
[ ] Pluginmanager (prculley)  also unlike the built in check for addons this one does not mention you need to restart gramps if you install a "gramps view" although it says it should on the addon wiki support page
..........................................................................
[] we don’t actually use SF for much any more and they’ve been having a lot of issues in the last couple of years maybe we should migrate the lists to Google Groups (jralls)
..........................................................................
https://gramps-project.org/wiki/index.php?title=Edit_Image_Exif_Metadata
* See: Future of Exiv2? (  https://github.com/Exiv2/exiv2/issues/1018 )
..........................................................................
https://gramps-project.org/wiki/index.php?title=Addons_Status
..........................................................................
https://gramps-project.org/wiki/index.php?title=Gramps_5.1_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_3#Attributes

Gramps has two dialogs called "Attribute Editor dialog" that look different but both collect the same info in the top section.

eg: from Source's attribute tab creating a new attribute.
........................................................
[ ] Some addons when building have the following warning:

Listed:          Graph View
GraphView/graphview.py:2383: warning: 'msgid' format string with unnamed arguments cannot be properly localized:
                                      The translator cannot reorder the arguments.
                                      Please consider using a format string with named arguments,
                                      and a mapping instead of a tuple for the arguments.

For solution see:
https://stackoverflow.com/questions/23405521/why-i-get-msgid-format-string-unnamed-arguments-warning-only-when-running-m

Which essentially say "To solve the problem, simply use named arguments"

my_string = "Hello %(person)s, it is %(time)s o'clock." % ({
    'person':'Foo', 
    'time':'two'
})

translated_string = "It is %(time)s o'clock, Mr. %(person)s" % ({
    'person':'Foo', 
    'time':'two'
})
...................................................................

Reports

Gramps Developer Documents

In the sphinx format:

On wiki:

See also:

User Experience Test Plan

Gramps Downloads (since: 2001/04/21)

The Gramps Project has broken the multi-million download milestone( Total: 2,140,634 as at 20190829 ).

This is not an indication of the active userbase.

  • [ ]Write up a blog post or wiki page or just leave here.
  • [ ]create an issue to hold the csv files.
  • [ ]create a Graph to plot downloads overtime.


Here is my attempt at gathering the statistics required to answer how many download to date.

The "User Base" - is the number of people who use a particular product or service, especially one available on the Internet


It is very difficult to estimate userbase as you get many different types of users

  • One time users who download and install Gramps and find it is not for them.
  • Long term users.
  • Alot of the downloads will be for users upgrading existing installations


Download Statistics commence from when the Gramps project started 2001/04/21.

A further break down of downloads is possible by (but I won't be doing that):

  • Supplied by project (Source code for manual installation)
  • Linux/OpenBSD etc
    • Supplied by volunteers to the project for download
    • Supplied by directly from the distribution website
  • Microsoft Windows
    • Supplied by volunteers to the project for download
    • Legacy version from portableapps.com
  • Apple MacOS
    • Supplied by volunteers to the project for download

Total: 2,140,634

Information gathered from the following sources that list download statistics from Links to website you can download gramps from:

Sourceforge: Downloads Total: 1,017,177 ( 2001-04-01 to 2019-08-01 )

Github: Total Downloads: 361,224

Portableapps.com: Gramps Portable Legacy 3.4.8  : Downloads: 733,238 (2005-10-01 to 2019-08-01)

Debian: Installations: 1051 (2004-01 to 2019-08)

  • https://qa.debian.org/popcon.php?package=gramps
  • Debian Popularity contest statistics for gramps (This only report Statistics for those that Opt-in to the reporting of the statistics. Usually reports the deliberate installation date for Gramps.

Majorgeeks: Direct from them Downloads: 6649 times

chocolatey.org: Downloads: 1785

softpedia.com: 6,079 downloads


bytesin.com: Downloads: 2,499

download82.com: Downloads: 604

chip.de: Downloads: 4,855

computerbild.de: Downloads: 7,694 (since 14.04.2015)

softonic.findmysoft.com: Downloads: 5472

cnet.com: Downloads: 951 https://download.cnet.com/developer/gramps-project


[ ] Possibly many other sites that host the Gramps files for downloads! In a lot of case a much older versions, I've attempted to contact the websites to update to the current version at least.

Information