Aide Gabarit Fichiers

Enterprise Architect utilise une série de fichiers gabarit pour générer du contenu HTML à partir de votre modèle d'aide. Chacun des fichiers gabarit contient des informations de formatage, ainsi que des espaces réservés où le contenu généré sera inséré.

A mesure que chaque élément du modèle est rendu, le fichier 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 remplacé dans l'espace réservé correspondant dans le fichier « gabarit maître ».

Il existe un fichier gabarit spécifique correspondant à chaque type d'élément disponible dans le modèle d'aide, ainsi que deux exemples de fichiers « gabarit maître ».

Tous ces fichiers 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.

Il est prévu que vous personnalisiez le fichier gabarit principal pour l'adapter à vos propres besoins, cependant, il est beaucoup moins probable que vous ayez besoin de modifier les fichiers gabarit des éléments.

Vous devez avoir une bonne connaissance pratique du HTML avant de tenter de personnaliser l'un des fichiers gabarit .

Lime Master Gabarit

Le fichier gabarit principal est unique, dans le sens où vous spécifiez le nom du fichier que vous souhaitez utiliser lorsque vous démarrez une génération. Vous êtes encouragé à 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 gabarit principal.

TOPIC_TITLE	Cet espace réservé est remplacé par le nom de l'élément « HelpTopic ». Dans le contenu par défaut du fichier 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 du navigateur.
SITE_PATH	Cet espace réservé est remplacé par la valeur du « Chemin du dossier du site », extraite de la dialogue « Générer 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 exemple : <li class = "home" > <a href = "#SITE_PATH#/index.html" > Index</a></li>
MÉTA_DESCRIPTION	Cet espace réservé est remplacé par une valeur construite à l'aide du nom du HelpTopic généré, suivi de la première phrase du champ Notes du HelpTopic généré. La valeur « méta description » est utilisée par les moteurs de recherche tels que Google pour indexer la page Web. L'utilisation typique serait d'inclure la ligne suivante dans la section <head> du fichier gabarit maître : <meta name = "Description" content = "#META_DESCRIPTION#" />
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 et 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 se trouve la rubrique actuelle. Le contenu par défaut du fichier gabarit maître entoure cet espace réservé avec étiquettes <div>, <table> et <ul>, qui spécifient les classes CSS requises pour afficher la liste des hyperliens sous forme de contrôle de navigation. Si vous souhaitez supprimer le contrôle de navigation, 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 « Précédent » et « Suivant », vous devez supprimer l'intégralité du fragment tableau qui commence par < tableau class = "hnavright" >
PREV_LINK_CLOSE	Cet espace réservé est remplacé par du code HTML qui ferme l' étiquette 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 « Précédent » et « Suivant », vous devez supprimer l'intégralité du fragment tableau qui commence par < tableau class = "hnavright" >
NEXT_LINK_CLOSE	Cet espace réservé est remplacé par du code HTML qui ferme l' étiquette qui est 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 d'un élément « HelpTopic », en utilisant le fichier gabarit correspondant au type de chaque élément enfant et construit une string HTML unique qui englobe tout le contenu du modèle pour la rubrique d'aide actuelle.
NAVIGATION	Cet espace réservé est remplacé par une liste d'hyperliens, qui génère un menu sur le côté gauche de la page Web, prenant en charge la navigation vers les rubriques d'aide sœurs de la rubrique actuelle. C'est-à-dire les rubriques qui se trouvent 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 disponibles dans le fichier gabarit nommé " HelpTopic .html ». Vous pouvez modifier le contenu de ce fichier si vous en avez besoin, 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 avec 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 gabarit " HelpTopic .html » utilise le nom de la rubrique d'aide comme titre 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 gabarit " HelpTopic .html » affiche les Notes de la rubrique d'aide immédiatement après le titre 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 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 « retour chariot ».

HelpSection

Le tableau suivant décrit l'utilisation des espaces réservés de contenu disponibles dans le fichier gabarit nommé " HelpSection .html ». Vous pouvez modifier le contenu de ce fichier si vous en avez besoin, 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 avec 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 gabarit restitue le nom de l'élément comme 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 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 disponibles pour une utilisation dans l'ensemble de fichiers gabarit nommés " HelpTableNN .html ». Vous pouvez modifier le contenu de ces fichiers si vous en avez besoin, mais nous vous recommandons de les utiliser sans modification - du moins pour commencer.

Vous ne pouvez pas renommer ces fichiers gabarit : le générateur d'aide s'attend à trouver un fichier avec un nom correspondant au type de tableau en cours de traitement.

Le contenu par défaut de ces fichiers gabarit est construit de telle sorte que le nom de l'élément apparaisse comme un en-tête, suivi de toutes notes associées à l'élément, puis le tableau suit avec les en-têtes de colonnes en haut, et le contenu des lignes tableaux suit en dessous.

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 gabarit restitue le nom de l'élément comme 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 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 tableau . Il comprend des 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 les 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 disponibles dans le fichier gabarit nommé " HelpTableRow .html ». Vous pouvez modifier le contenu de ce fichier si vous en avez besoin, 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 avec 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 gabarit affiche le nom de l'élément dans la première cellule (la plus à gauche) de la ligne 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 gabarit restitue les Notes dans la deuxième cellule de la ligne tableau .
ROWS_LINKS	Cet espace réservé est disponible pour une utilisation uniquement dans les fichiers gabarit pour tableaux à trois colonnes. Il est remplacé par des hyperliens générés à partir des données contenues dans les valeurs marquées « Voir aussi » de l'élément de ligne tableau en cours de traitement. Le contenu par défaut de ce fichier gabarit restitue les hyperliens « Voir aussi » dans la troisième cellule de la ligne tableau .

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 gabarit affiche le nom de l'élément dans la première cellule (la plus à gauche) de la ligne 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 gabarit restitue les Notes dans la deuxième cellule de la ligne tableau .

ROWS_LINKS

Cet espace réservé est disponible pour une utilisation uniquement dans les fichiers gabarit pour tableaux à trois colonnes.

Il est remplacé par des hyperliens générés à partir des données contenues dans les valeurs marquées « Voir aussi » de l'élément de ligne tableau en cours de traitement.

Le contenu par défaut de ce fichier gabarit restitue les hyperliens « Voir aussi » dans la troisième cellule de la ligne tableau .

HelpSectionLearnMore

Le tableau suivant décrit l'utilisation des espaces réservés de contenu disponibles dans le fichier gabarit nommé " HelpSectionLearnMore .html ». Vous pouvez modifier le contenu de ce fichier si vous en avez besoin, 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 avec 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 gabarit restitue le nom de l'élément comme un en-tête pour le contenu généré à partir de l'élément. En règle générale, l'élément s'appellerait " 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 gabarit affiche les Notes de l'élément immédiatement après l'en-tête de l'élément.

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 gabarit restitue le nom de l'élément comme un en-tête pour le contenu généré à partir de l'élément.

En règle générale, l'élément s'appellerait " 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 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 au contenu utilisés dans le fichier gabarit nommé " HelpSlideshow .html ". Le contenu par défaut du fichier gabarit " HelpSlideshow .html " organise le contenu HTML généré sous forme de tableau comportant une seule ligne et 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 de titre, avec l'élément Notes placé sous le titre. Vous pouvez modifier le contenu de ce fichier si vous en avez besoin, 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 avec 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 étiquettes 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 de diaporama.
FIRST_LB_IMAGE_END	Cet espace réservé est remplacé par un code HTML qui ferme l' étiquette de la première image du diaporama
TAGGED_VALUES_IMAGE	Cet espace réservé est remplacé par un 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 gabarit restitue 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 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 disponibles dans le fichier gabarit nommé " HelpSystemVideo .html ». Vous pouvez modifier le contenu de ce fichier si vous en avez besoin, 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 avec ce nom.

Nom de l'espace réservé	Description
VIDEO_TITLE	Cet espace réservé est remplacé par la valeur de la valeur 'VideoTitle' de l'élément. Le contenu par défaut de ce fichier gabarit affiche le titre sous forme d'en-tête au-dessus du contrôle vidéo HTML.
VIDEO_URL	Cet espace réservé est substitué par la valeur de valeur de l'élément nommée 'VideoURL'. Il est utilisé dans l' étiquette HTML 'video', pour fournir la valeur URL de l'attribut 'src' de l' étiquette 'source'. Le contenu par défaut de ce fichier gabarit affiche un contrôle vidéo pleine largeur. Lorsque le bouton « play » est cliqué, le contrôle charge et lit le fichier vidéo trouvé à l'URL spécifiée.
VIDEO_TYPE	Cet espace réservé est substitué par la valeur de la valeur 'VideoType' de l'élément. Il est utilisé dans l' étiquette HTML 'video' pour fournir une valeur pour l'attribut 'type' de l' étiquette 'source'.

Nom de l'espace réservé

Description

VIDEO_TITLE

Cet espace réservé est remplacé par la valeur de la valeur 'VideoTitle' de l'élément. Le contenu par défaut de ce fichier gabarit affiche le titre sous forme d'en-tête au-dessus du contrôle vidéo HTML.

VIDEO_URL

Cet espace réservé est substitué par la valeur de valeur de l'élément nommée 'VideoURL'. Il est utilisé dans l' étiquette HTML 'video', pour fournir la valeur URL de l'attribut 'src' de l' étiquette 'source'.

Le contenu par défaut de ce fichier gabarit affiche un contrôle vidéo pleine largeur. Lorsque le bouton « play » est cliqué, le contrôle charge et lit le fichier vidéo trouvé à l'URL spécifiée.

VIDEO_TYPE

Cet espace réservé est substitué par la valeur de la valeur 'VideoType' de l'élément. Il est utilisé dans l' étiquette HTML 'video' pour fournir une valeur pour l'attribut 'type' de l' étiquette 'source'.

HelpVideoLocal

Le fichier gabarit ' HelpVideoLocal .html ' 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 disponibles dans le fichier gabarit nommé " HelpSectionDiagram .html ». Vous pouvez modifier le contenu de ce fichier si vous en avez besoin, 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 avec ce nom.

Nom de l'espace réservé	Description
IMAGE_LOCATION	Cet espace réservé est remplacé par le nom du chemin généré pour l'image diagramme . Le code HTML généré inclut uniquement le nom du chemin du fichier contenant l'image diagramme . Il n'inclut pas le nom de l'élément ni notes .

Notes

Les espaces réservés au contenu dans les fichiers 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.