Descripción de los archivos Onet.xml
Última modificación: miércoles, 02 de febrero de 2011
Hace referencia a: SharePoint Foundation 2010
En este artículo
Las funciones de Onet.xml
Tareas de definición de sitios web con un archivo Onet.xml personalizado
Formato de archivo
Al instalar Microsoft SharePoint Foundation, también se instalan varios archivos Onet.xml. Uno de ellos se instala en %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\GLOBAL\XML, el cual se aplica de forma global a la implementación, y varios se instalan en diferentes carpetas de %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\SiteTemplates, cada uno de los cuales se aplica a una definición de sitio que se suministra con SharePoint Foundation. Se incluyen, por ejemplo, sitios de blogs, el sitio de Administración central, sitios de área de reuniones y sitios de SharePoint Team. Solo las dos últimas de estas familias contienen más de una configuración de definición del sitio.
El archivo Onet.xml global define plantillas de lista para listas ocultas, tipos de base de lista, una configuración de definición predeterminada y módulos que se aplican globalmente a la implementación. Cada archivo Onet.xml en un subdirectorio del directorio %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\SiteTemplates define áreas de navegación, plantillas de listas, plantillas de documentos, configuraciones, módulos, componentes y secciones de pie de página del servidor de correo electrónico que se usan en la definición de sitio que le corresponda.
Nota
Un Onet.xml también forma parte de una plantilla web. Algunos elementos Lenguaje de marcado de la aplicación de colaboración (CAML) que se pueden incluir en los archivos Onet.xml de las definiciones de sitios, no se pueden incluir en los archivos Onet.xml que forman parte de las plantillas web, por ejemplo, el elemento DocumentTemplates.
Las funciones de Onet.xml
Dependiendo de dónde se encuentre un archivo Onet.xml y de si es parte de una definición de sitio o una plantilla web, el marcado del archivo realiza algunas de las siguientes acciones o todas ellas:
Especifica el ámbito web y las características de ámbito de colección de sitios que están integradas a los sitios web creados a partir de la definición de sitio o plantilla web.
Especifica los tipos de listas, páginas, archivos y elementos web integrados a los sitios web que se crean a partir de la definición de sitio o plantilla web.
Define las áreas de navegación superior y lateral que aparecen en la página principal y en las vistas de lista para una definición de sitio.
Especifica las definiciones de lista que usa cada definición de sitio y determinar su disponibilidad para crear listas en la interfaz de usuario (UI).
Especifica las plantillas de documento que están disponibles en la definición de sitio para crear listas de bibliotecas de documentos en la interfaz de usuario y especifica los archivos que se usan en las plantillas de documento.
Define los tipos base de lista de los que derivan las listas predeterminadas de SharePoint Foundation. (Solo el archivo Onet.xml global desempeña esta función. No se pueden definir tipos base de lista nuevos).
Especifica los componentes de SharePoint Foundation.
Define la sección de pie de página usada en el correo electrónico de servidor.
Tareas de definición de sitios web con un archivo Onet.xml personalizado
Se pueden realizar los siguientes tipos de tareas en un archivo Onet.xml personalizado que se usa para una definición de sitio personalizada o una plantilla web personalizada:
Especificar un archivo de hoja de estilos en cascada (CSS), un archivo JavaScript o un archivo aspx alternativos para una definición de sitio.
Modificar las áreas de navegación para la página principal y las páginas de lista.
Agregar una definición de lista como una opción a la interfaz de usuario.
Definir una configuración para la definición de sitio o plantilla web, especificando las listas, los módulos, los archivos y los elementos web que se incluirán cuando se crea una instancia de la configuración.
Especificar las características que se incluirán automáticamente con los sitios web que se crean desde la definición de sitio o plantilla web.
Pueden realizarse los siguientes tipos de tareas en un archivo Onet.xml personalizado que se usa para una definición de sitio personalizada, pero no en uno que se usa para una plantilla web personalizada:
Agregar una plantilla de documento para crear bibliotecas de documentos.
Definir una o varias configuraciones para una definición de sitio, especificando las listas, los módulos, los archivos y los elementos web que se incluyen cuando se crean instancias de la configuración.
Definir un pie de página personalizado para los mensajes de correo electrónico que se envían desde los sitios web basados en la definición de sitio.
Definir los componentes personalizados, como un post processor de cuadro de diálogo de archivo, de sitios web basados en la definición de sitio.
.gif "Nota de precaución") Precaución |
|---|
No puede crear nuevos tipos base de lista en una definición de sitio, ni en una plantilla web. Los tipos base que se definen en el archivo Onet.xml global son los únicos que se admiten. |
| Precaución |
|---|
No se admite la realización de cambios en un archivo Onet.xml instalado originalmente. Si cambia el archivo, se podrían dividir los sitios existentes. Además, cuando instala actualizaciones o Service Pack para SharePoint Foundation, o cuando actualiza una instalación a la siguiente versión del producto, es posible que haya una versión nueva del archivo suministrado por Microsoft, por lo que la instalación no podrá combinar sus cambios con la nueva versión. Si desea un tipo de sitio que sea similar a un tipo de sitio integrado, y no puede usar una plantilla web, cree una nueva definición de sitio con su propio archivo Onet.xml; no modifique el archivo original. Para obtener más información, vea Procedimiento para crear una definición y una configuración personalizadas de un sitio. Para obtener más información sobre las situaciones en las que no puede usar una plantilla web, vea Decidir entre plantillas web personalizadas y definiciones de sitio personalizadas. |
Formato de archivo
En las secciones siguientes se definen los distintos elementos del archivo Onet.xml.
Elemento Project
El elemento Project de nivel superior especifica un nombre predeterminado para los sitios que se crean mediante cualquiera de las configuraciones de sitios en la definición de sitio. Además, especifica el directorio que contiene las subcarpetas en las que residen los archivos para cada definición de lista.
Nota
A menos que se indique lo contrario, los extractos usados en los ejemplos siguientes se toman del archivo Onet.xml para la definición del sitio STS.
<Project
Title="$Resources:core,onet_TeamWebSite;"
Revision="2"
ListDir="$Resources:core,lists_Folder;"
xmlns:ows="Microsoft SharePoint"
UIVersion="4">
Nota
En todos los ejemplos de este tema, las cadenas que empiezan por "$Resources" son constantes que se definen en un archivo .resx. Por ejemplo, "$Resources:onet_TeamWebSite" se define como "Sitio de grupo" en el archivo core.resx. Cuando se crea un archivo Onet.xml personalizado, se pueden usar cadenas literales.
Este elemento también puede tener varios otros atributos. Para obtener más información, vea Elemento Project (Site).
El elemento Project no contiene ningún atributo que identifique la definición de sitio que define. Cada archivo Onet.xml está asociado a una definición de sitio en virtud de la ruta de acceso al directorio donde se encuentra, que (excepto para el Onet.xml global) es %ProgramFiles%\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\SiteTemplates\tipo_sitio\XML\, donde tipo_sitio es el nombre de la definición de sitio, como STS o MPS. El archivo Onet.xml de una plantilla web está asociado a la plantilla por estar en el paquete wsp de la plantilla web.
Elemento NavBars
El elemento NavBars contiene las definiciones para el área de navegación superior que se muestra en la página principal o en las vistas de lista, y las definiciones para el área de navegación lateral que se muestra en la página principal.
Nota
Un NavBar no es necesariamente una barra de herramientas. Por ejemplo, puede ser un árbol de vínculos.
<NavBars>
<NavBar
Name="$Resources:core,category_Top;"
Separator="&nbsp;&nbsp;&nbsp;"
Body="<a ID='onettopnavbar#LABEL_ID#' href='#URL#' accesskey='J'>#LABEL#</a>"
ID="1002" />
<NavBar
Name="$Resources:core,category_Documents;"
Prefix="<table border='0' cellpadding='4' cellspacing='0'>"
Body="<tr><td><table border='0' cellpadding='0' cellspacing='0'><tr><td><img src='/_layouts/images/blank.gif' id='100' alt='' border='0'>&nbsp;</td><td valign='top'><a id='onetleftnavbar#LABEL_ID#' href='#URL#'>#LABEL#</td></tr></table></td></tr>"
Suffix="</table>"
ID="1004" />
...
</NavBars>
Un elemento NavBarLink define vínculos para el área de navegación superior o lateral, y una sección completa de NavBar agrupa los vínculos nuevos en el área lateral. Cada elemento NavBar especifica un nombre para mostrar y un identificador único para la barra de navegación y define cómo mostrar la barra de navegación.
Para obtener información acerca de cómo personalizar las áreas de navegación en las páginas de SharePoint Foundation, consulte Navegación del sitio web.
Elemento ListTemplates
La sección ListTemplates especifica las definiciones de lista que forman parte de una definición de sitio. Este marcado todavía se admite pero solo por compatibilidad con versiones anteriores. Los nuevos tipos de lista personalizados se deben definir como funciones. El siguiente ejemplo se toma del archivo Onet.xml para la definición de sitio de área de reuniones.
<ListTemplates>
<ListTemplate
Name="meetings"
DisplayName="$Resources:xml_onet_mwsidmeetingDisp;"
Type="200"
BaseType="0"
Unique="TRUE"
Hidden="TRUE"
HiddenList="TRUE"
DontSaveInTemplate="TRUE"
SecurityBits="11"
Description="$Resources:xml_onet_mwsidmeetingDesc;"
Image="/_layouts/images/itevent.gif">
</ListTemplate>
<ListTemplate
Name="agenda"
DisplayName="$Resources:xml_onet_mwsidagendaDisp;"
Type="201"
BaseType="0"
FolderCreation="FALSE"
DisallowContentTypes="TRUE"
SecurityBits="11"
Description="$Resources:xml_onet_mwsidagendaDesc"
Image="/_layouts/images/itagnda.gif">
</ListTemplate>
...
</ListTemplates>
Cada elemento ListTemplate especifica un nombre interno que identifica la definición de lista. El elemento ListTemplate también especifica un nombre para mostrar para la definición de lista y si la opción para agregar un vínculo en la barra Inicio rápido aparece seleccionada de forma predeterminada en la interfaz de usuario de creación de listas. Además, este elemento especifica la descripción de la definición de lista y la ruta de acceso a la imagen que la representa, las cuales se muestran en la interfaz de usuario de creación de listas. Si se especifica Hidden="TRUE", la definición de lista no aparece como una opción en la interfaz de usuario de creación de listas.
El elemento ListTemplate tiene dos atributos para el tipo, Type y BaseType. El atributo Type especifica un identificador único para la definición de lista y el atributo BaseType identifica el tipo de lista base para la definición de lista y corresponde al valor Type especificado para uno de los tipos base de lista que se definen en el archivo Onet.xml.
Para obtener más información acerca de cómo crear nuevos tipos de lista, vea Procedimiento para crear una definición de lista personalizada.
Elemento DocumentTemplates
La sección DocumentTemplates define las plantillas de documentos que se enumeran en la interfaz de usuario para la creación de una biblioteca de documentos. Este marcado todavía se admite pero solo por compatibilidad con versiones anteriores. Se deben definir los nuevos tipos de documento como tipos de contenido. Para obtener más información, vea el nodo Tipos de contenido de este SDK.
<DocumentTemplates>
...
<DocumentTemplate
Path="STS"
DisplayName="$Resources:core,doctemp_Word;"
Type="121"
Default="TRUE"
Description="$Resources:core,doctemp_Word_Desc;">
<DocumentTemplateFiles>
<DocumentTemplateFile
Name="doctemp\word\wdtmpl.dotx"
TargetName="Forms/template.dotx"
Default="TRUE" />
</DocumentTemplateFiles>
</DocumentTemplate>
...
</DocumentTemplates>
Cada elemento DocumentTemplate especifica un nombre para mostrar, un identificador único y una descripción para la plantilla de documento. Si Default se establece en TRUE, la plantilla es la plantilla predeterminada seleccionada para las bibliotecas de documentos que se crean en los sitios basados en una de las configuraciones de la definición de sitio. A pesar de su nombre en singular, un elemento DocumentTemplate realmente puede contener una colección de elementos DocumentTemplateFile. El atributo Name de cada elemento DocumentTemplateFile especifica la ruta de acceso relativa a un archivo local que se desempeña como la plantilla. El atributo TargetName especifica la dirección URL de destino del archivo de plantilla cuando se crea una biblioteca de documentos. El atributo Default especifica si el archivo es el archivo de plantilla predeterminado.
Nota
Un archivo Onet.xml en una plantilla web no puede tener un elemento DocumentTemplate.
Para consultar una tarea de programación con plantillas de documento, vea Procedimiento para agregar plantillas de documento, tipo de archivo y edición de una aplicación en una definición de sitio.
Elemento BaseTypes
El elemento BaseTypes del archivo Onet.xml global se usa durante la creación del sitio o lista para definir los tipos base de lista en los que se basan todas las definiciones de lista en SharePoint Foundation. Cada plantilla de lista que está especificada en la sección de plantillas de lista se identifica con uno de los tipos base: Generic List, Document Library, Discussion Forum, Vote or Survey o Issues List.
Nota
En SharePoint Foundation, la sección BaseTypes se implementa solo en el archivo Onet.xml global, del que se toma el siguiente ejemplo.
<BaseTypes>
<BaseType
Title="Generic List"
Image="/_layouts/images/itgen.gif"
Type="0">
<MetaData>
<Fields>
<Field
ID="{1d22ea11-1e32-424e-89ab-9fedbadb6ce1}"
ColName="tp_ID"
RowOrdinal="0"
ReadOnly="TRUE"
Type="Counter"
Name="ID"
PrimaryKey="TRUE"
DisplayName="$Resources:core,ID"
SourceID="https://schemas.microsoft.com/sharepoint/v3"
StaticName="ID">
</Field>
<Field
ID="{03e45e84-1992-4d42-9116-26f756012634}"
RowOrdinal="0"
Type="ContentTypeId"
Sealed="TRUE"
ReadOnly="TRUE"
Hidden="TRUE"
DisplayName="$Resources:core,Content_Type_ID;"
Name="ContentTypeId"
DisplaceOnUpgrade="TRUE"
SourceID="https://schemas.microsoft.com/sharepoint/v3"
StaticName="ContentTypeId"
ColName="tp_ContentTypeId">
</Field>
...
</Fields>
</MetaData>
</BaseType>
...
</BaseTypes>
Cada elemento BaseType especifica los campos usados en las listas que derivan del tipo base. El atributo Type de cada elemento Field identifica el campo con un tipo de campo definido en FldTypes.xml.
| Precaución |
|---|
No se debe modificar el contenido del archivo Onet.xml global, porque al hacerlo se puede interrumpir la instalación. No se pueden agregar tipos de lista base. Para obtener información acerca de cómo agregar una definición de lista, vea Procedimiento para crear una definición de lista personalizada. |
Elemento Configurations
Cada elemento Configuration en la sección Configurations especifica las listas, los módulos y las características que se crean de forma predeterminada cuando se crean instancias de la configuración de definición del sitio o de la plantilla web.
<Configurations>
...
<Configuration
ID="0"
Name="Default">
<Lists>
<List
FeatureId="00BFEA71-E717-4E80-AA17-D0C71B360101"
Type="101"
Title="$Resources:core,shareddocuments_Title;"
Url="$Resources:core,shareddocuments_Folder;"
QuickLaunchUrl="$Resources:core,shareddocuments_Folder;/Forms/AllItems.aspx" />
...
</Lists>
<Modules>
<Module
Name="Default" />
</Modules>
<SiteFeatures>
<Feature
ID="00BFEA71-1C5E-4A24-B310-BA51C3EB7A57" />
<Feature
ID="FDE5D850-671E-4143-950A-87B473922DC7" />
</SiteFeatures>
<WebFeatures>
<Feature
ID="00BFEA71-4EA5-48D4-A4AD-7EA5C011ABE5" />
<Feature
ID="F41CC668-37E5-4743-B4A8-74D1DB3FD8A4" />
</WebFeatures>
</Configuration>
...
</Configurations>
El atributo ID identifica la configuración (de forma exclusiva, en relación con las demás configuraciones, si hay alguna, en el elemento Configurations). Si el archivo Onet.xml es parte de una definición de sitio, el valor ID corresponde al atributo ID de un elemento Configuration en un archivo WebTemp*.xml. (Las plantillas web no tienen archivos WebTemp*.xml.)
Cada elemento List especifica el título de la definición de lista y la dirección URL donde se va a crear la lista. El atributo QuickLaunchUrl se puede usar para establecer la dirección URL de la página de vista que se va a usar al agregar un vínculo en Inicio rápido a una lista que se crea a partir de la definición de lista. El valor del atributo Type corresponde con el atributo Type de una plantilla en la sección plantillas de lista. Cada elemento Module especifica el nombre de un módulo definido en la sección de módulos.
Los elementos SiteFeatures y WebFeatures contienen las referencias a colección de sitios y características del ámbito del sitio para incluir en la definición del sitio.
Para las capacidades de procesamiento posterior, use un elemento ExecuteUrl dentro de un elemento Configuration para especificar la dirección URL que se llama tras la creación de instancias del sitio.
Para obtener más información acerca de las configuraciones de definición, vea Procedimiento para crear una definición y una configuración personalizadas de un sitio.
Elemento Modules
La colección Modules especifica un grupo de módulos. Se puede hacer referencia a cualquiera de los módulos del grupo mediante una configuración si se debe incluir el módulo en sitios web creados a partir de dicha configuración. Cada elemento Module a su vez especifica uno o más archivos que se van a incluir, normalmente para los elementos web, que se almacenan en la memoria caché en el servidor front-end web, junto con los archivos de esquema. Puede usar el atributo Url del elemento Module para aprovisionar una carpeta como parte de la definición del sitio. Este marcado sólo se admite para compatibilidad con versiones anteriores. Los nuevos módulos se deben incorporar a las características.
<Modules>
<Modules>
<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="https://schemas.microsoft.com/WebPart/v2"
xmlns:iwp="https://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>
<iwp:AlternativeText>$Resources:core,sitelogo_wss;
</iwp:AlternativeText>
</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>
...
</Modules>
El elemento Module especifica un nombre para el módulo, que corresponde a un nombre de módulo especificado en una configuración en Onet.xml.
El atributo Url de cada elemento File de un módulo especifica el nombre de un archivo que se debe crear al crear un sitio. Cuando el módulo incluye un archivo único, como default.aspx, NavBarHome="TRUE" especifica que el archivo es la página de destino para el vínculo Página principal en las barras de navegación. El elemento File para default.aspx también especifica los elementos web que se deben incluir en la página principal y la información sobre ésta para otras páginas vinculadas a ella.
Un elemento Module solo se puede incluir en un archivo Onet.xml que sea parte de una definición de sitio y no en un archivo Onet.xml que sea parte de una plantilla web.
Para obtener más información acerca de cómo usar los módulos en SharePoint Foundation, vea Procedimientoa para aprovisionar un archivo.
Elemento Components
El elemento Components especifica componentes para incluir en los sitios creados mediante la definición.
<Components>
<FileDialogPostProcessor ID="BDEADEE4-C265-11d0-BCED-00A0C90AB50F" />
</Components>
Un elemento Components sólo se puede incluir en un archivo Onet.xml que es parte de una definición de sitio y no en un archivo Onet.xml que es parte de una plantilla web.
Elemento ServerEmailFooter
El elemento ServerEmailFooter especifica la sección de pie de página usada en el correo electrónico que se envía desde el servidor.
<ServerEmailFooter>$Resources:ServerEmailFooter;</ServerEmailFooter>
Un elemento ServerEmailFooter solo se puede incluir en un archivo Onet.xml que es parte de una definición de sitio y no en un archivo Onet.xml que es parte de una plantilla web.