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

Tekla Structures

Not version-specific

Tekla Structures

Offline Help

custom components

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-файл с содержимым справки.
- Содержимое может представлять собой произвольный текст и код. При открытии в средстве просмотра справки содержимое файла иногда отображается в режиме совместимости с Internet Explorer. Во избежание этого добавьте в качестве первого элемента в разделе <head> HTML-файла следующую строку:
  <meta http-equiv="X-UA-Compatible" content="IE=Edge"/>
Сохраните HTML-файл с ранее указанным идентификатором в качестве имени, и проверьте расширение файла:
- Для Tekla Structures версий 19.0–2016i удалите расширение файла (.html, .htm и т. д.) из имени файла: имя файла должно содержать только значение helpurl, например mycchelp_balcony.
- Начиная с Tekla Structures 2017 файл должен иметь расширение .html (например, mycchelp_balcony.html).
Поместите файл в соответствующую папку:
- Путь к папке справки зависит от версии программы:
  - Начиная с Tekla Structures 2019 средство просмотра справки ищет эти файлы в папке
    ProgramData\Trimble\Tekla Structures\<версия>\Help.
  - В Tekla Structures 20.0–2018i средство просмотра справки ищет эти файлы в папке
    ProgramData\Tekla Structures\<версия>\Help.
  - В Tekla Structures 19.0 и 19.1 папка Help находится внутри папки установки Tekla Structures.
- Сохраните файл в папках, соответствующих конкретным языкам, внутри папки Help (например, в папке ENU для английского языка). Добавьте файл (или его перевод) в папки для всех языков, которые будут использоваться.
- Например, пути к файлу справки на английском языке в версиях 2016i и 2019 будут выглядеть следующим образом:
  ProgramData\Tekla Structures\2016i\Help\enu\mycchelp_balcony
  ProgramData\Trimble\Tekla Structures\2019\Help\enu\mycchelp_balcony.html