Module element (Site)

Article
06/29/2022

Applies to: SharePoint 2016 | SharePoint Foundation 2013 | SharePoint Online | SharePoint Server 2013

Specifies files and "all user" web parts with which to provision a website.

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

Elements and attributes

The following sections describe attributes, child elements, and parent elements.

Attributes

Attribute	Description
HyperlinkBaseUrl	Optional Text.
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\15\TEMPLATE\SiteTemplates\ _Site_Definition_. 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 website 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\15\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 site definition. The Url attribute cannot contain the following characters: " # % & * : < > ? \ { } \| ~ \x7f

Child elements

File

Parent elements

Modules

Occurrences

Minimum: 0
Maximum: Unbounded

Remarks

A detailed Module element appears in a Modules element directly under the Project element of an Onet.xml file. Each such module is referenced by at least one other Module element that is in a Configuration element of the same file.

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.

Example

The following example from Onet.xml defines the views and files to include within a module.

<Module Name="Default" Url="" Path="">
  <File Url="default.aspx" NavBarHome="True">
    <View List="$Resources:core,lists_Folder;/$Resources:core,announce_Folder;" BaseViewID="0" WebPartZoneID="Left" />
    <View List="$Resources:core,lists_Folder;/$Resources:core,calendar_Folder;" BaseViewID="0" RecurrenceRowset="TRUE" WebPartZoneID="Left" WebPartOrder="2" />
    <AllUsersWebPart WebPartZoneID="Right" WebPartOrder="1"><![CDATA[
      <WebPart xmlns="http://schemas.microsoft.com/WebPart/v2" xmlns:iwp="http://schemas.microsoft.com/WebPart/v2/Image">
        <Assembly>Microsoft.SharePoint, Version=12.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c</Assembly>
        <TypeName>Microsoft.SharePoint.WebPartPages.ImageWebPart
        </TypeName>
        <FrameType>None</FrameType>
        <Title>$Resources:wp_SiteImage;</Title>
                        <iwp:ImageLink>/_layouts/images/homepage.gif</iwp:ImageLink>
      </WebPart>
    ]]></AllUsersWebPart>
    <View List="$Resources:core,lists_Folder;/$Resources:core,links_Folder;" BaseViewID="0" WebPartZoneID="Right" WebPartOrder="2" />
    <NavBarPage Name="$Resources:core,nav_Home;" ID="1002" Position="Start" />
    <NavBarPage Name="$Resources:core,nav_Home;" ID="0" Position="Start" />
  </File>
</Module>

Share via