Adding a help page for a custom component
Environment
Not environment-specific
You can add your own custom help page for your custom components. The help pages are locally stored HTML files and displayed using the standard Tekla Structures help viewer using the built-in offline help feature when the F1 key is pressed in the dialog box.
- Add a help url for your custom component.
- Open the .inp file of your custom component in a text editor.
Add the
helpurl("unique_id")line to the file and replaceunique_idwith your own unique identifier. The identifier must not contain spaces and must be valid as a Windows file name. For example:page("TeklaStructures", "") { macro(1, "Balcony") { helpurl("mycchelp_balcony") tab_page("", "Picture", 1) {
- Create a HTML file with your help content.
- Save the HTML file with your identifier as the file name and the file extension
.html(for example,mycchelp_balcony.html). - Place the file in the correct folder:
- The path to the Help folder location depends on the software version and installation folder:
- If you install Tekla Structures in the default folder, the help viewer looks for these files in
ProgramData\Trimble\Tekla Structures\<version>\Help. - With non-default installation folders the
Helpfolder is in the Tekla Structures installation folder.
- If you install Tekla Structures in the default folder, the help viewer looks for these files in
- Save the file in the language-specific folders in the Help folder (for example, in folder
enufor English). Add the file (or a translated copy) in the folder of all languages that will be in use. - For example, the paths to an English help file in version 2026 installed in the default folder would be:
ProgramData\Trimble\Tekla Structures\2026\Help\enu\mycchelp_balcony.html
- The path to the Help folder location depends on the software version and installation folder: