Gabarits pour générer des PDF

Enterprise Architect fournit un ensemble de gabarits de documents que vous pouvez utiliser lors de la génération de fichiers PDF à partir de vos modèles d'aide, afin que vous puissiez commencer immédiatement. Les gabarits fournis sont des gabarits 'système' et ne peuvent donc pas être modifiés. Cependant, vous êtes libre de les copier et de les enregistrer en tant que gabarits "personnalisés", que vous pouvez ensuite modifier comme bon vous semble. Lorsque vous spécifiez les gabarits à utiliser pour la génération de documents, vous êtes libre de choisir parmi les gabarits système ou vos propres gabarits personnalisés.

Pour plus d'informations sur la création de nouveaux gabarits document, consultez la rubrique d'aide Tout sur les Gabarits de document .

Types Gabarit

La boîte de dialogue ' Générer Documentation' comporte quatre champs dans lesquels vous pouvez spécifier différents gabarits . Les champs sont étiquetés Gabarit , Page de couverture, Tableau des matières et Feuille de style. Les gabarits spécifiés dans chacun de ces champs servent un objectif spécifique, comme décrit ci-dessous.

Document Gabarit

Le gabarit principal du document est utilisé pour définir le contenu et la disposition du corps du document généré. Il est précisé dans le champ ' Gabarit ' du dialogue ' Générer Documentation ' . Le gabarit du système 'Guide de l'utilisateur' a été fourni comme point de départ pour vous. Il fait appel au fragment de gabarit 'Help Gabarit Selector'. Le gabarit de sélecteur gabarit à son tour quels fragments de gabarit sont utilisés pour restituer les différents types d'éléments qui composent un modèle d'aide.

Couverture Gabarit

Ce gabarit définit le contenu et la disposition de la page de garde de votre document. Elle est précisée dans le champ 'Page de garde'. Si vous ne souhaitez pas générer de page de garde pour votre document, vous pouvez choisir ' <none> ' au lieu d'un nom de gabarit . Le gabarit du système 'User Guide Cover' a été fourni comme point de départ pour vous. Le gabarit 'User Guide Cover' applique divers styles de mise en forme au texte et aux champs qu'il utilise. Ces styles sont définis dans le gabarit de la feuille de style.

Tableau des matières Gabarit

Ce gabarit qui définit le contenu et la disposition de la page Tableau des matières pour votre document. Il est précisé dans le champ ' Tableau des Contenus'. Si vous ne souhaitez pas générer un tableau de page de contenu pour votre document, vous pouvez choisir ' <none> ' au lieu d'un nom de gabarit . Le gabarit du système 'User Guide TOC' a été fourni comme point de départ pour vous. Le gabarit 'User Guide TOC' applique divers styles de mise en forme au texte et aux champs qu'il utilise. Ces styles sont définis dans le gabarit de la feuille de style.

Feuille de style Gabarit

Un gabarit de feuille de style est utilisé pour définir les styles de formatage des caractères et des paragraphes. Ces styles peuvent ensuite être utilisés par les différents gabarits de 'contenu' pour appliquer différents styles de formatage à des sections spécifiques des documents générés. Le gabarit de la feuille de style est spécifié dans le champ 'Feuille de style' de la boîte de dialogue 'Documentation Générer '. Le gabarit système 'Styles du guide de l'utilisateur' vous a été fourni comme point de départ. Il définit un grand nombre de styles, tels que Heading1, Heading2, CoverHeading1, CoverHeading2, Help Element Header, Help Section Header, TableHeading, TableText et Normal, qui sont utilisés par (référencés par) les autres gabarits de l'ensemble fourni. Vous pouvez également choisir <none> , ce qui vous donnera un ensemble réduit de styles standard, tels que Normal, Heading1, Heading2, etc. Note cependant que les différents gabarits fournis utilisent plusieurs styles non standard définis dans 'User Guide Styles'. Il est donc recommandé d'utiliser le gabarit de feuille de style fourni, au moins jusqu'à ce que vous compreniez bien comment tous les gabarits s'emboîtent et quels styles de formatage vous utilisez. Comme tous les autres gabarits , vous pouvez copier et enregistrer 'User Guide Styles' en tant que gabarit personnalisé, puis le modifier ensuite comme bon vous semble. Vous pouvez modifier les styles de mise en forme qu'il définit pour utiliser une mise en forme de paragraphe, des polices, une taille de texte ou une couleur différentes. Vous pouvez également ajouter ou supprimer des styles dans les définitions existantes.

Sélecteur Gabarit

Le document gabarit 'Guide de l'utilisateur' utilise le gabarit selector facilité d' Enterprise Architect . Il fait appel au fragment de gabarit 'Help Gabarit Selector', qui à son tour spécifie quels fragments de gabarit sont utilisés pour restituer les différents types d'éléments qui composent un modèle d'aide. Il existe un fragment de gabarit distinct correspondant à chacun des éléments stéréotypés disponibles dans le profil UML 'HelpSystem', à l'exception de HelpTableRow . Le gabarit de sélecteur a une entrée pour (presque) chaque classe stéréotypée définie dans le profil 'HelpSystem'. Les exceptions sont HelpTableRow , HelpSectionLearnMore , HelpSlideshow et HelpSystemVideo . Les HelpTableRows sont gérées comme des éléments enfants dans chacun des fragments de gabarit HelpTable , elles n'ont donc pas besoin d'une entrée dans le sélecteur gabarit . Chez Sparx Systems , nous ne générons pas les éléments HelpSectionLearnMore dans les documents PDF, car ils contiennent généralement des hyperliens vers des rubriques d'aide connexes. Les hyperliens générés fonctionnent bien dans les fichiers HTML générés, mais pas dans les documents PDF. De même, les diaporamas et les vidéos fonctionnent bien dans les pages Web HTML, mais pas tellement dans les documents PDF. Si vous souhaitez générer du contenu dans vos documents PDF pour des éléments de ces types, ajoutez simplement une entrée au sélecteur gabarit , en suivant le format des entrées existantes.

Pour plus d'informations, consultez la rubrique d'aide Comment définir un fragment de sélecteur Gabarit .

Fragments Gabarit

Il existe un fragment de gabarit distinct correspondant à chacun des éléments stéréotypés disponibles dans le profil UML 'HelpSystem', à l'exception de HelpTableRow . Le HelpTableRow est géré comme un élément enfant dans chacun des gabarits HelpTable Les fragments de gabarit appliquent différents styles de formatage au texte et aux champs qu'il utilise. Ces styles sont définis dans le gabarit de feuille de style 'User Guide Styles'.

Les gabarits fournis sont des gabarits 'système' et ne peuvent donc pas être modifiés. Cependant, vous êtes libre de les copier et de les enregistrer en tant que gabarits "personnalisés", que vous pouvez ensuite modifier comme bon vous semble.