mvcsitemap Wiki & Documentation Rss Feed

New Comment on "Dynamic sitemaps"

justrhysism — Fri, 27 Jul 2012 02:32:58 GMT

Ie Ming - Did you find a solution? I could really use it!

New Comment on "Exporting the sitemap for search engine indexing"

cardiac7 — Fri, 20 Jul 2012 16:06:07 GMT

Hi Maartenba, thanks for the great provider. I am not able to create a sitemap.xml file either, using option #1. No errors/message are given on compile, any suggestions on where to begin to debug this? Cheers!

New Comment on "Advanced node visibility"

Tweet — Thu, 09 Feb 2012 12:44:31 GMT

jgoemat: I had the same problem. This seems to work (with FilteredSiteMapNodeVisibilityProvider, anyway)... {{ public static MvcHtmlString Menu(this HtmlHelper helper) { var menu = new StringBuilder(); foreach (SiteMapNode node in SiteMap.RootNode.ChildNodes) { if (node.GetType() == typeof(MvcSiteMapNode)) { var mvcnode = (MvcSiteMapNode) node; bool visible = mvcnode.VisibilityProvider.IsVisible(mvcnode, HttpContext.Current, new Dictionary<string, object> { { "HtmlHelper", helper } }); if (visible) { menu.AppendFormat("<a href='{0}'>{1}</a>", node.Url, helper.Encode(node.Title)); } } } return MvcHtmlString.Create(menu.ToString()); } }}

New Comment on "Dynamic sitemaps"

Ridermansb — Mon, 26 Dec 2011 17:14:06 GMT

I'm not able to work with this feature. I need a node inside another .. see the complete question on stackoverflow: http://stackoverflow.com/questions/8624932/working-with-child-nodes-of-dynamicnodeprovider

Updated Wiki: Home

maartenba — Sun, 11 Dec 2011 11:04:29 GMT

We have moved to GitHub

The project will no longer be maintained on CodePlex.

MvcSiteMap Project Description

An ASP.NET MVC SiteMapProvider implementation for the ASP.NET MVC framework.

Updated Wiki: Home

maartenba — Thu, 08 Dec 2011 15:23:23 GMT

We have moved to GitHub

The project will no longer be maintained on CodePlex.

MvcSiteMap Project Description

An ASP.NET MVC SiteMapProvider implementation for the ASP.NET MVC framework.

Introduction

MvcSiteMapProvider is, as the name implies, an ASP.NET MVC SiteMapProvider implementation for the ASP.NET MVC framework. Targeted at ASP.NET MVC 2, it provides sitemap XML functionality and interoperability with the classic ASP.NET sitemap controls, like the SiteMapPath control for rendering breadcrumbs and the Menu control.

Based on areas, controller and action method names rather than hardcoded URL references, sitemap nodes are completely dynamic based on the routing engine used in an application. The dynamic character of ASP.NET MVC is followed in the MvcSiteMapProvider: there are numerous extensibility points that allow you to extend the basic functionality offered.

Example application

The downloads page features an example application. The example code is all based on the excellent ASP.NET MVC Music Store sample application by Jon Galloway.

Updated Wiki: Home

maartenba — Thu, 08 Dec 2011 15:23:06 GMT

We have moved to GitHub! The project will no longer be maintained on CodePlex.

MvcSiteMap Project Description

An ASP.NET MVC SiteMapProvider implementation for the ASP.NET MVC framework.

Introduction

Example application

The downloads page features an example application. The example code is all based on the excellent ASP.NET MVC Music Store sample application by Jon Galloway.

New Comment on "Creating a first sitemap"

TonyWallAtos — Thu, 01 Dec 2011 16:54:23 GMT

Could you publish the schema file "http://mvcsitemap.codeplex.com/schemas/MvcSiteMap-File-3.0"? It doesn't exist at the moment. Then perhaps Visual Studio would auto-complete.

New Comment on "HtmlHelper functions"

Islam_Ibrahim — Sat, 29 Oct 2011 08:25:04 GMT

Is there such a way to create a Menu hierarchy of a specific area, like Html.MvcSiteMap().Menu(area: "Admin")?

New Comment on "Dynamic sitemaps"

ronnieoverby — Sat, 08 Oct 2011 22:46:12 GMT

