jekyll-theme-conference 3.4.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50470940d27a0744cdf32312e829e73af0c6375241575e6eb074695edfee7028
-  data.tar.gz: 1444781b0f41ffc7d267fe324b9cfabb5afd709ee27c24d95bd6b34d02d57060
+  metadata.gz: 0da457627a261ffda7837260a6b66294a383971e653ea3e3f05299cb8f672f8f
+  data.tar.gz: b02dc7da45e1e76386635952414d57c0c22727fa6e4c6e0968e5e55db58266d3
 SHA512:
-  metadata.gz: 872ad7d006fbcb1c552dc863982d037e3eb9ba2ca8e8aab9d785d9e55ba0651c19c367ce03a0280317947e5ad2352b40eefc66a47e6bb5e3cbc1a3c36d298d91
-  data.tar.gz: 8000b8d73b08f71554efad482cd8cf5518db22b01fc3828c985b669e5b013819785f4c41369ef5007ea375bf49f0b5b2195864e79d88c9d55bb089c9b5149388
+  metadata.gz: 23c9ce1a8794dc7f25d5973c3ce70fd1c3dbb599ffc73c5a5e9fe4135a001e4ca173671d2433f66b15dd0bdc517fee1637a52325a2f233107d0590b1f554563e
+  data.tar.gz: ab334e1c2cd367f9ff3eebbc4d00760fc19a0ea0a1a7ea20df8d3bcc8ed0740a73464bb4b29db87452c780c4ade88b094766cff5377166a0249272105c5f50ee

data/README.md

