Onet.xml

Artículo
02/01/2010

Al instalar Windows SharePoint Services 3.0, seis archivos Onet.xml se colocan dentro del directorio de instalación, uno en \Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\TEMPLATE\GLOBAL\XML que se aplica de forma global a la implementación y cinco en diferentes carpetas dentro de ...\TEMPLATE\SiteTemplates, cada uno de los cuales se aplica a una de las cinco definiciones de sitio que se suministran con Windows SharePoint Services 3.0. Son sitios de blogs, el sitio de administración central, sitios Wiki, sitios de área de reuniones y sitios de SharePoint Team. Sólo las dos últimas de estas familias contienen más de una configuración de definición del sitio en Windows SharePoint Services 3.0.

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. Los cinco archivos Onet.xml en el directorio \SiteTemplates definen áreas de exploración, plantillas de listas, plantillas de documentos, configuraciones, módulos, componentes y secciones de pie de página del servidor de correo electrónico usadas en las cinco definiciones de sitio.

Las funciones de Onet.xml

En función de su uso en particular, un archivo Onet.xml puede desempeñar varias funciones, como las siguientes:

Definir las áreas de exploración superior y lateral que aparecen en la página principal y en las vistas de lista para una definición de sitio.
Especificar las definiciones de lista que se usan en cada definición de sitio y si están disponibles para crear listas en la página Crear.
Especificar plantillas de documento que están disponibles en la definición de sitio para crear listas de la biblioteca de documentos en la página Nuevo, y especificar los archivos que se usan en las plantillas de documento.
Definir los tipos de listas base de los que se derivan las listas predeterminadas de Windows SharePoint Services. (Sólo el archivo Onet.xml global desempeña esta función).
Especificar las configuraciones de las listas y módulos que se usan dentro de cada definición de sitio.
Especificar los componentes de Windows SharePoint Services.
Definir la sección de pie de página usada en el correo electrónico de servidor.

Tareas de definición de sitios web con Onet.xml

Los siguientes tipos de tareas pueden realizarse en un Onet.xml personalizado para crear una definición de sitio 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 exploración para la página principal y las páginas de lista.
Agregar una definición de lista como una opción a la página Crear.
Agregar una plantilla de documento para crear bibliotecas de documentos.
Definir una o varias configuraciones para la definición del sitio, especificando las listas, módulos, archivos y elementos web que se incluyen cuando se crean instancias de la configuración de definición de un sitio.

Advertencia

Realizar cambios en un archivo Onet.xml instalado originalmente en un servidor que ejecuta Windows SharePoint Services puede romper sitios existentes, y se pueden sobrescribir los cambios al instalar las actualizaciones o Service Packs para Windows SharePoint Services, o cuando se actualiza una instalación a la siguiente versión del producto. Cree siempre un nuevo archivo Onet.xml; no modifique el archivo original. Para obtener más información, consulte Procedimiento para crear una definición y una configuración personalizadas de un sitio.

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 y 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:onet_TeamWebSite;" 
  Revision="2"
  ListDir="$Resources:core,lists_Folder;" 
  xmlns:ows="Microsoft SharePoint">

Nota

En todo el extractos en 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 equipo " en core.resx. Cuando se crea un archivo Onet.xml personalizado, puede usar literales.

Este elemento también puede tener un atributo AlternateCSS que especifica un archivo CSS alternativo para las definiciones de estilo, un atributo CustomJSUrl que especifica un archivo JavaScript alternativo para scripts personalizadas, y un atributo AlternateHeader que especifica un archivo ASPX para encabezados alternativos.

El elemento Project no contiene ningún atributo que identifique la definición de sitio que define. Cada 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 Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\TEMPLATE\SiteTemplates\tipo_sitio\XML\, donde tipo_sitio es el nombre de la definición del sitio, como STS o MPS.

Elemento NavBars

El elemento NavBars contiene las definiciones para el área de exploración superior que se muestra en la página principal o en las vistas de lista, y las definiciones para el área de exploración lateral que se muestra en la página principal.

Nota

Un NavBar no es necesariamente una barra de herramientas. Puede ser, por ejemplo, un árbol de vínculos.

<NavBars>
  <NavBar 
    Name="$Resources:core,category_Top;" 
    Separator="&amp;nbsp;&amp;nbsp;&amp;nbsp;" 
    Body="&lt;a ID='onettopnavbar#LABEL_ID#' href='#URL#' accesskey='J'&gt;#LABEL#&lt;/a&gt;" 
    ID="1002" />
  <NavBar 
    Name="$Resources:core,category_Documents;" 
    Prefix="&lt;table border=0 cellpadding=4 cellspacing=0&gt;" 
    Body="&lt;tr&gt;&lt;td&gt;&lt;table border=0 cellpadding=0 cellspacing=0&gt;&lt;tr&gt;&lt;td&gt;&lt;img src='/_layouts/images/blank.gif' ID='100' alt='' border=0&gt;&amp;nbsp;&lt;/td&gt;&lt;td valign=top&gt;&lt;a ID=onetleftnavbar#LABEL_ID# href='#URL#'&gt;#LABEL#&lt;/td&gt;&lt;/tr&gt;&lt;/table&gt;&lt;/td&gt;&lt;/tr&gt;" 
    Suffix="&lt;/table&gt;" 
    ID="1004" />
    ...