Make sure to return nodes in order from top level to bottom level. Otherwise nodes won't correctly have children.

New Comment on "Dynamic sitemaps"

ronnieoverby — Sat, 08 Oct 2011 22:45:55 GMT

Make sure nodes in order from top level to bottom level. Otherwise nodes won't correctly have children.

New Comment on "Documentation"

superted187 — Mon, 26 Sep 2011 10:26:37 GMT

Here's a tutorial / Getting started I've written, covers most things that you would typically want to do with the sitemap provider (print a sitemap, use breadcrumbs, have dynamic nodes, etc) http://edspencer.me.uk/2011/09/20/mvc-sitemap-provider-tutorial-2-breadcrumbs/

New Comment on "Dynamic sitemaps"

daveb84 — Fri, 16 Sep 2011 11:59:00 GMT

I've just reached the end of a world of pain with this provider. I was experiencing the "No parameterless constructor defined for this object." error. This was because I had my own custom AuthorizeAttribute that did not have a default constructor. Looking through the code in reflector it seems that AuthorizeAttributes are read and created using reflection, but ignore the constructor parameters. The result was this exception, and the menu item did not appear. I solved the problem by adding a parameterless constructor to be AuthorizeAttribute.

New Comment on "Advanced node visibility"

neha16jain — Wed, 14 Sep 2011 07:33:12 GMT

what is SiteMapPathHelper? is it equivalent to controller name?

New Comment on "Creating a first sitemap"

erickwidya — Wed, 20 Jul 2011 09:16:53 GMT

hm..does the format for the sitemap needs using mvcSiteMap and mvcSiteMapNode keyword? thx, erick

Updated Wiki: Creating a first sitemap

maartenba — Wed, 06 Jul 2011 11:16:32 GMT

Creating a first sitemap

The following is a simple sitemap XML file that can be used with the MvcSiteMapProvider:

<?xml version="1.0" encoding="utf-8" ?> 
<mvcSiteMap xmlns="http://mvcsitemap.codeplex.com/schemas/MvcSiteMap-File-3.0" enableLocalization="true"> 
  <mvcSiteMapNode title="Home" controller="Home" action="Index" changeFrequency="Always" updatePriority="Normal"> 
    <mvcSiteMapNode title="Browse Store" controller="Store" action="Index" /> 
    <mvcSiteMapNode title="Checkout" controller="Checkout" /> 
  </mvcSiteMapNode> 
</mvcSiteMap>

The following attributes can be given on an XML node element:

Attribute	Required?	Default	Description
title	Yes	(empty)	The title of the node.
description	No	(empty)	Description of the node.
area	No	(empty)	The MVC area for the sitemap node. If not specified, it will be inherited from a node higher in the hierarchy.
controller	Yes	(empty)	The MVC controller for the sitemap node. If not specified, it will be inherited from a node higher in the hierarchy.
action	Yes	(empty)	The MVC action method for the sitemap node. If not specified, it will be inherited from a node higher in the hierarchy.
key	No	(autogenerated)	The unique identifier for the node.
url	No	(autogenerated based on routes)	The URL represented by the node.
roles	No	(empty)	Comma-separated list of roles allowed to access the node and its child nodes.
resourceKey	No	(empty)	Optional resource key.
clickable	No	True	Is the node clickable or just a grouping node?
targetFrame	No	(empty)	Optional target frame for the node link.
imageUrl	No	(empty)	Optional image to be shown by supported HtmlHelpers.
lastModifiedDate	No	(empty)	Last modified date for the node.
changeFrequency	No	Undefined	Change frequency for the node.
updatePriority	No	Undefined	Update priority for the node.
dynamicNodeProvider	No	(empty)	A class name implementing MvcSiteMapProvider.Extensibility.IDynamicNodeProvider and providing dynamic nodes for the site map.
urlResolver	No	Sitemap provider's ISiteMapNodeUrlResolver instance	Class that will be used to generate URLs for sitemap nodes.
visibilityProvider	No	Sitemap provider's ISiteMapNodeVisibilityProvider instance	Class that will be used to determine visibility for a sitemap node.
preservedRouteParameters	No	(empty)	Optional preserved route parameter names (= values that will be used from the current request route).
inheritedRouteParameters	No	(empty)	Optional. Route values that should be inherited from the parent sitemap node. This is not a replacement for the SiteMapPreserveRouteDataAttribute.

