Génération de documents de base

Ruban

Publier > Rapports de Modèle > Générateur de Rapports > Générer Documentation > Générer

Raccourcis Clavier

F8 | Générer

Modèle de document
Élément racine
Paquetage de racines

Vérifiez le nom de l'élément sélectionné dans la fenêtre Navigateur , diagramme , Diagramme List, Gestionnaire de Spécification ou Modèle Search.

S'il s'agit d'un élément Modèle Document spécialement créé pour un document virtuel, le champ est « Modèle Document ».

Sinon, ce champ identifie l'élément sélectionné de la hiérarchie sur lequel doit être effectué le rapport, c'est-à-dire l'élément racine ou Paquetage racine.

Sortie vers un fichier

Type ou sélectionnez l’emplacement et le nom du fichier pour la documentation générée.

Cliquez sur le bouton pour accéder à l'emplacement.

Saisissez l’extension de fichier appropriée pour le format de document dans lequel générer le rapport - PDF, RTF ou DOCX.

Gabarit

Cliquez sur la flèche déroulante et sélectionnez le nom du gabarit à utiliser pour votre rapport de document.

Vous pouvez sélectionner n'importe quel gabarit dans la liste déroulante, qui est divisée en gabarits personnalisés (ou utilisateur) et gabarits système. Si vous avez chargé une MDG Technologie contenant gabarits de document, ceux-ci sont également répertoriés sous le nom de la technologie.

Vous pouvez également créer immédiatement un nouveau gabarit , en sélectionnant l'option '<nouveau modèle>'.

Le système vérifie tous les dossiers gabarit pour le gabarit spécifié, dans l'ordre Gabarits personnalisés > Gabarits technologiques > Gabarits système. Si plusieurs gabarits sont disponibles sous le même nom, le système utilise le premier trouvé dans cette séquence.

Page de couverture

Cliquez sur la flèche déroulante et sélectionnez le nom de la définition de page de couverture à appliquer à votre rapport de document.

Vous pouvez sélectionner n'importe quelle définition dans la liste déroulante, qu'il s'agisse d'un format standard ou d'une page conçue par l'utilisateur.

Utilisez la valeur par défaut <none> pour ne pas inclure de page de couverture ou pour utiliser une page de couverture intégrée au gabarit défini par l'utilisateur sélectionné.

Tableau des matières

Cliquez sur la flèche déroulante et sélectionnez le nom de la définition du Tableau des matières à appliquer à votre rapport de document.

Vous pouvez sélectionner n'importe quelle définition dans la liste déroulante, qu'il s'agisse d'un format TOC standard ou d'un format conçu par l'utilisateur.

Utilisez la valeur par défaut <none> pour ne pas inclure de Tableau des matières ou pour utiliser un tableau des matières intégré au gabarit défini par l'utilisateur sélectionné.

Feuille de style

Cliquez sur la flèche déroulante et sélectionnez le nom de la feuille de style à appliquer à votre rapport de document.

Vous pouvez sélectionner n'importe quelle feuille de style dans la liste déroulante, qu'il s'agisse d'une définition standard ou d'un ensemble de styles conçus par l'utilisateur.

Utilisez la valeur par défaut ' <none> ' pour ne pas utiliser de feuille de style et appliquer à la place les styles définis dans le gabarit que vous avez sélectionné dans le champ ' Gabarit '.

Thème Diagramme

Cliquez sur la flèche déroulante et sélectionnez un thème Diagramme pour appliquer la couleur, l'épaisseur de ligne et le style de police aux diagrammes des éléments du rapport, si ces éléments utilisent des valeurs par défaut.

Si un élément a une apparence personnalisée attribuée à l'aide, par exemple, de la dialogue « Apparence par défaut », cette apparence remplace les paramètres du thème.

L'option par défaut est le thème Diagramme que vous avez actuellement défini dans vos options « Local ». Vous pouvez cependant sélectionner n'importe quel autre thème uniquement pour ce rapport. Le paramètre de champ revient à votre thème par défaut une fois le rapport généré.

Supprimer des sections

Cliquez sur la flèche déroulante et sélectionnez dans une liste de profils de suppression que vous ou d'autres utilisateurs du modèle avez créés dans l'onglet « Supprimer la section » de la dialogue « Générer la documentation ».

Chaque profil de suppression définit des sections de rapport qui peuvent être omises lorsque vous générez le rapport actuel. Cela vous aide à personnaliser le rapport pour un public spécifique lors de la génération.

