Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Propuesta para automatización y compilación de templates #2

Open
benjavicente opened this issue Jul 5, 2022 · 2 comments
Open

Propuesta para automatización y compilación de templates #2

benjavicente opened this issue Jul 5, 2022 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@benjavicente
Copy link
Member

benjavicente commented Jul 5, 2022

Problema

Ahora no hay una estructura definida en cada template.

El .tex como "target" puede ser distinto, algunos templates pueden incluir archivos de muestra o que no sirven para hacer los documentos, y hay datos como autor y versión que no son fáciles de incluir para que sean obtenidos automáticamente.

Propuesta

Propongo empezar a añadir un YAML Front Matter a cada ReadMe. Los datos que se añadan ahí podrían permitir saber información como el archivo a compilar, cuáles son los archivos a incluir en el zip, y más. Añadirlo junto al ReadMe evitará crear archivos de más. El formato podría tener la siguiente estructura:

---
# TeX a compilar para mostrar de ejemplo o base, requerido. Podría también ser una lista.
target: main.tex
# Autor, opcional. El mail podría ser incluido opcionalmente en el mismo formato que usa Git.
author: Benjamín <benja@example.com>
# Globs de archivos a incluir en un zip, opcional. Si no se incluye, se asumiría que se incluyen todos.
# Siempre se incluye el ReadMe.
include:
  - "*.cls"
# Versión, opcional. Tag para informar si el templete tuvo cambios significativos
version: 1.1
---

<!--- El nombre del template puede ser obtenido del título de markdown -->
# Title

La información de última vez editado se podría obtener con Git, si es que es requerida.

Posibles beneficios

Con esto, se podrá automatizar varias cosas para hacer esta recopilación de templates más atractiva, como la generación de una lista de los templates disponibles en el ReadMe de este repositorio y en una futura página externa, provelliendo también vistas previas de los templetes.

@benjavicente benjavicente added the enhancement New feature or request label Jul 5, 2022
@benjavicente benjavicente self-assigned this Jul 5, 2022
@agucova
Copy link
Member

agucova commented Jul 6, 2022

no lei nada de la propuesta (perdón), pero https://toml.io/en/

@benjavicente
Copy link
Member Author

TOML es innecesariamente verboso para este caso:

target = "main.tex"
author = "Benjamín <benja@example.com>"
include = [
  "*.cls",
]
version = 1.1

vs

target: main.tex
author: Benjamín <benja@example.com>
include:
  - "*.cls"
version: 1.1

No creo que valga mucho la pena TOML a menos que se usen tables.

diegocostares pushed a commit that referenced this issue May 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants