Utilisation des éléments du système d'aide

Cette rubrique explique comment configurer chaque type d’élément d’aide afin qu’il soit généré en tant que composant fonctionnel et utile de la page d’aide.

Nous supposons que vous avez lu la rubrique d'aide Création du système d'aide et que vous savez quels éléments sont disponibles et comment ils s'intègrent dans la structure de la page d'aide.

Configurer la page d'aide

Il existe deux manières rapides de configurer une structure pour une nouvelle rubrique d'aide.

Modèle Motifs

Ouvrez la dialogue Constructeur de Modèle (Ctrl+Maj+M), cliquez sur l'icône et sélectionnez le Profil d'aide.

Révision les motifs répertoriés dans le panneau de gauche, sélectionnez le plus approprié pour votre page d'aide et cliquez sur le bouton Créer Modèle .

Faites glisser depuis la page du système d'aide de la boîte à outils Diagramme vers la fenêtre Navigateur

Sélectionnez le Paquetage / Paquetage d'aide qui contiendra cette rubrique.
Faites glisser l'icône HelpPackage de la boîte à outils sur le Paquetage sélectionné dans le Navigateur et, dans la dialogue « Nouveau Paquetage », donnez un nom au nouveau HelpPackage .
Faites glisser l'icône HelpTopic ou HelpTopicProxy de la boîte à outils vers le nouveau HelpPackage dans le Navigateur .
Faites glisser l'icône HelpSection , HelpTablexn ou autre élément d'aide approprié de la boîte à outils vers HelpTopic dans le Navigateur . Répétez cette opération aussi souvent que nécessaire.
Si vous avez ajouté des HelpTables, faites glisser l'icône HelpTableRow de la boîte à outils vers la HelpTable appropriée dans le Navigateur .
Enfin, si nécessaire, faites glisser l’icône HelpSectionLearnMore de la boîte à outils vers la fenêtre Navigateur et positionnez-la à la fin de l’ensemble d’éléments.

Une fois la structure définie, vous pouvez ajouter le contenu et définir Valeur Étiquetés et propriétés qui pourraient être nécessaires. Vous pouvez utiliser la fenêtre Notes de chaque élément d'aide pour ajouter le texte et la fenêtre Propriétés pour définir les propriétés. La fenêtre Notes vous offre un moyen rapide et flexible d'écrire et de formater du texte.

Bien que vous puissiez utiliser la fenêtre Notes seule pour commencer, il est préférable de l'utiliser en conjonction avec le Gestionnaire de Spécification , qui vous permet de voir la structure et le contenu de la page d'aide au fur et à mesure que vous la créez.

Le Gestionnaire de Spécification est également le meilleur outil pour ajouter d'autres éléments d'aide à la rubrique au fur et à mesure de son développement, en faisant glisser l'icône appropriée de la page du système d'aide de la boîte à outils vers l'élément précédent ou parent dans le Gestionnaire de Spécification . Vous êtes invité à sélectionner si le nouvel élément vient après l'élément existant en tant qu'homologue, ou sous l'élément existant en tant qu'enfant.

Créer des éléments d'aide

Chaque élément d'aide est un élément de classe modifié par un stéréotype. Si vous faites glisser le mauvais élément d'aide dans une structure d'aide ou si vous changez d'avis sur la manière de présenter vos informations, vous pouvez modifier le stéréotype de l'élément existant pour en faire le type d'élément correct. Pour ce faire :

Cliquez sur l'élément puis accédez à la fenêtre Propriétés de l'élément.
Dans le champ « Stéréotype », cliquez sur l'icône et, dans la dialogue « Stéréotype pour le nom de l'élément », faites défiler la liste vers le haut ou vers le bas pour localiser le stéréotype requis et cochez la case correspondante.
Cliquez sur le bouton OK .
Cliquez à nouveau sur l'icône dans le champ « Stéréotype » et décochez la case en regard du stéréotype incorrect.
Cliquez sur le bouton OK .

Note qu'en ajoutant le stéréotype correct avant de supprimer le stéréotype incorrect, vous devez conserver les valeurs de toutes Valeur Étiquetés communes aux deux stéréotypes (comme les en-têtes de colonne), évitant ainsi d'avoir à réinitialiser les valeurs.

N'oubliez pas que Valeur Étiquetés alloué aux stéréotypes par les profils sont répertoriées dans l'onglet « Élément » de la fenêtre Propriétés , et non dans l'onglet 'Tags' .

HelpPackage	Chaque rubrique du système d'aide est représentée par un HelpPackage contenant un élément enfant HelpTopic du même nom. Les HelpPackages sont organisés selon une hiérarchie de Paquetages parents et enfants pour développer la structure des pages d'aide dans le système d'aide. Cette hiérarchie paquetage est ensuite reflétée dans les pages Web générées, via un contrôle de navigation en haut de la page et une liste de liens de type menu vers les rubriques enfants sur la gauche de la page. Note que les paquetages de niveau supérieur dans une hiérarchie d'aide (en fait les nœuds « Chapitre » ; par exemple, dans l'aide d' Enterprise Architect , « Langages Modélisation ») doivent avoir l'indicateur « Racine Namespace noms » défini pour l'ingénierie de code. Lors de la génération de l'aide Web, Enterprise Architect crée des sous-dossiers dans le dossier de sortie spécifié, en utilisant les noms des paquetages Racine Namespace comme noms de dossier. Chaque fichier de rubrique généré est placé dans le sous-dossier créé à partir de son paquetage parent le plus proche qui est marqué comme Racine Namespace . Au minimum, un seul paquetage de niveau supérieur doit être marqué comme Racine Namespace . La Racine Namespace peut être définie en cliquant sur un Paquetage puis en sélectionnant l'option de ruban « Développer > Code source > Options > Définir Paquetage comme Racine Namespace ». Le HelpPackage n'est pas directement généré en tant qu'élément d'aide, mais agit plutôt comme conteneur pour l' HelpTopic et ses propres éléments enfants. Il est important que l'élément Help Paquetage et l'élément Help Topic partagent le même nom.
HelpTopic	Un élément HelpTopic correspond à une page HTML. Il est important que la propriété 'Alias' HelpTopic soit définie sur le nom de fichier requis pour la rubrique d'aide dans la sortie finale générée. L'alias doit avoir un nom unique dans l'ensemble du système d'aide et ne doit pas inclure l'extension. Par exemple, 'requirements_management' (sans guillemets) est un alias valide et fournira le nom de fichier 'requirements_management.html' lors de la génération. L'élément HelpTopic contient généralement un texte d'introduction (dans le champ « Notes » de l'élément) pour expliquer le but du sujet et comment il s'intègre dans toute structure de sujet dont il fait partie. Il ne peut y avoir qu'un seul élément HelpTopic dans un Paquetage . L' HelpTopic peut être le parent de la plupart des autres éléments Help, à l'exception de HelpTopicProxy , HelpTableRow et HelpTableRowProxy .
HelpTopicProxy	Un élément HelpTopicProxy capture le contenu d'un élément HelpTopic existant et de ses éléments enfants, et les duplique sous un autre HelpPackage . Vous insérez donc l'élément HelpTopicProxy en tant qu'enfant du HelpPackage . Vous donnez à HelpTopicProxy son propre nom de rubrique et un alias approprié. Dans la fenêtre Propriétés de l'élément, pour la Valeur Étiquetée 'refTopic', vous cliquez sur l'icône et recherchez et sélectionnez la HelpTopic à dupliquer. Vous n’avez rien d’autre à faire dans les éléments HelpTopicProxy ou HelpPackage .
HelpSection	Un élément HelpSection correspond à un ou plusieurs paragraphes connexes dans une page, traitant d'un sujet particulier. Le nom HelpSection apparaîtra comme titre et les notes de l'élément comme contenu. Une HelpSection ne peut être qu'un enfant d'un HelpTopic et ne peut contenir aucun autre élément. Si vous avez plusieurs éléments HelpSection sous une rubrique, ils apparaîtront dans la page générée dans l'ordre dans lequel ils apparaissent dans la fenêtre Navigateur et dans Gestionnaire de Spécification . Vous pouvez intégrer des liens vers diagrammes et des captures d'écran dans le contenu HelpSection , et ceux-ci seront reproduits dans le contenu Web ou PDF selon les besoins. Un élément HelpSection avec le nom « Notes » est généralement placé avant-dernier dans la HelpTopic (avant la section « En savoir plus », si elle est présente), contenant une liste à puces de points supplémentaires sur le sujet de la rubrique, tels que les autorisations Enterprise Architect ou DBMS qui peuvent être requises pour effectuer une tâche.
HelpSectionProxy	Similairement à HelpTopicProxy , HelpSectionProxy duplique le contenu d'un HelpSection existant. Vous insérez HelpSectionProxy en tant qu'enfant de l'élément HelpTopic , à la position appropriée dans la séquence des éléments homologues HelpSection , HelpSectionProxy , HelpTable et HelpTableProxy sous HelpTopic . Le HelpSectionProxy possède son propre nom d'élément. Dans la fenêtre Propriétés de l'élément, pour la Valeur Étiquetée 'refSection', cliquez sur l'icône et localisez et sélectionnez le HelpSection à dupliquer.
HelpSectionDiagram	Un élément HelpSectionDiagram est utilisé comme espace réservé/conteneur pour un diagramme qui apparaîtra dans l'aide sous forme d'image. Le diagramme doit être construit sous l'élément HelpSectionDiagram ; les éléments ou les constructions qui apparaissent dans le diagramme n'apparaîtront pas dans les documents HTML, Web ou PDF eux-mêmes. Cela permet de créer diagrammes explicatifs sans avoir à intégrer chaque élément représenté dans le document d'aide lui-même. Les éléments du diagramme seront cependant répertoriés dans la fenêtre Navigateur et dans le Gestionnaire de Spécification . Vous pouvez inclure du texte dans cet élément. Comme le diagramme est essentiellement subordonné à l'élément HelpSectionDiagram , le texte appartenant à l'élément s'affichera au-dessus du diagramme . Outre la fourniture d'un nom pour l'élément HelpSectionDiagram , vous n'avez pas besoin de définir de propriétés. Cet élément est généralement utilisé pour diagrammes autonomes qui illustrent fonctionnalités ou des concepts généraux. Si un diagramme ou une image est un exemple d'un point expliqué dans un HelpTopic , HelpSection ou HelpTableRow , vous disposez de mécanismes d'hyperlien dans le texte pour créer un lien vers ce diagramme ou cette image qui se trouve ailleurs dans le modèle ou dans le gestionnaire d'images.
HelpSystemVideo	Un élément HelpSystemVideo est un conteneur pour un contrôle vidéo, qui va lire une vidéo dans le navigateur Web dans lequel l'aide est affichée. Cela permet d'inclure de courtes vidéos explicatives de votre site Web, qui peuvent être lancées à partir de l'aide en ligne. Après avoir fourni un nom à l'élément, vous configurez ce facilité en complétant cet ensemble de Valeur Étiquetés . VideoTitle - Type un titre ou une étiquette pour la vidéo VideoURL - Cliquez sur l'icône et recherchez et sélectionnez l'URL pour lire la vidéo ; l'URL peut être une valeur absolue ou relative, elle est insérée dans le document généré sans modification VideoType - Type le type de fichier ; par exemple, vidéo/mp4 Durée - Type le temps nécessaire à la lecture de la vidéo, en secondes ThumbnailURL - Type l'emplacement de l'icône qui représente la vidéo ; l'URL peut être une valeur absolue ou relative, elle est insérée dans le document généré sans modification Note que les valeurs Durée et ThumbnailURL ne sont pas incluses dans les documents HTML ou PDF générés, elles (avec les autres valeurs) sont écrites dans le fichier « site-map.xml », qui est utilisé pour améliorer le classement de recherche des fichiers de votre site Web.
HelpSlideshow	Similaire à l'élément HelpSystemVideo , l'élément HelpSlideshow permet à l'utilisateur d' exécuter un diaporama d'écrans statiques décrivant les étapes d'un processus, ou des exemples de résultats, ou d'autres images illustrant le sujet de la rubrique d'aide. Là encore, vous fournissez un nom pour l'élément et complétez ces Valeur Étiquetés : Icône - cliquez sur l'icône et localisez et sélectionnez l'image dans le gestionnaire d'images sur laquelle l'utilisateur cliquera pour démarrer le diaporama ; cette image pourrait être un standard pour tous vos diaporamas Image1 - cliquez sur l'icône et recherchez et sélectionnez l'image dans le gestionnaire d'images qui représente la DERNIÈRE diapositive à afficher ; voir l'explication sous cette liste DiagramRef - À définir La définition HelpSlideshow inclut la Valeur Étiquetée « Image1 ». Si vous souhaitez créer un diaporama de plusieurs images, accédez à l'onglet 'Tags' de la fenêtre Propriétés et créez d'autres Valeur Étiquetés . Vous avez deux options : Créez autant Valeur Étiquetés « Image1 » supplémentaires que vous le souhaitez, sans limite. Chaque nouvelle Valeur Étiquetée est ajoutée en haut de la liste et, étant toutes du même nom, elles seront traitées dans l'ordre de haut en bas. Vous pouvez donc simplement ajouter les Valeur Étiquetés en premier et ajouter les images des diapositives dans l'ordre requis lorsque vous avez terminé. Comme il s'agit de toutes Valeur Étiquetés « Image1 » et qu'elles font partie de la définition, elles apparaîtront dans l'onglet « Élément » de la section Valeur Étiquetés du stéréotype, dans l'ordre du plus récent au plus ancien (si ce n'est pas le cas, cliquez sur l'élément et cliquez à nouveau dessus). Créez jusqu'à quatre Valeur Étiquetés du type HelpSystem::Image2 à HelpSystem::Image5. Ajoutez la première image de votre diaporama à la Valeur Étiquetée 'Image2', la suivante à 'Image3', et ainsi de suite. Ces Valeur Étiquetés font partie du profil HelpSystem mais pas de la définition du stéréotype HelpSlideshow , elles sont donc répertoriées dans l'onglet 'Tags' de la fenêtre Propriétés . Toutes Valeur Étiquetés sont traitées par nom étiquette dans l'ordre alphanumérique, donc les étiquettes HelpSlideshow seront traitées de ' H elpSystem::Image2' à 'HelpSystem::Image5' à ' Ic on' à ' Im age1'. C'est pourquoi la Valeur Étiquetée Image1 initiale fournie par défaut lors de la création de l'élément contient toujours la dernière diapositive du diaporama - c'est la plus ancienne et la dernière dans l'ordre alphanumérique.
HelpTable	Les éléments HelpTable sont disponibles dans une variété de formats, en fonction du stéréotype attribué. Les noms de colonnes sont appliqués à l'aide Valeur Étiquetés dans la fenêtre Propriétés . Dans tableaux à trois colonnes, la troisième colonne contient des hyperliens vers d'autres rubriques d'aide (définies dans les éléments HelpTableRow ) et son en-tête par défaut est « Voir aussi » dans le générateur d'aide. Note que les colonnes « Voir aussi » ne sont pas reproduites dans la sortie PDF générée à partir de la source d'aide. Un élément HelpTable ne peut être qu'un enfant d'un élément HelpTopic et ne peut contenir que des éléments enfants HelpTableRow ou HelpTableRowProxy . Une liste complète des formats tableau et de leurs stéréotypes est fournie dans la rubrique Tableaux du système d'aide .
HelpTableProxy	Un HelpTableProxy duplique le contenu et la définition d'un HelpTable existant dans une autre rubrique d'aide, de n'importe quel style et format. Cela inclut tous les éléments HelpTableRow et HelpTableRowProxy que le HelpTable existant peut contenir. L'élément HelpTableProxy ne peut être que l'enfant d'un HelpTopic et ne peut pas avoir d'éléments enfants lui-même. Après avoir donné un nom à l'élément, dans la fenêtre Propriétés de l'élément, sélectionnez la Valeur Étiquetée 'refTable', cliquez sur l'icône et recherchez et sélectionnez la HelpTable que vous souhaitez dupliquer dans la rubrique actuelle.
HelpTableRow	Un élément Help Tableau Row représente une seule ligne dans un tableau . En général, le nom de l'élément devient le titre de la ligne et le champ Notes devient la description de la ligne. Cependant, l'élément possède plusieurs Valeur Étiquetés définies dans la fenêtre Propriétés qui support différents types d'en-têtes de ligne et de contenu de colonne. Il s'agit de : ImageRef - vous pouvez remplacer le texte de l'en-tête de ligne par une image, auquel cas vous utilisez le nom de l'image dans le gestionnaire d'images comme nom d'élément ; cliquez sur l'icône et recherchez et sélectionnez l'image dans le gestionnaire d'images Si vous souhaitez avoir un titre de ligne et une image, donnez ce titre à l'élément HelpTableRow comme nom Lytebox – À définir ImageArtifact - si vous souhaitez ajouter une image contenue dans un artefact d'image à la ligne, ou remplacer le titre de la ligne par cette image (en utilisant les mêmes principes que pour ImageRef), cliquez sur l'icône et recherchez et sélectionnez l'image dans votre navigateur de fichiers ImageLink - cliquez sur l'icône et recherchez et sélectionnez la rubrique d'aide qui s'affiche lorsque l'utilisateur clique sur l'image Voir aussi - vous permet d'ajouter un lien vers une autre rubrique d'aide, dont le nom s'affichera dans la colonne Voir aussi (le cas échéant en fonction du type tableau ) Note que ces liens ne peuvent être que vers des éléments HelpTopic , et non vers un autre type d' object ; si vous devez créer un lien vers un site Web ou une autre URL, créez le lien dans la deuxième colonne, en utilisant le champ Notes Les HelpTableRows sont générés dans le tableau dans la même séquence dans laquelle ils sont répertoriés dans la fenêtre Navigateur .
HelpTableRowProxy	Un élément HelpTableRowProxy duplique le contenu d'un élément HelpTableRow existant ailleurs dans le modèle. Il n'a pas de contenu propre. Comme pour les autres éléments Proxy, après avoir donné un nom à l'élément, dans la fenêtre Propriétés de l'élément, sélectionnez la Valeur Étiquetée 'refTableRow', cliquez sur l'icône , recherchez et sélectionnez l' HelpTableRow que vous souhaitez dupliquer dans le tableau actuel.
HelpSectionLearnMore	L'élément HelpSectionLearnMore est utilisé pour fournir une liste d'hyperliens vers des rubriques connexes qui n'ont pas été liées ailleurs dans la rubrique, ni dans la hiérarchie de l'aide affichée à côté de la rubrique d'aide générée. Il est généralement placé en dernier dans la HelpTopic afin de ne pas détourner l'attention du contenu présenté dans le corps de la HelpTopic . Cependant, s'il y a beaucoup de contenu, comme de longs tableaux de paramètres, d'attributs ou de méthodes, la section En savoir plus peut être insérée au-dessus de ce contenu, plus près du début de la page d'aide. Dans l'aide Enterprise Architect la section se compose généralement d'une simple liste à puces de liens hypertexte vers d'autres rubriques d'aide ou vers des sites Web pertinents. Vous pouvez toutefois ajouter un texte explicatif si nécessaire ou omettre la section s'il n'existe aucun point de référence en plus de ceux déjà liés dans le reste de la rubrique. Le générateur PDF ignore cet élément, donc la liste des liens ne s'affiche pas dans un document PDF.

