deploy: f49f174

Dataport · Feb 4, 2025 · 19be426 · 19be426
1 parent 89e8149
commit 19be426
Show file tree

Hide file tree

Showing 31 changed files with 4,586 additions and 4,568 deletions.
diff --git a/docs/afm/core.html b/docs/afm/core.html
@@ -48,7 +48,8 @@ <h3 id="addplugins" tabindex="-1">addPlugins</h3>
   instance.$store.dispatch('addComponent', {
     name: 'plugin', // unique technical name
     plugin: Plugin, // a vue component
-    language, // an i18n locale batch
+    locales, // an i18n Locale[]
+    language, // @deprecated an i18n locale batch
     options, // configuration; overriddable with mapConfiguration on createMap
     storeModule, // vuex store module, if required
   })
@@ -112,7 +113,7 @@ <h4 id="mapconfiguration" tabindex="-1">mapConfiguration</h4>
 </tr>
 <tr>
 <td>locales</td>
-<td>LanguageOption[]?</td>
+<td>Locale[]?</td>
 <td>All locales in POLAR's plugins can be overridden to fit your needs.</td>
 </tr>
 <tr>
@@ -145,7 +146,7 @@ <h4 id="mapconfiguration" tabindex="-1">mapConfiguration</h4>
   stylePath: '../dist/polar-client.css',
   checkServiceAvailability: true,
   language: 'de',
-  locales, // the languageOptions object will normally be outsourced to another file
+  locales, // the locales object will normally be outsourced to another file
   layerConf, // the layerConf object will normally be outsourced to another file - for more information, see the relevant chapter
   layers: [
     // parts of the layer configuration can be outsourced to another file
@@ -179,10 +180,10 @@ <h4 id="mapconfiguration" tabindex="-1">mapConfiguration</h4>
 }
 </code></pre>
 </details>
-<h5 id="mapconfiguration.languageoption" tabindex="-1">mapConfiguration.LanguageOption</h5>
+<h5 id="mapconfiguration.locale" tabindex="-1">mapConfiguration.Locale</h5>
 <p>A language option is an object consisting of a type (its language key) and the i18next resource definition. You may e.g. decide that the texts offered in the LayerChooser do not fit the style of your client, or that they could be more precise in your situation since you're only using <em>very specific</em> overlays.</p>
