My first gramplet - "Historical Context" for gramps 5.2

kmikkels · November 3, 2024, 2:00pm

Sure, that was my intention, but on a note at my pull request, CallMeDave asked me to link to the wiki. I am happy to leave it as it is.

emyoulation · November 3, 2024, 2:39pm

Great. I’ll be happy to create the wiki landing page once you decide it is ready for release.

Until then, please continue to tweak the README.md in your repository.

You can create a 2nd (commented out) help-url line in the .gpr.py file that points at “Addon:Historical_Context”

That will show the future intended target

GaryGriffin · November 3, 2024, 4:01pm

Not sure I am following. Shouldnt the help be set up before publishing? I was getting ready to publish this gramplet given the reviews that have already happened.

emyoulation · November 3, 2024, 8:36pm

While a gramplet is in development and evolving quickly, it is better to have the help_url point at the developer’s GitHub Repository.

It is easier to update images in the GitHub markdown than the MediaWiki. (We have not purged old screen captures in MediaWiki. I do not even know if that is possible unless you are an Admin.) And the developer has complete control of the README.md file.

It really doesn’t matter if it points to GitHub and not the wiki.

I have pushed for a wiki page in the past when a Developer has not written any documentation or isn’t comfortable writing user docs. Since Kaj already had a https://github.com/kajmikkelsen/TimeLineGramplet/blob/master/README.md file, that does not play into this Gramplet.

GaryGriffin · November 3, 2024, 10:18pm

My point is more about needing a PR to change the help_url pointer. Editing the contents of the help is a wash, I assumed. Creating a PR to update the gpr for the help_url pointer seemed overkill. Versus having it correct on initial merge.

kmikkels · November 4, 2024, 10:37am

Could we have a compromise?
@emyoulation : create a wiki landing page, but the only content is a redirect to my github page?
@GaryGriffin this way I could make the link to the wiki, before my pull request is approved?
Not sure about how redirects works on wiki pages, only tried in plain HTML code

kmikkels · November 4, 2024, 10:57am

Did the following changes to the branch:
Changed the README.md to be more userfriendly.
Added colous for foreground and background to the options menu
Various minor changes to comply with pylint
Changed status to stable
Updated teemplate.pot to reflect changes in the python code
Changed MANIFEST so the pictures in README.md will be distributed
So now I only need a decision for the help link

emyoulation · November 4, 2024, 3:22pm

The preliminary page to support help_url="Addon:Historical_Context" now exists:
https://gramps-project.org/wiki/index.php/Addon:Historical_Context

My pushback was not trying to be an obstructionist. I am trying to build a transclusion template for creating the MediaWiki components to support a new Addons in the wiki. (Similar to the Template:How_do_I transclusion template to flow in an outline for a “How Do I…?” Gramps tutorial article.) And I was hoping to test it with this addon.

But… back to pushing this addon into the gramps-project/addons-source repository. There hasn’t been any feedback to the renaming from “Timeline Gramplet” to “Historical Context”.

