Ajout d’une page d’aide pour un composant personnalisé

Tekla Structures
Not version-specific
Tekla Structures
Offline Help
custom components
Environment
Not environment-specific
Vous pouvez ajouter votre propre page d’aide personnalisée pour vos composants personnalisés. Les pages d'aide sont des fichiers HTML stockés localement et affichés à l'aide de la visualisation standard de l'aide Tekla Structuresà l'aide de la fonctionnalité d'aide hors ligne intégrée lorsque la touche F1 est enfoncée dans la boîte de dialogue.
  1. Ajoutez une URL d’aide pour votre composant personnalisé.
    1. Ouvrez le fichier. inp de votre composant personnalisé dans un éditeur de texte.
    2. Ajoutez la ligne helpurl("unique_id") au fichier et remplacez unique_id par votre propre identifiant unique. L'identifiant ne doit pas contenir d’espaces et doit être valide en tant que nom de fichier Windows. Par exemple :
      
      
      page("TeklaStructures", "")
      {
          macro(1, "Balcony")
          {
              helpurl("mycchelp_balcony")
              tab_page("", "Picture", 1)
              {
  2. Créez un fichier HTML avec le contenu de votre aide.
    • Vous pouvez écrire le contenu et le code librement selon vos besoins. Le contenu peut être rendu dans le mode de compatibilité d'Internet Explorer lorsqu'il est visualisé à l'aide du visualiseur d'aide. Pour éviter cela, ajoutez ce qui suit comme premier élément dans la section <head> du fichier HTML :
      <meta http-equiv="X-UA-Compatible" content="IE=Edge"/>
  3. Enregistrez le fichier HTML avec votre identifiant comme nom de fichier et vérifiez l’extension de fichier :
    • Pour Tekla Structures versions 19.0 to 2016i, supprimez l'extension de fichier (.html, .htm, etc.) du nom de fichier : le nom de fichier doit uniquement contenir la valeur helpurl, par exemple, mycchelp_balcony.
    • À partir de Tekla Structures 2017, assurez-vous que l'extension de fichier est .html (par exemple, mycchelp_balcony.html).
  4. Placez le fichier dans le dossier approprié :
    • Le chemin d’accès vers l’emplacement du répertoire d’aide dépend de la version du logiciel :
      • À partir de Tekla Structures 2019, la visualisation de l'aide recherche ces fichiers dans
        ProgramData\Trimble\Tekla Structures\<version>\Help.
      • Dans Tekla Structures 20.0 à 2018i, la visualisation de l'aide recherche ces fichiers dans 
        ProgramData\Tekla Structures\<version>\Help.
      • Dans Tekla Structures 19.0 et 19.1, le dossier Aide se trouve dans le répertoire d'installation de Tekla Structures.
    • Enregistrez le fichier dans les répertoires spécifiques à la langue du répertoire d’aide (par exemple, dans le dossier fra pour le français). Ajoutez le fichier (ou une copie traduite) dans le dossier de toutes les langues qui seront utilisées.
    • Par exemple, les chemins d'accès au fichier d'aide anglais dans les versions 2016i et 2019 seraient : 
      ProgramData\Tekla Structures\2016i\Help\enu\mycchelp_balcony
      ProgramData\Trimble\Tekla Structures\2019\Help\enu\mycchelp_balcony.html
Was this helpful?