Skip to content

Commit

Permalink
Update User Guide
Browse files Browse the repository at this point in the history
Fix input paths for macros and logo. Add step to installation instructions to include Simulink-Utility submodule. Update old citation.
  • Loading branch information
monikajaskolka committed Sep 15, 2020
1 parent b287e7d commit 88bf28b
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 10 deletions.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

doc/tex/SimulinkModule_UserGuide.aux
doc/tex/SimulinkModule_UserGuide.log
doc/tex/SimulinkModule_UserGuide.out
doc/tex/SimulinkModule_UserGuide.synctex.gz
doc/tex/SimulinkModule_UserGuide.toc
Binary file modified doc/SimulinkModule_UserGuide.pdf
Binary file not shown.
20 changes: 10 additions & 10 deletions doc/tex/SimulinkModule_UserGuide.tex
Original file line number Diff line number Diff line change
Expand Up @@ -70,18 +70,17 @@
\maketitle
\vfill

%\begin{figure}
% \centering
% \includegraphics[]{../../common/McSCert_Logo.pdf} \\
% McMaster Centre for Software Certification (McSCert)
%\end{figure}
\begin{figure}
\centering
\includegraphics{../figs/McSCert_Logo.pdf} \\
McMaster Centre for Software Certification (McSCert)
\end{figure}

\newpage

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Table of Contents
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\tableofcontents
\newpage

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

\begin{enumerate}
\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.}
\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.}

\item To install the tool,
\item To install the tool,
\begin{enumerate}
\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.
\item from a \file{.mltbx} file --- simply open \Matlab and double-click on the file. Your \mpath should be automatically configured.
Expand All @@ -160,7 +159,8 @@ \subsection{Prerequisites and Installation}
\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.
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}.
\end{itemize}
\item Ensure your model is open and unlocked.
\item Ensure the Simulink-Utility folder is on your \mpath. This is a dependency for the tool to work correctly.
\item Ensure your model is open and unlocked.
\end{enumerate}

%---------------------------------------
Expand Down Expand Up @@ -486,7 +486,7 @@ \subsection{Limitations}

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

\end{document}

0 comments on commit 88bf28b

Please sign in to comment.