Updated tex files with latest information about the program

2026-09-04 17:15:15 -05:00
1 parent f0716b0073
commit 0f8db48407
@@ -28,38 +28,44 @@
 \newcommand{\Gray}[1]{\textcolor{gray}{#1}}
 \newcommand{\Red}[1]{\textcolor{red}{#1}}

-\newcommand{\Required}[2]{
-  \makebox[3.3cm][l]{\texttt{\bold{\Red{#1}}}}: \begin{minipage}[t]{7cm}#2\end{minipage}
+% Keep parameter descriptions in the surrounding list so they can wrap and
+% continue onto another page, including nested parameter lists.
+\newcommand{\Required}[2]{\texttt{\bold{\Red{#1}}}: #2}
+\newcommand{\Optional}[2]{\texttt{\bold{\Gray{#1}}}: #2}
+
+% Reserve room for a sample heading and its first few lines.
+\newcommand{\SampleSpace}{%
+  \ifdim\dimexpr\pagegoal-\pagetotal\relax<6\baselineskip
+    \newpage
+  \fi
 }

-\newcommand{\Optional}[2]{
-  \makebox[3.35cm][l]{\texttt{\bold{\Gray{#1}}}}: \begin{minipage}[t]{7cm}#2\end{minipage}
+% Full-width samples allow long JSON responses to paginate naturally.
+\newcommand{\ApiData}[2]{%
+  \par\medskip\SampleSpace\noindent\bold{Sample Request}\par\nopagebreak
+  #1\par\medskip\SampleSpace\noindent\bold{Sample Response}\par\nopagebreak
+  #2\par\medskip
 }

-\newcommand{\ApiData}[2] {
-  \begin{tabular}{| C{0.5\textwidth} | C{0.5\textwidth} |} \hline
-    \bold{Sample Request} & \bold{Sample Response} \\ \hline
-    #1 & #2 \\ \hline
-   \end{tabular}
-}
-
-\newcommand{\locusworksCommonsVersion}{1.0.0-RELEASE\xspace}
-\newcommand{\EclipseVersion}{Oxygen.2 Release (4.7.2)\xspace}
-\newcommand{\JavaVersion}{21\xspace}
-\newcommand{\MavenVersion}{3.5.3\xspace}
-\newcommand{\AntVersion}{1.9.10\xspace}
-\newcommand{\AngularJsVersion}{1.6.9\xspace}
-\newcommand{\SpringVersion}{5.0.5-RELEASE\xspace}
-\newcommand{\NodeVersion}{24.20.0\xspace}
-\newcommand{\NpmVersion}{12.0.2\xspace}
-\newcommand{\HibernateVersion}{5.2.16.Final\xspace}
-\newcommand{\FlywayVersion}{5.0.7\xspace}
-\newcommand{\MySQLVersion}{5.7\xspace}
-\newcommand{\TomcatVersion}{9.0.121\xspace}
-\newcommand{\QuartzVerson}{2.3.0\xspace}
-\newcommand{\JSchVersion}{0.1.54\xspace}
-\newcommand{\JGitVersion}{4.11.0.201803080745-r\xspace}
-\newcommand{\NetBeansVersion}{8.2\xspace}
+% Versions match the project POMs, Spring Boot BOM, frontend lockfile and Jenkinsfile.
+\newcommand{\locusworksCommonsVersion}{3.0.1-RELEASE\xspace}
+\newcommand{\JavaVersion}{21\xspace}
+\newcommand{\MavenVersion}{3.9.16\xspace}
+\newcommand{\AngularVersion}{22.1.5\xspace}
+\newcommand{\AngularCliVersion}{22.1.7\xspace}
+\newcommand{\SpringBootVersion}{4.1.1\xspace}
+\newcommand{\SpringVersion}{7.0.9\xspace}
+\newcommand{\NodeVersion}{24.20.0\xspace}
+\newcommand{\NpmVersion}{12.0.2\xspace}
+\newcommand{\HibernateVersion}{7.4.5.Final\xspace}
+\newcommand{\FlywayVersion}{13.5.0\xspace}
+\newcommand{\HtwoVersion}{2.4.240\xspace}
+\newcommand{\MySQLVersion}{8.4 or newer\xspace}
+\newcommand{\MySQLConnectorVersion}{26.7.0\xspace}
+\newcommand{\TomcatVersion}{11.0.25\xspace}
+\newcommand{\QuartzVersion}{2.5.2\xspace}
+\newcommand{\JSchVersion}{2.28.7\xspace}
+\newcommand{\JGitVersion}{7.7.1.202607240634-r\xspace}

 \let\Oldsection\section
 \renewcommand{\section}{\FloatBarrier\Oldsection}
@@ -71,74 +77,25 @@
 \renewcommand{\subsubsection}{\FloatBarrier\Oldsubsubsection}


-% An environment for displaying api methods.
-%   This environment takes four parameters:
-%   \param #1: The name of the api method.
-%   \param #2: The endpoint url.
-%   \param #3: if its a post or get operations.
-%   \param #4: if the method requires authentication.
-%
-%   The body of the environment is the required parameters.
-\newsavebox{\ApiName}    % Create some boxes to hold the necessary text.
-\newsavebox{\ApiUrl}   % We need to do this because we can't use the
-\newsavebox{\ApiMethod} % environment parameters in the 'end' definition.
-\newsavebox{\ApiAuthReq}
-\newsavebox{\ApiRequired}
+% Metadata tables account for padding and borders. The body remains outside
+% the table so long procedures and parameter lists can break across pages.
 \newenvironment{apimethod}[4]
- {
-  \sbox{\ApiName}{\bfseries #1}  % The name is easy.
-  \sbox{\ApiUrl}{\vspace{2mm}#2\vspace{2mm}}
-  \sbox{\ApiMethod}{\vspace{2mm}#3\vspace{2mm}}           % The actor is easy.
-  \sbox{\ApiAuthReq}{\vspace{2mm}#4\vspace{2mm}}
-  \begin{lrbox}{\ApiRequired}      % The environment body becomes the action.
-  \begin{minipage}{1\textwidth}\vspace{2mm}
- }{
-  \vspace{2mm}
-  \end{minipage}
-  \end{lrbox}
- % Now spew forth the table using the information collected above.
-    
-    \begin{tabular}{|p{0.25\textwidth}||p{0.745\textwidth}|} \hline
-      \multicolumn{2}{|c|}{\usebox{\ApiName}} \\ \hline
-      Endpoint URL   & \usebox{\ApiUrl}   \\ \hline
-	  Method & \usebox{\ApiMethod} \\ \hline
-	  Requires Authentication & \usebox{\ApiAuthReq} \\ \hline
-	  Parameters & \usebox{\ApiRequired}  \\ \hline
-	\end{tabular}
-}
+ {\par\medskip\noindent
+  \begin{tabular}{|L{\dimexpr.27\linewidth-2\tabcolsep-1.5\arrayrulewidth\relax}|L{\dimexpr.73\linewidth-2\tabcolsep-1.5\arrayrulewidth\relax}|}\hline
+    \multicolumn{2}{|p{\dimexpr\linewidth-2\tabcolsep-2\arrayrulewidth\relax}|}{\bold{#1}}\\\hline
+    Endpoint URL & \command{#2}\\\hline
+    Method & #3\\\hline
+    Requires Authentication & #4\\\hline
+  \end{tabular}\par\nobreak\smallskip
+  \noindent\bold{Parameters}\par\nopagebreak
+ }{\par\medskip}

-% An environment for displaying use cases.
-%   This environment takes three parameters:
-%   \param #1: The name of the use case.
-%   \param #2: The actor who participates in the use case.
-%   \param #3: The context in which the use case executes.
-%
-%   The body of the environment is the action associated with the use case.
-\newsavebox{\UseCaseName}    % Create some boxes to hold the necessary text.
-\newsavebox{\UseCaseActor}   % We need to do this because we can't use the
-\newsavebox{\UseCaseContext} % environment parameters in the 'end' definition.
-\newsavebox{\UseCaseAction}
 \newenvironment{usecase}[3]
- {
-  \sbox{\UseCaseName}{\bfseries #1}  % The name is easy.
-  \sbox{\UseCaseActor}{\vspace{2mm}#2\vspace{2mm}}
-  \begin{lrbox}{\UseCaseContext}     % Format the context in a minipage.
-    \begin{minipage}{0.825\textwidth}
-    #3
-    \end{minipage}
-  \end{lrbox}
-  \begin{lrbox}{\UseCaseAction}      % The environment body becomes the action.
-  \begin{minipage}{0.825\textwidth}\vspace{2mm}
- }{
-  \vspace{2mm}
-  \end{minipage}
-  \end{lrbox}
- % Now spew forth the table using the information collected above.
-    \begin{tabular}{|R{0.1\textwidth}||L{0.85\textwidth}|} \hline
-      \multicolumn{2}{|c|}{\usebox{\UseCaseName}} \\ \hline
-      Actor  & \usebox{\UseCaseActor}   \\ \hline
-	  Context & \usebox{\UseCaseContext} \\ \hline
-	  Action & \usebox{\UseCaseAction}  \\ \hline
-	\end{tabular}
-}
-
+ {\par\medskip\noindent
+  \begin{tabular}{|L{\dimexpr.15\linewidth-2\tabcolsep-1.5\arrayrulewidth\relax}|L{\dimexpr.85\linewidth-2\tabcolsep-1.5\arrayrulewidth\relax}|}\hline
+    \multicolumn{2}{|p{\dimexpr\linewidth-2\tabcolsep-2\arrayrulewidth\relax}|}{\bold{#1}}\\\hline
+    Actor & #2\\\hline
+    Context & #3\\\hline
+  \end{tabular}\par\nobreak\smallskip
+  \noindent\bold{Action}\par\nopagebreak
+ }{\par\medskip}