History

Doxa Maps 22dc3ed770 Kit landing 4b: the rail stops reaching for research colours The facet rail and the chip bar imported useTreeLegendColors and useTreeLegendLabels — the DOXA palettes and the People code tables. Those are research-specific by this kit's own reckoning and they STAY in plugin-designs, so that import is precisely what stopped the rail from being able to move into the kit at all: a library component importing a plugin composable is what check:no-cross-plugin-imports refuses, and rightly. So the dependency inverts rather than the file moving. The panels declare what they need — two functions — and the SHELL supplies them as dashboardConfig.legend. The shell is the right supplier because it is the only thing that already holds the config, the dataStore and the source id those composables require, and because a composable cannot be called at config-module scope. ON dashboardConfig, NOT A NEW INJECT KEY, because section 5.1 of the spec says a panel needing a new capability gets a new CONFIG key and never a new channel. It would have been easy to add a seventh inject key and quietly exempt myself from a rule I wrote; the rule is better than the exception. Merged rather than assigned, so a profile supplying its own legend wins. THE NO-LEGEND STATE IS HONEST, NOT A CRASH. A dashboard that supplies nothing gets uncoloured swatches and raw values — which is what go-int sees before it wires its palette, and a half-configured dashboard should look PLAIN rather than broken. The kit's neutral is its OWN constant and deliberately not the research palette's NEUTRAL, which happens to hold the same value today: importing it to save a literal would re-create the dependency this landing removes, and the research palette must stay free to change its own neutral without reaching in here. Big Picture is unchanged because the fallbacks fire only when legend is ABSENT, and for Big Picture the shell always supplies it. Every hex still comes from the same strategy modules the map's pins paint with, so the legend still cannot drift from the map — it is handed the strategies instead of fetching them. check:legend-mirrors grows arm 3: the research imports are gone, cfg.legend is read, and the two no-legend fallbacks are LIFTED OUT OF THE SFC AND DRIVEN, so "neutral swatch and raw value" is measured rather than asserted. Three mutants, all caught. What it deliberately does NOT do is mount the component — a no-op renderer cannot show a colour, so a mount would prove only "it did not throw" at the cost of a dev server in a gate that runs in milliseconds. The rendered result is rega's. ★ AND MY OWN CHECK FAILED ON MY OWN COMMENT, FOR THE FIFTH TIME. The comment beside the kit's neutral explains the decision by NAMING the research NEUTRAL, so testing raw source reported a coupling that does not exist. I had already fixed that shape four times in other gates and still wrote the raw-source version here, which says the fix belongs in a habit rather than in each gate: every text search over source strips comments first, without thinking about it. Source only. STUDIO: needs a rebuild of research-dashboard and dashboard-plus-grid.		2026-09-27 04:14:13 +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	Messaging channels: a taxi and a food app are no longer a country's top messaging app	2026-09-27 03:25:59 +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	Decouple prose: no go-base / nuxtbase / nuxtinator / doxa-base names in plugin comments and docs	2026-09-26 17:28:45 +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	Decouple prose: no go-base / nuxtbase / nuxtinator / doxa-base names in plugin comments and docs	2026-09-26 17:28:45 +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	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	The interactive maps fetch the web-sized boundaries	2026-09-27 03:25:59 +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	The interactive maps fetch the web-sized boundaries	2026-09-27 03:25:59 +00:00
people-groups-grid	The second consumer drops its copy of the highlighter	2026-09-27 01:16:50 +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	PPLR maps: the toolbars, legends, pills, popups and pin card follow the reader's language	2026-09-27 03:26:35 +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	The region card becomes a shared component the plugin consumes	2026-09-27 03:26:36 +00:00
research-dashboard	Kit landing 4b: the rail stops reaching for research colours	2026-09-27 04:14:13 +00:00
research-map-plus-grid	D3: the bus can point at a record without choosing it	2026-09-27 02:17:35 +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	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).