History

doxa-maps-88655c70 319064a11b Map place names in the reader's language, on both engines Every map translated its own chrome but left the basemap's country, city and street names in the style default (English on Mapbox, Latin + native on OpenFreeMap) in all eleven locales. A reader in Arabic saw an Arabic legend over an English map. library/maps/localize-labels.js uses each engine's supported mechanism: - Mapbox: map.setLanguage(lang). It also localizes the Standard style's IMPORTED basemap, which a layer rewrite cannot reach. - MapLibre: basemap symbol layers point at ['coalesce', name:<lang>, name:latin, name]. English restores each layer's original expression, re-captured on every style load so a theme switch never restores the previous style's labels. Only layers whose text-field reads an OSM name field are touched. A plugin's own label layers (zone titles, group names) are never rewritten. useMapInstance applies it on every style.load and when the reader's language changes (ProfileLoader's 'lang', else profile-config locale, else ?lang / <html lang>). The Prayer Walk Planner drops its private copy for the shared one. Measured on the Prayer Progress map, ar/zh/ru/hi: - Mapbox getLanguage() == locale in all four. - MapLibre: 13/14 symbol layers localized, and the plugin's own label layer untouched. Read in the Arabic screenshots: القاهرة, الإسكندرية, السويس, الأردن on both engines. check:gallery-embed (+ :maplibre) and check:prayer-walk-planner pass. The shared change reaches all 11 bundles that compile initializeMap, and all are rebuilt here. check:shared-reached marker basemap-labels-localized: 10/10 consumers.		2026-09-25 09:46:21 +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	Stop Big Picture showing the same total twice	2026-09-23 15:32:28 +00:00
cities-internet	Cities with Internet and the phone legend speak the page's language	2026-09-25 06:05:46 +00:00
country-posters	Composites forward `provider`, so a MapLibre partner gets MapLibre	2026-09-25 08:12:20 +00:00
dashboard-plus-grid	Simple Research + Big Picture: the host's style stops at the box, and the last English goes	2026-09-25 08:19:56 +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	Research Gallery: boot on a partner page under the CORS the live server actually sends	2026-09-25 08:55:52 +00:00
doxa-research-map	Merge main into bundler-2/work	2026-09-25 06:12:10 +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	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
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	Bridge candidates as evidence, and no spoken bridge for a Deaf community	2026-09-25 08:40:25 +00:00
key-cities	Move the private field-access dataset out of the repo	2026-09-24 18:34:01 +00:00
my-upg-100-list	Composites forward `provider`, so a MapLibre partner gets MapLibre	2026-09-25 08:12:20 +00:00
people-groups-grid	Simple Research + Big Picture: the host's style stops at the box, and the last English goes	2026-09-25 08:19:56 +00:00
plugin-studio	Plugin studio: host attributes stay on the host; map-load measurement probe	2026-09-25 08:34:52 +00:00
pplr-data-maps	PPLR maps: country polygons came back after PPLR renamed its fields	2026-09-25 07:40:08 +00:00
prayer-walk-planner	Map place names in the reader's language, on both engines	2026-09-25 09:46:21 +00:00
regions-dashboard	Port the switcher's last rule, so six goal cards would stack as theirs do	2026-09-25 09:14:25 +00:00
research-dashboard	The last English in the shared header, panel and facet rail — and a 24px touch target	2026-09-25 09:15:30 +00:00
research-map-plus-grid	Simple Research + Big Picture: the host's style stops at the box, and the last English goes	2026-09-25 08:19:56 +00:00
stack-demo	Simple Research + Big Picture: the host's style stops at the box, and the last English goes	2026-09-25 08:19:56 +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	UPG Neighbor: build the five neighbor maps from source, not from a frozen IIFE in an iframe	2026-09-24 18:47:14 +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).