Añadir la ayuda de instructor para aplicaciones y componentes

Tekla Structures
2022
Tekla Structures

Añadir la ayuda de instructor para aplicaciones y componentes

Puede crear fácilmente la ayuda del panel lateral para las herramientas de la base de datos Aplicaciones y componentes.

En la base de datos Aplicaciones y componentes, el panel Instructor muestra contenido al seleccionar un elemento. La información resulta muy útil para aconsejar a sus usuarios acerca de cómo elegir el componente adecuado o bien para ofrecer instrucciones antes de la ejecución de una herramienta. Para aprovechar al máximo esta función, los usuarios deben disponer sus paneles laterales de forma que ambos sean visibles.

  1. Seleccione la herramienta para la que desea añadir ayuda en la base de datos Aplicaciones y componentes.
  2. En el panel Instructor, haga clic en el menú y seleccione Añadir archivo ayuda.

    Se abre un cuadro de diálogo para crear los archivos necesarios según sus selecciones.

  3. Haga clic en Siguiente y seleccione uno o varios idiomas.

    Seleccione los idiomas que se utilizan como idiomas de la interfaz de usuario de Tekla Structures en su organización. Debe haber un archivo de contenido para cada idioma aunque no se traduzca el contenido.

  4. Haga clic en Siguiente y, a continuación, seleccione la carpeta donde desea almacenar los archivos generados.

    Los archivos pueden almacenarse en la carpeta de modelo, proyecto, empresa o sistema. Se sigue el orden de búsqueda de carpetas estándar.

    Le recomendamos que guarde los archivos en la carpeta de empresa o de proyecto si desea distribuirlos entre los usuarios.

  5. Haga clic en Crear.

    Tekla Structures crea un archivo XML que define un enlace entre la herramienta de la base de datos Aplicaciones y componentes y un archivo HTML para el contenido de ayuda.

    Los archivos HTML se almacenan en una estructura de carpetas que separa los archivos en carpetas específicas de cada idioma. El archivo XML y la carpeta raíz del contenido se denominan según el identificador de la herramienta para la que es la ayuda. Puede copiar archivos entre las ubicaciones de almacenamiento permitidas, pero no cambie el nombre de los archivos o las carpetas ni la estructura de las mismas.

  6. Edite los archivos de contenido HTML en su herramienta preferida, como Visual Basic, o sustituya los archivos por sus propios archivos HTML del mismo nombre.

Opcionalmente puede añadir los archivos de ayuda del instructor al paquete .tsep de su extensión para que la ayuda del instructor se añada de forma automática cuando los usuarios instalen el paquete .tsep. Para añadir todos los archivos de la carpeta especificada, puede usar el carácter comodín (*) en el archivo .xml de definición del proyecto. Por ejemplo,

<TargetPathVariables>
	<PathVariable Id="HelpDirectory" Value="%ENVDIR%\common\extensions\MyExtension\"/>
</TargetPathVariables>

<Component Id="ExampleExtension" Guid="4902568A-2195-4B38-BBA4-BEB56A2ABECF">
	<File Id="HelpFilesToCopy" Source="%TSEPDEFINITIONFILEFOLDER%\plugin\*" Target="%HelpDirectory%"/>
</Component>
¿Le ha resultado útil?
Anterior
Siguiente