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 document
Élément racine
Paquetage racine

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

S'il s'agit de l'é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 à signaler ; c'est-à-dire l'élément racine ou le Paquetage racine .

Sortie vers fichier

Type ou sélectionnez l'emplacement et le nom de fichier de la documentation générée.

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

Entrez 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 des 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 de gabarit pour le gabarit spécifié , dans l' ordre Gabarits personnalisés > Gabarits technologiques > Gabarits Gabarits . S'il existe différents gabarits 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 garde à 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 < valeur <none> pour ne pas inclure de page de garde, ou pour utiliser une page de garde 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 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 de table des matières standard ou d'un format conçu par l'utilisateur.

Utilisez la valeur par défaut < valeur <none> pour ne pas inclure de Tableau de contenu ou pour utiliser un tableau de contenu 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 Diagramme de 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 boîte de dialogue « Apparence par défaut », cette apparence remplace les paramètres du thème.

L'option par défaut est le thème du 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 après la génération du rapport.

Supprimer les 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 "Section de suppression" de la Générer de dialogue "Documentation générale".

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 sur la génération.

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

Filigrane

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

Laver l'image

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 de ne pas nuire au contenu du rapport imprimé 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 boîte de dialogue 'Gérer les Options du Modèle ' ('Paramètres > Modèle > Options').

Lorsque le document est généré, le générateur inclut dans le document toutes les Notes , les noms object et les 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é d'image

Cliquez sur la flèche déroulante et sélectionnez le niveau d'échelle requis pour reproduire les images du 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 le document à la fin

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

Utiliser des substitutions de langue

Cochez cette case pour activer les substitutions de mots de langue personnalisées.

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

Termes du glossaire 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 des Notes d'un élément.

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

Utiliser la substitution de glossaire

(Disponible si Termes du glossaire de balisage est sélectionné.)

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 par les significations ' Corporate ', ' Unified ' et ' Ultimate ', respectivement.

Lot

Cliquez sur ce bouton pour afficher la boîte de dialogue "Génération de documents par lots", afin de générer des rapports dans un traitement par lots.

Utiliser le visualiseur interne

Cochez cette case pour permettre au bouton Vue de lancer le document généré dans le visualiseur interne Enterprise Architect .

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

Diagramme tous les éléments du diagramme dans Rapport

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

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

Si des éléments externes doivent être inclus uniquement pour des 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 , cochez la case "Ajouter chaque élément contenu dans la documentation" dans le diagramme Propriétés.

Lorsque les deux options sont désélectionnées, ou lorsqu'aucun des ' Paquetage . Les cases Diagramme .Element' ou ' Paquetage .Element' sont cochées dans le gabarit , seuls les éléments du Paquetage courant sont documentés.

Progrès

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

Document ressource

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 éditer le gabarit actuellement sélectionné à l'aide de l'éditeur Document Gabarit .

Vous ne pouvez modifier que les gabarits définis par l'utilisateur, pas les gabarits standard 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 du 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
• Le visualiseur interne Enterprise Architect , si vous avez coché la case "Utiliser le visualiseur interne"

Avorter

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