jekyll-theme-conference 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4f5a6058ed0096854e4b7d4714298ea9bc253a394b8170d3ae2d280bec3913e
-  data.tar.gz: 5ed07180716fc59636f3b5a9634fd7d430166796285566751a927ce9f15be913
+  metadata.gz: 32623dfa5fc548002ea9f1e8dac8b1e4c5833d33e6619bce8f77ea54c8080dc6
+  data.tar.gz: 565f13adc6ec08fab3a2240a8ef1adf0562454f1a4d9c58585c173d9ca583ecd
 SHA512:
-  metadata.gz: '08f8a0a6c90e0c23ee563b18200cbbd902385d388373c5b77ad05c6fda440914825b685771907947f7f2165378e2edd13ef7421d75133bf3e6d38f3ea6c75d8b'
-  data.tar.gz: 7095bab0d1cd826c3f1921d203ff67ae51f69c0d218196a0e45530cc227d2c3bab3e3b10529ffa27e840980fef9f9e6ed7cc5c6c3aa111a43ba2d7363bd54ddc
+  metadata.gz: bb1d8eae3fd5e858a24977bc77aafeebe6cdca657d4d0222afbcd40e0c4fe0011b13cacba8217cd32a68b7d6fd5fbda2756829f80bc44c601ad71aa79cc4ae36
+  data.tar.gz: fc2f250efcff400fbc2a96243d9f63f7659a1b071eae24391c1e6820f4cf03a63db4d43b119e0e38861423d48ab511c57dd184296d67d822756450ce4164c4c3

data/README.md