Updated Wiki: Creating a first sitemap

maartenba — Wed, 06 Jul 2011 11:16:15 GMT

Creating a first sitemap

The following is a simple sitemap XML file that can be used with the MvcSiteMapProvider:

<?xml version="1.0" encoding="utf-8" ?> 
<mvcSiteMap xmlns="http://mvcsitemap.codeplex.com/schemas/MvcSiteMap-File-3.0" enableLocalization="true"> 
  <mvcSiteMapNode title="Home" controller="Home" action="Index" changeFrequency="Always" updatePriority="Normal"> 
    <mvcSiteMapNode title="Browse Store" controller="Store" action="Index" /> 
    <mvcSiteMapNode title="Checkout" controller="Checkout" /> 
  </mvcSiteMapNode> 
</mvcSiteMap>

The following attributes can be given on an XML node element:

Attribute	Required?	Default	Description
title	Yes	(empty)	The title of the node.
description	No	(empty)	Description of the node.
area	No	(empty)	The MVC area for the sitemap node. If not specified, it will be inherited from a node higher in the hierarchy.
controller	Yes	(empty)	The MVC controller for the sitemap node. If not specified, it will be inherited from a node higher in the hierarchy.
action	Yes	(empty)	The MVC action method for the sitemap node. If not specified, it will be inherited from a node higher in the hierarchy.
key	No	(autogenerated)	The unique identifier for the node.
url	No	(autogenerated based on routes)	The URL represented by the node.
roles	No	(empty)	Comma-separated list of roles allowed to access the node and its child nodes.
resourceKey	No	(empty)	Optional resource key.
clickable	No	True	Is the node clickable or just a grouping node?
targetFrame	No	(empty)	Optional target frame for the node link.
imageUrl	No	(empty)	Optional image to be shown by supported HtmlHelpers.
lastModifiedDate	No	(empty)	Last modified date for the node.
changeFrequency	No	Undefined	Change frequency for the node.
updatePriority	No	Undefined	Update priority for the node.
dynamicNodeProvider	No	(empty)	A class name implementing MvcSiteMapProvider.Extensibility.IDynamicNodeProvider and providing dynamic nodes for the site map.
urlResolver	No	Sitemap provider's ISiteMapNodeUrlResolver instance	Class that will be used to generate URLs for sitemap nodes.
visibilityProvider	No	Sitemap provider's ISiteMapNodeVisibilityProvider instance	Class that will be used to determine visibility for a sitemap node.
preservedRouteParameters	(empty)	No	Optional preserved route parameter names (= values that will be used from the current request route).
inheritedRouteParameters	(empty)	No	Optional. Route values that should be inherited from the parent sitemap node. This is not a replacement for the SiteMapPreserveRouteDataAttribute.

Updated Wiki: Creating a first sitemap

maartenba — Wed, 06 Jul 2011 11:15:54 GMT

Creating a first sitemap

The following is a simple sitemap XML file that can be used with the MvcSiteMapProvider:

<?xml version="1.0" encoding="utf-8" ?> 
<mvcSiteMap xmlns="http://mvcsitemap.codeplex.com/schemas/MvcSiteMap-File-3.0" enableLocalization="true"> 
  <mvcSiteMapNode title="Home" controller="Home" action="Index" changeFrequency="Always" updatePriority="Normal"> 
    <mvcSiteMapNode title="Browse Store" controller="Store" action="Index" /> 
    <mvcSiteMapNode title="Checkout" controller="Checkout" /> 
  </mvcSiteMapNode> 
</mvcSiteMap>

The following attributes can be given on an XML node element:

