sitemapify

Sitemapify

Provides a ASP.NET HttpHandler to assist with generating a dynamic sitemap.xml file

There is also an Umbraco specific extension to Sitemapify that supports building the sitemap from Umbraco CMS content. See Sitemapify.Umbraco for further documentation

Installation

Install-Package Sitemapify

The installation process should have updated your web.config file to include a httphandler to process requests to sitemap.xml, it should look similar to:

">

<configuration>
  <system.webServer>
    <handlers>
      <add name="Sitemapify" path="sitemap.xml" verb="GET" type="Sitemapify.SitemapifyHttpHandler, Sitemapify" />
    handlers>
  system.webServer>
configuration>

Customisation

The sitemap handler can be customised by altering the base configuration via the Sitemapify.Configure static configuration class.

Sitemapify.Configure(c => c
  .UsingContentProvider(new YourContentProvider())
  .UsingCacheProvider(new YourCacheProvider())
  .UsingDocumentBuilder(new YourDocumentBuilder())
);

Sitemapify is split into providers that are responsible for elements of the sitemap generation.

Content Provider (ISitemapifyContentProvider)

An implementation of a content provider supplies Sitemapify with a collection of SitemapUrl objects representing the nodes to output within the sitemap.

public interface ISitemapContentProvider
{
    IEnumerable<SitemapUrl> GetSitemapUrls();
    bool Cacheable { get; }
    DateTime CacheUntil { get; }
}

Cache Provider (ISitemapifyCacheProvider)

An implementation of a cache provider allows customisation of the caching mechanism used to optimise delivery of the sitemap to the browser. Once the sitemap document is generated it will be cached via the configured implementation of this interface.

public interface ISitemapCacheProvider
{
    void Add(XDocument sitemapContent, DateTimeOffset? expires);
    bool IsCached { get; }
    XDocument Get();
    void Remove();
}

Document Builder (ISitemapDocumentBuilder)

An implementation of the ISitemapDocumentBuilder provides allows full customisation of the sitemap document itself. The default implementation generates a fully compliant sitemap document based on the official sitemap.xsd.

public interface ISitemapDocumentBuilder
{
    XDocument BuildSitemapXmlDocument(IEnumerable<SitemapUrl> sitemapUrls);
}

Sitemapify.Umbraco Configuration

This version of Sitemapify.Umbraco supports Umbraco 8.1+. For Umbraco v7.* support, please refer to version 0.5.2.

Firstly install the Umbraco extension:

Install-Package Sitemapify.Umbraco

Once you have installed Sitemapify.Umbraco you can create an Component to configure Sitemapify to use the available "Umbraco Content Provider" to generate sitemap url that form the sitemap.xml.

public class SitemapifyComponent : IComponent
{
	public void Initialize()
	{
		Configure.With(config => config.UsingContentProvider(new SitemapifyUmbracoContentProvider()));
	}

	public void Terminate() { }
}

You'll also need to create a UserComposer to register the Component.

public class SitemapifyComposer : IUserComposer
{
	public void Compose(Composition composition)
	{
		composition.Components().Append<SitemapifyComponent>();
	}
}

By default the Umbraco content provider will look for content node properties with specific names to determine whether a particular node should be included in the generated sitemap file, these property names are:

• umbracoNaviHide - True/False to determine whether this node is included (Default: false)
• sitemapifyExcludeChildren - True/False to determine whether to ignore all child nodes below this node (Default: false)

If you want to alter these property aliases you can override them via application settings:

">

<appSettings>
	<add key="Sitemapify.Umbraco:ExcludedFromSitemapPropertyAlias" value="newPropertyAlias" />
	<add key="Sitemapify.Umbraco:ExcludedChildrenFromSitemapPropertyAlias" value="anotherPropertyAlias" />
appSettings>