jekyll-theme-conference 2.3.1 → 2.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c720f58e937e6ff0aed3eee7e9107c09d8c23d5b0baa5724c54a23cacb33ee4b
-  data.tar.gz: 5e7b98cde919f1a3dd6290b46d287ea73565bf0d40927f82fa6ecce00cc52044
+  metadata.gz: 0ebb94e878ab7f234d64b2a45c45153438c9e075251d9dda31bc12e670168f91
+  data.tar.gz: '0980a8034943452466ce56df8e81a76b4e0f1bb9f2d66fa9ad7a8028157cf6b8'
 SHA512:
-  metadata.gz: ed80869f7fc9dbb226ccfee9e4eb3c537e64dd3f0a9db674afb24cb48dffd4b50e31be01c50bbd635493de0c4490388c52fba0cb88119fedaabeadd487e89951
-  data.tar.gz: 7058af0d31c5b99356d5c33707df521c3858759aa3180143fd8d1d2ca3ddefb7b9a3349f320366071709d0737206ecffecb78bacddd2f06a4a02779a57a6b652
+  metadata.gz: dfb07d4cad799e4c8e1d2742966b5dce78d586e2d73b359f6f5b8cffd6aacc7f8b510dbadeec3af407f92cd9801eae12edff14240ec81621e8c86de0abc77e93
+  data.tar.gz: b2381ce0e3e608130c37f55695e3c27af9980f3097359b6989ecb257bad158611bbfc00b61464835b48a3aadb9144e31077a3e4778ee6f746c953a1f20269bd0

data/README.md

