Documentación de recursos

Además de poder ver recursos, quizás también necesite documentar las aplicaciones que construye. WebSphere Integration Developer proporciona una herramienta para generar la documentación de los recursos de los módulos, los módulos de mediación y las bibliotecas.

La generación de documentación se inicia invocando un asistente. Puede personalizar el contenido de la documentación seleccionando múltiples recursos de uno o varios módulos y bibliotecas para que toda la información se escriba en un único informe, que es un archivo PDF. También puede especificar el diseño y los fonts de la salida. Encontrará los detalles sobre cómo generar la documentación en las tareas relacionadas.

Documentación de recursos

El generador de documentación produce la siguiente información de los siguientes recursos:

El generador de documentación no documentará los demás recursos.

Archivos referidos

El generador de documentación también puede crear documentación de determinados recursos y los recursos a los que hace referencia. Por ejemplo, en el asistente Generación de documentación, puede seleccionar el proceso de negocio y la opción Incluir archivos referidos. Como consecuencia, el informe PDF generado también tendrá información de los recursos (por ejemplo, interfaces invocadas por sus actividades) a los que hace referencia el proceso.

Estructura de la documentación

El informe PDF generado tiene la siguiente estructura:

  • Página de título

    Contiene el título del informe, nombre de autor y fecha del informe.

  • Tabla de contenido

    Lista de las secciones y números de página del informe.

  • Secciones de documentación de recursos

    Lista las propiedades de los recursos. Excepto para los módulos y bibliotecas, todos los recursos tienen también imágenes de los recursos abiertos en la vista Editor.

  • Referencias cruzadas

    Indica para cada recurso documentado los recursos que lo utilizan (Lista de proveedores) y dónde se utilizan (Lista de receptores).

  • Apéndice: valores de generación de documentación

    Lista de los valores de generación de documentación especificados en el asistente Generación de documentación y que se han utilizado para el informe PDF.

Diseño y estilo de la documentación

El diseño y estilo del informe PDF generado puede personalizarse con el Asistente de generación de documentación. Si cambia los valores de diseño y estilo, se guardarán para todas las generaciones posteriores de documentación, hasta que se vuelvan a cambiar.

Los siguientes valores de diseño se pueden modificar:

  • Tamaño de papel

    Define el tamaño de papel de la documentación generada.

    Valor por omisión: carta

  • Nivel de la tabla de contenido

    Define el máximo nivel de temas que figurarán en la tabla de contenido del informe.

    Valor por omisión: 7

  • Font
    Define la familia de font, tamaño de font y estilo de font de la salida. Los valores de font por omisión son los siguientes:
    • Texto sin formato

      • Se utiliza en la descripción y documentación de diferentes artefactos. La familia de font de texto sin formato también se utiliza para la portadilla, la cabecera y el pie de página.
      • Familia de font por omisión: Helvetica
      • Tamaño de font por omisión: 10
      • Estilo de font por omisión: regular
    • Título de capítulo

      • Se utiliza en las cabeceras numeradas, la cabecera de la tabla de contenido y la cabecera del apéndice
      • Familia de font por omisión: Helvetica
      • Tamaño de font por omisión: 14
      • Estilo de font por omisión: negrita
    • Texto de código fuente

      • Se utiliza para la documentación de código fuente como Java
      • Familia de font por omisión: Courier
      • Tamaño de font por omisión: 10
      • Estilo de font por omisión: regular
    • Texto de pie

      • Se utiliza en los pies de imágenes
      • Familia de font por omisión: Helvetica
      • Tamaño de font por omisión: 10
      • Estilo de font por omisión: negrita
    • Texto de definición

      • Se utiliza en la documentación de pares valor-clave
      • Familia de font por omisión: Helvetica
      • Tamaño de font por omisión: 10
      • Estilo de font por omisión: regular
    • Texto de cabecera

      • Se utiliza en las cabeceras no numeradas
      • Familia de font por omisión: Helvetica
      • Tamaño de font por omisión: 11
      • Estilo de font por omisión: negrita
    • Tabla de contenido

      • Se utiliza en las tablas de contenido
      • Familia de font por omisión: Helvetica
      • Tamaño de font por omisión: 9
      • Estilo de font por omisión: regular

Archivos maestros para guardar valores

Un archivo maestro es un perfil de recursos que define el contenido (no los estilos de font) que debe incluirse en la documentación general. Cuando utilice el asistente de Generación de documentación, cree un archivo maestro para guardar las selecciones de recursos y la siguiente vez que utilice el asistente para generar el mismo informe, simplemente seleccione el archivo maestro.

Registrar fonts nuevos

El generador de documentación proporciona tres fonts por omisión que se pueden utilizar en la documentación. Estos fonts son Helvetica, Courier y Times con los estilos de font: regular, cursiva, negrita y cursiva negrita.

Puede añadir un font nuevo, tanto como archivo font True Type (.ttf) como archivo de colección True Type (.ttc), registrándolo. El registro de font se realiza desde el asistente Generación de documentación. Una vez se ha registrado un font, éste puede utilizarse en todos los informes hasta que se elimine. Los fonts por omisión no se pueden eliminar. Consulte el apartado "Generar documentación" en las tareas relacionadas para obtener instrucciones sobre cómo trabajar con el asistente Generación de documentación.

Nota: En el asistente Generación de documentación, los nombres de los fonts registrados, incluyendo los nombres de fonts de Juego de Caracteres de Doble Byte, sólo se muestran en letras del juego de caracteres Latin.

Archivo de rastreo

El generador de documentación puede escribir mensajes de rastreo de generación de documentación en un archivo de rastreo. Nota: no active esta función de rastreo a no ser que exista un problema en el generador de documentación, puesto que el rastreo afecta al rendimiento del sistema y puede ocupar mucho espacio en disco. El rastreo se establece en la ventana de preferencias y la salida se escribe en un archivo de texto en el directorio de metadatos (nombre_espacio_trabajo\.metadata\.plugins\com.ibm.wbit.reporting.infrastructure\trace\). Las entradas de anotaciones se añaden al final y nunca se borran.

Conceptos relacionados
Módulos y bibliotecas
Módulos y dependencias de bibliotecas
Posibilidades y roles de Integración empresarial
Hojas de apuntes de Integración empresarial
Tareas relacionadas
Crear un módulo para servicios de negocio
Crear un módulo de mediación
Cambiar espacios de nombres por omisión
Habilitar las posibilidades de las herramientas
Añadir dependencias en módulos y bibliotecas
Crear la biblioteca
Generar documentación

Información relacionada

Guía de aprendizaje: trabajar con módulos y bibliotecas

Comentarios
(C) Copyright IBM Corporation 2005, 2006. Reservados todos los derechos.