WUT_Computer_Science/Programming/ECOTE/finalReport/sections/02-functional-requirements.tex
Krzysztof kuhy Rudnicki ffa5dad02a Split 19 over-cap LaTeX reports, proving each PDF is unchanged
The 250-line cap applies to prose too, and the reports were the worst
offenders -- ENUME's projectA.tex alone was 1,876 lines. Each is now a
preamble plus one \input{} per section, which is how a long LaTeX document is
normally organised; not one byte of prose was rewritten.

"The PDF is unchanged" is checked by a script rather than by eye, because
hashing the PDF cannot work: pdflatex stamps a /CreationDate and an /ID into
every build, so two runs of the SAME source already differ. tex_fingerprint.sh
compares what a reader sees instead -- page count plus a hash of the extracted
text -- and it is stable across rebuilds of untouched sources, which is the
property that makes it usable as a gate.

It earned its keep immediately. Both ECOTE reports quote an example LaTeX
document inside an lstlisting block, so \end{document} appears in the middle
of the file; splitting on the FIRST one stranded everything after it. Same
page count, different text, caught automatically. EOPSY lab3 exposed a second
bug: a \section{} title that runs onto the next line.

Result: 19 .tex over the cap -> 1. The survivor,
ELAC/.../03-building-nfa-...tex, is 418 lines of consecutive tikz figures
with no subsection to split on and needs a hand-placed boundary.

Verified: 29 splits across two passes (section, then subsection for the
pieces still over), every one reporting `unchanged` from
scripts/tex_fingerprint.sh --check.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_0172dj34FDpao6wsix8ZuCzE
2026-08-28 19:47:12 +02:00

30 lines
1.6 KiB
TeX

\section{Functional requirements}
The goal of the project is to transform .tex file to (working ) .html file if the subset of .tex file is within project scope or output error message explaining why the html could not be outputed
\subsection{\LaTeX \, subset}
This project will focus almost exclusively on \emph{tabular} environment \\
\begin{itemize}
\item $\backslash$documentclass\{class\}: Defines what layout standard \LaTeX will use
\item $\backslash$begin\{document\}: Ends (in our case empty) preamble
\item $\backslash$end\{document\}: Ends \LaTeX \, document
\item $\backslash$begin\{tabular\}[pos]\{table spec\}: Opens environment used to typeset tables
\item $\backslash$end\{tabular\}: Closes environment used to typeset tables
\end{itemize}
Supported tabular arguments:
\begin{itemize}
\item l, c, r - respectively left-justified, centered and right-justified column
\item | - single vertical line
\item || - double vertical line
\item p\{'width'\} - paragraph column (that wraps), aligned at the top
\item m\{'width'\} - paragraph column (that wraps), aligned at the middle
\item b\{'width'\} - paragraph column (that wraps), aligned at the bottom
\end{itemize}
Supported commands inside tabular environment
\begin{itemize}
\item \& - separate columns
\item $\backslash$$\backslash$ - start new row
\item $\backslash$hline - horizontal line
\item $\backslash$cline\{i-j\} horizontal line beginning in column i and ending in column j
\item $\backslash$newline - new line \emph{inside} the cell
\end{itemize}