Black Blade Associates Blog

Links

Black Blade Home
SharePoint Zip
docBlock Virtual Documents

Convert a site template manifest.xml file to onet.xml site definition file

Tags:

I was doing some work for a client and was thinking…. Site definitions are great.
They are extremely flexible. But, they can also be very time consuming to create.
Site templates are a little less desirable because they un-ghost pages. But, they
are so easy and quick to create. It would sure be nice if I could simply take a
site template and convert it to a site definition. Well, it turns out that it’s
not all that hard. There are quite a few steps to follow, but it’s a lot easier
than creating a site definition from scratch.

First, let's get some prep-work done.

Open the ONET.XML file in the site definition from which the template
manifest.xml file was created and copy it to a
destination directory

Important: Never modify the default ONET.XML
files distributed with SharePoint.

Now that our source and target files are setup, we can begin migrating our list
definitions.

For each /Project/ListTemplates/ListTemplate
element already present in the file,
make sure to set the
/Project/ListTemplates/ListTemplate[Path]
attribute to the folder under the Lists directory where the original site definition
resides. For example, if referencing lists from the default Team Web Site site definition,
set the
/Project/ListTemplates/ListTemplate[Path]
attribute to
"STS".

For each /Web/UserLists/List elements in the manifest.xml
file, add a
/Project/ListTemplates/ListTemplate
element to the destination ONET.XML
file

Note: The next few steps describe the formatting
for each
/Project/ListTemplates/ListTemplate
element. Each new ListTemplate element will take this form:

<ListTemplate Name="Cache" DisplayName="Cache" Type="10000" BaseType="0" Unique="TRUE"
Hidden="TRUE" DontSaveInTemplate="TRUE" SecurityBits="11" Description="List of meetings
attached to the workspace." Image="/_layouts/images/itgen.gif"></ListTemplate>

I will refer to attributes from the
/Web/UserLists/List element we are converting through
the List[@source_attribute] notation and to attributes of the
/Project/ListTemplates/ListTemplate
we are generating through
the ListTemplate[@target_attribute] notation.

Note: We are adding additional
/Project/ListTemplates/ListTemplate
elements to the new
ONET.XML file. We are not removing the default
/Project/ListTemplates/ListTemplate
elements already present
in the file.

Note: We are creating list definition headers
in the ONET.XML file, but we have not yet created the list schemas behind the new
list definitions. For detailed steps on converting the list definition from the
site template manifest.xml to a site definition schema.xml file, take a look at
my previous blog entry.

Set the ListTemplate[Name] to List[Title].
Make sure to remove any non-alpha characters from when converting the title to the
list name. For example, if the Title is "My Mom's List",
set the name to something like "MyMomsList".

Set ListTemplate[Name] to List[DisplayName].

Set ListTemplate[Type] to a
unique numeric value. I, and others, recommend starting at 10000.

Note: Although the
Type attribute is optional in the
ONET.XML file, you will not be able to automatically
provision the list using Configuration
elements upon site creation unless you specify the Type
attribute.

Set ListTemplate[Description] to List[Description].

Set ListTemplate[BaseType] to List[BaseType].

Leave the /Project/DocumentTemplates and /Project/BaseTypes
elements as is.

With the list definitions migrated, we need to set up a site configuration to provision
our lists and a couple of modules to define the files and web parts our site will
use.

Remove the default /Project/Configurations/Configuration elements from the new
ONET.XML file. We will be creating a new one
based on the configuring of the site from the site template.

Create a new /Project/Configurations/Configuration element in the new
ONET.XML file.

Set the /Project/Configurations/Configuration[ID] to "0"
.

Set the /Project/Configurations/Configuration[Name] to "Default".

Create a new /Project/Configurations/Configuration/Lists element.

For each custom /Project/ListTemplates/ListTemplate
created in step 3, create a
/Project/Configurations/Configuration/Lists/List element. You will now need to use
the optional Type attribute specified in step 3c.

The newly created elements will take the following forms:

<List Title="Cache" Type="10000" ></List>

Note: The next steps should be performed
for each newly created
/Project/Configurations/Configuration/Lists/List element.

Set the /Project/Configurations/Configuration/Lists/List[Title] attribute to the /Project/ListTemplates/ListTemplate[DisplayName].

Set the /Project/Configurations/Configuration/Lists/List[Type] attribute to /Project/ListTemplates/ListTemplate[Type].

Add the following elements to the
/Project/Configurations/Configuration/Lists
element:

Clear out the old /Project/Configurations/Configuration/Modules
element.

Create a /Project/Modules element in the new ONET.XML file.

Create a /Project/Configurations/Configuration/Modules/Module element

Set the /Project/Configurations/Configuration/Modules/Module[Name] to "DefaultHome".

Set the /Project/Configurations/Configuration/Modules/Module[Name] to "WebPartPopulation".

Clear out the old /Project/Modules element

Create a /Project/Modules element in the new ONET.XML
file.

Add the following element to the
/Project/Modules element:

</File>

</Module>

Add the following element to the
/Project/Modules
element:

</Module>

Leave the /Project/Components as is.

At this point we have transferred all of the list definitions from our site template
to our site definition and created the list schema.xml files to store the schemas
for our custom lists. However, we have not added the web pats to our default.aspx
page. Unfortunately, I have run out of time on this post so I will have to leave
that for another day. In the mean time, I hope this post helps anyone looking for
a "quick-start" way to create site definitions from existing SharePoint sites.

Posted by Eugene Rosenfeld on 17-Nov-06
0 Comments | Trackback Url | Link to this post | Bookmark this post with:

Links to this post

Comments

Name:

URL:

Email:

Comments:

Links

Archives

Tag Cloud

Convert a site template manifest.xml file to onet.xml site definition file

Links to this post

Comments