| Pré. | Proc. |
Génération de 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'invoquer la commande ' Générer l'aide'. Dans la boîte de le dialogue qui s'affiche, indiquez un dossier de sortie, indiquez l'emplacement des fichiers de gabarit , indiquez le fichier de gabarit maître à utiliser, puis cliquez sur ' Générer '.
Accès
|
Menu Navigateur |
Dans la fenêtre du Navigateur , cliquez-droit sur un élément «HelpPackage», «HelpTopic» ou «HelpTopicProxy», puis choisissez l'option de menu ' Générer l'aide sur l' Item courant'. |
|
Ruban |
Avec un élément « HelpPackage », « HelpTopic » ou « HelpTopicProxy » sélectionné dans la fenêtre du Navigateur , choisissez l'option du ruban "Publish > Rapports de Modèle > Générer Help". |
É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.
La boîte de dialogue 'Aide Générer ' est expliquée en détail dans la rubrique d'aide 'La Générer de Dialogue Aide Générer' .
Marcher |
Description |
Voir également |
|---|---|---|
|
Sélectionnez le Paquetage /Topic à Générer |
Dans la fenêtre Navigateur , cliquez-droit sur un «HelpPackage», «HelpTopic» ou un «HelpTopicProxy», puis choisissez la commande ' Générer Help for Current Item '. La boîte de dialogue ' Générer l'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 de la première exécuter du générateur d'aide, le champ 'Emplacement des Gabarits ' était vide jusqu'à présent. Lorsque le 'Dossier de sortie' est sélectionné à l'aide du bouton 'parcourir', l''Emplacement des Gabarits ' 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 de gabarit fournis dans l''emplacement Gabarits ' spécifié sur chaque exécuter , si les fichiers n'existent pas déjà à cet emplacement. |
Aide Fichiers Gabarit |
|
Spécifiez le maître Gabarit à utiliser |
Le champ 'Master Gabarit ' aura été renseigné avec la valeur par défaut ' valeur '. Pour maintenant , laissez cette valeur telle quelle. |
Aide Fichiers Gabarit |
|
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 System Output s'affiche et un log de traitement est écrit dans la page 'Help System' 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 de gabarit prêts à l'emploi est fourni dans le cadre d' Enterprise Architect . Les fichiers de 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 selon vos propres besoins. Les fichiers existants ne seront pas écrasés lors de la prochaine génération de vos fichiers HTML.
On s'attend à ce que vous personnalisiez le fichier de gabarit principal en fonction de vos propres besoins, cependant, il est beaucoup moins probable que vous ayez besoin de modifier les fichiers de gabarit d'élément.
Pour des informations détaillées sur les fichiers de gabarit , consultez la rubrique d' aide Help Gabarit Files .
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 dans le cadre d' 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.