# rezonaldo/format-check-paper architecture

> Architecture diagram of the GitHub repository rezonaldo/format-check-paper, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/rezonaldo/format-check-paper
- Repository: https://github.com/rezonaldo/format-check-paper

## Overview

This is an IEEE manuscript PDF compliance checker and auto-annotator. Authors or publication staff submit a PDF through the web interface, CLI, or API; the entry point validates it, then runs IEEE checks and produces location-specific violations. The web and CLI workflows generate an annotated PDF plus Word and Excel review sheets; the API returns an annotated PDF and Word report with structured violations. The README documents checks spanning page setup, manuscript content, equations, figures, tables, references, and typography. Relationships below follow shown calls or documented behavior; unsampled rule internals are represented by the checker.

Main entry points: [`app.py`](https://github.com/rezonaldo/format-check-paper/blob/main/app.py) (Web Checker), [`cli.py`](https://github.com/rezonaldo/format-check-paper/blob/main/cli.py) (Batch CLI), [`api/index.py`](https://github.com/rezonaldo/format-check-paper/blob/main/api/index.py) (HTTP API), [`core/rules.py`](https://github.com/rezonaldo/format-check-paper/blob/main/core/rules.py) (IEEE Rule Checker)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Submission Interfaces"]
  node_web["Web Checker<br/>[app.py]"]
  node_cli["Batch CLI<br/>[cli.py]"]
  node_api["HTTP API<br/>[index.py]"]
end

subgraph group_check["Manuscript Checking"]
  node_validator["PDF Gatekeeper<br/>[validator.py]"]
  node_checker["IEEE Rule Checker<br/>[rules.py]"]
end

subgraph group_outputs["Review Outputs"]
  node_annotator["PDF Annotator<br/>[highlighter.py]"]
  node_reports["Review Reports"]
end

subgraph group_types["Shared Data"]
  node_models["Violation Models<br/>[models.py]"]
end

node_author(("Submitter"))

node_author -->|"uploads PDF"| node_web
node_author -->|"provides PDF"| node_cli
node_author -->|"posts PDF"| node_api
node_web -->|"validates PDF"| node_validator
node_web -->|"checks manuscript"| node_checker
node_web -->|"annotates PDF"| node_annotator
node_web -->|"generates sheets"| node_reports
node_cli -->|"validates PDF"| node_validator
node_cli -->|"checks manuscript"| node_checker
node_cli -->|"annotates PDF"| node_annotator
node_cli -->|"generates sheets"| node_reports
node_api -->|"validates PDF"| node_validator
node_api -->|"checks manuscript"| node_checker
node_api -->|"annotates PDF"| node_annotator
node_api -->|"generates Word report"| node_reports
node_checker -->|"creates violations"| node_models
node_annotator -->|"uses violations"| node_models
node_reports -->|"uses violations"| node_models

click node_web "https://github.com/rezonaldo/format-check-paper/blob/main/app.py"
click node_cli "https://github.com/rezonaldo/format-check-paper/blob/main/cli.py"
click node_api "https://github.com/rezonaldo/format-check-paper/blob/main/api/index.py"
click node_validator "https://github.com/rezonaldo/format-check-paper/blob/main/core/validator.py"
click node_checker "https://github.com/rezonaldo/format-check-paper/blob/main/core/rules.py"
click node_models "https://github.com/rezonaldo/format-check-paper/blob/main/core/models.py"
click node_annotator "https://github.com/rezonaldo/format-check-paper/blob/main/core/highlighter.py"
click node_reports "https://github.com/rezonaldo/format-check-paper/blob/main/core/report_generator.py"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_web,node_cli,node_api toneBlue
class node_validator,node_checker toneAmber
class node_annotator,node_reports toneMint
class node_models toneRose
class node_author toneIndigo
```

## Components

### Submission Interfaces

- [Web Checker](https://github.com/rezonaldo/format-check-paper/blob/main/app.py): `app.py`
- [Batch CLI](https://github.com/rezonaldo/format-check-paper/blob/main/cli.py): `cli.py`
- [HTTP API](https://github.com/rezonaldo/format-check-paper/blob/main/api/index.py): `api/index.py`

### Manuscript Checking

- [PDF Gatekeeper](https://github.com/rezonaldo/format-check-paper/blob/main/core/validator.py): `core/validator.py`
- [IEEE Rule Checker](https://github.com/rezonaldo/format-check-paper/blob/main/core/rules.py): `core/rules.py`

### Review Outputs

- [PDF Annotator](https://github.com/rezonaldo/format-check-paper/blob/main/core/highlighter.py): `core/highlighter.py`
- [Review Reports](https://github.com/rezonaldo/format-check-paper/blob/main/core/report_generator.py): `core/report_generator.py`

### Shared Data

- [Violation Models](https://github.com/rezonaldo/format-check-paper/blob/main/core/models.py): `core/models.py`

### Other components

- **Submitter**

## Connections

- Submitter → Web Checker: uploads PDF (evidence: `README.md`)
- Submitter → Batch CLI: provides PDF (evidence: `README.md`)
- Submitter → HTTP API: posts PDF (evidence: `api/index.py`)
- Web Checker → PDF Gatekeeper: validates PDF (evidence: `app.py`)
- Web Checker → IEEE Rule Checker: checks manuscript (evidence: `app.py`)
- Web Checker → PDF Annotator: annotates PDF (evidence: `app.py`)
- Web Checker → Review Reports: generates sheets (evidence: `app.py`)
- Batch CLI → PDF Gatekeeper: validates PDF (evidence: `cli.py`)
- Batch CLI → IEEE Rule Checker: checks manuscript (evidence: `cli.py`)
- Batch CLI → PDF Annotator: annotates PDF (evidence: `cli.py`)
- Batch CLI → Review Reports: generates sheets (evidence: `cli.py`)
- HTTP API → PDF Gatekeeper: validates PDF (evidence: `api/index.py`)
- HTTP API → IEEE Rule Checker: checks manuscript (evidence: `api/index.py`)
- HTTP API → PDF Annotator: annotates PDF (evidence: `api/index.py`)
- HTTP API → Review Reports: generates Word report (evidence: `api/index.py`)
- IEEE Rule Checker → Violation Models: creates violations (evidence: `core/rules.py`)
- PDF Annotator → Violation Models: uses violations (evidence: `core/highlighter.py`)
- Review Reports → Violation Models: uses violations (evidence: `core/report_generator.py`)
