Création de bibliothèques de templates

De RAD Studio
Aller à : navigation, rechercher

Remonter à Comment modifier le code dans l'éditeur de code


Les bibliothèques de templates sont des templates de projet personnalisés qui spécifient à quoi doit ressembler un projet et ce qu'il doit contenir. Lorsque vous créez une bibliothèque de templates personnalisée, elle est placée dans la boîte de dialogue Nouveaux éléments où elle est accessible pour la création d'un projet avec Fichier > Nouveau.

Vous pouvez créer des projets de bibliothèque de templates à partir de rien ou utiliser des projets préalablement créés par vous ou par d'autres développeurs comme base des bibliothèques de templates. Pour utiliser un projet existant, créez simplement un fichier XML avec l'extension .bdstemplatelib qui décrit le projet et est utilisé pour créer la bibliothèque de templates utilisant ce projet.

Remarque :  Lors de la création d'un projet à utiliser avec une bibliothèque de templates, le projet doit être situé dans un sous-répertoire ne contenant pas d'autres projets. En outre, tous les fichiers du projet doivent résider dans le sous-répertoire ou ses sous-répertoires enfant.

Pour créer une bibliothèque de templates

  1. Créez un nouveau projet ou ouvrez un projet existant qui représentera la base de la bibliothèque de templates personnalisée.Apportez des modifications au projet afin de le personnaliser pour la bibliothèque de templates.
  2. Enregistrez et fermez le projet.
  3. Choisissez Fichier > Nouveau > Autre > Documents Web et double-cliquez sur l'icône Fichier XML.
  4. Remplacez le contenu par défaut du nouveau fichier XML par le contenu exemple suivant :


  <TemplateLibrary Version="1.0" id="">
    <Name></Name>
    <Description></Description>
    <Items>
      <Item id="" Creator="">
        <Name>Name of template library here </Name>
        <Description>Custom Project Template</Description>
        <Author></Author>
        <Icon>MyTemplate\MyTemplateIcon.ico</Icon>
        <ProjectFile>MyTemplate.dproj</ProjectFile>
        <DefaultProjectName>MyTemplate</DefaultProjectName>
        <FilePath>MyTemplate</FilePath>
        <Identities>RadStudio</Identities>
      </Item>
    </Items>
  </TemplateLibrary>


Remarques :
  • L'attribut id="" de l'élément <TemplateLibrary> doit être unique afin d'éviter des conflits avec d'autres bibliothèques de templates. Il est conseillé d'inclure votre nom ou le nom de votre société dans l'id.
  • Pour les projets C++Builder, changez l'extension dans l'élément <ProjectFile> par cbproj.
  • L'attribut Creator="" de l'élément <Item> spécifie la page de la boîte de dialogue Nouveaux éléments qui affiche l'icône de cette bibliothèque de templates. Vous pouvez placer l'icône du projet sur une page spécifique au type de projet créé.
Voici les valeurs possibles de l'attribut Creator="" :


Type de projet Valeur de l'attribut Creator de l'élément
Projets C++ Creator="CBuilderProjectRepositoryCreator"
Projets Delphi Creator="DelphiProjectRepositoryCreator"


  1. Enregistrez le fichier xml .bdstemplatelib dans un répertoire au-dessus du répertoire projet.

    Remarque :  L'élément <FilePath> du fichier .bdstemplatelib indique l'emplacement du répertoire projet relativement à l'emplacement du fichier .bdstemplatelib.

  2. Modifiez le contenu du XML .bdstemplatelib de façon à le personnaliser pour votre propre bibliothèque de templates :

    • Ajoutez le nom de la bibliothèque de templates, la description et la valeur de l'attribut Creator.
    • Modifiez le nom du projet, les informations de chemin du projet, le chemin de l'icône et le nom du fichier. Vous pouvez facultativement ajouter votre nom comme auteur.
    • Spécifiez le chemin relatif au fichier XML .bdstemplatelib dans la valeur <FilePath>. Par exemple, si votre projet réside dans C:\MyProjects\TemplateLibraries\MyTemplate et que vous placez le fichier XML dans C:\MyProjects\TemplateLibraries, la valeur <FilePath> dans le fichier XML est <FilePath>TemplateLibraries\MyTemplate</FilePath>.
  3. Choisissez Outils > Bibliothèques de templates pour ouvrir la boîte de dialogue Bibliothèques de templates.
  4. Cliquez sur le bouton Ajouter, naviguez jusqu'au fichier XML .bdstemplatelib nouvellement créé, sélectionnez-le et cliquez sur Ouvrir. La nouvelle bibliothèque de templates est ajoutée à la liste de la boîte de dialogue Bibliothèques de templates. Elle est également ajoutée dans la page spécifiée de la boîte de dialogue Nouveaux fichiers. Cliquez sur OK pour fermer la boîte de dialogue Bibliothèques de templates.

Afin d'utiliser cette bibliothèque de templates pour la création d'un nouveau projet, choisissez Fichier > Nouveau > Autre et sélectionnez votre bibliothèque de templates dans la boîte de dialogue Nouveaux fichiers.

Exemple

  <TemplateLibrary Version="1.0" id="CompanyNameDelphiVCLProject">
    <Name>DelphiVCLProject</Name>
    <Description>Simple Delphi VCL Project</Description>
    <Items>
      <Item id="DelphiVCLProject" Creator="DelphiProjectRepositoryCreator">
        <Name>Delphi VCL Project</Name>
        <Description>A simple Delphi VCL project.</Description>
        <Author>John Doe</Author>
        <ProjectFile>DelphiVCLProject.dproj</ProjectFile>
        <DefaultProjectName>DelphiVCLProject</DefaultProjectName>
        <FilePath>DelphiVCL</FilePath>
        <Identities>RadStudio</Identities>
      </Item>
    </Items>
  </TemplateLibrary>

Si vous avez plusieurs projets associés, vous pouvez utiliser un fichier bibliothèque de templates .bdstemplatelib unique pour lister tous les projets.

Pour combiner plusieurs projets dans un seul fichier bibliothèque de templates

  1. Placez tous les dossiers projet au même niveau dans le même sous-dossier projet.
  2. Créez le fichier bibliothèque de templates .bdstemplatelib au niveau situé au-dessus du dossier contenant tous les projets.
  3. Ajoutez le contenu pour le premier projet, comme décrit ci-dessus.
  4. Ajoutez un <Item></Item> supplémentaire à l'élément <Items></Items> pour chaque projet du groupe, donnant à chaque <Item></Item> un attribut id=" unique.

Exemple

  <TemplateLibrary Version="1.0" id="Embarcadero">
    <Name>MultipleProjectsTemplate</Name>
    <Description>Template with multiple projects.</Description>
    <Items>
      <Item id="DelphiVCLProject" Creator="DelphiProjectRepositoryCreator">
        <Name>Delphi VCL Project</Name>
        <Description>A simple Delphi VCL project.</Description>
        <Author>John Doe</Author>
        <ProjectFile>DelphiVCLProject.dproj</ProjectFile>
        <DefaultProjectName>DelphiVCLProject1</DefaultProjectName>
        <FilePath>DelphiVCL</FilePath>
        <Identities>RadStudio</Identities>
      </Item>
      <Item id="CppVCLProject" Creator="CBuilderProjectRepositoryCreator">
        <Name>C++ VCL Project</Name>
        <Description>A simple C++ VCL project.</Description>
        <Author>John Doe</Author>
        <ProjectFile>CPPVCLProject.cbproj</ProjectFile>
        <DefaultProjectName>CPPVCLProject2</DefaultProjectName>
        <FilePath>CPPVCL</FilePath>
        <Identities>RadStudio</Identities>
      </Item>
    </Items>
  </TemplateLibrary>


Voir aussi