Mar 12th, 2012

Octopress Customize Part 1

OctoPress カスタマイズ内容覚書 part1

今後しばらくの間、増えるであろう覚書の一発目。

タグクラウドの設定

標準ではタグが使えないので、使えるようにした。 category関連のファイルをコピーして、新たにtag_dir をtagとして使えるように改修。

ここが使いやすそうなので、これをインストール。
以下のように変更して、tag_cloud は tag_dirを使うようにした。

``` diff tagcloud.diff +++ tagcloud.rb 2012-03-12 10:44:40.000000000 +0900 @@ -57,21 +57,20 @@ lists = {} max, min = 1, 1 config = context.registers[:site].config - categorydir = config['root'] + config['categorydir'] + '/' - categories = context.registers[:site].categories - categories.keys.sortby{ |str| str.downcase }.each do |category| - count = categories[category].count - lists[category] = count + tagdir = config['tagdir'] + '/' + tags = context.registers[:site].tags + tags.keys.sortby{ |str| str.downcase }.each do |tag| + count = tags[tag].count + lists[tag] = count max = count if count > max end

   html = ''

そして、plugins/tag_generator.rb を作成。（中身はcategory_generator.rb)

``` ruby tag_generator.rb

encoding: utf-8

module Jekyll

# The TagIndex class creates a single tag page for the specified tag. class TagIndex < Page

# Initializes a new TagIndex.
#
#  +base+         is the String path to the <source>.
#  +tag_dir+ is the String path between <source> and the tag folder.
#  +tag+     is the tag currently being processed.
def initialize(site, base, tag_dir, tag)
  @site = site
  @base = base
  @dir  = tag_dir
  @name = 'index.html'
  self.process(@name)
  # Read the YAML data from the layout page.
  self.read_yaml(File.join(base, '_layouts'), 'tag_index.html')
  self.data['tag']    = tag
  # Set the title for this page.
  title_prefix             = site.config['tag_title_prefix'] || 'Tag: '
  self.data['title']       = "#{title_prefix}#{tag}"
  # Set the meta-description for this page.
  meta_description_prefix  = site.config['tag_meta_description_prefix'] || 'Tag: '
  self.data['description'] = "#{meta_description_prefix}#{tag}"
end

end

# The TagFeed class creates an Atom feed for the specified tag. class TagFeed < Page

# Initializes a new TagFeed.
#
#  +base+         is the String path to the <source>.
#  +tag_dir+ is the String path between <source> and the tag folder.
#  +tag+     is the tag currently being processed.
def initialize(site, base, tag_dir, tag)
  @site = site
  @base = base
  @dir  = tag_dir
  @name = 'atom.xml'
  self.process(@name)
  # Read the YAML data from the layout page.
  self.read_yaml(File.join(base, '_includes/custom'), 'tag_feed.xml')
  self.data['tag']    = tag
  # Set the title for this page.
  title_prefix             = site.config['tag_title_prefix'] || 'tag: '
  self.data['title']       = "#{title_prefix}#{tag}"
  # Set the meta-description for this page.
  meta_description_prefix  = site.config['tag_meta_description_prefix'] || 'Tag: '
  self.data['description'] = "#{meta_description_prefix}#{tag}"

  # Set the correct feed URL.
  self.data['feed_url'] = "#{tag_dir}/#{name}"
end

end

# The Site class is a built-in Jekyll class with access to global site config information. class Site

# Creates an instance of TagIndex for each tag page, renders it, and
# writes the output to a file.
#
#  +tag_dir+ is the String path to the tag folder.
#  +tag+     is the tag currently being processed.
def write_tag_index(tag_dir, tag)
  index = TagIndex.new(self, self.source, tag_dir, tag)
  index.render(self.layouts, site_payload)
  index.write(self.dest)
  # Record the fact that this page has been added, otherwise Site::cleanup will remove it.
  self.pages << index

  # Create an Atom-feed for each index.
  feed = TagFeed.new(self, self.source, tag_dir, tag)
  feed.render(self.layouts, site_payload)
  feed.write(self.dest)
  # Record the fact that this page has been added, otherwise Site::cleanup will remove it.
  self.pages << feed
end

# Loops through the list of tag pages and processes each one.
def write_tag_indexes
  if self.layouts.key? 'tag_index'
    dir = self.config['tag_dir'] || 'tags'
    self.tags.keys.each do |tag|
      self.write_tag_index(File.join(dir, tag.gsub(/_|\P{Word}/, '-').gsub(/-{2,}/, '-').downcase), tag)
    end

  # Throw an exception if the layout couldn't be found.
  else
    throw "No 'tag_index' layout found."
  end
end

end

# Jekyll hook - the generate method is called by jekyll, and generates all of the tag pages. class GenerateTags < Generator safe true priority :low

def generate(site)
  site.write_tag_indexes
end

end

# Adds some extra filters used during the tag creation process. module Filters

# Outputs a list of tags as comma-separated <a> links. This is used
# to output the tag list for each post on a tag page.
#
#  +tags+ is the list of tags to format.
#
# Returns string
#
def tag_links(tags)
  dir = @context.registers[:site].config['tag_dir']
  tags = tags.sort!.map do |item|
    "<a class='tag' href='#{dir}/#{item.gsub(/_|\P{Word}/, '-').gsub(/-{2,}/, '-').downcase}/'>#{item}</a>"
  end

  case tags.length
  when 0
    ""
  when 1
    tags[0].to_s
  else
    "#{tags[0...-1].join(', ')}, #{tags[-1]}"
  end
end

# Outputs the post.date as formatted html, with hooks for CSS styling.
#
#  +date+ is the date object to format as HTML.
#
# Returns string
def date_to_html_string(date)
  result = '<span class="month">' + date.strftime('%b').upcase + '</span> '
  result += date.strftime('<span class="day">%d</span> ')
  result += date.strftime('<span class="year">%Y</span> ')
  result
end

end

end ```

コレに伴い、 /sass/partials/_archive.scss と /sass/partials/_blog.scss を修正。
また、/source/_layouts/tag_index.html, /source/_includes/post/tags.html, /source/_includes/custom/tag_feed.xml を追加。