Saltar a contenido

Plantillas de documentos de salida

Un documento de salida se arma a partir de una plantilla: HTML con marcadores donde van los datos del caso. Esta página cubre cómo se escribe la plantilla y qué hacen los ajustes del documento al generar el archivo.

Marcadores

Un marcador es el nombre de la variable con un prefijo, igual que en una condición:

<p>Estimado @#CustomerName,</p>
<p>Factura @#InvoiceNumber por @#Amount.</p>
  • @#Campo escribe el valor de la variable.
  • Una variable que no existe no escribe nada; no detiene el documento.
  • El valor se inserta como texto. Si la variable contiene HTML, se escapa.

Tablas desde una grilla

Una grilla se imprime con un bloque que se repite por cada fila: el nombre de la grilla lo abre con @> y lo cierra con @<.

<table>
  <tr><td>Producto</td><td>Precio</td></tr>
  @>Items
  <tr><td>@#Product</td><td>@#Price</td></tr>
  @<Items
</table>

Todo lo que está entre @>Items y @<Items se repite una vez por fila, con las columnas de esa fila en lugar de los marcadores. Si el bloque no se cierra, el resto del documento queda absorbido por la repetición.

Los ajustes del documento

Ajuste Qué cambia
Título El nombre en el paso y en la lista de documentos del caso
Descripción Contexto para otros diseñadores
Nombre de archivo El nombre del archivo generado
Documento de salida a generar Ambos, Doc o Pdf
Tamaño de página El tamaño de la página (A4 por defecto)
Horizontal La orientación de la página
Márgenes Superior, inferior, izquierdo y derecho
Encabezado y pie Contenido que se repite en cada página
Generador de informes TCPDF o HTML2PDF
Seguridad del PDF Contraseña de apertura y de propietario, y los permisos
Versionado Si cada generación crea una versión nueva
Ruta de destino Dónde se guarda el archivo

Encabezado y pie

Cada documento puede llevar un encabezado y un pie, configurados por separado y aplicados a todas las páginas. Ambos ofrecen las mismas partes:

Parte Qué hace
Logotipo Una imagen, con su ancho y su posición en la página
Título Una línea de texto, con tamaño de fuente y posición
Número de página La página actual
Total de páginas Agrega el total, así la línea dice página 2 de 7

El título y el texto del número de página aceptan marcadores, así que un encabezado puede llevar el número del caso o la fecha del documento.

Imágenes

Una imagen de la plantilla debe ser alcanzable por el servidor que genera el documento: una URL absoluta, o un archivo que el proceso pueda leer. Una ruta relativa que solo existe en el editor se imprime como un recuadro vacío en el PDF.

Los logotipos del encabezado y del pie siguen la misma regla.

Fuentes

El generador usa las fuentes instaladas en el servidor. Una fuente que el servidor no tiene se reemplaza por la predeterminada, y por eso un documento puede verse bien en el editor y distinto en el caso. Las fuentes propias deben instalarse en el servidor, no solo nombrarse en el CSS.

Flujo de páginas

El contenido fluye en tantas páginas como necesite: márgenes, tamaño y orientación salen de los ajustes del documento, y una tabla que no entra continúa en la página siguiente. El encabezado y el pie se repiten en cada una de esas páginas automáticamente.

Qué le hace el generador de PDF al HTML

  • La orientación y el tamaño salen de los ajustes, no del HTML.
  • Las etiquetas <font> antiguas se convierten a estilos en línea, así que una plantilla de una versión anterior conserva su aspecto.
  • El encabezado y el pie se aplican a todas las páginas.
  • Una fuente que no está en el servidor se reemplaza por la predeterminada; es la causa habitual de un documento que se ve bien en el editor y distinto en el caso.

Documentos Doc

Con Documento de salida a generar en Doc la misma plantilla produce un archivo .doc. El CSS complejo no se traduce: las tablas y el texto sobreviven, los trucos de maquetación como los flotantes normalmente no. Cuando la maquetación importa, genera PDF.

Cuando el documento sale mal

Síntoma Normalmente
Un campo sale vacío El marcador nombra una variable que el caso no guardó: revisa la ortografía, el prefijo y que el paso la haya llenado
El resto del documento desaparece después de una grilla El bloque @>Grilla no se cierra con @<Grilla
La maquetación difiere del editor El generador no es un navegador: solo sobrevive parte del CSS y las fuentes desconocidas se reemplazan
Una imagen sale como recuadro vacío La ruta no es alcanzable desde el servidor, o el archivo no es público
Una tabla se corta en el borde de la página La fila es más alta que la página: divídela o reduce el contenido

Versionado

Con el versionado activo, volver a generar el documento no sobrescribe el archivo anterior: el caso conserva ambos y el visor de documentos muestra las versiones. Eso es lo que hace auditable un documento generado.

Relacionado