jekyll-tagging 0.2.0 → 0.3.0

data/ChangeLog

@@ -1,3 +1,7 @@
+== 0.3.0 [2012-02-03]
+
+* Feed per tag feature added.
+
 == 0.2.0 [2011-03-10]
 
 * Added support for pretty tag page URLs.

data/README.rdoc

@@ -2,13 +2,13 @@
 
 By Arne Eilermann <mailto:eilermann@lavabit.com> and Jens Wille <mailto:jens.wille@uni-koeln.de>
 
-jekyll-tagging is a Jekyll plugin, to add a tag cloud and per tag pages to your Jekyll generated Website.
+jekyll-tagging is a Jekyll plugin, to add a tag cloud and per tag pages plus feeds to your Jekyll generated Website.
 
 == Usage
 
 Install it:
 
-  sudo gem install jekyll-tagging
+  gem install jekyll-tagging
 
 Add the following to your <tt>_plugins/ext.rb</tt> file:
 
@@ -21,6 +21,14 @@ And in your <tt>_config.yml</tt> you have to define your layout used to generate
 
 Now you got a new filter called <tt>tag_cloud</tt> which you can use with the <tt>site</tt> object as argument in your layout to get a cloud of all your site's tags. The tags are linked to their related tag page. Furthermore, you got a <tt>tags</tt> filter which you can feed withe a <tt>post</tt> or a <tt>site</tt> object to get a link list of all its tags.
 
+You can optionally define a per tag Atom/RSS feed.  In your <tt>_config.yml</tt> define the following:
+
+  tag_feed_layout: tag_feed
+  tag_feed_dir: tag
+  
+(<tt>tag_page_dir</tt> and <tt>tag_feed_dir</tt> can have the same value.)
+
+
 === Example tag page layout
 
   ---
@@ -36,11 +44,38 @@ Now you got a new filter called <tt>tag_cloud</tt> which you can use with the <t
   <div id="tag-cloud">
     {{ site | tag_cloud }}
   </div>
+  
+  
+=== Example layout of an Atom feed
+
+  ---
+  layout: nil
+  ---
+  <?xml version="1.0" encoding="utf-8"?>
+  <feed xmlns="http://www.w3.org/2005/Atom">  
+   <title>Your Title - {{ page.tag }}</title>
+   <link href="http://example.com{{ page.url }}" rel="self"/>
+   <link href="http://example.com/tag/{{ page.tag }}.html"/>
+   <updated>{{ site.time | date_to_xmlschema }}</updated>
+   <id>http://example.com/tag/{{ page.tag }}.html</id>
+   <author>
+     <name>Author Here</name>
+   </author>
+   {% for post in page.posts %}
+   <entry>
+     <title>{{ post.title }}</title>
+     <link href="http://example.com{{ post.url }}"/>
+     <updated>{{ post.date | date_to_xmlschema }}</updated>
+     <id>http://example.com{{ post.id }}</id>
+     <content type="html">{{ post.content | xml_escape }}</content>
+   </entry>
+   {% endfor %}
+  </feed>
 
 == Links
 
 <b></b>
-Documentation:: <http://rdoc.info/github/pattex/jekyll-tagging>
+Documentation:: <http://rubydoc.info/gems/jekyll-tagging/frames>
 Source code:: <http://github.com/pattex/jekyll-tagging>
 RubyGem:: <http://rubygems.org/gems/jekyll-tagging>
 
@@ -48,7 +83,8 @@ RubyGem:: <http://rubygems.org/gems/jekyll-tagging>
 
 === The MIT License
 
-Copyright (c) 2010 Arne Eilermann
+Copyright (c) 2010-2011 University of Cologne,
+Albertus-Magnus-Platz, 50923 Cologne, Germany
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/Rakefile

@@ -1,4 +1,4 @@
-require %q{lib/jekyll/tagging/version}
+require File.expand_path(%q{../lib/jekyll/tagging/version}, __FILE__)
 
 begin
   require 'hen'
@@ -8,20 +8,16 @@ begin
       :name         => %q{jekyll-tagging},
       :version      => Jekyll::Tagging::VERSION,
       :summary      => %q{Jekyll plugin to automatically generate a tag cloud and tag pages.},
