La plantilla Word, es un documento .docx que contiene la estructura y el estilo que se utiliza para generar la documentación Word de un proceso.
Al generar la documentación, esta plantilla Word es copiada y completada con los datos del proceso. Cualquier imagen, estilo o texto estático será replicado en el documento de salida.
Dentro del documento .docx se pueden utilizar determinados TAGS (encapsulados por los caracteres <<>>).
A la hora de generar la documentación, estos TAGS son identificados y procesados de acuerdo a su significado. Existen dos clases diferentes de TAGS:
TAGS de Datos
Son reemplazados por los datos correspondientes al proceso. Normalmente representan atributos de algún elemento del proceso.
Se debe tener en cuenta que el texto que reemplace al TAG mantendrá el mismo formato y estilo que el propio TAG.
TAGS Identificadores
Se utilizan para determinar la posición de un elemento. En el documento Word resultante, estos TAGS son borrados y no se remplazan por ningún texto. Son necesarios para identificar la ubicación de los títulos o de las tablas contenedoras de atributos (TAGS de Datos).
Comienzan con el prefijo “TITULO-” para títulos o “T-” para tablas.
Identificadores de Títulos ("TITULO-")
Se usan para indicar que un cierto texto, escrito en la plantilla Word, es en realidad un Titulo. Se deben ubicar en el mismo párrafo que está ubicado el texto/título.
Necesitamos saber esto, para poder ocultar ese texto/titulo, cuando no corresponda incluirlo en la documentación resultante (esto depende de la plantilla de impresión utilizada).
Ejemplo de definición de título del diagrama:
EL texto "Diagrama del Proceso" es el título que precede a los diagramas del proceso.
El tag <<TITULO-DIAGRAMA-PROCESO>>, ubicado en el mismo párrafo permite asociar el texto con su significado.
Diagrama del Proceso <<TITULO-DIAGRAMA-PROCESO>>
<<DiagramaProceso>>
Entonces, si en la plantilla de impresión se especifica "Imprimir Diagrama=SI", se incluye en el documento de salida el titulo y el diagrama del proceso, respetando los estilos de tipografías y colores indicados en la plantilla. Se obtendrá:
Diagrama del Proceso
<<DiagramaProceso>>
Caso contrario, si en la plantilla de impresión se especifica "Imprimir Diagrama=NO", no se incluye en el documento de salida ni el titulo ni el diagrama del proceso.
Indentificadores de Tablas ("T-")
Estos TAGS deben ubicarse en la primer fila de la tabla (en cualquier posición).
Se usan para determinar el significado de una tabla existente en la plantilla Word.
Necesitamos saber esto, para poder ocultar o visualizar la tabla dependiendo de lo indicado en la plantilla de impresión.
Cuando se procesa el documento se puede determinar qué tabla es y qué elementos puede contener.
Ejemplo de definición de la tabla de responsable:
Responsable <<T-RESPONSABLE-ELEMENTO>> |
|
Nombre |
<<NombreRes>> |
Descripción |
<<DescRes>> |
Si en la plantilla Word se encuentra una tabla y no contiene uno de estos tags válidos, no será procesada por el generador de documentación.
Es decir, se incluye la tabla en la documentación resultante, pero como si fuese contenido estático, no se realiza ningún reemplazo ni procesamiento sobre esta tabla.
Los tags que se utilizan dentro de las tablas pueden estar en cualquier posición y combinados de cualquier manera dentro de una celda.
Sin embargo no pueden estar dentro de otra tabla que este contenida en una celda de la tabla.
A continuación se describe cada TAG y en que estructuras pueden colocarse para que sean reemplazados correctamente.
El siguiente documento es ejemplo (en formato PDF) de una plantilla Word. Le permitirá observar como se utilizan los TAGS a lo largo del documento.
