jekyll-octopod 0.5.3 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69ee05cf08ca26492fee99f147bd61664f457765
-  data.tar.gz: 8bdfa92f3a4fcab1e78aceac85644cf038d4653a
+  metadata.gz: 407054feab491c836c3756f08d6fb2a9e107d66d
+  data.tar.gz: 6ca029cd8f126d6764458760720ecf6216d8a81d
 SHA512:
-  metadata.gz: 7cb0c5ad2295da191d2737f956933733d0cd3903e8d5ff92826651ff10c2dc42be918c59bb823b7439b72fe97fcf6864aa375f3a9ac45b1251b10b4dfc315976
-  data.tar.gz: e6abc68601fd4d2b1b586d7042d2335d72185560ddb39dae56ece2354d8f3e0fa25f9bef9cb641bddf8ef04f3428347c6d4f738eb36282a358c6334f6078bf70
+  metadata.gz: e96c4a9e63b139683a7713fdd396ffa3968c996b44d22b15ab7c4d3c5a16c6bd1c757afcd63be0ea5036103e679cda4f95749e990d7fe0defe0d565941905681
+  data.tar.gz: a2eb1e597101a284150cefcece71617aa7a1628997d72eabac7bb03c7bc9f66db5b5166b763e0f9b0f601643e241326ba55e9c97e11baf9405f208fe32744ea0

data/README.md

