Skip to content

Commit 2dc752d

Browse files
v30mattv30matt
authored
Template creation (#106)
* Update README.md * feat: create procedure template
1 parent ef670ae commit 2dc752d

File tree

11 files changed

+284
-3
lines changed

11 files changed

+284
-3
lines changed

‎README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# helios-procedures
2-
LaTeX source for HELIOS related procedures
1+
# hephaestus-procedures
2+
LaTeX source for HEPHAESTUS related procedures
33

44
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.
55

‎src/common/lib/header.tex

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
\lhead{\includegraphics[width=2cm]{../../common/assets/HELIOS_LOGO.png}}
4646
\rhead{\includegraphics[width=2cm]{../../common/assets/ARIS_space_to_grow_LOGO-black.pdf}}
4747
\cfoot{\thepage}
48-
\fancyfoot[L]{Project HELIOS}
48+
\fancyfoot[L]{Project HEPHAESTUS}
4949
\fancyfoot[C]{Page \thepage\ out of \pageref{LastPage}}
5050

5151
% Draft watermark

‎src/templates/procedure-template/main.out

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
\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
2+
\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
3+
\BOOKMARK [1][-]{section.3}{\376\377\000R\000e\000q\000u\000i\000r\000e\000d\000\040\000T\000o\000o\000l\000s}{}% 3
4+
\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
5+
\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
6+
\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

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
\documentclass{article}
2+
3+
\input{../../common/lib/header}
4+
5+
% Define a counter for the item numbers
6+
\newcounter{rowCounter}
7+
% Initialize counter
8+
\setcounter{rowCounter}{0}
9+
10+
\newcounter{tableCounter}
11+
\setcounter{tableCounter}{0}
12+
13+
% Command for row in checklist
14+
% First argument is amount
15+
% Second argument is description
16+
\newcommand{\checklistItem}[2]{
17+
\checkbox & #1 & #2 \\ \hline
18+
}
19+
20+
% Command for row in procedure list
21+
\newcommand{\procedureItem}[2]{
22+
\stepcounter{rowCounter} % Increment counter
23+
\arabic{tableCounter}.\arabic{rowCounter}
24+
&
25+
\checkbox
26+
&
27+
\begin{minipage}[t]{1.2\linewidth}
28+
#1
29+
\vspace{1mm} % Just slightly add vspace to prevent clipping into table border
30+
\end{minipage}
31+
&
32+
\begin{minipage}[t]{0.8\linewidth}
33+
#2
34+
\vspace{1mm} % Just slightly add vspace to prevent clipping into table border
35+
\end{minipage}
36+
\\ \hline
37+
}
38+
39+
% Command for row in note list
40+
\newcommand{\noteItem}[1]{
41+
\begin{minipage}[t]{\linewidth}
42+
#1
43+
\vspace{1mm} % Just slightly add vspace to prevent clipping into table border
44+
\end{minipage}
45+
\\ \hline
46+
}
47+
48+
49+
\title{Template Procedure}
50+
\author{Operating Procedure}
51+
\date{Version: \isodate\today}
52+
53+
\begin{document}
54+
55+
\maketitle
56+
57+
% Set the page style for the title page
58+
\thispagestyle{fancy}
59+
60+
%%%%%% Prefix section
61+
% Change section numbering to A, B, C...
62+
\renewcommand{\thesection}{\Alph{section}}
63+
64+
\section{Operation Description}
65+
\input{sections/operation-description.tex}
66+
67+
\section{Required Documents}
68+
\input{sections/required-documents.tex}
69+
70+
\section{Required Tools}
71+
\input{sections/required-tools.tex}
72+
73+
\section{Required Materials}
74+
\input{sections/required-materials.tex}
75+
76+
\newpage
77+
78+
%%%%%% Main section
79+
% Change section numbering to 1, 2, 3...
80+
\renewcommand{\thesection}{\arabic{section}}
81+
82+
% Reset section counter to start from 1 again
83+
\setcounter{section}{0}
84+
85+
\section{Procedure example numero uno}
86+
\input{sections/procedure_1.tex}
87+
88+
\section{Procedure example numero dos}
89+
\input{sections/procedure_2.tex}
90+
91+
\newpage
92+
93+
%%%%%% Notes
94+
\setcounter{section}{0}
95+
\section*{Notes}
96+
\input{sections/notes.tex}
97+
98+
\end{document}

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
% Notes
2+
3+
\rowcolors{1}{notesColor}{notesColor}
4+
\begin{tabularx}{\textwidth}{X}
5+
\hline
6+
7+
\noteItem{
8+
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.
9+
}
10+
11+
\noteItem{
12+
This is a second note. You can add as many notes as you need.
13+
}
14+
15+
\noteItem{}
16+
\noteItem{}
17+
\noteItem{}
18+
\noteItem{}
19+
\noteItem{}
20+
\noteItem{}
21+
\noteItem{}
22+
\noteItem{}
23+
\noteItem{}
24+
\noteItem{}
25+
\noteItem{}
26+
\noteItem{}
27+
\noteItem{}
28+
\noteItem{}
29+
\noteItem{}
30+
\noteItem{}
31+
\noteItem{}
32+
\noteItem{}
33+
\noteItem{}
34+
\noteItem{}
35+
36+
\end{tabularx}

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
% Operation description
2+
This describes the operation for which the following procedure should be used.

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

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
% Procedure for installation
2+
3+
\stepcounter{tableCounter} % Increment counter
4+
\setcounter{rowCounter}{0} % Reset counter
5+
\begin{tabularx}{\textwidth}{|>{\columncolor{tableColumnColor}}c|>{\columncolor{tableColumnColor}}c|>{\hsize=1.2\hsize}X|>{\hsize=.8\hsize}X|}
6+
\hline
7+
\rowcolor{tableHeaderColor}
8+
ID & Check & Description & Comments \\ \hline
9+
\cellcolor{cyan}
10+
\procedureItem{
11+
This is a task for the test conductor, which is why it's marked as cyan.
12+
}{Here, comments or pictures can be added to clarify the task.}
13+
14+
\cellcolor{green}
15+
\procedureItem{
16+
This is a task for the Safety Officer, which is why it's marked green. Tasks can also have itemized lists:
17+
18+
\begin{itemize}
19+
\item Like this: \texttt{/home/dacs/git/}
20+
21+
\item Or this
22+
\end{itemize}
23+
}
24+
25+
\procedureItem{
26+
Commit config file and push to GitLab.
27+
\\
28+
Make sure to commit it under your name based on the instructions in the wiki
29+
\\
30+
Make sure to push after committing
31+
}
32+
33+
\procedureItem{
34+
Unplug the power supply of the trailer
35+
}
36+
37+
\multicolumn{4}{|c|}{\cellcolor{tableColumnColor}This is an inserted comment, for example: 30 min before briefing} \\ \hline
38+
39+
\procedureItem{
40+
Unplug the 70m Ethernet cable and extension.
41+
}
42+
43+
\procedureItem{
44+
Carefully roll up the 70m Ethernet replacement cable and the extensions individually.
45+
\\
46+
Note that it is only rated for indoor usage so make sure to not drag it along the ground.
47+
}
48+
49+
\procedureItem{
50+
Put the Ethernet connector protectors back onto the 70m Ethernet cable.
51+
}
52+
53+
\procedureItem{
54+
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.
55+
}
56+
57+
\procedureItem{
58+
Make sure the data is saved and uploaded on Sharepoint as described in PRO\_OP\_DACS\_009\_DataSavingExport\_01
59+
}
60+
61+
\procedureItem{
62+
Turn off mission control PC and Surveillance/KiDAQ PC
63+
}
64+
65+
\procedureItem{
66+
\hl{
67+
Place the three monitors with foil to protect the displays in the two big DACS boxes
68+
}
69+
}
70+
71+
\procedureItem{
72+
\hl{
73+
Put PC power cables, power strips, DP cables, mouses, keyboards and manual override box in the same boxes
74+
}
75+
}
76+
77+
\procedureItem{
78+
\hl{
79+
Put the two PCs in the smaller DACS box together with the Ethernet switch, Ethernet cables and Switch‘s power cable
80+
}
81+
}{}
82+
\end{tabularx}

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
% Just copy and paste from procedure_1 and modify as needed
2+
3+
\stepcounter{tableCounter} % Increment counter
4+
\setcounter{rowCounter}{0} % Reset counter
5+
\begin{tabularx}{\textwidth}{|>{\columncolor{tableColumnColor}}c|>{\columncolor{tableColumnColor}}c|>{\hsize=1.2\hsize}X|>{\hsize=.8\hsize}X|}
6+
\hline
7+
\rowcolor{tableHeaderColor}
8+
ID & Check & Description & Comments \\ \hline
9+
\procedureItem{
10+
Sample task
11+
}{Sample comment}
12+
\end{tabularx}

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
% Required documents
2+
\begin{tabularx}{0.9\textwidth}{|>{\columncolor{tableColumnColor}}c|c|X|}
3+
\hline
4+
\rowcolor{tableHeaderColor}
5+
Check & Amount & Name \\ \hline
6+
\checklistItem{1}{Insert all needed documents needed for the execution of the procedure here} \hline
7+
\cellcolor{red}\checklistItem{1 (PRINT)}{You can also specify procedures or documents that need to be printed}
8+
\end{tabularx}

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

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
% Table of required materials
2+
3+
\begin{tabularx}{0.9\textwidth}{|>{\columncolor{tableColumnColor}}c|c|X|}
4+
\hline
5+
\rowcolor{tableHeaderColor}
6+
Check & Amount & Description \\ \hline
7+
\checklistItem{1}{Mission Control PC}
8+
\checklistItem{1}{Windows PC with KiStudio Lab preinstalled (KiDAQ PC)}
9+
\checklistItem{3}{Monitor}
10+
\checklistItem{2}{Keyboard}
11+
\checklistItem{2}{Mouse}
12+
\checklistItem{2}{Wifi Adapter}
13+
\checklistItem{2}{Power Adapter for PC}
14+
\checklistItem{1}{Manual Override Box}
15+
\checklistItem{2}{Power Strip}
16+
\checklistItem{3}{DP Cable}
17+
\checklistItem{1}{Phone with Hotspot \& Charger}
18+
\checklistItem{1}{Ethernet cable on cable roll (connected to testbench)}
19+
\checklistItem{1}{HELIOS Ethernet Switch with power cable}
20+
\checklistItem{2}{Short Ethernet cable}
21+
\end{tabularx}
22+
23+
% If no materials required, delete previous lines and uncomment next line
24+
% \textit{none}
25+

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
% Table of required tools
2+
3+
\begin{tabularx}{0.9\textwidth}{|>{\columncolor{tableColumnColor}}c|c|X|}
4+
\hline
5+
\rowcolor{tableHeaderColor}
6+
Check & Amount & Description \\ \hline
7+
\checklistItem{1}{Some tool}
8+
\end{tabularx}
9+
10+
% If no tools required, delete previous lines and uncomment next line
11+
% \textit{none}
12+

0 commit comments

Comments
 (0)