Academic Primer Framework

Documentation

1. Overview 2. Quick Start 3. Directory Structure 4. Template System 5. Figure System 6. Build System 7. Verification Tools 8. LaTeX Configuration 9. Workflow Guide 10. Constraints 11. Troubleshooting

1 Overview

6 Section Templates

Introduction, Theory, Key Topic, Mathematical, Empirical, and Validation sections with placeholder markers

4 Appendix Templates

Proofs, Derivations, Data Catalog, and Exercises - complete academic structure

7 Figure Templates

Line chart, bar chart, scatter plot, heatmap, time series, distribution, flowchart

Automated Verification

Figure integration, citation validation, DOI resolution, overflow checking

100+ Math Symbols

Predefined notation for probability, optimization, derivatives, vectors, matrices

Professional Output

elsarticle class, publication-ready PDF with ~44 pages

2 Quick Start

5-Step Setup

# 1. Copy templates to working folders
cp paper/main_template.tex paper/main.tex
cp paper/frontmatter_template/*.tex paper/frontmatter/
cp paper/sections_template/*.tex paper/sections/
cp paper/appendices_template/*.tex paper/appendices/

# 2. Replace [PLACEHOLDERS] in all .tex files with your content

# 3. Create figures from templates
cp -r figures_template/01_line_chart figures/01_my_concept
python figures/01_my_concept/chart.py

# 4. Build
just figures    # Generate all figures
just build      # Compile LaTeX

# 5. Verify
just qa         # Run all checks
                

3 Directory Structure

Academic_Primer_Framework/
├── justfile                          # Build commands
├── figures/                          # YOUR FIGURES
│   ├── _shared/
│   │   ├── colors.py                 # Color palette (8 colors)
│   │   └── styles.py                 # Matplotlib rcParams
│   └── 01_example_chart/
│       └── chart.py -> chart.pdf
├── figures_template/                 # 7 TEMPLATES
├── paper/
│   ├── main.tex                      # Your document
│   ├── main_template.tex             # TEMPLATE
│   ├── preamble.tex                  # DO NOT MODIFY
│   ├── notation.tex                  # DO NOT MODIFY
│   ├── sections/                     # 6 sections (01-06)
│   ├── sections_template/            # TEMPLATES
│   ├── appendices/                   # 4 appendices (A-D)
│   └── appendices_template/          # TEMPLATES
├── scripts/                          # Verification
└── tools/                            # Hallucination prevention

4 Template System

All templates use [UPPERCASE_PLACEHOLDER] markers:

% Before replacement
\section{[KEY_TOPIC_TITLE]}
[TOPIC_INTRODUCTION] has become essential for [DOMAIN].

% After replacement
\section{Deep Learning Architectures}
Deep learning has become essential for financial prediction.
                

Section Templates

Section	Purpose	Pages
01_introduction	Motivation, literature, contributions	~3
02_theory	Definitions, theorems, methods	~5
03_key_topic	Core novel contribution	~6
04_mathematical	Proofs, convergence, analysis	~5
05_empirical	Data, experiments, results	~5
06_validation	Testing, diagnostics, guidelines	~4

5 Figure System

Core Principle: One figure = One folder = One chart.pdf

📈

Line Chart

Trends, time series

📊

Bar Chart

Comparisons

⚫

Scatter Plot

Relationships

🔥

Heatmap

Matrices

📉

Time Series

Temporal data

📐

Distribution

Statistics

🔀

Flowchart

Processes

Figure Requirements

Section	Min Figures
01_introduction	1
02_theory	2
03_key_topic	3
04_mathematical	2
05_empirical	3
06_validation	2
Total	13

6 Build System

just                    # Show all commands
just figures            # Generate all figures
just figure NAME        # Generate single figure
just build              # Full compile (pdflatex + bibtex)
just build-quick        # Quick compile (no bibliography)
just qa                 # Full quality assurance
just clean              # Remove auxiliary files
                

7 Verification Tools

Figure Integration

All figures referenced in sections

Citation Verification

All cite keys exist in .bib

DOI Resolution

DOIs resolve at doi.org

LaTeX Overflow

Zero overfull warnings

python tools/run_all_checks.py

# Expected output:
======================================================================
Summary
======================================================================
  [OK]   Figure Integration   - 13/13 figures
  [OK]   Citation Verification - 40 entries
  [OK]   DOI Resolution       - All resolve
  [OK]   LaTeX Overflow       - 0 warnings
----------------------------------------------------------------------
Total: 4 passed, 0 failed
======================================================================
                

8 LaTeX Configuration

Predefined Math Commands

% Number Sets
\Real, \Natural, \Integer

% Probability & Statistics
\E[X], \Prob(A), \Var(X), \Cov(X,Y)

% Optimization
\argmin, \argmax

% Vectors & Matrices
\vec{x}, \mat{A}, \trans

% Cross-references
\Cref{fig:name}  % "Figure 1"
\citet{smith2020}  % "Smith (2020)"
\citep{smith2020}  % "(Smith, 2020)"
                

10 Hard Constraints

Constraint	Requirement
Figures	One chart.py per folder, one chart.pdf per script
Figure size	(10, 6) standard aspect ratio
LaTeX	Zero overflow warnings
Content	All [PLACEHOLDER] markers replaced
Integration	Minimum 13 figures referenced

11 Troubleshooting

Problem	Solution
"Missing figure" error	Run `python figures/XX_name/chart.py`
"Undefined citation"	Add entry to references.bib, run `just build`
"Overfull hbox"	Reduce figure width (0.65), shorten text
Figure not showing	Check path matches folder name (case-sensitive)
LaTeX fails	Run `just clean && just build`