doxa-maps/plugin-designs
Doxa Maps ae6d60780b Send the research map's live map to packet page 1 through the mapImage seam
Page 1 keeps the live map rather than a fetched sheet, and it was handed
across as a bare <img> in mapSvg — raw markup the renderer interpolates.
The page-1 redesign no longer draws that full page, so the map arrived
shrunk inside a layout built for a stored sheet. It reads as a styling
quirk rather than a wiring mistake, which is why it survived here after
country-posters was fixed. The URL now goes through mapImage, which places
it as the whole page.

This is the third defect of the same shape between these two files: a fix
lands in one twin and not the other, and nothing reports it. So the gate
asserts the seam for every host that rasterises a live map, rather than for
one file.

Two fixes to the check itself, both found by poisoning it rather than by
reading it. `[^)]*` cannot cross the arrow function's own parens, so
`useMapPoster(() => map.value).render(` never matched and the new section
skipped both files — it passed while testing nothing. And an older
assertion pinned the exact literal `{ mapSvg, variant }`, so moving to the
seam failed a check that was still describing the shape it replaced; it now
asserts that the variant travels, not the argument list it travelled in. A
gate that names one spelling of a call turns every refactor into a false
alarm, and a false alarm is how a real one gets waved through.

Both twins now use the seam. The render is skipped for a card deck, which
has no map page; this map's legend menu only asks for full or lightweight,
so that arm guards a future caller rather than a path taken today.
2026-09-29 07:31:17 +00:00
..
all-people-groups All People Groups: no DOXA group is drawn twice; the base is re-sent slim without them 2026-09-29 02:53:16 +00:00
big-picture Keep the reason, drop the speaker 2026-09-29 03:46:37 +00:00
cities-internet The embedded map drew 340px below its card, and said nothing for the 30s it took 2026-09-28 23:43:44 +00:00
country-map No country codes means no pins, not every pin on earth 2026-09-29 07:07:48 +00:00
country-posters Fix what an adversarial review of the print standard confirmed: 21 defects, each re-checked against the code 2026-09-29 06:23:19 +00:00
dashboard-plus-grid One phone flag per map, and the leaf page follows it as well as the Gallery 2026-09-29 07:31:16 +00:00
demo-map Five plugins were silently monolingual, because the bootstrap was copied sixteen times 2026-09-28 17:40:34 +00:00
doxa-maps-spa One phone flag per map, and the leaf page follows it as well as the Gallery 2026-09-29 07:31:16 +00:00
doxa-research-map Send the research map's live map to packet page 1 through the mapImage seam 2026-09-29 07:31:17 +00:00
doxa-simple-map Prayer Progress: the basemap colours' comment states the measurement instead of citing a folder outside the repo 2026-09-29 03:38:57 +00:00
doxa-vision-card Every Experimental map carries its own hosted ?, where its controls already are 2026-09-29 02:35:35 +00:00
golden-path-check golden-path-check finds its manifest from its own script, so it answers when embedded 2026-09-28 23:23:58 +00:00
gospel-internet One phone flag per map, and the leaf page follows it as well as the Gallery 2026-09-29 07:31:16 +00:00
gospel-resources Arabic readers get the language code, the link gap and the population column on the wrong side 2026-09-28 23:43:44 +00:00
key-cities Eleven plugin entries import the element helper they call 2026-09-28 17:40:35 +00:00
my-upg-100-list The generated sheets fetch their capitals and cities at print time, instead of every page bundling them 2026-09-29 06:23:20 +00:00
people-groups-grid The grid's "controls off" preset did nothing, and nothing said so 2026-09-28 22:25:30 +00:00
plugin-studio Plugin Studio keeps the reason and drops the speaker: its 15 references to the Driver reworded, comments only 2026-09-29 05:26:26 +00:00
pplr-data-maps PPLR Data Maps: on a phone the ten views are one select, and the prayer map's coach-mark stays off this research tool 2026-09-29 05:17:38 +00:00
prayer-walk-planner Prayer Walk Planner: on a phone the zone list opens from a ☰ Zones button instead of being hidden 2026-09-29 02:58:03 +00:00
regions-dashboard Translate the three poster-wall nouns the regions list was passing in English 2026-09-29 04:51:30 +00:00
research-dashboard Retire the last one-cycle re-export in the dashboard composables 2026-09-29 07:31:16 +00:00
research-map-plus-grid check:no-free-identifiers knows atob and btoa, the two base64 globals every browser and Node 16+ define 2026-09-29 06:32:21 +00:00
rudder-voice Dictation fell behind because our own build took every core 2026-09-29 05:26:25 +00:00
stack-demo Decouple prose: no go-base / nuxtbase / nuxtinator / doxa-base names in plugin comments and docs 2026-09-26 17:28:45 +00:00
template-bundle template-bundle: each screen carries its meta.json, so a copy of the starter is listed in the Plugin Studio 2026-09-29 02:01:33 +00:00
upg-neighbor UPG Neighbor: on a phone the list can be lowered to a bar and raised again 2026-09-29 07:22:57 +00:00
wall-of-people-groups Wall of People Groups: the store no longer downloads every photo in the background, and the dead source picker and old card are gone 2026-09-29 07:22:57 +00:00
.gitkeep Rename app-profiles -> plugin-designs; build green under new naming (load-bearing paths updated, guards pass) 2026-09-17 18:18:18 +00:00
README.md plugin-designs/README: the tree is dx-maps, and a bundle's tag is its folder name 2026-09-26 01:19:53 +00:00

