Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add initial skeleton for data saving export procedure #88

Merged
merged 1 commit into from
Jun 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 106 additions & 0 deletions src/dacs-sw/data-saving-and-export/main.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
\documentclass{article}

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

% 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{DACS Data Saving and Export }
\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{Preparation}
\input{sections/preparation.tex}
\newpage

\section{During the test}
\input{sections/during-test.tex}
\newpage

\section{Deinstallation}
\input{sections/deinstallation.tex}
\newpage

\section{Export to Database}
\input{sections/export.tex}

\newpage

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

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

\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}
13 changes: 13 additions & 0 deletions src/dacs-sw/data-saving-and-export/sections/during-test.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
% Procedure for during the test

\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}
13 changes: 13 additions & 0 deletions src/dacs-sw/data-saving-and-export/sections/export.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
% Procedure for export to database

\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/data-saving-and-export/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}
13 changes: 13 additions & 0 deletions src/dacs-sw/data-saving-and-export/sections/preparation.tex
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
% Procedure for preparation

\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}
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}