Cómo se hace: Crear Kits de Inicio

En esta página

Cómo se hace: Crear Kits de Inicio

Un Kit de Inicio es esencialmente una plantilla mejorada de proyecto que puede ser compartida con otros miembros de la comunidad. El proceso de creación de un Kit de Inicio supone no solo el diseño y desarrollo del proyecto y documentación, sino también proveer la información sobre la plantilla de proyecto y compartir el Kit de Inicio en sí con otros interesados.

Los Kits de Inicio con aplicaciones de ejemplo y herramientas de aprendizaje contienen ambos un proyecto y su documentación, pero las herramientas de aprendizaje incluyen además otras cosas que el usuario puede usar y a las que hacer referencia cuando cree una aplicación. Los mínimos requisitos a incluir en un Kit de Inicio son:

•	El archivo de metadatos (*.vstemplate) que Visual Studio usa para definir cómo mostrar el proyecto en el entorno de desarrollo y, si has especificado las propiedades apropiadas, para parametrizar cómo se crea el proyecto en el entorno de desarrollo.
•	El archivo de proyecto o archivo Web.config.
•	Los archivos de código como formularios Windows forms, Web forms, clases, y archivos de recursos.
•	El directorio que contiene la documentación y recursos como las imágenes (Documentation\). La documentación puede estar en cualquier formato, por ejemplo en archivos Hypertext Markup Language (HTML), Microsoft Office Word, o de texto plano, aunque la mayoría de la documentación suele incluirse en HTML.
•	El archivo de inicio de la documentación, que es mostrado automáticamente cuando el usuario crea un nuevo proyecto utilizando el Kit de Inicio (Documentation\default.htm).

Otros temas opcionales que se puede considerar incluir son:

•	Un directorio que contenga el proyecto completado, el archivo de proyecto y el código fuente (After\).
•	Un archivo comprimido que contenga fragmentos de código (snippets), código para controles, y plantillas de artículos (CodeSnippets.zip).

Todos los artículos se comprimen finalmente en un solo archivo de forma que el Kit de Inicio puede ser fácilmente compartido con otros desarrolladores.

Creando un Kit de Inicio Básico

Un Kit de Inicio Básico contiene la cantidad mínima de metadatos para asegurar que el proyecto se visualiza en el entorno de desarrollo; por ejemplo, especifica cómo es muestra la caja de diálogo Nuevo Proyecto.

Para crear un Kit de Inicio Básico

Diseña el Kit de Inicio y crea el proyecto y la documentación.

Firma el archivo XML que proporciona los metadatos de la plantilla del proyecto y guarda el archivo con la extensión .vstemplate.

Este ejemplo muestra un archivo de metadatos que especifica cómo el Kit de Inicio es mostrado como una plantilla de proyecto en la caja de diálogo Nuevo Proyecto, y lista el contenido del proyecto. La sección TemplateData especifica el nombre y descripción del proyecto que son mostrados , así como el lenguaje del proyecto. La sección TemplateContent especifica el nombre del archivo del proyecto y lista los archivos que están incluidos en el mismo.

<VSTemplate Type="StarterKit" Version="1.1.0">
   <TemplateData>
      <Name>
         <String>IBuySpy Portal Starter Kit</String>
      </Name>
      <Description>
         <String>A web portal </String>
      </Description>
      <Languages>
         <Language>CSharp</Language>
      </Languages>
   </TemplateData>
   <TemplateContent>
      <ProjectFile>
         <SourceFile>web.config</SourceFile>
      </ProjectFile>
      <ProjectContents>
         <ProjectItem>
            <SourceFile>Global.asax</SourceFile>
         </ProjectItem>
         <ProjectItem>
            <SourceFile>Default.aspx</SourceFile>
         </ProjectItem>

         ...

      </ProjectContents>
   </TemplateContent>
</VSTemplate>

Comprime el contenido del Kit de Inicio, incluyendo el archivo de metadatos, en un archivo .zip.

Creando un Kit de Inicio Inermedio

Un Kit de Inicio intermedio contiene suficientes metadatos para asegurar que el proyecto es visualizado en el entorno de desarrollo y además permite a los usuarios la parametrización de algunos de los parámetros del proyecto; por ejemplo, en la caja de diálogo Nuevo Proyecto, los usuarios pueden dar un nombre a la solución.

Para crear un Kit de Inicio Intermedio

Diseña el Kit de Inicio y crea el proyecto y la documentación.

Firma el archivo XML que proporciona los metadatos de la plantilla del proyecto y guarda el archivo con la extensión .vstemplate.