@@ -89,6 +89,10 @@ The different talks, speakers and rooms are stored as a collection of files. Eac
 
 The actual schedule defining when and in which room a talk takes place is stored as a [YAML data file](https://jekyllrb.com/docs/datafiles/) under `_data/program.yml`. For further details about it see below in the section _Content_.
 
+:warning: Please note that the generated website can be quite large containing many unnecessary whitespaces. It is recommended to minimize the generated output files before uploading them to a server (e.g. with [minify](https://github.com/tdewolff/minify)).
+
+### Jump Start
+
 In order to be up and running simply use the default content of this repository as an initial base for your new website. After having setup a new Jekyll website copy the following files and folders into the website's folder:
 
 - `_config.example.yml` -> `_config.yml`
@@ -102,11 +106,23 @@ In order to be up and running simply use the default content of this repository
 - `speakers/`
 - `talks/`
 
-There exists a Python file in this repository, `create_entries.py`, which can be used to import content from a CSV table and generate the different talk, speakers and room files automatically based on it. Just open your terminal and type `python create_entries.py --help` to show the help and get started.
+### Automatic Import
+
+There exists a Python file in this repository, `create_entries.py`, which can be used to import content from a [frab](https://github.com/frab/frab/wiki/Manual#introduction) compatible JSON file or a CSV table and generate the different talk, speakers and room files automatically based on it. Just open your terminal and type `python create_entries.py --help` to show the help and get started.
+
+### Automatic Build
 
-In case you do not want to install the entire Ruby/Jekyll toolchain on your machine you can make use of [GitHub Actions](https://github.com/features/actions), Github's continuous integration platform. This repository contains an example Github Action configuration file which automatically builds the website upon adding a new tag. It then attaches the generated website as package to a release for easy downloading. Simply copy the following file to your repository and adapt it to your needs:
+In case you do not want to install the entire Ruby/Jekyll toolchain on your machine you can make use of [GitHub Actions](https://github.com/features/actions), Github's continuous integration platform. This repository contains an example Github Action configuration file which automatically builds and minimizes the website upon adding a new tag. It then attaches the generated website as package to a release for easy downloading. Simply copy the following file to your repository and adapt it to your needs:
 
-- `workflows.example.yml` -> `.github/workflows.main.yml`
+- `workflow-example.yml` -> `.github/workflows/main.yml`
+
+Hidden rooms, speakers, or talks are automatically generated in way containing no content. In order to remove these empty files simply add a file called `delete_hidden.sh` to the root with the following content. It will automatically called by the Github Action workflow to delete the files.
+
+```markdown
+---
+layout: delete_hidden
+---
+```
 
 
 ## Configuration
@@ -124,6 +140,8 @@ conference:
   show_errors: false
 ```
 
+:warning: Please be sure to disable this parameter for your production system.
+
 ### Collection URLs
 
 The three required collections containing the files for the talks, speakers and rooms have to be specified in the `_config.yml` file. The first block declares them and sets the URL under which they will later be accessed. The second block defines the default layout for each of the collection.
@@ -183,10 +201,6 @@ conference:
 
 The navigation bar is located at the top and visible on every site. On the right it show the title of the website (`site.title`) followed by the links listed under the `links` property of the `navigation` property. See the _Content_ > _Links_ section below for the available properties per link.
 
-Additionally, a navigation bar link can also have the following properties:
-
-- `menu` containing another list of links. This creates a dropdown menu of multiple sublinks. The sublinks have the same properties as regular links (see the _Content_ > _Links_ section).
-
 Example:
 
 ```yaml
@@ -195,6 +209,7 @@ conference:
     links:
       - name: Program
         relative_url: /program/
+      - live: true
       - name: Previous Editions
         menu:
           - name: 2020 (current)
@@ -224,7 +239,7 @@ conference:
 
 The main landing page is shown at the root of the website to greet new visitors. In order to show it you need to create a `index.md` file in the root of your website's folder and specify its layout as `layout: main`. The remaining customizations are specified in the `_config.yml` file.
 
-The main page states your site's title (`site.title`) or a logo instead. The logo can be configured through the `logo` property under the `main` property containing:
+The main page states your site's title (`site.title`) or a logo instead. The logo can be configured through the `logo` property under the `main` property containing
 
 - a `img` property specifying the path to the image file relative to the `/assets/images/` folder.
 
@@ -286,7 +301,31 @@ conference:
         Try again next year.
 ```
 
-### Talk Settings: Main Categories and Icons
+### Live Indications & Streaming
+
+In order to help users navigating the program during the congress, a _Live_ indication can be shown next to talks which are currently taking place. A small JavaScript functions keeps the site automatically up-to-date (without the need to refresh) showing the indication as soon as the talk has started and hiding it once it is over (according to the timetable indicated in the `_data/program.yml` file).
+
+This can be further extended if some of the talks have an associated live stream: Upon clicking one of the live indications a modal will open containing the corresponding live stream embedded. The URL to the live stream has to be set via `live` property in each room (see the _Content_ > _Room_ section below).
+
+In order to activate the functionality the `live` property has to be set containing
+
+- the date of the day at which the conference takes place (`date`),
+- the timezone in which the conference takes place (`timezone`),
+- optionally if streaming is enabled (`streaming`) with indications how many minutes early the stream will begin and end, and
+- optionally a demo mode setting, whereby the JavaScript function cycles through the entire program in five minutes for demonstration purposes (`demo: true`, default: `false`).
+
+```yaml
+conference:
+  live:
+    date: 01.01.2020
+    timezone: GMT+1
+    streaming:
+      start_early: 15  # in minutes
+      end_late:     0  # in minutes
+    demo: false
+```
+
+### Talk Settings
 
 Each talk can have one or multiple categories associated via FrontMatter (see the _Individual Pages: Talks_ section below for more details). Some of these categories can be elevated to so called main categories". These are used to color group the talks across the entire website, particularly in the program. In order to do so add the `main_categories` property under the `talks` property. It consists of a list of all main categories. Each main category consists of:
 
@@ -314,11 +353,12 @@ conference:
         color: info
       - name: Cat B
         color: success
+
     # Hide icons on talk overview page
     hide_icons: false
 ```
 
-### Speaker Settings: First name
+### Speaker Settings
 
 In the program as well as the speaker's overview the speaker's first name can be abbreviated to its first letter. Of course, you also have the option to not specify a first name for each speaker in the first place. In order to shorten the first name add the `show_firstname: true` setting (default: `false`) to the `speakers` property.
 
@@ -330,7 +370,7 @@ conference:
     show_firstname: false
 ```
 
-### Location Settings: Hide all and configure map
+### Location Settings
 
 In case the location of your rooms is obvious (e.g. on a campus) you can decide to disable the location page and links to all the rooms. You still need to create the different rooms as files in the `_rooms/` directory, since they are needed as a reference. But there will not be any link pointing to it (effectively hiding them).
 In order to hide all rooms add the `hide: true` setting (default: `false`) to the `location` property.
@@ -353,7 +393,7 @@ conference:
       map_provider: "OpenStreetMap.Mapnik"
 ```
 
-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 `map` pointing to the Leaflet container.
+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.
 
 Example:
 
@@ -364,11 +404,13 @@ Example:
 {% include js/conference.js %}
 
 (function() {
+    let map = window.conference.map;
+
     if (typeof map !== 'undefined') {
         var main_station = L.marker([47.37785, 8.54035], {
             icon: L.divIcon({
                 className: '',
-                html: '<span class="fas fa-train"></span> Bahnhof Zürich',
+                html: '<span class="fas fa-train"></span> Main Station',
                 iconSize: [120, 56]
             })
         }).addTo(map);
@@ -454,8 +496,9 @@ Each speaker is represented by a file in the `_speakers/` directory. It must beg
 
 Each room is represented by a file in the `_rooms/` directory. It must begin with valid [YAML Front Matter](https://jekyllrb.com/docs/frontmatter/) containing
 
-- the room's `name`, and
-- optionally `hide: true` if the room's page should not be linked to.
+- the room's `name`
+- optionally `hide: true` if the room's page should not be linked to, and
+- optionally a URL pointing to a live stream for the given room during the conference (`live`, see the section _Live Indications & Streaming_ above).
 
 ### Links
 
@@ -471,6 +514,11 @@ Links are used at different location throughout the theme: They can either be us
   + pointing to a file uploaded to the `/documents` folder (for talks `/documents/slides`, for speakers `/documents/bio`): `file:`
   + pointing to an external video: `video:`
 
+Additionally, a navigation bar or main landing page link can also have the following properties:
+
+- `menu` containing another list of links. This creates a dropdown menu of multiple sublinks. The sublinks have the same properties as regular links, or
+- `live` making the link only visible during the conference and adds a live indication. The `name` property can be omitted. If streaming is enabled and any URL property is omitted, a click on the link will open the streaming modal (see section _Live Indications_ above).
+
 Using the `file:` indicator, the relative address is automatically set as well as the icon. Using the `video:` indicator, the link is automatically configured to open in an iframe with a corresponding title and the icon is set.
 
 Example:

data/_includes/js/conference-live.js

@@ -0,0 +1,415 @@
+    window.conference.live = (function() {
+    {%- include partials/get_conf_time.html -%}
+    {%- assign time_start = conf_start -%}
+    {%- assign time_end = conf_end -%}
+    {%- include partials/get_timestamp.html -%}
+
+    let confStart = {{ timestamp_start }};
+    let confEnd = {{ timestamp_end }};
+    let confDur = confEnd - confStart;
+
+    let freezeTime = false;
+    let timeFrozen = 0;
+    let timeOffset = 0;
+
+    let demo = {{ site.conference.live.demo | default: "false" }};
+    let durDemo  = 5*60; // in seconds
+    let durPause =   10; // in seconds
+
+    let demoStart = confStart - confDur/durDemo*durPause;
+    let demoEnd = confEnd + confDur/durDemo*durPause;
+
+    let liveTimer;
+    let streamTimer;
+
+    let mod = function (n, m) {
+        return ((n % m) + m) % m;
+    };
+
+    let timeNow = function () {
+        return Math.floor(Date.now() / 1000);
+    };
+
+    let timeCont = function () {
+        return timeNow() - timeOffset;
+    };
+
+    let timeCycle = function () {
+        let actTime = timeNow();
+        let relTime = mod(actTime, durDemo + 2*durPause) / durDemo;
+        let cycleTime = mod((demoEnd - demoStart) * relTime - timeOffset, (demoEnd - demoStart)) + demoStart;
+        return cycleTime;
+    };
+
+    let time = function () {
+        if (freezeTime) {
+            return timeFrozen;
+        }
+        else if (demo) {
+            return timeCycle();
+        }
+        else {
+            return timeCont();
+        }
+    };
+
+    let pauseTime = function () {
+        if (!freezeTime) {
+            timeFrozen = time();
+            freezeTime = true;
+
+            stopUpdate();
+        }
+    };
+
+    let continueTime = function () {
+        if (freezeTime) {
+            freezeTime = false;
+            timeOffset += time() - timeFrozen;
+            startUpdate();
+        }
+    };
+
+    let resetTime = function (timeStr) {
+        timeOffset = 0;
+        freezeTime = false;
+
+        startUpdate();
+    };
+
+    let setTime = function (newTime) {
+        pauseTime();
+
+        let d = new Date(confStart * 1000);
+        newTime = newTime.split(':');
+        d.setHours(newTime[0], newTime[1]);
+
+        timeFrozen = Math.floor(d.getTime() / 1000);
+
+        update();
+    };
+
+    let getTime = function (tConvert = time()) {
+        let d = new Date(tConvert * 1000);
+        let h = d.getHours();
+        let m = d.getMinutes();
+
+        return h + ":" + (m < 10 ? "0" : "") + m;
+    };
+
+    let timeUnit = function () {
+        if (demo) {
+            return 0.1;
+        }
+        else {
+            return 60;
+        }
+    };
+
+    let delayStart = function (startTime) {
+        let tNow = time();
+        let tUnit = timeUnit();
+
+        if (demo) {
+            // Convert virtual duration to real duration
+            return mod(startTime - tNow, demoEnd - demoStart) / (demoEnd - demoStart) * (durDemo + 2*durPause);
+        }
+        else {
+            if (startTime > tNow) {
+                return startTime - tNow;
+            }
+            else {
+                // Start on the unit
+                return (tUnit - (tNow % tUnit));
+            }
+        }
+    };
+
+    let toggleDemo = function () {
+        demo = !demo;
+        resetTime();
+    };
+
+    let demoOn = function () {
+        return demo;
+    };
+
+    let updateLive = function () {
+        let tNow = time();
+        let liveShow = document.getElementsByClassName('live-show');
+        let liveHide = document.getElementsByClassName('live-hide');
+
+        for (let i = 0; i < liveShow.length; i++) {
+            let tStart = liveShow[i].dataset.start;
+            let tEnd = liveShow[i].dataset.end;
+
+            if (tNow >= tStart && tNow < tEnd) {
+                // Show when active
+                liveShow[i].classList.remove('d-none');
+            }
+            else if (!liveShow[i].classList.contains('d-none')) {
+                // Hide otherwise
+                liveShow[i].classList.add('d-none');
+            }
+        }
+
+        for (let i = 0; i < liveHide.length; i++) {
+            let tStart = liveHide[i].dataset.start;
+            let tEnd = liveHide[i].dataset.end;
+
+            if (tNow >= tStart && tNow < tEnd) {
+                // Hide when active
+                if (!liveHide[i].classList.contains('d-none')) {
+                    liveHide[i].classList.add('d-none');
+                }
+            }
+            else {
+                // Show otherwise
+                liveHide[i].classList.remove('d-none');
+            }
+        }
+
+        if (tNow > confEnd && !demo) {
+            // Cancel timer after program is over
+            stopUpdateLive();
+        }
+    };
+
+    let startUpdateLive = function () {
+        stopUpdateLive();
+        updateLive();
+
+        if (demo) {
+            // Immediate start required since delayStart would wait for next wrap around
+            liveTimer = setInterval(updateLive, timeUnit() * 1000);
+        }
+        else {
+            setTimeout(function() {
+                liveTimer = setInterval(updateLive, timeUnit() * 1000);
+                updateLive();
+            }, delayStart(confStart) * 1000);
+        }
+    };
+
+    let stopUpdateLive = function () {
+        if (typeof liveTimer !== "undefined") {
+            clearInterval(liveTimer);
+        }
+    };
+
+    {% if site.conference.live.streaming -%}
+
+        let rooms = {
+            {%- for r in site.data.program -%}
+                {%- assign room = site.rooms | where: 'name', r.room | first -%}
+                {%- if room.live -%}
+
+                    {%- assign t = r.talks | first -%}
+                    {%- include partials/get_talk_time.html -%}
+                    {%- assign time_start = talk_start -%}
+                    {%- assign time_end = talk_end -%}
+                    {%- include partials/get_timestamp.html -%}
+
+                    {%- assign offset_start = site.conference.live.streaming.start_early | default: 0 -%}
+                    {%- assign room_ts_start = offset_start | times: -60 | plus: timestamp_start -%}
+
+                    {%- assign t = r.talks | last -%}
+                    {%- include partials/get_talk_time.html -%}
+                    {%- assign time_start = talk_start -%}
+                    {%- assign time_end = talk_end -%}
+                    {%- include partials/get_timestamp.html -%}
+
+                    {%- assign offset_end = site.conference.live.streaming.end_late | default: 0 -%}
+                    {%- assign room_ts_end = offset_end | times: 60 | plus: timestamp_end -%}
+
+                    "{{ room.name }}": {
+                        "id": {{ forloop.index }},
+                        "href": "{{ room.live }}",
+                        "start": {{ room_ts_start }},
+                        "end": {{ room_ts_end }}
+                    },
+                {%- endif -%}
+            {%- endfor -%}
+        };
+
+        let streamModal;
+
+        let getRoom = function (roomName) {
+            if (roomName in rooms) {
+                return rooms[roomName];
+            }
+            else {
+                return rooms[Object.keys(rooms)[0]];
+            }
+        };
+
+        let preStartStream = function (roomName) {
+            let room = getRoom(roomName);
+
+            streamModal.find('iframe').attr('src', '');
+            streamModal.find('iframe').addClass('d-none');
+            streamModal.find('#stream-placeholder > div').text('{{ site.data.lang[site.conference.lang].live.pre_stream | default: "Live stream has not started yet." }}');
+            streamModal.find('#stream-placeholder').addClass('d-flex');
+
+            stopUpdateStream();
+            if (!freezeTime) {
+                streamTimer = setTimeout(activeStream, delayStart(room.start) * 1000, roomName);
+            }
+        };
+
+        let activeStream = function (roomName) {
+            let room = getRoom(roomName);
+
+            streamModal.find('iframe').attr('src', room.href);
+            streamModal.find('#stream-placeholder').addClass('d-none').removeClass('d-flex');
+            streamModal.find('iframe').removeClass('d-none');
+
+            stopUpdateStream();
+            if (!freezeTime) {
+                streamTimer = setTimeout(postEndStream, delayStart(room.end) * 1000, roomName);
+            }
+        };
+
+        let postEndStream = function (roomName) {
+            let room = getRoom(roomName);
+
+            streamModal.find('iframe').attr('src', '');
+            streamModal.find('iframe').addClass('d-none');
+            streamModal.find('#stream-placeholder > div').text('{{ site.data.lang[site.conference.lang].live.post_stream | default: "Live stream has ended." }}');
+            streamModal.find('#stream-placeholder').addClass('d-flex');
+
+            stopUpdateStream();
+            if (!freezeTime && demo) {
+                streamTimer = setTimeout(preStartStream, delayStart(demoStart) * 1000, roomName);
+            }
+        };
+
+        let setStream = function (roomName) {
+            streamModal.find('.modal-footer .btn').removeClass('active');
+            streamModal.find('#stream-select').selectedIndex = -1;
+
+            let room = getRoom(roomName);
+            let tNow = time();
+
+            if (tNow < room.start) {
+                preStartStream(roomName);
+            }
+            else if (tNow > room.end) {
+                postEndStream(roomName);
+            }
+            else {
+                activeStream(roomName);
+            }
+
+            streamModal.find('#stream-button' + room.id).addClass('active');
+            streamModal.find('#stream-select').selectedIndex = room.id;
+        };
+
+        let updateStream = function () {
+            if (streamModal.hasClass('show')) {
+                let activeButton = streamModal.find('.modal-footer .btn.active');
+                let roomName = activeButton.data('room');
+
+                if (typeof roomName !== "undefined") {
+                    setStream(roomName);
+                }
+            }
+        };
+
+        let stopUpdateStream = function () {
+            if (typeof streamTimer !== "undefined") {
+                clearInterval(streamTimer);
+            }
+        };
+
+        let hideModal = function (event) {
+            streamModal.find('iframe').attr('src', '');
+            streamModal.find('.modal-footer .btn').removeClass('active');
+            streamModal.find('#stream-select').selectedIndex = -1;
+        };
+
+        let setupStream = function () {
+            streamModal = $('#stream-modal');
+
+            streamModal.on('show.bs.modal', function (event) {
+                let button = $(event.relatedTarget);
+                let roomName = button.data('room');
+                setStream(roomName);
+            });
+            streamModal.on('hide.bs.modal', function (event) {
+                hideModal(event);
+            });
+
+            streamModal.find('.modal-footer .btn').on('click', function(event) {
+                event.preventDefault();
+
+                let roomName = $(this).data('room');
+                setStream(roomName);
+            });
+
+            streamModal.find('#stream-select').on('change', function(event) {
+                event.preventDefault();
+
+                let roomName = $(this).children('option:selected').text();
+                setStream(roomName);
+            });
+        };
+
+        let setup = function () {
+            startUpdateLive();
+            setupStream();
+        };
+
+        let update = function () {
+            updateLive();
+            updateStream();
+        };
+
+        let startUpdate = function () {
+            startUpdateLive();
+            updateStream();
+        };
+
+        let stopUpdate = function () {
+            stopUpdateLive();
+            stopUpdateStream();
+        };
+
+    {%- else -%}
+
+        let setup = function () {
+            startUpdateLive();
+        };
+
+        let update = function () {
+            updateLive();
+        };
+
+        let startUpdate = function () {
+            startUpdateLive();
+        };
+
+        let stopUpdate = function () {
+            stopUpdateLive();
+        };
+
+    {%- endif %}
+
+    return {
+        init: setup,
+
+        pauseTime: pauseTime,
+        continueTime: continueTime,
+        resetTime: resetTime,
+        setTime: setTime,
+        getTime: getTime,
+
+        toggleDemo: toggleDemo,
+        demo: demoOn,
+        durDemo: durDemo,
+        durPause: durPause
+    };
+
+})();
+
+window.conference.live.init();