jekyll-theme-conference 3.6.1 → 3.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64608f074739a5b9544e9c1e620c7801330e4a22ea778b940018f493b6334100
-  data.tar.gz: 5d74b4841bbfcc28f740a9b5464fbde28b8257dd98499c77e938c56865b15378
+  metadata.gz: 61b7f9271a152b1368fb216342281bceed52d157e63866a0af293ff9e2c19686
+  data.tar.gz: 193a60a8ea2c1559279dfdd05262681d1df8cc1e1e990d8a76bbdccc4f8a987f
 SHA512:
-  metadata.gz: 5ebd2f83933b0aed0216e34cc7ed10896531dd24c897d465af591cbeecaf8763027358570163b94bf9d920406f4b8268acda84fc72733882ea5904ade4f58ac6
-  data.tar.gz: 0d2c4d6c3e3ee34a390889d1b59153816ac6cdcc0f4a7c1a298e9f79f6b4fbada379b7e0d2335c9c5b3af2d781b69b32e8c4add0162c082400ce7722c6c0c1d0
+  metadata.gz: 9c5002b5e3808191703950acb3d9b5b1fa64038b25f7abf873f97e77ded566cac6bce8983ff6bd0d94cf264c550e9e2ec9402dc4a93bc545eb09d1322fa65045
+  data.tar.gz: 66e00cd41d3e99897a9959d4ef1976f5f3a48ecf747155eb05649b6fbf7d2c1257713a6efac8972e8b50ddb883607441433833dba33a962229533960ff3f97a0

data/README.md

@@ -176,6 +176,8 @@ To get started, simply copy the desired workflow file to your repository and ada
 
 - `_tools/build.yml` -> `.github/workflows/build.yml`
 
+Please note that the `Gemfile.lock` of your project must be adapted to include specific versions required by Github's workflow server, i.e. run `bundle lock --add-platform x86_64-linux` to add support for them.
+
 
 ## Configuration
 
@@ -493,9 +495,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 +510,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 +522,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/live.js

