Documenting parsing API

Saw this old post. Are you still interested in these questions?

Some of these use the same underlying parser that is built into Gramps. For example, Dates in Data Entry Gramplet, Person Filter, and Date calculator all use the same parser. What kinds of things are you looking for?

The intent is to improve the wiki’s exposure of GUI options for parsing data. To allow users with no programming skills to find options.

AND… to help beginning developers find functional examples of parsing code (not pseudocode) so the can build their own tools.

For example, say that someone wants to build a form that takes a common obit header phrase to make a new person. (e.g., “John Smith Jones 1953 - November 23, 2024”) They might need examples of parsing a Name and a date range. And of creating a person object with 2 event objects

While talking to @kku , I realized that his Dates addon gramplet had a lot of date parsing example code and wasn’t included in the list. So that’s the addition to the posting.

1 Like

Still searching for an example of adding a common citation for object being created.

As an example of that obituary, I’d probably start with making a souce of the newspaper, a citation with the publication date and page, a secondary Note object with the transcription.

I’d like to use the Data Entry gramplet or the Import Text gramplet to rough in the person. But those either share a Source (no citation) or create a separate new blank citation for a common source. Either way, I still have to hand-edit each Citation.

1 Like

I see. One thing that would help would be links on the wiki pages for addons to the source code. It took me a while to find Dates

BTW, this also uses the dateparser. It might be nice to have an article on how to use it.

@Nick-Hall has a prototype tool to build an Template:Addon5.2 List for the wiki from the plugin registration and an idea for template to wrap around Addon wiki articles that could include a link to the source. (Similar to the template for WikiPedia’s plug-ins) But it requires the Lua plug-in. Unfortunately, something in our MediaWiki has been blocking @gramps-project from installing plug-ins. So rather than hand-tweak wiki pages for 149 addons and then have to remove those tweaks, I’m waiting for the wiki problem to be fixed.

After expanding the Dates gramplet subsection in the Isotammi wiki article, I discovered the help_url was incorrect and submitted a PR with a correction. @kku comitted the changes within hours but decided (in response to my feature request inspired by documenting) to tweak the gramplet a little before publishing an update.

One of the changes is that the “dateparser” step is being moved into a separate “Revalidate” option checkbox.

1 Like

Are you talking about a Sphinx article or a Wiki article?

There are 141 matches found when searching for dateparser in the Sphinx developer documentation for Gramps.

For the life of me, I cannot grok the Sphinx format for parameters. So I determine that the function exists in Sphinx, then search for working example code using that function name on GitHub.

Actually, I was thinking about the Gramps blog. But I see that no one has blogged an article since 2015 when some crazy guy posted about using Prolog and family trees :slight_smile:

I actually find github’s search better for these things.

1 Like

The WordPress silo is aging poorly.

It is easy to gain WikiContributor access for the MediaWiki. The wiki is in constant revision and has accessible (although excruciating) support for localization.

It is unclear how to become a WordPress editor. Or learn how to Blog. And there is ZERO support non-English visitors. The browsing path to localized vital content (downloads, localized user manuals) is non-existent from the domain landing page.

Nick recently provided guidance for contibuting content to the Sphinx system. And it is fenced off enough that only core team can effectively contribute. It is painful enough that those (overloaded) team members are unlikely to add docs (or “useful snippets”) to help new contributors.

1 Like

I adapted the MediaWiki information box for extensions. The simplified version still requires the TemplateStyles and ParserFunctions to run, but we have ParserFunctions installed already.

Someone else requested Lua, but I can’t remember the conversation.

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.