Attribute	Required?	Default	Description
title	Yes	(empty)	The title of the node.
description	No	(empty)	Description of the node.
area	No	(empty)	The MVC area for the sitemap node. If not specified, it will be inherited from a node higher in the hierarchy.
controller	Yes	(empty)	The MVC controller for the sitemap node. If not specified, it will be inherited from a node higher in the hierarchy.
action	Yes	(empty)	The MVC action method for the sitemap node. If not specified, it will be inherited from a node higher in the hierarchy.
key	No	(autogenerated)	The unique identifier for the node.
url	No	(autogenerated based on routes)	The URL represented by the node.
roles	No	(empty)	Comma-separated list of roles allowed to access the node and its child nodes.
resourceKey	No	(empty)	Optional resource key.
clickable	No	True	Is the node clickable or just a grouping node?
targetFrame	No	(empty)	Optional target frame for the node link.
imageUrl	No	(empty)	Optional image to be shown by supported HtmlHelpers.
lastModifiedDate	No	(empty)	Last modified date for the node.
changeFrequency	No	Undefined	Change frequency for the node.
updatePriority	No	Undefined	Update priority for the node.
dynamicNodeProvider	No	(empty)	A class name implementing MvcSiteMapProvider.Extensibility.IDynamicNodeProvider and providing dynamic nodes for the site map.
urlResolver	No	Sitemap provider's ISiteMapNodeUrlResolver instance	Class that will be used to generate URLs for sitemap nodes.
visibilityProvider	No	Sitemap provider's ISiteMapNodeVisibilityProvider instance	Class that will be used to determine visibility for a sitemap node.
preservedRouteParameters	No	Optional preserved route parameter names (= values that will be used from the current request route).
inheritedRouteParameters	No	Optional. Route values that should be inherited from the parent sitemap node. This is not a replacement for the SiteMapPreserveRouteDataAttribute.

New Comment on "HtmlHelper functions"

jao28 — Sun, 01 May 2011 23:39:11 GMT

For those of you who might be having trouble in modifying the templates as defined in the "Customizing rendered output" section above and getting them to work, I have found that you should actually locate the templates under Views/Shared/DisplayTemplates instead of Views/DisplayTemplates as is mentioned above. Hope this helps someone.

Updated Wiki: Creating a first sitemap

maartenba — Wed, 20 Apr 2011 14:27:42 GMT

Creating a first sitemap

The following is a simple sitemap XML file that can be used with the MvcSiteMapProvider:

<?xml version="1.0" encoding="utf-8" ?> 
<mvcSiteMap xmlns="http://mvcsitemap.codeplex.com/schemas/MvcSiteMap-File-3.0" enableLocalization="true"> 
  <mvcSiteMapNode title="Home" controller="Home" action="Index" changeFrequency="Always" updatePriority="Normal"> 
    <mvcSiteMapNode title="Browse Store" controller="Store" action="Index" /> 
    <mvcSiteMapNode title="Checkout" controller="Checkout" /> 
  </mvcSiteMapNode> 
</mvcSiteMap>

The following attributes can be given on an XML node element:

Attribute	Required?	Default	Description
title	Yes	(empty)	The title of the node.
description	No	(empty)	Description of the node.
area	No	(empty)	The MVC area for the sitemap node. If not specified, it will be inherited from a node higher in the hierarchy.
controller	Yes	(empty)	The MVC controller for the sitemap node. If not specified, it will be inherited from a node higher in the hierarchy.
action	Yes	(empty)	The MVC action method for the sitemap node. If not specified, it will be inherited from a node higher in the hierarchy.
key	No	(autogenerated)	The unique identifier for the node.
url	No	(autogenerated based on routes)	The URL represented by the node.
roles	No	(empty)	Comma-separated list of roles allowed to access the node and its child nodes.
resourceKey	No	(empty)	Optional resource key.
clickable	No	True	Is the node clickable or just a grouping node?
targetFrame	No	(empty)	Optional target frame for the node link.
imageUrl	No	(empty)	Optional image to be shown by supported HtmlHelpers.
lastModifiedDate	No	(empty)	Last modified date for the node.
changeFrequency	No	Undefined	Change frequency for the node.
updatePriority	No	Undefined	Update priority for the node.
dynamicNodeProvider	No	(empty)	A class name implementing MvcSiteMapProvider.Extensibility.IDynamicNodeProvider and providing dynamic nodes for the site map.
urlResolver	No	Sitemap provider's ISiteMapNodeUrlResolver instance	Class that will be used to generate URLs for sitemap nodes.
visibilityProvider	No	Sitemap provider's ISiteMapNodeVisibilityProvider instance	Class that will be used to determine visibility for a sitemap node.
preservedRouteParameters	No	Optional preserved route parameter names (= values that will be used from the current request route).