Crear documentación definida por el usuario - TIA Portal

La documentación definida por el usuario para diferentes elementos de un proyecto o de una librería global se crea fuera del TIA Portal. La documentación definida por el usuario puede crearse en todos los idiomas disponibles para la interfaz de usuario.

Si la documentación definida por el usuario se crea en forma de archivo CHM, el procedimiento para crear la ayuda difiere ligeramente del proceso de creación con otros formatos de archivo.

Tenga en cuenta las indicaciones del capítulo "Convenciones para la creación".

Crear documentación definida por el usuario como archivo independiente

Para crear documentación como archivo independiente, proceda del siguiente modo:

1. Cree un archivo en un formato de datos permitido.

2. Ponga al archivo el mismo nombre que tiene el objeto para el que desea llamar documentación definida por el usuario.

   Así, por ejemplo, si se ofrece ayuda para un tipo de librería, ponga al archivo de ayuda el mismo nombre que tiene el tipo.

3. Copie el archivo en una de las siguientes ubicaciones, en función de si la documentación definida por el usuario será para contenidos de un proyecto o para contenidos de una librería global:

   • Directorio del proyecto en "UserFiles\UserDocumentation\<carpeta del idioma correspondiente>\<categoría de objeto>"

   • Directorio de una librería global en "UserFiles\UserDocumentation\<carpeta del idioma correspondiente>\<categoría de objeto>"

   • Directorio centralizado en el disco duro o en una unidad de red:

     <directorio centralizado para la documentación definida por el usuario>\<carpeta del idioma correspondiente>\<categoría de objeto>\

   Si la carpeta del idioma correspondiente o la carpeta de la categoría de objeto todavía no existe, cree las carpetas necesarias antes de copiar el archivo.

Ejemplo de configuración para documentación definida por el usuario

A continuación se ve la ruta correcta para las condiciones siguientes:

• La documentación definida por el usuario está prevista para un tipo de una librería global.

• La documentación definida por el usuario está en francés.

• El tipo se llama "commande de moteur".

• La documentación definida por el usuario se suministra junto con la librería global.

• La documentación definida por el usuario se ha creado en formato Microsoft Power Point.

La ruta para estas condiciones es:

<carpeta de la librería global>\UserFiles\UserDocumentation\fr-FR\Library Types\commande de moteur.pptx

Crear documentación como archivo CHM

Para preparar documentación en formato CHM, haga lo siguiente:

1. Cree una carpeta en el Explorador de Windows para cada categoría de objeto a la que desee asignar documentación definida por el usuario. Utilice la denominación inglesa de la categoría de objeto.

2. Cree un archivo HTML para cada objeto para el que desee ofrecer documentación definida por el usuario. Asigne al archivo HTML el mismo nombre que tiene el objeto para el que desea llamar documentación definida por el usuario. Así, por ejemplo, si desea ofrecer documentación definida por el usuario para un tipo de librería, ponga al archivo HTML el mismo nombre que tiene el tipo.

3. Guarde los archivos HTML en las carpetas correspondientes a cada categoría de objeto.

4. Genere el archivo CHM con ayuda de Microsoft HTML Help Workshop. Adopte la estructura de carpetas preparada con los archivos HTML.

5. Copie el archivo CHM a una de las ubicaciones siguientes:

   • Directorio del proyecto en "UserFiles\UserDocumentation\<carpeta del idioma correspondiente>"

   • Directorio de una librería global en "UserFiles\UserDocumentation\<carpeta del idioma correspondiente>"

   • Directorio centralizado en el disco duro o en una unidad de red:

     <directorio centralizado para la documentación definida por el usuario>\<carpeta del idioma correspondiente>

   Si la carpeta del idioma en cuestión todavía no existe, créela antes de copiar el archivo CHM.