Adicionalmente al información en el archivo de metadatos que proporciona un Kit de Inicio Básico, el siguiente ejemplo muestra un archivo de metadatos que permite alguna personalización y especifica los archivos que son abiertos cuando el proyecto es creado en el entorno de desarrollo, así como el orden en que son abiertas sus correspondientes archivos de documentación. El elemento ReplaceParameters especifica si hay parámetros que requieran sustitución por el ayudante de plantillas y que estén presentes en el código fuente, y la sección TemplateContent incluye los nombres de los archivos de documentación y el orden en que serán abiertos.

<VSTemplate Type="StarterKit" Version="1.1.0">
   <TemplateData>
      <Name>
         <String>IBuySpy Portal Starter Kit</String>
      </Name>
      <Description>
         <String>A web portal </String>
      </Description>
      <Languages>
         <Language>CSharp</Language>
      </Languages>
</TemplateData>
<TemplateContent>
      <ProjectFile>
         <SourceFile>web.config</SourceFile>
         <ReplaceParameters>true</ReplaceParameters>
      </ProjectFile>
      <ProjectContents>
         <ProjectItem>
            <SourceFile>Global.asax</SourceFile>
         </ProjectItem>
         <ProjectItem>
            <SourceFile>Default.aspx</SourceFile>
         </ProjectItem>

         ...

         <Folder Name="Documentation">
            <Item>
               <SourceFile>Documentation\GettingStarted.html</SourceFile>
               <OpenInEditorPropertyGroup>
                  <OpenInEditor>true</OpenInEditor>
                  <OpenOrder>10</OpenOrder>
               </OpenInEditorPropertyGroup>
            </Item>
            
            <Item>
               <SourceFile>Documentation\GettingStarted2.html</SourceFile>
               <OpenInEditorPropertyGroup>
                  <OpenInEditor>true</OpenInEditor>
                  <OpenOrder>20</OpenOrder>
               </OpenInEditorPropertyGroup>
            </Item>
         </Folder>
      </ProjectContents>
   </TemplateContent>
</VSTemplate>

Comprime el contenido del Kit de Inicio, incluyendo el archivo de metadatos, en un archivo .zip.

Creando un Kit de Inicio Detallado

Además de los metadatos que se especifican en un Kit de Inicio Intermedio, el archivo de metadatos para un Kit de Inicio Detallado contiene información de registro para un ayudante que los usuarios pueden utilizar para parametrizar la plantilla; por ejemplo, pueden especificar el namespace origen (root) y el GUID de proyecto. Los ayudantes se pueden utilizar solo con los Starter Kits que se instalan sobre Visual Studio.

•

Para crear un Kit de Inicio Detallado

•

Diseña el Kit de Inicio y crea el proyecto y la documentación.

•

Firma el archivo XML que proporciona los metadatos de la plantilla del proyecto y guarda el archivo con la extensión .vstemplate.

Como añadido a la información incluida en el archivo de metadatos de un Kit de Inicio Intermedio, el siguiente ejemplo contiene una sección WizardExtension que registra el montaje (assembly) de la extensión del ayudante.

<VSTemplate Type="StarterKit" Version="1.1.0">
   <TemplateData>
      <Name>
         <String>IBuySpy Portal Starter Kit</String>
      </Name>
      <Description>
         <String>A web portal </String>
      </Description>
      <Languages>
         <Language>CSharp</Language>
      </Languages>
   </TemplateData>
   <TemplateContent>
      <ProjectFile>
         <SourceFile>web.config</SourceFile>
         <ReplaceParameters>true</ReplaceParameters>
      </ProjectFile>
      <ProjectContents>
         <ProjectItem>
            <SourceFile>Global.asax</SourceFile>
         </ProjectItem>
         <ProjectItem>
            <SourceFile>Default.aspx</SourceFile>
         </ProjectItem>

      .

         <Folder Name="Documentation">
            <Item>
               <SourceFile>Documentation\GettingStarted.html</SourceFile>
            <OpenInEditorPropertyGroup>
               <OpenInEditor>true</OpenInEditor>
               <OpenOrder>10</OpenOrder>
            </OpenInEditorPropertyGroup>
            </Item>

            <Item>
               <SourceFile>Documentation\GettingStarted.html</SourceFile>
               <OpenInEditorPropertyGroup>
                  <OpenInEditor>true</OpenInEditor>
                  <OpenOrder>20</OpenOrder>
               </OpenInEditorPropertyGroup>
            </Item>
         </Folder>
      </ProjectContents>
   </TemplateContent>
   <WizardExtension>
         <Assembly>Foo, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, 
		 Custom=null</Assembly>
         <FullClassName>VC#Wizards.WindowsApplication</FullClassName>
   </WizardExtension>
</VSTemplate>

•

Comprime el contenido del Kit de Inicio, incluyendo el archivo de metadatos, en un archivo .zip.

Principio de la página