MvcSiteMapProvider Documentation

Install the version of MvcSiteMapProvider that matches your ASP.NET MVC version using the NuGet Package Manager Console.

Stable Releases:

• For MVC 5: Install-Package MvcSiteMapProvider.MVC5
• For MVC 4: Install-Package MvcSiteMapProvider.MVC4
• For MVC 3: Install-Package MvcSiteMapProvider.MVC3
• For MVC 2: Install-Package MvcSiteMapProvider.MVC2

Continuous Integration (Prerelease) Builds: If you require builds from the MyGet continuous integration feed, use the -IncludePrerelease flag and specify the source:

• For MVC 5: Install-Package MvcSiteMapProvider.MVC5 -IncludePrerelease -Source http://www.myget.org/F/mvcsitemapprovider
• For MVC 4: Install-Package MvcSiteMapProvider.MVC4 -IncludePrerelease -Source http://www.myget.org/F/mvcsitemapprovider
• For MVC 3: Install-Package MvcSiteMapProvider.MVC3 -IncludePrerelease -Source http://www.myget.org/F/mvcsitemapprovider
• For MVC 2: Install-Package MvcSiteMapProvider.MVC2 -IncludePrerelease -Source http://www.myget.org/F/mvcsitemapprovider

Additionally, you can use specific dependency injection packages available on NuGet to integrate with your DI container.

Because MvcSiteMapProvider uses DI to allow extensibility, upgrading the package may introduce new requirements in your DI configuration. Since NuGet cannot automatically merge changes into your custom DI modules, you must manually manage updates.

Upgrade Workflow:

1. When upgrading MvcSiteMapProvider, do not simply overwrite your existing DI configuration.
2. Compare your current DI module/registry against the latest version in the official repository using a diff tool (e.g., Beyond Compare).
3. Identify any new registrations or configuration changes required by the new version.
4. Merge these changes into your configuration without overwriting your existing customizations.
5. Focus on the code relevant to your specific .NET and MVC version (ignore #if preprocessor directive blocks themselves).

The latest StructureMap registry can be found in the repository's master branch under src/MvcSiteMapProvider/CodeAsConfiguration/StructureMap/DI/StructureMap/Registries/MvcSiteMapProviderRegistry.cs.

To integrate MvcSiteMapProvider into your Dependency Injection (DI) setup using StructureMap, you must add the provider's registry to your container and assign the ISiteMapLoader to the global MvcSiteMapProvider.SiteMaps.Loader property.

Follow these steps in your composition root:

1. Register the Provider: Add MvcSiteMapProviderRegistry to your StructureMap configuration.
2. Configure the Loader (Required): Assign the ISiteMapLoader instance from your container to MvcSiteMapProvider.SiteMaps.Loader.
3. Validate XML (Optional): Use ISiteMapXmlValidator to ensure your .sitemap files adhere to the required XSD.
4. Register Routes (Optional): Call XmlSiteMapController.RegisterRoutes to make your sitemaps accessible to search engines.

// Create the DI container (typically part of your DI setup already)
var container = new StructureMapContainer();

// Setup configuration of DI (required)
container.Configure(r => r.AddRegistry<MvcSiteMapProviderRegistry>());

// Setup global sitemap loader (required)
MvcSiteMapProvider.SiteMaps.Loader = container.GetInstance<ISiteMapLoader>();

// Check all configured .sitemap files to ensure they follow the XSD for MvcSiteMapProvider (optional)
var validator = container.GetInstance<ISiteMapXmlValidator>();
validator.ValidateXml(HostingEnvironment.MapPath("~/Mvc.sitemap"));

// Register the Sitemaps routes for search engines (optional)
XmlSiteMapController.RegisterRoutes(RouteTable.Routes);

To integrate MvcSiteMapProvider into your Unity Dependency Injection (DI) configuration, you must add the MvcSiteMapProviderContainerExtension to your container and configure the global sitemap loader.

Follow these steps in your composition root:

1. Add the extension module: Use container.AddNewExtension<MvcSiteMapProviderContainerExtension>(). This is required.
2. Setup the global sitemap loader: Assign MvcSiteMapProvider.SiteMaps.Loader by resolving ISiteMapLoader from your container. This is required.
3. Validate XML (Optional): Resolve ISiteMapXmlValidator and call ValidateXml on your .sitemap file path to ensure it follows the MvcSiteMapProvider XSD.
4. Register routes (Optional): Call XmlSiteMapController.RegisterRoutes(RouteTable.Routes) to expose sitemap routes to search engines.

// Create the container (typically part of your DI setup already)
var container = new UnityContainer();

// Add the extension module (required)
container.AddNewExtension<MvcSiteMapProviderContainerExtension>();

// Setup global sitemap loader (required)
MvcSiteMapProvider.SiteMaps.Loader = container.Resolve<ISiteMapLoader>();

// Check all configured .sitemap files to ensure they follow the XSD for MvcSiteMapProvider (optional)
var validator = container.Resolve<ISiteMapXmlValidator>();
validator.ValidateXml(HostingEnvironment.MapPath("~/Mvc.sitemap"));

// Register the Sitemaps routes for search engines (optional)
XmlSiteMapController.RegisterRoutes(RouteTable.Routes);

To use MvcSiteMapProvider with Autofac, you must register the required modules in your composition root and assign the resolved ISiteMapLoader to the MvcSiteMapProvider.SiteMaps.Loader property.

Integration Steps

1. Register Modules: Add MvcSiteMapProviderModule and MvcModule to your ContainerBuilder.
2. Assign Loader: After building the container, resolve ISiteMapLoader and assign it to MvcSiteMapProvider.SiteMaps.Loader.
3. Optional - Validate XML: Resolve ISiteMapXmlValidator to ensure your .sitemap files adhere to the XSD.
4. Optional - Register Routes: Call XmlSiteMapController.RegisterRoutes(RouteTable.Routes) to expose sitemaps to search engines.

// 1. Register modules
var builder = new ContainerBuilder();
builder.RegisterModule(new MvcSiteMapProviderModule()); // Required
builder.RegisterModule(new MvcModule()); // Required by MVC

// 2. Create the DI container
var container = builder.Build();

// 3. Setup global sitemap loader (required)
MvcSiteMapProvider.SiteMaps.Loader = container.Resolve<ISiteMapLoader>();

// 4. Optional: Validate XML
var validator = container.Resolve<ISiteMapXmlValidator>();
validator.ValidateXml(HostingEnvironment.MapPath("~/Mvc.sitemap"));

// 5. Optional: Register Sitemaps routes
XmlSiteMapController.RegisterRoutes(RouteTable.Routes);