jekyll-octopod 0.23.0 → 0.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e8a41ff862f72c1aec7028926e077d7bd3d6f202a3139b2e733d1ea2033b2df
-  data.tar.gz: 3a9f0249e0039acc36666d3e3c74d450864677b73967b63ff8f79e75a7cf90d3
+  metadata.gz: d953001b39397be865714d7b3ed448dc513ae4673d1c362bacead88d51897be9
+  data.tar.gz: 5c0f42e40cec30b2977f495df8169f5f92d5b2c02a38b9a8320c9613cc456e06
 SHA512:
-  metadata.gz: ff581e079d12768deded21853f2568ce4a1fbe03c42187e81f1cf8016979f2fe9f3deaed583cf93ec436f8f9f7cfb20e00b90ee1d20f98700836d35eb3120140
-  data.tar.gz: 62c687c7c7b91ff57ea896b6145bb7e8b16c786d358ae95ac1c3095dc96db89e8a5fbe9d012498e74162215c97d429c3abf908e02e1aef2e36d3903425761508
+  metadata.gz: 8c5b98504862f358426070babb61db21df771c307070b2408631896dcb133a187aa6b5eb807dc981cff65cd0968d3b39626082e91fbdeffbc9cc00ef76e6d360
+  data.tar.gz: e8884a4dac88e26b5ebad5230451524b6cdd9cdc12a86eda7b9bd9af1e885d66c64f8d81c98ea5816335ed1c9e04ac6590ece78aa54d2d75dd2b320df6218023

data/assets/_config.yml.sample

@@ -26,6 +26,20 @@ rsync_delete: true
 ### Fediverse config, optional
 fediverse_url: https://podcasts.social/@my_account # Fediverse links will not be shown unless this is set
 
+### Feed permalinks, optional: by default the episode feeds live at /episodes.<format>.rss. When
+### migrating a podcast from another platform, keep its old feed URL so subscribers don't have to
+### resubscribe (a path ending in "/" is written as index.html, which every web server serves).
+# episode_feed_permalinks:
+#   mp3: /feed/mp3/
+
+### Transcript speakers, optional: map WebVTT voice tags (<v Thomas>) to names and avatars shown
+### in the player's transcript. Without this, the voice tag itself is shown as the speaker's name.
+# speakers:
+#   - id: thomas
+#     name: Thomas Kahle
+#     voice: Thomas # defaults to name
+#     avatar: /assets/img/speakers/thomas.jpg
+
 language: en
 explicit: "no" # "yes" | "no" | clean
 

data/lib/jekyll/octopod_filters.rb

@@ -283,7 +283,7 @@ module Jekyll
 
       if site['episode_feed_formats']
         site['episode_feed_formats'].map { |f|
-         feeds << ["#{f} Episode RSS-Feed", "#{site['url']}/episodes.#{f}.rss"] unless f == except
+         feeds << ["#{f} Episode RSS-Feed", OctopodFilters.feed_url(site, f)] unless f == except
         }
       end
       if site['additional_feeds']
@@ -295,6 +295,33 @@ module Jekyll
       feeds
     end
 
+    # Path of an episode feed page, relative to the site root. By default that's
+    # '/episodes.<format>.rss' (page 1) and '/episodes<n>.<format>.rss' (page n). The
+    # 'episode_feed_permalinks' setting in '_config.yml' moves page 1 of a format elsewhere, e.g. to
+    # keep the feed URL of a podcast migrated from another platform:
+    #
+    #   episode_feed_permalinks:
+    #     mp3: /feed/mp3/
+    def self.feed_path(site, format, page_number = 1)
+      permalink = (site['episode_feed_permalinks'] || {})[format.to_s]
+      if page_number == 1 && permalink && !permalink.to_s.strip.empty?
+        permalink.start_with?('/') ? permalink : "/#{permalink}"
+      else
+        "/episodes#{page_number == 1 ? '' : page_number}.#{format}.rss"
+      end
+    end
+
+    def self.feed_url(site, format, page_number = 1)
+      "#{site['url']}#{feed_path(site, format, page_number)}"
+    end
+
+    # Returns the full URL of an episode feed, honouring 'episode_feed_permalinks'.
+    #
+    #   {{ site | episode_feed_url:'mp3' }} => https://example.com/episodes.mp3.rss
+    def episode_feed_url(site, format)
+      OctopodFilters.feed_url(site, format)
+    end
+
     # Returns HTML links to all episode feeds named by the convetion
     # 'episodes.<episode_file_format>.rss' within the root directory. Also it
     # returns all additional feeds specified by 'additional_feeds' in the

