Anton Kallenberg
Jun 19, 2012
  3949
(0 votes)

Adding a site map index

I have created a add-on that adds a site map index to a EPiServer site based on the page tree structure. I have used the protocol that is described here http://www.sitemaps.org/protocol.html#index

The implementation is based on a http handler that must be registered in web.config,  would be great if the registration could be done through code, maybe in a initialization module, is this possible?

Add a reference to the SiteMapIndex.dll and add following to Web.config ( /configuration/system.webServer/handlers)

   1: <add name="SiteMapIndex" 
   2:            path="sitemap.xml"
   3:            verb="*"
   4:            type="SiteMapIndex.IndexHandler, SiteMapIndex" />
   5:       <add name="SiteMapItem"
   6:            path="sitemapitem.xml"
   7:            verb="*"
   8:            type="SiteMapIndex.IndexHandler, SiteMapIndex" />

Browse to http://yoursite.com/sitemap.xml to view the site map index.

Excluding pages, setting change frequency and priority

It is possible to change the behavior of these things. Implement the interface ISiteMapIndexPageType to your page type builder page type class and implement the properties from the interface.

   1: #region ISiteMapIndexPageType
   2: bool ISiteMapIndexPageType.Skip
   3: {
   4:     get { return false; }
   5: }
   6:  
   7: ChangeFrequency ISiteMapIndexPageType.ChangeFrequency
   8: {
   9:     get { return ChangeFrequency.Weekly; }
  10: }
  11:  
  12: double ISiteMapIndexPageType.Priority
  13: {
  14:     get { return 0.7; }
  15: }
  16: #endregion

Caching

It could be a quite heavy operation to render the site map index for big site. Now only page references are cached in addition to episerver standard caching of page data objects. A cache dependency is added to the global episerver version key. If a page is updated the entire cache (of page references) for the site map index is dropped. Do you think the outputted xml should be cached instead of the page references or maybe something completely different?

Source and downloads are available at github. https://github.com/antonkallenberg/SiteMapIndex

Requires PageTypeBuilder 2.0 and EPiServer 6 R2.

Jun 19, 2012

Comments

Please login to comment.
Latest blogs
Optimizely Commerce vs Composable Commerce: What Should You Do with CMS 13?

As organizations modernize their digital experience platforms, a common architectural question emerges: Should we continue using Optimizely Commerc...

Aniket | Mar 12, 2026

Missing Properties tool for Optimizely CMS

If you have been working with Optimizely CMS for a while you have probably accumulated some technical debt in your property definitions. When you...

Per Nergård (MVP) | Mar 10, 2026

AI Generated Optimizely Developer Newsletter

Updates in the Optimizely ecosystem are everywhere: blog posts, forums, release notes, NuGet packages, and documentation changes. This newsletter...

Allan Thraen | Mar 10, 2026 |

Lessons from Building Production-Ready Opal Tools

AI tools are becoming a normal part of modern digital platforms. With  Optimizely Opal , teams can build tools that automate real tasks across the...

Praful Jangid | Mar 7, 2026