Home Library Learn Downloads Support Community
Sign in | United States - English | |
This topic has not yet been rated - Rate this topic

Module Element (Module)

SharePoint 2010

Published: May 2010

Specifies files with which to provision SharePoint Web sites within an element manifest.

Copy 

<Module
  HyperlinkBaseUrl = string
  IncludeFolders = "Text"
  List = "Integer"
  Name = "Text"
  Path = "Text"
  RootWebOnly = "TRUE" | "FALSE"
  SetupPath = "Text"
  Url = "Text">
</Module>

Attribute

Description

HyperlinkBaseUrl

Optional string. Specifies an absolute URL to use as the base URL for hyperlinks.

IncludeFolders

 Optional Text.

List

Optional Integer. Specifies the type of list, which is defined within Onet.xml.

Name

Required Text. Contains the name of the file set. Can only contain the following characters:

  • alphanumeric

  • hyphen (-)

  • underscore (_)

  • period (.)

  • space ( )

Path

Optional Text. Specifies the physical path to the file set relative to %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\Features\Feature. Can only contain the following characters:

  • alphanumeric

  • hyphen (-)

  • underscore (_)

  • period (.)

  • space ( )

RootWebOnly

Optional Boolean. TRUE if the files specified in the module are installed only in the top-level Web site of the site collection.

SetupPath

Optional Text. Specifies the physical path to a folder in the SharePoint Foundation setup directory %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE) that contains a file to include in the module. Can only contain the following characters:

  • alphanumeric

  • hyphen (-)

  • underscore (_)

  • period (.)

  • space ( )

Url

Optional Text. Specifies the virtual path of the folder in which to place the files when a site is instantiated. If Path is not specified, the value of Url is used for the physical path. Use the Url attribute to provision a folder through the Feature.

The Url attribute cannot contain the following characters:

  • \"

  • #

  • %

  • &

  • *

  • :

  • <

  • >

  • ?

  • \\

  • {

  • }

  • |

  • ~

  • \x7f

Minimum: 0

Maximum: Unbounded

The Module element specifies a file or collection of files and a location where the files are installed during site creation. If the file is a Web Part Page, the module definition can specify which Web Parts should be included on the page.

For an example of how this element is used, see Modules.

Date

Description

Reason

May 2010

Initial publication

Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ
SetupPath can have a "\"
The SetupPath can include a backslash as well ("\") in case you have resources that are in subfolders of the SiteTemplates folder
History
Old path for SharePoint root
If I'm reading correctly that this content is for SharePoint 2010 not 2007 then the paths that refer to the SharePoint root should include \14\ not \12\. For example:
Program Files\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE
History