Aplicación Technical Information
Introducción a Technical Information
Es necesario implementar un tipo de documento en el servidor de Arbortext Publishing Engine que pueda publicar el documento XML transformado que ha creado la aplicación Service. Con Arbortext Editor and Publishing Engine, se incluye una aplicación de tipo del documento DITA de ejemplo, que se puede utilizar como punto de partida o analizar para determinar los requisitos clave del tipo de documento propio.
La aplicación Technical Information es un tipo de documento DITA especializado. Permite organizar y administrar la información sobre las operaciones y los artículos del servicio. En el servidor de Arbortext Publishing Engine, la aplicación se instala por defecto en:
Ruta de Arbortext\application\com.ptc.arbortext.techinfo
Descripción del tipo de documento de Technical Information
Los temas de la aplicación Technical Information se pueden utilizar para desarrollar información de servicio o como punto de partida para desarrollar una aplicación DITA especializada propia. La aplicación Technical Information es una especialización de la aplicación DITA Arbortext, aunque no se requiere un tipo de documento personalizado basado en DITA.
Los siguientes tipos de tema están disponibles para el tipo de documento de Technical Information:
Concept
Proporciona información adicional que los usuarios deben entender para poder trabajar con un producto o una interfaz, así como para realizar una tarea.
Portada
Indica la información que debe incluir la portada de un PDF o cualquier documento impreso.
Diagnóstico
Proporciona información de diagnóstico.
Procedimiento
Indica el procedimiento que se debe seguir para la realización de una tarea. En este caso, los pasos y gráficos se mezclan en un único flujo de texto.
Reference
Proporciona información sobre las características normales de un servicio, un producto o un artículo.
Procedimiento paralelo
Indica el procedimiento que se debe seguir para la realización de una tarea. En este caso, los pasos y los gráficos se presentan unos junto a otros en formato tabular.
Task
Proporciona información sobre procedimientos.
Resolución de problemas
Proporciona información de resolución de problemas o de diagnóstico.
Descripción de la hoja de estilos de Technical Information
El tipo de documento de Technical Information incluye una hoja de estilos de Arbortext Styler de muestra para la publicación, que se encuentra en:
Ruta-Arbortext\application\com.ptc.arbortext.techinfo
\doctypes\techinfo\techinfo.style
Comprobación de la transformación y los estilos
Se puede generar una hoja de estilos para la salida. Para comprobar el progreso, se puede abrir el documento raíz de carga útil, realizar ajustes en la hoja de estilos y probar los cambios al generar la salida mediante Arbortext Publishing Engine Interactive. Los autores de XSLT también pueden utilizar este proceso para evaluar las transformaciones que generan el mapa y las listas de artículos de destino.
Es necesario obtener una carga útil del servidor de Arbortext Publishing Engine. WVS y Arbortext Publishing Engine deben configurarse para la publicación. En el servidor de Arbortext Publishing Engine, el archivo de transacciones debe estar configurado y activo. (Consulte la documentación de Configuración de Arbortext Publishing Engine para obtener información acerca del archivo de transacciones, que forma parte de la documentación de Arbortext Publishing Engine). Posteriormente se puede iniciar una solicitud de publicación de la estructura de publicación, la estructura de información o la lista de artículos en Windchill. En el archivo de transacciones, busque la transacción, descárguela y cambie el nombre del cuerpo de la solicitud, denominado rqbody.dat. Cámbiele el nombre con una extensión .zip.
Abra el documento raíz Identifier.xml de la carga útil en Arbortext Publishing Engine Interactive para generar manualmente el mapa de destino. Se pueden extraer primero los ficheros de payload.zip y abrir el documento raíz Identifier.xml o bien abrir payload.zip directamente. La opción Editar > Editar documento transformado solo aparece si se abre un documento Identifier.xml desde una carga útil (el tipo de documento debe ser PublicationStructure para que el elemento de menú esté disponible). Si se elige Edit Transformed Document, Arbortext Publishing Engine Interactive realiza transformación de la aplicación Service en el documento raíz y en todos sus documentos de referencia. El mapa de destino resultante (por ejemplo, techinfomap) se muestra en una nueva ventana.
Si se utiliza una especialización de mapa DITA, se puede utilizar Editar > Editar RDS (documento resuelto para la definición de estilo) en Arbortext Publishing Engine Interactive para ver el resultado con el estilo. Si el destino era otro tipo de documento, se podrá visualizar y publicar el mapa para ver el resultado.
Las secciones siguientes proporcionan algunas sugerencias sobre el diseño de la hoja de estilos techinfo.style.
Título del manual
La hoja de estilos de muestra utiliza el atributo outputclass del elemento de asignación de raíz techinfomap para generar los siguientes títulos:
Valor del atributo outputclass
Título
service
Manual de servicio
installation
Manual de instalación
owners
Manual del propietario
parts
Catálogo de artículos ilustrado
Numeración de la página de título
En la página de título, number y numberlist se utilizan para generar frases que rijan los números de serie, de artículo y de modelo.
Valor del atributo outputclass
Frase
serial
N.º de serie
part
N.º de artículo
model
N.º de modelo
No se genera ningún texto si outputclass está en blanco o presenta un valor distinto de los mostrados. numberlist puede contener numberarrange.
Procedimientos paralelos
Para que un procedimiento aparezca con el texto a la izquierda y los gráficos a la derecha, se debe aplicar una estructura de etiquetas especial. Por lo menos una de las etiquetas procstep debe contener una etiqueta procinfo. Si el procedimiento no presenta ninguna etiqueta procinfo, no aparece como un procedimiento paralelo.
Modificaciones de la tabla Lista de artículos
El marcador XML Lista de artículos es una tabla personalizada. Como tal, la hoja de estilos de Arbortext Styler utiliza algunas de las propiedades de la tabla para aplicar estilos. En la tabla de la lista de artículos por defecto se incluyen las propiedades de número de elemento, contratación, número de artículo, nombre de artículo, cantidad, indicador apto para servicio, no ilustrado y observaciones.
Propiedad
Tipo de datos
Nombre de partattribute
Salida
Nº de elemento
Cadena
itemNumber
Número de secuencia de elemento
Entero
itemSequenceNumber
No
Partida
Entero (0-6)
indenture
No, probado
Número de artículo
Cadena
number
Nombre del artículo
Cadena
name
Cantidad
Cadena
itemQuantity
Indicador apto para servicio
Booleano
serviceable
No, probado
No ilustrado
Booleano
illustrated
No, probado
Referencia
FIG
ITM
ISN
referTo
No
Observaciones
Cadena
remarks
Para probar los valores de serviceable e illustrated, se deben añadir los valores de partattribute name=”serviceable” y partattribute name=”illustrated” como un atributo de partitem mediante la edición de la versión XML de la hoja de estilos, en lugar de hacerlo a través de la interfaz de usuario de Arbortext Styler.
La salida de número de elemento y número de artículo dependen de los valores de las propiedades serviceable y illustrated como se indica a continuación:
Útil
Ilustrado
¿Mostrar número de artículo?
¿Mostrar número de elemento?
True
True
True
Falso
No
Falso
True
No
Falso
Falso
No
No
Al modificar la versión XML de la hoja de estilos y utilizar SetOutputAttribute, los valores se guardan como atributos. A continuación, estos atributos se prueban con los elementos _sfe que se generan como parte de la tabla personalizada.
¿Fue esto útil?