Generar Documentación [Guía de Usuario de Enterprise Architect]

Top Previous Next

Generar Documentación

button_main button_prev button_next

Es posible especificar una amplia gama de parámetros para controlar como es generado y como sale su informe de documento. Puede especificar, por ejemplo, donde es escrito el archivo de documento, en que formato es generado, y que elementos son incluidos en el documento. Usted configura estas opciones en la ventana Generar Documentación, en la cual las opciones son proporcionadas en varias pestañas.

La primera, y predeterminada, pestaña es la pestaña Generar, en la cual usted define como y donde se genera el documento. Después de que haya configurado las opciones en cualquiera o todas las otros pestañas, debe volver a la pestaña Generar y hacer clic en el botón Generar para producir su documento.

Acceso paquete de Explorador de Proyecto: ( F8 ) > Generar o

Elemento de Diagrama ( F8 ) > Generar

Configurar Opciones de Generación de Informe

Opción

Acción

Ver También

Documento Modelo

 

 

Elemento Raíz

Paquete Raíz

Revise el nombre del elemento seleccionado desde el Explorador de Proyectos, diagrama, Lista de Diagrama, Administrador de Especificación o Búsqueda Modelo.

Si este es el elemento de Documento Modelo creado especialmente para un documento virtual, el campo es Documento Modelo.

De lo contrario, este campo identifica el elemento seleccionado de la jerarquía sobre el cual informar, el Elemento Raíz o Paquete Raíz.

 

 

 

Documento Virtual

Salida a Archivo

Escriba o seleccione la ubicación y el nombre de archivo para la documentación generada.

Haga clic en el botón ( ... ) (Explorar) para navegar a la ubicación.

 

 

Plantilla

Haga clic en la flecha de despliegue y seleccione el nombre de la plantilla para utilizar para su informe de documento.

Puede seleccionar cualquier plantilla de la lista de despliegue, la cual está dividida en plantillas del Usuario (o personalizadas) y plantillas del Sistema. Si ya ha cargado una Tecnología MDG que contiene plantillas de documento, estas también son listadas bajo el nombre de Tecnología.

También puede crear inmediatamente una nueva plantilla, al seleccionar la opción <nueva plantilla>.

El sistema revisa todas las carpetas de plantilla para la plantilla especificada, en el orden Plantillas de Usuario > Plantillas de Tecnología >Plantillas del Sistema. Si hay diferentes plantillas con el mismo nombre disponibles, el sistema utiliza la primera encontrada en esta secuencia.

 

Seleccionar una Plantilla

Plantillas de Documento Personalizadas

Plantillas de Documento de Sistema

Tabla de Contenidos

Haga clic en la flecha de despliegue y seleccione el nombre de la definición de la Tabla de Contenidos para aplicar para su informe de documento.

Puede seleccionar cualquier definición de la lista de despliegue, ya sea un formato TOC estándar o un formato diseñado por el usuario.

Utilice el valor predeterminado <ninguno> para no incluir una Tabla de Contenidos, o para utilizar una tabla de Contenidos incorporada en la plantilla seleccionada definida por el usuario.

 

Seleccionar una Tabla de Contenidos

Hoja de Estilo

Haga clic en la flecha de despliegue y seleccione el nombre de la Hoja de Estilo para aplicar a su informe de documento.

Puede seleccionar cualquier Hoja de Estilo de la lista de despliegue, ya sea una definición TOC estándar o un conjunto de estilos diseñados por el usuario.

Utilice el valor predeterminado <ninguno> para no utilice una Hoja de Estilo y en lugar aplicar los estilos definidos en la plantilla que seleccionó en el campo Plantilla (arriba).

 

Seleccionar una Hoja de Estilo

Página de Portada

Haga clic en la flecha de despliegue y seleccione el nombre de la definición de la página de portada para aplicar para su informe de documento.

Puede seleccionar cualquier definición de la lista de despliegue, ya sea un formato estándar o una página diseñada por el usuario.

Utilice el valor predeterminado <ninguno> para no incluir una página de portada, o para utilizar una página de portada incorporada en la plantilla seleccionada definida por el usuario.

 

Seleccionado una Hoja de Portada

Formato de Salida

Haga clic en la flecha de despliegue y seleccione el formato en el cual sacar el informe. El formato predeterminado es el Formato de Texto Enriquecido (.RTF), pero también puede seleccionar:

