User:Sam888

From Gramps
Revision as of 05:40, 15 January 2018 by Sam888 (talk | contribs) (Addons)
Jump to: navigation, search

Things to do

Addons

Bug Triage

Unofficial bug triager.

Issue State - Gramps Bugtracker:

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 (On hold)

Update for Gramps 5.0

Gramps 5.0 User manual, update all images and improve text to match the interface, also to basically to manually test all user accessible parts of Gramps.

  • Started: 2017-12-13
  • Completed:
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 20180115 #################
************Bugs**************************************
[](Bug# )text reports - Ahnentafel report - only prints out active person (pdf) [ms windows & linux] (does not work in gramps 4.2.6) Or am I doing soemthing wrong?
[](Bug# )people export view to csv (changed to my documents directory and file named mnaually "filename.csv" ) gives the following

error1013219: ERROR: grampsapp.py: line 143: Unhandled exception
Traceback (most recent call last):
  File "C:\Program Files\GrampsAIO64-5.0.0\gramps\gui\views\listview.py", line 1049, in export
    self.write_tabbed_file(fn, fl)
  File "C:\Program Files\GrampsAIO64-5.0.0\gramps\gui\views\listview.py", line 1088, in write_tabbed_file
    ofile.end_row()
  File "C:\Program Files\GrampsAIO64-5.0.0\gramps\gen\utils\docgen\csvtab.py", line 62, in end_row
    self.writer.writerow(self.dlist)
  File "AIO/encodings/cp1252.py", line 19, in encode
UnicodeEncodeError: 'charmap' codec can't encode characters in position 1-8: character maps to <undefined>

It creates an empty file that is held open by gramps until you exit.
[](Bug# )help button on "Select Father/Mother/Child/Events/Note/Select Media Object/Select a different person/ selectors" dismisses dialog and does not work!
[](Bug# )edit preferences "base path for media" "{GRAMPS_RESOURCES}/example/gramps" setting "{GRAMPS_RESOURCES}" from the example.gramps does not work on MS_Windows!
[](Bug# )graphical reports - calendar - information overflows boxes (pdf) on ms-windows tested only
[](Bug# )help button on "Family tree"(manager) dismises dialog and does not work!
[](Bug# )repeated use of the same icon for different views especially with addons loaded eg Charts three icons identical! can we use diffrent colors or a border/underline for third party addons? (simpliest answer if make more icons)
[](Bug# )when you use the help button for
https://gramps-project.org/wiki/index.php?title=Gramps_5.0_Wiki_Manual_-_Tools#Generate_Testcases_for_Persons_and_Families
it disapears.
[](Bug# )"Books reports"  "Manage Books" dialogs available items  list when opened shows the end of the list first instead of the highlighted  "Title Page" item entry (sitting unhelpfully just below the fold)
[](Bug# )"Books reports"   item "statistics report" generates an error on empty database
[](Bug# )pressing "help" on "Books"  "Generate Book" dialog  dismisses the dialog and opens help to the wrong section (non existant).
https://gramps-project.org/wiki/index.php?title=Gramps_5.0_Wiki_Manual_-_Reports#Generate_Book
[](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
[](Bug# )The "Undo history warning" dialog disapears behind the "Tool Selection" dialog when you try to run "Extract Event Description" (ms-windows only checked)
[](Bug# )report options tabs issues with repeating names (due to tab reorganisation!) think of better single word names!


[](Bug# )need to rename the wiki section and update gramps code to be "New Repository dialog" instead of "New_Repositor>ies< dialog"
https://gramps-project.org/wiki/index.php?title=Gramps_5.0_Wiki_Manual_-_Entering_and_editing_data:_detailed_-_part_2#New_Repositories_dialog
[](Bug# )Merge (people) dialog does not grow larger when you expand the "Detailed Selection" section out.
[](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)
[](Bug# )"Add Rule dialog"  two issues:
	* the search box does not stay at top of screen when you expand all filters!
	* if you highlight a top level category of filter" the right hand window shows random stuff from previous filters (suggest blank area only)
[](Bug# )encloses & enclosed by gramplets - help links fail
[](Bug# )Tool "Reorder_Gramps_ID" help link broken. https://gramps-project.org/wiki/index.php?title=Gramps_5.0_Wiki_Manual_-_Tools#manual|Reorder_Gramps_ID
[](Bug# )Tool "Reorder_Gramps_ID"  broken in alpha3  (need to check gramps50 )
[](Bug# )image metadata gramplet - does not show metadata? (ms-windows / linux ) check why later then update user manual image with example. otherwise report it.
[](Bug# )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.
[](Bug# )for web calendar report:
* 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?
* fullyearlinked.html  does not work.
* on the individual month pages the "< & >" arrows are above the month name and not on either side
[] See image: 2018-01-08 14_37_34-Export options-reordered-alignment issue of boxes in Export Assistant
[] "Suppress warning about missing researcher when exporting to GEDCOM" checkbox does not work?

.........Fixed bug.....................
[x] preview gramplet was renamed to "media preview" gramplet and help url changed to
https://gramps-project.org/wiki/index.php?title=Gramps_5.0_Wiki_Manual_-_Gramplets#Media_Preview

...........................
************Papercuts - Enhancements******************
[] dashboard - order of default Gramplets is different on ms-windows  versus linux? eg: top [surnames|welcome] on win 10 - how do you guarantee order ( hae a look at geography view 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()
[] 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 the USA and comes from a country that uses metric set paper to A4 automatically!
https://gramps-project.org/wiki/index.php?title=Gramps_5.0_Wiki_Manual_-_Reports_-_part_4#Paper_Options
[] 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 mininmum.
[] 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 summmary of other information eg citation/repositorys 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 sugggestion 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 insensative (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 selectable) 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 thats 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 prerequistes 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 consistant.

@@@@@@@@@@@@@@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.


..............Unsorted................................
[] Only documented behavior should be supported. Ensure that clear documentation is a requirement for contributions enhancing Gramps (Part of the PR)
[] advanced apendix that mentions. Custom filters (custom_filter.xml) and report setting (?.xml) 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. 
...........................
-----------------------------------
############## Addons #################
[] ClipboardGramplet no longer works between session (Add feature request to enhance the built in clipboard with these functions?) https://gramps-project.org/wiki/index.php?title=ClipboardGramplet
[] Add on Graphical Report - Descendants Lines -Error writing to Output Stream  (turn off document options and make sure report defaults to the docuemnts 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.
...........................................................

Reports

Gramps Developer Documents

In the sphinx format:

On wiki:

Information