(Vous pouvez également omettre Paquetages enfants de tout rapport généré sur le Paquetage parent ; voir la rubrique d'aide Exclure Paquetage du document et Rapport HTML .)

Filigrane

Type l’emplacement de l’image à utiliser comme filigrane sur le document ou cliquez sur le bouton pour rechercher l’emplacement.

Image de lavage

Si vous avez sélectionné une image en filigrane, cochez cette case pour appliquer un lavis à l'image avant de l'appliquer au document. Cela rend l'image plus claire afin qu'elle ne nuise pas au contenu du rapport imprimé par-dessus.

Langue

Cliquez sur la flèche déroulante et sélectionnez la langue dans laquelle générer le document. La liste des langues disponibles est définie par l'administrateur du Modèle sur la page « Traductions » de la dialogue « Gérer les options Modèle » (Paramètres > Modèle > Options).

Lors de la génération du document, le générateur inclut dans le document toutes Notes , noms object et alias qui ont des traductions dans la langue sélectionnée. Si des champs ne contiennent pas de traduction pour cette langue, le champ de document correspondant reste vide.

Qualité de l'image

Cliquez sur la flèche déroulante et sélectionnez le niveau de mise à l'échelle requis pour reproduire les images diagramme dans le rapport. Cela détermine la qualité visuelle de l'image.

• Brouillon
• Standard (par défaut)
• Haute résolution
• Très haute résolution

Vue du document à l'achèvement

Cochez cette case pour ouvrir le rapport de document dès qu'il a été généré.

Utiliser des substitutions linguistiques

Cochez cette case pour activer les substitutions de mots dans la langue personnalisée.

Décochez la case pour désactiver les substitutions de mots dans la langue personnalisée.

Glossaire des termes de balisage

Cochez cette case pour appliquer, dans l'ensemble du rapport RTF généré, tous les styles appliqués à tous les termes du glossaire via le texte Notes d'un élément.

Un style est appliqué à un terme de glossaire en fonction de son type de terme de glossaire.

Utiliser la substitution du glossaire

(Disponible si les termes du glossaire de balisage sont sélectionnés.)

Cliquez sur la flèche déroulante et sélectionnez un type de terme. Pour tous les termes du glossaire de ce type, chaque fois qu'un terme apparaît dans le rapport, il sera remplacé par sa signification.

Par exemple, si vous sélectionnez un type de terme « édition », dans le rapport les termes « Corp », « Uni » et « Ult » seront remplacés respectivement par les significations « Corporate », « Unified » et « Ultimate ».

Lot

Cliquez sur ce bouton pour afficher la dialogue « Génération de documents par lots », afin de générer des rapports dans un processus par lots.

Utiliser la visionneuse interne

Cochez cette case pour activer le bouton Vue pour lancer le document généré dans la visionneuse interne Enterprise Architect .

Décochez cette case pour activer le bouton Vue pour lancer le document généré dans la visionneuse de fichiers par défaut de MS Windows .

Inclure tous les éléments Diagramme dans Rapport

Cochez cette case pour inclure dans le rapport des éléments provenant de Paquetages externes référencés à partir d'un diagramme , pour chaque diagramme recherché par le rapport ; la case à cocher est sélectionnée par défaut.

Pour inclure les éléments externes dans le document, sélectionnez également les cases à cocher ' Paquetage . Diagramme .Element ' et ' Paquetage .Element ' dans le gabarit courant.

Si des éléments externes doivent être inclus uniquement pour diagrammes spécifiques, décochez cette case et - uniquement pour les diagrammes pour lesquels vous souhaitez inclure des éléments externes dans le rapport - pour chaque diagramme sélectionnez la case à cocher « Ajouter chaque élément contenu dans la documentation » dans les propriétés diagramme .

Lorsque les deux options sont désélectionnées, ou lorsqu'aucune des cases à cocher ' Paquetage . Diagramme .Element ' ou ' Paquetage .Element ' n'est sélectionnée dans le gabarit , seuls les éléments du Paquetage courant sont documentés.

Progrès

Indiquez la progression de la génération du document avec des messages d'état et une barre d'état de plus en plus remplie.

Document de référence

Cliquez sur ce bouton pour enregistrer les options actuellement définies en tant que définition de document.

Ouvrir Gabarit

Cliquez sur ce bouton pour modifier le gabarit actuellement sélectionné à l'aide de l'éditeur de documents Gabarit .

Vous ne pouvez modifier que gabarits définis par l'utilisateur, pas les gabarits standards fournis avec le système. Si vous avez sélectionné un gabarit système, ce bouton est grisé.

Générer

Cliquez sur ce bouton pour générer le document (après avoir défini toutes les options souhaitées, sur tous les onglets de le dialogue ).

Vue

Cliquez sur ce bouton pour lancer le document généré dans :

• La visionneuse de fichiers par défaut de MS Windows , ou
• La visionneuse interne Enterprise Architect , si vous avez coché la case « Utiliser la visionneuse interne »

Avorter

Cliquez sur ce bouton pour annuler la génération du rapport ; une prompt s'affiche pour confirmer l'annulation du rapport.