README.md in jekyll-theme-conference-3.5.0 vs README.md in jekyll-theme-conference-3.6.0

- old
+ new

@@ -382,31 +382,31 @@ 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 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`), +- 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 (`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 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 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: enable: true - time_pause: 60 # in minutes - time_prepend: 5 # in minutes - time_extend: 5 # in minutes + pause: 60 # in minutes + prepend: 5 # in minutes + extend: 5 # in minutes demo: enable: false duration: 300 # in seconds pause: 10 # in seconds ``` @@ -618,10 +618,25 @@ 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` - 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 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: