Module: Nanoc3::Helpers::LinkTo
Included Modules
Nanoc3::Helpers::LinkTo contains functions for linking to items.
To activate this helper, include it, like this:
include Nanoc3::Helpers::LinkTo
Public Visibility
Public Instance Method Summary
| #link_to(text, path_or_rep, attributes = {}) |
Creates a HTML link to the given path or item representation, and with the given text. |
|---|---|
| #link_to_unless_current(text, path_or_rep, attributes = {}) |
Creates a HTML link using link_to, except when the linked item is the current one. |
| #relative_path_to(target) |
Returns the relative path from the current item to the given path or item representation. |
Public Instance Methods Included from Nanoc3::Helpers::HTMLEscape
Public Instance Method Details
link_to
public
link_to(text, path_or_rep, attributes = {})
Creates a HTML link to the given path or item representation, and with the given text.
| path_or_rep: | the URL or path (a String) that should be linked to, or the item representation that should be linked to. |
| text: | the visible link text. |
| attributes: | a hash containing HTML attributes that will be added to the link. |
Examples:
link_to('Blog', '/blog/') # => '<a href="/blog/">Blog</a>' item_rep = @items.find { |i| i.item_id == 'special' }.reps(:default) link_to('Special Item', item_rep) # => '<a href="/special_item/">Special Item</a>' link_to('Blog', '/blog/', :title => 'My super cool blog') # => '<a href="/blog/" title="My super cool blog">Blog</a>
[View source]
37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'lib/nanoc3/helpers/link_to.rb', line 37 def link_to(text, path_or_rep, attributes={}) # Find path path = path_or_rep.is_a?(String) ? path_or_rep : path_or_rep.path # Join attributes attributes = attributes.inject('') do |memo, (key, value)| memo + key.to_s + '="' + h(value) + '" ' end # Create link "<a #{attributes}href=\"#{path}\">#{text}</a>" end |
link_to_unless_current
public
link_to_unless_current(text, path_or_rep, attributes = {})
Creates a HTML link using link_to, except when the linked item is the current one. In this case, a span element with class "active" and with the given text will be returned.
Examples:
link_to_unless_current('Blog', '/blog/') # => '<a href="/blog/">Blog</a>' link_to_unless_current('This Item', @item_rep) # => '<span class="active">This Item</span>'
[View source]
61 62 63 64 65 66 67 68 69 70 71 |
# File 'lib/nanoc3/helpers/link_to.rb', line 61 def link_to_unless_current(text, path_or_rep, attributes={}) # Find path path = path_or_rep.is_a?(String) ? path_or_rep : path_or_rep.path if @item_rep and @item_rep.path == path # Create message "<span class=\"active\" title=\"You're here.\">#{text}</span>" else link_to(text, path_or_rep, attributes) end end |
relative_path_to
public
relative_path_to(target)
Returns the relative path from the current item to the given path or item representation.
| path_or_rep: | the URL or path (a String) to where the relative should point, or the item representation to which the relative should point. |
Example:
# if the current item's path is /foo/bar/ relative_path('/foo/qux/') # => '../qux/'
[View source]
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/nanoc3/helpers/link_to.rb', line 85 def relative_path_to(target) require 'pathname' # Find path if target.is_a?(String) path = target elsif target.respond_to?(:reps) path = target.reps.find { |r| r.name == :default }.path else path = target.path end # Get source and destination paths dst_path = Pathname.new(path) src_path = Pathname.new(@item_rep.path) # Calculate elative path (method depends on whether destination is a # directory or not). if src_path.to_s[-1,1] != '/' relative_path = dst_path.relative_path_from(src_path.dirname).to_s else relative_path = dst_path.relative_path_from(src_path).to_s end # Add trailing slash if necessary if dst_path.to_s[-1,1] == '/' relative_path += '/' end # Done relative_path end |