Improvement in Documentation
diff --git a/org.eclipse.rmf.documentation/rmf-latex/reference-part1.tex b/org.eclipse.rmf.documentation/rmf-latex/reference-part1.tex index 86bba7b..c4266b5 100644 --- a/org.eclipse.rmf.documentation/rmf-latex/reference-part1.tex +++ b/org.eclipse.rmf.documentation/rmf-latex/reference-part1.tex
@@ -183,13 +183,6 @@ A model contains any number of Specifications, and the details of each Specification can be inspected individually. The windows in which all relevant information appears are called \term{views}. At your disposal are many views with productivity, debugging, help and team resources. We will be focusing only on the views relevant to \pror{}. -\begin{figure} -\centering -\includegraphics[width=.7\textwidth]{../rmf-images/reqif-editor.png} -\caption{ReqIF Editor} -\label{fig:reqif-editor} -\end{figure} - % ----------------------------------------------------------------------------------- \subsection{ReqIF Editor} \label{sec:reqif-editor} @@ -199,6 +192,13 @@ The \menu{ReqIF Editor} is the first editor that opens when opening a ReqIF file. It is shown in Figure~\ref{fig:reqif-editor}. +\begin{figure} +\centering +\includegraphics[width=.7\textwidth]{../rmf-images/reqif-editor.png} +\caption{ReqIF Editor} +\label{fig:reqif-editor} +\end{figure} + The \menu{ReqIF Editor} lists all Specifications, which can be opened by double-clicking. \begin{info} @@ -208,17 +208,10 @@ Further, there are a few sections that are collapsed by default: \begin{description} -\item[RMF - Getting Started.] This section contains some basic information for new users. +\item[RMF -- Getting Started.] This section contains some basic information for new users. \item[Document Properties.] This section show the embedded metadata. Some of it can be edited, some elements are read-only, as they are set by the tool. \end{description} -\begin{figure} -\centering -\includegraphics[width=.7\textwidth]{../rmf-images/error-editor.png} -\caption{ReqIF Editor With an active error tab} -\label{fig:error-editor} -\end{figure} - % ----------------------------------------------------------------------------------- \subsection{Errors in ReqIF Editor} \label{sec:errors-reqif-editor} @@ -228,6 +221,13 @@ If a ReqIF file is invalid, then \pror{} makes an attempt to recover. If this succeeds, then the \menu{ReqIF Editor} will show two tabs, as shown in Figure~\ref{fig:error-editor}. +\begin{figure} +\centering +\includegraphics[width=.7\textwidth]{../rmf-images/error-editor.png} +\caption{ReqIF Editor with an active error tab} +\label{fig:error-editor} +\end{figure} + On the bottom, the editor now has two tabs, labeled \menu{Selection} and \menu{Problems}. The \menu{Problems} tab has three options: \begin{description}
diff --git a/org.eclipse.rmf.documentation/rmf-latex/tutorial.tex b/org.eclipse.rmf.documentation/rmf-latex/tutorial.tex index 389124a..c1934e6 100644 --- a/org.eclipse.rmf.documentation/rmf-latex/tutorial.tex +++ b/org.eclipse.rmf.documentation/rmf-latex/tutorial.tex
@@ -95,9 +95,9 @@ \subsection{Customizing the SpecType} \label{sec:customize-spec-type} \index{SpecType configuration} -\index{Datatype configuration} +\index{datatype configuration} \index{configuration!SpecType} -\index{configuration!Datatype} +\index{configuration!datatype} % ----------------------------------------------------------------------------------- To get familiar with the tool, we will: