From 024a5a0179f91e61f76e2d17fa13e62e888f1246 Mon Sep 17 00:00:00 2001
From: Loic Guegan <manzerbredes@mailbox.org>
Date: Tue, 13 Sep 2022 19:56:22 +0200
Subject: Update manual

---
 manual/manual.tex | 32 ++++++++++++++++++++++++++------
 1 file changed, 26 insertions(+), 6 deletions(-)

(limited to 'manual/manual.tex')

diff --git a/manual/manual.tex b/manual/manual.tex
index 94aa592..4af9323 100644
--- a/manual/manual.tex
+++ b/manual/manual.tex
@@ -21,7 +21,7 @@
 \newcommand{\version}{\InputIfFileExists{version}{}{version}}
 \newcommand*{\addsource}[2]{\vspace{0.3cm}\begin{tcolorbox}[breakable,enhanced,arc=1.4mm,arc is angular,title=\textbf{\small#1}]\inputminted[breaklines,fontsize=\scriptsize]{#2}{#1}\end{tcolorbox}}
 \newenvironment{tabminted}[1]
-               {\VerbatimEnvironment\begin{minipage}{2.5in}\begin{tcolorbox}[frame empty]\begin{minted}{#1}}
+               {\VerbatimEnvironment\begin{minipage}{2.65in}\begin{tcolorbox}[frame empty]\begin{minted}{#1}}
                {\end{minted}\end{tcolorbox}\end{minipage}}
 
 % Document
@@ -122,29 +122,49 @@ As explain in Section \ref{sec:firstsimulation:platform}, esds platform files co
 Lets see in details the format of each section.
 
 \subsection{General}
-This section is used to settings up the overall parameters of esds. Table\ref{keywords:general} reference all the keywords for this section of the platform file.
+This section is used to settings up the overall parameters of esds. Table \ref{keywords:general} reference all the keywords for this section of the platform file.
 
 \begin{table}[]
   \centering
-  \begin{tabular}{llp{0.4\textwidth}}
+  \begin{tabular}{m{0.25\textwidth}m{0.3\textwidth}p{0.4\textwidth}}
     \toprule
     \textbf{Keyword} & \textbf{Description} & \textbf{Example} \\ \midrule
 
-    \textbf{interferences} & \makecell[l]{Turn on/off interferences detection\\ during wireless communications} &
+    \textbf{interferences} & Turn on/off interferences detection during wireless communications &
     \begin{tabminted}{yaml}
 interferences: on
     \end{tabminted}
     \\ \cmidrule{1-3}
     
-    \textbf{debug} & \makecell[l]{Turn on/off esds debugging\\mode (generate a debug file)} &
+    \textbf{debug} & Turn on/off esds debugging mode (generate a debug file) &
     \begin{tabminted}{yaml}
 debug: on
     \end{tabminted}
     \\ \cmidrule{1-3}
 
-    \textbf{debug\_file} & \makecell[l]{Specify the file to use as output\\for the debugging} &
+    \textbf{debug\_file} & Specify the file to use as output for the debugging &
     \begin{tabminted}{yaml}
 debug_file: "./myfile.txt"
+    \end{tabminted}
+    \\ \cmidrule{1-3}
+    
+    \textbf{breakpoints} & Specify a list of simulated time (in seconds) at which esds should interrupt and call the specified callback &
+    \begin{tabminted}{yaml}
+breakpoints: [5, 6, 7]
+    \end{tabminted}
+    \\ \cmidrule{1-3}
+    
+    \textbf{breakpoints\_every} & Specify an interval of time (in seconds) at which esds will interrupt and call the specified callback &
+    \begin{tabminted}{yaml}
+breakpoints_every: 5
+    \end{tabminted}
+    \\ \cmidrule{1-3}
+    
+    \textbf{breakpoints\_callback} & Tell esds where how to reach the callback used during breakpoints &
+    \begin{tabminted}{yaml}
+breakpoints_callback:
+  file: "platform_callback.py"
+  callback: "callback"
     \end{tabminted}
     \\ \bottomrule
 \end{tabular}
-- 
cgit v1.2.3