plugin-designs/ — where YOUR maps live

The shared template lives in ../library/ (aliased @map) — you never edit it per-map. You build your map by making a folder here, plugin-designs/<your-map>/, and composing the template's building blocks. Your folder is yours (colors, API, i18n); the template is shared (Apache-2.0, propagated to every map on the next build).

Shared vs. yours — the balance

  library/  (@map)  ── SHARED, reusable, parameterized ──►  legend · map · map-controls
        │                                                    (every map reuses these)
        │  imported by
        ▼
  plugin-designs/<your-map>/  ── YOURS ──►  the map's "main" class (the .vue profile = the Vue
        │                                  instance for that map)
        └── src/            ── YOURS ──►  this map's OWN non-reusable components, colors, API, utils

  One bundle can hold as many maps as you want — add another .vue profile and rebuild.
  • Reusable → library/. The legend, the map, the map-controls are shared, parameterized components every map reuses. Fix once, every map benefits. Never edit it to customize one map.
  • This map's own → plugin-designs/<your-map>/. It holds two things: the map's "main" class (each .vue profile is the Vue instance for that map) and that map's own non-reusable components (in src/). Nothing here leaks to another map.
  • Many maps per bundle. The bundler bundles one map or many — add another flat .vue and rebuild.

Production or experimental — every profile declares itself

Every app profile is one of two things, and experimental profiles are unlimited and encouraged — create as many as you need:

  • Experimental, not built: prefix the folder with _ — the build skips it; it just sits in code. Zero cost, zero risk.
  • Experimental, built: builds normally, but it belongs in the Experimental section of the power app's layout (nav section) — never embedded on partner surfaces.
  • Production: a real product — main sections of the power app + individually embeddable.

(The power app = the SPA layout that composes all profiles into one application.)

The pattern in one picture

plugin-designs/<your-map>/     ← one FOLDER = one BUNDLE, named after the folder
   ├── index.js               ← entry: registers the custom element, finds the profiles
   ├── overview.vue           ← one .vue = one PROFILE (flat in the folder — no profiles/ subfolder)
   └── detail.vue             ← another profile in the SAME bundle

     builds to ─────────────► public/dx-maps/<your-map>/<your-map>.js   (one file)
  • Folder name = bundle name. Folders starting with _ or . are skipped (handy for WIP).
  • Each .vue = one profile (one map screen). One bundle can hold many.
  • Pick the profile at embed time with the profile field — every profile shares one bundle:
<script src="/dx-maps/<your-map>/<your-map>.js"></script>
<your-map profile-config='{"profile":"overview","tk":"pk.eyJ..."}'></your-map>
<your-map profile-config='{"profile":"detail","tk":"pk.eyJ..."}'></your-map>

Add a map — three steps

# 1. create the folder + one profile
mkdir -p plugin-designs/<your-map>
#    index.js   ← copy doxa-simple-map/index.js, rename the tag
#    <name>.vue ← your screen, built from @map/* blocks (flat in the folder)

# 2. build
npm run build            # → public/dx-maps/<your-map>/<your-map>.js
#    (just this one:  BUNDLE=<your-map> npm run build:bundle)

# 3. embed the script tag + element (dev staging at `npm run dev` shows a paste-ready snippet)

Your three things (everything else is shared)

  • Colors — how pins are colored. Pick one the template ships (getColorStrategy('language-family')), or drop your own in plugin-designs/<your-map>/src/colors/ (start from template-bundle/src/colors/example-mode.js). Never edit @map/colors/ to recolor your map.
  • API — your map reads its data from the profile-config on the page, so the same bundle points at different data with no rebuild. DataSourceManager accepts csv (bundled file), api (one JSON URL), or rest-api (a live REST endpoint, the default). Prefer the real API over inlined JSON.
  • i18n — the template ships 11 base locales in @map/i18n/locales/. Use useI18n() for strings and RTL_LOCALES for right-to-left; add or override strings from your own profile.

The one hosting variable

The only thing that changes between hosting modes is the <script src>: a relative path when your own site serves the file, or an absolute CDN URL when a partner site serves it. The bundle is identical either way. See ../documentation/CONTRIBUTING.md for the two CDN modes and partner-site embedding.

Profile patterns (mix freely)

  • Individual — one .vue per bundle (simplest).
  • Parameterized — one profile, behavior driven by profile-config props (e.g. tabs[]).
  • Nested — one profile that renders others (workbench-style, like doxa-research-map).

See also

  • doxa-simple-map/index.js — fully commented reference bundle entry
  • template-bundle/ — minimal two-profile skeleton to copy
  • ../library/colors/README.md — the color-strategy contract
  • ../README.md — repo overview & build pipeline · ../documentation/CONTRIBUTING.md — build vs dev, CDN modes