Accès aux fichiers d'aide de bibliothèque via la touche F1

Présentation

Cet accès contextuel aux fichiers d'aide est réservé à la documentation utilisateur des bibliothèques.

Il est recommandé de créer la documentation CHM ou HTML de votre bibliothèque à l'aide de l'outil CODESYS LibDoc Scripting Collection. La documentation de bibliothèque créée avec cet outil vous permet d'accéder à la rubrique d'aide relative à l'élément de bibliothèque ouvert (un bloc fonction, par exemple) en appuyant sur la touche F1 du clavier. Pour plus d'informations, reportez-vous à la synthèse du développement de bibliothèque dans l'aide en ligne de l'EcoStruxure Machine Expert.

Les conditions suivantes doivent être remplies :

  • Un fichier de mappage de bibliothèque (*.librarymapping) est disponible dans le dossier Répertoire pour la documentation utilisateur.

  • Un élément de bibliothèque est sélectionné dans le Gestionnaire de bibliothèques.

    Ou

  • Un élément correspondant à un élément de bibliothèque (par exemple, un nom de variable ou un élément CFC) est sélectionné dans un éditeur logique dans EcoStruxure Machine Expert Logic Builder.

Fichiers de mappage de bibliothèque

Le fichier de mappage de bibliothèque définit l'emplacement de la documentation d'une bibliothèque. Une entrée de mappage doit être disponible pour chaque bibliothèque.

La structure du fichier de mappage doit être conforme à l'exemple suivant, en remplaçant les éléments de l'exemple par vos informations de mappage de bibliothèque :

<?xml version="1.0" encoding="utf-8"?>
<LibraryMapping>
<MappingEntry libraryName="UserLib" vendor="SE" helpBook="UserLib.html" openWith="WebBrowser" />
<MappingEntry libraryName="UserLib2" vendor="SE" helpBook="https://www.your.company.page.com/" openWith="WebBrowser" />
<MappingEntry libraryName="UserLib3" vendor="SE" helpBook="UserLib3.chm" openWith="Help" />
</LibraryMapping>

Elément

Description

libraryName

Entrez le nom de la bibliothèque tel qu'il apparaît dans le champ Titre dans les Informations de projet du projet de bibliothèque.

vendor

Entrez le nom du fournisseur de la bibliothèque tel qu'il apparaît dans le champ Société dans les Informations de projet du projet de bibliothèque.

helpBook

Entrez le nom du fichier CHM ou HTML ou une URL (Uniform Resource Locator) référençant l'aide en ligne à afficher.

openWith="WebBrowser"

Utilisez openWith="WebBrowser" si votre aide en ligne est fournie sous la forme d'un fichier HTML ou d'une URL.

openWith="Help"

Utilisez openWith="Help" si votre aide en ligne est fournie sous la forme d'un fichier CHM.