Una plantilla de documento define la estructura, el diseño
y el contenido de un informe. La creación de una plantilla
correcta requiere planificar, desarrollar, probar y almacenar
la plantilla.
1: Recopilar requisitos
Distintas
necesidades requieren diseños diferentes. Determine las necesidades
empresariales y los requisitos prácticos del documento antes de
empezar a diseñar sus plantillas.
- Elementos de datos
- Existe una variedad de elementos de plantilla que muestran
distintos tipos de información. ¿Qué información necesitan las
personas que visualizarán el documento? Una vez que lo sepa, podrá
empezar a determinar elementos de datos:
- ¿Qué elementos de plantilla muestran esos datos? ¿Qué aspecto
tendrá el documento final?
- ¿Existe más de una forma para mostrar la información? En caso
afirmativo, ¿qué visualización se adapta mejor al contexto en el
cual se visualizará el documento?
- ¿Cuántos datos son necesarios? Es posible que pueda filtrar datos
innecesarios, lo que puede ahorrar tiempo al generar la salida del
informe.
- Tipo de salida
- Considere qué tipo de salida podría servir mejor a las
necesidades de las personas que visualizarán el documento. La
plantilla que diseñe podría tener un aspecto diferente cuando se
genera en distintos tipos de salida. Algunos elementos se optimizan
para visualizar en un formato particular y algunos no están
soportados en determinados formatos. Familiarícese con la forma en la
que se visualizan los elementos de plantilla en distintos formatos
de salida. Esto le permite seleccionar elementos y el tipo de
salida que mejor funcionan juntos.
- Una plantilla vs. muchas plantillas
- ¿Se trata de una plantilla de un solo uso o podría reutilizar
algunos de los fragmentos en otras plantillas?
- Una plantilla: Puede utilizar una plantilla para contener todas
las distintas partes del diseño de documento. Esto significa que
todo está en un lugar y no es necesaria ninguna fusión.
- Muchas plantillas: Puede utilizar un enfoque modular, crear
varias plantillas que, después, se pueden fusionar juntas para
crear un documento completo. Por ejemplo, puede tener una
plantilla de tabla de contenido, plantilla de portada,
plantilla de datos, plantilla de indice y plantilla de tapa
posterior. Estas plantillas se pueden reutilizar en la generación
de distintos documentos.
Determine el número de plantillas
necesarias dados estos requisitos. Puede denominar y describir cada
bloque de plantilla en los atributos de metadatos. El contenido de
nombre se muestra en la plantilla y el contenido de la descripción se
muestra en el campo de pista de elemento de plantilla.
- Visualización de contexto
- ¿Cómo verá alguien este documento?
- ¿Se imprimirá? ¿Se verá en pantalla? ¿Ambas cosas?
- ¿Se ejecutará en un producto integrado?
2: Diseñar una plantilla
Al
diseñar una plantilla, las tácticas siguientes pueden ayudarle a
utilizar su tiempo eficientemente.
- Implemente la estructura general de la plantilla utilizando un
enfoque descendente. Empiece con los elementos más generales y,
después, céntrese cada vez más en los detalles.
- Valide la generación de datos antes de centrarse en los detalles
de formato.
Si dedica mucho tiempo al formato y, después, descubre que los datos
no se están generando correctamente, es posible que tenga que volver
a dar formato. Consulte 3. Probar
la plantilla para ver detalles.
- Pula los detalles y añada requisitos más detallados de uno en uno.
Deje los detalles menos importantes o los difíciles para
implementarlos más tarde.
Considere la importancia de los requisitos que son difíciles de
lograr, como lo haría en un análisis de coste-beneficio.
- Considere el uso de scripts para extraer información en un
formato que
Rational Publishing Engine
puede consumir de forma eficaz.
- Se puede diseñar una plantilla para proporcionar propiedades de
diseño de página específicas, como el tamaño de página, orientación,
márgenes, número de columnas y estilos para los tipos de
párrafos que con mayor probabilidad se utilizarán en documentos.
- Una plantilla puede contener:
- Elementos de estructura de documento, como párrafos,
tablas, listas y una tabla de contenido.
- Bloques de diseño de documento, como páginas maestras, hojas de
estilo, cabeceras y pies de página.
- Estilos definidos por usuarios internos y externos, como formato
de texto o párrafo. El formato de texto incluye negrita, cursiva,
subrayado, tamaño de font y color de font. El formato de
párrafo incluye márgenes, bordes, sangrado y parámetros de scripts en
la forma de JavaScript.
- Contenido de plantilla incorporada, como imágenes, texto estático
y referencias a archivos estáticos y hojas de estilo.
- Elementos de datos, como atributos, condiciones y elementos de
datos dinámicos.
- Extracción de datos en forma de consultas y filtros.
- Variables externas que reciben valores durante el tiempo de
ejecución y variables internas que se utilizan para cálculos. La
creación de variables externas es preferible a codificar los URL
de origen en la plantilla. Si codifica los URL y cambia el nombre del
servidor, deberá actualizar los URL en todas las plantillas. Con
variables externas, puede alterar temporalmente los URL durante el
tiempo de ejecución. Para las plantillas que están incorporadas en
otros productos, utilice las variables especiales que reconocen
estos productos cuando hacen referencia a datos.
- Inicie Document Studio.
- Crear
una nueva plantilla, a partir de cero o basándose en una
plantilla existente.
- Añadir
el esquema de origen de datos.
- Añadir
elementos.
- Añadir
formato a elementos.
- Definir
contenido dinámico.
- Opcional:
Refinar
los datos con filtros, clasificaciones o condiciones.
3: Probar la plantilla
- Las pruebas se realizan de forma incremental durante el
desarrollo. Guárdelas con frecuencia y con nombres exclusivos. Verifique
la salida con frecuencia utilizando un pequeño conjunto de datos de
prueba. No añada más elementos, hasta que los que ya tenga funcionen.
- Después de desarrollar la mayor parte del documento, realice una
prueba de carga para comprobar problemas de rendimiento. Utilice la
herramienta Vista previa para limitar el tamaño de los datos que se
están utilizando. El informe generado sigue siendo preciso, pero se
ejecuta más rápidamente porque el máximo de registros predeterminado
por consulta que
recupera
Rational Publishing Engine
es 10 registros. Al probar condiciones, es posible que ningún
registro de los primeros 10 coincida con la condición. En este caso,
utilice la herramienta Ejecutar, en lugar de la herramienta Vista
previa o cambie el valor para el máximo de registros por consulta en
las Preferencias.
- Pruebe la plantilla en distintos formatos de salida. Es posible
que encuentre que un tipo de salida no muestra la plantilla, así como
otro tipo de salida.
- Ejecute la herramienta de verificación.
- Genere una vista previa.
4: Almacenar la plantilla
- Guarde las plantillas desarrolladas y probadas en el Creador
de documentos.
- Asegúrese de proporcionar alguna información en los metadatos de
plantilla para que otros sepan cómo reutilizar la plantilla. Algunos
datos de ejemplo y alguna información de especificación de
documento de ejemplo para los datos del proyecto ayudan en la
reutilización eficaz de estas plantillas.
Siguientes pasos
Tras haber
creado y probado las plantillas: