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.

Il est supposé que vous avez lu la rubrique d'aide Création de 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 l' Assistant de Modèle ( Page Démarrage , onglet 'Créer à partir de Motif '), cliquez sur l'icône et sélectionnez le Profil d'aide.

Révision les modèles répertoriés dans le panneau de gauche, sélectionnez celui qui convient le mieux à votre page d'aide, puis cliquez sur le bouton Modèle un ou plusieurs modèles.

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 /Help Paquetage pour contenir cette rubrique.
Faites glisser l'icône HelpPackage de la Boîte à outils sur le Paquetage sélectionné dans le Navigateur et, dans la boîte de dialogue 'Nouveau Paquetage ', donnez un nom au nouveau HelpPackage .
Faites glisser l'icône HelpTopic ou HelpTopicProxy de la Toolbox vers le nouveau HelpPackage dans le Navigateur .
Faites glisser l' HelpSection , HelpTopic ou autre élément d'aide appropriée de la boîte à outils vers la rubrique d'aide 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 du Navigateur et positionnez-la à la fin de l'ensemble d'éléments.

Après avoir configuré la structure, vous pouvez ensuite ajouter le contenu et définir les Valeur Étiquetés et les propriétés éventuellement requises. Vous pouvez utiliser la fenêtre Notes sur 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.

Alors que vous pouvez utiliser la fenêtre Notes seule pour commencer, il est de loin 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 au sujet 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 sur 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éation d'éléments d'aide

Chaque élément Help est un élément Class modifié par un stéréotype. S'il vous arrive de faire glisser le mauvais élément d'aide dans une structure d'aide, ou si vous changez d'avis sur la façon 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 faire ça:

Cliquez sur l'élément puis allez dans la fenêtre Propriétés de l'élément.
Dans le champ 'Stéréotype', cliquez sur l'icône de et, dans la boîte de 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 de dans le champ "Stéréotype" et décochez la case correspondant au 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 toute 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 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 dans une hiérarchie de Paquetages parent et enfant 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 fil d'Ariane en haut de la page et un menu comme une liste de liens vers des sujets enfants sur la gauche de la page. Note que les paquets de niveau paquetages dans une hiérarchie d'aide (en fait les nœuds 'Chapitre'; par exemple, dans la propre aide d' Enterprise Architect , ' Modélisation Languages') doivent avoir le drapeau d'ingénierie de code ' Namespace Root' défini. 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 Namespace Root 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 marqué comme racine d'espace de Namespace . Au minimum, un seul paquetage de niveau paquetage doit être marqué comme racine d'espace de Namespace . La racine de l'espace de 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 le Paquetage comme racine de l'espace de Namespace ". Le HelpPackage n'est pas directement généré en tant qu'aide, mais agit plutôt comme conteneur pour le HelpTopic et ses propres éléments enfants. Il est important que les éléments Help Paquetage et Help Topic partagent le même nom.
HelpTopic	Un élément HelpTopic correspond à une page HTML. Il est important que la propriété HelpTopic 'Alias' 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 tout le système d'aide et ne doit pas inclure l'extension. Par exemple, 'requirements_management' (sans les guillemets) est un alias valide et fournira le nom de fichier 'requirements_management.html' lors de sa génération. L'élément HelpTopic contient généralement un texte d'introduction (dans le champ de l'élément ' Notes ') 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 . Le HelpTopic peut être le parent de la plupart des autres éléments d'aide, à 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 de HelpPackage . Vous donnez à HelpTopicProxy son propre nom de rubrique et son alias approprié. Dans la fenêtre Propriétés de l'élément, pour le 'refTopic' Valeur Étiquetée , vous cliquez sur l'icône de et recherchez et sélectionnez le 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 au sein d'une page, traitant d'un sujet particulier. Le nom de HelpSection apparaîtra comme titre et les notes d'é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 plus d'un élément 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 Gestionnaire de Spécification . Vous pouvez intégrer des liens vers des diagrammes et des captures d'écran dans le contenu de la section d' 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é en avant-dernier dans le HelpTopic (avant la section « En savoir plus », le cas échéant), contenant une liste à puces de points supplémentaires sur le sujet du sujet, comme quel Des autorisations Enterprise Architect ou de SGBD peuvent être requises pour effectuer une tâche.
HelpSectionProxy	Semblable à HelpTopicProxy , un 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 a son propre nom d'élément. Dans la fenêtre Propriétés de l'élément, pour la 'refSection' Valeur Étiquetée , vous cliquez sur l'icône de et recherchez et sélectionnez la 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 ; tous les éléments ou constructions qui apparaissent dans le diagramme n'apparaîtront pas dans les documents HTML, Web ou PDF eux-mêmes. Cela permet la création de diagrammes explicatifs sans avoir à insérer chaque élément représenté dans le document d'aide lui-même. Les éléments du diagramme seront cependant listés dans la fenêtre Navigateur et 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 le fait de fournir 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 les diagrammes autonomes qui illustrent des 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 conservé 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 lira une vidéo dans le navigateur Web dans lequel l'aide est affichée. Cela permet d'inclure de courtes vidéos "Comment faire" à partir de votre site Web, qui peuvent être lancées à partir de l'aide en ligne. Après avoir donné un nom à l'élément, vous mettez en place cette 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 de , localisez et sélectionnez l'URL pour lire la vidéo ; l'URL peut être une valeur absolue ou valeur , 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 de 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 valeur , elle est insérée dans le document généré sans modification Note que les valeurs Duration 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	Semblable à l'élément HelpSystemVideo , l'élément HelpSlideshow permet à l'utilisateur de exécuter un diaporama d'écrans statiques décrivant les étapes d'un processus, ou des exemples de sortie, ou d'autres images illustrant le sujet de la rubrique d'aide. Encore une fois, vous fournissez un nom pour l'élément, et complétez ces Valeur Étiquetés : Icône - cliquez sur l'icône de et recherchez 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 de et localisez et sélectionnez l'image dans le gestionnaire d'images qui représente la DERNIÈRE diapositive à afficher ; voir l'explication sous cette liste RefDiagramme - À définir La définition HelpSlideshow inclut la Valeur Étiquetée 'Image1'. Si vous avez l'intention d'avoir un diaporama de plus d'une image, vous allez dans l'onglet 'Tags' de la fenêtre Propriétés et créez-y d'autres Valeur Étiquetés . Vous avez deux options : Créez autant d''Image1' Valeur Étiquetés 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 la séquence de haut en bas, alors ajoutez peut-être simplement la Valeur Étiquetés premier et ajoutez les images de diapositives dans la séquence requise quand vous avez fini. Comme ce sont tous 'Image1' Valeur Étiquetés et une partie de la définition, ils apparaîtront dans l'onglet 'Élément' dans la section stéréotype Valeur Étiquetés , dans l'ordre du plus récent au plus ancien (si ce n'est pas le cas, cliquez sur l'élément et cliquez sur à nouveau dessus). Créez jusqu'à quatre Valeur Étiquetés du type HelpSystem::Image2 jusqu'à HelpSystem::Image5. Ajoutez la première image de votre diaporama à 'Image2' Valeur Étiquetée , et 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 les Valeur Étiquetés sont traitées par nom de balise dans l'ordre alphanumérique, de sorte que les balises HelpSlideshow seront traitées de ' HelpSystem ::Image2' à 'HelpSystem::Image5' à ' Ic on' à ' Im age1'. C'est pourquoi l'Image1 Valeur Étiquetée 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 par ordre alphanumérique.
HelpTable	Les éléments HelpTable sont disponibles dans une variété de formats, selon le stéréotype attribué. Les noms de colonne sont appliqués à l'aide de Valeur Étiquetés dans la fenêtre Propriétés . Dans les 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 de tableau et de leurs stéréotypes est fournie dans la rubrique Help System Tableaux .
HelpTableProxy	Un HelpTableProxy duplique le contenu et la définition d'un HelpTable existant dans une rubrique d'aide différente, de n'importe quel style et format. Cela inclut tous les éléments HelpTableRow et HelpTableRowProxy que la HelpTable existante peut avoir. L'élément HelpTableProxy ne peut être que l'enfant d'un HelpTopic et ne peut pas lui-même avoir d'éléments enfants. Après avoir donné un nom à l'élément, dans la fenêtre Propriétés de l'élément, sélectionnez la 'refTable' Valeur Étiquetée , cliquez sur l'icône de et localisez 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 . Généralement, 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 différentes Valeur Étiquetés définies dans la fenêtre Propriétés qui prennent en support différents types d'en-tête de ligne et de contenu de colonne. Ceux-ci sont: 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 de et localisez et sélectionnez l'image dans le gestionnaire d'images Si vous voulez avoir un titre de ligne et une image, donnez à l'élément HelpTableRow ce titre comme nom Lytebox - À définir ImageArtifact - si vous souhaitez ajouter une image contenue dans un Image Artifact à 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 de et localisez et sélectionnez l'image dans votre fichier le navigateur ImageLink - cliquez sur l'icône de et localisez et sélectionnez la rubrique d'aide qui s'affiche lorsque l'utilisateur clique sur l'image SeeAlso - 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 pour le type de tableau ) Note que ces liens ne peuvent être que vers des éléments HelpTopic , pas vers un autre type d' object ; si vous avez besoin d'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ées dans le tableau dans le même ordre qu'elles sont listées 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 le 'refTableRow' Valeur Étiquetée , cliquez sur l'icône de et localisez et sélectionnez le 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 le HelpTopic afin de ne pas détourner l'attention du contenu présenté dans le corps du 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 matériel, plus près du début de la page d'aide. Dans l'aide Enterprise Architect , la section consiste généralement en une simple liste à puces d'hyperliens vers d'autres rubriques d'aide ou vers des sites Web pertinents. Cependant, vous pouvez ajouter un texte explicatif si nécessaire, ou omettre la section s'il n'y a pas de points de référence autres que ceux déjà liés dans le reste du sujet. Le générateur PDF ignore cet élément, de sorte que 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 :

ReportAlias
Auteur du rapport
ReportCoverImage
ReportKeywords
Producteur de rapport
État du rapport
ReportSubject
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ément standard, sont collectivement appelées constantes de 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 répertoriées ci-dessus, ReportAuthor, ReportCoverImage, ReportKeywords, ReportStatus, ReportSummary, ReportTitle et ReportVersion sont disponibles pour être inclus 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 sous forme de champs dans gabarits de votre document. Elles apparaissent sous le menu ' Rapport Constants' lorsque vous cliquez-droit dans l'éditeur gabarit . En règle générale, ils seraient utilisés 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. Ce sont : Nom, Alias, Mots clés, Statut et Version. Si les valeurs de l'une de ces propriétés de stéréotype sont vides, les champs de document utiliseront à leur place les valeurs de propriété d'élément standard correspondantes.

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 de 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.