Opciones de documentación

www.altova.com Imprimir este apartado Página anterior Subir un nivel Página siguiente

Inicio >  Guía y referencia del usuario > Comandos de menú > Menú Diseño de esquemas > Generar documentación >

Opciones de documentación

El comando Diseño de esquemas | Generar documentación genera documentación detallada sobre el esquema activo, ya sea un esquema XML o un esquema JSON. Esta sección explica cómo generar documentación para esquemas XML. El procedimiento para generar documentación para esquemas JSON es similar y se describe en la sección Generar documentación para esquemas JSON.

 

Generar documentación para esquemas XML

Si el documento activo es un esquema XML y hace clic en el comando Diseño de esquemas | Generar documentación, aparece el cuadro de diálogo "Documentación del esquema" (imagen siguiente), donde puede configurar la documentación antes de generarla.

 

En el panel Diseño de la documentación del cuadro de diálogo puede seleccionar si para generar la documentación se usa el diseño fijo de XMLSpy o un diseño personalizado y creado en un archivo SPS de StyleVision. Recuerde que la documentación se puede generar en formato PDF solamente si usa un archivo SPS de StyleVision, no con el diseño fijo. Para más información consulte el apartado Diseño definido por el usuario.

schema-doc-ge4ndbox

A continuación explicamos el resto de opciones del cuadro de diálogo "Documentación del esquema":

 

Formato de salida: en este panel puede configurar el formato de salida, que puede ser HTML, Microsoft Word, RTF o PDF. (El formato de salida PDF solamente está disponible si usa un archivo SPS de StyleVision para generar la documentación). Al hacer clic en Aceptar, se le pide un nombre para el archivo de salida y la ubicación donde desea guardarlo.
Los documentos de Microsoft Word se crean con la extensión de archivo .doc si usa el diseño fijo para generar la documentación y con la extensión de archivo .docx si usa un archivo SPS de StyleVision.
Dividir documentación en múltiples archivos: la documentación puede generarse en un solo archivo o dividirse en varios archivos. Si marca esta casilla, se genera un archivo por cada componente. Use las casillas del panel Incluir para especificar qué componentes se incluyen en la documentación. En la documentación de diseño fijo, se crean automáticamente hipervínculos entre los componentes relacionados entre sí.
Incrustar CSS en HTML: si genera la documentación en formato HTML, las definiciones de estilos CSS se pueden guardar por separado en un archivo CSS o se pueden incrustar en el archivo HTML (en el elemento <head>). Si crea un archivo CSS, se crea con el mismo nombre que el archivo HTML, pero con la extensión .css. Active o desactive la casilla Incrustar CSS en HTML según corresponda.
Incrustar diagramas: esta casilla se habilita si selecciona los formatos de salida MS Word, RTF o PDF. Si marca esta casilla, los diagramas se incrustan en el archivo de salida, en formato PNG. De lo contrario, los diagramas se crean como archivos PNG y la documentación incluye enlaces a estos archivos por medio de vínculos de objeto.
Crear carpeta para los diagramas: si genera la documentación en formato HTML, todos los diagramas se crean como archivos PNG externos. Si marca la casilla Crear carpeta para los diagramas, se crea una carpeta en la carpeta donde está la documentación HTML y los archivos PNG se guardan dentro de ella. Esta carpeta tendrá un nombre tipo NombreDelArchivoHTML_diagramas. Si esta casilla no está marcada, los archivos PNG se guardan en el mismo directorio que la documentación HTML.
Generar vínculos a archivos locales: en este panel puede elegir si los vínculos a archivos locales (como los archivos de imagen de los diagramas y el archivo CSS externo) son relativos o absolutos.
Incluir: en este panel puede seleccionar qué componentes incluye la documentación. Todos los elementos marcados en este panel aparecerán en la documentación. Por ejemplo, si marca la casilla Atributos locales, la documentación incluirá una descripción para cada atributo local. Si marca la casilla Índice, todos los esquemas relacionados aparecerán al principio de la documentación y sus componentes globales aparecerán agrupados por tipos. Con los botones Activar todos/Desactivar todos puede seleccionar rápidamente todas las opciones del panel o anular la selección. Nota: las opciones elegidas en este panel no influyen en la representación gráfica del tipo de componente dentro de la documentación. La representación gráfica de los componentes viene dada por la configuración elegida en el cuadro de diálogo Configurar visualización del esquema. Es decir, si prefiere que los atributos no aparezcan en la representación gráfica de un elemento del esquema, entonces debe desactivar los atributos en el cuadro de diálogo Configurar visualización del esquema.
Detalles: en este panel puede seleccionar qué detalles se incluyen en la documentación de cada componente. Con los botones Activar todos y Desactivar todos puede activar/desactivar todas las opciones del panel con un solo clic.
Mostrar archivo resultante tras ser generado: esta casilla está disponible para todos los formatos de salida. Si está marcada, los archivos resultantes se abren inmediatamente en la vista Explorador (documentación HTML), en MS Word (documentación Word) y en las aplicaciones predeterminadas para archivos .rtf (documentación RTF) y archivos .pdf (documentación PDF).

 

Valores de los parámetros

Si el archivo SPS de StyleVision contiene definiciones de parámetros, al hacer clic en Aceptar aparece un cuadro de diálogo con todos los parámetros definidos en el archivo SPS. Puede escribir nuevos valores de parámetro en este cuadro de diálogo para reemplazar los valores predeterminados que se asignaron en el archivo SPS.

 


© 2019 Altova GmbH