Documentación definida por el usuario sobre contenidos del proyecto o la librería
Con el tiempo, en un proyecto o una librería se van creando contenidos propios. Se consideran contenidos propios bloques, variables o tipos de librerías, por ejemplo. Mientras que el funcionamiento del TIA Portal está descrito en la ayuda suministrada, no existe ayuda alguna para los contenidos creados por el usuario. Puede crear su propia documentación para explicar a otros compañeros el funcionamiento de un proyecto o el uso de diferentes tipos de librerías.
La documentación se puede redactar en todos los idiomas disponibles de la interfaz de usuario. De forma estándar, en el TIA Portal se ofrecen los idiomas de interfaz alemán, inglés, francés, español, italiano y chino. Para que se abra siempre la ayuda correspondiente a un objeto concreto, es necesario seguir algunas convenciones a la hora de crear la documentación.
Puede crear la documentación en uno de los formatos Office compatibles o bien como ayuda HTML compilada en formato CHM.
|
Nota Add-In "Code2Docu" para generar documentación de objetos Para generar documentación de funciones, bloques de función y tipos de datos PLC de un proyecto del TIA Portal, puede integrar el Add-In "Code2Docu" en el TIA Portal. Mediante el Add-In, es posible extraer información y elementos de texto de estos objetos, prepararlos y guardarlos en documentos. Los documentos se ponen a disposición y se abren del mismo modo que la documentación personalizada creada manualmente. Encontrará más información sobre el Add-In "Code2Docu" en la FAQ con el ID de artículo 109809007 en Siemens Industry Online Support. |
Posibles ámbitos para la documentación definida por el usuario
Es posible ofrecer documentación definida por el usuario en los siguientes ámbitos del TIA Portal, p. ej.:
-
Árbol del proyecto
-
Task Card "Librerías"
-
Algunos editores, en función de los productos instalados, p. ej.:
-
Editor de programación
Se soportan los lenguajes de programación KOP, FUP, AWL, SCL, GRAPH y CEM También las llamadas de bloque permiten la vinculación de documentación definida por el usuario.
-
Editor "Imágenes"
En el editor "Imágenes" se soportan usos de imágenes e instancias de faceplates HMI.
-
Directorios para la documentación definida por el usuario
La documentación definida por el usuario se guarda en uno de los siguientes directorios:
-
Directorio del proyecto
Si crea documentación para objetos de un proyecto, deberá guardar la ayuda en el directorio del proyecto. Al transferir el proyecto, también se transfiere la documentación definida por el usuario.
-
Directorio de una librería global
Si crea documentación propia para objetos de una librería global, deberá guardarla en el directorio de la librería global. Al transferir la librería global, también se transfiere la documentación definida por el usuario.
-
Directorio centralizado en el disco duro o en una unidad de red
La documentación definida por el usuario puede guardarse en un directorio centralizado del disco duro o de una unidad de red. De ese modo es posible acceder a la documentación definida por el usuario desde cualquier proyecto o utilizarla en una unidad de red de forma conjunta dentro del equipo. El directorio para el almacenamiento centralizado de la documentación definida por el usuario se define utilizando un archivo XML en los ajustes del TIA Portal.
Página de inicio para la documentación definida por el usuario
Es posible crear una página de inicio propia para cada idioma de la documentación definida por el usuario. La página de inicio para la documentación definida por el usuario puede incluir ayuda general para un proyecto o una librería. La página de inicio debe estar guardada en el directorio para el almacenamiento centralizado de la documentación definida por el usuario.
Abrir la documentación definida por el usuario
Si hay documentación definida para el usuario para un objeto, esta se abre con la combinación de teclas <Mayús+F1>. La documentación definida por el usuario se abre siempre con el programa estándar definido en Microsoft Windows para el correspondiente formato de archivo.
Después de pulsar <Mayúsculas+F1>, se busca la documentación definida por el usuario en determinados directorios y en un orden específico. A continuación se indica el orden de búsqueda:
|
1. |
Búsqueda en el directorio central para documentación definida por el usuario |
|
|
1.1 |
Búsqueda de un archivo CHM |
|
|
1.2 |
Búsqueda de documentación en otros formatos de archivo |
|
|
2. |
Búsqueda en el directorio del proyecto o la librería |
|
|
2.1 |
Búsqueda de un archivo CHM |
|
|
2.2 |
Búsqueda de documentación en otros formatos de archivo |
|
La búsqueda se realiza primero en el directorio de idioma del idioma ajustado actualmente para la interfaz del TIA Portal. Si no hay ninguna ayuda en dicho directorio, la búsqueda de documentación definida por el usuario continúa en el mismo orden en el directorio de idioma para inglés.
En cuanto se encuentra documentación definida por el usuario en un lugar, se abre dicha documentación y se cancela la búsqueda. Si no se encuentra documentación definida por el usuario en ninguno de los directorios, se busca una página de inicio para la documentación definida por el usuario siguiendo el orden descrito anteriormente. Primero se busca una página de inicio en el directorio de idioma del idioma ajustado actualmente para la interfaz. Si en él no se encuentra ninguna página de inicio, se busca en el directorio de idioma inglés.
Informe de llamada
Para facilitar la integración de la documentación definida por el usuario, existe la posibilidad de visualizar un informe de llamada para la documentación definida por el usuario. Los mensajes contenidos en el informe indican los directorios en los que se busca la documentación y si la llamada de la documentación definida por el usuario se realiza correctamente. Además, se muestra el nombre que se espera que tenga el archivo. Esto permite identificar el nombre que hay que dar a la documentación y en qué directorios debe guardarse la documentación definida por el usuario. El informe de llamada sigue el mismo orden en el que se busca la documentación definida por el usuario o una página de inicio.
El informe se muestra en la pestaña "Información" de la ventana de inspección. Antes de poder visualizar el informe de llamada, este debe activarse primero en la configuración de TIA Portal. Active para ello la casilla de verificación "Mostrar informe de llamada para la documentación personalizada" en "Configuración > General > Documentación de usuario". También existe la posibilidad alternativa de visualizar el informe de llamada con un archivo XML.