| Pré. | Proc. |
Aide Fichiers Gabarit
Enterprise Architect utilise une série de fichiers de gabarit lors de la génération de contenu HTML à partir de votre modèle d'aide. Chacun des fichiers de gabarit contient des informations de formatage, ainsi que des espaces réservés où le contenu généré sera inséré.
Au fur et à mesure que chaque élément de modèle est rendu, le fichier de gabarit correspondant est chargé en mémoire et les données de l'élément sont remplacées dans les espaces réservés appropriés. Le contenu de la page est construit au fur et à mesure que chaque élément est rendu, jusqu'à ce que finalement, le contenu de la page soit substitué dans l'espace réservé correspondant dans le fichier 'master gabarit '.
Il existe un fichier de gabarit spécifique qui correspond à chaque type d'élément disponible dans le modèle d'aide, ainsi que deux exemples de fichiers 'master gabarit '.
Tous ces fichiers de gabarit sont fournis dans le cadre d' Enterprise Architect et seront copiés dans un sous-dossier nommé ' Gabarits ' dans votre dossier de sortie spécifié la première fois que vous générez des fichiers à partir de votre modèle d'aide.
On s'attend à ce que vous personnalisiez le fichier de gabarit principal en fonction de vos propres besoins, cependant, il est beaucoup moins probable que vous ayez besoin de modifier les fichiers de gabarit d'élément.
Vous devez avoir une bonne connaissance pratique du HTML avant de tenter de personnaliser l'un des fichiers de gabarit .
Fichier Maître Gabarit
Le fichier de gabarit maître est unique, en ce sens que vous spécifiez le nom du fichier que vous souhaitez utiliser au début d'une génération. Nous vous encourageons à copier et renommer ce fichier, et à le modifier selon vos besoins. Essentiellement, il est utilisé comme conteneur pour le contenu généré et vous êtes libre de modifier la disposition de votre contenu comme vous le souhaitez.
Le tableau suivant décrit l'utilisation des espaces réservés de contenu disponibles pour une utilisation dans un fichier de gabarit maître.
|
TOPIC_TITLE |
Cet espace réservé est remplacé par le nom de l'élément «HelpTopic». Dans le contenu par défaut du fichier de gabarit maître, cette valeur est utilisée pour définir le titre de la page Web générée. Le titre de la page est utilisé par les navigateurs Web pour étiqueter les onglets individuels dans le navigateur. |
|
SITE_PATH |
Cet espace réservé est remplacé par la valeur du 'Site Folder Path', extraite de la boîte de dialogue ' Générer l'aide'. Une utilisation typique serait de créer l'élément initial dans le contrôle de navigation du fil d'Ariane de la page. Par example: <li class = "home" ><a href = "#SITE_PATH#/index.html" >Index</a></li> |
|
BREADCRUMB |
Cet espace réservé est remplacé par une string de code HTML, qui est utilisée pour créer un style de fil d'Ariane, un contrôle de navigation. La string HTML est construite sous la forme d'une liste d'hyperliens vers les pages générées associées à chacun des paquetages parents sous lesquels réside la rubrique actuelle. Le contenu par défaut dans le fichier de gabarit maître enveloppe cet espace réservé avec les balises <div>, <table> et <ul>, qui spécifient les classes CSS requises pour afficher la liste des hyperliens sous forme de fil d'Ariane. Si vous souhaitez supprimer le contrôle du fil d'Ariane, vous devez supprimer l'intégralité du fragment <div>. |
|
PREV_LINK |
Cet espace réservé, utilisé conjointement avec l'espace réservé ' PREV_LINK_CLOSE ', est utilisé pour créer un bouton qui fournit un lien hypertexte vers la page Web associée à la rubrique 'précédente' dans votre modèle d'aide. Si vous ne souhaitez pas afficher les boutons 'Prev' et 'Next', vous devez supprimer tout le fragment de tableau qui commence par < tableau class = "hnavright" > |
|
PREV_LINK_CLOSE |
Cet espace réservé est remplacé par du code HTML qui ferme la balise ouverte avec l'espace réservé ' PREV_LINK '. |
|
NEXT_LINK |
Cet espace réservé, utilisé conjointement avec l'espace réservé ' PREV_LINK_CLOSE ', est utilisé pour créer un bouton qui fournit un lien hypertexte vers la page Web associée à la rubrique 'précédente' dans votre modèle d'aide. Si vous ne souhaitez pas afficher les boutons 'Prev' et 'Next', vous devez supprimer tout le fragment de tableau qui commence par < tableau class = "hnavright" > |
|
NEXT_LINK_CLOSE |
Cet espace réservé est remplacé par du code HTML qui ferme la balise ouverte avec l'espace réservé " NEXT_LINK ". |
|
TOPIC_TEXT |
Cet espace réservé est remplacé par une string de texte HTML, qui constitue le corps de la page Web générée. Le générateur traite chacun des éléments enfants au sein d'un élément «HelpTopic», en utilisant le fichier de gabarit qui correspond au type de chaque élément enfant et construit une seule string HTML qui englobe tout le contenu du modèle pour la rubrique d'aide en cours. |
|
NAVIGATION |
Cet espace réservé est remplacé par une liste d'hyperliens, qui produit un menu sur le côté gauche de la page Web, prenant en charge la navigation vers les rubriques d'aide qui sont apparentées à la rubrique actuelle. C'est-à-dire, les sujets qui sont au même niveau dans la hiérarchie du modèle. |
HelpTopic
Le tableau suivant décrit l'utilisation des espaces réservés de contenu qui sont disponibles pour une utilisation dans le fichier de gabarit nommé " HelpTopic .html". Vous pouvez modifier le contenu de ce fichier si nécessaire, mais nous vous recommandons de l'utiliser sans modification - du moins pour commencer.
Vous ne pouvez pas renommer ce fichier gabarit - le générateur d'aide s'attend à trouver un fichier portant ce nom.
Nom de l'espace réservé |
Description |
|---|---|
|
TOPIC_NAME |
Cet espace réservé est remplacé par le nom de l'élément «HelpTopic». Le contenu par défaut du fichier de gabarit " HelpTopic .html" utilise le nom de la rubrique d'aide comme en-tête de la page. |
|
NOTES |
Cet espace réservé est remplacé par les Notes de l'élément « HelpTopic ». Le contenu par défaut du fichier de gabarit " HelpTopic .html" affiche les Notes de la rubrique d'aide immédiatement après l'en-tête de la page. |
|
PAGE_CONTENT |
Cet espace réservé est remplacé par le contenu de la page généré à la suite du traitement des éléments enfants de l'élément « HelpTopic ». Le contenu par défaut du fichier gabarit " HelpTopic .html" affiche ce 'contenu de la page' à la suite des Notes de l'élément «HelpTopic». |
|
LEARN_MORE |
Actuellement non utilisé. À ce stade, cet espace réservé est remplacé par un caractère de "retour chariot". |
HelpSection
Le tableau suivant décrit l'utilisation des espaces réservés de contenu qui sont disponibles pour une utilisation dans le fichier de gabarit nommé " HelpSection .html". Vous pouvez modifier le contenu de ce fichier si nécessaire, mais nous vous recommandons de l'utiliser sans modification - du moins pour commencer.
Vous ne pouvez pas renommer ce fichier gabarit - le générateur d'aide s'attend à trouver un fichier portant ce nom.
Nom de l'espace réservé |
Description |
|---|---|
|
ELEMENT_NAME |
Cet espace réservé est remplacé par le nom de l'élément en cours de traitement. Le contenu par défaut de ce fichier de gabarit rend le nom de l'élément sous la forme d'un en-tête pour le contenu généré à partir de l'élément. |
|
NOTES |
Cet espace réservé est remplacé par les Notes de l'élément «HelpSection». Le contenu par défaut de ce fichier de gabarit affiche les Notes de l'élément immédiatement après l'en-tête de l'élément. |
HelpTableNN
Le tableau suivant décrit l'utilisation des espaces réservés de contenu qui sont disponibles pour une utilisation dans l'ensemble de fichiers de gabarit nommé " HelpTableNN .html". Vous pouvez modifier le contenu de ces fichiers si nécessaire, mais nous vous recommandons de les utiliser sans modification, du moins pour commencer.
Vous ne pouvez pas renommer ces fichiers de gabarit - le générateur d'aide s'attend à trouver un fichier dont le nom correspond au type de tableau en cours de traitement.
Le contenu par défaut de ces fichiers de gabarit est construit de telle sorte que le nom de l'élément apparaisse sous la forme d'un en-tête, suivi de toutes les notes associées à l'élément, puis le tableau suit avec des en-têtes de colonne en haut, et le contenu des lignes du tableaux suit sous cela .
Nom de l'espace réservé |
Description |
|---|---|
|
ELEMENT_NAME |
Cet espace réservé est remplacé par le nom de l'élément en cours de traitement. Le contenu par défaut de ce fichier de gabarit rend le nom de l'élément sous la forme d'un en-tête pour le contenu généré à partir de l'élément. |
|
NOTES |
Cet espace réservé est remplacé par les Notes de l'élément en cours de traitement. Le contenu par défaut de ce fichier de gabarit affiche les Notes de l'élément immédiatement après l'en-tête de l'élément. |
|
TAGGED_VALUES |
Cet espace réservé est remplacé par une string de code HTML générée, qui constitue le début de la définition du tableau . Il inclut les en-têtes de colonne générés à partir des valeurs balisées de l'élément nommées "Column1", "Column2" et, dans le cas de tableaux à trois colonnes, "Column3". |
|
TABLE_ROWS |
Cet espace réservé est remplacé par la string HTML générée par le traitement des éléments « HelpTableRow » qui sont des enfants de l'élément « HelpTable » en cours de traitement. |
HelpTableRow
Le tableau suivant décrit l'utilisation des espaces réservés de contenu qui sont disponibles pour une utilisation dans le fichier de gabarit nommé " HelpTableRow .html". Vous pouvez modifier le contenu de ce fichier si nécessaire, mais nous vous recommandons de l'utiliser sans modification - du moins pour commencer.
Vous ne pouvez pas renommer ce fichier gabarit - le générateur d'aide s'attend à trouver un fichier portant ce nom.
Nom de l'espace réservé |
Description |
|---|---|
|
ELEMENT_NAME |
Cet espace réservé est remplacé par le nom de l'élément en cours de traitement. Le contenu par défaut de ce fichier de gabarit le nom de l'élément dans la première cellule (la plus à gauche) de la ligne du tableau . |
|
NOTES |
Cet espace réservé est remplacé par les Notes de l'élément en cours de traitement. Le contenu par défaut de ce fichier de gabarit rend les Notes dans la deuxième cellule de la ligne du tableau . |
|
ROWS_LINKS |
Cet espace réservé est disponible pour une utilisation uniquement dans les fichiers de gabarit pour les tableaux à trois colonnes . Il est remplacé par des hyperliens générés à partir des données contenues dans les valeurs balisées 'Voir aussi' de l'élément de ligne du tableau en cours de traitement. Le contenu par défaut de ce fichier de gabarit rend les hyperliens "Voir aussi" dans la troisième cellule de la ligne du tableau . |
HelpSectionLearnMore
Le tableau suivant décrit l'utilisation des espaces réservés de contenu qui sont disponibles pour une utilisation dans le fichier de gabarit nommé " HelpSectionLearnMore .html". Vous pouvez modifier le contenu de ce fichier si nécessaire, mais nous vous recommandons de l'utiliser sans modification - du moins pour commencer.
Vous ne pouvez pas renommer ce fichier gabarit - le générateur d'aide s'attend à trouver un fichier portant ce nom.
Nom de l'espace réservé |
Description |
|---|---|
|
ELEMENT_NAME |
Cet espace réservé est remplacé par le nom de l'élément en cours de traitement. Le contenu par défaut de ce fichier de gabarit rend le nom de l'élément sous la forme d'un en-tête pour le contenu généré à partir de l'élément. Typiquement, l'élément serait nommé " Apprenez Plus " |
|
NOTES |
Cet espace réservé est remplacé par les Notes de l'élément en cours de traitement. Le contenu par défaut de ce fichier de gabarit affiche les Notes de l'élément immédiatement après l'en-tête de l'élément. |
HelpSlideshow
Le tableau suivant décrit les espaces réservés de contenu qui sont utilisés dans le fichier gabarit nommé " HelpSlideshow .html". Le contenu par défaut du fichier de HelpSlideshow gabarit ', organise le contenu HTML généré sous la forme d'un tableau ayant une seule ligne avec deux colonnes. Une icône représentant le diaporama est placée dans la première colonne. La deuxième colonne contient le nom de l'élément écrit sous forme d'en-tête, avec l'élément Notes placé sous l'en-tête. Vous pouvez modifier le contenu de ce fichier si nécessaire, mais nous vous recommandons de l'utiliser sans modification - du moins pour commencer.
Vous ne pouvez pas renommer ce fichier gabarit - le générateur d'aide s'attend à trouver un fichier portant ce nom.
Nom de l'espace réservé |
Description |
|---|---|
|
FIRST_LB_IMAGE |
Cet espace réservé est remplacé par du code HTML qui ouvre les balises utilisées pour le contrôle de style lightbox et spécifie la première image du diaporama. |
|
TAGGED_VALUES_ICON |
Cet espace réservé est remplacé par le code HTML qui spécifie l'image à afficher comme icône du diaporama. |
|
FIRST_LB_IMAGE_END |
Cet espace réservé est remplacé par du code HTML qui ferme la balise de la première image du diaporama |
|
TAGGED_VALUES_IMAGE |
Cet espace réservé est remplacé par du code HTML qui répertorie toutes les images suivantes dans le diaporama. |
|
ELEMENT_NAME |
Cet espace réservé est remplacé par le nom de l'élément en cours de traitement. Le contenu par défaut de ce fichier de gabarit rend le nom de l'élément sous forme d'en-tête, à droite de l'icône du diaporama. |
|
NOTES |
Cet espace réservé est remplacé par les Notes de l'élément en cours de traitement. Le contenu par défaut de ce fichier de gabarit affiche les Notes de l'élément immédiatement sous l'en-tête de l'élément. |
HelpSystemVideo
Ce tableau décrit l'utilisation des espaces réservés de contenu qui sont disponibles pour une utilisation dans le fichier de gabarit nommé " HelpSystemVideo .html". Vous pouvez modifier le contenu de ce fichier si nécessaire, mais nous vous recommandons de l'utiliser sans modification - du moins pour commencer.
Vous ne pouvez pas renommer ce fichier gabarit - le générateur d'aide s'attend à trouver un fichier portant ce nom.
Nom de l'espace réservé |
Description |
|---|---|
|
VIDEO_TITLE |
Cet espace réservé est remplacé par la valeur de la valeur taguée de l'élément nommée ' valeur '. Le contenu par défaut de ce fichier de gabarit , affiche le titre sous forme d'en-tête au-dessus du champ vidéo HTML. |
|
VIDEO_URL |
Cet espace réservé est remplacé par la valeur de la valeur balisée de l'élément nommée " valeur ". Ceci est utilisé dans la balise HTML 'video', pour fournir la valeur d'URL pour l'attribut 'src' de la balise 'source'. Le contenu par défaut de ce fichier de gabarit affiche un contrôle vidéo pleine largeur. Lorsque le bouton 'play' est cliqué, le contrôle chargera et lira le fichier vidéo trouvé à l'URL spécifiée. |
|
VIDEO_TYPE |
Cet espace réservé est remplacé par la valeur de la valeur taguée de l'élément nommée ' valeur '. Ceci est utilisé dans la balise HTML 'video', pour fournir une valeur pour l'attribut 'type' de la balise 'source'. |
HelpVideoLocal
Le fichier HelpVideoLocal gabarit ' n'est actuellement pas utilisé.
Nom de l'espace réservé |
Description |
|---|
HelpSectionDiagram
Ce tableau décrit l'utilisation des espaces réservés de contenu qui sont disponibles pour une utilisation dans le fichier gabarit nommé " HelpSectionDiagram .html". Vous pouvez modifier le contenu de ce fichier si nécessaire, mais nous vous recommandons de l'utiliser sans modification - du moins pour commencer.
Vous ne pouvez pas renommer ce fichier gabarit - le générateur d'aide s'attend à trouver un fichier portant ce nom.
Nom de l'espace réservé |
Description |
|---|---|
|
IMAGE_LOCATION |
Cet espace réservé est remplacé par le nom de chemin généré pour l'image du diagramme . Le code HTML généré inclut uniquement le nom du chemin d'accès au fichier contenant l'image du diagramme . Il n'inclut pas le nom de l'élément ni les notes . |
Notes
- Les espaces réservés de contenu dans les fichiers de gabarit sont (et doivent rester) entourés d'un seul caractère "#" devant et derrière, afin que le générateur d'aide les reconnaisse comme des espaces réservés.