-<p>An example for a LanguageOption array usable in <code>createMap</code> is this array:</p>
-<pre><code class="language-ts">const languageOptions: LanguageOption[] = [
+<p>An example for a Locale array usable in <code>createMap</code> is this array:</p>
+<pre><code class="language-ts">const locales: Locale[] = [
   {
     type: 'de',
     resources: {

diff --git a/docs/afm/plugin-legend.html b/docs/afm/plugin-legend.html
@@ -92,8 +92,8 @@ <h2>Locales</h2>
 
         <tr>
           <td>plugins.legend.openLegendTo</td>
-          <td>$t(common:plugins.legend.legendTo) öffnen</td>
-          <td>Open $t(common:plugins.legend.legendTo)</td>
+          <td>$t(plugins.legend.legendTo) öffnen</td>
+          <td>Open $t(plugins.legend.legendTo)</td>
         </tr>
 
         <tr>

diff --git a/docs/diplan/core.html b/docs/diplan/core.html
@@ -48,7 +48,8 @@ <h3 id="addplugins" tabindex="-1">addPlugins</h3>
   instance.$store.dispatch('addComponent', {
     name: 'plugin', // unique technical name
     plugin: Plugin, // a vue component
-    language, // an i18n locale batch
+    locales, // an i18n Locale[]
+    language, // @deprecated an i18n locale batch
     options, // configuration; overriddable with mapConfiguration on createMap
     storeModule, // vuex store module, if required
   })
@@ -112,7 +113,7 @@ <h4 id="mapconfiguration" tabindex="-1">mapConfiguration</h4>
 </tr>
 <tr>
 <td>locales</td>
-<td>LanguageOption[]?</td>
+<td>Locale[]?</td>
 <td>All locales in POLAR's plugins can be overridden to fit your needs.</td>
 </tr>
 <tr>
@@ -145,7 +146,7 @@ <h4 id="mapconfiguration" tabindex="-1">mapConfiguration</h4>
   stylePath: '../dist/polar-client.css',
   checkServiceAvailability: true,
   language: 'de',
-  locales, // the languageOptions object will normally be outsourced to another file
+  locales, // the locales object will normally be outsourced to another file
   layerConf, // the layerConf object will normally be outsourced to another file - for more information, see the relevant chapter
   layers: [
     // parts of the layer configuration can be outsourced to another file
@@ -179,10 +180,10 @@ <h4 id="mapconfiguration" tabindex="-1">mapConfiguration</h4>
 }
 </code></pre>
 </details>
-<h5 id="mapconfiguration.languageoption" tabindex="-1">mapConfiguration.LanguageOption</h5>
+<h5 id="mapconfiguration.locale" tabindex="-1">mapConfiguration.Locale</h5>
 <p>A language option is an object consisting of a type (its language key) and the i18next resource definition. You may e.g. decide that the texts offered in the LayerChooser do not fit the style of your client, or that they could be more precise in your situation since you're only using <em>very specific</em> overlays.</p>
-<p>An example for a LanguageOption array usable in <code>createMap</code> is this array:</p>
-<pre><code class="language-ts">const languageOptions: LanguageOption[] = [
+<p>An example for a Locale array usable in <code>createMap</code> is this array:</p>
+<pre><code class="language-ts">const locales: Locale[] = [
   {
     type: 'de',
     resources: {

diff --git a/docs/diplan/dist/polar-client.css b/docs/diplan/dist/polar-client.css
diff --git a/docs/diplan/dist/polar-client.js b/docs/diplan/dist/polar-client.js
diff --git a/docs/diplan/dist/polar-client.js.map b/docs/diplan/dist/polar-client.js.map
diff --git a/docs/generic/core.html b/docs/generic/core.html
@@ -48,7 +48,8 @@ <h3 id="addplugins" tabindex="-1">addPlugins</h3>
   instance.$store.dispatch('addComponent', {
     name: 'plugin', // unique technical name
     plugin: Plugin, // a vue component
-    language, // an i18n locale batch
+    locales, // an i18n Locale[]
+    language, // @deprecated an i18n locale batch
     options, // configuration; overriddable with mapConfiguration on createMap
     storeModule, // vuex store module, if required
   })
@@ -112,7 +113,7 @@ <h4 id="mapconfiguration" tabindex="-1">mapConfiguration</h4>
 </tr>
 <tr>
 <td>locales</td>
-<td>LanguageOption[]?</td>
+<td>Locale[]?</td>
 <td>All locales in POLAR's plugins can be overridden to fit your needs.</td>
 </tr>
 <tr>
@@ -145,7 +146,7 @@ <h4 id="mapconfiguration" tabindex="-1">mapConfiguration</h4>
   stylePath: '../dist/polar-client.css',
   checkServiceAvailability: true,
   language: 'de',
-  locales, // the languageOptions object will normally be outsourced to another file
+  locales, // the locales object will normally be outsourced to another file
   layerConf, // the layerConf object will normally be outsourced to another file - for more information, see the relevant chapter
   layers: [
     // parts of the layer configuration can be outsourced to another file
@@ -179,10 +180,10 @@ <h4 id="mapconfiguration" tabindex="-1">mapConfiguration</h4>
 }
 </code></pre>
 </details>
-<h5 id="mapconfiguration.languageoption" tabindex="-1">mapConfiguration.LanguageOption</h5>
+<h5 id="mapconfiguration.locale" tabindex="-1">mapConfiguration.Locale</h5>
 <p>A language option is an object consisting of a type (its language key) and the i18next resource definition. You may e.g. decide that the texts offered in the LayerChooser do not fit the style of your client, or that they could be more precise in your situation since you're only using <em>very specific</em> overlays.</p>
-<p>An example for a LanguageOption array usable in <code>createMap</code> is this array:</p>
-<pre><code class="language-ts">const languageOptions: LanguageOption[] = [
+<p>An example for a Locale array usable in <code>createMap</code> is this array:</p>
+<pre><code class="language-ts">const locales: Locale[] = [
   {
     type: 'de',
     resources: {

diff --git a/docs/generic/plugin-legend.html b/docs/generic/plugin-legend.html
@@ -92,8 +92,8 @@ <h2>Locales</h2>
 
         <tr>
           <td>plugins.legend.openLegendTo</td>
-          <td>$t(common:plugins.legend.legendTo) öffnen</td>
-          <td>Open $t(common:plugins.legend.legendTo)</td>
+          <td>$t(plugins.legend.legendTo) öffnen</td>
+          <td>Open $t(plugins.legend.legendTo)</td>
         </tr>
 
         <tr>

diff --git a/docs/meldemichel/core.html b/docs/meldemichel/core.html
@@ -48,7 +48,8 @@ <h3 id="addplugins" tabindex="-1">addPlugins</h3>
   instance.$store.dispatch('addComponent', {
     name: 'plugin', // unique technical name
     plugin: Plugin, // a vue component
-    language, // an i18n locale batch
+    locales, // an i18n Locale[]
+    language, // @deprecated an i18n locale batch
     options, // configuration; overriddable with mapConfiguration on createMap
     storeModule, // vuex store module, if required
   })
@@ -112,7 +113,7 @@ <h4 id="mapconfiguration" tabindex="-1">mapConfiguration</h4>
 </tr>
 <tr>
 <td>locales</td>
-<td>LanguageOption[]?</td>
+<td>Locale[]?</td>
 <td>All locales in POLAR's plugins can be overridden to fit your needs.</td>
 </tr>
 <tr>
@@ -145,7 +146,7 @@ <h4 id="mapconfiguration" tabindex="-1">mapConfiguration</h4>
   stylePath: '../dist/polar-client.css',
   checkServiceAvailability: true,
   language: 'de',
-  locales, // the languageOptions object will normally be outsourced to another file
+  locales, // the locales object will normally be outsourced to another file
   layerConf, // the layerConf object will normally be outsourced to another file - for more information, see the relevant chapter
   layers: [
     // parts of the layer configuration can be outsourced to another file
@@ -179,10 +180,10 @@ <h4 id="mapconfiguration" tabindex="-1">mapConfiguration</h4>
 }
 </code></pre>
 </details>
-<h5 id="mapconfiguration.languageoption" tabindex="-1">mapConfiguration.LanguageOption</h5>
+<h5 id="mapconfiguration.locale" tabindex="-1">mapConfiguration.Locale</h5>
 <p>A language option is an object consisting of a type (its language key) and the i18next resource definition. You may e.g. decide that the texts offered in the LayerChooser do not fit the style of your client, or that they could be more precise in your situation since you're only using <em>very specific</em> overlays.</p>
-<p>An example for a LanguageOption array usable in <code>createMap</code> is this array:</p>
-<pre><code class="language-ts">const languageOptions: LanguageOption[] = [
+<p>An example for a Locale array usable in <code>createMap</code> is this array:</p>
+<pre><code class="language-ts">const locales: Locale[] = [
   {
     type: 'de',
     resources: {