add locale register to docs

Author: warm-coolguy

package-lock.json

@@ -37,11 +37,11 @@
     "pages:build": "rimraf ./pages/docs && npm run generic:build && bash ./scripts/buildPages.sh",
     "pages:build:serve": "http-server pages -o index.html",
     "clean": "nx reset && rimraf --glob packages/**/{.cache,dist,docs} && rimraf --glob {.cache,dist} && node ./scripts/clean",
-    "docs:afm": "node ./scripts/makeDocs afm",
-    "docs:generic": "node ./scripts/makeDocs generic",
-    "docs:meldemichel": "node ./scripts/makeDocs meldemichel && npm run meldemichel:build && cp -r ./packages/clients/meldemichel/dist ./packages/clients/meldemichel/example ./packages/clients/meldemichel/docs",
-    "docs:snowbox": "node ./scripts/makeDocs snowbox",
-    "docs:textLocator": "node ./scripts/makeDocs textLocator && npm run textLocator:build && cp -r ./packages/clients/textLocator/dist ./packages/clients/textLocator/docs",
+    "docs:afm": "npx tsx ./scripts/makeDocs afm",
+    "docs:generic": "npx tsx ./scripts/makeDocs generic",
+    "docs:meldemichel": "npx tsx ./scripts/makeDocs meldemichel && npm run meldemichel:build && cp -r ./packages/clients/meldemichel/dist ./packages/clients/meldemichel/example ./packages/clients/meldemichel/docs",
+    "docs:snowbox": "npx tsx ./scripts/makeDocs snowbox",
+    "docs:textLocator": "npx tsx ./scripts/makeDocs textLocator && npm run textLocator:build && cp -r ./packages/clients/textLocator/dist ./packages/clients/textLocator/docs",
     "lint": "npx eslint . --cache --ext .js,.ts,.vue",
     "lint:ci": "npx eslint . --ext .js,.ts,.vue",
     "lint:fix": "npx eslint . --fix --cache --ext .js,.ts,.vue",
@@ -102,10 +102,10 @@
     "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
     "tslib": "^2.3.0",
+    "tsx": "^4.19.2",
     "typescript": "^5.6.2",
     "vite": "^5.4.8",
     "vite-plugin-commonjs": "^0.6.2",
     "vue-template-compiler": "^2.7.16"
-  },
-  "dependencies": {}
+  }
 }

package.json

@@ -1,4 +1,4 @@
-const locales = [
+const language = [
   {
     type: 'de',
     resources: {
@@ -44,4 +44,4 @@ const locales = [
   },
 ]
 
-export default locales
+export default language

packages/clients/dish/src/locales.ts packages/clients/dish/src/language.tspackages/clients/dish/src/locales.ts renamed to packages/clients/dish/src/language.ts

@@ -7,7 +7,7 @@ import {
   dishBaseUrl,
   // servicePrefix, s.u.
 } from './services'
-import locales from './locales'
+import locales from './language'
 
 const shBlue = '#003064'
 const shWhite = '#FFFFFF'

packages/clients/dish/src/mapConfig.ts

@@ -1,5 +1,5 @@
 import { MapConfig } from '@polar/lib-custom-types'
-import locales from './locales'
+import locales from './language'
 import {
   openStreetMap,
   openSeaMap,

…kages/clients/textLocator/src/locales.ts …ages/clients/textLocator/src/language.tspackages/clients/textLocator/src/locales.ts renamed to packages/clients/textLocator/src/language.ts packages/clients/textLocator/src/locales.ts renamed to packages/clients/textLocator/src/language.ts

@@ -174,7 +174,9 @@ const languageOptions: LanguageOption[] = [
 ]
 ```
 
-To figure out the name of the locales to override, inspect the matching plugin in GitHub's file browser. In `packages/plugins`, open the plugin you desire to override. Each plugin's `src` folder contains a `language.ts` listing all used locale keys with appropriate nesting.
+To figure out the name of overridable locales, inspect the documentation of your client; [for example, this is the documentation page of the snowbox](https://dataport.github.io/polar/docs/snowbox/client-snowbox.html). All child documents with locales feature a table of default translations at the end, and some clients bring their own locales and pre-existing overrides.
+
+When reading the locale tables, please mind that the dot notation (`a.b.c | value`) has to be written as separate keys in nested objects as seen in the example above (`{a: {b: {c: "value"}}}`).
 
 ##### mapConfiguration.extendedMasterportalapiMarkers
 

packages/clients/textLocator/src/mapConfig.ts

@@ -2,27 +2,31 @@ import i18next, { init, use } from 'i18next'
 import LanguageDetector from 'i18next-browser-languagedetector'
 import Vue from 'vue'
 import VueI18Next from 'i18next-vue'
-import de from './locales/de'
-import en from './locales/en'
+import language from '../language'
 
 use(LanguageDetector)
 Vue.use(VueI18Next, { i18next })
 
+const supportedLngs = language.map(({ type }) => type)
+
 /**
  * @param initialLanguage - If given, the initial language set in the mapConfiguration.
  */
 export default (initialLanguage?: string) =>
   init({
-    resources: { de, en },
+    resources: language.reduce((accumulator, { type, resources }) => {
+      accumulator[type] = resources
+      return accumulator
+    }, {}),
     detection: {
       lookupQuerystring: 'lng',
       order: ['querystring', 'navigator', 'htmlTag'],
     },
     load: 'languageOnly',
-    fallbackLng: 'de',
+    fallbackLng: supportedLngs[0],
     fallbackNS: 'common',
     ns: ['common'],
-    supportedLngs: ['de', 'en'],
+    supportedLngs,
     ...(initialLanguage ? { lng: initialLanguage } : {}),
   })
     .then(() => {

packages/core/README.md

@@ -0,0 +1,47 @@
+import { LanguageOption } from '@polar/lib-custom-types'
+
+// first type will be used as fallback language
+const language: LanguageOption[] = [
+  {
+    type: 'de',
+    resources: {
+      common: {
+        canvas: {
+          label: 'Kartenanwendung',
+        },
+        error: {
+          serviceUnavailable:
+            'Der Kartendienst "{{serviceName}}" (ID: {{serviceId}}) ist derzeit nicht verfügbar. Dies kann die Funktionalität der Karte einschränken.',
+        },
+        overlay: {
+          noControlOnZoom: 'Verwenden Sie Strg+Scrollen zum Zoomen der Karte',
+          noCommandOnZoom:
+            'Verwenden Sie Command ⌘ + Scrollen zum Zoomen der Karte',
+          oneFingerPan:
+            'Verwenden Sie mindestens zwei Finger zum Verschieben der Karte',
+        },
+      },
+    },
+  },
+  {
+    type: 'en',
+    resources: {
+      common: {
+        canvas: {
+          label: 'Map application',
+        },
+        error: {
+          serviceUnavailable:
+            'Service  "{{serviceName}}" (ID: {{serviceId}}) is unavailable. This may limit the map\'s functionality.',
+        },
+        overlay: {
+          noControlOnZoom: 'Use Ctrl+Mousewheel to zoom into the map',
+          noCommandOnZoom: 'Use Command ⌘ + Mousewheel to zoom into the map',
+          oneFingerPan: 'Use at least two fingers to pan the map',
+        },
+      },
+    },
+  },
+]
+
+export default language