Skip to content

Commit e61a1af

Browse files
jmrplensjmrplens
committed
docs: añadir archivos de contexto para asistentes de IA
- AGENTS.md: Guía general para cualquier IA - CLAUDE.md: Instrucciones específicas para Claude - .github/copilot-instructions.md: Contexto para GitHub Copilot - docs/AI_CONTEXT.md: Referencia técnica detallada Estos archivos ayudan a las IAs a proporcionar respuestas precisas a estudiantes que usan la plantilla.
1 parent 1fff306 commit e61a1af

4 files changed

Lines changed: 915 additions & 0 deletions

File tree

‎.github/copilot-instructions.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# GitHub Copilot Instructions for TFG-TFM_EPS
2+
3+
## Project Overview
4+
5+
This is a **LaTeX template** for Bachelor's (TFG) and Master's (TFM) thesis at the Polytechnic School of the University of Alicante (Spain).
6+
7+
**Key facts:**
8+
- Must compile with **LuaLaTeX** (not pdfLaTeX)
9+
- Requires `-shell-escape` flag for minted package
10+
- Spanish is the primary language
11+
- Supports 21 different degree programs
12+
13+
## File Structure
14+
15+
- `main.tex` - Entry point, includes all chapters
16+
- `configuracion.tex` - User configuration via `\EPSsetup{}`
17+
- `capitulos/*.tex` - Chapter content files
18+
- `anexos/*.tex` - Appendix files
19+
- `bibliografia/bibliografia.bib` - BibTeX references
20+
- `cls/eps-tfg.cls` - Main class file (DO NOT MODIFY)
21+
- `sty/*.sty` - Style packages (DO NOT MODIFY)
22+
23+
## When Helping Users
24+
25+
### For LaTeX content questions:
26+
- Always suggest using the template's built-in commands
27+
- Reference the `docs/` folder for detailed guides
28+
- Use `\autoref{}` for cross-references (auto-detects type)
29+
- Use `\parencite{}` for citations (BibLaTeX style)
30+
31+
### For configuration questions:
32+
- All settings go in `configuracion.tex` inside `\EPSsetup{}`
33+
- Available degrees: `informatica`, `teleco`, `arquitectura`, `civil`, `quimica`, `robotica`, `multimedia`, `arquitectura-tecnica`, and masters with `master-` prefix
34+
35+
### For compilation issues:
36+
1. Check LuaLaTeX is being used
37+
2. Verify `-shell-escape` is enabled
38+
3. Run full compilation: `lualatex → biber → lualatex → lualatex`
39+
40+
## Code Style
41+
42+
When writing LaTeX code for this project:
43+
- Use Spanish for comments and content
44+
- Indent with 2 spaces inside environments
45+
- Use `%` comments to explain complex macros
46+
- Prefer semantic commands (`\autoref`) over manual references
47+
48+
## Common Commands
49+
50+
```latex
51+
% Configuration
52+
\EPSsetup{
53+
titulo = {Title},
54+
autor = {Name},
55+
titulacion = informatica,
56+
}
57+
58+
% Citations
59+
\parencite{key} % (Author, Year)
60+
\textcite{key} % Author (Year)
61+
62+
% Cross-references
63+
\autoref{fig:name} % "Figure 1"
64+
\autoref{tab:name} % "Table 1"
65+
66+
% Acronyms
67+
\gls{acronym} % Smart expansion
68+
\acrshort{acronym} % Short form only
69+
70+
% Code
71+
\begin{pythoncode}
72+
# Python code here
73+
\end{pythoncode}
74+
```
75+
76+
## Documentation
77+
78+
Point users to these files in `docs/`:
79+
- `ECUACIONES.md` - Math equations
80+
- `TABLAS.md` - Tables
81+
- `FIGURAS_GRAFICAS.md` - Figures and graphics
82+
- `CODIGO_FUENTE.md` - Source code listings
83+
- `BIBLIOGRAFIA.md` - Bibliography management
84+
- `GLOSARIOS_ACRONIMOS.md` - Glossaries and acronyms
85+
86+
## Important Warnings
87+
88+
1. Never suggest pdfLaTeX - this template requires LuaLaTeX
89+
2. Don't modify files in `cls/` or `sty/` directories
90+
3. The `titulacion` value must match exactly (case-sensitive)
91+
4. Bibliography uses Biber, not BibTeX

