barcala:0.2.0 (#3342)

Author: JuanM04

packages/preview/barcala/0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Juan Martín Seery
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/preview/barcala/0.2.0/README.md

@@ -0,0 +1,112 @@
+# barcala
+
+![](https://img.shields.io/badge/Typst-0.14.0-blue?style=flat-square&logo=typst&logoColor=white&labelColor=239DAD&color=555555)
+
+
+A report template for UNLP students, specially for engineering. Not affiliated with the university.
+
+---
+
+Plantilla de informe para estudiantes de la Universidad Nacional de La Plata, especialmente para ingeniería. No está afiliada a la universidad.
+
+<p align="center">
+  <img alt="Documento de ejemplo, página 1" src="./thumbnails/1.png" width="45%">
+&nbsp; &nbsp; &nbsp; &nbsp;
+  <img alt="Documento de ejemplo, página 2" src="./thumbnails/2.png" width="45%">
+</p>
+
+## Uso
+
+```typst
+#import "@preview/barcala:0.2.0": informe
+
+#show: informe.with(
+  // parámetros del informe
+)
+```
+
+- `institucion`: el logo de la institución del informe.
+  - `"unlp"`: Universidad Nacional de La Plata (por defecto)
+  - Si se desea usar un logo diferente, se puede pasar un `image("logo.png")` o cualquier otro contenido. Si el logo es muy grande, se puede cambiar su tamaño como `image("logo.png", height: 80%)`.
+- `unidad-academica`: el logo de la unidad académica del informe. Opciones:
+  - `"informática"`: Facultad de Informática
+  - `"ingeniería"`: Facultad de Ingeniería
+  - Si se desea usar un logo diferente, se puede pasar un `image("logo.png")` o cualquier otro contenido. Si el logo es muy grande, se puede cambiar su tamaño como `image("logo.png", height: 80%)`.
+  - Si la unidad académica de la UNLP no está en la lista, [creá un reporte](https://github.com/JuanM04/barcala/issues/new) con el link al logo y lo agregamos a la plantilla.
+- `asignatura`: el nombre de la asignatura (`str`).
+- `trabajo` (`content`, opcional): el título más formal del informe, como `[Trabajo Práctico Nº 3]`.
+- `equipo` (`content`): el nombre del equipo, como `[Grupo 12]`.
+- `autores` (`array`): los autores y autoras del proyecto. Cada autor/a tiene
+  - `nombre` (`str`): el nombre del autor/a con el formato `Apellido, Nombre`; 
+  - `email` (`str`, opcional): un email;
+  - `legajo` (`str`, opcional): un legajo;
+  - `notas` (`array` o `str`, opcional): otras notas, como `"Autor responsable del informe"`.
+- `titulo` (`content`): el título del proyecto en sí, como `[Análisis de un sistema fluvial]`.
+- `resumen` (`content`, opcional): un resumen del lo que trata el informe o el objetivo del proyecto. Es un campo libre para escribir con el formato que se desee.
+- `fecha` (`date` o `str`): la fecha de entrega del informe, se puede escribir como `"2023-10-01"` (1 de octubre de 2023).
+- `formato` (`dict`, opcional): otras configuraciones del informe:
+  - `tipografia` (`str`, opcional): la tipografía del informe, _New Computer Modern_ por defecto;
+  - `columnas` (`int`, opcional): la cantidad de columnas, una por defecto;
+  - `margenes` (opcional): pueden ser
+    - `"simétricos"`: los mismo márgenes de cada lado (por defecto),
+    - `"anillado"`: márgenes más anchos donde iría el anillado.
+
+
+### Apéndices
+
+Para agregar apéndices al informe, se puede usar el comando `apendice` en el lugar empiezan los apéndices. Por ejemplo:
+
+```typst
+#import "@preview/barcala:0.2.0": informe, apendice
+
+#show: informe.with(
+  // parámetros del informe
+)
+
+// ... contenido del informe
+
+#show: apendice
+
+= Tablas de datos // Apéndice A
+// ...
+
+= Otra información // Apéndice B
+// ...
+```
+
+### Tabla de símbolos
+
+Para agregar una tabla de símbolos/nomenclatura al informe, se puede usar el comando `nomenclatura` en el lugar donde empieza la tabla. Por ejemplo:
+
+```typst
+#import "@preview/barcala:0.2.0": informe, nomenclatura
+
+#show: informe.with(
+  // parámetros del informe
+)
+
+#nomenclatura(
+  ($S_1$, [Símbolo 1]),
+  ($S_2$, [Símbolo 2]),
+  ($S_3$, [Símbolo 3]),
+)
+```
+
+## Desarrollo
+
+Para generar el documento `main.pdf` y la imagen `thumbnails/1.png` de la portada, se debe cambiar
+
+```diff
+-  #import "@preview/barcala:0.2.0": ...
++  #import "../src/lib.typ": ...
+```
+
+y utilizar los siguientes comandos:
+
+```bash
+# Genera PDF
+typst compile --root . --pdf-standard a-2u template/main.typ
+# Genera thumbnail.png
+typst compile --root . --format png template/main.typ "thumbnails/{p}.png"
+oxipng -o 2 --strip safe thumbnails/*.png
+```