@@ -35,20 +35,20 @@ The theme was originally created for the yearly Winterkongress conference of the
   * [Open Graph Link Preview](#open-graph-link-preview)
   * [Main Landing Page](#main-landing-page)
   * [Information Boxes](#information-boxes)
-  * [Live Indications & Streaming](#live-indications---streaming)
+  * [Live Indications & Streaming](#live-indications--streaming)
   * [Map](#map)
   * [Talk Settings](#talk-settings)
   * [Speaker Settings](#speaker-settings)
   * [Location Settings](#location-settings)
   * [Program Settings](#program-settings)
 - [Content](#content)
-  * [Schedule / Program](#schedule---program)
+  * [Schedule / Program](#schedule--program)
   * [Talks](#talks)
   * [Speakers](#speakers)
   * [Rooms](#rooms)
   * [Links](#links)
 - [Overview Pages](#overview-pages)
-  * [Location / Room Overview](#location---room-overview)
+  * [Location / Room Overview](#location--room-overview)
   * [Live Stream Overview](#live-stream-overview)
   * [Additional Pages](#additional-pages)
 - [Design](#design)
@@ -380,27 +380,35 @@ conference:
 
 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). Instead of opening the modal an external link can also be used.
+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 embedded live stream. The URL to the live stream has to be set via `live` property in each room (see the _Content_ > _Room_ section below). Instead of opening the modal an external link can also be used.
 
-In order to activate the functionality, each day in the `program.yml` file must contain a `date` property (see section _Content_ > _Schedule / Program_ below) and the `live` property has to be set in the configuration file containing
+In order to activate these functionalities, each day in the `program.yml` file must contain a `date` property (see section _Content_ > _Schedule / Program_ below) and the `live` property has to be set in the configuration file containing
 
-- how long a pause between two consecutive talks has to be for the live indication to pause (`time_stop`),
-- optionally if streaming is enabled (`streaming`) with indications
-  + how many minutes the stream goes active before a talk (`time_prepend`),
-  + how many minutes the stream stays active after a talk (`time_extend`),
-  + how long a pause between two consecutive talks has to be for the stream to pause (`time_pause`), and
+- how long a pause between two consecutive talks has to be for the live indication to pause (`stop`),
+- optionally under the `streaming` property:
+  + if streaming should be enabled (`enable`), and if enabled
+  + how many minutes the stream goes active before a talk (`prepend`),
+  + how many minutes the stream stays active after a talk (`extend`),
+  + how long a pause between two consecutive talks has to be for the stream to pause (`pause`), and
   + optionally an external (absolute) link to which the user will be redirected instead of opening the modal (`external`),
-- optionally a demo mode setting, whereby the JavaScript function cycles through the entire program in five minutes for demonstration purposes (`demo: true`, default: `false`).
+- optionally under the `demo` property:
+  + if a demonstration mode should be enabled (`enable`), whereby the JavaScript function cycles continuously through the entire program in a few minutes, and if enabled
+  + how long the demonstration should take (`duration`), and
+  + how long the pause between two demonstration cycle should be (`pause`).
 
 ```yaml
 conference:
   live:
-    time_stop: 240      # in minutes
+    stop: 240      # in minutes
     streaming:
-      time_pause:   60  # in minutes
-      time_prepend:  5  # in minutes
-      time_extend:   5  # in minutes
-    demo: false
+      enable: true
+      pause:   60  # in minutes
+      prepend:  5  # in minutes
+      extend:   5  # in minutes
+    demo:
+      enable: false
+      duration: 300  # in seconds
+      pause:     10  # in seconds
 ```
 
 ### Map
@@ -495,11 +503,11 @@ Example:
 
 {% include js/conference.js %}
 
-(function() {
-    let map = window.conference.map;
+(() => {
+    const map = window.conference.map;
 
     if (typeof map !== 'undefined') {
-        var main_station = L.marker([47.37785, 8.54035], {
+        let main_station = L.marker([47.37785, 8.54035], {
             icon: L.divIcon({
                 className: '',
                 html: '<span class="fas fa-train"></span> Main Station',
@@ -590,7 +598,8 @@ Each talk is represented by a file in the `_talks/` directory. It must begin wit
 - the talk's `name` (used as identifier),
 - one or more existing `speakers` name(s),
 - optionally one or more `categories` of which one should be a main category as defined in the site's configuration,
-- optionally a list of `links` (see the _Links_ subsection below for the available properties per link; links with icons are treated separately and are also included on the talk overview page), and
+- optionally a list of `links` (see the _Links_ subsection below for the available properties per link; links with icons are treated separately and are also included on the talk overview page),
+- optionally a list of `live: links` (see the _Links_ subsection below for the available properties per link) which are shown below the live stream for the given talk in form of buttons, and
 - optionally `hide: true` if the talk's page should not be linked to.
 
 ### Speakers
@@ -611,7 +620,22 @@ Each room is represented by a file in the `_rooms/` directory. It must begin wit
 
 - 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).
+- optionally under the `live` property a URL pointing to a live stream for the given room during the conference (see the section _Live Indications & Streaming_ above), either:
+  * as an `absolute_url`, or
+  * a `relative_url`.
+
+Example:
+
+```yaml
+---
+name: The Room
+hide: false
+live:
+  absolute_url: https://github.com
+---
+
+...
+```
 
 ### Links
 

data/_includes/js/conference.js

@@ -1,32 +1,42 @@
-// Global app variable
-window.conference = {};
+// Libraries
+//   Bootstrap (Style Framework)
+{% include js/lib/jquery-3.5.1.min.js %}
+{% include js/lib/popper.min.js %}
+{% include js/lib/bootstrap.js %}
 
-// Bootstrap (Style Framework)
-{% include js/jquery-3.5.1.min.js %}
-{% include js/popper.min.js %}
-{% include js/bootstrap.js %}
+//   FontAwesome (Icons)
+//     Imported via CSS and webfonts
+
+// Conference
+window.conference = {
+    config: {
+        baseurl: '{{ site.baseurl }}'
+    }
+};
 
-// FontAwesome (Icons)
-//   Imported via CSS and webfonts
 
 // Program
-{% include js/conference-program.js %}
+{% include js/lib/syncscroll.js %}
+{% include js/program.js %}
 
 // Leaflet (Map Display)
 {% include partials/get_enable_map.html %}
 {% if enable_map %}
-    {% include js/leaflet.js %}
-    {% include js/leaflet-easybutton.js %}
-    {% include js/leaflet-locatecontrol.js %}
-    {% include js/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/conference-map.js %}
+    {% include js/map.js %}
 {% endif %}
 
 // Modals ("Popups")
-{% include js/conference-modal.js %}
+{% include js/modal.js %}
 
 // Live and Streaming
 {% if site.conference.live %}
-    {% include js/conference-live.js %}
+    {% include js/live.js %}
 {% endif %}
+
+// Load configuration and start initialization
+{% include js/init.js %}

data/_includes/js/init.js

@@ -0,0 +1,37 @@
+const init = () => {
+    // Load configuration
+    const request = new Request(window.conference.config.baseurl + '/assets/js/config.json');
+
+    fetch(request)
+    .then(response =>
+        response.json()
+    )
+    .then(config => {
+        // Add configuration to global scope
+        window.conference.config = Object.assign(window.conference.config, config);
+
+        // Execute initialization functions
+        for (const [name, module] of Object.entries(window.conference)) {
+            if (name == 'config') {
+                continue;
+            }
+
+            let c;
+            if (name in config) {
+                c = config[name];
+            }
+            let l;
+            if (name in config.lang) {
+                l = config.lang[name];
+            }
+
+            module.init(c, l)
+        }
+
+    })
+    .catch((error) => {
+        console.log(error);
+    });
+};
+
+init();