Diferencias

Muestra las diferencias entre dos versiones de la página.

--- a:system_configuration:templates [2025/05/29 12:57]
creado, vcortes
+++ a:system_configuration:templates [2026/09/14 19:00] (actual)
wiki: a:system_configuration:templates profundiza "Modificar una plantilla" con sus campos (Lenguaje de plantilla, Tamaño de papel, Generar en formato horizontal, Generar PDF, Depuración/Desarrollo), el comportamiento por Tipo (Reporte personalizado, Mensaje a deudores, Encabezado) y los avisos de guardado (JavaScript no permitido, encabezado duplicado, tamaño de papel faltante, plantilla ya bloqueada por JavaScript existente). (+1 mejoras más de la corrida), algebraix
@@ Línea 1: / Línea 1: @@
 ====== Plantillas de documentos ======
+Las plantillas de documentos son formatos generados mediante código, diseñados para permitir la impresión de información de la plataforma con un formato específico. Por ejemplo, puedes crear plantillas para imprimir calificaciones, certificados o kardex, según tus necesidades.\\
+**IMPORTANTE:** La creación de estas plantillas mediante código puede ser solicitada directamente al equipo de soporte técnico de Algebraix.
+===== Crear plantilla =====
+  - Desde tu **Panel de control**, dirígete a la sección **Configuración del sistema**.
+  - Selecciona **Plantillas de documentos**.
+  - Una vez que ingreses, haz clic en la pestaña “Crear plantilla”
+  - Se desplegarán varias opciones, selecciona **Crear plantilla.**
+  - Deberás completar la siguiente información:
+    * **Nombre:** Agrega el nombre que darás a tu plantilla.
+    * **Tipo:** Despliega el tipo para seleccionar la información que se imprimirá en la plantilla que vas a generar.
+      * **Aviso/Carta/Generación de listas:** Utiliza este tipo de documento para la impresión de avisos, cartas para tus usuarios y lo resultando del menú "Generación de listas".
+      * **Administración de folios:** Imprime toda la información relacionada con los ingresos que has recibido.
+      * **Calificaciones:** Imprime las boletas de calificaciones de los estudiantes.
+      * **Cuadros concentrados ( Grupo ):** Imprime la información generada en la estadística de cuadros concentrados por grupo.
+      * **Cuadros concentrados ( Clase ):** Imprime la información generada en la estadística de cuadros concentrados por clase.
+      * **Cuadros concentrados ( Asistencia de grupos ):** Imprime la información generada en la estadística de cuadros concentrados de asistencia.
+      * **Cuadros concentrados ( Extraordinarios ):** Imprime la información generada en la estadística de cuadros concentrados de exámenes extraordinarios.
+      * **Carta de convenio:** Se imprime la información de los convenios que generas desde el estado de cuenta de tus estudiantes.
+      * **Cartas de referencia bancaria:** Imprime la información para las cartas de referencias bancarías para pagos en banco que entregas a tus usuarios.
+      * **Cartas de referencia bancaria (Inscripciones):** Imprime la información de la carta de referencias para pagos en banco relacionados con tus inscripciones.
+      * **Cartas de referencias bancarias por familia:** Imprime la información de las referencias para pago en ventanilla bancaría de toda una familia.
+      * **Carta de referencias generadas:** Imprime la información de las referencias de pago que se han generado para un estudiante.
+      * **Constancia:** Imprime las constancias que necesites generar a tus estudiantes.
+      * **Constancias para profesores:** Imprime la información para las constancias que necesites generar a tus profesores.
+      * **Estadísticas adeudos:** Imprime la información generada desde la estadística de adeudos.
+      * **Facturas y recibos:** Da formato a las facturas y recibos que generas.
+      * **Encabezado:** Puedes generar un encabezado para la impresión que realices de listas de grupos, búsqueda de folios, estadísticas y listados de profesores.
+      * **Kardex:** Imprime la información que necesitas que aparezca en el kardex de tus estudiantes.
+      * **Inventario:** Imprime la información que tienes en el inventario de tus artículos en venta.
+      * **Mensaje a deudores:** Diseña el mensaje que se envía a tus estudiantes con adeudos. Al elegir este tipo se deshabilitan los campos **Tamaño de papel**, **Generar formato horizontal**, **Generar PDF** y **Depuración / Desarrollo**, y debajo del formulario se muestra el panel **Datos disponibles** con la estructura de datos (estudiante, periodos y cargos) que puedes usar en tu código.
+      * **Reporte personalizado:** Diseña un formato propio para presentar la información de uno de tus reportes personalizados, en lugar de descargarla en Excel o texto. Al elegir este tipo se muestra el campo **Reporte personalizado**, donde eliges de cuál de tus reportes personalizados ya creados tomará los datos.
+    * **Lenguaje de plantilla:** Selecciona el lenguaje de código que utilizarás para la creación de tu plantilla.
+      * **Template toolkit:** Sistema de plantillas ampliamente utilizado para generar contenido dinámico, como páginas web o documentos de texto, a partir de datos estructurados.
+      * **XSLT:** Lenguaje de transformación de documentos XML. Permite convertir un archivo XML en otro formato, como otro XML, HTML, texto plano o incluso PDF, aplicando reglas definidas en una hoja de estilos XSLT.
+      * **Mustache:** Motor de plantillas lógico sin lógica (logic-less template engine), usado para generar contenido dinámico como HTML, XML, JSON o texto plano a partir de datos.
+      * **Plantilla de Microsoft Excel ® XLS 2003 / Plantilla de Microsoft Excel ® XLS 2007 ( BETA ):** En vez de escribir código, adjuntas tu propio archivo de Excel como plantilla; al elegir alguna de estas dos opciones el formulario reemplaza el editor de código por un campo para subir el **Archivo**, que debe tener la extensión que corresponda (.xls o .xlsx según la opción elegida).
+      * Si tu **Tipo** es **Encabezado** y ya existe una plantilla de encabezado en Template toolkit o en Excel 2007, esa opción de lenguaje se deshabilita para evitar duplicarla.
+    * **Tamaño de papel:** Selecciona el tamaño del papel en el que se hará la impresión de la información incluida en tu plantilla.
+    * **Generar formato horizontal:** Acomoda la información de manera horizontal en lugar de vertical.
+    * **Generar PDF:** Se generará un PDF en cuanto des clic en "Aceptar" concluida la configuración de tu código de plantilla.
+    * **Depuración / Desarrollo:** Esta opción debe estar seleccionada para generar el renderizado de la información, el cual te servirá como referencia para desarrollar el código de tu plantilla una vez que hagas clic en "Aceptar".
+      * **IMPORTANTE:** Es necesario ya haber agregado al menos una línea de código para poder guardar con la opción de "Depuración / Desarrollo"
+      * **Ver render de información:** Para visualizar el render de la información, dirígete a la pantalla desde la cual deseas imprimir los datos que vas a incorporar en tu código.
+  - Si tu **Tipo** es **Encabezado** y tu **Lenguaje de plantilla** es Template toolkit o Excel 2007, se muestra debajo del formulario la lista de **Variable** que puedes usar en tu código (fecha, hora, apellido del autor, nombre del autor y nombre del reporte).
+  - **Código de plantilla:** Se muestra el espacio para que comiences a agregar el código para tu plantilla.
+    * **IMPORTANTE:** Si tu **Lenguaje de plantilla** es Template toolkit, tu código no puede incluir JavaScript; la plataforma lo quita automáticamente al guardar.
+  - Para guardar la plantilla da clic en **Aceptar.**
+<notes>FALTA_CAPTURA — pantalla: Plantillas de documentos → Crear plantilla → Crear plantilla, Tipo "Mensaje a deudores"; mostrar: el panel "Datos disponibles" con la estructura de estudiante, periodos y cargos, junto al editor de código; archivo sugerido: :a:system_configuration:crear_plantilla_datos_disponibles.png</notes>
+===== Formatos predefinidos =====
+Puedes crear una plantilla específicamente para la impresión de calificaciones de tus estudiantes, tomando alguno de los formatos que Algebraix ya tiene como predeterminados.
+  - Desde tu "Panel de control" selecciona **Plantillas de documentos.**
+  - Despliega "Crear plantilla" y selecciona **Formatos predefinidos.**
+  - Llena la siguiente información del formulario:
+    * **Nombre:** Agrega el nombre que le darás a la plantilla. Solo admite letras, números, espacios y los caracteres "." "_" "-"; no puede exceder 128 caracteres.
+    * **Estructura:** Selecciona cuál es la estructura de impresión que quieres para tu plantilla.
+    * **Estilo:** Selecciona el color con el que quieres que se imprima la información.
+      * **Vista previa:** en cuanto elijas la **Estructura** y el **Estilo** se muestra debajo del formulario una imagen de ejemplo con esa combinación.
+    * **Tamaño de papel:** Selecciona el tamaño del papel en el que quieres hacer la impresión, **Carta** u **Oficio**.
+    * **Generar en formato horizontal:** La información se acomodará de manera horizontal y no vertical.
+    * **Generar PDF:** Se generará un PDF al hacer la impresión de la información.
+    * **Incluir comentarios:** Se incluirán los comentarios que los profesores hayan agregado al registro de calificaciones.
+    * **Incluir ausencias:** Se incluirán las ausencias que haya registrado el profesor.
+  - Para guardar da clic en **Aceptar.**
+    * Si no elegiste una **Estructura** o un **Estilo**, la plataforma te lo pide con un aviso y no guarda la plantilla.
+<notes>FALTA_CAPTURA — pantalla: Plantillas de documentos → Crear plantilla → Formatos predefinidos, con Estructura y Estilo ya elegidos; mostrar: el formulario completo con la Vista previa visible debajo; archivo sugerido: :a:system_configuration:formatos_predefinidos_vista_previa.png</notes>
+===== Modificar un formato predefinido =====
+Esta opción es para modificar una plantilla que hayas creado con un **Formato predefinido**.
+  - Desde tu "Panel de control" selecciona **Plantillas de documentos.**
+  - En la pestaña **General** da clic en el nombre de la plantilla de formato predefinido que deseas modificar.
+  - Haz clic en **Modificar.**
+  - Se muestra el formulario con la configuración actual de la plantilla y una **Vista previa** de su combinación vigente de **Estructura** y **Estilo**:
+    * **Nombre:** Solo admite letras, números, espacios y los caracteres "." "_" "-"; no puede exceder 128 caracteres.
+    * **Estructura:** Cambia la estructura de impresión de tu plantilla.
+    * **Estilo:** Cambia el color con el que se imprime la información.
+      * **Vista previa:** al cambiar la **Estructura** o el **Estilo** se actualiza la imagen de ejemplo con la nueva combinación.
+    * **Tamaño de papel:** Cambia el tamaño del papel de la impresión, **Carta** u **Oficio**.
+    * **Generar en formato horizontal:** La información se acomodará de manera horizontal y no vertical.
+    * **Generar PDF:** Se generará un PDF al hacer la impresión de la información.
+    * **Incluir comentarios:** Se incluirán los comentarios que los profesores hayan agregado al registro de calificaciones.
+    * **Incluir ausencias:** Se incluirán las ausencias que haya registrado el profesor.
+  - Para guardar los cambios da clic en **Aceptar.**
+    * Si no dejas seleccionada una **Estructura** o un **Estilo**, la plataforma te lo pide con un aviso y no guarda los cambios.
+<notes>FALTA_CAPTURA — pantalla: Plantillas de documentos → [nombre de una plantilla de Formato predefinido] → Modificar; mostrar: el formulario de modificación completo, con la Vista previa de la Estructura y el Estilo vigentes; archivo sugerido: :a:system_configuration:modificar_formato_predefinido.png</notes>
+===== Consultar el detalle de una plantilla =====
+  - Desde tu "Panel de control" selecciona **Plantillas de documentos.**
+  - En la pestaña **General** da clic en el nombre de la plantilla que deseas consultar.
+  - Se muestra la pestaña **General** con:
+    * **Nombre**
+    * Si el **Tipo** de la plantilla es **Reporte personalizado**, el nombre del reporte personalizado del que toma los datos.
+    * Si el **Lenguaje de plantilla** es **Plantilla de Microsoft Excel ® XLS 2003** o **XLS 2007**, el enlace **Descargar plantilla** para obtener el archivo adjuntado.
+    * El panel **Especificaciones técnicas:**
+      * Si la plantilla es un **Formato predefinido**, se indica con esa etiqueta; en cualquier otro caso se muestra el **Lenguaje de plantilla** (**Template toolkit**, **Plantilla de Microsoft Excel ® XLS 2003**, **Plantilla de Microsoft Excel ® XLS 2007**, **XSLT** o **Mustache**).
+      * **Tamaño de papel:** solo se muestra si la plantilla tiene uno asignado (**Carta** u **Oficio**).
+      * **Generar formato horizontal, Generar PDF** y **Depuración / Desarrollo:** cada uno con un ícono verde o rojo según esté activado o no.
+      * Si la plantilla es un **Formato predefinido**, se agregan también **Incluir comentarios** e **Incluir ausencias**, con el mismo ícono verde o rojo.
+    * Si el **Lenguaje de plantilla** no es Excel ni **Formato predefinido**, se muestra debajo el código completo de la **Plantilla**.
+  - En la parte inferior derecha de la pantalla, el ícono **Eliminar** {{icon>far fa-trash-can}} solo aparece si tienes permiso para eliminar la plantilla; al darle clic la plataforma te pide confirmar con "¿ Está seguro que desea eliminar esta plantilla [nombre de la plantilla] ?".
+<notes>FALTA_CAPTURA — pantalla: Plantillas de documentos → [nombre de una plantilla] → General; mostrar: la pestaña General completa, con el panel de datos generales y el panel "Especificaciones técnicas"; archivo sugerido: :a:system_configuration:detalle_plantilla_general.png</notes>
+===== Modificar una plantilla =====
+<notes>También se conoce como modificar constancia de estudios, boletas, reportes.</notes>
+Esta opción es para poder modificar tus plantillas de boletas, kardex, constancias, etc. No aplica a las plantillas de **Formatos predefinidos** (consulta "Modificar un formato predefinido").
+  - Desde tu "Panel de control" selecciona **Plantillas de documentos.**
+  - En la pestaña **General** se muestran todas las plantillas que se han creado, agrupadas en un panel por cada **Tipo**, con las columnas **Nombre**, **Idioma** y **Última modificación** (esta última incluye la fecha y, debajo, "Por" el nombre de quien hizo la modificación).
+    * **Nota:** desde esta pestaña también puedes dar clic en el ícono de Excel para descargar el listado completo, o en el ícono de **Imprimir** para su vista de impresión.
+  - Da clic en el nombre de la plantilla que deseas modificar.
+  - Haz clic en **Modificar.**
+    * **IMPORTANTE:** si el código de tu plantilla ya incluye JavaScript, la plataforma no te deja abrirla para modificarla y te avisa con "La plantilla incluye código JavaScript y no puede ser editada"; solo el administrador principal de la plataforma puede hacerlo en ese caso.
+  - Se muestra el formulario con la configuración actual de la plantilla:
+    * **Nombre**
+    * **Lenguaje de plantilla:** puedes cambiarlo entre **Template toolkit**, **XSLT**, **Mustache**, **Plantilla de Microsoft Excel ® XLS 2003** y **Plantilla de Microsoft Excel ® XLS 2007** (esta última no se ofrece si el **Tipo** de la plantilla es **Encabezado**). Si el **Tipo** es **Encabezado** y ya existe otra plantilla de encabezado en Template toolkit o en Excel 2007, esa opción de lenguaje se deshabilita para evitar duplicarla.
+      * Si eliges **Plantilla de Microsoft Excel ® XLS 2003** o **XLS 2007**, el formulario reemplaza el editor de código por un campo para adjuntar el **Archivo**, con la extensión que corresponda (.xls o .xlsx); si adjuntas uno de otro tipo, la plataforma te avisa con "El archivo adjuntado debe ser de tipo Microsoft Excel ® 1997-2003 (XLS)" o "... 2007-365 (XLSX)" según el caso.
+    * **Tamaño de papel:** **Carta** u **Oficio**.
+    * **Generar en formato horizontal**
+    * **Generar PDF**
+    * **Depuración / Desarrollo**
+    * Si el **Tipo** de la plantilla es **Reporte personalizado**, se muestra además el campo **Reporte personalizado**, donde eliges de cuál de tus reportes ya creados tomará los datos.
+    * Si el **Tipo** de la plantilla es **Mensaje a deudores**, los campos **Tamaño de papel**, **Generar en formato horizontal**, **Generar PDF** y **Depuración / Desarrollo** aparecen deshabilitados, y debajo del formulario se muestra el panel **Datos disponibles** con la estructura de datos (estudiante, periodos y cargos) que puedes usar en tu código.
+    * Si el **Tipo** de la plantilla es **Encabezado** y el **Lenguaje de plantilla** es Template toolkit o Excel 2007, se muestra debajo del formulario la lista de **Variable** que puedes usar en tu código (fecha, hora, apellido del autor, nombre del autor y nombre del reporte).
+  - **Código de plantilla:** se muestra el código actual para que lo modifiques.
+    * Si deseas hacer la copia del código de la plantilla, da clic en las hojas que aparecen en la parte inferior derecha de la pantalla. {{icon>far fa-copy text-dark action-item__icon action-item__icon}}
+    * **IMPORTANTE:** si tu **Lenguaje de plantilla** es Template toolkit, tu código no puede incluir JavaScript; si lo incluyes, la plataforma no guarda los cambios y te avisa con "La plantilla no puede incluir código JavaScript".
+  - Realizadas las modificaciones da clic en **Aceptar** para guardar.
+    * Si tu plantilla es de **Tipo** **Encabezado** y cambias el **Lenguaje de plantilla** a uno que ya tiene otra plantilla de encabezado, la plataforma no guarda los cambios y te avisa con "Ya existe un encabezado de este tipo".
+    * Si no seleccionaste un **Tamaño de papel** (y tu plantilla no es de **Tipo** **Mensaje a deudores**), la plataforma te lo pide con un aviso y no guarda los cambios.
+<notes>FALTA_CAPTURA — pantalla: Plantillas de documentos → [nombre de una plantilla que no sea de Formato predefinido] → Modificar; mostrar: el formulario de modificación con el editor de código y el botón de copiar al portapapeles en la esquina inferior derecha; archivo sugerido: :a:system_configuration:modificar_plantilla.png</notes>
+===== Generar un reporte personalizado con tu plantilla =====
+Si creaste una plantilla de tipo **Reporte personalizado**, puedes usarla para obtener la información de ese reporte con el formato que programaste, en vez de descargarla en Excel o texto.
+  - Desde tu **Panel de control** selecciona **Plantillas de documentos.**
+  - En "General" se muestran todas las plantillas que se han creado, da clic en el nombre de la plantilla de tipo **Reporte personalizado.**
+  - En la pestaña **General** despliega el menú y selecciona **Generar reporte.**
+  - Si alguna de las consultas del reporte necesita datos adicionales (por ejemplo un grupo, una fecha o un periodo), completa el formulario que te pide esos datos; si ninguna los necesita, pasa directo al siguiente paso.
+    * **Nota:** este es el mismo formulario de datos que se pide al descargar el reporte personalizado en Excel — consulta "Descargar reporte personalizado" en la página de Reportes personalizados para el detalle de cada tipo de campo.
+  - Da clic en **Aceptar** para obtener el reporte con el formato de tu plantilla.
+<notes>FALTA_CAPTURA — pantalla: Plantillas de documentos → [nombre de la plantilla de tipo Reporte personalizado] → General → Generar reporte; mostrar: la pestaña "General" desplegada mostrando la opción "Generar reporte" activa; archivo sugerido: :a:system_configuration:generar_reporte_personalizado_plantilla.png</notes>
+===== Eliminar plantilla de documentos =====
+  - Desde tu "Panel de control" selecciona **Plantillas de documentos.**
+  - En "General" se muestran todas las plantillas que se han creado, da clic en el nombre de la que deseas eliminar.
+  - En la parte inferior derecha de la pantalla da clic en el ícono de **Eliminar.** {{icon>far fa-trash-alt}}
+===== Recursos =====
+Puedes cargar recursos (imágenes) que te serán útiles para integrarlos en el código de tus plantillas como por ejemplo: logos, fondos o firmas.
+  - Desde tu "Panel de control" selecciona **Plantillas de documentos.**
+  - Haz clic en **Recursos.**
+    * Si todavía no has agregado ningún recurso, la plataforma te avisa con "No se han agregado recursos para plantillas de documentos".
+  - Da clic en **Agregar.**
+  - Se mostrará el recuadro de "Archivo", da clic en **Documento.**
+  - Selecciona el archivo de imagen que deseas agregar y da clic en **Abrir.**
+  - Una vez cargado da clic en **Aceptar.**
+===== Consultar el detalle de un recurso =====
+  - Desde tu "Panel de control" selecciona **Plantillas de documentos.**
+  - Haz clic en **Recursos.**
+  - Da clic en el nombre del recurso que deseas consultar.
+  - En la pestaña **General** se muestra el panel **Detalle del recurso** con:
+    * La imagen del recurso.
+    * **Tipo:** el tipo de plantilla al que pertenece el recurso.
+    * **Creador:** el apellido y nombre de quien lo agregó.
+    * La URL directa del archivo, para usarla dentro del código de tu plantilla.
+    * El **Alias** del recurso (se asigna en automático al agregarlo, con el formato "A" seguido de números).
+    * **Fecha:** la fecha en que se agregó el recurso.
+    * **Tipo de archivo:** el tipo de archivo del recurso.
+    * **Tamaño de archivo:** el peso del archivo.
+<notes>FALTA_CAPTURA — pantalla: Plantillas de documentos → Recursos → [nombre del recurso]; mostrar: el panel "Detalle del recurso" completo, con la imagen y la lista de datos (Tipo, Creador, URL, Alias, Fecha, Tipo de archivo, Tamaño de archivo); archivo sugerido: :a:system_configuration:detalle_recurso.png</notes>
+===== Eliminar un recurso =====
+  - Desde tu "Panel de control" selecciona **Plantillas de documentos.**
+  - Haz clic en **Recursos.**
+  - Da clic en el nombre del recurso que deseas eliminar.
+  - Haz clic en el botón **Eliminar** que se encuentra en la parte inferior derecha de la pantalla. {{icon>far fa-trash-alt}}
+  - La plataforma te pide confirmar con "¿ Está seguro que desea eliminar este recurso : [nombre del archivo] ?"; da clic en **Eliminar** para confirmar.
+===== Permisos para el operador =====
+Para que un operador pueda acceder al menú "Plantillas de documentos" necesita los siguientes permisos al momento de agregarlo o modificar su perfil:
+    * Desde "Permisos globales" > **Configuración general.**
+      * **Plantillas de documentos:**
+        * **Formatos de boletas predefinidos:** Podrá agregar como plantillas alguno de los formatos predefinidos que tiene Algebraix.
+        * **Agregar recursos:** Podrá agregar recursos para utilizarse en las plantillas.
+        * **Agregar plantillas de documentos:** Podrá agregar plantillas creando el código desde cero.
+        * **Ver plantillas de documentos:** Podrá observar las plantillas que se han creado.
+        * **Modificar plantillas de documentos:** Podrá modificar las plantillas que se han creado.
+        * **Eliminar plantillas de documentos:** Podrá eliminar las plantillas creadas.
+        * **Eliminar recursos:** Podrá eliminar recursos dados de alta.
+        * **Modificar formatos de boletas predefinidos:** Podrá modificar las plantillas de formato predefinido existentes.
+        * **Ver recursos:** Podrá observar los recursos dados de alta.
+**Nota:** para usar **Generar reporte** con una plantilla de tipo **Reporte personalizado**, el operador necesita además el permiso **Generar reportes personalizados**, descrito en "Permisos para el operador" de la página de Reportes personalizados.
+<notes>REVISION_PENDIENTE — redactado por el canal automático y publicado sin revisión de un segundo lector. Para revisarlo: ARTICULOS="a:system_configuration:templates" make -C pipeline revisar</notes>