Dodawanie strony pomocy do komponentu użytkownika

Tekla Structures

Not version-specific

Tekla Structures

Offline Help

custom components

Environment

Not environment-specific

Dla komponentów użytkownika można dodać własną stronę pomocy. Strony pomocy są lokalnie przechowywanymi plikami HTML i wyświetlane przy użyciu standardowej przeglądarki pomocy Tekla Structures przy użyciu wbudowanej funkcji pomocy offline po naciśnięciu klawisza F1 w oknie dialogowym.

Dodaj adres URL pomocy do komponentu użytkownika.
1. Otwórz plik. inp komponentu użytkownika w edytorze tekstu.
2. Dodaj wiersz helpurl("unique_id") do pliku, podstawiając w miejsce tekstu unique_id własny unikatowy identyfikator. Identyfikator nie może zawierać spacji i musi być ważny jako nazwa pliku Windows. Przykład:
```


page("TeklaStructures", "")
{
    macro(1, "Balcony")
    {
        helpurl("mycchelp_balcony")
        tab_page("", "Picture", 1)
        {
```
Utwórz plik HTML z zawartością pomocy.
- W razie potrzeby można swobodnie zapisywać zawartość i kod. Zawartość może być renderowana w trybie zgodności programu Internet Explorer, gdy jest wyświetlana przez Help Viewer (przeglądarkę pomocy). Aby temu zapobiec, dodaj następującą składnię jako pierwszy element w sekcji <head> pliku HTML:
  <meta http-equiv="X-UA-Compatible" content="IE=Edge"/>
Zapisz plik HTML z identyfikatorem jako nazwę pliku i sprawdź rozszerzenie pliku:
- W przypadku wersji Tekla Structures od 19.0 do 2016i należy usunąć rozszerzenie (.html, .htm, etc.) z nazwy pliku: nazwa pliku może zawierać tylko wartość helpurl, na przykład mycchelp_balcony.
- W przypadku Tekla Structures 2017 i nowszych wersji plik musi mieć rozszerzenie html (na przykład mycchelp_balcony.html).
Umieść plik w odpowiednim folderze:
- Ścieżka lokalizacji folderu pomocy zależy od wersji oprogramowania:
  - W przypadku Tekla Structures 2019 i nowszych wersji przeglądarka pomocy szuka tych plików w katalogu
    ProgramData\Trimble\Tekla Structures\<version>\Help.
  - W Tekla Structures w wersjach od 20.0 do 2018i przeglądarka pomocy szuka tych plików w katalogu
    ProgramData\Tekla Structures\<version>\Help.
  - W Tekla Structures w wersji 19.0 i 19.1, folder Help znajduje się w folderze instalacyjnym Tekla Structures.
- Zapisz plik w folderach specyficznych dla języka w folderze Help (na przykład w folderze enu w przypadku języka angielskiego). Dodaj plik (lub przetłumaczoną kopię) do folderu wszystkich języków, które będą używane.
- Przykładowo ścieżki do pliku pomocy w języku angielskim w wersjach 2016i i 2019 byłyby następujące:
  ProgramData\Tekla Structures\2016i\Help\enu\mycchelp_balcony
  ProgramData\Trimble\Tekla Structures\2019\Help\enu\mycchelp_balcony.html