@@ -2,7 +2,7 @@ window.conference.live = (() => {
     let config;
     let lang;
 
-    let data;
+    let data = {};
 
     let confStart;
     let confEnd;
@@ -117,6 +117,11 @@ window.conference.live = (() => {
         // Set and pause app time
         pauseTime();
 
+        if (!('days' in data)) {
+            console.log('Data is not loaded yet!')
+            return
+        }
+
         let dayIdx;
         if (!newDay) {
             dayIdx = 0;
@@ -359,17 +364,34 @@ window.conference.live = (() => {
     };
 
     const getRoom = (roomName) => {
-        // Return room object for given room name
-        if (roomName in data.rooms) {
-            return data.rooms[roomName];
+        // Verify if data is already loaded and object populated
+        if ('rooms' in data && Object.keys(data.rooms).length > 0) {
+            // Return room object for given room name
+            if (roomName in data.rooms) {
+                return data.rooms[roomName];
+            }
+            else {
+                return data.rooms[Object.keys(data.rooms)[0]];
+            }
         }
         else {
-            return data.rooms[Object.keys(data.rooms)[0]];
+            console.log('Cannot read rooms as data is not loaded yet!')
+            return {}
+        }
+    };
+
+    const getAllTalks = () => {
+        if ('talks' in data && Object.keys(data.talks).length > 0) {
+            return data.talks
+        }
+        else {
+            console.log('Cannot read talks as data is not loaded yet!')
+            return {}
         }
     };
 
     const getTalks = (roomName) => {
-        if (roomName in data.talks) {
+        if (roomName in getAllTalks()) {
             return data.talks[roomName].map((talk) => {
                 // For talks with live links, add some grace period to the end
                 // time in order to prevent that the next talk is announced
@@ -380,7 +402,7 @@ window.conference.live = (() => {
             });
         }
         else {
-            return false;
+            return [];
         }
     };
 
@@ -389,7 +411,7 @@ window.conference.live = (() => {
         const timeNow = time();
         const talksHere = getTalks(roomName);
 
-        if (talksHere) {
+        if (talksHere.length > 0) {
             if (timeNow < talksHere[talksHere.length-1].end) {
                 for (let i = 0; i < talksHere.length; i++) {
                     if (timeNow < talksHere[i].end) {
@@ -398,7 +420,18 @@ window.conference.live = (() => {
                 }
             }
         }
-        return false;
+        return {};
+    };
+
+    const getSpeaker = (speakerName) => {
+        if ('speakers' in data && Object.keys(data.speakers).length > 0) {
+            if (speakerName in data.speakers) {
+                return data.speakers[speakerName]
+            }
+        }
+
+        console.log('Cannot read speakers as data is not loaded yet!')
+        return {}
     };
 
     const getNextPause = (roomName) => {
@@ -406,7 +439,7 @@ window.conference.live = (() => {
         const timeNow = time();
         const talksHere = getTalks(roomName);
 
-        if (talksHere) {
+        if (talksHere.length > 0) {
             if (timeNow < talksHere[talksHere.length-1].end) {
                 for (let i = 1; i < talksHere.length; i++) {
                     if (timeNow < talksHere[i].start && streamPause*60 <= talksHere[i].start - talksHere[i-1].end) {
@@ -440,10 +473,10 @@ window.conference.live = (() => {
         // Update stream modal iframe:
         // Show stream with start/pause/end message (for given room) and keep updated
         const timeNow = time();
-
-        const talksHere = getTalks(roomName);
         let roomStart, roomEnd;
-        if (talksHere) {
+
+        let talksHere = getTalks(roomName);
+        if (talksHere.length > 0) {
             roomStart = talksHere[0].start;
             roomEnd = talksHere[talksHere.length-1].end;
         }
@@ -451,16 +484,19 @@ window.conference.live = (() => {
             // If no program for given room, take overall first and last talk
             roomStart = 0;
             roomEnd = 0;
-            for (let roomNameTalk in data.talks) {
+            for (let roomNameTalk in getAllTalks()) {
                 talksHere = getTalks(roomNameTalk);
-                const crntRoomStart = talksHere[0].start;
-                const crntRoomEnd = talksHere[talksHere.length-1].end;
 
-                if (roomStart == 0 || roomStart > crntRoomStart) {
-                    roomStart = crntRoomStart;
-                }
-                if (roomEnd == 0 || roomEnd < crntRoomEnd) {
-                    roomEnd = crntRoomEnd;
+                if (talksHere.length > 0) {
+                    const crntRoomStart = talksHere[0].start;
+                    const crntRoomEnd = talksHere[talksHere.length-1].end;
+
+                    if (roomStart == 0 || roomStart > crntRoomStart) {
+                        roomStart = crntRoomStart;
+                    }
+                    if (roomEnd == 0 || roomEnd < crntRoomEnd) {
+                        roomEnd = crntRoomEnd;
+                    }
                 }
             }
         }
@@ -502,14 +538,16 @@ window.conference.live = (() => {
             // Currently a talk is active
             else {
                 const room = getRoom(roomName);
-                setStreamIframeSrc(room.href);
-
-                if (!freezeTime) {
-                    if (pauseNext) {
-                        streamVideoTimer = setTimeout(setStreamVideo, delayStart(pauseNext.start + streamExtend*60) * 1000, roomName);
-                    }
-                    else {
-                        streamVideoTimer = setTimeout(setStreamVideo, delayStart(roomEnd + streamExtend*60) * 1000, roomName);
+                if (room !== {}) {
+                    setStreamIframeSrc(room.href);
+
+                    if (!freezeTime) {
+                        if (pauseNext) {
+                            streamVideoTimer = setTimeout(setStreamVideo, delayStart(pauseNext.start + streamExtend*60) * 1000, roomName);
+                        }
+                        else {
+                            streamVideoTimer = setTimeout(setStreamVideo, delayStart(roomEnd + streamExtend*60) * 1000, roomName);
+                        }
                     }
                 }
             }
@@ -526,7 +564,7 @@ window.conference.live = (() => {
             clearInterval(streamInfoTimer);
         }
 
-        if (talkNext && timeNow >= talkNext.start - streamPause*60) {
+        if (talkNext !== {} && timeNow >= talkNext.start - streamPause*60) {
             document.getElementById('stream-info').dataset.time = talkNext.start;
             document.getElementById('stream-info-time').dataset.time = talkNext.start;
 
@@ -539,8 +577,12 @@ window.conference.live = (() => {
 
             let speakerStr = '';
             for (let i = 0; i < talkNext.speakers.length; i++) {
-                let speaker = data.speakers[talkNext.speakers[i]];
-                if (speaker.href == '') {
+                let speaker = getSpeaker(talkNext.speakers[i]);
+
+                if (speaker == {}) {
+                    speakerStr += talkNext.speakers[i] +', '
+                }
+                else if (speaker.href == '') {
                     speakerStr += speaker.name +', '
                 }
                 else {
@@ -588,7 +630,7 @@ window.conference.live = (() => {
                 }
                 else if (demo) {
                     let talksHere = getTalks(roomName);
-                    if (talksHere) {
+                    if (talksHere.length > 0) {
                         streamInfoTimer = setTimeout(setStreamInfo, delayStart(talksHere[0].start - streamPrepend*60) * 1000, roomName);
                     }
                 }
@@ -603,13 +645,15 @@ window.conference.live = (() => {
 
         // Recover room name in case of empty default
         const room = getRoom(roomName);
-        roomName = room.name;
+        if (room !== {}) {
+            roomName = room.name;
 
-        setStreamVideo(roomName);
-        setStreamInfo(roomName);
+            setStreamVideo(roomName);
+            setStreamInfo(roomName);
 
-        streamModal.find('#stream-button' + room.id).addClass('active');
-        streamModal.find('#stream-select').val(room.id);
+            streamModal.find('#stream-button' + room.id).addClass('active');
+            streamModal.find('#stream-select').val(room.id);
+        }
     };
 
     const updateStream = () => {

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/_includes/partials/get_room_live_href.html

@@ -0,0 +1,8 @@
+{% assign room_live_href = '' -%}
+{%- if room.live -%}
+    {%- if room.live.absolute_url -%}
+        {%- assign room_live_href = room.live.absolute_url -%}
+    {%- elsif room.live.relative_url -%}
+        {%- assign room_live_href = room.live.relative_url | prepend: site.baseurl -%}
+    {%- endif -%}
+{%- endif -%}

data/_includes/partials/header.html

@@ -22,12 +22,15 @@
   <link rel="prefetch" as="fetch" href="{{ site.baseurl }}/assets/js/data.json" type="application/json" crossorigin="anonymous" />
   {%- endif %}
 
-  {%- if site.conference.live.streaming.enable -%}
-    {%- for room in site.rooms -%}
+  {%- if site.conference.live.streaming.enable %}
+    {%- for room in site.rooms %}
       {%- if room.live %}
-  <link rel="preconnect" href="{{ room.live }}" />
-      {%- endif -%}
-    {%- endfor -%}
+        {%- include partials/get_room_live_href.html %}
+        {%- if room_live_href %}
+  <link rel="preconnect" href="{{ room_live_href }}" />
+        {%- endif %}
+      {%- endif %}
+    {%- endfor %}
   {%- endif %}
 </head>
 

data/_includes/partials/navbar_rooms.html

@@ -1,48 +1,36 @@
-<ul class="nav nav-pills d-print-none mb-3">
-  <li class="nav-item">
-    <a class="nav-link {% if page.name contains 'index' %}active{% endif %}" href="{{ site.conference.location.url | prepend: site.baseurl }}">
-      {% if site.conference.location.navbar_title -%}
-        {{- site.conference.location.navbar_title -}}
-      {%- else -%}
-        {{- site.data.lang[site.conference.lang].location.directions | default: "Directions" -}}
-      {%- endif %}
-    </a>
-  </li>
-  {%- for room in site.rooms -%}
+{% assign all_hidden = true -%}
+{% unless site.conference.location.hide %}
+  {% for room in site.rooms %}
+    {% unless room.hide %}
+      {% assign all_hidden = false %}
+      {% break %}
+    {% endunless %}
+  {% endfor %}
+{% endunless %}
+
+{% unless all_hidden %}
+  <ul class="nav nav-pills d-print-none mb-3">
     <li class="nav-item">
-      {%- if room.hide %}
-        <span class="nav-item nav-link disabled">
-          {{ room.name }}
-        </span>
-      {%- else %}
-        <a class="nav-link {% if this_room.name == room.name %}active{% endif %}" href="{{ room.url | prepend: site.baseurl }}">
-          {{ room.name }}
-        </a>
-      {%- endif %}
+      <a class="nav-link {% if page.name contains 'index' %}active{% endif %}" href="{{ site.conference.location.url | prepend: site.baseurl }}">
+        {% if site.conference.location.navbar_title -%}
+          {{- site.conference.location.navbar_title -}}
+        {%- else -%}
+          {{- site.data.lang[site.conference.lang].location.directions | default: "Directions" -}}
+        {%- endif %}
+      </a>
     </li>
-  {%- endfor -%}
-  {%- for room in site.rooms -%}
-    {%- assign room_displayed = false -%}
-    {%- for d in site.data.program.days -%}
-      {%- for r in d.rooms -%}
-        {%- if room.name == r.name -%}
-          {%- assign room_displayed = true -%}
-          {%- break -%}
-        {%- endif -%}
-      {%- endfor -%}
-    {%- endfor -%}
-    {%- unless room_displayed %}
+    {% for room in site.rooms or site.conference.location.hide -%}
       <li class="nav-item">
-        {%- if room.hide or site.conference.location.hide %}
+        {% if room.hide -%}
           <span class="nav-item nav-link disabled">
             {{ room.name }}
           </span>
-        {%- else %}
+        {%- else -%}
           <a class="nav-link {% if this_room.name == room.name %}active{% endif %}" href="{{ room.url | prepend: site.baseurl }}">
             {{ room.name }}
           </a>
         {%- endif %}
       </li>
-    {%- endunless -%}
-  {%- endfor %}
-</ul>
+    {%- endfor %}
+  </ul>
+{% endunless %}

data/_layouts/data.html

@@ -15,13 +15,10 @@
     {%- assign first_room = true -%}
     {%- for room in site.rooms %}
         {%- if room.live -%}
-            {%- if room.live.absolute_url -%}
-                {%- assign room_live_href = room.live.absolute_url -%}
-            {%- elsif room.live.relative_url -%}
-                {%- assign room_live_href = room.live.relative_url | prepend: site.baseurl -%}
-            {%- else -%}
+            {%- include partials/get_room_live_href.html -%}
+            {%- unless room_live_href -%}
                 {%- continue -%}
-            {%- endif -%}
+            {%- endunless -%}
 
             {%- unless first_room -%}
                 ,

data/_layouts/page.html

@@ -1,7 +1,7 @@
 {% include partials/header.html %}
 
 {% if page.title -%}
-  <h1 class="font-weight-light mb-2">{{ page.title }}</h1>
+  <h1 class="display-5 mb-3">{{ page.title }}</h1>
 {%- endif %}
 
 {{ content }}

data/_layouts/stream-overview.html

@@ -21,7 +21,8 @@
     <div class="col-md mb-4">
       <h3>{{ room.name }}</h3>
       <div class="embed-responsive embed-responsive-16by9">
-        <iframe class="embed-responsive-item" src="{{ room.live }}" allowfullscreen></iframe>
+        {%- include partials/get_room_live_href.html %}
+        <iframe class="embed-responsive-item" src="{{ room_live_href }}" allowfullscreen></iframe>
       </div>
     </div>
 

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.3
 platform: ruby
 authors:
 - Lorenz Schmid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-20 00:00:00.000000000 Z
+date: 2023-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.32
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.32
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +86,7 @@ files:
 - _includes/partials/get_main_category.html
 - _includes/partials/get_page_description.html
 - _includes/partials/get_page_title.html
+- _includes/partials/get_room_live_href.html
 - _includes/partials/get_talk_time.html
 - _includes/partials/get_talk_timestamp.html
 - _includes/partials/get_time_pronoun.html
@@ -286,7 +287,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