History

doxa-maps-88655c70 f0b41ae3be Describe the plugin that exists now, in one line that survives extraction The gallery and the plugin-studio — the surfaces a new developer or an inheritor opens to learn what is here — described a plugin that stopped existing twenty ticks ago. resources-map read "Every country shaded by how much of its unengaged population has NO gospel resource": the choropleth, and nothing about the 12,379 people-group pins, the real per-group links, the search or the gap filter. data-tables read "Two validated tables" when there are eight. Someone browsing for a tool that maps gospel resources per people group would not have learned that this is one. ★ AND A LONGER DESCRIPTION WOULD HAVE MADE IT WORSE. generate-tree extracts with /^\s\\s@([\w-]+)\s+(.+?)\s$/gm — ONE LINE. A wrapped @description silently ships only its first line, so my first rewrite ended mid-sentence on the word "and", which is worse than the stale text it replaced. All four profiles are now a single complete sentence. THIS IS NOT LOCAL. 27 profiles across the repo ship a description that ends mid-sentence, including doxa-maps-spa — the flagship SPA — and big-picture, cities-internet and all-people-groups. check:profile-descriptions asserts a description EXISTS, not that it is a whole sentence, so all 27 pass. Fixing this bundle takes it to 23. The rest are other bundles' and are left alone rather than failing a shared gate on work that is not mine; the measurement is here for whoever owns them. The gallery also had to be regenerated: it is written by `bun run gallery` from the manifest, so updating the source docblocks moved the manifest and left the gallery HTML stale. Both now carry the new text; verified by searching the built gallery for it. Verified: 4 of 4 profiles in this bundle end in a full stop, the manifest carries the complete text, the built gallery contains it, and the coverage gate, descriptions gate, SRI check and map gate all pass.		2026-09-24 08:26:50 +00:00
..
all-people-groups	light the remaining unconditional loading overlays and the copy-me starter	2026-09-21 16:40:53 +00:00
big-picture	Stop Big Picture showing the same total twice	2026-09-23 15:32:28 +00:00
cities-internet	Resolve a composite's child bundles against the tree root, not a guessed depth	2026-09-23 19:34:28 +00:00
country-posters	Resolve the shared asset base per bundle, so nested tabs stop 404ing	2026-09-23 12:14:52 +00:00
dashboard-plus-grid	Add the Gospel Access filter, the ladder the binary flag was flattening	2026-09-23 13:19:22 +00:00
demo-map	consolidate docs into documentation/ and deployment shells into deployment/	2026-09-21 23:23:23 +00:00
doxa-maps-spa	Regions mounts its cap-4 composite; UPG-100 drops its duplicate share and shrinks its dots	2026-09-23 19:37:55 +00:00
doxa-research-map	Widen the red ramp, add a greyscale ramp, and gate cap-4 interoperability	2026-09-23 14:53:51 +00:00
doxa-simple-map	Describe every plugin: 15 of 26 profiles shipped with no description	2026-09-22 03:11:07 +00:00
doxa-vision-card	Brand-neutral shared VerticalTabsLayout with lazy nested-element hosting; fix cap-5 prayer tab leaf path; neutralize library identifiers; add Forgejo CI build-gate workflow	2026-09-19 17:24:30 +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	Describe the plugin that exists now, in one line that survives extraction	2026-09-24 08:26:50 +00:00
key-cities	Resolve the shared asset base per bundle, so nested tabs stop 404ing	2026-09-23 12:14:52 +00:00
my-upg-100-list	Regions mounts its cap-4 composite; UPG-100 drops its duplicate share and shrinks its dots	2026-09-23 19:37:55 +00:00
people-groups-grid	Add the Gospel Access filter, the ladder the binary flag was flattening	2026-09-23 13:19:22 +00:00
plugin-studio	Plugin studio: show what a composite is made of, in one panel	2026-09-23 20:21:48 +00:00
prayer-walk-planner	Add prayer-walk-planner: experimental polygon prayer-walking map	2026-09-23 16:22:56 +00:00
regions-dashboard	Regions element gets the Select View tabs, shared with UPG-100	2026-09-23 19:08:00 +00:00
research-dashboard	Full table headers via horizontal scroll, and a full-screen table	2026-09-23 20:25:08 +00:00
research-map-plus-grid	Share the mobile composite too, and make the url absolute so the embed works	2026-09-23 08:32:50 +00:00
stack-demo	Let a stacked composite find its siblings in either tree	2026-09-22 15:37:41 +00:00
template-bundle	consolidate docs into documentation/ and deployment shells into deployment/	2026-09-21 23:23:23 +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).