History

Doxa Maps 216fa292d4 Pin popup: render the description their site renders, not a field that is 99% empty Their CountryMap binds `description: p.imb_people_description ?? ''` and asks for that field in PIN_FIELDS (master, :89 and :114). The doxa-maps-build branch this repo's DX-life checkout is parked on still says location_description, and that is what we cloned — I even kept it deliberately last commit, reasoning that "the popup needs it", which was true of the branch and false of their site. MEASURED against the prayer API over 2,107 people groups: non-empty location_description 35 (1%) <- what our popup rendered non-empty imb_people_description 2107 (100%) <- what theirs renders So this was not the wrong paragraph, it was NO paragraph: roughly 2,072 groups opened a popup with a blank description where doxa.life shows prose. Nothing caught it because the popup did open, with a name, population and religion — my own pin probe asserts that a popup APPEARS, never that it says anything. An element can be present and empty, and "it opened" is not "it is right". The verification queued behind this: _probe-popup-description-field.mjs clicks a pin, reads the group's NAME out of the popup, asks the API for BOTH candidate fields for that exact group, and asserts the popup contains imb_people_description and NOT location_description — the second half is the control, since "the popup has a description" passes with either field. It reports UNPROVEN when the two fields happen to be equal for that group. Browser slots have been saturated for fifteen minutes, so what is proven here is the data path: the shipped bundle requests imb_people_description, carries no location_description at all, and the two fields demonstrably differ in the API. Built only regions-dashboard.		2026-09-25 22:15:36 +00:00
..
all-people-groups	All People Groups loads fast on a light map; the Vision Card becomes a true funnel from data	2026-09-25 07:18:30 +00:00
big-picture	Big Picture: read the language the host asked for	2026-09-25 15:15:55 +00:00
cities-internet	Raw maps shape Arabic, Persian and Hebrew place names: cities-internet and key-cities	2026-09-25 18:59:31 +00:00
country-posters	Composites forward `provider`, so a MapLibre partner gets MapLibre	2026-09-25 08:12:20 +00:00
dashboard-plus-grid	Let a host set the language of a whole page, not half of it	2026-09-25 14:26:02 +00:00
demo-map	Move internal files out of the repo; fix five dead links; a fuller delegation diagram	2026-09-25 05:14:10 +00:00
doxa-maps-spa	Export gate reads the tree name from the build config	2026-09-25 21:32:35 +00:00
doxa-research-map	Export gate reads the tree name from the build config	2026-09-25 21:32:35 +00:00
doxa-simple-map	Move internal files out of the repo; fix five dead links; a fuller delegation diagram	2026-09-25 05:14:10 +00:00
doxa-vision-card	Host locale: gate the profile-config contract, forward ?lang= into staging embeds, stop losing gate stderr	2026-09-25 12:18:26 +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	Gospel charts: the chart vocabulary comes from the catalogue	2026-09-25 19:03:44 +00:00
key-cities	Raw maps shape Arabic, Persian and Hebrew place names: cities-internet and key-cities	2026-09-25 18:59:31 +00:00
my-upg-100-list	The raw map shapes Arabic, Persian and Hebrew place names	2026-09-25 19:05:59 +00:00
people-groups-grid	Match the live page's wording where we differed only by case	2026-09-25 17:08:16 +00:00
plugin-studio	Plugin Studio: the header's menus stay on top of every plugin	2026-09-25 20:44:24 +00:00
pplr-data-maps	engineFor(map): build markers, popups and poster maps with the map's OWN engine	2026-09-25 18:38:17 +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	Pin popup: render the description their site renders, not a field that is 99% empty	2026-09-25 22:15:36 +00:00
research-dashboard	The dashboard's search header follows the engine it was given	2026-09-25 21:14:19 +00:00
research-map-plus-grid	Five more gate scripts read the tree's name from the build config	2026-09-25 16:25:22 +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	Move internal files out of the repo; fix five dead links; a fuller delegation diagram	2026-09-25 05:14:10 +00:00
upg-neighbor	Map labels ask for a font the engine's glyph server has: one shared helper	2026-09-25 13:48:10 +00:00
wall-of-people-groups	Wall of People Groups: say so when the live API cannot be reached, and stop a render error	2026-09-25 19:20:48 +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	consolidate docs into documentation/ and deployment shells into deployment/	2026-09-21 23:23:23 +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/doxa-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="/doxa-maps/<your-map>/<your-map>.js"></script>
<doxa-map profile-config='{"profile":"overview","tk":"pk.eyJ..."}'></doxa-map>
<doxa-map profile-config='{"profile":"detail","tk":"pk.eyJ..."}'></doxa-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/doxa-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).