@@ -5,67 +5,4 @@
 <img align="right" src="assets/img/logo.jpg" alt="logo">
 A podcast publishing extension for the static site generator [Jekyll](https://jekyllrb.com/)
 
-## tl;dr
-
-You generate a static web site for your podcast on your own computer, test drive it and sync it to your web space.
-
-So no Wordpress, PHP, Ruby other scripting language, database management system or any other dynamic component is needed on your server.
-This increases security immensely.
-
-## Tell me more!
-
-If you want to take a look: See (and listen to) Stefan's podcast [Aua-Uff-Code!](https://aua-uff-co.de).
-
-The page, you will get, when you follow the installation instructions later, looks like this:
-
-![screenshot](materials/demo.png)
-
-Technically speaking, jekyll-octopod is a Jekyll plugin and a Ruby Gem. It
-contains of scripts, templates, helpers and extensions to publish your
-podcasts the cool text file lover's way.
-
-If you are not afraid of the command line of your computer and text files are the
-stuff to heat up your geeky little heart, jekyll-octopod may be worth a trial
-to publish your podcasts.
-
-The underlying assumptions of jekyll-octopod are that static content
-should be delivered statically and text files are the perfect way to handle
-podcast metadata. So jekyll-octopod makes it easy to generate and deploy a
-website and feeds for your podcast out of one textfile and at least one audio
-file per episode.
-
-
-## Features
-
-jekyll-octopod brings innately:
-* iTunes ready episode feeds for different file formats (e.g. mp3, ogg, m4a)
-* a ready to use [Bootflat](http://bootflat.github.io/) and  [Twitter Bootstrap](http://twitter.github.com/bootstrap/) based, responsible (i.e. mobile friendly) layout modifiable to your heart's desire.
-* [Flattr](https://flattr.com/) support on the website and in the episode feed
-* [Twitter](https://twitter.com) integration on the website
-* comments via [Disqus](http://disqus.com/)
-* [Podlove Web Player](http://podlove.org/podlove-web-player/) in it's current version 3.0
-* Static player pages that are embeddable in iframes at your other or affiliates' sites
-* [Podlove Alternate Feeds](http://podlove.org/alternate-feeds/)
-* [Podlove Simple Chapters](http://podlove.org/simple-chapters/)
-* [Podlove Subscribe Button](http://podlove.org/podlove-subscribe-button/) for easy podcast subscription on any operating system, including mobile phones.
-* https compatibility
-* Google search integration
-* easy creation of show notes
-
-**Is this production ready?**
-
-We use it in production, so we believe it is.
-But it is very likely, that it still contains bugs. And there is no guarantee that behavior will not change with the next update :-).
-
-Hopefully you are brave enough to play with this cute little toy anyway.
-
-
-## Documentation
-
-Detailed documentation is provided in the [Wiki](https://github.com/informatom/jekyll-octopod/wiki)
-
-## Maintainer
-
-Stefan Haslinger <mailto:stefan.haslinger@informatom.com>
-
-Credits go to lots of [people and projects](https://github.com/informatom/jekyll-octopod/wiki/Credits).
+jekyll-octopod has now it's own [Project Site](https://jekyll-octopod.github.io/)!

data/assets/_config.yml

@@ -0,0 +1,53 @@
+# You have to configure this ###################################################
+title: Octopod
+# You should configure this ####################################################
+url: http://localhost:4000
+subtitle: Static Site Podcast Publishing for Geeks
+description: My super duper cool podcast.
+author: Uncle Octopod
+email: octopod@example.com
+keywords: [octopod, podcast, magic]
+itunes_categories: [Technology]
+# additional_feeds:
+#   itunes: http://itunes.apple.com/de/podcast/podcast_name/id42424242
+#   torrent_m4a: http://bitlove.org/example_user/example_podcast_m4a/feed
+#   torrent_mp3: http://bitlove.org/example_user/example_podcast_mp3/feed
+episodes_per_feed_page: 99
+## podlove-web-palyer ##########################################################
+poster: /img/logo-360x360.png
+alwaysShowHours: true
+startVolume: 0.8
+width: auto
+summaryVisible: false
+timecontrolsVisible: false
+chaptersVisible: true
+sharebuttonsVisible: false
+## Rsync Deploy config #########################################################
+### Be sure your public key is listed in your server's ~/.ssh/authorized_keys
+### file.
+ssh_host: user@host.org
+ssh_port: 22
+document_root: /path/to/your/htdocs/
+rsync_delete: true
+# You can configure this #######################################################
+twitter_nick: my_twitter_handle
+language: en
+explicit: 'no'  # 'yes'/'no'/clean
+license: CC BY 4.0
+license_url: https://creativecommons.org/licenses/by/4.0/
+license_image_url: https://i.creativecommons.org/l/by/4.0/88x31.png
+## Flattr ######################################################################
+flattr_uid: # Flattr will not be used unless this is set
+flattr_button: compact # compact | default
+flattr_mode: auto # auto | manual(default)
+flattr_popout:  1 # 1 | 0 (show popout when hovering mouse over button)
+flattr_language: en_GB # available languages - https://api.flattr.com/rest/v2/languages.txt
+flattr_category: audio # available categories - https://api.flattr.com/rest/v2/categories.txt
+## Disqus comments #############################################################
+disqus_shortname: # Disqus will not be used unless this is set
+disqus_developer: 0 # 1 / 0
+## Feed links ###########################################################
+itunes_url: https://itunes.apple.com/at/podcast/myname/id#myid#
+bitlove_url: https://bitlove.org/myaccount
+fyyd_url: https://fyyd.de/podcast/myaccount/myid
+gpodder_url: https://gpodder.net/podcast/mypodcast

data/assets/_config.yml.sample

@@ -12,6 +12,7 @@ itunes_categories: [Technology]
 #   itunes: http://itunes.apple.com/de/podcast/podcast_name/id42424242
 #   torrent_m4a: http://bitlove.org/example_user/example_podcast_m4a/feed
 #   torrent_mp3: http://bitlove.org/example_user/example_podcast_mp3/feed
+episodes_per_feed_page: 99
 ## podlove-web-palyer ##########################################################
 poster: /img/logo-360x360.png
 alwaysShowHours: true

data/assets/_layouts/feed.xml

@@ -6,7 +6,12 @@ layout: null
   <channel>
     <title>{{ site.title }}</title>
     <link>{{ site.url }}</link>
-    <atom:link href="{{ site.url }}/episodes.{{ page.format }}.rss" rel="self" type="application/rss+xml" title="{{ page.format }} Episode RSS-Feed"/>
+    <atom:link href="{{ site.url }}/episodes.{{ page.format }}.rss{{page.myself}}" rel="self" type="application/rss+xml" title="{{ page.format }} Episode RSS-Feed"/>
+    <atom:link href="{{ site.url }}/episodes.{{ page.format }}.rss" rel="first" type="application/rss+xml" />
+    <atom:link href="{{ site.url }}/episodes.{{ page.format }}.rss{{page.last}}" rel="last" type="application/rss+xml" />
+    {% if page.next %}<atom:link href="{{ site.url }}/episodes.{{ page.format }}.rss{{page.next}}" rel="next" type="application/rss+xml" />{% endif %}
+    {% if page.prev %}<atom:link href="{{ site.url }}/episodes.{{ page.format }}.rss{{page.prev}}" rel="prev" type="application/rss+xml" />{% endif %}
+
     {{ site | episode_feeds_rss:page.format }}
     <description>{{ site.description | markdownify | strip_html }}</description>
     <lastBuildDate>{{ site.time | time_to_rssschema }}</lastBuildDate>

data/assets/_plugins/feed_generator.rb

@@ -0,0 +1,40 @@
+module Jekyll
+  class PagedFeedPage < Page
+    def initialize(site, base, dir, name, page_number, pages_total, format)
+      @site = site
+      @dir = "/"
+      @name = name
+
+      self.process(@name)
+      self.read_yaml(File.join(base, '_layouts'), 'feed.xml')
+      self.data['next'] = pages_total > page_number ? "?page=" + (page_number + 1).to_s : nil
+      self.data['last'] = pages_total > 1 ? "?page=" + pages_total.to_s : nil
+      self.data['prev'] = case page_number
+        when 1 then nil
+        when 2 then ""
+        else        "?page=" + (page_number - 1).to_s
+      end
+      self.data['myself'] = page_number == 1 ? nil : "?page=" + page_number.to_s
+      self.data['format'] = format
+    end
+  end
+
+  class PagedFeedPageGenerator < Generator
+    safe true
+
+    def generate(site)
+      pages_total = site.posts.docs.count / site.config["episodes_per_feed_page"].ceil
+
+      site.config["episode_feed_formats"].each do |page_format|
+        name = "episodes." + page_format + ".rss"
+        page = PagedFeedPage.new(site, site.source, ".", name, 1, pages_total, page_format)
+        site.pages << page
+        (1..pages_total).each do |page_number|
+          name = "episodes." + page_format + ".rss?page=" + page_number.to_s
+          page = PagedFeedPage.new(site, site.source, ".", name, page_number, pages_total, page_format)
+          site.pages << page
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/octopod/version.rb

@@ -2,8 +2,8 @@ module Jekyll
   class Octopod
     module VERSION #:nodoc:
       MAJOR = 0
-      MINOR = 5
-      TINY  = 3
+      MINOR = 6
+      TINY  = 0
 
       STRING = [MAJOR, MINOR, TINY].join('.')
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-octopod
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.6.0
 platform: ruby
 authors:
 - Arne Eilermann
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-01 00:00:00.000000000 Z
+date: 2016-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -50,6 +50,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
+- assets/_config.yml
 - assets/_config.yml.sample
 - assets/_includes/disqus_count.html
 - assets/_includes/disqus_thread.html
@@ -64,6 +65,7 @@ files:
 - assets/_layouts/page.html
 - assets/_layouts/player_index.html
 - assets/_layouts/post.html
+- assets/_plugins/feed_generator.rb
 - assets/_plugins/flattr_filters.rb
 - assets/_plugins/octopod_filters.rb
 - assets/_plugins/podcast_player_page_generator.rb
@@ -203,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: jekyll-
-rubygems_version: 2.4.8
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Podcasting Publishing Extension for Jekyll