History

Doxa Maps d5a95e97b8 merge main (gospel `a37ea4ff`) into packet/vertical Six public/ conflicts, zero in source. They take main's side here and are regenerated from the merged source in the next commit — a bundle is an output, and a hand-reconciled middle version is wrong by construction.		2026-09-27 05:56:25 +00:00
..
all-people-groups	A bare-host embed under ?lang=ar now renders Arabic here too	2026-09-27 02:17:35 +00:00
big-picture	Big Picture: the live count speaks, and the locale reaches the children	2026-09-26 22:06:58 +00:00
cities-internet	Svalbard carries its own data, not Norway's	2026-09-27 05:05:04 +00:00
country-posters	Country posters: a religion search names the family in the reader's language	2026-09-27 01:10:49 +00:00
dashboard-plus-grid	Arabic set after mount never turned the composites RTL, because the instance was read too late	2026-09-27 05:05:03 +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	The Research Gallery loads behind a login gate: same-origin fetches keep their credentials	2026-09-27 05:05:03 +00:00
doxa-research-map	Two setup-time defects: a TDZ that blanked the map, and a cleanup that never ran	2026-09-27 04:00:31 +00:00
doxa-simple-map	Prayer map without a key: crisp rose borders and light mixed-case country names, as on the reference	2026-09-27 04:38:16 +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-internet	Gospel x Internet credits Glottolog on the board	2026-09-27 02:26:09 +00:00
gospel-resources	Derive the two country numbers the explainer quotes	2026-09-27 04:36:34 +00:00
key-cities	Key cities: the map honours provider=maplibre instead of always building Mapbox GL	2026-09-27 04:38:17 +00:00
my-upg-100-list	Show on map: release the retained zone request once it succeeds	2026-09-27 05:23:10 +00:00
people-groups-grid	The second consumer drops its copy of the highlighter	2026-09-27 01:16:50 +00:00
plugin-studio	The Research Gallery loads behind a login gate: same-origin fetches keep their credentials	2026-09-27 05:05:03 +00:00
pplr-data-maps	PPLR maps: a map that cannot be built says so instead of throwing	2026-09-27 04:38:17 +00:00
prayer-walk-planner	Prayer Walk Planner: the resolved instance id is exposed under its own name	2026-09-27 04:38:17 +00:00
regions-dashboard	The prayer-progress cards become shared components too	2026-09-27 04:14:31 +00:00
research-dashboard	Big Picture's Religion and Region charts were empty because NEUTRAL was never imported	2026-09-27 05:34:00 +00:00
research-map-plus-grid	Arabic set after mount never turned the composites RTL, because the instance was read too late	2026-09-27 05:05:03 +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: the starter's first screen is now a real map	2026-09-26 04:38:12 +00:00
upg-neighbor	UPG Neighbor cockpit: the view switch, sort buttons, tooltip and legend follow the reader's language	2026-09-27 03:26:35 +00:00
wall-of-people-groups	Wall of People Groups opens where the photos are, with rows as far apart as columns	2026-09-27 05:30:05 +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).