| Pré. | Proc. |
Contenu du système d'aide à la création
Le modèle de système d'aide 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 le résultat aux normes et à la présentation propres à votre organisation.
Le format du contenu d'aide source est en grande partie 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 divers formats et styles que vous pouvez imposer lorsque vous rédigez votre texte d'aide, et ceux-ci sont abordés dans les sections de cette rubrique.
Utilisation du Gestionnaire de Spécification
L'outil principal de création de contenu d'aide est le Gestionnaire de Spécification . Il s'agit d'une interface personnalisable de type « 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 :
- 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 comporte un certain nombre de colonnes qui vous aident à vérifier et à gérer 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 affichera uniquement le nom de l'élément et le contenu Notes (le texte d'aide). Vous utilisez l'option de menu contextuel « Sélecteur de champs » 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écifications-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 sur la page du système d'aide afin qu'elle s'ouvre toujours sur cette page.
- « Élément > Déplacer vers le haut » et « Élément > Déplacer vers le bas », qui vous aident à réorganiser la séquence des éléments de niveau homologue
- 'Affichage > Format Notes ', qui vous permet de placer le texte Notes là où il vous convient le mieux de le lire et de le modifier, soit sous le nom de l'élément d'aide ou à sa droite, soit de masquer les en-têtes de colonnes ('Document Vue ')
- « Affichage > Numérotation des Niveaux », qui - dans les structures de sujet 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 de pouvoir développer uniquement le groupe d'éléments sur lequel vous souhaitez travailler (très utile lorsque vous avez plusieurs 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 le rendre plus facile à lire, 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 le formatage et les hyperliens via les options de la barre d'outils de la fenêtre Notes .
Voici quelques raccourcis utiles dans notes :
- Commence ou termine une liste à puces
- démarre 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
Référencement des images
L'utilisation d'images dans le Gestionnaire de Spécification s'effectue à l'aide de la fenêtre Notes normale. Pour créer un lien vers une image, ouvrez la fenêtre Notes et utilisez le bouton Hyperlien de la barre d'outils pour ajouter un lien hypertexte vers une image dans le Gestionnaire d'images (sélectionnez le type de lien hypertexte « Gestionnaire d'images ») ou vers une image contenue dans un diagramme de référence (sélectionnez le type de lien hypertexte « Image d'élément »). Il est également possible d'ajouter un lien hypertexte directement vers un diagramme contenu dans le même projet (sélectionnez le type de lien hypertexte « Image de Diagramme »).
Considérations sur le style et le formatage
Comme vous allez éditer un document qui sera généré ultérieurement, la plupart des considérations de formatage et de style sont déjà traitées automatiquement au moment de la génération. Essayez d'éviter d'appliquer manuellement des caractères gras, italiques, soulignés ou colorés au texte. Utilisez plutôt le glossaire pour baliser systématiquement les termes par catégorie (voir la section suivante 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
Au fur et à mesure que vous ajoutez du contenu, vous verrez peut-être certains termes soulignés. Cela est dû au fait qu'ils sont définis dans le glossaire et qu'ils apparaîtront dans le document d'aide final avec une couleur ou une apparence particulière. Si vous incluez de nouveaux termes pour des éléments d'interface utilisateur, des raccourcis clavier ou des termes spéciaux, il peut être judicieux de les ajouter à la section appropriée du glossaire. Pour ce faire, mettez le terme en surbrillance et utilisez le menu contextuel Créer | Définition du glossaire. Ajoutez le terme à l'emplacement approprié et vérifiez le contenu généré pour vous assurer qu'il apparaît comme prévu.
Le glossaire Modèle joue également un rôle dans la définition de la langue maternelle dans laquelle vous écrivez le texte d'aide, ainsi que de toute autre langue dans laquelle vous le traduisez. Consultez les rubriques d'aide de Translation Facilité .