User:Sam888

From Gramps
Jump to: navigation, search

Volunteer Website Administrator

Manage and monitor the website (not Github)

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

My attempt at 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 [Review]Gramps Help button User Manual wiki-links (In progress)

Update for Gramps 5.0

Gramps 5.0 User manual

Update (almost) all images
  • Started: 2017-12-13
  • Completed: 2018-01-13

Remaining 10 image links:


Update and improve text to match the interface
  • Started: 2018-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 20180706 #################
************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.
[](Bug# )image metadata gramplet - does not show metadata? (ms-windows / linux ) check why later then update user manual image with example. otherwise report it.
[] "Suppress warning about missing researcher when exporting to GEDCOM" checkbox does not work?
[](Bug# )pedigree chart view - two charts look wrong compared to 4.2.6 check later(need to check again) -
  * vertical and down
  * vertical and up
[]( )for web calendar report:
* (Bug#)Attempting to load the index.html file shows a title page called "My Family Calendar" and generated by gramps" but no links to the individual months?
* (Bug#)"Year at a glance": fullyearlinked.html  does not work. clicking on a month only works and not a day as mentioned on page:
"This calendar is meant to give you access to all your data at a glance compressed into one page. Clicking on a date will take you to a page that shows all the events for that date, if there are any."

%%%%%%%% Help related bugs
[](Bug# )when you use the help button for "Generate_Testcases_for_Persons_and_Families" it disapears.
https://gramps-project.org/wiki/index.php?title=Gramps_5.0_Wiki_Manual_-_Tools#Generate_Testcases_for_Persons_and_Families

[](Bug# )pressing the help button on "Books"  "Generate Book" dialog  dismisses the dialog and opens help to the wrong section (non existent).
https://gramps-project.org/wiki/index.php?title=Gramps_5.0_Wiki_Manual_-_Reports#Generate_Book

should be:
https://gramps-project.org/wiki/index.php?title=Gramps_5.0_Wiki_Manual_-_Reports_-_part_3#Generate_Book_dialog

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

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

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

[](Bug# )for the "filter" gramplets can we name each one (shown on Title bar when detached) and provide working help link (then update screenshots and link to wiki)
...........................
************Papercuts - Enhancements******************
[](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)
[]( )for web calendar report:
* (feature)on the individual month pages the "< & >" arrows are above the month name and not on either side
[](Feature/Bug# )edit preferences "base path for media" "{GRAMPS_RESOURCES}/example/gramps" setting "{GRAMPS_RESOURCES}" from the example.gramps does not work on MS_Windows! How about Apple Mac?
[] (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.0_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)
[] context menu's (right click) add an entry for "Help" at the bottom of each?
[] how do we get text under icons on the toolbar? (for usability)
[] 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!)
[] "Select a Map Service" button list does not indicate which one has been selected. (have a radio button next to it?)
[] "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: manaully type in a non existant file path and run the report.

@@@@@@@@@@@@@@User manual@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
[] 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 waist a translators time) as well as the overhead of maintaining the mediawiki!
[] Note that page 20 ( Gramps_5.0_Wiki_Manual_-_Reports_-_part_1 ) will be merged to ( Gramps_5.0_Wiki_Manual_-_Reports ) later as Gramps code needs to update for all subsequent pages!!)
[] add documentation section about "Active Person"  / " Home Person"  to user manual
[] 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 depencies/prerequisites (so that addons that share prerequisites import the same library?) (maybe move spell check into an addon etc? tip of the day... possibilites...)

depends_on = ["libwebconnect"]

mentioned in the following
http://gramps.1791082.n4.nabble.com/addon-importing-function-from-plugin-td3308398.html#a3308695
''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']

..............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 apendix 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.0_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. 
[] update url's from http to https where possible eg:  gramps/gen/config.py see: 
register('behavior.web-search-url', 'http://google.com/#&q=%(text)s')
[] 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.
[] for Graphview addon change defaults to show at least 3 generations of ancestors and reduce the descendants to 7
[] "Birthdays Gramplet Gramplet"  repeated in title
[] PedigreeChart help url addon goes to
https://gramps-project.org/wiki/index.php?title=Gramps_5.0_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.
[] editexifmetadata addon may not work (checked on windows)
[ ] "Date Calculator Gramplet" issue with the entry fields being collapsed and you need to expand and detach the addon.  Instruction Text does wrap in entry fields.
...........................................................
[] Add help url to context menu'same
    [] dashboard (grampletview)  when no database is loaded especially!  be able to popup context menu showing "About Dashboard"
    good reason why is issue https://gramps-project.org/bugs/view.php?id=10594
    [] each of the seven(7) geography views
    [] chart views
            [] pedigree view
            [] 2 way fan chart
            [] fan chart (ancestors)
            [] descendant fan chart
    [] each of the "list" & "grouped list" views"
            [] when empty
    [] add gramplet dropdown for each sidebar & bottombar
    [] category drop down under navigator?
.............................................................
[] htree - cherry-pick changes to addon-source master
[] for the following addons, add a context menu entry for "About: Addon name"
        [x] htree  (TODO[]change name to ancestor grid?)
        [x] Timeline pedigreeview
        [x] graph view
        [x] quilt view
[] 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
.........................................................
[] denominoviso - still creates report but show the following:

2018-02-24 13:40:48.275: WARNING: _enumeratedlist.py: line 143: Value 'Publishable' not found for option 'Source reference attribute'
2018-02-24 13:40:48.275: WARNING: _enumeratedlist.py: line 144: Valid values: []
2018-02-24 13:40:48.290: WARNING: _enumeratedlist.py: line 143: Value 'Publishable' not found for option 'Source reference attribute'
2018-02-24 13:40:48.290: WARNING: _enumeratedlist.py: line 144: Valid values: []
............................................................
[] calculate estimated dates:

** Only issue I could spot had nothing to do with your changes ( https://github.com/gramps-project/addons-source/pull/114 ).  When you  try to expand out the **Select** tab the result section does not fill all the space. 

** If you run the older version over the database and then install the newer version you get the following when run:

166745: ERROR: grampsapp.py: line 143: Unhandled exception
Traceback (most recent call last):
  File "C:\Program Files\GrampsAIO64-5.0.0-alpha3\gramps\gui\plug\_windows.py", line 805, in on_ok_clicked
    self.run() # activate results tab
  File "C:\Users\me\Documents\gramps-test-profile\gramps\gramps50\plugins\CalculateEstimatedDates\CalculateEstimatedDates.py", line 270, in run
    source = self.db.get_source_from_handle(source_handle)
  File "C:\Program Files\GrampsAIO64-5.0.0-alpha3\gramps\plugins\db\bsddb\read.py", line 696, in get_source_from_handle
    return self._get_from_handle(handle, Source, self.source_map)
  File "C:\Program Files\GrampsAIO64-5.0.0-alpha3\gramps\plugins\db\bsddb\read.py", line 680, in _get_from_handle
    raise HandleError('Handle %s not found' % handle)
gramps.gen.errors.HandleError: Handle c140d4ef77841431905 not found
...........................................................................
[] DetDescendantReport-images-error
71931: ERROR: _reportdialog.py: line 745: Failed to run report.
Traceback (most recent call last):
  File "C:\Program Files (x86)\GrampsAIO32-5.0.0-beta1\gramps\gui\plug\report\_reportdialog.py", line 706, in report
    my_report.write_report()
  File "C:\Users\me\Documents\gramps-test-profile\gramps\gramps50\plugins\DetDescendantReport-images\detdescendantreporti.py", line 322, in write_report
    self.write_person(key)
  File "C:\Users\me\Documents\gramps-test-profile\gramps\gramps50\plugins\DetDescendantReport-images\detdescendantreporti.py", line 418, in write_person
    self.write_person_info(person)
  File "C:\Users\me\Documents\gramps-test-profile\gramps\gramps50\plugins\DetDescendantReport-images\detdescendantreporti.py", line 753, in write_person_info
    self.write_images(person.get_media_list())
  File "C:\Users\me\Documents\gramps-test-profile\gramps\gramps50\plugins\DetDescendantReport-images\detdescendantreporti.py", line 954, in write_images
    media = self.database.get_object_from_handle(media_handle)
AttributeError: 'DbBsddb' object has no attribute 'get_object_from_handle'
..........................................................................
[]Using Family - overview gives:


26568: ERROR: grampsapp.py: line 143: Unhandled exception
Traceback (most recent call last):
  File "C:\Program Files (x86)\GrampsAIO32-5.0.0-beta1\gramps\gui\widgets\grampletbar.py", line 532, in __add_clicked
    self.add_gramplet(gname)
  File "C:\Program Files (x86)\GrampsAIO32-5.0.0-beta1\gramps\gui\widgets\grampletbar.py", line 306, in add_gramplet
    self.dbstate, self.uistate)
  File "C:\Program Files (x86)\GrampsAIO32-5.0.0-beta1\gramps\gui\widgets\grampletpane.py", line 177, in make_requested_gramplet
    getattr(module, opts["content"])(gui)
  File "C:\Program Files (x86)\GrampsAIO32-5.0.0-beta1\gramps\gen\plug\_gramplet.py", line 73, in __init__
    self._db_changed(self.dbstate.db)
  File "C:\Program Files (x86)\GrampsAIO32-5.0.0-beta1\gramps\gen\plug\_gramplet.py", line 400, in _db_changed
    self.update()
  File "C:\Program Files (x86)\GrampsAIO32-5.0.0-beta1\gramps\gen\plug\_gramplet.py", line 300, in update
    self.update_has_data()
  File "C:\Users\me\Documents\gramps-test-profile\gramps\gramps50\plugins\Overview\Overview.py", line 201, in update_has_data
    active = self.dbstate.db.get_family_from_handle(active_handle)
  File "C:\Program Files (x86)\GrampsAIO32-5.0.0-beta1\gramps\plugins\db\bsddb\read.py", line 736, in get_family_from_handle
    return self._get_from_handle(handle, Family, self.family_map)
  File "C:\Program Files (x86)\GrampsAIO32-5.0.0-beta1\gramps\plugins\db\bsddb\read.py", line 680, in _get_from_handle
    raise HandleError('Handle %s not found' % handle)
gramps.gen.errors.HandleError: Handle  not found
..........................................................................
[ ] 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
Gramplet does not work ( Needs converting from pyexiv2 to GExiv2. (Was originally included in Gramps 3 and earlier) )

    2018-04-02 10:33:07.872: WARNING: _manager.py: line 295: Plugin error (from 'editexifmetadata'): No module named 'pyexiv2'
..........................................................................
https://gramps-project.org/wiki/index.php?title=Addons_Status
..........................................................................
https://gramps-project.org/wiki/index.php?title=Gramps_5.0_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.
...................................................................
[](feature)  For plugins/addons if prerequistes not available display a page stating why/what is missing that includes the addon description and a url to the support page.
...................................................................

Reports

Gramps Developer Documents

In the sphinx format:

On wiki:

See also:

Information