2026-01-20 11:35:56 +01:00
Generate the Word document for this Master's Thesis project.
## Instructions
Execute the TFM document generation pipeline in order:
### Step 0: Clean Up Previous Output
Remove the entire thesis_output folder to ensure a fresh build:
```bash
rm -rf thesis_output && mkdir -p thesis_output/figures
```
### Step 1: Generate Figures from Mermaid Diagrams
Run the figure generation script using the virtual environment:
```bash
source .venv/bin/activate && python3 generate_mermaid_figures.py
```
**Input:** Mermaid code blocks from `docs/*.md`
**Output:** `thesis_output/figures/figura_*.png` and `figures_manifest.json`
2026-01-20 15:18:56 +01:00
**Notes:**
- Bar charts (`xychart-beta` ) are automatically post-processed to use light blue (`#0098CD` ) bars
- The script generates SVG first, replaces default colors, then converts to PNG via `cairosvg`
- Other diagram types (flowchart, sequence, pie) use direct PNG generation via `mmdc`
2026-01-20 11:35:56 +01:00
### Step 2: Apply Content to UNIR Template
Run the content application script using the virtual environment:
```bash
source .venv/bin/activate && python3 apply_content.py
```
**Input:**
- `instructions/plantilla_individual.htm` (UNIR template)
2026-01-20 11:42:20 +01:00
- `instructions/plantilla_individual_files/` (template support files)
2026-01-20 11:35:56 +01:00
- `docs/*.md` (chapter content)
- `thesis_output/figures/*.png` (generated figures)
2026-01-20 11:42:20 +01:00
**Output:** `thesis_output/` (htm + support files + figures)
2026-01-20 11:35:56 +01:00
### Step 3: Report Results
After successful execution, provide:
1. Number of figures generated
2. Number of tables formatted
3. Path to output file
4. Instructions for Word finalization:
- Open `thesis_output/plantilla_individual.htm` in Microsoft Word
- Press Ctrl+A then F9 to update all indices (contents, figures, tables)
- Adjust image sizes if needed (select image → right-click → Size and Position)
- Save as `.docx`
### Prerequisites
If scripts fail, check that dependencies are installed:
```bash
# Python dependencies (in .venv)
2026-01-20 15:18:56 +01:00
source .venv/bin/activate && pip install beautifulsoup4 cairosvg
2026-01-20 11:35:56 +01:00
# Mermaid CLI for figure generation
npm install @mermaid -js/mermaid-cli
```
2026-01-20 15:18:56 +01:00
### Notes
- **Bar chart colors**: The `generate_mermaid_figures.py` script automatically converts xychart-beta bar colors to UNIR light blue (`#0098CD` ). This is done via SVG post-processing since Mermaid's xychart theming doesn't work reliably via config files.
- **Color replacement**: Both `fill` and `stroke` attributes are replaced for colors `#ECECFF` and `#FFF4DD` (default Mermaid bar colors).
- **Config file**: `mermaid.config.json` in root directory sets the base theme for all diagrams.
2026-01-20 11:35:56 +01:00
### Error Handling
- If `generate_mermaid_figures.py` fails: Check mmdc (mermaid-cli) is installed
- If `apply_content.py` fails: Check beautifulsoup4 is installed
- Report any errors with the specific step that failed