HelpPackage Valeur Étiquetés pour la génération de PDF

Dans la fenêtre Propriétés d'un HelpPackage vous verrez la liste de propriétés suivante :

RapportAlias
Auteur du rapport
ReportCoverImage
RapportMots-clés
Producteur de rapports
État du rapport
Sujet du rapport
Résumé du rapport
Titre du rapport
Version du rapport

Les propriétés sont stockées sous forme de valeurs balisées, appartenant au stéréotype <<HelpPackage>>.

Ces propriétés, ainsi que certaines propriétés d'éléments standard, sont collectivement appelées constantes Rapport . Les constantes Rapport (lorsqu'elles sont présentes) sont utilisées lors de la génération de documents PDF à partir de votre modèle d'aide.

Parmi les propriétés listées ci-dessus, ReportAuthor, ReportCoverImage, ReportKeywords, ReportStatus, ReportSummary, ReportTitle et ReportVersion sont disponibles pour inclusion dans vos documents générés. Ces propriétés, ainsi que plusieurs propriétés d'éléments standard, peuvent être insérées en tant que champs dans gabarits de votre document. Elles apparaissent sous le menu « Constantes Rapport » lorsque vous cliquez-droit dans l'éditeur gabarit . En général, elles sont utilisées dans un gabarit CoverPage ou dans les sections d'en-tête et de pied de page du gabarit principal du document.

Certaines de ces propriétés ont des noms similaires aux propriétés d'élément standard. Il s'agit de : Nom, Alias, Mots-clés, Statut et Version. Si les valeurs de l'une de ces propriétés stéréotypées sont vides, les champs du document utiliseront les valeurs de propriété d'élément standard correspondantes à leur place.

Une deuxième liste de propriétés légèrement plus petite : ReportAuthor, ReportKeywords, ReportProducer, ReportSubject, ReportTitle, est utilisée pour écrire les métadonnées du fichier PDF généré.

Les valeurs balisées du « paquetage racine » sélectionné pour la génération PDF seront utilisées pour l'ensemble du document. Si le paquetage sélectionné comprend également une série de paquetages enfants, les valeurs balisées des paquetages enfants ne sont pas utilisées lors du rendu de ces rubriques.