module Nanoc::Helpers::Tagging

Provides support for managing tags added to items.

To add tags to items, set the `tags` attribute to an array of tags that should be applied to the item.

@example Adding tags to an item

tags: [ 'foo', 'bar', 'baz' ]

Public Instance Methods

items_with_tag(tag) click to toggle source

Find all items with the given tag.

@param [String] tag The tag for which to find all items

@return [Array] All items with the given tag

# File lib/nanoc/helpers/tagging.rb, line 42
def items_with_tag(tag)
  @items.select { |i| (i[:tags] || []).include?(tag) }
end
tags_for(item, base_url: nil, none_text: '(none)', separator: ', ') click to toggle source

Returns a formatted list of tags for the given item as a string. The tags will be linked using the {#link_for_tag} function; the HTML-escaping rules for {#link_for_tag} apply here as well.

@param [String] base_url The URL to which the tag will be appended

to construct the link URL. This URL must have a trailing slash. The
function will return a tags string without tag page link if the param
is not provided.

@param [String] none_text The text to display when

the item has no tags

@param [String] separator The separator to put between tags

@return [String] A hyperlinked list of tags for the given item

# File lib/nanoc/helpers/tagging.rb, line 29
def tags_for(item, base_url: nil, none_text: '(none)', separator: ', ')
  if item[:tags].nil? || item[:tags].empty?
    none_text
  else
    item[:tags].map { |tag| base_url ? link_for_tag(tag, base_url) : tag }.join(separator)
  end
end