@@ -35,6 +35,7 @@ The theme was originally created for the yearly Winterkongress conference of the
   * [Main Landing Page](#main-landing-page)
   * [Information Boxes](#information-boxes)
   * [Live Indications & Streaming](#live-indications---streaming)
+  * [Map](#map)
   * [Talk Settings](#talk-settings)
   * [Speaker Settings](#speaker-settings)
   * [Location Settings](#location-settings)
@@ -50,6 +51,7 @@ The theme was originally created for the yearly Winterkongress conference of the
   * [Live Stream Overview](#live-stream-overview)
   * [Additional Pages](#additional-pages)
 - [Design](#design)
+- [Development](#development)
 - [License](#license)
 
 
@@ -137,9 +139,9 @@ In order to be up and running simply use the default content of this repository
 
 ### Automatic Import
 
-There exists a Python file in this repository, `_tools/create_entries.py`, which can be used to import content from a [frab](https://github.com/frab/frab/wiki/Manual#introduction) compatible JSON file (e.g. from [pretalx.com](https://pretalx.com/p/about/)) or a CSV table and generate the different talk, speakers and room files automatically. It has as only dependency [PyYAML](https://pypi.org/project/PyYAML/):
+There exists a Python file in this repository, `_tools/create_entries.py`, which can be used to import content from a [frab](https://github.com/frab/frab/wiki/Manual#introduction) compatible JSON file (e.g. from [pretalx.com](https://pretalx.com/p/about/)) or a CSV table and generate the different talk, speakers and room files automatically.
 
-1. Copy the file `_tools/create_entries.py` from this repository
+1. Copy the files `_tools/create_entries.py` and `_tools/requirements.txt` from this repository
 
 2. Create a virtual environment and activate it
 
@@ -148,10 +150,10 @@ There exists a Python file in this repository, `_tools/create_entries.py`, which
    source venv/bin/activate
    ```
 
-3. Install PyYAML
+3. Install the requirements
 
    ```bash
-   pip install pyyaml
+   pip install -r _tools/requirements.txt
    ```
 
 4. Execute the script, e.g. to show the help type
@@ -377,6 +379,21 @@ conference:
     demo: false
 ```
 
+### Map
+
+In order to help users finding your venue, an [OpenStreetMap](https://www.openstreetmap.org/) container displaying a map can be shown on any page. The map's initial position is globally defined and thus the same for all map containers. You can define the initial position of the map by setting the default zoom level `default_zoom`, the center coordinates `home_coord`, and the map provider for the tiles `map_provider`. Alternative map providers can be found [here](https://leaflet-extras.github.io/leaflet-providers/preview/).
+The map contains small control buttons to zoom in and out, center the map back to the initial position, and show the visitors current location (has to be manually activated and granted by the visitor).
+
+The map can be added to any page by setting `map: true` in its Front Matter or on the location main page by setting `conference.location.map: true` (see _Location Settings_ section below).
+
+```yaml
+conference:
+  map:
+    default_zoom: 17
+    home_coord: 47.37808, 8.53935
+    map_provider: "OpenStreetMap.Mapnik"
+```
+
 ### 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:
@@ -429,8 +446,9 @@ In order to hide all rooms add the `hide: true` setting (default: `false`) to th
 
 If your `location` overview file is not located under `/location` you can indicate an alternative path by setting the `url` property (default: `/location`) under the `location` property.
 
-The `location` layout automatically includes an [OpenStreetMap](https://www.openstreetmap.org/) container to point to your venue. If you want to hide it add the `enable: false` setting (default: `true`) to the `map` property under the `location` property. Otherwise, you can define the initial position of the map by setting the default zoom level `default_zoom`, the center coordinates `home_coord`, and the map provider for the tiles `map_provider`. Alternative map providers can be found [here](https://leaflet-extras.github.io/leaflet-providers/preview/).
-The map contains small control buttons to zoom in and out, center the map back to the initial position, and show the visitors current location (has to be manually activated and granted by the visitor).
+The location main page shows a navigation bar listing all the different rooms by name. Due to the quirks of Jekyll, the main page itself cannot be listed by title as defined in its Front Matter. Instead the title of the main landing page for the navigation bar is taken from the language files and defaults to "Directions". In order to change this, you can either change the language files directly (see the _Language_ section above), or you provide an alternative title by setting the `navbar_title` to the desired title under the `location` property.
+
+The `location` layout can include a map to point to your venue by adding the `map: true` setting (default: `true`) to the `location` property. See the _Map_ section above for more information.
 
 Example:
 
@@ -438,11 +456,9 @@ Example:
 conference:
   location:
     hide: false
-    map:
-      enable: true
-      default_zoom: 17
-      home_coord: 47.37808, 8.53935
-      map_provider: "OpenStreetMap.Mapnik"
+    url: '/location'
+    navbar_title: 'Location'
+    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.
@@ -604,6 +620,29 @@ Example:
       video: https://media.ccc.de/
 ```
 
+There exists a Python file in this repository, `_tools/import_resources.py`, which can be used to import resources such as slides and other documents from [pretalx.com](https://pretalx.com/p/about/)) via its API. It automatically downloads all files, stores them and updates the links of the talks concerned.
+
+1. Copy the files `_tools/import_resources.py` and `_tools/requirements.txt` from this repository
+
+2. Create a virtual environment and activate it
+
+   ```bash
+   python -m venv venv
+   source venv/bin/activate
+   ```
+
+3. Install the requirements
+
+   ```bash
+   pip install -r _tools/requirements.txt
+   ```
+
+4. Execute the script, e.g. to show the help type
+
+   ```bash
+   python _tools/import_resources.py --help
+   ```
+
 
 ## Overview Pages
 
@@ -623,7 +662,7 @@ If you choose a different location for the overview pages you must:
 
 ### Location / Room Overview
 
-The `location` layout contains a map container (if not disabled, see section _Location Settings_ above) which can be customized. See the section above for further details.
+The `location` layout can include a map container (if not disabled, see the _Location Settings_ section above) which can be customized (see the _Map_ section above).
 
 ### Live Stream Overview
 
@@ -633,6 +672,7 @@ The `stream-overview` layout contains all active streams on a single page (see t
 
 Additional static pages can easily be added as files and linked to via navigation bar or main landing page (see above on how to).
 
+Each of these pages can include a map at its end (e.g. to point to your venue) by adding the `map: true` setting to its Front Matter. See the _Map_ section above for more information.
 
 ## Design
 

data/_includes/js/conference-map.js

@@ -2,9 +2,9 @@ window.conference.mapConfig = (function() {
 
     let map;
 
-    let mapProvider = "{{ site.conference.location.map.map_provider | default: 'OpenStreetMap.Mapnik' }}";
-    let homeCoord = [{{ site.conference.location.map.home_coord }}];
-    let zoomLevel = {{ site.conference.location.map.default_zoom | default: 17 }};
+    let mapProvider = "{{ site.conference.map.map_provider | default: 'OpenStreetMap.Mapnik' }}";
+    let homeCoord = [{{ site.conference.map.home_coord }}];
+    let zoomLevel = {{ site.conference.map.default_zoom | default: 17 }};
 
     let setup = function (elId) {
         map = L.map(elId).setView(homeCoord, zoomLevel);

data/_includes/js/conference.js

@@ -13,7 +13,8 @@ window.conference = {};
 {% include js/conference-program.js %}
 
 // Leaflet (Map Display)
-{% if site.conference.location.hide != true and site.conference.location.map.enable %}
+{% include partials/get_enable_map.html %}
+{% if enable_map %}
     {% include js/leaflet.js %}
     {% include js/leaflet-easybutton.js %}
     {% include js/leaflet-locatecontrol.js %}

data/_includes/partials/get_enable_map.html

@@ -0,0 +1,11 @@
+{%- if site.conference.location.map -%}
+  {%- assign enable_map = true -%}
+{%- else -%}
+  {%- assign enable_map = false -%}
+  {%- for page in site.pages -%}
+    {%- if page.map -%}
+      {%- assign enable_map = true -%}
+      {%- break -%}
+    {%- endif -%}
+  {%- endfor -%}
+{%- endif -%}

data/_includes/partials/navbar_rooms.html

@@ -1,7 +1,11 @@
 <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 }}">
-      {{ site.data.lang[site.conference.lang].location.directions | default: "Directions" }}
+      {% 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 -%}

data/_layouts/location.html

@@ -18,7 +18,7 @@
 
   {{ content }}
 
-  {% if site.conference.location.map.enable %}
+  {% if site.conference.location.map %}
     <div id="map" class="mt-4 mb-3"></div>
   {% endif %}
 

data/_layouts/page.html

@@ -6,4 +6,8 @@
 
 {{ content }}
 
+{% if page.map %}
+  <div id="map" class="mt-4 mb-3"></div>
+{% endif %}
+
 {% include partials/footer.html %}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-conference
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Lorenz Schmid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-01 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.32
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: 2.2.32
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +78,7 @@ files:
 - _includes/partials/footer.html
 - _includes/partials/get_day_hash.html
 - _includes/partials/get_day_time.html
+- _includes/partials/get_enable_map.html
 - _includes/partials/get_link.html
 - _includes/partials/get_link_types.html
 - _includes/partials/get_live_timestamps.html
@@ -279,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Jekyll template for a conference website containing program, speaker, talks