New edits to reference section
Signed-off-by: Maha Jastram <maha@jastram.de>
diff --git a/org.eclipse.rmf.documentation/rmf-images/default_spec_view.png b/org.eclipse.rmf.documentation/rmf-images/default_spec_view.png
new file mode 100644
index 0000000..1c0b91f
--- /dev/null
+++ b/org.eclipse.rmf.documentation/rmf-images/default_spec_view.png
Binary files differ
diff --git a/org.eclipse.rmf.documentation/rmf-latex/main.lof b/org.eclipse.rmf.documentation/rmf-latex/main.lof
new file mode 100644
index 0000000..fe583d0
--- /dev/null
+++ b/org.eclipse.rmf.documentation/rmf-latex/main.lof
@@ -0,0 +1,30 @@
+\addvspace {10\p@ }
+\contentsline {figure}{\numberline {1.1}{\ignorespaces The RMF team during a Sprint in April 2012 in D\IeC {\"u}sseldorf, Germany (left to right) Lukas Ladenberger, Mark Br\IeC {\"o}rkens, Ingo Weigelt, Said Salem, Michael Jastram}}{7}{figure.1.1}
+\addvspace {10\p@ }
+\contentsline {figure}{\numberline {2.1}{\ignorespaces Specification example}}{10}{figure.2.1}
+\contentsline {figure}{\numberline {2.2}{\ignorespaces The ProR{} user interface}}{12}{figure.2.2}
+\contentsline {figure}{\numberline {2.3}{\ignorespaces Datatype Configuration Dialog}}{14}{figure.2.3}
+\contentsline {figure}{\numberline {2.4}{\ignorespaces Column Configuration}}{15}{figure.2.4}
+\contentsline {figure}{\numberline {2.5}{\ignorespaces Adding SpecObjects}}{16}{figure.2.5}
+\contentsline {figure}{\numberline {2.6}{\ignorespaces Drag and Drop}}{16}{figure.2.6}
+\contentsline {figure}{\numberline {2.7}{\ignorespaces Improved Specification}}{17}{figure.2.7}
+\contentsline {figure}{\numberline {2.8}{\ignorespaces Presentation Configuration Dialog Box}}{19}{figure.2.8}
+\contentsline {figure}{\numberline {2.9}{\ignorespaces Datatype Configuration Dialog}}{20}{figure.2.9}
+\contentsline {figure}{\numberline {2.10}{\ignorespaces ID Configuration Detail}}{21}{figure.2.10}
+\contentsline {figure}{\numberline {2.11}{\ignorespaces Datatype Configuration for the Headline Presentation}}{22}{figure.2.11}
+\contentsline {figure}{\numberline {2.12}{\ignorespaces Activated Headline Configuration}}{23}{figure.2.12}
+\contentsline {figure}{\numberline {2.13}{\ignorespaces Presentation Configuration for Headline}}{24}{figure.2.13}
+\contentsline {figure}{\numberline {2.14}{\ignorespaces Creating a New SpecType}}{25}{figure.2.14}
+\contentsline {figure}{\numberline {2.15}{\ignorespaces Showing Links in the GUI}}{26}{figure.2.15}
+\addvspace {10\p@ }
+\contentsline {figure}{\numberline {3.1}{\ignorespaces Views.}}{29}{figure.3.1}
+\contentsline {figure}{\numberline {3.2}{\ignorespaces The ProR{} user interface}}{30}{figure.3.2}
+\contentsline {figure}{\numberline {3.3}{\ignorespaces Click on a requirement and drag onto target parent.}}{34}{figure.3.3}
+\contentsline {figure}{\numberline {3.4}{\ignorespaces Result: The requirement is now a child of the chosen parent.}}{34}{figure.3.4}
+\contentsline {figure}{\numberline {3.5}{\ignorespaces Click on a requirement and drag onto target sibling.}}{35}{figure.3.5}
+\contentsline {figure}{\numberline {3.6}{\ignorespaces Result: The requirement is now a sibling of the chosen requirement.}}{35}{figure.3.6}
+\contentsline {figure}{\numberline {3.7}{\ignorespaces Datatype Configuration Dialog}}{38}{figure.3.7}
+\contentsline {figure}{\numberline {3.8}{\ignorespaces Enumerations}}{38}{figure.3.8}
+\addvspace {10\p@ }
+\addvspace {10\p@ }
+\addvspace {10\p@ }
diff --git a/org.eclipse.rmf.documentation/rmf-latex/reference.tex b/org.eclipse.rmf.documentation/rmf-latex/reference.tex
index 719eaf2..1399f2b 100644
--- a/org.eclipse.rmf.documentation/rmf-latex/reference.tex
+++ b/org.eclipse.rmf.documentation/rmf-latex/reference.tex
@@ -179,36 +179,46 @@
\subsection{Specification Editor}
% -----------------------------------------------------------------------------------
-In hierarchical order the requirements are layed out in a spreadsheet in a this window along with all their attributes.
+\begin{figure}[!h]
+ \centering
+ \includegraphics[width=\linewidth]{../rmf-images/default_spec_view.png}
+ \caption{Default spec window with the right-click menu}
+ \label{fig:default spec window}
+\end{figure}
+The requirements are layed out in a spreadsheet in a this window along with all their attributes in hierarchical order.
-The columns display the attributes that can be independantly created via the Column Configurater and associated with each requirement.
-\begin{figure}[h!]
+The columns, labeled across the top, display the attributes associated with each requirement. The attributes are created independantly via the Column Configurator. The default columns are ``Description'' and ``Link'.' ``Description`` Has two different symbols that appear on each row to the far left. Either a purple circle with an ''R`` denoting a SpecObject (requirement). It can also display a round, white cirlce denoting a Spec Hierarchy.
+
+Information can be entered either directly into the cell by double clicking it or by opening the properties window by right clicking any of the cells in the row. All of the SpecObjects information will then be available for editing in the properties window.
+
+The rows display the hierarchy. The order in which the requirements are displayed can be easily manipulated by cutting and pasting or by dragging and dropping. To move an existing requirement into the position of parent or child of another existing requirement, simply drag the child directly onto the target parent. Alternatively, as you drag the requirement onto the line below the level you would like to move it, it will become a sibling rather than a child of the requirement above the line.
+
+To duplicate a requirement, simply copy and paste it into the required position. The copying, cutting and pasting funktions are accessible through the traditional dropdown menu or by right-clicking on a desired cell.
+
+\begin{figure}[!h]
\centering
\includegraphics[width=\linewidth]{../rmf-images/hierarchy_step_1.png}
\caption{Click on a requirement and drag onto target parent.}
\label{fig:hierarchy_step_1}
\end{figure}
-\begin{figure}[h!]
+\begin{figure}[!h]
\centering
\includegraphics[width=\linewidth]{../rmf-images/hierarchy_step_2.png}
\caption{Result: The requirement is now a child of the chosen parent.}
\label{fig:hierarchy_step_2}
\end{figure}
-\begin{figure}[h!]
+\begin{figure}[!h]
\centering
\includegraphics[width=\linewidth]{../rmf-images/hierarchy_step_3.png}
- \caption{Click on a requirement and drag onto target sibling.}
+ \caption{Click on a requirement and drag onto the line (bolded) below or above target sibling.}
\label{fig:hierarchy_step_3}
\end{figure}
-\begin{figure}[h!]
+\begin{figure}[!h]
\centering
\includegraphics[width=\linewidth]{../rmf-images/hierarchy_step_4.png}
\caption{Result: The requirement is now a sibling of the chosen requirement.}
\label{fig:hierarchy_step_1}
\end{figure}
-The rows display the hierarchy. The order in which the requirements are displayed can be easily changed by cutting and pasting or by dragging and dropping onto the cell that shall be the parent. Alternatively, as you drag the requirement onto the line below the level you would like to move it, it will become a sibling rather than a child of the requirement above the line.
-
-To duplicate a requirement, simply copy and paste it into the required position. The copying, cutting and pasting funktions are accessible through the traditional dropdown menu or by right-clicking on a desired cell.
By right clicking on any cell in the window, you have a few options at your disposal. Outside of the usual ``Undo,'' ``Cut,'' ``Copy,'' ``Paste'' and ``Delete,'' commands, the following are also available:
@@ -217,20 +227,24 @@
\item
[New Child] - A new requirement can be created as a child of right-clicked requirement.
\item
- [New Sibling] - A new Sibling can be created on the same lever as the r ight-clicked requirement.
+ [New Sibling] - A new Sibling can be created on the same lever as the right-clicked requirement.
\item
- [Initiate Linking] - This is the option to create a link between requirements. Once a link is initiated and then by right clicking a target selection, the options to complete the links either to or from a selection will appear.
+ [Initiate Linking] - This is the option to create a link between requirements. Once a link is initiated and then by right clicking a target selection, the options to complete the links either to or from a selection will appear. By default, the links are illustrated in the ``Link'' column to the right.
\item
[Show Properties View] - Opens the Properties window below (be default) where one can individually inspect and edit each requirment.
\end{description}
-
% ===================================================================================
\section{Views}
% ===================================================================================
By default, ProR's Workbench displays the following three views:
+\begin{itemize}
+\item Project Explorer View: Appears on the left side and displays and allows control of the project and all it's related files.
+\item Properties View: Appears at the bottom. Displays and allows the editing of highlighted objects such as projects, files, requirements, etc.
+\item Outline View: Displays the structure and contents of the specifications document.
+\end{itemize}
% -----------------------------------------------------------------------------------
\subsection{Project Explorer View}\index{Project Explorer View}
