jekyll-theme-conference 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8d4fe78f7da2eba1de22ca1b58a6cd57fefd89729aae6efc5ec6e34bc61bf85
-  data.tar.gz: 14da05b22aec27e04c3827682c686fc07444ab42f0b38c99c0158f818f363dce
+  metadata.gz: 91444cf0a7c14c4e1d4a10547c95fd9c6a10b176db297a2071830f2a634052c0
+  data.tar.gz: 5c16b5f374876f5bde05ff91c0e121133843f31ad42701ef8336b523933101ba
 SHA512:
-  metadata.gz: 58c2b9524a42cc13bcc1cb91075bc35cdc223418b23bd926bd21cc849688d60f543d13fadaf4ad46ac21ff8091a798478fad9daf331ae49db1b88d6ae6b56f7f
-  data.tar.gz: abe66bdd148005dc8293d4604070c00bfb41203b33767ab4f05341da278b67527738800ad20880f8c39af85825549f91ae47069a6f6f029716ccae065e25a648
+  metadata.gz: c2e410318beee836c5d3371185d5e5386f24a28c34061eeb0fc407ec68715326e55f9344021b93c2ded7631df376c45723fbeac84a3e7ae9c5f7a781e981abcc
+  data.tar.gz: a3a3fefe3e080e42fdf24923fe36189593aeaafd87a2e90624ce42a2fa6ba766a5436201cbb63a5e7b34fba71ea695e05a9ddbadf13352fddc4792c8423444f9

data/README.md

