jekyll-theme-conference 3.6.5 → 3.6.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +199 -156
- data/_includes/js/program.js +9 -10
- data/_includes/partials/get_link.html +99 -85
- data/_includes/partials/get_link_types.html +8 -5
- data/_includes/partials/get_talk_time.html +2 -2
- data/_includes/partials/get_talk_timestamp.html +8 -2
- data/_includes/partials/navbar.html +43 -28
- data/_layouts/data.html +14 -8
- data/_layouts/home.html +41 -16
- data/_layouts/program.html +1 -1
- data/_layouts/speaker.html +7 -7
- data/_layouts/talk-overview.html +3 -3
- data/_layouts/talk.html +7 -7
- metadata +7 -7
data/README.md
CHANGED
|
@@ -6,63 +6,62 @@ This is a responsive [Jekyll](http://jekyllrb.com) theme based on [Bootstrap 4](
|
|
|
6
6
|
|
|
7
7
|
- multiday program / schedule,
|
|
8
8
|
- talk and speaker descriptions,
|
|
9
|
-
-
|
|
10
|
-
-
|
|
9
|
+
- maps for directions,
|
|
10
|
+
- real-time indications during the conference, and
|
|
11
11
|
- supports embedded video streaming or recordings.
|
|
12
12
|
|
|
13
|
-
All components such as talks, speakers or rooms are represented as collection of files. The schedule is
|
|
13
|
+
All components such as talks, speakers or rooms are represented as collection of files. The schedule is defined via a simple structure stored in a [YAML](https://en.wikipedia.org/wiki/YAML) file. There is no need for databases and once generated the website consists only of static files. A script and workflows are available for easy import, e.g., of [frab](https://github.com/frab/frab/wiki/Manual#introduction) compatible schedules.
|
|
14
14
|
The design is easily customizable and is adapted for mobile uses and printing.
|
|
15
15
|
|
|
16
|
-
The theme was
|
|
16
|
+
The theme was created for the yearly Winterkongress conference of the [Digital Society Switzerland](https://digitale-gesellschaft.ch/). You can see this theme active here:
|
|
17
17
|
|
|
18
18
|
- [Demo: Winterkongress](https://digitale-gesellschaft.ch/kongress/)
|
|
19
19
|
|
|
20
|
-
|
|
21
20
|
## Table of Contents
|
|
22
21
|
|
|
23
22
|
- [Installation](#installation)
|
|
24
|
-
|
|
25
|
-
|
|
23
|
+
- [Gem-based Method](#gem-based-method)
|
|
24
|
+
- [Remote Theme Method](#remote-theme-method)
|
|
26
25
|
- [Setup](#setup)
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
26
|
+
- [Jump Start](#jump-start)
|
|
27
|
+
- [Automatic Import](#automatic-import)
|
|
28
|
+
- [Automatic Build](#automatic-build)
|
|
30
29
|
- [Configuration](#configuration)
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
30
|
+
- [Theme Verification](#theme-verification)
|
|
31
|
+
- [Collection URLs](#collection-urls)
|
|
32
|
+
- [Language](#language)
|
|
33
|
+
- [Timezone](#timezone)
|
|
34
|
+
- [Navigation Bar](#navigation-bar)
|
|
35
|
+
- [Open Graph Link Preview](#open-graph-link-preview)
|
|
36
|
+
- [Main Landing Page](#main-landing-page)
|
|
37
|
+
- [Information Boxes](#information-boxes)
|
|
38
|
+
- [Live Indications & Streaming](#live-indications--streaming)
|
|
39
|
+
- [Map](#map)
|
|
40
|
+
- [Talk Settings](#talk-settings)
|
|
41
|
+
- [Speaker Settings](#speaker-settings)
|
|
42
|
+
- [Location Settings](#location-settings)
|
|
43
|
+
- [Program Settings](#program-settings)
|
|
44
44
|
- [Content](#content)
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
45
|
+
- [Schedule / Program](#schedule--program)
|
|
46
|
+
- [Talks](#talks)
|
|
47
|
+
- [Speakers](#speakers)
|
|
48
|
+
- [Rooms](#rooms)
|
|
49
|
+
- [Links](#links)
|
|
50
50
|
- [Overview Pages](#overview-pages)
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
51
|
+
- [Location / Room Overview](#location--room-overview)
|
|
52
|
+
- [Live Stream Overview](#live-stream-overview)
|
|
53
|
+
- [Additional Pages](#additional-pages)
|
|
54
54
|
- [Design](#design)
|
|
55
55
|
- [Development](#development)
|
|
56
56
|
- [License](#license)
|
|
57
57
|
|
|
58
|
-
|
|
59
58
|
## Installation
|
|
60
59
|
|
|
61
60
|
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.
|
|
62
61
|
|
|
63
62
|
### Gem-based Method
|
|
64
63
|
|
|
65
|
-
With Gem-based themes, directories such as the `assets`, `_layouts`, `_includes`, and `_sass` are stored in the theme’s gem, hidden from your immediate view. Yet all
|
|
64
|
+
With Gem-based themes, directories such as the `assets`, `_layouts`, `_includes`, and `_sass` are stored in the theme’s gem, hidden from your immediate view. Yet all the necessary directories will be read and processed during Jekyll’s build process.
|
|
66
65
|
|
|
67
66
|
This allows for easier installation and updating as you don't have to manage any of the theme files. To install:
|
|
68
67
|
|
|
@@ -100,6 +99,7 @@ To install:
|
|
|
100
99
|
source "https://rubygems.org"
|
|
101
100
|
|
|
102
101
|
gem "github-pages", group: :jekyll_plugins
|
|
102
|
+
gem "jekyll-include-cache", group: :jekyll_plugins
|
|
103
103
|
```
|
|
104
104
|
|
|
105
105
|
2. Add `jekyll-include-cache` to the `plugins` array of your `_config.yml`.
|
|
@@ -110,22 +110,21 @@ To install:
|
|
|
110
110
|
bundle
|
|
111
111
|
```
|
|
112
112
|
|
|
113
|
-
4. Add `remote_theme: "DigitaleGesellschaft/jekyll-theme-conference@v3.6.
|
|
113
|
+
4. Add `remote_theme: "DigitaleGesellschaft/jekyll-theme-conference@v3.6.3"` to your `_config.yml` file. Remove any other `theme:` or `remote_theme:` entry.
|
|
114
114
|
|
|
115
115
|
5. Continue with the _Setup_ section further below to customize the theme and add some content for your conference
|
|
116
116
|
|
|
117
|
-
|
|
118
117
|
## Setup
|
|
119
118
|
|
|
120
|
-
The different talks, speakers and rooms are stored as a collection of files. Each file contains a small header in form of a YAML block (called [FrontMatter](https://jekyllrb.com/docs/front-matter/))
|
|
119
|
+
The different talks, speakers and rooms are stored as a collection of files. Each file contains a small header in form of a YAML block (called [FrontMatter](https://jekyllrb.com/docs/front-matter/)) used to store additional information beside a description. Their exact use and meaning is described further below in the section _Content_. Additional configuration options can be found in the section _Configuration_.
|
|
121
120
|
|
|
122
|
-
The
|
|
121
|
+
The 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_.
|
|
123
122
|
|
|
124
|
-
:warning: Please note that the generated website can be
|
|
123
|
+
:warning: Please note that the generated website can be 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)).
|
|
125
124
|
|
|
126
125
|
### Jump Start
|
|
127
126
|
|
|
128
|
-
|
|
127
|
+
To be up and running simply use the default content of this repository as an initial base for your new website. After having set up a new Jekyll website copy the following files and folders into the website's folder:
|
|
129
128
|
|
|
130
129
|
- `_config.example.yml` -> `_config.yml`
|
|
131
130
|
- `_data/`
|
|
@@ -140,7 +139,7 @@ In order to be up and running simply use the default content of this repository
|
|
|
140
139
|
|
|
141
140
|
### Automatic Import
|
|
142
141
|
|
|
143
|
-
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
|
|
142
|
+
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.
|
|
144
143
|
|
|
145
144
|
1. Copy the files `_tools/create_entries.py` and `_tools/requirements.txt` from this repository
|
|
146
145
|
|
|
@@ -157,18 +156,17 @@ There exists a Python file in this repository, `_tools/create_entries.py`, which
|
|
|
157
156
|
pip install -r _tools/requirements.txt
|
|
158
157
|
```
|
|
159
158
|
|
|
160
|
-
4. Execute the script, e.g
|
|
159
|
+
4. Execute the script, e.g., to show the help type
|
|
161
160
|
|
|
162
161
|
```bash
|
|
163
162
|
python _tools/create_entries.py --help
|
|
164
163
|
```
|
|
165
164
|
|
|
166
|
-
|
|
167
165
|
### Automatic Build
|
|
168
166
|
|
|
169
|
-
|
|
167
|
+
If you do not want to install the entire Ruby/Jekyll tool chain on your machine you can use [GitHub Actions](https://github.com/features/actions), Github's continuous integration platform. This repository contains multiple example Github Action configuration files in the `_tools/` folder:
|
|
170
168
|
|
|
171
|
-
- `build.yml`: automatically builds and minimizes the website upon adding a new tag starting with a `v` (e.g
|
|
169
|
+
- `build.yml`: automatically builds and minimizes the website upon adding a new tag starting with a `v` (e.g., `v2020.01.01`). It then attaches the generated website as an archive to a release for easy downloading. Requires `purgecss.config.js` to be copied to the project's root too.
|
|
172
170
|
- `test.yml`: automatically tries to build the website upon a new pull request. It can thus be used as status check before merging.
|
|
173
171
|
- `schedule.yml`: automatically generates the schedule and content files when a new pull request contains a `schedule.json` file (see the _Automatic Import_ subsection above). Thus, it allows quick updates of the site's content from [pretalx.com](https://pretalx.com/p/about/) exports.
|
|
174
172
|
|
|
@@ -176,8 +174,7 @@ To get started, simply copy the desired workflow file to your repository and ada
|
|
|
176
174
|
|
|
177
175
|
- `_tools/build.yml` -> `.github/workflows/build.yml`
|
|
178
176
|
|
|
179
|
-
Please note that the `Gemfile.lock` of your project must be adapted to include specific versions required by Github's workflow server, i.e
|
|
180
|
-
|
|
177
|
+
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.
|
|
181
178
|
|
|
182
179
|
## Configuration
|
|
183
180
|
|
|
@@ -185,7 +182,7 @@ All configurations and customization for this theme are stored under the `confer
|
|
|
185
182
|
|
|
186
183
|
### Theme Verification
|
|
187
184
|
|
|
188
|
-
Upon building the theme runs some basic verification to check if all necessary files and configurations are in place. If it encounters an error it shows so in adding an information bar on all your sites. You can disable this, e.g
|
|
185
|
+
Upon building, the theme runs some basic verification to check if all necessary files and configurations are in place. If it encounters an error it shows so in adding an information bar on all your sites. You can disable this, e.g., in a production environment, by setting `show_errors` to `false` (default: `true`).
|
|
189
186
|
|
|
190
187
|
Example:
|
|
191
188
|
|
|
@@ -230,14 +227,13 @@ defaults:
|
|
|
230
227
|
layout: room
|
|
231
228
|
```
|
|
232
229
|
|
|
233
|
-
|
|
230
|
+
To change the URL of the collection, simply edit the `permalink` property and replace the `:collection` tag (which translates to `talks`, `speakers` and `rooms`) with your desired value. Please note that the talk and speaker overview pages should residue in a folder of the same name.
|
|
234
231
|
|
|
235
232
|
_Note:_ While you might want to change the URLs, the name of the three collections (`talks`, `speakers` and `rooms`) is fixed and cannot be changed.
|
|
236
233
|
|
|
237
|
-
|
|
238
234
|
### Language
|
|
239
235
|
|
|
240
|
-
|
|
236
|
+
To adapt the language of the theme set the `lang` property. If you change it from its default, make sure you have copied the internationalization file from this repository to `_data/lang.yml`. The following languages are supported:
|
|
241
237
|
|
|
242
238
|
- English: `en` (Default)
|
|
243
239
|
- German: `de`
|
|
@@ -251,9 +247,20 @@ conference:
|
|
|
251
247
|
lang: en
|
|
252
248
|
```
|
|
253
249
|
|
|
250
|
+
### Timezone
|
|
251
|
+
|
|
252
|
+
Multiple dynamic features such as showing the current day in the program or live indications require correct timing. Define the timezone in which the conference takes place with the `tz` property set to a valid [UTC timezone offset](https://en.wikipedia.org/wiki/List_of_UTC_offsets) in the format `"+/-HH:MM"`:
|
|
253
|
+
|
|
254
|
+
Example:
|
|
255
|
+
|
|
256
|
+
```yaml
|
|
257
|
+
conference:
|
|
258
|
+
tz: "+02:00"
|
|
259
|
+
```
|
|
260
|
+
|
|
254
261
|
### Navigation Bar
|
|
255
262
|
|
|
256
|
-
The navigation bar is located at the top and visible on every site. On the right it
|
|
263
|
+
The navigation bar is located at the top and visible on every site. On the right, it shows 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.
|
|
257
264
|
|
|
258
265
|
Example:
|
|
259
266
|
|
|
@@ -272,7 +279,7 @@ conference:
|
|
|
272
279
|
relative_url: /2019/
|
|
273
280
|
```
|
|
274
281
|
|
|
275
|
-
Optionally, a logo or link of your organization hosting the conference can be shown on the right side of the navigation bar. It is
|
|
282
|
+
Optionally, a logo or link of your organization hosting the conference can be shown on the right side of the navigation bar. It is activated through the `logo` property under the `navigation` property containing
|
|
276
283
|
|
|
277
284
|
- the text to show (`name`),
|
|
278
285
|
- an absolute link address (`url`), and
|
|
@@ -294,15 +301,15 @@ The navigation bar automatically collapses when the available space is too small
|
|
|
294
301
|
|
|
295
302
|
### Open Graph Link Preview
|
|
296
303
|
|
|
297
|
-
The theme automatically includes the necessary `<meta>` tags to ease link previewing when sharing links based on the [Open Graph protocol](https://ogp.me/) and [Twitter Cards](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/abouts-cards). These tags control how a link is
|
|
304
|
+
The theme automatically includes the necessary `<meta>` tags to ease link previewing when sharing links based on the [Open Graph protocol](https://ogp.me/) and [Twitter Cards](https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/abouts-cards). These tags control how a link is shown when shared via different platform and apps. To disable these `<meta>` tags add the `disable: true` setting (default: `false`) to the `link_preview` property.
|
|
298
305
|
|
|
299
|
-
|
|
306
|
+
To generate a meaningful description for each of the links, the preposition for the conference title as given under the `title` property can be defined by using the `preposition` property. For example, if `title` is set to "Conference 2020" the corresponding `preposition` would be "at". The template can then use it to generate descriptions such as "Talk _at_ Conference 2020".
|
|
300
307
|
|
|
301
|
-
Optionally, an image
|
|
308
|
+
Optionally, an image that is shown as preview for all links can be specified. For sharing via Open Graph an image ratio of 1.91:1 and an ideal size of 1200x630 pixel is recommended. For sharing via Twitter an image ratio of 1:1 and a minimal size of 600x600 pixel (better 1200x1200 pixel) is recommended. SVG image files are not supported. It is activated through the `img` property under the `link_preview` property containing an image file shown for Open Graph (`open_graph`) and on the Twitter Cards (`twitter`), whereby the path to the image file relative to the `/assets/images/` folder has to be specified.
|
|
302
309
|
|
|
303
310
|
```yaml
|
|
304
311
|
title: Conference 2020
|
|
305
|
-
preposition:
|
|
312
|
+
preposition: "at"
|
|
306
313
|
|
|
307
314
|
...
|
|
308
315
|
|
|
@@ -310,13 +317,13 @@ conference:
|
|
|
310
317
|
link_preview:
|
|
311
318
|
disable: false
|
|
312
319
|
img:
|
|
313
|
-
twitter:
|
|
314
|
-
open_graph:
|
|
320
|
+
twitter: "twitter_preview.png" # inside /assets/images/
|
|
321
|
+
open_graph: "facebook_preview.png" # inside /assets/images/
|
|
315
322
|
```
|
|
316
323
|
|
|
317
324
|
### Main Landing Page
|
|
318
325
|
|
|
319
|
-
The main landing page is shown at the root of the website to greet new visitors.
|
|
326
|
+
The main landing page is shown at the root of the website to greet new visitors. 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.
|
|
320
327
|
|
|
321
328
|
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
|
|
322
329
|
|
|
@@ -328,10 +335,10 @@ Example:
|
|
|
328
335
|
conference:
|
|
329
336
|
main:
|
|
330
337
|
logo:
|
|
331
|
-
img:
|
|
338
|
+
img: "main_logo.png"
|
|
332
339
|
```
|
|
333
340
|
|
|
334
|
-
The title/logo on the main page is followed by a description of your site (`site.description`) and the content of your `index.md` file. It ends with an optional list of
|
|
341
|
+
The title/logo on the main page is followed by a description of your site (`site.description`) and the content of your `index.md` file. It ends with an optional list of link buttons. See the _Content_ > _Links_ section below for the available properties per link.
|
|
335
342
|
|
|
336
343
|
Example:
|
|
337
344
|
|
|
@@ -349,7 +356,7 @@ conference:
|
|
|
349
356
|
|
|
350
357
|
### Information Boxes
|
|
351
358
|
|
|
352
|
-
One or multiple information banners or boxes can be shown at the top of the website just below the navigation bar. They are prominent but
|
|
359
|
+
One or multiple information banners or boxes can be shown at the top of the website just below the navigation bar. They are prominent but dismissible and can inform your visitors about recent changes. They are activated through the `info_bars` property, which contains a list for each information banner to show. Each banner consists of
|
|
353
360
|
|
|
354
361
|
- a title (`title`),
|
|
355
362
|
- a color (`color`) following the Bootstrap color scheme (see below), possible values are:
|
|
@@ -382,42 +389,42 @@ conference:
|
|
|
382
389
|
|
|
383
390
|
### Live Indications & Streaming
|
|
384
391
|
|
|
385
|
-
|
|
392
|
+
To help users navigating the program during the conference, 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).
|
|
386
393
|
|
|
387
|
-
This can be further extended if some
|
|
394
|
+
This can be further extended if some 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.
|
|
388
395
|
|
|
389
|
-
|
|
396
|
+
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
|
|
390
397
|
|
|
391
398
|
- how long a pause between two consecutive talks has to be for the live indication to pause (`stop`),
|
|
392
|
-
- optionally under the `streaming` property:
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
- optionally under the `demo` property:
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
399
|
+
- optionally, under the `streaming` property:
|
|
400
|
+
- if streaming should be enabled (`enable`), and if enabled
|
|
401
|
+
- how many minutes the stream goes active before a talk (`prepend`),
|
|
402
|
+
- how many minutes the stream stays active after a talk (`extend`),
|
|
403
|
+
- how long a pause between two consecutive talks has to be for the stream to pause (`pause`), and
|
|
404
|
+
- an external (absolute) link to which the user will be redirected instead of opening the modal (`external`),
|
|
405
|
+
- optionally, under the `demo` property:
|
|
406
|
+
- 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
|
|
407
|
+
- how long the demonstration should take (`duration`), and
|
|
408
|
+
- how long the pause between two demonstration cycles should be (`pause`).
|
|
402
409
|
|
|
403
410
|
```yaml
|
|
404
411
|
conference:
|
|
405
412
|
live:
|
|
406
|
-
stop: 240
|
|
413
|
+
stop: 240 # in minutes
|
|
407
414
|
streaming:
|
|
408
415
|
enable: true
|
|
409
|
-
pause:
|
|
410
|
-
prepend:
|
|
411
|
-
extend:
|
|
416
|
+
pause: 60 # in minutes
|
|
417
|
+
prepend: 5 # in minutes
|
|
418
|
+
extend: 5 # in minutes
|
|
412
419
|
demo:
|
|
413
420
|
enable: false
|
|
414
|
-
duration: 300
|
|
415
|
-
pause:
|
|
421
|
+
duration: 300 # in seconds
|
|
422
|
+
pause: 10 # in seconds
|
|
416
423
|
```
|
|
417
424
|
|
|
418
425
|
### Map
|
|
419
426
|
|
|
420
|
-
|
|
427
|
+
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/).
|
|
421
428
|
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).
|
|
422
429
|
|
|
423
430
|
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).
|
|
@@ -432,7 +439,7 @@ conference:
|
|
|
432
439
|
|
|
433
440
|
### Talk Settings
|
|
434
441
|
|
|
435
|
-
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
|
|
442
|
+
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. 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:
|
|
436
443
|
|
|
437
444
|
- its name (`name`, must be corresponding to the listed categories in the talk's FrontMatter), and
|
|
438
445
|
- a color (`color`) following the Bootstrap color scheme (see below), possible values are:
|
|
@@ -445,7 +452,7 @@ Each talk can have one or multiple categories associated via FrontMatter (see th
|
|
|
445
452
|
- `light` (white)
|
|
446
453
|
- `dark` (dark grey)
|
|
447
454
|
|
|
448
|
-
Each talk can have associated links listed at the end of its content. If these links have an icon associated (see _Content_ > _Talks_ below), they are also shown on the talk overview page (e.g
|
|
455
|
+
Each talk can have associated links listed at the end of its content. If these links have an icon associated (see _Content_ > _Talks_ below), they are also shown on the talk overview page (e.g., to show in the overview, which talk has a video recording and, which not). To disable the showing of icon links on the overview page, set the `hide_icons` property to `true` (default: `false`).
|
|
449
456
|
|
|
450
457
|
Example:
|
|
451
458
|
|
|
@@ -465,7 +472,7 @@ conference:
|
|
|
465
472
|
|
|
466
473
|
### Speaker Settings
|
|
467
474
|
|
|
468
|
-
In the program as well as the speaker's overview the speaker's first name can be abbreviated to its first letter
|
|
475
|
+
In the program as well as the speaker's overview the speaker's first name can be abbreviated to its first letter if present. To do so, add the `show_firstname: true` setting (default: `false`) to the `speakers` property.
|
|
469
476
|
|
|
470
477
|
Example:
|
|
471
478
|
|
|
@@ -477,12 +484,12 @@ conference:
|
|
|
477
484
|
|
|
478
485
|
### Location Settings
|
|
479
486
|
|
|
480
|
-
|
|
481
|
-
|
|
487
|
+
If 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).
|
|
488
|
+
To hide all rooms add the `hide: true` setting (default: `false`) to the `location` property.
|
|
482
489
|
|
|
483
490
|
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.
|
|
484
491
|
|
|
485
|
-
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".
|
|
492
|
+
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". 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.
|
|
486
493
|
|
|
487
494
|
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.
|
|
488
495
|
|
|
@@ -492,8 +499,8 @@ Example:
|
|
|
492
499
|
conference:
|
|
493
500
|
location:
|
|
494
501
|
hide: false
|
|
495
|
-
url:
|
|
496
|
-
navbar_title:
|
|
502
|
+
url: "/location"
|
|
503
|
+
navbar_title: "Location"
|
|
497
504
|
map: true
|
|
498
505
|
```
|
|
499
506
|
|
|
@@ -547,26 +554,26 @@ conference:
|
|
|
547
554
|
|
|
548
555
|
## Content
|
|
549
556
|
|
|
550
|
-
The different talks, speakers and rooms are stored as a collection of
|
|
551
|
-
The
|
|
557
|
+
The different talks, speakers and rooms are stored as a collection of files. Each file contains a small header in form of a YAML block (called [FrontMatter](https://jekyllrb.com/docs/front-matter/)) used to store additional information beside a description.
|
|
558
|
+
The schedule defining when and in which room a talk takes place is stored as a [YAML data file](https://jekyllrb.com/docs/datafiles/).
|
|
552
559
|
|
|
553
560
|
### Schedule / Program
|
|
554
561
|
|
|
555
|
-
The schedule of the conference linking the talks with the rooms and indicating when each talk talks place and how long it goes is set in the `_data/program.yml` file. It contains a list of days, whereby each day contains a list of rooms, whereby each room contains a list of talks.
|
|
562
|
+
The schedule of the conference linking the talks with the rooms and indicating when each talk talks place and how long it goes, is set in the `_data/program.yml` file. It contains a list of days, whereby each day contains a list of rooms, whereby each room contains a list of talks.
|
|
556
563
|
|
|
557
564
|
Each day consists of
|
|
558
565
|
|
|
559
566
|
- a list of rooms (`rooms`) in which talks are taking place on that day
|
|
560
|
-
- optionally, the day's `name`, e.g
|
|
567
|
+
- optionally, the day's `name`, e.g., the weekday
|
|
561
568
|
- optionally, the short form of the day's name (`abbr`), and
|
|
562
|
-
- optionally only if no live indications are active, a `date` in the format `YYYY-MM-DD`.
|
|
569
|
+
- optionally and only if no live indications are active, a `date` in the format `YYYY-MM-DD`.
|
|
563
570
|
|
|
564
571
|
Each room consists of
|
|
565
572
|
|
|
566
573
|
- the room's `name` (must correspond to one of the room identifier), and
|
|
567
574
|
- a list of talks (`talks`) which also can be empty `[]`.
|
|
568
575
|
|
|
569
|
-
The order of the rooms in the list defines the order of the rooms as shown in the schedule on the program page. For the live
|
|
576
|
+
The order of the rooms in the list defines the order of the rooms as shown in the schedule on the program page. For the live-streaming or the room overview the order of the rooms is alphabetical but can be adapted via the [main configuration file](https://jekyllrb.com/docs/collections/#sort-by-front-matter-key).
|
|
570
577
|
|
|
571
578
|
Each talk consists of
|
|
572
579
|
|
|
@@ -574,30 +581,30 @@ Each talk consists of
|
|
|
574
581
|
- a starting time `time_start` given as `H:M` ([`strftime`](http://www.strfti.me) formated) or `H:M +∆` whereby ∆ is the day offset in relation to the date given for the given day, and
|
|
575
582
|
- an end time `time_end`.
|
|
576
583
|
|
|
577
|
-
The list of talks should (manually) be ordered by time, i.e
|
|
584
|
+
The list of talks should (manually) be ordered by time, i.e., the first occurring talk should be listed first.
|
|
578
585
|
|
|
579
586
|
Example:
|
|
580
587
|
|
|
581
588
|
```yaml
|
|
582
589
|
days:
|
|
583
|
-
- name: Monday
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
590
|
+
- name: Monday
|
|
591
|
+
abbr: Mo
|
|
592
|
+
date: 2020-01-31
|
|
593
|
+
rooms:
|
|
594
|
+
- name: Room A
|
|
595
|
+
talks:
|
|
596
|
+
- name: Vim Impetus Placerat Cotidieque Ad
|
|
597
|
+
time_start: "12:00"
|
|
598
|
+
time_end: "12:45"
|
|
599
|
+
- name: Condimentum Vitae Sapien Pellentesque
|
|
600
|
+
time_start: "12:45"
|
|
601
|
+
time_end: "13:30"
|
|
602
|
+
|
|
603
|
+
- name: Room B
|
|
604
|
+
talks:
|
|
605
|
+
- name: Arcu Non Odio
|
|
606
|
+
time_start: "12:00"
|
|
607
|
+
time_end: "13:00"
|
|
601
608
|
```
|
|
602
609
|
|
|
603
610
|
### Talks
|
|
@@ -606,10 +613,24 @@ Each talk is represented by a file in the `_talks/` directory. It must begin wit
|
|
|
606
613
|
|
|
607
614
|
- the talk's `name` (used as identifier),
|
|
608
615
|
- one or more existing `speakers` name(s),
|
|
609
|
-
- optionally one or more `categories` of which one should be a main category as defined in the site's configuration,
|
|
610
|
-
- optionally a list of `links` (see the _Links_ subsection below for the available properties
|
|
611
|
-
-
|
|
612
|
-
-
|
|
616
|
+
- optionally, one or more `categories` of which one should be a main category as defined in the site's configuration,
|
|
617
|
+
- optionally, a list of `links` (see the _Links_ subsection below for the available properties):
|
|
618
|
+
- Links with an `icon` are treated separately and are also included on the talk overview page.
|
|
619
|
+
- Links with `live: true` are only shown below the live stream for the given talk in form of buttons.
|
|
620
|
+
- optionally, `hide: true` if the talk's page should not be linked to.
|
|
621
|
+
|
|
622
|
+
Example:
|
|
623
|
+
|
|
624
|
+
```yaml
|
|
625
|
+
---
|
|
626
|
+
name: Vim Impetus Placerat Cotidieque Ad
|
|
627
|
+
speakers:
|
|
628
|
+
- Tolga Philip
|
|
629
|
+
categories:
|
|
630
|
+
- Cat B
|
|
631
|
+
- Talk
|
|
632
|
+
---
|
|
633
|
+
```
|
|
613
634
|
|
|
614
635
|
### Speakers
|
|
615
636
|
|
|
@@ -618,20 +639,34 @@ Each speaker is represented by a file in the `_speakers/` directory. It must beg
|
|
|
618
639
|
- the speaker's `name` (used as identifier), as well as its
|
|
619
640
|
- `first_name`,
|
|
620
641
|
- `last_name`,
|
|
621
|
-
- optionally a list of `links` (see the _Links_ subsection below for the available properties
|
|
622
|
-
-
|
|
642
|
+
- optionally, a list of `links` (see the _Links_ subsection below for the available properties):
|
|
643
|
+
- Links with an `icon` are treated separately and are also included on the speaker overview page.
|
|
644
|
+
- optionally, `hide: true` if the speaker's page should not be linked to.
|
|
623
645
|
|
|
624
646
|
If the speaker's name consists only out of one word, populate the `last_name` property and leave the `first_name` property empty. The last name is generally used for sorting the speakers.
|
|
625
647
|
|
|
648
|
+
Example:
|
|
649
|
+
|
|
650
|
+
```yaml
|
|
651
|
+
---
|
|
652
|
+
name: Tolga Philip
|
|
653
|
+
first_name: Tolga
|
|
654
|
+
last_name: Philip
|
|
655
|
+
links:
|
|
656
|
+
- name: Profile
|
|
657
|
+
absolute_url: https://github.com
|
|
658
|
+
---
|
|
659
|
+
```
|
|
660
|
+
|
|
626
661
|
### Rooms
|
|
627
662
|
|
|
628
663
|
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
|
|
629
664
|
|
|
630
665
|
- the room's `name`
|
|
631
|
-
- optionally `hide: true` if the room's page should not be linked to, and
|
|
632
|
-
- 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:
|
|
633
|
-
|
|
634
|
-
|
|
666
|
+
- optionally, `hide: true` if the room's page should not be linked to, and
|
|
667
|
+
- 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:
|
|
668
|
+
- as an `absolute_url`, or
|
|
669
|
+
- a `relative_url`.
|
|
635
670
|
|
|
636
671
|
Example:
|
|
637
672
|
|
|
@@ -642,8 +677,6 @@ hide: false
|
|
|
642
677
|
live:
|
|
643
678
|
absolute_url: https://github.com
|
|
644
679
|
---
|
|
645
|
-
|
|
646
|
-
...
|
|
647
680
|
```
|
|
648
681
|
|
|
649
682
|
### Links
|
|
@@ -651,31 +684,42 @@ live:
|
|
|
651
684
|
Links are used at different location throughout the theme: They can either be used in the configuration file (for the landing page or the navigation bar), or in talks and for speakers. A link can thereby have the following properties:
|
|
652
685
|
|
|
653
686
|
- the text to show (`name`),
|
|
654
|
-
-
|
|
655
|
-
-
|
|
656
|
-
-
|
|
657
|
-
- the
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
687
|
+
- the link address:
|
|
688
|
+
- _relative_ to the site's base address: `relative_url:`,
|
|
689
|
+
- as an _absolute_ address: `absolute_url:`,
|
|
690
|
+
- pointing to a _file_ uploaded to the `/documents` folder: `file:`, or
|
|
691
|
+
- pointing to an external _video_: `video:`.
|
|
692
|
+
- optionally, if it is disabled (`disabled: true`),
|
|
693
|
+
- optionally, if it should open in a iframe embedded in a popup-like modal (`iframe: true`), and
|
|
694
|
+
- optionally, an icon to show in front of the title (`icon: ` followed by the [FontAwesome](https://fontawesome.com/icons?d=gallery&s=solid&m=free) icon name to show).
|
|
662
695
|
|
|
663
|
-
|
|
696
|
+
Using the `file:` indicator, the
|
|
664
697
|
|
|
665
|
-
-
|
|
666
|
-
-
|
|
698
|
+
- link address is set to
|
|
699
|
+
- the site's base address followed by `/documents/slides` and the value for _talks_,
|
|
700
|
+
- the site's base address followed by `/documents/bio` and the value for _speakers_, or
|
|
701
|
+
- the site's base address followed by `/documents` and the value for all remaining types.
|
|
702
|
+
- the link's `icon:` is set to `file-alt`.
|
|
667
703
|
|
|
668
|
-
Using the `
|
|
704
|
+
Using the `video:` indicator, the
|
|
669
705
|
|
|
670
|
-
|
|
706
|
+
- link address is set to an absolute address as given by the value.
|
|
707
|
+
- the link's `iframe:` attribute is set to `true` top embed the video in a popup-like modal having a default iframe ratio of 24:11.
|
|
708
|
+
- the link's `icon:` is set to `video`.
|
|
671
709
|
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
710
|
+
Additionally, a _talk_ link can also have the following property:
|
|
711
|
+
|
|
712
|
+
- `live: true` whereby the link is only shown below the live stream for the given talk in form of buttons.
|
|
713
|
+
|
|
714
|
+
Additionally, a _navigation bar_ or _main landing page_ link can also have the following properties:
|
|
715
|
+
|
|
716
|
+
- `live: true` making the link only visible during the conference and adds a live indication.
|
|
717
|
+
- The link is only shown if `name` is set. If `name` is an empty string, "Live Stream" is shown instead.
|
|
718
|
+
- If `name_inactive` is set, its value is used to be shown as a placeholder text, while the conference is **not** live. If `name_inactive` is an empty string, "Live Stream" is shown instead.
|
|
719
|
+
- 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).
|
|
720
|
+
- `menu` containing another list of links. This creates a dropdown menu of multiple sublinks, while the URL of the parent link is ignored. The sublinks have the same properties as regular links.
|
|
721
|
+
|
|
722
|
+
#### Import link files
|
|
679
723
|
|
|
680
724
|
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.
|
|
681
725
|
|
|
@@ -694,13 +738,12 @@ There exists a Python file in this repository, `_tools/import_resources.py`, whi
|
|
|
694
738
|
pip install -r _tools/requirements.txt
|
|
695
739
|
```
|
|
696
740
|
|
|
697
|
-
4. Execute the script, e.g
|
|
741
|
+
4. Execute the script, e.g., to show the help type
|
|
698
742
|
|
|
699
743
|
```bash
|
|
700
744
|
python _tools/import_resources.py --help
|
|
701
745
|
```
|
|
702
746
|
|
|
703
|
-
|
|
704
747
|
## Overview Pages
|
|
705
748
|
|
|
706
749
|
For each of the three collections there exist a dedicated layout giving an overview among all items of the collection. Furthermore, there exists a layout to show the program as a time schedule. Simply create an empty page and associate the corresponding layout with it:
|
|
@@ -714,8 +757,8 @@ They can be empty but should contain the `layout` property in the FrontMatter he
|
|
|
714
757
|
|
|
715
758
|
If you choose a different location for the overview pages you must:
|
|
716
759
|
|
|
717
|
-
-
|
|
718
|
-
-
|
|
760
|
+
- if of the `talks` and `speaker` overview file, adapt the URL of the two collections as described further above in the section _Collection URLs_, and
|
|
761
|
+
- if of the `location` and `program` file, adapt the corresponding `url` parameter as described further above in the sections _Location Settings_ and _Program Settings_.
|
|
719
762
|
|
|
720
763
|
### Location / Room Overview
|
|
721
764
|
|
|
@@ -729,7 +772,7 @@ The `stream-overview` layout contains all active streams on a single page (see t
|
|
|
729
772
|
|
|
730
773
|
Additional static pages can easily be added as files and linked to via navigation bar or main landing page (see above on how to).
|
|
731
774
|
|
|
732
|
-
Each of these pages can include a map at its end (e.g
|
|
775
|
+
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.
|
|
733
776
|
|
|
734
777
|
## Design
|
|
735
778
|
|
|
@@ -742,14 +785,14 @@ Custom Bootstrap themes or simple color schemes such as designed with [Bootstrap
|
|
|
742
785
|
---
|
|
743
786
|
---
|
|
744
787
|
|
|
745
|
-
$fa-font-path:
|
|
788
|
+
$fa-font-path: "{{ site.baseurl }}/assets/webfonts";
|
|
746
789
|
|
|
747
|
-
@import
|
|
790
|
+
@import "conference";
|
|
748
791
|
```
|
|
749
792
|
|
|
750
793
|
Do not skip the `$fa-font-path` variable or modify it as otherwise, the FontAwesome icons will not be able to load.
|
|
751
794
|
|
|
752
|
-
2. Add your Bootstrap variables in front of the `@import 'conference'` line, e.g
|
|
795
|
+
2. Add your Bootstrap variables in front of the `@import 'conference'` line, e.g., currently the primary color is set internally to green (instead of Bootstrap's default blue): `$primary: #074 !default;`
|
|
753
796
|
3. Add any additional CSS styles after it.
|
|
754
797
|
|
|
755
798
|
## Development
|
|
@@ -766,4 +809,4 @@ end
|
|
|
766
809
|
|
|
767
810
|
This project is licensed under the MIT License. You can view [LICENSE.md](LICENSE.md) for more details.
|
|
768
811
|
|
|
769
|
-
This project redistributes other
|
|
812
|
+
This project redistributes other open source tools and libraries. You can view [REDISTRIBUTED.md](REDISTRIBUTED.md) for third party licenses.
|