Pré. | Proc. |
Générer des fichiers HTML
Après avoir construit un modèle d'aide dans Enterprise Architect , vous pouvez ensuite générer des fichiers HTML à partir du modèle, adaptés au téléchargement sur un site Web ou à une utilisation sur un système de fichiers local.
Le processus de génération est aussi simple que de choisir le paquetage pour lequel générer les pages d'aide et d'appeler la commande ' Générer Aide '. Dans le dialogue qui s'affiche, spécifiez un dossier de sortie, spécifiez l'emplacement des fichiers gabarit , spécifiez le fichier gabarit maître à utiliser, puis cliquez sur ' Générer '.
Accéder
Menu Navigateur |
Dans la fenêtre Navigateur , cliquez-droit sur un élément « HelpPackage », « HelpTopic » ou « HelpTopicProxy », puis choisissez l'option de menu ' Générer Aide sur Item actuel '. |
Ruban |
Avec un élément « HelpPackage », « HelpTopic » ou « HelpTopicProxy » sélectionné dans la fenêtre Navigateur , choisissez l'option du ruban « Publier > Rapports de Modèle > Générer Aide ». |
Étapes pour générer des fichiers HTML
Le tableau ci-dessous décrit la procédure de génération de fichiers HTML à partir de votre modèle d'aide, dans sa forme la plus simple, en utilisant uniquement les valeurs par défaut.
Le dialogue ' Générer Aide ' est expliqué en détail dans la rubrique d'aide 'Le Dialogue Générer Aide ' .
Étape |
Description |
Voir aussi |
---|---|---|
Sélectionnez le Paquetage /Sujet à Générer |
Dans la fenêtre Navigateur , cliquez-droit sur un «HelpPackage», «HelpTopic» ou un «HelpTopicProxy», puis choisissez la commande ' Générer Aide pour Item courant'. La dialogue ' Générer Aide ' s'affiche. |
Le Dialogue ' Générer Aide ' |
Sélectionnez un dossier de sortie |
Utilisez le bouton « Parcourir » pour sélectionner un dossier existant sur votre système de fichiers, dans lequel écrire les fichiers HTML générés. Note : ne choisissez pas « C:\ " comme dossier de sortie, car le générateur ne peut pas extraire les fichiers nécessaires dans le dossier racine. |
|
Spécifiez l'emplacement des fichiers Gabarit |
S'il s'agit du premier exécuter du Générateur d'aide, le champ ' Gabarits Location' était vide jusqu'à présent. Lorsque le 'Dossier de sortie' est sélectionné à l'aide du bouton 'parcourir', le champ ' Gabarits Location' est mis à jour avec la valeur ' Gabarits ', en tant que sous-dossier du dossier de sortie choisi. Note : le générateur d'aide copiera l'ensemble des fichiers gabarit fournis dans l'emplacement « Gabarits » spécifié à chaque exécuter , si les fichiers n'existent pas déjà à cet emplacement. |
Aide Gabarit Fichiers |
Spécifiez le Master Gabarit à utiliser |
Le champ 'Master Gabarit ' aura été renseigné avec la valeur par défaut 'HelpPageTemplate.html'. Pour maintenant , laissez cette valeur telle quelle. |
Aide Gabarit Fichiers |
Générer |
Cliquez sur le bouton « Générer » pour générer un ensemble de fichiers HTML pour la hiérarchie du modèle à partir du « HelpPackage » sélectionné. La fenêtre Sortie système s'affiche et un log de traitement est écrit dans la page « Système d'aide » de cette fenêtre. |
|
Vue les fichiers générés |
En haut du log de traitement dans la fenêtre Sortie système, vous trouverez le chemin complet du fichier généré pour le paquetage racine de la branche de modèle que vous venez de générer. Ouvrez un navigateur Web et chargez le fichier nommé dans la fenêtre de sortie. |
Fichiers Gabarit
Un ensemble de fichiers gabarit prêts à l'emploi est fourni avec Enterprise Architect . Les fichiers gabarit seront extraits dans un sous-dossier nommé « Gabarits » dans votre dossier de sortie spécifié à chaque fois que vous générez des fichiers HTML. Une fois les fichiers copiés dans le dossier de sortie, vous êtes libre de les modifier pour les adapter à vos propres besoins. Les fichiers existants ne seront pas écrasés lors de la prochaine génération de vos fichiers HTML.
Il est prévu que vous personnalisiez le fichier gabarit principal pour l'adapter à vos propres besoins, cependant, il est beaucoup moins probable que vous ayez besoin de modifier les fichiers gabarit des éléments.
Pour des informations détaillées sur les fichiers gabarit , consultez la rubrique d'aide Aide Fichiers Gabarit .
Fichier CSS
Un fichier CSS nommé « user-guide.css » qui définit les styles utilisés par le code HTML généré est également fourni avec Enterprise Architect . Lors de la génération de fichiers HTML, ce fichier est également extrait dans votre dossier de sortie spécifié s'il n'y existe pas déjà. Une fois que le fichier existe dans votre dossier de sortie, vous pouvez mettre à jour les styles qu'il définit en fonction de vos besoins.