And that needs to be finalized (the repository needs to be renamed) before pushing it to the “addons-source”. Otherwise, it becomes another instance where it is too convoluted to find the right source code to experiment upon before suggesting a patch. And the .tgz file mentioned in the Addon List will have a mismatching name to the title of the gramplet. (Kaj has already renamed the .py and .gpr.py files.

It is premature to publish this addon.

Plus, it would be helpful to document the workflow of getting an Addon published through non-traditional channel.

kmikkels · November 4, 2024, 3:51pm

I understand and agree. The only place HistTimeLine is used is in my own repository, if you look in the addons-source branch, it is already chaanged.
Do I need to change my own repository as well?
If it helps I surely will do so. - thinking about it, I will do it anyways
As always: Thanks for your feedback and your commitment.

emyoulation · November 4, 2024, 10:57pm

4 posts were split to a new topic: Workflows for publishing Addons and updates

kmikkels · November 5, 2024, 6:51am

Now I have mirrored the kajmikkelsen/HistTimeLine repo to GitHub - kajmikkelsen/HistContext: A python gramplet for the gramps genealogy software, which will show historical events in the sidebar
The original repo has been archived.
And the branch in addons-source in the gramps project is holding the same files.

emyoulation · November 5, 2024, 7:04am

Wiki page links changed to https://github.com/kajmikkelsen/HistContext

emyoulation · November 8, 2024, 3:55am

Do you want to look at some examples of having color swatches (to complement your text fields) in the Configuration options? (Screen capture from your README.md file if others want to look up the red notations.)

The All Known Places Geography view has an extra Configure tab for color selectors.

github.com

gramps-project/gramps/blob/8ca2326523ca3093c3a07c0182804f2ad8c5cb00/gramps/plugins/view/geoplaces.py#L588


      
              Center the map on latitude, longitude.
              """
              self.set_center(None, None, lat, lon)
          
          def get_default_gramplets(self):
              """
              Define the default gramplets for the sidebar and bottombar.
              """
              return (("Place Filter",), ())
          
          def specific_options(self, configdialog):
              """
              Add specific entry to the preference menu.
              Must be done in the associated view.
              """
              grid = Gtk.Grid()
              grid.set_border_width(12)
              grid.set_column_spacing(6)
              grid.set_row_spacing(6)
              configdialog.add_color(grid, _("Unknown"), 1, "geography.color.unknown", col=1)
              configdialog.add_color(grid, _("Custom"), 2, "geography.color.custom", col=1)

from gramps.gen.config import config

github.com

gramps-project/gramps/blob/master/gramps/gui/configure.py#L515


      
              lwidget = BasicLabel(_("%s: ") % label)  # needed for French
              entry = Gtk.Entry()
              entry.set_text(str(config.get(constant)))
              entry.set_tooltip_markup(helptext)
              entry.set_hexpand(True)
              if callback:
                  entry.connect("changed", callback, constant)
              grid.attach(lwidget, col_attach, index, 1, 1)
              grid.attach(entry, col_attach + 1, index, 1, 1)
          
          def add_color(self, grid, label, index, constant, config=None, col=0):
              """
              Add color chooser widget with label and hex value to the grid.
              """
              if not config:
                  config = self.__config
              lwidget = BasicLabel(_("%s: ") % label)  # needed for French
              colors = config.get(constant)
              if isinstance(colors, list):
                  scheme = config.get("colors.scheme")
                  hexval = colors[scheme]

kmikkels · November 8, 2024, 8:37am

That look interesting, and I will see if I can implement.
But I think it will have to wait until next release.
You are a never ending source of great ideas and advice!

emyoulation · November 8, 2024, 12:19pm

Or I may just be “full of it”.

kmikkels · November 8, 2024, 2:09pm

Took me also some time to figure out that a MANIFEST file is simply a file called MANIFEST
And that it shouldn’t just have the names of the files you want to add to the application, but addon-directory/file.nam

emyoulation · November 8, 2024, 2:21pm

I haven’t found Gramps functionality that uses a MANIFEST. But recall seeing multiple places that recommended avoiding them.

kmikkels · November 8, 2024, 2:25pm

So to (ab)use your knowledge more.
I have implemented (not committed) the persistent way of storing options.
Is there a standard/recommended way to enter an options window, or is it OK, as I do using the views option to do it?
I have seen it my way, having a toolbar at the top of the gramplet or having a button “somwhere” in the gramplet

kmikkels · November 8, 2024, 2:26pm

I quote from the wiki (Addons development#Package your addon):

Starting with Gramp 5.0, if you have additional files beyond those listed above, you should create a MANIFEST file in the root of your addon folder listing the files (or pattern) one per line, like this sample MANIFEST file:

emyoulation · November 8, 2024, 3:04pm

Hmm. That reads like it is how the Make.py decides what to include in its .tgz archive used by the Addon Manager.

The docs say it includes all Text (*.txt) files by default. So that might cause a difficulty with the custom_v1_0.txt overwriting customized files during updates.

Maybe that repository file should be renamed with a .csv extension? Users would still be provided a well-named template to adapt.

Topic		Replies	Views
Branch bug-0013498 created, and made a pull request HistContext Development third-party-addon	34	144	January 2, 2025
Historical events or facts into Timelines with Gramps? Genealogy timeline	25	2264	January 26, 2025
Plans to Update Forms Addon Over the 2024 Summer Development third-party-addon , data-import	215	2524	April 7, 2025
Roadmap for v5.3 (correction: 6.0) Roadmap	113	2396	June 28, 2025
Add a "Recent" sub-menu Ideas hacks	94	1153	April 1, 2025

My first gramplet - "Historical Context" for gramps 5.2

Related topics