Skip to content

Commit

Permalink
feat: Add initial skeleton for installation hardware check (#76)
Browse files Browse the repository at this point in the history
  • Loading branch information
gteufelberger authored Jun 21, 2024
1 parent f300f9b commit 795f621
Show file tree
Hide file tree
Showing 7 changed files with 133 additions and 0 deletions.
96 changes: 96 additions & 0 deletions src/dacs-sw/installation-hardware-check/main.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
\documentclass{article}

\input{../../common/lib/header}

\usepackage[normalem]{ulem}

% Define a counter for the item numbers
\newcounter{rowCounter}
% Initialize counter
\setcounter{rowCounter}{0}

\newcounter{tableCounter}
\setcounter{tableCounter}{0}

% Command for row in checklist
% First argument is amount
% Second argument is description
\newcommand{\checklistItem}[2]{
\checkbox & #1 & #2 \\ \hline
}

% Command for row in procedure list
\newcommand{\procedureItem}[1]{
\stepcounter{rowCounter} % Increment counter
\arabic{tableCounter}.\arabic{rowCounter}
&
\checkbox
&
\checkbox
&
\checkbox
&
\begin{minipage}[t]{\linewidth}
#1
\vspace{1mm} % Just slightly add vspace to prevent clipping into table border
\end{minipage}
\\ \hline
}

% Command for row in note list
\newcommand{\noteItem}[1]{
\begin{minipage}[t]{\linewidth}
#1
\vspace{1mm} % Just slightly add vspace to prevent clipping into table border
\end{minipage}
\\ \hline
}


\title{Installation-Hardware Check}
\author{Operating Procedure}
\date{Version: \isodate\today}

\begin{document}

\maketitle

% Set the page style for the title page
\thispagestyle{fancy}

%%%%%% Prefix section
% Change section numbering to A, B, C...
\renewcommand{\thesection}{\Alph{section}}

\section{Operation Description}
\input{sections/operation-description.tex}

\section{Required Documents}
\input{sections/required-documents.tex}

\section{Required Tools}
\input{sections/required-tools.tex}

\section{Required Materials}
\input{sections/required-materials.tex}

\newpage

%%%%%% Main section
% Change section numbering to 1, 2, 3...
\renewcommand{\thesection}{\arabic{section}}

% Reset section counter to start from 1 again
\setcounter{section}{0}

\section{Installation}
\input{sections/installation.tex}

\newpage

%%%%%% Notes
\setcounter{section}{0}
\section*{Notes}
\input{sections/notes.tex}

\end{document}
13 changes: 13 additions & 0 deletions src/dacs-sw/installation-hardware-check/sections/installation.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
% Procedure for installation

\stepcounter{tableCounter} % Increment counter
\setcounter{rowCounter}{0} % Reset counter
\begin{tabularx}{\textwidth}{|>{\columncolor{tableColumnColor}}c|>{\columncolor{tableColumnColor}}c|>{\columncolor{tableColumnColor}}c|>{\columncolor{tableColumnColor}}c|X|}
\hline
\rowcolor{tableHeaderColor}
ID & CK 1 & CK 2 & CK 3 & Description \\ \hline

\procedureItem{
REPLACE ME
}
\end{tabularx}
10 changes: 10 additions & 0 deletions src/dacs-sw/installation-hardware-check/sections/notes.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
% Notes

\rowcolors{1}{notesColor}{notesColor}
\begin{tabularx}{\textwidth}{X}
\hline

\noteItem{
\textbf{REPLACE ME}
}
\end{tabularx}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
% Operation description
\textbf{REPLACE ME}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
% Required documents
\textbf{REPLACE ME}
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
% Required materials
\textbf{REPLACE ME}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
% Table of required tools

\begin{tabularx}{0.9\textwidth}{|>{\columncolor{tableColumnColor}}c|c|X|}
\hline
\rowcolor{tableHeaderColor}
Check & Amount & Description \\ \hline
\checklistItem{X}{Replace Me}
\end{tabularx}

0 comments on commit 795f621

Please sign in to comment.