jekyll-theme-conference 3.6.1 → 3.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64608f074739a5b9544e9c1e620c7801330e4a22ea778b940018f493b6334100
-  data.tar.gz: 5d74b4841bbfcc28f740a9b5464fbde28b8257dd98499c77e938c56865b15378
+  metadata.gz: 3a8a764ea9cd83ec595e33843bfc153ed9771d50fc7913b27be142c48ec911ad
+  data.tar.gz: ed274c9834c5a2f832300d78260ddbd740471f59d53767ba34667fd4a7f2b762
 SHA512:
-  metadata.gz: 5ebd2f83933b0aed0216e34cc7ed10896531dd24c897d465af591cbeecaf8763027358570163b94bf9d920406f4b8268acda84fc72733882ea5904ade4f58ac6
-  data.tar.gz: 0d2c4d6c3e3ee34a390889d1b59153816ac6cdcc0f4a7c1a298e9f79f6b4fbada379b7e0d2335c9c5b3af2d781b69b32e8c4add0162c082400ce7722c6c0c1d0
+  metadata.gz: 73c23afdd2af6befe4d2986ba6c8d00f6c10173a5e6ed65da2440480b8664cbfb9986457d120dc91e6386fec3f41fac4ff548d634b2f3f54186cf90385894680
+  data.tar.gz: dddb4b961103052da89c38d721411a9e853ee317ebf0c5c30bc163f307e6bfac1e1b2b65a2f966b5c349ffce42805f3ff44251930f5b8002abb1632b8ba8e482

data/README.md

@@ -493,9 +493,14 @@ conference:
     map: true
 ```
 
-The map is based on the JavaScript Library [Leaflet](https://leafletjs.com/) and can be customized by editing the `assets/js/main.js` file, e.g. adding additional layers with markers, text, or shapes to the map. To start, copy simply the file from this repository and make use of the initialized global variable `window.conference.map` pointing to the Leaflet container.
+The map is based on the [Leaflet](https://leafletjs.com/) JavaScript library. The map object can be customized by adding additional layers with markers, text, or shapes. To do so, one has to edit the main JavaScript file, `assets/js/main.js`:
 
-Example:
+1. Import the JavaScript library of the theme (via Jekyll `include` command)
+2. Await the initialization of the theme's object
+3. Fetch the map object and verify it is set (while the JavaScript code is imported and executed on each page, the map object will only exist on the location site)
+4. Modify the map.
+
+Following an example is given adding a simple marker to the map:
 
 ```javascript
 ---
@@ -503,8 +508,8 @@ Example:
 
 {% include js/conference.js %}
 
