Générer de la documentation HTML


Le rapport est un ensemble de pages HTML. Chaque page correspond à un concept. Grâce à un système d'hyperliens, il est possible de naviguer entre ces pages.

Open ModelSphere offre la possibilité de générer de la documentation HTML à partir de n'importe quel objet sémantique, peu importe que vous fassiez de la modélisation de données, de classes ou de processus. Le rapport peut être employé pour publier le contenu d'un modèle, fournissant ainsi l'accès rapide à l'information. Cette fonction vous permet aussi de partager l'information facilement. En effet, l'information peut ensuite être intégré dans un site Web ou être consulté sur un réseau local.

Par exemple, si vous générez un rapport pour un modèle de données, ce sera une excellente référence pour d'éventuels utilisateurs de la base de données qui est construite à partir de ce modèle. Offrant beaucoup de flexibilité quant au contenu et au format, la fonction de Génération de rapport s'avérera être essentielle.

Pour générer un rapport :
  1. Faites votre choix dans l'Explorateur, à n'importe quel niveau (projet au niveau le plus bas). Ce choix sera, récursivement, la source d'information pour le processus de génération de rapport.

  2. Du menu principal, choisissez Outils > Générer > Rapport. La fenêtre de Génération de rapport apparaîtra.



  3. Cochez les concepts que vous voulez ajouter au rapport, décochez ceux que vous ne voulez pas. Il est possible d'Enregistrer votre choix de concepts et le Recharger quand vous en avez besoin.

  4. Réglez les paramètres : couleur, dimension, alignement, configurations générales, etc. Chaque concept peut être réglé différemment. Dans la liste des concepts, ouvrez le noeud en cliquant sur la poignée à côté. Vous pouvez aussi mettre plus bas les niveaux de concepts de la même manière.

  5. Cliquez sur l'onglet Option pour personnaliser les options.



    • Générer la table des matières : cochez cette case si vous voulez qu'une table des matières soit générée. La table des matières est placée sur le côté gauche du rapport. Vous verrez tous les concepts inclus dans le rapport.

    • Page d'accueil : choisissez la page qui s'ouvrira avec main.html

    • Répertoire de sortie : choisissez dans quel répertoire les fichiers HTML seront générés. Le répertoire de sortie par défaut est aussi inscrit dans le menu Outils > Options. Si vous changez le répertoire ici, cela n'affectera pas les configurations du menu Options.

    • Répertoire des diagrammes : nommez ici le répertoire dans lequel les images JPEG des diagrammes seront stockées. Tapez le nom du répertoire, il sera automatiquement créé à côté du répertoire de sortie. Ex. : le nom du répertoire est 'images'. Le répertoire de production est C:\report. Alors le répertoire de diagrammes sera C:\report\images

    • Utiliser le fond d'image : cochez cette case si vous voulez qu'une image de fond apparaisse à chaque page (sauf TOC.HTM).



  6. Cliquer sur Générer et Fermer. Une fois que les fichiers sont générés, vous obtiendrez un avis d'achèvement. Vous pouvez Montrer les détails ou non. Dans la section des Détails, il y a l'information quant à la date et l’heure de la génération, aux fichiers produits et leur emplacement, sans oublier les erreurs, s’il y en a.

  7. Naviguez jusqu'au répertoire de génération et ouvrez le fichier index.htm.



Si vous devez produire de la documentation HTML pour plus d'un modèle à la fois, assurez-vous que tous les noms physiques sont différents.

Souvenez-vous, le fichier gabarit peut être personnalisé, adaptant ainsi le contenu de la documentation. Par exemple, vous pouvez limiter la quantité d'informations qui sera transformée en fichiers HTML.