Gabarits pour générer des PDF

Enterprise Architect fournit un ensemble de gabarits de document 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 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 à votre guise. Lorsque vous spécifiez les gabarits à utiliser pour la génération de documents, vous êtes libre de choisir entre gabarits système ou vos propres gabarits personnalisés.

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

Types Gabarit

La dialogue « Générer la documentation » comporte quatre champs dans lesquels vous pouvez spécifier différents gabarits . Les champs sont intitulés Gabarit , Page de couverture, Tableau des matières et Feuille de style. Les gabarits spécifiés dans chacun de ces champs ont un objectif spécifique, comme décrit ci-dessous.

Document Gabarit

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

Page de couverture Gabarit

Ce gabarit définit le contenu et disposition de la page de garde de votre document. Il est spécifié 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> ' à la place d'un nom gabarit . Le gabarit système 'Couverture du guide utilisateur' vous a été fourni comme point de départ. Le gabarit 'Couverture du guide utilisateur' applique différents styles de formatage au texte et aux champs qu'il utilise. Ces styles sont définis dans la feuille de style gabarit .

Tableau des matières Gabarit

Ce gabarit définit le contenu et disposition de la page de Tableau de votre document. Il est spécifié dans le champ ' Tableau de contenu'. Si vous ne souhaitez pas générer de page de tableau pour votre document, vous pouvez choisir ' <none> ' à la place d'un nom gabarit . Le gabarit système 'User Guide TOC' vous a été fourni comme point de départ. Le gabarit 'User Guide TOC' applique différents styles de formatage au texte et aux champs qu'il utilise. Ces styles sont définis dans la feuille de style gabarit .

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 feuille de style est spécifié dans le champ « Feuille de style » de la dialogue « Générer la documentation ». 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 et ainsi de suite. Note cependant que les différents gabarits fournis utilisent plusieurs styles non standard définis dans « Styles du guide de l'utilisateur ». Il est donc recommandé d'utiliser le gabarit de feuille de style fourni, au moins jusqu'à ce que vous ayez une bonne compréhension de la manière dont tous les gabarits s'articulent et des styles de formatage que vous utilisez. Comme tous les autres gabarits , vous pouvez copier et enregistrer « Styles du guide de l'utilisateur » en tant que gabarit personnalisé, puis le modifier ultérieurement comme bon vous semble. Vous pouvez modifier les styles de formatage qu'il définit pour utiliser un formatage de paragraphe, des polices, une taille de texte ou une couleur différents. Vous pouvez également ajouter ou supprimer des styles à partir des définitions existantes.

Sélecteur Gabarit

Le gabarit du document « Guide de l'utilisateur » utilise le sélecteur gabarit facilité d' Enterprise Architect . Il fait appel au fragment de gabarit « Help Gabarit Selector », qui spécifie à son tour quels fragments gabarit sont utilisés pour restituer les différents types d'éléments qui composent un modèle d'aide. Il existe un fragment gabarit distinct correspondant à chacun des éléments stéréotypés disponibles dans le profil UML « HelpSystem », à l'exception de HelpTableRow . Le gabarit du sélecteur possède 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 HelpTableRow sont traitées comme des éléments enfants dans chacun des fragments gabarit HelpTable , elles n'ont donc pas besoin d'une entrée dans le gabarit du sélecteur. 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 associées. 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 gabarit distinct correspondant à chacun des éléments stéréotypés disponibles dans le profil UML 'HelpSystem', à l'exception de HelpTableRow . HelpTableRow est traité comme un élément enfant dans chacun des gabarits HelpTable . Les fragments gabarit appliquent différents styles de formatage au texte et aux champs qu'ils utilisent. Ces styles sont définis dans la feuille de style gabarit 'Styles du guide de l'utilisateur'.

Les gabarits fournis sont gabarits « système » et ne peuvent donc pas être modifiés. Vous êtes cependant libre de les copier et de les enregistrer en tant que gabarits « personnalisés », que vous pourrez ensuite modifier à votre guise.