History

Doxa Maps 5cdb5cdc3c A partner's dataSource never reached either Regions pane regions-mfe forwards page-scoped config to its nested panes by an explicit key list, because a cap-4 composite mounts its children in THIS document and a pane has no leaf page of its own to hand it anything. Two keys were missing. dataSource is the one that was actually broken. PRODUCTION-MATRIX's own table for embedders lists it -- "wrong/partial data ... Regions uses pray-tools" -- and nothing pinned it in spec.config or either pane.config, so a partner setting it on <regions-mfe> had it silently dropped and both panes fell back to sources.json's activeSource. Unlike the token there is no page-wide publish to rescue it. tokenUrl is latent rather than broken, and it is worth being exact about which. exp-shepherd's universal-props re-measure named it absent here, and it is; but this composite sits under a ProfileLoader that already watches tokenUrl, fetches it, and publishes the answer page-wide, so the panes do hold a token. What they lacked was the URL, so a pane could never re-ask the token service itself and was stuck with whatever the page had published. Of the four keys that table documents, assetsBase was already forwarded, tk needs no forwarding (ProfileLoader publishes a token it is handed page-wide), and profile must NOT be inherited -- the host's would overwrite each pane's own and collapse both tabs into one view. The new gate asserts that exclusion too, so a future well-meaning addition fails instead of quietly merging the tabs.		2026-09-26 17:10:06 +00:00
..
all-people-groups	C2: one library helper for per-engine projection, across 12 call sites in 9 plugins	2026-09-26 08:39:53 +00:00
big-picture	Integrate main into bundler-2/work	2026-09-26 06:43:22 +00:00
cities-internet	Cities with Internet: a page that asks for MapLibre never silently gets Mapbox	2026-09-26 17:01:36 +00:00
country-posters	Country posters: the map's loading and error lines speak the reader's language	2026-09-26 16:55:14 +00:00
dashboard-plus-grid	C1a: the affinity-block and doxa-region palettes move to library/colors/	2026-09-26 08:39:53 +00:00
demo-map	C2: one library helper for per-engine projection, across 12 call sites in 9 plugins	2026-09-26 08:39:53 +00:00
doxa-maps-spa	Research Gallery: PPLR Data Maps and Wall of People Groups are named in all 11 languages	2026-09-25 23:41:17 +00:00
doxa-research-map	"Arabic" emptied the grid, because no people group speaks "Arabic"	2026-09-26 13:35:57 +00:00
doxa-simple-map	Six entries hand-rolled the RTL text plugin; the library already installs it	2026-09-26 13:35:57 +00:00
doxa-vision-card	Doxa Vision Card: take the page language from profile-config lang as well as locale	2026-09-26 01:10:51 +00:00
golden-path-check	golden-path-check: walk the develop-a-plugin-and-see-it-live path end to end	2026-09-22 03:55:18 +00:00
gospel-resources	P8: a partner's own list is an address	2026-09-26 13:36:15 +00:00
key-cities	Key Cities (gated): the map, list, tables and posters speak the reader's language	2026-09-26 03:34:30 +00:00
my-upg-100-list	Six entries hand-rolled the RTL text plugin; the library already installs it	2026-09-26 13:35:57 +00:00
people-groups-grid	The grid's DATA follows the URL's language, and the grid turns round in Arabic	2026-09-26 07:56:38 +00:00
plugin-studio	Plugin Studio rail laid out like plugin-designs/: one folder per bundle, its elements inside	2026-09-26 12:23:49 +00:00
pplr-data-maps	Six entries hand-rolled the RTL text plugin; the library already installs it	2026-09-26 13:35:57 +00:00
prayer-walk-planner	Export gate reads the tree name from the build config	2026-09-25 21:32:35 +00:00
regions-dashboard	A partner's dataSource never reached either Regions pane	2026-09-26 17:10:06 +00:00
research-dashboard	The dashboard now says out loud what a filter just did	2026-09-26 13:35:57 +00:00
research-map-plus-grid	"Arabic" emptied the grid, because no people group speaks "Arabic"	2026-09-26 13:35:57 +00:00
stack-demo	Studio and stack-demo hand the host's language down to what they mount	2026-09-25 13:26:01 +00:00
template-bundle	template-bundle: the starter's first screen is now a real map	2026-09-26 04:38:12 +00:00
upg-neighbor	Six entries hand-rolled the RTL text plugin; the library already installs it	2026-09-26 13:35:57 +00:00
wall-of-people-groups	One pinned-UMD loader for PPLR and the Wall: library/utils/loadPinnedUmd.js	2026-09-26 07:24:25 +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

README.md

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).