Add instructor help for applications and components

Tekla Structures
Tekla Structures

Add instructor help for applications and components

You can easily create side pane help for tools in the Applications & components catalog.

In the Applications & components catalog, the Instructor shows content already on selection, so the information is especially useful for giving advice to your users on choosing between different components or giving instructions before running a tool. To make full use of this feature, users should arrange their side panes so that both panes are visible.

  1. Select the tool you want to add help for in the Applications & components catalog.
  2. Click the Add help files button in the Instructor pane.

    A dialog box opens for creating the necessary files according to your selections.

  3. Click Next and select the languages that are used as user interface languages in your organization. There needs to be a content file for each language even if you do not translate the content.
  4. Click Next and select the folder where you want to store the generated files.
    The files can be stored in the model, project, firm, or system folder. The standard folder search order is followed.
  5. Click Create.

    Tekla Structures creates an XML file that defines a link between the tool in the Applications & components catalog and an HTML file for the help content.

    The HTML files are stored in a folder structure that separates files into language-specific folders. The XML file and the root folder for the content are named according to the identifier of the tool you are documenting. You can copy files between the allowed storage locations, but do not rename the files or folders or change the folder structure.

  6. Edit the HTML content file(s) in your preferred tool, such as a text editor, or replace the file with your own HTML file of the same name.
    If you do not have any HTML editing experience, there are several good tutorials available on the internet to quickly learn the few basics you need to know. You can create your own HTML files by saving as HTML from familiar tools, such as Microsoft Word or Google Docs. Note that the resulting files will not look exactly the same as the original document.
Was this helpful?