Générer des fichiers PDF

Après avoir créé un modèle d'aide dans Enterprise Architect , vous pouvez générer des fichiers PDF à partir du modèle. Le générateur PDF inclut le contenu du paquetage sélectionné et inclut de manière récursive le contenu de tous ses paquetages enfants. Vous pouvez ainsi produire un seul grand document couvrant l'ensemble de votre modèle d'aide ou des documents plus petits qui couvrent uniquement les rubriques sélectionnées dans votre modèle.

Il est également possible de sauvegarder un « Document ressource » associé à un paquetage , afin de pouvoir facilement régénérer le document PDF associé à un paquetage à 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 la HelpTopic pour laquelle générer un fichier PDF et d'appeler la commande « Générer la documentation ». Dans le dialogue qui s'affiche, spécifiez 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.

Étape	Description	Voir aussi
Sélectionnez le Paquetage	À l'aide de la fenêtre Navigateur , recherchez et sélectionnez le Paquetage contenant votre rubrique. Note que le générateur de documents (ainsi que le générateur HTML) génère du contenu de manière récursive, vous pouvez donc choisir de créer un ensemble de Paquetages à partir d'un parent commun ou de créer une rubrique à feuille unique selon vos besoins.
Ouvrir le générateur de documents	Une fois que vous avez sélectionné un Paquetage , soit : Appuyez sur F8 ou Sélectionnez l'option 'Publier > Rapports de Modèle > Générateur de Rapports > Générer Documentation' ou (Si vous éditez votre sujet dans le Gestionnaire de Spécification ) sélectionnez l'option « Spécification-Spécifier > Élément > Documentation > Générer la documentation (DOCX, PDF, RTF) » Ces options affichent la dialogue ' Générer Documentation'. Une différence importante dans la troisième méthode est que le Gestionnaire de Spécification va créer un document non récursif, ce qui signifie que seuls les éléments du Paquetage actuel seront générés. Ceci est idéal pour tester Paquetages de haut niveau sans avoir besoin de générer Paquetages enfants en même temps.
Définir Type et le nom du fichier	Dans la dialogue « Générer la documentation », vérifiez le nom et le chemin du fichier de sortie et modifiez-les 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 « Guide de l'utilisateur » dans la liste déroulante « Gabarit » et le gabarit « Styles du guide de l'utilisateur » dans la liste déroulante « Feuille de style ». Vous pouvez également sélectionner « Couverture du guide de l'utilisateur » dans la liste déroulante « Page de couverture » et « Table des matières 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 existe quelques options supplémentaires à sélectionner avant de créer le document PDF. 1. Sur la première page de la 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 garantit que tous diagrammes rendus « à la volée » excluront les éléments désignés comme non imprimables. Ceci est important si vous avez placé notes explicatives sur diagrammes , que vous souhaitez supprimer dans la sortie PDF (et HTML).
Créer un document PDF	Une fois tout paramétré, cliquez sur le bouton Générer pour créer le fichier PDF.
Vue et Vérification	Une fois le document créé avec succès, vous pouvez immédiatement l'afficher en appuyant sur le bouton Vue . Examinez attentivement le document pour détecter les espaces verticaux excessifs ou manquants, l'utilisation inappropriée de tableaux , les images mal rendues, la mauvaise lisibilité, la mauvaise grammaire et d'autres erreurs évidentes qui gâchent l'effet global. Si nécessaire, revenez à la HelpTopic et corrigez les problèmes en suspens, puis régénérez-la et confirmez que la correction a été efficace.

Documents de référence

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 d'accès 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 intitulé 'Document Ressource' dans le coin supérieur droit de la fenêtre ' Générer un Document'. Donnez un nom au nouveau Document Ressource, 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éveloppez le nœud 'Publication de documents > Rapport Bibliothèque '. Faites un clic droit sur le document ressource enregistré, puis sélectionnez ' Générer un document...' dans le menu. La fenêtre ' Générer un 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 ressources en cliquant sur le bouton « Mettre à jour la ressource ».