Module | Nanoc::Helpers::Tagging |
In: |
lib/nanoc/helpers/tagging.rb
|
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' ]
Returns a link to to the specified tag. The link is marked up using the rel-tag microformat. The `href` attribute of the link will be HTML- escaped, as will the content of the `a` element.
@param [String] tag The name of the tag, which should consist of letters
and numbers (no spaces, slashes, or other special characters).
@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.
@return [String] A link for the given tag and the given base URL
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.
@option params [String] base_url ("technorati.com/tag/") The URL
to which the tag will be appended to construct the link URL. This URL must have a trailing slash.
@option params [String] none_text ("(none)") The text to display when
the item has no tags
@option params [String] separator (", ") The separator to put between
tags
@return [String] A hyperlinked list of tags for the given item