| Pré. | Proc. |
Génération de fichiers PDF
Après avoir construit un modèle d'aide dans Enterprise Architect , vous pouvez ensuite générer des fichiers PDF à partir du modèle. Le générateur PDF inclut le contenu du paquetage sélectionné ainsi que le contenu récursif de tous ses paquetages enfants. Ainsi, vous pouvez produire un document volumineux couvrant l'ensemble de votre modèle d'aide, ou des documents plus petits qui ne couvrent que des rubriques sélectionnées à partir de votre modèle.
Il est également possible d'enregistrer un 'Document Ressource' associé à un paquetage , afin de pouvoir facilement régénérer le document PDF associé à un paquetage au fur et à mesure que son contenu est mis à jour et révisé au fil du temps.
Étapes pour générer des fichiers PDF
Le processus de génération est aussi simple que de choisir le HelpTopic pour lequel générer un fichier PDF et d'invoquer la commande ' Générer Documentation'. Dans la boîte de le dialogue qui s'affiche, indiquez un nom de fichier de sortie et les gabarits à utiliser, puis cliquez sur ' Générer '.
Le tableau ci-dessous décrit le processus de création d'un document PDF pour un sujet.
Marcher |
Description |
Voir également |
|---|---|---|
|
Sélectionnez le Paquetage |
À l'aide de la fenêtre du Navigateur , recherchez et sélectionnez le Paquetage contenant votre sujet. Note que le générateur de document (ainsi que le générateur HTML) générera du contenu de manière récursive, vous pouvez donc choisir de créer un ensemble de Paquetages en construisant à partir d'un parent commun, ou de créer un sujet feuille unique si nécessaire. |
|
|
Ouvrir le générateur de documents |
Une fois que vous avez sélectionné un Paquetage , soit :
Une différence importante dans la troisième méthode est que le Gestionnaire de Spécification créera un document non récursif, ce qui signifie que seuls les éléments du Paquetage courant seront sortis. C'est idéal pour tester des Paquetages de haut niveau sans avoir besoin de générer des Paquetages enfants en même temps. |
|
|
Définir Type et le nom de fichier |
Dans la boîte de dialogue ' Générer Documentation ', vérifiez le nom et le chemin du fichier de sortie et modifiez-le si nécessaire, en vous assurant que l'extension du fichier de sortie est définie sur .pdf. |
|
|
Sélectionnez Génération Gabarits et feuille de style |
Un ensemble de gabarits système et une feuille de style vous sont fournis. Sélectionnez le gabarit 'User Guide' dans la liste déroulante ' Gabarit ' et le gabarit 'User Guide Styles' dans la liste déroulante 'Stylesheet'. En option, vous pouvez également sélectionner « Couverture du guide de l'utilisateur » dans la liste déroulante « Page de couverture » et « TOC du guide de l'utilisateur » dans la liste déroulante « Tableau des matières ». Si aucune sélection n'est effectuée dans les champs Page de couverture et Tableau des matières, ces éléments ne seront pas générés. |
Gabarits pour générer des PDF |
|
Définir les options de génération |
Il y a quelques options supplémentaires à sélectionner avant de créer le document PDF. 1. Sur la première page de la boîte de dialogue "Génération de documents", cochez l'option "Marquer les termes du glossaire" pour activer la mise en surbrillance automatique des termes du glossaire conformément à la feuille de style CSS, définie avec les définitions du glossaire. 2. Sur la page 'Options', sélectionnez l'option 'Masquer les objets non imprimables'. Cela garantira que tous les diagrammes rendus "à la volée" excluront les éléments désignés comme non imprimables. Ceci est important si vous avez placé des notes explicatives sur des diagrammes que vous souhaitez supprimer dans la sortie PDF (et HTML). |
|
|
Créer un document PDF |
Une fois que tout est défini, cliquez sur le bouton Générer pour créer le fichier PDF. |
|
|
Vue et vérifier |
Une fois le document créé avec succès, vous pouvez l'afficher immédiatement en appuyant sur le bouton Vue . Examinez attentivement le document pour détecter des espaces verticaux excessifs ou manquants, une utilisation inappropriée des tableaux , des images mal rendues, une mauvaise lisibilité, une mauvaise grammaire et d'autres erreurs évidentes qui nuisent à l'effet global. Si nécessaire, revenez à la HelpTopic d'aide et corrigez les problèmes en suspens, puis générez à nouveau et confirmez que le correctif a été effectif. |
Documents ressources
Une fois que vous êtes prêt à générer le document PDF, tous les paramètres de génération tels que le paquetage racine, le chemin du fichier de sortie et les gabarits à utiliser, peuvent être enregistrés pour être réutilisés, en tant que document ressource. Pour enregistrer les paramètres, cliquez sur le bouton 'Document Ressource' en haut à droite de la fenêtre 'Document Générer '. Donnez un nom au nouveau document de ressources, puis cliquez sur OK .
Pour régénérer le document pour ce paquetage , en utilisant les paramètres enregistrés, ouvrez l'onglet Ressources de la fenêtre Navigateur , puis déroulez le nœud 'Édition de documents > Rapport Bibliothèque '. Faites un clic droit sur le Document Ressource enregistré, puis sélectionnez ' Générer Document...' dans le menu. La fenêtre ' Générer Document' s'affiche, renseignée avec tous les paramètres de génération enregistrés.
À ce stade, vous avez la possibilité de modifier les paramètres de génération avant de générer et si vous le souhaitez, toutes les valeurs mises à jour peuvent ensuite être enregistrées dans le document de ressource en cliquant sur le bouton « Mettre à jour la ressource ».