-(() => {
-    const map = window.conference.map;
+window.conference.awaitReady().then(() => {
+    const map = window.conference.map.getMap();
 
     if (typeof map !== 'undefined') {
         let main_station = L.marker([47.37785, 8.54035], {
@@ -515,7 +520,7 @@ Example:
             })
         }).addTo(map);
     }
-})();
+});
 
 ```
 

data/_includes/js/conference.js

@@ -11,6 +11,19 @@
 window.conference = {
     config: {
         baseurl: '{{ site.baseurl }}'
+    },
+
+    ready: false,
+    awaitReady: () => {
+        const poll = (resolve) => {
+            if(window.conference.ready === true) {
+                resolve();
+            }
+            else {
+                setTimeout(() => poll(resolve), 500);
+            }
+        }
+        return new Promise(poll);
     }
 };
 
@@ -22,12 +35,12 @@ window.conference = {
 // Leaflet (Map Display)
 {% include partials/get_enable_map.html %}
 {% if enable_map %}
-    {% include js/lib/leaflet.js %}
-    {% include js/lib/leaflet-easybutton.js %}
-    {% include js/lib/leaflet-locatecontrol.js %}
-    {% include js/lib/leaflet-providers.js %}
+    {%- include js/lib/leaflet.js %}
+    {%- include js/lib/leaflet-easybutton.js %}
+    {%- include js/lib/leaflet-locatecontrol.js %}
+    {%- include js/lib/leaflet-providers.js %}
 
-    {% include js/map.js %}
+    {%- include js/map.js %}
 {% endif %}
 
 // Modals ("Popups")
@@ -35,7 +48,7 @@ window.conference = {
 
 // Live and Streaming
 {% if site.conference.live %}
-    {% include js/live.js %}
+    {%- include js/live.js %}
 {% endif %}
 
 // Load configuration and start initialization

data/_includes/js/init.js

@@ -12,7 +12,7 @@ const init = () => {
 
         // Execute initialization functions
         for (const [name, module] of Object.entries(window.conference)) {
-            if (name == 'config') {
+            if (['config','ready','awaitReady'].includes(name)) {
                 continue;
             }
 
@@ -25,9 +25,11 @@ const init = () => {
                 l = config.lang[name];
             }
 
-            module.init(c, l)
+            module.init(c, l);
         }
 
+    }).then(() => {
+        window.conference.ready = true;
     })
     .catch((error) => {
         console.log(error);

data/_includes/js/map.js

@@ -11,12 +11,12 @@ window.conference.map = (() => {
 
         L.easyButton('far fa-star', () => {
             map.flyTo(config.home_coord, config.default_zoom);
-        }, lang.location.focus_conf).addTo(map);
+        }, lang.focus_conf).addTo(map);
 
         L.control.locate({
             flyTo: true,
             strings: {
-                title: lang.location.focus_me
+                title: lang.focus_me
             }
         }).addTo(map);
     };
@@ -32,7 +32,12 @@ window.conference.map = (() => {
         }
     };
 
+    const getMap = () => {
+        return map
+    };
+
     return {
-        init: init
+        init: init,
+        getMap: getMap
     };
 })();

data/_includes/partials/checks.html

@@ -2,10 +2,10 @@
 
 {%- unless site.data.lang.version -%}
   {%- unless site.conference.lang == "en" -%}
-    {%- assign errors = errors | push : "The internationalization file containing different strings for this template seems to be missing. Have you copied the `_data/lang.yml` file from the [theme's repository](https://github.com/DigitaleGesellschaft/jekyll-theme-conference/blob/master/_data/lang.yml) to you local website folder?" -%}
+    {%- assign errors = errors | push : "The internationalization file containing different strings for this template seems to be missing. Have you copied the `_data/lang.yml` file from the [theme's repository](https://github.com/DigitaleGesellschaft/jekyll-theme-conference/blob/main/_data/lang.yml) to you local website folder?" -%}
   {%- endunless -%}
 {%- elsif site.data.lang.version != 8 -%}
-  {%- assign errors = errors | push : "The internationalization file in `_data/lang.yml` seems to be outdated and does not correspond to the current version of the theme. Grab the current version from the [theme's repository](https://github.com/DigitaleGesellschaft/jekyll-theme-conference/blob/master/_data/lang.yml)." -%}
+  {%- assign errors = errors | push : "The internationalization file in `_data/lang.yml` seems to be outdated and does not correspond to the current version of the theme. Grab the current version from the [theme's repository](https://github.com/DigitaleGesellschaft/jekyll-theme-conference/blob/main/_data/lang.yml)." -%}
 {%- endunless -%}
 {%- unless site.conference.lang == "en" or site.conference.lang == "de" or site.conference.lang == "fr" or site.conference.lang == "pt" -%}
   {%- assign errors = errors | push : "Unknown language selected for `site.conference.lang` parameter. Supported are `en`, `de`, `fr`, and `pt`." -%}

data/_sass/bootstrap/_variables.scss

@@ -677,7 +677,7 @@ $form-validation-states: map-merge(
   $form-validation-states
 );
 
-// Z-index master list
+// Z-index main list
 //
 // Warning: Avoid customizing these values. They're used for a bird's eye view
 // of components dependent on the z-axis and are designed to all work together.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-conference
 version: !ruby/object:Gem::Version
-  version: 3.6.1
+  version: 3.6.2
 platform: ruby
 authors:
 - Lorenz Schmid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-20 00:00:00.000000000 Z
+date: 2023-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -286,7 +286,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Jekyll template for a conference website containing program, speaker, talks