Anyone know where to find the docs on the
new_addons.txt file used for managing Gramps Plugin Manager? In particular, how a new (or updated) addon is registered for inclusion? And the format spec?
And why does the file saved in the User Directory gramps51 folder have a slightly different format. (It adds spaces not found in the GitHub file. It also converts the backslashed single-quotes in strings to eliminate the backslashes and double-quotes the strings.)
Why am I asking?
It is difficult to keep the wiki documentation accessible for features in Gramps. Even when Users know the correct Feature name, the search gives WAY too many secondary hits from outdated version pages and other languages. (But at least you can change languages with a click & type the current version in the URL.) So having the feature listed identically to how hint & labels appear in the GUI is critical.
Unfortunately, most of the add-ons (particularly, Tools, Reports, Quick Reports, import/export, libraries & filter Rules) do not have a Help button. And many of those do not have a GUI element to get a rollover hint of the name. So the only way for Users to discover the name is through the Plugin Manager.
Gramps has no feature to export a list of addon names to use as a documenting checklist. (Or an exploration guide.) My assumption is that the label in the Plugin Manager (and Plugin Manager Enhanced) will always match the ‘n’ (name?) terms of each row in the
new_addons.txt file. So I decided to use that instead.
Manual harmonization is tedious and error prone. Worse, I just realized that translators will have to repeat the same exercise. They have to harmonize the translated wiki page to match the precise translations of the translated names of their addons.
The format of the add on file is not CSV. Which means it doesn’t lend itself to import to Excel for automated verification. (It primarily uses a comma as the delimiter. But it uses a colon as a secondary delimiter. While a single quote is mostly used to enclose strings that include the delimiters, it uses double quotes if the string includes single quote! and each row has an opening & closing curly braces. ARRGH!)
I had hoped to Parse the new_addons.txt and use that to generate a pastable replacement MediaWiki table. Figuring that if I automatically created a hotlink to the ‘v’ (version) value, that would create a Red (does not exist) hyperlink in the wiki table… indicating where the documentation needed to be reviewed & updated.
new_addon.txt lacks a lot of stuff: Help URL,Thumbnail URL, Use audience, rating, hotlinked contact.person. Several of the .gpr.py lines correspond to the fields in the addons.txt file… but not ALL of them.
So how do these various files correlate?