History

doxa-maps 5f2d7e6bbc Some checks are pending Deploy to GitHub Pages / build (push) Waiting to run Details Deploy to GitHub Pages / deploy (push) Blocked by required conditions Details fix(spa,dashboard): kill the top divider + reflow the map when the table collapses - SPA sidebar: suppress the leading section divider on the FIRST nav group. Every section emitted a `.sep` rule before its header, so Prayer Mobilization (the first section) drew a 1px line directly under the header with nothing above it to divide. drawSide() now tracks a firstGroup flag and skips it. - Research dashboard: when the table under the map collapses, resize the map to fill the freed space. The ResizeObserver alone missed the grid reflow at the instant the table cell flips to display:none (v-show), leaving the map canvas at its old size (gray gap). DashboardMapPanel now also resizes on the 'toggleTable' bus event (rAF + a 280ms settle pass), with clean teardown.		2026-09-12 21:21:45 +00:00
..
cities-internet	doxa-maps — portable bundler for embeddable JAMstack maps	2026-09-10 01:53:07 +00:00
country-posters	doxa-maps — portable bundler for embeddable JAMstack maps	2026-09-10 01:53:07 +00:00
demo-map	docs: simplify all folder READMEs (what's here + graphic + link); migrate complex reference to docs/architecture/{data-sources,i18n,components,app-wrappers,poster-generation}.md	2026-09-11 18:50:31 +00:00
doxa-research-map	feat: map provider swap — mapbox\|maplibre engine + hybrid geocoder + provider badge; staging title doxa-maps	2026-09-11 21:47:25 +00:00
doxa-simple-map	docs: simplify all folder READMEs (what's here + graphic + link); migrate complex reference to docs/architecture/{data-sources,i18n,components,app-wrappers,poster-generation}.md	2026-09-11 18:50:31 +00:00
gospel-resources	doxa-maps — portable bundler for embeddable JAMstack maps	2026-09-10 01:53:07 +00:00
key-cities	doxa-maps — portable bundler for embeddable JAMstack maps	2026-09-10 01:53:07 +00:00
my-upg-100-list	doxa-maps — portable bundler for embeddable JAMstack maps	2026-09-10 01:53:07 +00:00
research-dashboard	fix(spa,dashboard): kill the top divider + reflow the map when the table collapses	2026-09-12 21:21:45 +00:00
template-bundle	docs: fix cold-read gaps — embeddability design doc (generated pages + manifest), SPA recipe + PROFILES contract, copy-rename checklist	2026-09-11 18:50:31 +00:00
.gitkeep	doxa-maps — portable bundler for embeddable JAMstack maps	2026-09-10 01:53:07 +00:00
README.md	docs: decoupled-twin pairing section in why.md; composable/embeddable-first terms in one-liner; experimental-vs-production profile convention	2026-09-11 19:24:27 +00:00

README.md

app-profiles/ — 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, app-profiles/<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
        ▼
  app-profiles/<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 → app-profiles/<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

app-profiles/<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 app-profiles/<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 app-profiles/<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 ../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).