Ajout de l'aide à l'instructeur pour les applications et composants

Tekla Structures
2023
Tekla Structures

Ajout de l'aide à l'instructeur pour les applications et composants

Vous pouvez facilement faire apparaître l’aide dans le panneau latéral pour les outils du catalogue Applications & composants.

Dans le catalogue Applications & composants, le panneau Instructeur affiche le contenu lorsque vous sélectionnez un élément. Ces informations sont particulièrement utiles pour conseiller les utilisateurs sur la manière de choisir le bon composant ou pour donner des instructions avant d'utiliser un outil. Pour tirer pleinement parti de cette fonction, les utilisateurs doivent disposer de leurs panneaux latéraux de sorte que les deux panneaux soient visibles.

  1. Sélectionnez l'outil pour lequel vous souhaitez ajouter l'aide dans le catalogue Applications & composants.
  2. Dans le panneau Instructeur, cliquez sur le menu, puis sélectionnez Ajouter fichier d’aide.

    Une boîte de dialogue s’ouvre pour créer les fichiers nécessaires en fonction de vos sélections.

  3. Cliquez sur Suivant, puis sélectionnez une ou plusieurs langues.

    Sélectionnez les langues utilisées en tant que langues de l’interface utilisateur Tekla Structures dans votre organisation. Il doit y avoir un fichier de contenu pour chaque langue, même si vous ne traduisez pas le contenu.

  4. Cliquez sur Suivant, puis sélectionnez le répertoire dans lequel vous souhaitez enregistrer les fichiers générés.

    Les fichiers peuvent peut être stockés dans le répertoire modèle, projet, société ou système. L'ordre de recherche des dossiers par défaut est suivi.

    Si vous souhaitez distribuer les fichiers aux utilisateurs, nous vous recommandons de les stocker dans le répertoire projet ou dans le FIRM.

  5. Cliquez sur Créer.

    Tekla Structures crée un fichier XML qui définit un lien entre l’outil du catalogue Applications & composants et un fichier HTML pour le contenu de l’aide.

    Les fichiers HTML sont stockés dans une structure de répertoires qui sépare les fichiers dans des répertoires spécifiques à une langue. Le fichier XML et le répertoire racine du contenu sont nommés en fonction de l’identifiant de l’outil auquel l'aide est destinée. Vous pouvez copier des fichiers dans les différents emplacements de stockage autorisés, mais ne renommez pas les fichiers ni les répertoires et ne modifiez pas la structure de ces derniers.

  6. Modifiez les fichiers de contenu HTML dans votre outil favori, tel que Visual Basic, ou remplacez les fichiers par vos propres fichiers HTML portant les mêmes noms.

Vous pouvez éventuellement ajouter les fichiers d'aide de l'Instructeur au package .tsep de votre extension de sorte que l'aide de l'Instructeur soit automatiquement ajoutée lorsque les utilisateurs installent le package .tsep. Vous pouvez utiliser le caractère générique (*) dans le fichier .xml de définition du projet pour ajouter tous les fichiers du dossier spécifié. Par exemple :

<TargetPathVariables>
	<PathVariable Id="HelpDirectory" Value="%ENVDIR%\common\extensions\MyExtension\"/>
</TargetPathVariables>

<Component Id="ExampleExtension" Guid="4902568A-2195-4B38-BBA4-BEB56A2ABECF">
	<File Id="HelpFilesToCopy" Source="%TSEPDEFINITIONFILEFOLDER%\plugin\*" Target="%HelpDirectory%"/>
</Component>
Cela a-t-il été utile?
Précédent
Suivant