Qu’est ce qu’un document ?

Au sein d’un modèle Modelio, un document est le lien entre le plan-type et les éléments qui doivent figurer dans la documentation générée. Il permet en outre de rajouter des informations spécifiques (titre, auteur, …​), ou de modifier le format utilisé. Au moins un document doit être créé avant toute génération de documentation.

Comment créer un document ?

Documentpublisher documentpublisher principles create document docpubFR 001
Création d’un dossier de document et d’un document

Légende :

  1. Tout d’abord, créez un dossier de documents en cliquant droit sur un package puis en exécutant la commande "Document Publisher / Créer dossier de documents"

  2. Continuez en créant votre document en cliquant droit sur votre nouveau dossier de documents puis en exécutant la commande "Document Publisher / Créer un document"

La fenêtre "Création de document" apparaît alors. C’est ici que vous pouvez définir les options de génération, ainsi que le contenu de votre document. Regardons d’abord la définition des options de génération :

Documentpublisher documentpublisher principles create document docpubFR 002
Définition des options de génération pour votre nouveau document

Légende :

  1. Saisissez un nom pour votre document

  2. Choisissez un format (OpenXML, HTML ou ODT)

  3. Indiquez le répertoire de destination

  4. Choisissez la feuille de style à appliquer

  5. Sélectionnez un plan-type

  6. Définissez les propriétés de votre choix

  7. Cliquez sur "Suivant" pour passer à l’étape suivante

Vous êtes maintenant prêt à définir le contenu de votre document :

Documentpublisher documentpublisher principles create document docpubFR 003
Définition du contenu de votre nouveau document

Légende :

  1. Sélectionnez les tables que vous voulez inclure dans votre document

  2. Cliquez sur "Suivant" pour passer à l’étape suivante

  3. Ici, vous pouvez définir exactement ce que vous voulez inclure dans votre document. Cliquez sur image pour ouvrir un explorateur demodèle et choisissez les éléments que vous souhaitez inclure

  4. Cliquez sur "OK" pour confirmer

  5. Puis cliquez sur "Terminer" pour compléter la création de votre nouveau document

Note : L’assistant de création de document ressemble à l’édition de document.