jekyll-theme-conference 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32623dfa5fc548002ea9f1e8dac8b1e4c5833d33e6619bce8f77ea54c8080dc6
-  data.tar.gz: 565f13adc6ec08fab3a2240a8ef1adf0562454f1a4d9c58585c173d9ca583ecd
+  metadata.gz: 50470940d27a0744cdf32312e829e73af0c6375241575e6eb074695edfee7028
+  data.tar.gz: 1444781b0f41ffc7d267fe324b9cfabb5afd709ee27c24d95bd6b34d02d57060
 SHA512:
-  metadata.gz: bb1d8eae3fd5e858a24977bc77aafeebe6cdca657d4d0222afbcd40e0c4fe0011b13cacba8217cd32a68b7d6fd5fbda2756829f80bc44c601ad71aa79cc4ae36
-  data.tar.gz: fc2f250efcff400fbc2a96243d9f63f7659a1b071eae24391c1e6820f4cf03a63db4d43b119e0e38861423d48ab511c57dd184296d67d822756450ce4164c4c3
+  metadata.gz: 872ad7d006fbcb1c552dc863982d037e3eb9ba2ca8e8aab9d785d9e55ba0651c19c367ce03a0280317947e5ad2352b40eefc66a47e6bb5e3cbc1a3c36d298d91
+  data.tar.gz: 8000b8d73b08f71554efad482cd8cf5518db22b01fc3828c985b669e5b013819785f4c41369ef5007ea375bf49f0b5b2195864e79d88c9d55bb089c9b5149388

data/README.md

@@ -32,6 +32,7 @@ The theme was originally created for the yearly Winterkongress conference of the
   * [Collection URLs](#collection-urls)
   * [Language](#language)
   * [Navigation Bar](#navigation-bar)
+  * [Open Graph Link Preview](#open-graph-link-preview)
   * [Main Landing Page](#main-landing-page)
   * [Information Boxes](#information-boxes)
   * [Live Indications & Streaming](#live-indications---streaming)
@@ -169,7 +170,7 @@ In case you do not want to install the entire Ruby/Jekyll toolchain on your mach
 
 - `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.
 - `test.yml`: automatically tries to build the website upon a new pull request. It can thus be used as status check before merging.
-- `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.
+- `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.
 
 To get started, simply copy the desired workflow file to your repository and adapt it to your needs:
 
@@ -283,9 +284,32 @@ conference:
     ...
     logo:
       name: Magic Organisation
+      img: 'logo.svg'  # inside /assets/images/
       url: 'https://github.com'
 ```
 
+### Open Graph Link Preview
+
+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 presented when shared via different platform and apps. In order to disable these `<meta>` tags add the `disable: true` setting (default: `false`) to the `link_preview` property.
+
+In order 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".
+
+Optionally, an image which 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 activate 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.
+
+```yaml
+title: Conference 2020
+preposition: 'at'
+
+...
+
+conference:
+  link_preview:
+    disable: false
+    img:
+      twitter: 'twitter_preview.png'      # inside /assets/images/
+      open_graph: 'facebook_preview.png'  # inside /assets/images/
+```
+
 ### Main Landing Page
 
 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.
@@ -695,6 +719,15 @@ Custom Bootstrap themes or simple color schemes such as designed with [Bootstrap
 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;`
 3. Add any additional CSS styles after it.
 
+## Development
+
+If you want to modify this theme and see its changes on an existing project, simply indicate in your `Gemfile` that you want to use the local copy of the theme by adding a `path` indication after the gem instantiation:
+
+```ruby
+group :jekyll_plugins do
+  gem "jekyll-theme-conference", path: "../[path to your local theme]"
+end
+```
 
 ## License
 

data/_includes/partials/checks.html

@@ -4,7 +4,7 @@
   {%- unless site.conference.lang == "en" -%}
     {%- assign errors = errors | push : "The internationalization file containing different strings for this template seems to be missing. Have you copied the `_data/lang.yml` file from the [theme's repository](https://github.com/DigitaleGesellschaft/jekyll-theme-conference/blob/master/_data/lang.yml) to you local website folder?" -%}
   {%- endunless -%}
-{%- elsif site.data.lang.version != 6 -%}
+{%- elsif site.data.lang.version != 7 -%}
   {%- assign errors = errors | push : "The internationalization file in `_data/lang.yml` seems to be outdated and does not correspond to the current version of the theme. Grab the current version from the [theme's repository](https://github.com/DigitaleGesellschaft/jekyll-theme-conference/blob/master/_data/lang.yml)." -%}
 {%- endunless -%}
 {%- unless site.conference.lang == "en" or site.conference.lang == "de" or site.conference.lang == "fr" or site.conference.lang == "pt" -%}

data/_includes/partials/get_page_description.html

@@ -0,0 +1,23 @@
+{%- unless site.preposition == empty -%}
+  {%- assign preposition = site.preposition -%}
+{%- else -%}
+  {%- assign preposition = '-' -%}
+{%- endunless -%}
+
+{%- capture page_description -%}
+  {%- if page.layout == 'talk' -%}
+    {{ site.data.lang[site.conference.lang].talk.title | default: 'Talk' }} {{ site.data.lang[site.conference.lang].pronoun.by | default: 'by'}} {% include partials/list_speakers.html text_only=true %} {{ preposition }} {{ site.title }}
+  {%- elsif page.layout == 'speaker' -%}
+    {{ site.data.lang[site.conference.lang].speaker.title | default: 'Speaker' }} {{ preposition }} {{ site.title }}
+  {%- elsif site.description -%}
+    {{ site.description }}
+  {%- endif -%}
+{%- endcapture -%}
+
+{%- if page_description.empty and include.default -%}
+  {%- assign page_description = include.default -%}
+{%- endif -%}
+
+{%- if include.replace_quotes -%}
+  {%- assign page_description = page_description | replace: '"', "'" -%}
+{%- endif -%}

data/_includes/partials/get_page_title.html

@@ -0,0 +1,33 @@
+{%- capture page_title -%}
+  {%- if page.layout == 'room' -%}
+    {{- page.name -}}
+  {%- elsif page.layout == 'speaker' -%}
+    {{- page.first_name }} {{ page.last_name -}}
+  {%- elsif page.layout == 'talk' -%}
+    {{- page.name -}}
+
+  {%- elsif page.title -%}
+    {{- page.title -}}
+
+  {%- else -%}
+    {%- if page.layout == 'location' -%}
+      {{- site.data.lang[site.conference.lang].location.title | default: "Location" -}}
+    {%- elsif page.layout == 'program' -%}
+      {{- site.data.lang[site.conference.lang].program.title | default: "Program" -}}
+    {%- elsif page.layout == 'speaker-overview' -%}
+      {{- site.data.lang[site.conference.lang].speaker.overview | default: "Speakers" -}}
+    {%- elsif page.layout == 'stream-overview' -%}
+      {{ site.data.lang[site.conference.lang].live.stream | default: "Live Streams" }}
+    {%- elsif page.layout == 'talk-overview' -%}
+      {{- site.data.lang[site.conference.lang].talk.overview | default: "Talks" -}}
+    {%- endif -%}
+  {%- endif -%}
+{%- endcapture -%}
+
+{%- if page_title == empty and include.default -%}
+  {%- assign page_title = include.default -%}
+{%- endif -%}
+
+{%- if include.replace_quotes -%}
+  {%- assign page_title = page_title | replace: '"', "'" -%}
+{%- endif -%}

data/_includes/partials/header.html

@@ -5,16 +5,19 @@
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
+  {% include partials/get_page_title.html -%}
   <title>
-    {% unless page.name contains '.' %}{{ page.name }} - {% else %}{% if page.title %}{{ page.title }} - {% endif %}{% endunless %}{{ site.title }}
+    {{- page_title -}}
+    {%- unless page_title == empty %} - {% endunless -%}
+    {{- site.title -}}
   </title>
-  <meta name="description" content="{{ site.description }}" />
+  {% include partials/list_page_meta.html %}
 
   <link rel="stylesheet" href="{{ site.baseurl }}/assets/css/main.css?t={{ site.time | date: "%s" }}" />
 
   <link rel="preload" as="font" href="{{ site.baseurl }}/assets/webfonts/fa-regular-400.woff2" type="font/woff2" crossorigin="anonymous" />
   <link rel="preload" as="font" href="{{ site.baseurl }}/assets/webfonts/fa-solid-900.woff2" type="font/woff2" crossorigin="anonymous" />
-  {% if site.conference.live -%}
+  {%- if site.conference.live %}
   <link rel="prefetch" as="image" href="{{ site.baseurl }}/assets/icons/live.svg" type="image/svg+xml" crossorigin="anonymous" />
   <link rel="prefetch" as="fetch" href="{{ site.baseurl }}/assets/js/data.json" type="application/json" crossorigin="anonymous" />
   {%- endif %}

data/_includes/partials/list_page_meta.html

@@ -0,0 +1,23 @@
+{% unless site.conference.link_preview.disable -%}
+  {%- include partials/get_page_title.html default=site.title replace_quotes=true -%}
+  {%- include partials/get_page_description.html default=site.title replace_quotes=true -%}
+
+  <meta name="description" content="{{ page_description }}" />
+
+  <meta name="twitter:card" content="summary" />
+  {%- if site.conference.link_preview.img and site.conference.link_preview.img.twitter %}
+  <meta name="twitter:image" content="{{ site.conference.link_preview.img.twitter | prepend: '/assets/images/' | prepend: site.baseurl | prepend: site.url }}" />
+  {%- endif %}
+  <meta name="twitter:title" content="{{ page_title }}" />
+  <meta name="twitter:description" content="{{ page_description }}" />
+
+  <meta property="og:site_name" content="{{ site.title }}" />
+  {%- if site.conference.link_preview.img and site.conference.link_preview.img.open_graph %}
+  <meta property="og:image" content="{{ site.conference.link_preview.img.open_graph | prepend: '/assets/images/' | prepend: site.baseurl | prepend: site.url }}" />
+  {%- endif %}
+  <meta property="og:url" content="{{ page.url | prepend: site.baseurl | prepend: site.url }}" />
+  <meta property="og:title" content="{{ page_title }}" />
+  <meta property="og:description" content="{{ page_description }}" />
+  <meta property="og:type" content="website" />
+
+{%- endunless %}

data/_includes/partials/list_speakers.html

@@ -1,4 +1,4 @@
-{%- for speaker_name in talk.speakers -%}
+{% for speaker_name in talk.speakers -%}
   {%- assign speaker = site.speakers | where: 'name', speaker_name | first -%}
   {%- if site.conference.speakers.show_firstname -%}
     {%- assign speaker_short = speaker.first_name | append: ' ' | append: speaker.last_name -%}
@@ -6,11 +6,17 @@
     {%- assign speaker_short = speaker.first_name | slice: 0 | append : '. ' | append: speaker.last_name -%}
   {%- endif -%}
 
-  {%- if speaker.hide -%}
-    {{ speaker_short }}
+  {%- if speaker.hide or include.text_only -%}
+    {{- speaker_short -}}
   {%- else -%}
-    <a class="text-reset" href="{{ speaker.url | prepend: site.baseurl }}">{{ speaker_short }}</a>
+    <a class="text-reset" href="{{ speaker.url | prepend: site.baseurl }}">
+      {{- speaker_short -}}
+    </a>
   {%- endif -%}
-  {%- if forloop.last != true %}, {% endif -%}
+
+  {%- unless forloop.last %}
+    {%- assign forloop_index_before_last = talk.speakers.size | minus: 1 -%}
+    {% if forloop.index == forloop_index_before_last and include.text_only %} {{ site.data.lang[site.conference.lang].pronoun.and | default: 'and' }} {% else %}, {% endif -%}
+  {%- endunless -%}
 
 {%- endfor -%}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-theme-conference
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Lorenz Schmid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -83,12 +83,15 @@ files:
 - _includes/partials/get_link_types.html
 - _includes/partials/get_live_timestamps.html
 - _includes/partials/get_main_category.html
+- _includes/partials/get_page_description.html
+- _includes/partials/get_page_title.html
 - _includes/partials/get_talk_time.html
 - _includes/partials/get_talk_timestamp.html
 - _includes/partials/get_time_pronoun.html
 - _includes/partials/header.html
 - _includes/partials/info_bar.html
 - _includes/partials/list_categories.html
+- _includes/partials/list_page_meta.html
 - _includes/partials/list_speakers.html
 - _includes/partials/list_sub_categories.html
 - _includes/partials/modal_link.html
@@ -280,7 +283,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key: 
 specification_version: 4
 summary: Jekyll template for a conference website containing program, speaker, talks