Formato de Documento Portable (.PDF) o

Formato de Documento Microsoft (.DOCX)

 

 

Utilizar Sustituciones del Lenguaje

Seleccione esta casilla para encender las sustituciones de palabras del lenguaje personalizadas.

Deseleccione la casilla para apagar las sustituciones de palabras del lenguaje personalizadas.

 

Sustitución de Palabra

Ver Documento Al Completarse

 

Seleccione esta casilla para abrir el informe de documento apenas haya sido generado.

 

Utilizar Visor Interno

Seleccione esta casilla para activar el botón Ver para lanzar el documento generado en el visor interno de Enterprise Architect.

Deseleccione esta casilla para activar el botón Ver para lanzar el documento generado en el visor de archivo predeterminado de Windows MS.

 

Opciones de Documento

Incluir todos los Elementos de Diagrama en el Informe

Seleccione esta casilla para incluir elementos en el informe desde paquetes externos que son referenciados a partir de un diagrama, para cada diagrama que abarca el informe; la casilla se predetermina a lao seleccionado.

Para incluir los elementos externos en el documento, también seleccione las casillas Package.Diagram.Element y Package.Element en la plantilla actual.

Si los elementos externos deben ser incluidos sólo para diagramas específicos, deseleccione esta casilla y - sólo para los diagramas para los cuales quiera incluir elementos externos en el informe - para cada diagrama seleccione la casilla Documentar cada elemento contenido en RTF en las propiedades de diagrama.

Cuando ambas opciones están deseleccionadas, o cuando ningunas de las casillas Package.Diagram.Element o Package.Element están seleccionadas en la plantilla, sólo los elementos del paquete actual son documentados.

 

 

 

 

 

Opciones de Diagrama

Utilizar modo de Pizarra para todos los diagramas

 

Todos los diagramas que aparecen en el Informe RTF se muestran si está activado el Modo de Pizarra.

Configurar Visualización de Diagrama

Tema

Haga clic en la flecha de despliegue y seleccione un Tema al cual aplicar el color, grosor de línea y estilo de fuente para representaciones de elementos en el informe, si esos elementos están utilizando valores predeterminados.

Si un elemento tiene una apariencia ajustada asignada utilizando, por ejemplo, al ventana de Apariencia Predeterminada, esa apariencia anula las configuraciones de Tema.

La opción predeterminada es el Tema que ha configurado actualmente en sus opciones Locales. Puede, sin embargo, seleccionar cualquier otro Tema para este informe. Las configuraciones del campos se revierten a su Tema predeterminado después de que el informe es generado.

 

Opciones de Tema de Diagrama

 

Configurar la Apariencia Predeterminada de un Elemento

Documento de Recurso

Haga clic en este botón para guardar las opciones guardas actualmente como una definición de documento.

 

Documentos de Recurso

Editar Plantilla

Haga clic en este botón para editar la plantilla seleccionada actualmente utilizando el Editor de Plantilla de Documento.

Sólo puede editar plantillas definidas por el usuario, no las plantillas estándares proporcionadas por el sistema. Si ha seleccionado una plantilla de sistema, este botón se encuentra atenuado.

 

Diseñar Plantillas de Documento Personalizado

Generar

Haga clic en este botón para generar el documento (después de que haya configurado todas las opciones que requiera, en todas las pestañas de la ventana).

 

 

Ver

Haga clic en este botón para lanzar el documento generado en:

El visor de archivo predeterminado de MS, o

El visor interno de Enterprise Architect, si ha seleccionado la casilla Utilizar Visor Interno (arriba)

 

 

Abortar

Haga clic en este botón para cancelar la generación del informe; se muestra una solicitud para confirmar la cancelación del informe.

 

 

Notas

Para una introducción para generar informes de documento, vea el tema de Ayuda de Informes de Documento

La segunda pestaña en la ventana Generar Documentación, Plantillas, es utilizada para desarrollar y mantener:

Plantillas personalizadas

Hojas de Estilo personalizadas

Tablas de Contenidos personalizadas y

Páginas de Portada personalizadas

 

Aprender más

Informes de Documento

Plantillas de Documento Personalizadas

Filtros de Elementos

Otros Filtros

Constantes de Proyecto

Sustitución de Lenguaje (Página de código)

 

Temas de Centro de aprendizaje

Alt+F1 | Enterprise Architect | Informar | Informes de Texto Enriquecido | Generar un Informe RTF