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

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

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

1. 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).
2. 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'.

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

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.