</NavBars>

Un elemento NavBarLink define vínculos para el área de exploración superior o lateral, un 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 exploración y define cómo mostrar la barra de exploración.

Para obtener información acerca de cómo personalizar las áreas de exploración en las páginas de Windows SharePoint Services, consulte Personalización de la exploración del sitio.

Elemento ListTemplates

La sección ListTemplates especifica las definiciones de lista que forman parte de una definición de sitio.

Nota

La sección ListTemplates no se incluye en el archivo Onet.xml de la definición del sitio Windows SharePoint Services estándar, que en su lugar usa características de definición de lista y archivos .xml elemento para definir sus plantillas de lista. El siguiente ejemplo se toma del archivo Onet.xml para la definición del 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 página Nuevo. Además, este elemento especifica la descripción de definición de lista y la ruta de acceso a la imagen que representa la definición de lista, las cuales se muestran en la página Crear. Si se especifica Hidden="TRUE", la definición de lista no aparece como una opción en la página Crear.

El elemento ListTemplate tiene dos atributos para tipo, Type y BaseType. El atributo Type especifica un identificador único para la definición de lista, mientras que BaseType identifica el tipo de lista base para la definición de lista y corresponde al valor Type especificado para uno de los tipos de lista base definidos en el archivo ONET.XML global (\TEMPLATE\GLOBAL\XML).

Para ver una tarea de programación que muestra cómo agregar una plantilla de lista, consulteProcedimiento para crear una definición de lista personalizada.

Elemento DocumentTemplates

La sección DocumentTemplates define las plantillas de documento que se enumeran en la página Nuevo.

<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 creados con una configuración en la definición de sitio que especifica el archivo Onet.xml. 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 sirve 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.

Para una tarea de programación que implica plantillas de documento, consulte 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 cinco tipos de lista en los que se basan todas las definiciones de lista en Windows SharePoint Services . 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 Windows SharePoint Services 3.0 se implementa la sección BaseTypes sólo en el archivo Onet.xml global (\TEMPLATE\GLOBAL\XML), 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 se derivan del tipo base. El atributo Type de cada elemento Elemento Field (Lista - Definición) identifica el campo con un tipo de campo definido en FldTypes.xml

Advertencia

No se puede modificar el contenido del archivo Onet.xml global (archivo (\TEMPLATE\GLOBAL\XML), 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, consulte Procedimiento para crear una definición de lista personalizada

Elemento Configurations

Cada elemento Configuration en la sección Configurations especifica las listas y módulos que se crean de forma predeterminada cuando se crean instancias de la configuración de definición del sitio.

<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 relacionados con las demás configuraciones en la definición de sitio) y se corresponde con el atributo ID de un elemento Configuration en 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 creada 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, consulte Procedimiento para usar configuraciones de definición de sitios.

Elemento Modules

La colección Modules especifica los módulos para incluir de forma predeterminada al crear una colección de sitios. 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 cliente 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.

<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 que está especificado en una configuración en ONET.XML.

El atributo Url de cada elemento File en un módulo especifica el nombre de un archivo para crear cuando se crea un sitio. Cuando el módulo incluye un archivo único, como Default.aspx, NavBarHome="TRUE" especifica que el archivo actuará como la página de destino para el vínculo Home en las barras de exploración. El elemento File para Default.aspx también especifica los elementos web que desea incluir en la página principal e información sobre la página principal para otras páginas con vínculos a ella.

Para obtener más información acerca de cómo usar los módulos en Windows SharePoint Services 3.0, consulte 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>

Elemento ServerEmailFooter

El elemento ServerEmailFooter especifica la sección de pie de página usada en el correo electrónico enviado desde el servidor.

<ServerEmailFooter>$Resources:ServerEmailFooter;</ServerEmailFooter>

Vea también

Otros recursos

Esquema de sitios
Instrucciones para usar plantillas y definiciones

Compartir a través de

Onet.xml

Las funciones de Onet.xml

Tareas de definición de sitios web con Onet.xml

Formato de archivo

Elemento Project

Elemento NavBars

Elemento ListTemplates

Elemento DocumentTemplates

Elemento BaseTypes

Elemento Configurations

Elemento Modules

Elemento Components

Elemento ServerEmailFooter

Vea también

Otros recursos

Recursos adicionales