data/lib/jekyll/paged_feed_page.rb

@@ -18,6 +18,33 @@ module Jekyll
       self.data['myself'] = page_number == 1 ? nil : page_number.to_s
       self.data['format'] = format
       self.data['page_number'] = page_number
+
+      # Full URLs for the feed's self/first/last/next/prev links, so the theme doesn't have to
+      # rebuild them from the naming convention (which an 'episode_feed_permalinks' entry changes).
+      config = site.config
+      self.data['self_url'] = OctopodFilters.feed_url(config, format, page_number)
+      self.data['first_url'] = OctopodFilters.feed_url(config, format, 1)
+      self.data['last_url'] = OctopodFilters.feed_url(config, format, [pages_total, 1].max)
+      self.data['next_url'] = OctopodFilters.feed_url(config, format, page_number + 1) if pages_total > page_number
+      self.data['prev_url'] = OctopodFilters.feed_url(config, format, page_number - 1) if page_number > 1
+
+      # Only the canonical first page moves; the generator's duplicate "episodes1.<format>.rss"
+      # stays where it is.
+      if name == "episodes.#{format}.rss"
+        path = OctopodFilters.feed_path(config, format, 1)
+        @feed_path = path unless path == "/#{name}"
+        self.data['permalink'] = @feed_path if @feed_path
+      end
+    end
+
+    # A custom feed path ending in "/" (like Podlove's "/feed/mp3/") is written as index.html, the
+    # one directory index every web server serves without extra configuration. Jekyll's default
+    # would be index.rss, which no server picks up for a directory URL.
+    def destination(dest)
+      return super unless @feed_path
+
+      path = @feed_path.end_with?('/') ? "#{@feed_path}index.html" : @feed_path
+      site.in_dest_dir(dest, URL.unescape_path(path))
     end
   end
-end
+end

data/lib/jekyll/podlove_player_tag.rb

@@ -45,9 +45,44 @@ module Jekyll
         duration: page["duration"],
         audio: audio,
         chapters: page["chapters"] ? page["chapters"].map { |chapter| split_chapter(chapter) }.compact : nil,
-        transcripts: transcripts_for(page),
         share: { channels: SHARE_CHANNELS }
-      }.to_json
+      }.merge(transcripts_and_contributors(page, config).compact).to_json
+    end
+
+    # The player shows a transcript cue's speaker by looking cue[:speaker] up by id in the
+    # top-level "contributors" list (and ignores cue[:voice] entirely), so the VTT voice tags only
+    # become visible names/avatars - and paragraph breaks at each speaker change - once both are
+    # filled in. Speakers can be declared per post or site-wide:
+    #
+    #   speakers:
+    #     - id: thomas
+    #       name: Thomas Kahle
+    #       voice: Thomas                    # matches <v Thomas>, defaults to name
+    #       avatar: /assets/img/speakers/thomas.jpg
+    #
+    # Voices without a declared speaker still get a contributor named after the voice itself, so
+    # speaker names work out of the box without any configuration.
+    def transcripts_and_contributors(page, config)
+      speakers = page["speakers"] || config["speakers"] || []
+      contributors = speakers.map do |speaker|
+        avatar = speaker["avatar"]
+        avatar = config["url"] + avatar if avatar&.start_with?("/")
+        { id: speaker["id"].to_s, name: speaker["name"], avatar: avatar, group: speaker["group"] }.compact
+      end
+      id_by_voice = speakers.to_h { |speaker| [speaker["voice"] || speaker["name"], speaker["id"].to_s] }
+
+      transcripts = transcripts_for(page)
+      transcripts&.each do |cue|
+        next unless cue[:voice]
+
+        unless id_by_voice.key?(cue[:voice])
+          id_by_voice[cue[:voice]] = cue[:voice]
+          contributors << { id: cue[:voice], name: cue[:voice] }
+        end
+        cue[:speaker] = id_by_voice[cue[:voice]]
+      end
+
+      { transcripts: transcripts, contributors: contributors.empty? ? nil : contributors }
     end
 
     # Finds a WebVTT transcript for this episode and parses it into the cue list Podlove Web

data/lib/octopod/version.rb

@@ -2,7 +2,7 @@ module Jekyll
   class Octopod
     module VERSION #:nodoc:
       MAJOR = 0
-      MINOR = 23
+      MINOR = 24
       TINY  = 0
 
       STRING = [MAJOR, MINOR, TINY].join('.')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-octopod
 version: !ruby/object:Gem::Version
-  version: 0.23.0
+  version: 0.24.0
 platform: ruby
 authors:
 - Arne Eilermann