Contains functionality for building XML sitemaps that will be crawled by search engines. See the [Sitemaps protocol site](www.sitemaps.org) for details.
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”.
@return [String] The XML sitemap
# File lib/nanoc3/helpers/xml_sitemap.rb, line 32 def xml_sitemap require 'builder' # 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.google.com/schemas/sitemap/0.84') do # Add item @items.reject { |i| i[:is_hidden] }.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
Generated with the Darkfish Rdoc Generator 2.