Skip to content

Commit 88bf28b

Browse files
Update User Guide
Fix input paths for macros and logo. Add step to installation instructions to include Simulink-Utility submodule. Update old citation.
1 parent b287e7d commit 88bf28b

File tree

3 files changed

+16
-10
lines changed

3 files changed

+16
-10
lines changed

.gitignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
doc/tex/SimulinkModule_UserGuide.aux
3+
doc/tex/SimulinkModule_UserGuide.log
4+
doc/tex/SimulinkModule_UserGuide.out
5+
doc/tex/SimulinkModule_UserGuide.synctex.gz
6+
doc/tex/SimulinkModule_UserGuide.toc

doc/SimulinkModule_UserGuide.pdf

8.82 KB
Binary file not shown.

doc/tex/SimulinkModule_UserGuide.tex

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -70,18 +70,17 @@
7070
\maketitle
7171
\vfill
7272

73-
%\begin{figure}
74-
% \centering
75-
% \includegraphics[]{../../common/McSCert_Logo.pdf} \\
76-
% McMaster Centre for Software Certification (McSCert)
77-
%\end{figure}
73+
\begin{figure}
74+
\centering
75+
\includegraphics{../figs/McSCert_Logo.pdf} \\
76+
McMaster Centre for Software Certification (McSCert)
77+
\end{figure}
7878

7979
\newpage
8080

8181
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8282
% Table of Contents
8383
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
84-
8584
\tableofcontents
8685
\newpage
8786

@@ -148,9 +147,9 @@ \section{How to Use the Tool}
148147
\subsection{Prerequisites and Installation}
149148

150149
\begin{enumerate}
151-
\item For full use of the tool, please use \matlab/\Simulink R2017b or newer.\footnote{Simulink functions were introduced in R2014b. The \emph{Function Visibility} parameter was introduced in R2017b.}
150+
\item For full use of the tool, please use \matlab/\Simulink R2017b or newer.\footnote{Simulink functions were introduced in R2014b. The \emph{Function Visibility} parameter was introduced in R2017b.}
152151

153-
\item To install the tool,
152+
\item To install the tool,
154153
\begin{enumerate}
155154
\item from a \file{.zip} file --- unzip the contents into your desired location. Ensure the unzipped folder and subfolders are present in your \mpath, or add them if they are not present. Run \href{https://www.mathworks.com/help/simulink/ug/registering-customizations.html}{sl\_refresh\_customizations} to refresh the Context Menu.
156155
\item from a \file{.mltbx} file --- simply open \Matlab and double-click on the file. Your \mpath should be automatically configured.
@@ -160,7 +159,8 @@ \subsection{Prerequisites and Installation}
160159
\item \textit{Note:} If running the command ``\cmd{which AutoLayout}'' indicates that the script is not found, then the tool needs to be added to the \mpath.
161160
For information on adding files to the \mpath, please see the \href{https://www.mathworks.com/help/matlab/matlab_env/add-remove-or-reorder-folders-on-the-search-path.html}{MathWorks documentation}.
162161
\end{itemize}
163-
\item Ensure your model is open and unlocked.
162+
\item Ensure the Simulink-Utility folder is on your \mpath. This is a dependency for the tool to work correctly.
163+
\item Ensure your model is open and unlocked.
164164
\end{enumerate}
165165

166166
%---------------------------------------
@@ -486,7 +486,7 @@ \subsection{Limitations}
486486

487487
\begin{thebibliography}{9}
488488
\bibitem{paper}
489-
Monika Jaskolka, Vera Pantelic, Mark Lawford, and Alan Wassyng, ``Supporting Modularity in \Simulink Models", \emph{Journal of Software and Systems Modeling} (Submitted May 2020).
489+
Monika Jaskolka, Vera Pantelic, Alan Wassyng, and Mark Lawford, ``Supporting Modularity in \Simulink Models", \emph{arXiv:2007.10120}.
490490
\end{thebibliography}
491491

492492
\end{document}

0 commit comments

Comments
 (0)