Generar documentación

Puede generar documentación para los recursos de los módulos y bibliotecas.

Para generar la documentación, siga estas instrucciones:

  1. Seleccione el recurso en la vista Integración empresarial.
  2. Pulse Generar documentación en la barra de herramientas, Botón Generar documentación en la barra de herramientas o pulse con el botón derecho para seleccionar Generar Documentación.... Se abre el asistente Generación de documentación.
    Nota: Todos los campos de este asistente tienen información de ayuda F1 que facilita la especificación de valores. Utilice la tecla Tabulador para desplazar el foco hasta el campo o botón y pulse la tecla F1 (Ctrl+F1 en Linux) para visualizar la ayuda adicional.
  3. En el asistente Generación de documentación, especifique el Nombre de autor, Título de documentación y una ubicación para el archivo PDF que se generará. El nombre de archivo por omisión es reportFile.pdf y la ubicación por omisión es en su área de trabajo. Consulte la ayuda F1 para obtener instrucciones sobre cómo cambiar el nombre del informe.
  4. Puede aceptar los valores por omisión y pulsar Finalizar para generar la documentación. No obstante, si desea seleccionar que se incluyan recursos adicionales en la salida o cambiar el diseño de la documentación, pulse Siguiente.
    Nota: Si el botón Finalizar no está habilitado, ha seleccionado un recurso que el generador de documentación no soporta. Debe pulsar Siguiente para crear un nuevo archivo maestro. A continuación, posteriormente, podrá seleccionar un recurso que el generador de documentación soporte. Consulte "Documentación o recurso" en los conceptos relacionados para obtener información adicional sobre la documentación de recursos.
    1. En la página Seleccionar contenido, especifique si desea personalizar más el contenido de la salida generada.
      • Seleccione Generar documentación del recurso seleccionado si no desea añadir o eliminar recursos para la generación de documentación.
      • Seleccione Generar documentación desde un archivo maestro existente y un archivo maestro para volver a ejecutar un perfil de recursos guardado anteriormente.
      • Seleccione Crear un nuevo archivo maestro para añadir o eliminar recursos para esta generación de documentación.
      Consulte "Documentación o recurso" en los conceptos relacionados para obtener información adicional sobre los archivos maestros. Pulse Siguiente.
    2. En la página Editar contenido puede añadir o eliminar recursos de la documentación. Seleccione un recurso y pulse > para añadirlo a la tabla Recursos de entrada de documento. También puede seleccionar elementos en la tabla y pulsar < para eliminar el contenido de la documentación a generar. Seleccione el recuadro de selección Incluir archivo de referencia para generar también información de los artefactos referidos por los recursos seleccionados. Consulte "Documentación o recurso" en los conceptos relacionados para obtener información adicional sobre los archivos referidos.

      El botón Guardar como... guarda el nuevo archivo maestro para que pueda volver a generar el mismo informe utilizando el archivo maestro. Pulse Siguiente.

    3. En la página Valores de diseño, seleccione el diseño de la documentación que necesita y pulse Finalizar para generar la documentación.
      Nota: 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.
      Para añadir fonts nuevos y utilizarlos en la documentación, consulte el tema "Añadir fonts" que viene a continuación.
  5. Busque el archivo PDF en la ubicación que ha especificado y ábralo con Acrobat Reader.

Añadir fonts

Si desea añadir fonts nuevos para poder utilizarlos en la documentación generada, lance el asistente Generación de documentación y pulse Siguiente hasta llegar a la página Valores de diseño:

Página Valores de diseño del asistente Generación de documentación

A continuación, siga estos pasos:

  1. Seleccione el recuadro de selección Sobrescribir fonts predeterminados. Se habilitará el botón Fonts....
  2. Pulse Fonts... y se abrirá la página Valores de estilo de documentación:

    Página Valores de estilo de documentación

  3. Pulse Gestionar fonts... y se abrirá la ventana Gestionar fonts de documentación.

    Ventana Gestionar fonts de documentación

  4. Pulse el botón Añadir.... Se abrirá la ventana Añadir font de documentación.

    Ventana Añadir font de documentación

  5. Pulse Examinar para abrir la ventana Abrir y localizar los archivos TTF o TTC y seleccionarlos.
    Nota: (Solo Windows) Si desea seleccionar fonts del directorio Windows, por ejemplo, WINNT o WINDOWS, debe volver a escribir el nombre del archivo TTF o TTC en la ventana Abrir, que se muestra aquí:
    Ventana Abrir en el directorio WINNT
    Por omisión, si pulsa dos veces en el archivo del directorio WINNT, Windows abre el archivo TTF o TTC en lugar de seleccionarlo, de modo que, para seleccionarlo, deberá escribir el nombre. Para utilizar el ratón en esta selección, copie el archivo TTF o TTC en otro directorio. A continuación, podrá utilizar el ratón para pulsar y seleccionar el archivo de font.

    Si se selecciona un archivo TTC, debe entrarse un nombre válido de font.

  6. Pulse Aceptar en la ventana Font de documentación para completar la selección. Debe poder ver el nuevo font en la ventana Gestionar fonts 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.
  7. Pulse Aceptar para regresar a la página Valores de estilo de documentación, donde ahora podrá seleccionar el nuevo font para los tipos de texto que figuran en la lista.

El nuevo font ya se ha registrado, lo que hace que esté a disposición de todas las generaciones de documentación posteriores. Los fonts por omisión no se pueden eliminar.

Referencia relacionada
Documentación de recursos

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