diff --git a/papers/reflector/paper.tex b/papers/reflector/paper.tex index 463b85a..6be3e44 100644 --- a/papers/reflector/paper.tex +++ b/papers/reflector/paper.tex @@ -1,45 +1,26 @@ -\documentclass[11pt, letterpaper]{article} - -% ============================================================ -% reflector -% Reflective Development Systems for -% Recursive AI-Augmented Software Engineering -% -% Author: Alan Szmyt -% Repository: https://github.com/egohygiene/papers -% ============================================================ +\documentclass[11pt,letterpaper]{article} % ============================================================ % Encoding and Typography % ============================================================ - \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} - \usepackage{lmodern} \usepackage{microtype} +\usepackage[english]{babel} % ============================================================ % Page Layout % ============================================================ - -\usepackage[ -margin=1in, -includeheadfoot, -headheight=14pt -]{geometry} - +\usepackage[margin=1in]{geometry} \usepackage{setspace} -\onehalfspacing{} - +\onehalfspacing \usepackage{parskip} % ============================================================ % Colors % ============================================================ - \usepackage[dvipsnames]{xcolor} - \definecolor{reflectorblue}{HTML}{3B82F6} \definecolor{reflectorpurple}{HTML}{8B5CF6} \definecolor{reflectorgray}{HTML}{6B7280} @@ -47,77 +28,73 @@ \definecolor{reflectorbg}{HTML}{F8FAFC} % ============================================================ -% Hyperlinks and PDF Metadata +% Metadata Commands % ============================================================ +\newcommand{\papertitle}{Reflector: Reflective Development Systems for Recursive AI-Augmented Software Engineering} +\newcommand{\paperauthor}{Alan Szmyt} +\newcommand{\paperdate}{\today} +\newcommand{\paperstatus}{Draft} +\newcommand{\paperrepository}{https://github.com/egohygiene/papers} +\newcommand{\paperorcid}{0009-0008-5291-9795} +\newcommand{\paperorcidurl}{https://orcid.org/{\paperorcid}} +% ============================================================ +% Hyperlinks and PDF Metadata +% ============================================================ \usepackage[ -colorlinks=true, -linkcolor=reflectorblue, -citecolor=reflectorpurple, -urlcolor=reflectorblue, -pdfauthor={Alan Szmyt}, -pdftitle={Reflector: Reflective Development Systems for Recursive AI-Augmented Software Engineering}, -pdfsubject={AI-Augmented Software Engineering}, -pdfkeywords={ -AI, -recursive systems, -governance, -human-in-the-loop, -software engineering, -AI agents, -orchestration, -recursive auditing, -milestone synchronization, -reflective systems -}, -pdfcreator={LaTeX}, -pdfproducer={reflector publication pipeline} + unicode=true, + colorlinks=true, + linkcolor=reflectorblue, + citecolor=reflectorpurple, + urlcolor=reflectorblue, + pdftitle={\papertitle}, + pdfauthor={\paperauthor}, + pdfsubject={AI-Augmented Software Engineering}, + pdfkeywords={ + AI, + recursive systems, + governance, + human-in-the-loop, + software engineering, + recursive auditing, + milestone synchronization + }, + pdfcreator={LaTeX}, + pdfproducer={reflector publication pipeline} ]{hyperref} \usepackage{bookmark} % ============================================================ % Bibliography % ============================================================ - \usepackage[ -backend=biber, -style=ieee, -sorting=nyt, -giveninits=true, -maxbibnames=99, -doi=true, -url=true, -isbn=false, -eprint=true + backend=biber, + style=ieee, + sorting=nyt, + giveninits=true, + maxbibnames=99, + doi=true, + url=true, + isbn=false, + eprint=true ]{biblatex} - \addbibresource{references.bib} % ============================================================ % Graphics and Figures % ============================================================ - \usepackage{graphicx} -\graphicspath{ -{figures/} -{assets/} -{diagrams/} -} - -\usepackage{float} +\graphicspath{{figures/}{assets/}{diagrams/}} +\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg} \usepackage{caption} \usepackage{subcaption} - -\captionsetup{ -font=small, -labelfont=bf, -labelsep=period -} +\captionsetup{font=small,labelfont=bf,labelsep=period} +% Accessibility note: provide descriptive captions and keep figure exports as PDF/PNG/JPG. +% Future release tooling can map figure-level alt text metadata from canonical sources. % ============================================================ % Tables % ============================================================ - \usepackage{booktabs} \usepackage{array} \usepackage{longtable} @@ -126,237 +103,88 @@ % ============================================================ % Code Listings % ============================================================ - \usepackage{listings} - \lstdefinestyle{reflector}{ -backgroundcolor=\color{reflectorbg}, -basicstyle=\ttfamily\small, -breaklines=true, -frame=single, -rulecolor=\color{reflectorborder}, -numbers=left, -numberstyle=\tiny\color{reflectorgray}, -commentstyle=\color{reflectorgray}, -keywordstyle=\color{reflectorblue}, -stringstyle=\color{ForestGreen}, -showstringspaces=false, -tabsize=2, -columns=fullflexible -} - -\lstset{ -style=reflector + backgroundcolor=\color{reflectorbg}, + basicstyle=\ttfamily\small, + breaklines=true, + frame=single, + rulecolor=\color{reflectorborder}, + numbers=left, + numberstyle=\tiny\color{reflectorgray}, + commentstyle=\color{reflectorgray}, + keywordstyle=\color{reflectorblue}, + stringstyle=\color{ForestGreen}, + showstringspaces=false, + tabsize=2, + columns=fullflexible } +\lstset{style=reflector} % ============================================================ -% Math +% Math and Utilities % ============================================================ - \usepackage{amsmath} \usepackage{amssymb} \usepackage{amsthm} - -% ============================================================ -% Utilities -% ============================================================ - \usepackage{enumitem} \usepackage{csquotes} \usepackage{multirow} \usepackage{makecell} % ============================================================ -% Callouts and Theorem Environments -% ============================================================ - -\usepackage[most]{tcolorbox} - -\tcbset{ -colback=reflectorbg, -colframe=reflectorborder, -arc=3pt, -boxrule=0.5pt -} - -\newtcolorbox{reflectorcallout}{ -colback=reflectorbg, -colframe=reflectorblue, -enhanced, -breakable, -left=6pt, -right=6pt, -top=6pt, -bottom=6pt -} - -% ============================================================ -% Header and Footer -% ============================================================ - -\usepackage{fancyhdr} - -\pagestyle{fancy} - -\fancyhf{} - -\fancyhead[L]{reflector} -\fancyhead[R]{Alan Szmyt} - -\fancyfoot[C]{\thepage} - -\renewcommand{\headrulewidth}{0.4pt} -\renewcommand{\footrulewidth}{0pt} - -% ============================================================ -% Section Styling -% ============================================================ - -\usepackage{titlesec} - -\titleformat{\section} -{\large\bfseries} -{\thesection} -{1em} -{} - -\titleformat{\subsection} -{\normalsize\bfseries} -{\thesubsection} -{1em} -{} - -% ============================================================ -% Metadata Commands -% ============================================================ - -\newcommand{\papertitle}{ -Reflector: -Reflective Development Systems for -Recursive AI-Augmented Software Engineering -} - -\newcommand{\paperauthor}{ -Alan Szmyt -} - -\newcommand{\paperdate}{ -\today -} - -\newcommand{\paperrepository}{ -https://github.com/egohygiene/papers -} - -\newcommand{\paperorcid}{ -0009-0008-5291-9795 -} - -\newcommand{\paperorcidurl}{ -https://orcid.org/\paperorcid{} -} - -% ============================================================ -% Title +% Title Metadata % ============================================================ - -\title{ -\vspace{-1.5cm} -\textbf{\Huge reflector}\\[0.35cm] -\Large Reflective Development Systems for\\ -Recursive AI-Augmented Software Engineering -} - +\title{\papertitle} \author{ -Alan Szmyt\\ -\small \href{\paperrepository}{github.com/egohygiene/papers}\\ -\small \href{\paperorcidurl}{ORCID: \paperorcid} + \paperauthor\\ + \small\href{\paperorcidurl}{ORCID: \paperorcid}\\ + \small\href{\paperrepository}{\paperrepository} } - \date{\paperdate} % ============================================================ % Document % ============================================================ - \begin{document} -% ============================================================ -% Title Page -% ============================================================ - \maketitle -\thispagestyle{empty} - -\vspace{0.5cm} - -% \begin{abstract} -% \input{sections/abstract} -% \end{abstract} - -\vspace{0.5cm} - \begin{center} -\small -Version: Draft \ -Repository: \href{\paperrepository}{\paperrepository} + \small Version: \paperstatus \end{center} -\newpage - -% ============================================================ -% Table of Contents -% ============================================================ +\begin{abstract} + \input{sections/abstract} +\end{abstract} \tableofcontents - -% TODO \listoffigures - \newpage % ============================================================ % Main Sections % ============================================================ - -% \input{sections/introduction} -% \input{sections/recursive_development} -% \input{sections/human_in_the_loop} -% \input{sections/recursive_auditing} -% \input{sections/milestone_synchronization} -% \input{sections/governance_model} -% \input{sections/proposed_architecture} -% \input{sections/drift_failure_modes} -% \input{sections/future_work} -% \input{sections/conclusion} - -% ============================================================ -% Future Visual Sections -% ============================================================ - -% \input{sections/visual_manifest} -% \input{sections/appendix} -% \input{sections/implementation_examples} +\input{sections/introduction} +\input{sections/problem_statement} +\input{sections/recursive_development} +\input{sections/human_in_the_loop} +\input{sections/recursive_auditing} +\input{sections/milestone_synchronization} +\input{sections/governance_model} +\input{sections/proposed_architecture} +\input{sections/drift_failure_modes} +\input{sections/future_work} +\input{sections/conclusion} % ============================================================ % Bibliography % ============================================================ - -\newpage - -\nocite{*} - \printbibliography % ============================================================ % Appendix % ============================================================ - % \appendix % \input{sections/appendix} -% ============================================================ -% End Document -% ============================================================ - \end{document} diff --git a/templates/paper/paper.tex b/templates/paper/paper.tex index c06a7ba..7a631c9 100644 --- a/templates/paper/paper.tex +++ b/templates/paper/paper.tex @@ -1,39 +1,90 @@ -\documentclass[12pt, letterpaper]{article} +\documentclass[11pt,letterpaper]{article} -% --- Encoding and fonts --- +% ============================================================ +% Encoding and Typography +% ============================================================ \usepackage[utf8]{inputenc} \usepackage[T1]{fontenc} \usepackage{lmodern} +\usepackage{microtype} +\usepackage[english]{babel} -% --- Page geometry --- +% ============================================================ +% Page Layout +% ============================================================ \usepackage[margin=1in]{geometry} +\usepackage{setspace} +\onehalfspacing +\usepackage{parskip} -% --- Hyperlinks --- +% ============================================================ +% Metadata Commands +% ============================================================ +% TODO: Replace all metadata values below. +\newcommand{\papertitle}{PAPER TITLE} +\newcommand{\paperauthor}{AUTHOR NAME} +\newcommand{\paperdate}{\today} +\newcommand{\paperstatus}{Draft} +% TODO: Replace with the canonical repository URL for this paper source. +\newcommand{\paperrepository}{https://github.com/OWNER/REPO} +% TODO: Replace with the author's ORCID iD (example placeholder format). +\newcommand{\paperorcid}{0000-0000-0000-000X} +\newcommand{\paperorcidurl}{https://orcid.org/{\paperorcid}} + +% ============================================================ +% Hyperlinks and PDF Metadata +% ============================================================ \usepackage[ + unicode=true, colorlinks=true, linkcolor=blue, citecolor=blue, urlcolor=blue, - pdftitle={PAPER TITLE}, - pdfauthor={AUTHOR NAME}, + pdftitle={\papertitle}, + pdfauthor={\paperauthor} ]{hyperref} +\usepackage{bookmark} -% --- Bibliography --- -\usepackage[backend=biber, style=ieee, sorting=nyt]{biblatex} +% ============================================================ +% Bibliography +% ============================================================ +\usepackage[ + backend=biber, + style=ieee, + sorting=nyt, + giveninits=true, + maxbibnames=99, + doi=true, + url=true, + isbn=false, + eprint=true +]{biblatex} \addbibresource{references.bib} -% --- Graphics and figures --- +% ============================================================ +% Graphics and Figures +% ============================================================ \usepackage{graphicx} -\graphicspath{{figures/}} +\graphicspath{{figures/}{assets/}{diagrams/}} +\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg} +\usepackage{caption} +\usepackage{subcaption} +\captionsetup{font=small,labelfont=bf,labelsep=period} +% Accessibility note: use descriptive captions and keep an alt-text source note near each figure. -% --- Tables --- +% ============================================================ +% Tables +% ============================================================ \usepackage{booktabs} \usepackage{array} +\usepackage{longtable} +\usepackage{tabularx} -% --- Code listings --- -\usepackage{listings} +% ============================================================ +% Code Listings +% ============================================================ \usepackage{xcolor} - +\usepackage{listings} \lstset{ basicstyle=\ttfamily\small, breaklines=true, @@ -42,45 +93,60 @@ numberstyle=\tiny, commentstyle=\color{gray}, keywordstyle=\color{blue}, + showstringspaces=false } -% --- Math --- +% ============================================================ +% Math and Utilities +% ============================================================ \usepackage{amsmath} \usepackage{amssymb} +\usepackage{amsthm} +\usepackage{enumitem} +\usepackage{csquotes} +\usepackage{multirow} +\usepackage{makecell} -% --- Misc --- -\usepackage{microtype} -\usepackage{setspace} -\usepackage{parskip} - -% --- Title metadata --- -% TODO: Replace PAPER TITLE and AUTHOR NAME -\title{\textbf{PAPER TITLE}} -\author{AUTHOR NAME} -\date{\today} +% ============================================================ +% Title Metadata +% ============================================================ +\title{\papertitle} +\author{ + \paperauthor\\ + \small\href{\paperorcidurl}{ORCID: \paperorcid}\\ + \small\href{\paperrepository}{\paperrepository} +} +\date{\paperdate} % ============================================================ -\begin{document} +% Document % ============================================================ +\begin{document} \maketitle -\thispagestyle{empty} + +\begin{center} + \small Version: \paperstatus +\end{center} \begin{abstract} \input{sections/abstract} \end{abstract} -\newpage \tableofcontents \newpage \input{sections/introduction} % TODO: Add additional section \input commands here - \input{sections/future_work} \input{sections/conclusion} -\newpage \printbibliography +% ============================================================ +% Appendix +% ============================================================ +% \appendix +% \input{sections/appendix} + \end{document}