User:Eduralph/Sandbox/Gramps 6.0 Wiki Manual - Addon Development - Roadmap
Contents
Overview
Forward-looking view of the addon-development surface — what's planned, what's in flight, what's slated for deprecation, and what open questions will eventually become rules. The audience is an addon author asking "what do I need to plan around?"
This page is the prospective counterpart to What's new, which is retrospective. An item moves from this page to What's new once it ships in a release.
How to read this page
Each entry should answer four things:
| Field | Meaning |
|---|---|
| Status | proposed / accepted / in-flight / shipped / deferred / rejected |
| Target | Gramps version (6.1, 6.2, ...) or "unscheduled"
|
| Impact | what addon authors need to do (rewrite / opt-in / nothing) |
| Tracking | PR / Mantis bug / wiki RFC / mailing-list thread |
A roadmap entry without a tracking link is a wish, not a plan; either add the link or move the entry to a separate "ideas" section.
In flight
- none recorded yet
Accepted but not yet implemented
- none recorded yet
Deprecations and removals
- none recorded yet
Open questions
- none recorded yet
Deferred / rejected
- none recorded yet
Documentation roadmap
The doc set itself is in flight. Pages with managed: false front-matter are draft stubs and will not appear in published output until promoted. Current draft state — flip to managed: true page by page as content lands:
Publishing-pipeline conventions (now supported)
What md2wiki.py and md2pdf.py handle as of 2026-05-30 — pages authored with these conventions render correctly in both wikitext and PDF output. Verified by running both pipelines on Gramps 6.0 Wiki Manual - Addon Development - Fundamentals (which contains an SVG embed + Obsidian-internal links).
| Convention | Where converted | Notes |
|---|---|---|
!cap Obsidian embed
|
mdcommon.convert_obsidian_embeds
|
Becomes  before pandoc
|
Page / label Obsidian-internal link
|
mdcommon.convert_obsidian_internal_links
|
Resolved via mdcommon.build_title_map (filename-stem → wiki title); unresolved targets error loudly
|
| Markdown image with SVG src in PDF | _preconvert_svgs (md2pdf)
|
Pre-converted to PDF via rsvg-convert or inkscape; embeds natively in xelatex
|
| Markdown image with relative path in PDF | --resource-path to pandoc
|
Resolved against the source file's directory |
File:Media/foo.svg post-pandoc wikitext
|
mdcommon.basenameify_file_refs
|
Becomes File:Foo.svg (MediaWiki's File: namespace is flat)
|
| Media files alongside pages | wikitransport.upload_if_changed + publish.upload_media_for
|
SHA-1 dedup; uploaded BEFORE the page edit so refs never render red |
| HTML comments | mdcommon.stash_html_comments
|
Stashed around Obsidian preprocessors so syntax inside comments is not rewritten |
What the pipeline already handled before these additions:
label→ wikitextlabel/ PDF anchor or external URL.Template:...template shims → rawTemplate:...wikitext / dropped from PDF.- YAML front-matter →
title,categories,managed. - Fenced code with language tags, tables.
Page-by-page draft state
- Gramps 6.0 Wiki Manual - Addon Development - Tutorials — needs each tutorial fleshed out, or split into one page per addon kind.
- Gramps 6.0 Wiki Manual - Addon Development - Addon Kinds — needs the per-kind register-fields, base classes, and lifecycle hooks filled in.
- Gramps 6.0 Wiki Manual - Addon Development - Fundamentals — needs each topic bullet promoted to an H2 with worked examples.
- Gramps 6.0 Wiki Manual - Addon Development - Data access — needs worked examples for each API touch-point.
- Gramps 6.0 Wiki Manual - Addon Development - API Reference — needs synchronisation against
gramps/gen/__init__.pyon the maintenance branch this doc set targets. - Gramps 6.0 Wiki Manual - Addon Development - Testing — fold in Addon Testing Guidelines and retire the preliminary note.
- Gramps 6.0 Wiki Manual - Addon Development - Debug, Gramps 6.0 Wiki Manual - Addon Development - Troubleshoot, Gramps 6.0 Wiki Manual - Addon Development - Code Analysis, Gramps 6.0 Wiki Manual - Addon Development - Packaging, Gramps 6.0 Wiki Manual - Addon Development - Compatibility, Gramps 6.0 Wiki Manual - Addon Development - What's New — all outline-stage; need entries.
- Gramps 6.0 Wiki Manual - Addon Development - Rules — substantive; pending sign-off to flip to
managed: true.
(For the publishing pipeline itself — publish.py, md2wiki.py, md2pdf.py --tree — see the testbed root, not this page.)
See also
- What's new — retrospective counterpart.
- Compatibility — porting guidance once an item ships.
- Mantis bug tracker — feature requests and design discussions originate here.
- Gramps mailing lists — where larger design questions get hashed out.
|
This article's content is incomplete or a placeholder stub. |