Dozent-Hilfe für Anwendungen und Komponenten hinzufügen

Sie können ganz einfach eine Hilfe im Seitenbereich für Werkzeuge im Katalog Anwendungen und Komponenten erstellen.

Im Katalog Anwendungen und Komponenten werden im Bereich Dozent bei Auswahl eines Elements Inhalte angezeigt. Diese Informationen geben den Benutzern insbesondere praktische Empfehlungen zur Auswahl der richtigen Komponente oder Anweisungen zum Ausführen eines Werkzeugs. Um den Nutzen der Funktion vollends auszuschöpfen, können die Benutzer die Seitenbereiche so anordnen, dass beide Bereiche sichtbar sind.

Wählen Sie das hinzuzufügende Tool im Katalog Anwendungen und Komponenten aus.
Klicken Sie im Bereich Dozent auf das Menü und dann auf Hilfedatei hinzufügen.

Ein Dialogfeld wird geöffnet, in dem die erforderlichen Dateien der Auswahl entsprechend erstellt werden können.
Dann klicken Sie auf Weiter und wählen mindestens eine Sprache aus.

Wählen Sie die Sprachen aus, die in Ihrer Organisation für die Benutzeroberfläche von Tekla Structures verwendet werden. Für jede Sprache muss eine Inhaltsdatei vorhanden sein, auch wenn Sie den Inhalt nicht übersetzen.
Klicken Sie auf Weiter, und wählen Sie dann den Ordner aus, in dem die erstellten Dateien gespeichert werden sollen.

Die Dateien können im Modell-, Projekt-, Firmen- oder Systemordner gespeichert werden. Standardmäßig wird die Suchreihenfolge des -Ordners befolgt.

Zum Verteilen der Dateien an Benutzer empfiehlt sich, die Dateien im Projekt- oder Firmenordner zu speichern.
Klicken Sie auf Erstellen.

Tekla Structures erstellt eine XML-Datei, die eine Verknüpfung zwischen dem Werkzeug im Katalog Anwendungen und Komponenten und einer HTML-Datei für den Inhalt der Hilfe definiert.

Die HTML-Dateien werden in einer Ordnerstruktur gespeichert, bei der die Dateien in sprachspezifische Ordner unterteilt sind. Die XML-Datei und der Stammordner für die Inhalte werden entsprechend dem Identifizierungszeichen des Werkzeugs benannt, für den die Hilfe dient. Sie können Dateien zwischen den zulässigen Speicherorten hin- und herkopieren, jedoch keine Dateien oder Ordner umbenennen oder die Ordnerstruktur ändern.
Bearbeiten Sie die HTML-Inhaltsdateien in einem von Ihnen bevorzugten Werkzeug, z. B. in Visual Basic, oder ersetzen Sie die Dateien durch ihre eigene HTML-Dateien mit denselben Dateinamen.

Optional dazu können die Dozent-Hilfedateien zum .tsep-Paket für Ihre Erweiterung hinzugefügt werden, damit die Dozent-Hilfe beim Installieren des .tsep-Pakets durch den Benutzer automatisch hinzugefügt wird. In der .xml-Datei der Projektdefinition können Sie das Platzhalterzeichen (*) verwenden, um alle Dateien im angegebenen Ordner hinzuzufügen. Zum Beispiel:

<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>