Añadir una página de ayuda para un componente personalizado

Tekla Structures

Not version-specific

Tekla Structures

Offline Help

custom components

Environment

Not environment-specific

Puede añadir su propia página de ayuda personalizada para sus componentes personalizados. Las páginas de ayuda son archivos HTML almacenados localmente y se muestran con el visualizador de ayuda de Tekla Structures estándar con la función de ayuda sin conexión integrada cuando se pulsa la tecla F1 en el cuadro de diálogo.

Añada una url de ayuda para su componente personalizado.
1. Abra el archivo .inp de su componente personalizado en un editor de texto.
2. Añada la línea helpurl("unique_id") al archivo y sustituya unique_id por su identificador único. El identificador no debe contener espacios y debe ser válido como un nombre de archivo de Windows. Por ejemplo,
```


page("TeklaStructures", "")
{
    macro(1, "Balcony")
    {
        helpurl("mycchelp_balcony")
        tab_page("", "Picture", 1)
        {
```
Cree un archivo HTML con su contenido de ayuda.
- Puede escribir el contenido y el código libremente según sus necesidades. El contenido se puede presentar en el modo de compatibilidad de Internet Explorer cuando se visualiza a través del visualizador de ayuda. Para evitarlo, añada lo siguiente como el primer elemento de la sección <head> del archivo HTML:
  <meta http-equiv="X-UA-Compatible" content="IE=Edge"/>
Guarde el archivo HTML con su identificador como nombre de archivo y verifique la extensión de archivo:
- Para las versiones 19.0 a 2016i de Tekla Structures, elimine la extensión de archivo (.html, .htm, etc.) del nombre: el nombre de archivo solo debe contener el valor, por ejemplo, mycchelp_balcony.
- A partir de Tekla Structures 2017, asegúrese de que la extensión de archivo sea .html (por ejemplo, mycchelp_balcony.html).
Guarde el archivo en la carpeta correcta:
- La ruta a la ubicación de la carpeta de ayuda depende de la versión del software:
  - A partir de Tekla Structures 2019, el visualizador de ayuda busca estos archivos en
    ProgramData\Trimble\Tekla Structures\<versión>\Help.
  - En Tekla Structures 20.0 a 2018i, el visualizador de ayuda busca estos archivos en
    ProgramData\Tekla Structures\<versión>\Help.
  - En Tekla Structures 19.0 y 19.1, la carpeta Help está en la carpeta de instalación de Tekla Structures.
- Guarde el archivo en las carpetas específicas del idioma en la carpeta Help (por ejemplo, en la carpeta enu para inglés). Añada el archivo (o una copia traducida) en la carpeta de todos los idiomas que se usarán.
- Por ejemplo, las rutas al archivo de ayuda en inglés en las versiones 2016i y 2019 serían:
  ProgramData\Tekla Structures\2016i\Help\enu\mycchelp_balcony
  ProgramData\Trimble\Tekla Structures\2019\Help\enu\mycchelp_balcony.html