| Pré. | Proc. |
Contenu du système d'aide à la création
Le modèle de système d'aide d' Enterprise Architect fournit toute la structure, le formatage et les styles dont vous avez besoin pour créer et générer immédiatement des rubriques d'aide qui ressemblent à l'aide Enterprise Architect elle-même. Vous pouvez ensuite modifier le fichier CSS et les gabarits pour adapter la sortie afin de refléter les normes et la présentation de votre organisation.
Le format du matériel d'aide source est largement contrôlé par Enterprise Architect , puis interprété par les générateurs HTML et PDF comme défini par les gabarits et le fichier CSS. Il existe cependant différents formats et styles que vous pouvez imposer lorsque vous écrivez votre texte d'aide, et ceux-ci sont abordés dans les sections de cette rubrique.
Utilisation du Gestionnaire de Spécification
Le principal outil de création de contenu d'aide est le Gestionnaire de Spécification . Il s'agit d'une interface personnalisable « semblable à un document » dans laquelle vous pouvez ajouter et créer du contenu d'aide. Pour ouvrir le Gestionnaire de Spécification , sélectionnez un HelpPackage dans la fenêtre Navigateur , puis soit :
- Appuyez sur
- Cliquez-droit et sélectionnez Gestionnaire de Spécification , ou
- Sélectionnez l'option de ruban Conception > Paquetage > Spécification Vue .
Le Gestionnaire de Spécification a un certain nombre de colonnes qui vous aident à vérifier et à maintenir les propriétés d'un élément d'aide, telles que le Statut, la Priorité et le Stéréotype. Vous pouvez également préférer masquer toutes les colonnes à l'exception de ' Item ', qui n'affichera que le nom de l'élément et le contenu des Notes (le texte d'aide). Vous utilisez l'option de menu contextuel "Field Chooser" pour ajouter des colonnes et faites simplement glisser les en-têtes de colonne hors de la barre d'en-tête pour les masquer.
Lorsque vous ouvrez le Gestionnaire de Spécification , le ruban Spécification-Spécifier s'affiche automatiquement. Les options utiles du ruban incluent :
- 'Élément > Insérer > Afficher la boîte à outils' - affiche la boîte à outils Diagramme , que vous pouvez épingler à la page du système d'aide afin qu'elle s'ouvre toujours sur cette page.
- 'Element > Move Up' et 'Element > Move Down', qui vous aident à réorganiser la séquence des éléments de niveau pair
- 'Affichage > Format Notes ', qui vous permet de placer le texte des Notes là où il vous convient le mieux pour le lire et le modifier, soit sous le nom de l'élément d'aide ou à sa droite, soit de masquer les en-têtes de colonne ('Document Vue ' )
- 'Affichage > Numérotation des Niveaux ', qui - dans les structures thématiques plus complexes - numérote les éléments parents et enfants afin que vous puissiez voir quels éléments sont les enfants de quels parents
- Affichage > Noms en gras', pour mettre en gras les noms des éléments et les rendre plus visibles parmi les blocs de texte
- 'Affichage> Régions réductibles' pour masquer les éléments enfants sous leurs éléments parents, afin que vous puissiez développer uniquement le groupe d'éléments sur lequel vous souhaitez travailler (très utile lorsque vous avez un certain nombre de tableaux , en particulier avec de nombreuses lignes)
- 'Affichage > Taille de Police ', qui vous permet de modifier la taille d'affichage de tout le texte pour en faciliter la lecture, ou d'inclure plus de texte dans la zone de la fenêtre
La fenêtre Notes
La deuxième fenêtre importante pour le développement du texte d'aide est la fenêtre Notes , qui facilite un peu la mise en forme et les liens hypertexte via les options de la barre d'outils de la fenêtre Notes .
Voici quelques raccourcis utiles dans les notes :
- Commence ou termine une liste à puces
- Commence ou termine une liste numérotée
- Activer ou désactiver le gras
- Activer ou désactiver l'italique
- Activer ou désactiver le soulignement
Images de référence
L'utilisation d'images dans le Gestionnaire de Spécification est réalisée en utilisant la fenêtre Notes normale. Pour créer un lien vers une image, ouvrez la fenêtre Notes et utilisez le bouton de la barre d'outils Lien hypertexte pour ajouter un lien hypertexte vers une image dans le gestionnaire d'images (sélectionnez le type de lien hypertexte comme « Gestionnaire d'images ») ou en tant qu'élément d'image contenu dans un diagramme de référence (sélectionnez le type de lien hypertexte comme 'Element Image'). Il est également possible d'ajouter un lien hypertexte directement à un diagramme dans le même projet (sélectionnez le type de lien hypertexte comme ' Image de Diagramme ').
Considérations de style et de formatage
Comme vous allez modifier un document qui sera généré ultérieurement, la plupart des considérations de formatage et de style sont déjà gérées automatiquement au moment de la génération. Essayez d'éviter d'appliquer manuellement du gras, de l'italique, du soulignement ou de la couleur au texte. Utilisez plutôt le glossaire pour baliser systématiquement les termes par catégorie (voir la section ultérieure sur le glossaire).
Lorsqu'une HelpSection ou HelpTable contient beaucoup de code, vous préférerez peut-être formater le texte en monospace. Vous pouvez le faire en sélectionnant l'onglet 'Tags' de la fenêtre Propriétés de l'élément et en ajoutant une nouvelle Valeur Étiquetée 'ContentType' avec la valeur 'basic'.
Le rôle du glossaire
Lorsque vous ajoutez du contenu, vous pouvez voir certains termes soulignés ; en effet, ils sont définis dans le glossaire et apparaîtront dans le document d'aide final avec une couleur ou une apparence spéciale. Si vous incluez de nouveaux termes pour des éléments d'interface utilisateur, des raccourcis clavier ou des termes spéciaux, il se peut que vous deviez les ajouter à la section appropriée du glossaire. Vous pouvez le faire en mettant en surbrillance le terme et en utilisant le menu contextuel pour Créer | Définition du glossaire. Ajoutez le terme à l'endroit approprié et vérifiez votre contenu généré pour vous assurer qu'il s'affiche comme prévu.
Le glossaire du Modèle joue également un rôle dans la définition de la langue maternelle dans laquelle vous écrivez le texte d'aide et de toute autre langue dans laquelle vous le traduisez. Consultez les rubriques d'aide de Translation Facilité .