@@ -18,6 +18,41 @@ The theme was originally created for the yearly Winterkongress conference of the
 - [Demo: Winterkongress](https://digitale-gesellschaft.ch/kongress/)
 
 
+## Table of Contents
+
+- [Installation](#installation)
+  * [Gem-based Method](#gem-based-method)
+  * [Remote Theme Method](#remote-theme-method)
+- [Setup](#setup)
+  * [Jump Start](#jump-start)
+  * [Automatic Import](#automatic-import)
+  * [Automatic Build](#automatic-build)
+- [Configuration](#configuration)
+  * [Theme Verification](#theme-verification)
+  * [Collection URLs](#collection-urls)
+  * [Language](#language)
+  * [Navigation Bar](#navigation-bar)
+  * [Main Landing Page](#main-landing-page)
+  * [Information Boxes](#information-boxes)
+  * [Live Indications & Streaming](#live-indications---streaming)
+  * [Talk Settings](#talk-settings)
+  * [Speaker Settings](#speaker-settings)
+  * [Location Settings](#location-settings)
+  * [Program Settings](#program-settings)
+- [Content](#content)
+  * [Schedule / Program](#schedule---program)
+  * [Talks](#talks)
+  * [Speakers](#speakers)
+  * [Rooms](#rooms)
+  * [Links](#links)
+- [Overview Pages](#overview-pages)
+  * [Location / Room Overview](#location---room-overview)
+  * [Live Stream Overview](#live-stream-overview)
+  * [Additional Pages](#additional-pages)
+- [Design](#design)
+- [License](#license)
+
+
 ## Installation
 
 There are three ways to install: As a [Gem-based theme](https://jekyllrb.com/docs/themes/#understanding-gem-based-themes), as a [remote theme](https://github.blog/2017-11-29-use-any-theme-with-github-pages/) (GitHub Pages compatible), or by cloning/forking this repository and reference to it directly.

data/_includes/js/conference-live.js

@@ -35,28 +35,34 @@ window.conference.live = (function() {
     let streamInfoTimer;
 
     let loadData = function () {
+        // Fetch schedule from external file
         $.getJSON('{{ site.baseurl }}/assets/js/data.json', function(json) {
             data = json;
         });
     };
 
     let getData = function () {
+        // Return data
         return data;
     };
 
     let mod = function (n, m) {
+        // Absolute modulo
         return ((n % m) + m) % m;
     };
 
     let timeNow = function () {
+        // Current timestamp in seconds
         return Math.floor(Date.now() / 1000);
     };
 
     let timeCont = function () {
+        // Continuous time (respecting previous pauses)
         return timeNow() - timeOffset;
     };
 
     let timeCycle = function () {
+        // Cyclic timestamp in seconds
         let actTime = timeNow();
         let relTime = mod(actTime, durDemo + 2*durPause) / (durDemo + 2*durPause);
         let cycleTime = mod((demoEnd - demoStart) * relTime - timeOffset, (demoEnd - demoStart)) + demoStart;
@@ -64,6 +70,7 @@ window.conference.live = (function() {
     };
 
     let time = function () {
+        // Return app time
         if (freezeTime) {
             return timeFrozen;
         }
@@ -76,6 +83,7 @@ window.conference.live = (function() {
     };
 
     let pauseTime = function () {
+        // Pause app time
         if (!freezeTime) {
             timeFrozen = time();
             freezeTime = true;
@@ -85,6 +93,7 @@ window.conference.live = (function() {
     };
 
     let continueTime = function () {
+        // Continue app time
         if (freezeTime) {
             freezeTime = false;
             timeOffset += time() - timeFrozen;
@@ -92,18 +101,23 @@ window.conference.live = (function() {
         }
     };
 
-    let resetTime = function (timeStr) {
+    let resetTime = function () {
+        // Reset app time
         timeOffset = 0;
         freezeTime = false;
 
         startUpdate();
     };
 
-    let setTime = function (newTime, newDay=1) {
+    let setTime = function (newTime, newDay) {
+        // Set and pause app time
         pauseTime();
 
         let dayIdx;
-        if (Number.isInteger(newDay)) {
+        if (arguments.length < 2) {
+            dayIdx = 0;
+        }
+        else if (Number.isInteger(newDay)) {
             dayIdx = newDay-1;
         }
         else if (/^[0-9]{4}-[0-9]{2}-[0-9]{2}$/.test(newDay)) {
@@ -112,7 +126,7 @@ window.conference.live = (function() {
         else {
             dayIdx = data.days.find(o => o.name === newDay);
         }
-        newDate = data.days[dayIdx].date;
+        let newDate = data.days[dayIdx].date;
 
         let d = new Date(newDate);
         newTime = newTime.split(':');
@@ -123,7 +137,10 @@ window.conference.live = (function() {
         update();
     };
 
-    let getTime = function (tConvert=time()) {
+    let getTime = function () {
+        // Return app time as string
+        let tConvert = time();
+
         let d = new Date(tConvert * 1000);
         let dStr = d.toISOString().slice(0,10);
         let h = d.getHours();
@@ -133,6 +150,7 @@ window.conference.live = (function() {
     };
 
     let timeUnit = function () {
+        // App time refresh rate
         if (demo) {
             return 0.1;
         }
@@ -142,6 +160,7 @@ window.conference.live = (function() {
     };
 
     let delayStart = function (startTime) {
+        // Seconds until given startTime occurs
         let tNow = time();
         let tUnit = timeUnit();
 
@@ -161,21 +180,25 @@ window.conference.live = (function() {
     };
 
     let toggleDemo = function () {
+        // Toggle app demo mode
         demo = !demo;
         resetTime();
     };
 
     let demoOn = function () {
+        // Return app demo status
         return demo;
     };
 
     let updateLive = function () {
+        // Update status all live elements in DOM
         let tNow = time();
         let liveShow = document.getElementsByClassName('live-show');
         let liveHide = document.getElementsByClassName('live-hide');
         let liveTime = document.getElementsByClassName('live-time');
         let livePast = document.getElementsByClassName('live-past');
 
+        // Show elements for a given period
         for (let i = 0; i < liveShow.length; i++) {
             let tStarts = liveShow[i].dataset.start.split(',');
             let tEnds = liveShow[i].dataset.end.split(',');
@@ -193,6 +216,7 @@ window.conference.live = (function() {
             }
         }
 
+        // Hide elements for a given period
         for (let i = 0; i < liveHide.length; i++) {
             let tStarts = liveHide[i].dataset.start.split(',');
             let tEnds = liveHide[i].dataset.end.split(',');
@@ -212,6 +236,7 @@ window.conference.live = (function() {
             }
         }
 
+        // Update duration string for given elements
         for (let i = 0; i < liveTime.length; i++) {
             let t = liveTime[i].dataset.time;
             if (typeof t == "undefined") {
@@ -271,6 +296,7 @@ window.conference.live = (function() {
             liveTime[i].innerHTML = tStr;
         }
 
+        // Disable elements for a given period
         for (let i = 0; i < livePast.length; i++) {
             let t = livePast[i].dataset.time;
             if (typeof t == "undefined") {
@@ -290,13 +316,14 @@ window.conference.live = (function() {
             }
         }
 
+        // Cancel timer after program is over
         if (tNow > confEnd && !demo) {
-            // Cancel timer after program is over
             stopUpdateLive();
         }
     };
 
     let startUpdateLive = function () {
+        // Start update timer to update live elements in DOM
         stopUpdateLive();
         updateLive();
 
@@ -313,6 +340,7 @@ window.conference.live = (function() {
     };
 
     let stopUpdateLive = function () {
+        // stopUpdate update timer to update live elements in DOM
         if (typeof liveTimer !== "undefined") {
             clearInterval(liveTimer);
         }
@@ -326,6 +354,7 @@ window.conference.live = (function() {
         let streamModal;
 
         let getRoom = function (roomName) {
+            // Return room object for given room name
             if (roomName in data.rooms) {
                 return data.rooms[roomName];
             }
@@ -335,6 +364,7 @@ window.conference.live = (function() {
         };
 
         let getNextTalk = function (roomName) {
+            // Get talk object for next talk in given room
             let timeNow = time();
             let talksHere = data.talks[roomName];
 
@@ -351,6 +381,7 @@ window.conference.live = (function() {
         };
 
         let getNextPause = function (roomName) {
+            // Get time object for next pause in given room
             let timeNow = time();
             let talksHere = data.talks[roomName];
 
@@ -369,20 +400,24 @@ window.conference.live = (function() {
             return false;
         };
 
-        let setStreamContent = function (content) {
+        let setStreamIframeContent = function (content) {
+            // Set stream modal iframe to show given text
             streamModal.find('iframe').attr('src', '');
             streamModal.find('iframe').addClass('d-none');
             streamModal.find('#stream-placeholder > div').text(content);
             streamModal.find('#stream-placeholder').addClass('d-flex');
         };
 
-        let setStreamSrc = function (href) {
+        let setStreamIframeSrc = function (href) {
+            // Set stream modal iframe to show given URL
             streamModal.find('iframe').attr('src', href);
             streamModal.find('#stream-placeholder').addClass('d-none').removeClass('d-flex');
             streamModal.find('iframe').removeClass('d-none');
         };
 
         let setStreamVideo = function (roomName) {
+            // Update stream modal iframe:
+            // Show stream with start/pause/end message (for given room) and keep updated
             let timeNow = time();
 
             let talksHere = data.talks[roomName];
@@ -395,7 +430,7 @@ window.conference.live = (function() {
 
             // Conference not yet started
             if (timeNow < roomStart - streamPrepend*60) {
-                setStreamContent('{{ site.data.lang[site.conference.lang].live.pre_stream | default: "Live stream has not started yet." }}');
+                setStreamIframeContent('{{ site.data.lang[site.conference.lang].live.pre_stream | default: "Live stream has not started yet." }}');
 
                 if (!freezeTime) {
                     streamVideoTimer = setTimeout(setStreamVideo, delayStart(roomStart - streamPrepend*60) * 1000, roomName);
@@ -404,7 +439,7 @@ window.conference.live = (function() {
 
             // Conference is over
             else if (timeNow > roomEnd + streamExtend*60) {
-                setStreamContent('{{ site.data.lang[site.conference.lang].live.post_stream | default: "Live stream has ended." }}');
+                setStreamIframeContent('{{ site.data.lang[site.conference.lang].live.post_stream | default: "Live stream has ended." }}');
 
                 if (!freezeTime && demo) {
                     streamVideoTimer = setTimeout(setStreamVideo, delayStart(roomEnd - streamPrepend*60) * 1000, roomName);
@@ -417,7 +452,7 @@ window.conference.live = (function() {
 
                 // Currently stream is paused
                 if (pauseNext && timeNow >= pauseNext.start + streamExtend*60 && timeNow <= pauseNext.end - streamPrepend*60) {
-                    setStreamContent('{{ site.data.lang[site.conference.lang].live.pause_stream | default: "Live stream is currently paused." }}');
+                    setStreamIframeContent('{{ site.data.lang[site.conference.lang].live.pause_stream | default: "Live stream is currently paused." }}');
 
                     if (!freezeTime) {
                         streamVideoTimer = setTimeout(setStreamVideo, delayStart(pauseNext.end - streamPrepend*60) * 1000, roomName);
@@ -426,7 +461,7 @@ window.conference.live = (function() {
                 // Currently a talk is active
                 else {
                     let room = getRoom(roomName);
-                    setStreamSrc(room.href);
+                    setStreamIframeSrc(room.href);
 
                     if (!freezeTime) {
                         if (pauseNext) {
@@ -441,6 +476,8 @@ window.conference.live = (function() {
         };
 
         let setStreamInfo = function (roomName) {
+            // Update stream modal info bar:
+            // Show next talk and speaker (for given room) and keep updated
             let timeNow = time();
             let talkNext = getNextTalk(roomName);
 
@@ -495,6 +532,7 @@ window.conference.live = (function() {
         };
 
         let setStream = function (roomName) {
+            // Update stream modal (iframe and info bar) for given room
             streamModal.find('.modal-footer .btn').removeClass('active');
             streamModal.find('#stream-select').val(0);
 
@@ -510,6 +548,7 @@ window.conference.live = (function() {
         };
 
         let updateStream = function () {
+            // Update stream modal for currently active room button
             if (streamModal.hasClass('show')) {
                 let activeButton = streamModal.find('.modal-footer .btn.active');
                 let roomName = activeButton.data('room');
@@ -521,6 +560,7 @@ window.conference.live = (function() {
         };
 
         let stopUpdateStream = function () {
+            // Stop stream modal update timer
             if (typeof streamVideoTimer !== "undefined") {
                 clearInterval(streamVideoTimer);
             }
@@ -529,13 +569,15 @@ window.conference.live = (function() {
             }
         };
 
-        let hideModal = function (event) {
+        let hideModal = function () {
+            // Close stream modal
             streamModal.find('iframe').attr('src', '');
             streamModal.find('.modal-footer .btn').removeClass('active');
             streamModal.find('#stream-select').selectedIndex = -1;
         };
 
         let setupStream = function () {
+            // Setup events when modal opens/closes
             streamModal = $('#stream-modal');
 
             // configure modal opening buttons
@@ -544,8 +586,8 @@ window.conference.live = (function() {
                 let roomName = button.data('room');
                 setStream(roomName);
             });
-            streamModal.on('hide.bs.modal', function (event) {
-                hideModal(event);
+            streamModal.on('hide.bs.modal', function () {
+                hideModal();
             });
 
             // configure room selection buttons in modal

data/_includes/js/conference-map.js

@@ -24,7 +24,7 @@ window.conference.mapConfig = (function() {
     };
 
     let init = function () {
-        elId = 'map';
+        let elId = 'map';
 
         if (document.getElementById(elId)) {
             setup(elId);

data/_includes/js/conference-modal.js

@@ -51,7 +51,7 @@ window.conference.modal = (function () {
         }
     };
 
-    let hide = function (el, event) {
+    let hide = function (el) {
         let modal = $(el);
 
         modal.find('.modal-title h3').text('');
@@ -61,13 +61,13 @@ window.conference.modal = (function () {
     };
 
     let init = function() {
-        elSel = '#link-modal';
+        let elSel = '#link-modal';
 
         $(elSel).on('show.bs.modal', function (event) {
             show(this, event);
         });
-        $(elSel).on('hide.bs.modal', function (event) {
-            hide(this, event);
+        $(elSel).on('hide.bs.modal', function () {
+            hide(this);
         });
     };
 

data/_includes/js/conference-program.js

@@ -34,7 +34,7 @@ window.conference.program = (function() {
             }
 
             // Add current selected day as hash to URL while keeping current scrolling position
-            $('a[data-toggle="tab"]').on('shown.bs.tab', function (e) {
+            $('a[data-toggle="tab"]').on('shown.bs.tab', function () {
                 updateHash(this.hash);
             });
         }

data/_includes/js/syncscroll.js

@@ -29,7 +29,7 @@ function (exports) {
         var elems = document.getElementsByClassName('syncscroll');
         var i, j, el, found, name;
         for (name in names) {
-            if (names.hasOwnProperty(name)) {
+            if (Object.prototype.hasOwnProperty.call(names, name)) {
                 for (i = 0; i < names[name].length; i++) {
                     names[name][i].removeEventListener(
                         'scroll', names[name][i].syn, 0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-conference
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Lorenz Schmid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-14 00:00:00.000000000 Z
+date: 2021-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll