Module Element (Module)

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

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

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 \\Program Files\Common Files\Microsoft Shared\web server extensions\12\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 Windows SharePoint Services setup directory (\\Program Files\Common Files\Microsoft Shared\web server extensions\12\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
Child Elements

File

Parent Elements

Elements

Occurrences

Minimum: 0

Maximum: Unbounded
Remarks

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

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

Other Resources

Module
Modules
How to: Provision a File

Tags :


Community Content

austegard
'Path' = Single Subfolder
While the word 'Path' normally conjures up something like some\directory\structure, given the limitations specifed above, Path can in fact only denote a single Folder.
I.e. you can place a file in the root of your feature folder, or in a subfolder, but not in a subfolder's subfolder (or beyond). If you place your file too deep in the folder hierarchy it will not be found when the feature is activated.
Tags :

Wei Ming
Path
Noticed Child element "File" also has 'Path' property, which can specify subfolder'ssubfolder....
Tags :

durayakar2
Name attribute is not required
It is optional.
Tags :

Page view tracker