Skip to content

rendering-module.md

Latest commit

 

History

History
135 lines (95 loc) · 3.96 KB

rendering-module.md

File metadata and controls

135 lines (95 loc) · 3.96 KB

Rendering System Module

Multi-format output generation from single source

Location: infrastructure/rendering/core.py
Quick Reference: Modules Guide | API Reference

Key Features

  • PDF Rendering: Professional LaTeX-based PDFs
  • Presentation Slides: Beamer (PDF) and reveal.js (HTML) slides
  • Web Output: Interactive HTML with MathJax
  • Scientific Posters: Large-format poster generation
  • Format-Agnostic: Single source, multiple outputs
  • Quality Validation: Automated output checking

Usage Examples

Render All Formats

from infrastructure.rendering import RenderManager
from pathlib import Path

manager = RenderManager()

# Render all formats from markdown
outputs = manager.render_all(Path("manuscript/main.md"))

# Outputs are written under the project output tree, e.g.:
# - PDF: projects/{name}/output/pdf/
# - Slides: projects/{name}/output/slides/
# - Web: projects/{name}/output/web/
# Final copy stage may mirror to output/{name}/ (see RUN_GUIDE)

Render Specific Format

# PDF only
pdf_path = manager.render_pdf(Path("manuscript/main.tex"))

# Beamer slides
slides_pdf = manager.render_slides(
    Path("presentation.md"),
    format="beamer"
)

# Reveal.js HTML slides
slides_html = manager.render_slides(
    Path("presentation.md"),
    format="revealjs"
)

# Web version
html_path = manager.render_web(Path("manuscript/main.md"))

Combined PDF with Title Page

# Render combined PDF with automatic title page generation
markdown_files = [
    Path("manuscript/01_abstract.md"),
    Path("manuscript/02_introduction.md"),
    # ... more sections
]

pdf_path = manager.render_combined_pdf(
    markdown_files,
    manuscript_dir=Path("manuscript/")
)
# Title page automatically generated from projects/{name}/manuscript/config.yaml

CLI Integration

# Render all formats
uv run python -m infrastructure.rendering.cli all manuscript.tex

# Render PDF only
uv run python -m infrastructure.rendering.cli pdf manuscript.tex

# Generate slides
uv run python -m infrastructure.rendering.cli slides presentation.md --format beamer
uv run python -m infrastructure.rendering.cli slides presentation.md --format revealjs

# Generate web version
uv run python -m infrastructure.rendering.cli web manuscript.md

Template Variable Injection

The renderer natively supports dynamic parameter injection for your manuscripts using Jinja-like placeholders ({{variable_name}}).

How It Works

If a manuscript_vars.yaml file is placed in your project's manuscript/ directory, the engine parses it mapping any primitive keys into strings dynamically injected into markdown headers, lists, code, and body text.

For example, given projects/{name}/manuscript/manuscript_vars.yaml:

areas:
  ActiveInference: 11
  FEP: 14
maturity:
  real: 8
  partial: 35

The rendering hooks resolve any nested structures using flatten techniques:

  • {{maturity.real}} -> 8
  • {{areas.FEP}} -> 14

Synthetic Pipeline Agnosticism

For structural project topologies resembling fep_lean—but completely backward-compatible with generalized architectures (code_project, template)—the module automatically evaluates synthetic parameters to simplify front-end syntax:

  • Synthesizes total_topics and total_areas aggregations based on count metrics if relevant keys exist.
  • Emits derived representations like dynamically scaled maturity_icon semantics (✅, ⚠️, ○) and string metric transformations like lean_chars based on codebase properties.
  • Robust Schema Binding: Deep type inspections guarantee that the generalized rendering layer skips variable derivations exclusively relying on arrays or absent dictionary structures on minimalist or newer templates running within the projects/ subdirectories.

Related: Reporting Module | Publishing Module