Добавление страницы справки для пользовательского компонента

Environment

Not environment-specific

Вы можете добавить свою собственную страницу справки для своего пользовательского компонента. Страницы справки представляют собой локально сохраненные HTML-файлы и отображаются с помощью стандартного средства просмотра справки Tekla Structures при нажатии клавиши F1 в диалоговом окне (как встроенная автономная справка).

Добавьте в пользовательский компонент URL-адрес справки.
1. Откройте INP-файл пользовательского компонента в текстовом редакторе.
2. Добавьте в файл строку helpurl("unique_id"), заменив unique_id на ваш собственный уникальный идентификатор. Идентификатор не должен содержать пробелов и должен быть допустимым для использования в качестве имени файла Windows. Например:
```
page("TeklaStructures", "")
{
    macro(1, "Balcony")
    {
        helpurl("mycchelp_balcony")
        tab_page("", "Picture", 1)
        {
```
Создайте HTML-файл с содержимым справки.
Сохраните HTML-файл, используя свой идентификатор в качестве имени файла и расширение .html (например, mycchelp_balcony.html).
Поместите файл в соответствующую папку:
- Путь к папке Help зависит от версии программного обеспечения и папки установки:
  - Если вы установили Tekla Structures в папку по умолчанию, средство просмотра справки ищет эти файлы в
    ProgramData\Trimble\Tekla Structures\<version>\Help.
  - При установке Tekla Structures в папку, отличную от используемой по умолчанию, папка Help находится в папке установки Tekla Structures.
- Сохраните файл в папках, соответствующих конкретным языкам, внутри папки Help (например, в папке rus для русского языка). Добавьте файл (или его перевод) в папки для всех языков, которые будут использоваться.
- Например, пути к файлу справки на русском языке в версии 2026, установленной в папку по умолчанию, будут следующими:
  ProgramData\Trimble\Tekla Structures\2026\Help\rus\mycchelp_balcony.html