Template creation (#106)

* Update README.md

* feat: create procedure template

README.md

@@ -1,5 +1,5 @@
-# helios-procedures
-LaTeX source for HELIOS related procedures
+# hephaestus-procedures
+LaTeX source for HEPHAESTUS related procedures
 
 To get the procedures, go to the [release page on right side](https://github.com/aris-space/helios-procedures/releases) and download it from the release assets.
 

src/common/lib/header.tex

@@ -45,7 +45,7 @@
 \lhead{\includegraphics[width=2cm]{../../common/assets/HELIOS_LOGO.png}}
 \rhead{\includegraphics[width=2cm]{../../common/assets/ARIS_space_to_grow_LOGO-black.pdf}}
 \cfoot{\thepage}
-\fancyfoot[L]{Project HELIOS}
+\fancyfoot[L]{Project HEPHAESTUS}
 \fancyfoot[C]{Page \thepage\ out of \pageref{LastPage}}
 
 % Draft watermark

src/templates/procedure-template/main.out

@@ -0,0 +1,6 @@
+\BOOKMARK [1][-]{section.1}{\376\377\000O\000p\000e\000r\000a\000t\000i\000o\000n\000\040\000D\000e\000s\000c\000r\000i\000p\000t\000i\000o\000n}{}% 1
+\BOOKMARK [1][-]{section.2}{\376\377\000R\000e\000q\000u\000i\000r\000e\000d\000\040\000D\000o\000c\000u\000m\000e\000n\000t\000s}{}% 2
+\BOOKMARK [1][-]{section.3}{\376\377\000R\000e\000q\000u\000i\000r\000e\000d\000\040\000T\000o\000o\000l\000s}{}% 3
+\BOOKMARK [1][-]{section.4}{\376\377\000R\000e\000q\000u\000i\000r\000e\000d\000\040\000M\000a\000t\000e\000r\000i\000a\000l\000s}{}% 4
+\BOOKMARK [1][-]{section.1}{\376\377\000P\000r\000o\000c\000e\000d\000u\000r\000e\000\040\000e\000x\000a\000m\000p\000l\000e\000\040\000n\000u\000m\000e\000r\000o\000\040\000u\000n\000o}{}% 5
+\BOOKMARK [1][-]{section.2}{\376\377\000P\000r\000o\000c\000e\000d\000u\000r\000e\000\040\000e\000x\000a\000m\000p\000l\000e\000\040\000n\000u\000m\000e\000r\000o\000\040\000d\000o\000s}{}% 6

src/templates/procedure-template/main.tex

@@ -0,0 +1,98 @@
+\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}[2]{
+  \stepcounter{rowCounter} % Increment counter
+  \arabic{tableCounter}.\arabic{rowCounter}
+  &
+  \checkbox
+  &
+  \begin{minipage}[t]{1.2\linewidth}
+    #1
+    \vspace{1mm} % Just slightly add vspace to prevent clipping into table border
+  \end{minipage}
+  &
+  \begin{minipage}[t]{0.8\linewidth}
+    #2
+    \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{Template Procedure}
+\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{Procedure example numero uno}
+\input{sections/procedure_1.tex}
+
+\section{Procedure example numero dos}
+\input{sections/procedure_2.tex}
+
+\newpage
+
+%%%%%% Notes
+\setcounter{section}{0}
+\section*{Notes}
+\input{sections/notes.tex}
+
+\end{document}

src/templates/procedure-template/sections/notes.tex

@@ -0,0 +1,36 @@
+% Notes
+
+\rowcolors{1}{notesColor}{notesColor}
+\begin{tabularx}{\textwidth}{X}
+  \hline
+
+  \noteItem{
+    In the notes section, you can add any additional information that is relevant to the procedure. You can also add blank space to add notes during exectution.
+  }
+
+  \noteItem{
+    This is a second note. You can add as many notes as you need.
+  }
+
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+  \noteItem{}
+
+\end{tabularx}

src/templates/procedure-template/sections/operation-description.tex

@@ -0,0 +1,2 @@
+% Operation description
+This describes the operation for which the following procedure should be used.

src/templates/procedure-template/sections/procedure_1.tex

@@ -0,0 +1,82 @@
+% Procedure for installation
+
+\stepcounter{tableCounter} % Increment counter
+\setcounter{rowCounter}{0} % Reset counter
+\begin{tabularx}{\textwidth}{|>{\columncolor{tableColumnColor}}c|>{\columncolor{tableColumnColor}}c|>{\hsize=1.2\hsize}X|>{\hsize=.8\hsize}X|}
+  \hline
+  \rowcolor{tableHeaderColor}
+  ID & Check & Description & Comments \\ \hline
+  \cellcolor{cyan}
+  \procedureItem{
+    This is a task for the test conductor, which is why it's marked as cyan.
+  }{Here, comments or pictures can be added to clarify the task.}
+
+  \cellcolor{green}
+  \procedureItem{
+    This is a task for the Safety Officer, which is why it's marked green. Tasks can also have itemized lists:
+
+    \begin{itemize}
+      \item Like this: \texttt{/home/dacs/git/}
+
+      \item Or this
+    \end{itemize}
+  }
+
+  \procedureItem{
+    Commit config file and push to GitLab.
+  \\
+    Make sure to commit it under your name based on the instructions in the wiki
+  \\
+    Make sure to push after committing
+  }
+
+  \procedureItem{
+    Unplug the power supply of the trailer
+  }
+
+  \multicolumn{4}{|c|}{\cellcolor{tableColumnColor}This is an inserted comment, for example: 30 min before briefing} \\ \hline
+
+  \procedureItem{
+    Unplug the 70m Ethernet cable and extension.
+  }
+
+  \procedureItem{
+    Carefully roll up the 70m Ethernet replacement cable and the extensions individually.
+  \\
+    Note that it is only rated for indoor usage so make sure to not drag it along the ground.
+  }
+
+  \procedureItem{
+    Put the Ethernet connector protectors back onto the 70m Ethernet cable.
+  }
+
+  \procedureItem{
+    Roll the rugged cable up onto cable roll starting on the trailer side as the MOB box is permanently attached to the cable and should not be moved around to much.
+  }
+
+  \procedureItem{
+    Make sure the data is saved and uploaded on Sharepoint as described in PRO\_OP\_DACS\_009\_DataSavingExport\_01
+  }
+
+  \procedureItem{
+    Turn off mission control PC and Surveillance/KiDAQ PC
+  }
+
+  \procedureItem{
+    \hl{
+      Place the three monitors with foil to protect the displays in the two big DACS boxes
+    }
+  }
+
+  \procedureItem{
+    \hl{
+      Put PC power cables, power strips, DP cables, mouses, keyboards and manual override box in the same boxes
+    }
+  }
+
+  \procedureItem{
+    \hl{
+      Put the two PCs in the smaller DACS box together with the Ethernet switch, Ethernet cables and Switch‘s power cable
+    }
+  }{}
+\end{tabularx}

src/templates/procedure-template/sections/procedure_2.tex

@@ -0,0 +1,12 @@
+% Just copy and paste from procedure_1 and modify as needed
+
+\stepcounter{tableCounter} % Increment counter
+\setcounter{rowCounter}{0} % Reset counter
+\begin{tabularx}{\textwidth}{|>{\columncolor{tableColumnColor}}c|>{\columncolor{tableColumnColor}}c|>{\hsize=1.2\hsize}X|>{\hsize=.8\hsize}X|}
+  \hline
+  \rowcolor{tableHeaderColor}
+  ID & Check & Description & Comments \\ \hline
+  \procedureItem{
+    Sample task
+  }{Sample comment}
+\end{tabularx}

src/templates/procedure-template/sections/required-documents.tex

@@ -0,0 +1,8 @@
+% Required documents
+\begin{tabularx}{0.9\textwidth}{|>{\columncolor{tableColumnColor}}c|c|X|}
+    \hline
+    \rowcolor{tableHeaderColor}
+    Check & Amount & Name \\ \hline
+    \checklistItem{1}{Insert all needed documents needed for the execution of the procedure here} \hline
+    \cellcolor{red}\checklistItem{1 (PRINT)}{You can also specify procedures or documents that need to be printed}
+  \end{tabularx}

src/templates/procedure-template/sections/required-materials.tex

@@ -0,0 +1,25 @@
+% Table of required materials
+
+\begin{tabularx}{0.9\textwidth}{|>{\columncolor{tableColumnColor}}c|c|X|}
+    \hline
+    \rowcolor{tableHeaderColor}
+    Check & Amount & Description \\ \hline
+    \checklistItem{1}{Mission Control PC}
+    \checklistItem{1}{Windows PC with KiStudio Lab preinstalled (KiDAQ PC)}
+    \checklistItem{3}{Monitor}
+    \checklistItem{2}{Keyboard}
+    \checklistItem{2}{Mouse}
+    \checklistItem{2}{Wifi Adapter}
+    \checklistItem{2}{Power Adapter for PC}
+    \checklistItem{1}{Manual Override Box}
+    \checklistItem{2}{Power Strip}
+    \checklistItem{3}{DP Cable}
+    \checklistItem{1}{Phone with Hotspot \& Charger}
+    \checklistItem{1}{Ethernet cable on cable roll (connected to testbench)}
+    \checklistItem{1}{HELIOS Ethernet Switch with power cable}
+    \checklistItem{2}{Short Ethernet cable}
+  \end{tabularx}
+
+% If no materials required, delete previous lines and uncomment next line
+% \textit{none}
+

src/templates/procedure-template/sections/required-tools.tex

@@ -0,0 +1,12 @@
+% Table of required tools
+
+\begin{tabularx}{0.9\textwidth}{|>{\columncolor{tableColumnColor}}c|c|X|}
+    \hline
+    \rowcolor{tableHeaderColor}
+    Check & Amount & Description \\ \hline
+    \checklistItem{1}{Some tool}
+  \end{tabularx}
+
+% If no tools required, delete previous lines and uncomment next line
+% \textit{none}
+