-      :files        => FileList['lib/**/*.rb'].to_a,
-      :extra_files  => FileList['[A-Z]*'].to_a,
-      :dependencies => %w[ruby-nuggets],
       :authors      => ['Arne Eilermann', 'Jens Wille'],
       :email        => ['eilermann@lavabit.com', 'jens.wille@uni-koeln.de'],
-      :homepage     => %q{http://github.com/pattex/jekyll-tagging}
+      :homepage     => :pattex,
+      :dependencies => %w[ruby-nuggets]
     }
   }}
-rescue LoadError
-  warn "Please install the `hen' gem."
+rescue LoadError => err
+  warn "Please install the `hen' gem. (#{err})"
 end
 
-### Place your custom Rake tasks here.
-
 begin
   require 'jekyll/testtasks/rake'
 rescue LoadError

data/lib/jekyll/tagging.rb

@@ -8,11 +8,14 @@ module Jekyll
     safe true
 
     def generate(site)
-      unless Tagger.const_defined?(:TAG_PAGE_DIR)
-        Tagger.const_set('TAG_PAGE_DIR', site.config['tag_page_dir'] || 'tag')
+      %w[TAG_PAGE_DIR TAG_FEED_DIR].each do |dir_name|
+        unless Tagger.const_defined?(dir_name.to_sym)
+          Tagger.const_set(dir_name, site.config[dir_name.downcase] || 'tag')
+        end
       end
 
       @tag_page_layout = site.config['tag_page_layout']
+      @tag_feed_layout = site.config['tag_feed_layout']
 
       unless Jekyll::Filters.const_defined?(:PRETTY_URL)
         Jekyll::Filters.const_set('PRETTY_URL', site.permalink_style == :pretty)
@@ -21,8 +24,7 @@ module Jekyll
       if @tag_page_layout
         generate_tag_pages(site)
       else
-        $stderr.puts 'WARNING: You have to define a tag_page_layout in ' +
-          'configuration file.'
+        warn 'WARNING: You have to define a tag_page_layout in configuration file.'
       end
 
       site.config.update({ 'tag_data' => calculate_tag_cloud(site) })
@@ -33,13 +35,16 @@ module Jekyll
     # to use this.
     def generate_tag_pages(site)
       site.tags.each { |tag, posts|
-        site.pages << new_tag_page(site, site.source, TAG_PAGE_DIR, tag, posts.sort.reverse)
+        site.pages << new_tag(site, site.source, TAG_PAGE_DIR, tag, posts.sort.reverse, @tag_page_layout)
+        if @tag_feed_layout
+          site.pages << new_tag(site, site.source, TAG_FEED_DIR, tag, posts.sort.reverse, @tag_feed_layout)
+        end
       }
     end
 
-    def new_tag_page(site, base, dir, tag, posts)
-      TagPage.new(site, base, dir, "#{tag}.html", {
-        'layout' => @tag_page_layout,
+    def new_tag(site, base, dir, tag, posts, layout)
+      TagPage.new(site, base, dir, "#{tag}#{site.layouts[layout].ext}", {
+        'layout' => layout,
         'posts'  => posts,
       })
     end

data/lib/jekyll/tagging/version.rb

@@ -5,7 +5,7 @@ module Jekyll
     module Version
 
       MAJOR = 0
-      MINOR = 2
+      MINOR = 3
       TINY  = 0
 
       class << self

metadata

@@ -1,94 +1,72 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: jekyll-tagging
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 0
-  version: 0.2.0
 platform: ruby
-authors: 
+authors:
 - Arne Eilermann
 - Jens Wille
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-10 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-04-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: ruby-nuggets
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70196087414680 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *70196087414680
 description: Jekyll plugin to automatically generate a tag cloud and tag pages.
-email: 
+email:
 - eilermann@lavabit.com
 - jens.wille@uni-koeln.de
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - ChangeLog
-files: 
+files:
 - lib/jekyll/tagging/version.rb
 - lib/jekyll/tagging.rb
 - ChangeLog
 - Rakefile
 - README.rdoc
-has_rdoc: true
 homepage: http://github.com/pattex/jekyll-tagging
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --all
+rdoc_options:
 - --charset
 - UTF-8
+- --line-numbers
+- --all
+- --title
+- jekyll-tagging Application documentation (v0.3.0)
 - --main
 - ChangeLog
-- --title
-- jekyll-tagging Application documentation (v0.2.0)
-- --line-numbers
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Jekyll plugin to automatically generate a tag cloud and tag pages.
 test_files: []
-