‎AGENTS.md‎

Lines changed: 256 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,256 @@
1+
# 🤖 Guía para Asistentes de IA
2+
3+
Este archivo proporciona contexto para que los asistentes de IA (ChatGPT, Claude, Copilot, etc.) puedan ayudar eficazmente a los estudiantes que usan esta plantilla LaTeX.
4+
5+
## 📋 Descripción del Proyecto
6+
7+
**TFG-TFM_EPS_UA** es una plantilla LaTeX profesional para la elaboración de:
8+
- **TFG** (Trabajo Fin de Grado)
9+
- **TFM** (Trabajo Fin de Máster)
10+
11+
En la **Escuela Politécnica Superior de la Universidad de Alicante** (España).
12+
13+
### Características principales
14+
- Compilación con **LuaLaTeX** (obligatorio, no funciona con pdfLaTeX)
15+
- Soporte para **21 titulaciones** diferentes (grados y másteres)
16+
- Portadas oficiales en color y blanco/negro
17+
- Bibliografía con BibLaTeX + Biber
18+
- Código fuente con sintaxis resaltada (minted + Pygments)
19+
- Glosarios y acrónimos integrados
20+
- Cumple con la normativa de la EPS UA
21+
22+
---
23+
24+
## 📁 Estructura del Proyecto
25+
26+
```
27+
/
28+
├── main.tex # Documento principal (punto de entrada)
29+
├── configuracion.tex # ⭐ ARCHIVO CLAVE: Configuración del usuario
30+
├── capitulos/ # Contenido del documento
31+
│ ├── Introduccion.tex
32+
│ ├── objetivos.tex
33+
│ ├── marcoteorico.tex
34+
│ ├── metodologia.tex
35+
│ ├── desarrollo.tex
36+
│ ├── resultados.tex
37+
│ └── conclusiones.tex
38+
├── anexos/ # Anexos y apéndices
39+
├── bibliografia/
40+
│ └── bibliografia.bib # Referencias en formato BibTeX
41+
├── archivos/
42+
│ ├── figuras/ # Imágenes del documento
43+
│ └── ejemplos/ # Código fuente de ejemplo
44+
├── cls/
45+
│ └── eps-tfg.cls # Clase principal (NO MODIFICAR)
46+
├── sty/ # Paquetes de estilo (NO MODIFICAR)
47+
└── docs/ # Documentación detallada
48+
```
49+
50+
---
51+
52+
## ⚙️ Configuración Principal
53+
54+
El archivo `configuracion.tex` contiene todas las opciones personalizables mediante `\EPSsetup{}`:
55+
56+
### Datos básicos obligatorios
57+
```latex
58+
\EPSsetup{
59+
titulo = {Título del trabajo},
60+
autor = {Nombre Apellido1 Apellido2},
61+
genero = m, % m = masculino, f = femenino, n = neutro
62+
tutor = {Dr. Nombre del Tutor},
63+
tutor-departamento = {Nombre del Departamento},
64+
titulacion = informatica, % Ver lista de titulaciones abajo
65+
fecha = {Junio 2026},
66+
}
67+
```
68+
69+
### Titulaciones disponibles (valor para `titulacion`)
70+
**Grados:**
71+
- `arquitectura`, `arquitectura-tecnica`, `civil`, `informatica`
72+
- `multimedia`, `quimica`, `robotica`, `teleco`
73+
74+
**Másteres:**
75+
- `master-agua`, `master-caminos`, `master-ciberseguridad`
76+
- `master-edificacion`, `master-geologica`, `master-informatica`
77+
- `master-materiales`, `master-moviles`, `master-prevencion`
78+
- `master-quimica`, `master-robotica`, `master-teleco`, `master-web`
79+
80+
### Opciones de género
81+
```latex
82+
genero = m, % Muestra "Autor" y "Tutor"
83+
genero = f, % Muestra "Autora" y "Tutora"
84+
genero = n, % Muestra "Autoría" y "Tutoría" (neutro)
85+
86+
tutor-genero = m, % Género del tutor: m/f/n
87+
cotutor-genero = f, % Género del cotutor: m/f/n
88+
```
89+
90+
### Opciones adicionales comunes
91+
```latex
92+
\EPSsetup{
93+
% Subtítulo opcional
94+
subtitulo = {Subtítulo del trabajo},
95+
96+
% Cotutor (opcional)
97+
cotutor = {Dra. Nombre Cotutora},
98+
cotutor-departamento = {Otro Departamento},
99+
100+
% Email institucional
101+
email = nombre@alu.ua.es,
102+
103+
% Palabras clave
104+
palabras-clave = {palabra1, palabra2, palabra3},
105+
keywords = {keyword1, keyword2, keyword3},
106+
}
107+
```
108+
109+
---
110+
111+
## 🔧 Comandos Principales
112+
113+
### Portadas
114+
```latex
115+
\portadacolor % Portada a color (por defecto)
116+
\portadabn % Portada en blanco y negro
117+
```
118+
119+
### Resúmenes
120+
```latex
121+
\begin{resumen}
122+
Texto del resumen en español...
123+
\end{resumen}
124+
125+
\begin{abstract}
126+
Abstract text in English...
127+
\end{abstract}
128+
```
129+
130+
### Citas bibliográficas
131+
```latex
132+
\parencite{clave} % (Autor, 2024)
133+
\textcite{clave} % Autor (2024)
134+
\cite{clave} % Cita numérica [1]
135+
```
136+
137+
### Acrónimos y glosario
138+
```latex
139+
\gls{acronimo} % Primera vez: "Nombre Completo (NC)", después: "NC"
140+
\acrshort{acronimo} % Solo las siglas: NC
141+
\acrlong{acronimo} % Solo el nombre completo
142+
\acrfull{acronimo} % Siempre completo: Nombre Completo (NC)
143+
```
144+
145+
### Referencias cruzadas
146+
```latex
147+
\autoref{fig:nombre} % "Figura 1" (automático)
148+
\autoref{tab:nombre} % "Tabla 1"
149+
\autoref{sec:nombre} % "Sección 1"
150+
\autoref{eq:nombre} % "Ecuación 1"
151+
```
152+
153+
### Código fuente
154+
```latex
155+
% Código Python con números de línea
156+
\begin{pythoncode}[title={script.py}]
157+
def hello():
158+
print("Hello, World!")
159+
\end{pythoncode}
160+
161+
% Código inline
162+
\mintinline{python}{print("Hello")}
163+
```
164+
165+
---
166+
167+
## ❌ Errores Comunes y Soluciones
168+
169+
### 1. "Package minted Error: You must invoke LaTeX with -shell-escape"
170+
**Causa:** Minted necesita ejecutar comandos externos.
171+
**Solución:** Compilar con `lualatex -shell-escape main.tex` o configurar el editor.
172+
173+
### 2. "Undefined control sequence: \EPSsetup"
174+
**Causa:** No se está usando la clase correcta o hay error en main.tex.
175+
**Solución:** Verificar que `main.tex` comienza con `\documentclass{eps-tfg}`.
176+
177+
### 3. "File 'eps-tfg.cls' not found"
178+
**Causa:** Las rutas no están configuradas correctamente.
179+
**Solución:** Verificar que existe el bloque `\input@path` en main.tex.
180+
181+
### 4. "Citation undefined" o "Reference undefined"
182+
**Causa:** Falta ejecutar biber o hay errores en .bib.
183+
**Solución:** Ejecutar: `lualatex → biber → lualatex → lualatex`.
184+
185+
### 5. La portada no tiene los colores correctos
186+
**Causa:** Titulación mal escrita en configuracion.tex.
187+
**Solución:** Verificar que el valor de `titulacion` coincide exactamente con la lista.
188+
189+
### 6. "Font not found" o errores de fuentes
190+
**Causa:** LuaLaTeX no encuentra las fuentes del sistema.
191+
**Solución:**
192+
- En Overleaf: Funciona automáticamente
193+
- Local: Instalar TeX Live completo o las fuentes necesarias
194+
195+
---
196+
197+
## 💡 Consejos para Ayudar a Estudiantes
198+
199+
### Cuando pregunten sobre estructura
200+
- Sugerir usar la estructura de capítulos existente
201+
- Los archivos en `capitulos/` ya tienen el orden lógico típico
202+
- Pueden añadir/eliminar capítulos modificando `main.tex`
203+
204+
### Cuando pregunten sobre bibliografía
205+
- El archivo es `bibliografia/bibliografia.bib`
206+
- Usar formato BibTeX estándar
207+
- Herramientas útiles: Zotero, Mendeley, Google Scholar (exportar BibTeX)
208+
209+
### Cuando pregunten sobre imágenes
210+
- Colocar en `archivos/figuras/`
211+
- Formatos recomendados: PDF (vectorial), PNG (raster)
212+
- Usar `\includegraphics[width=0.8\textwidth]{nombre}`
213+
214+
### Cuando pregunten sobre tablas
215+
- Recomendar el paquete `booktabs` (ya incluido)
216+
- Usar `\toprule`, `\midrule`, `\bottomrule`
217+
- Para tablas largas: `longtable`
218+
219+
### Cuando pregunten sobre ecuaciones
220+
- Entorno `equation` para ecuaciones numeradas
221+
- Entorno `align` para ecuaciones alineadas
222+
- Usar `\label{eq:nombre}` para referenciar
223+
224+
---
225+
226+
## 📚 Documentación Adicional
227+
228+
La carpeta `docs/` contiene guías detalladas:
229+
- `ECUACIONES.md` - Guía completa de ecuaciones matemáticas
230+
- `TABLAS.md` - Creación de tablas profesionales
231+
- `FIGURAS_GRAFICAS.md` - Imágenes y gráficas con TikZ/PGFPlots
232+
- `CODIGO_FUENTE.md` - Inserción de código con minted
233+
- `BIBLIOGRAFIA.md` - Gestión de referencias
234+
- `GLOSARIOS_ACRONIMOS.md` - Términos y acrónimos
235+
236+
---
237+
238+
## ⚠️ Advertencias Importantes
239+
240+
1. **NO modificar** los archivos en `cls/` y `sty/` a menos que sea absolutamente necesario
241+
2. **Siempre compilar con LuaLaTeX**, no pdfLaTeX ni XeLaTeX
242+
3. **Usar UTF-8** como codificación de todos los archivos .tex
243+
4. **Respetar los nombres** de las titulaciones exactamente como están listados
244+
5. La plantilla está diseñada para **español**, pero soporta contenido bilingüe
245+
246+
---
247+
248+
## 🔗 Enlaces Útiles
249+
250+
- **Repositorio:** https://github.com/jmrplens/TFG-TFM_EPS
251+
- **Documentación LaTeX:** https://www.overleaf.com/learn
252+
- **Comunidad TeX:** https://tex.stackexchange.com/
253+
254+
---
255+
256+
*Este archivo está diseñado para proporcionar contexto a asistentes de IA. Si eres un estudiante leyendo esto, ¡bienvenido! Puedes usar esta información como referencia rápida.*

0 commit comments

Comments
 (0)