Module: Nanoc3::Helpers::XMLSitemap

Defined in:
lib/nanoc3/helpers/xml_sitemap.rb

Overview

Contains functionality for building XML sitemaps that will be crawled by search engines. See the [Sitemaps protocol site](www.sitemaps.org) for details.

Instance Method Summary collapse

Instance Method Details

#xml_sitemap(params = {}) ⇒ String

Builds an XML sitemap and returns it.

The following attributes can optionally be set on items to change the behaviour of the sitemap:

  • ‘changefreq` — The estimated change frequency as defined by the Sitemaps protocol

  • ‘priority` — The item’s priority, ranging from 0.0 to 1.0, as defined by the Sitemaps protocol

The sitemap will also include dates on which the items were updated. These are generated automatically; the way this happens depends on the used data source (the filesystem data source checks the file mtimes, for instance).

The site configuration will need to have the following attributes:

  • ‘base_url` — The URL to the site, without trailing slash. For example, if the site is at “example.com/”, the `base_url` would be “example.com”.

Examples:

Excluding binary items from the sitemap


<%= xml_sitemap :items => @items.reject{ |i| i[:is_hidden] || i[:binary] } %>

Parameters:

  • params (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (params):

  • :items (Array) —

    A list of items to include in the sitemap

Returns:

  • (String) —

    The XML sitemap



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/nanoc3/helpers/xml_sitemap.rb', line 39

def xml_sitemap(params={})
  require 'builder'

  # Extract parameters
  items = params[:items] || @items.reject { |i| i[:is_hidden] }

  # Create builder
  buffer = ''
  xml = Builder::XmlMarkup.new(:target => buffer, :indent => 2)

  # Check for required attributes
  if @site.config[:base_url].nil?
    raise RuntimeError.new("The Nanoc3::Helpers::XMLSitemap helper requires the site configuration to specify the base URL for the site.")
  end

  # Build sitemap
  xml.instruct!
  xml.urlset(:xmlns => 'http://www.sitemaps.org/schemas/sitemap/0.9') do
    # Add item
    items.each do |item|
      item.reps.reject { |r| r.raw_path.nil? }.each do |rep|
        xml.url do
          xml.loc         @site.config[:base_url] + rep.path
          xml.lastmod     item.mtime.to_iso8601_date unless item.mtime.nil?
          xml.changefreq  item[:changefreq] unless item[:changefreq].nil?
          xml.priority    item[:priority] unless item[:priority].nil?
        end
      end
    end
  end

  # Return sitemap
  buffer
end