Improving General Configuration Section
diff --git a/org.eclipse.rmf.documentation/rmf-images/ReqIFUIToolExtension.png b/org.eclipse.rmf.documentation/rmf-images/ReqIFUIToolExtension.png new file mode 100644 index 0000000..35b7b18 --- /dev/null +++ b/org.eclipse.rmf.documentation/rmf-images/ReqIFUIToolExtension.png Binary files differ
diff --git a/org.eclipse.rmf.documentation/rmf-latex/presentations.tex b/org.eclipse.rmf.documentation/rmf-latex/presentations.tex index ab74c71..4cc22f9 100644 --- a/org.eclipse.rmf.documentation/rmf-latex/presentations.tex +++ b/org.eclipse.rmf.documentation/rmf-latex/presentations.tex
@@ -17,7 +17,7 @@ % =================================================================================== \section{ID Generator Presentation} \index{Presentation!ID Generator} - +\label{sec:id_presentation} % =================================================================================== This presentation allows the designation of Attributes to be used as @@ -32,6 +32,7 @@ % =================================================================================== \section{Linewrap Presentation} \index{Presentation!Linewrap} +\label{sec:linewrap_presentation} % =================================================================================== This presentation automatically renders long text with linebreaks and @@ -40,6 +41,7 @@ % =================================================================================== \section{Headline Presentation} \index{Presentation!Headline} +\label{sec:headline_presentation} % =================================================================================== This presentation renders an attribute in bigger font and bold. It
diff --git a/org.eclipse.rmf.documentation/rmf-latex/reference.tex b/org.eclipse.rmf.documentation/rmf-latex/reference.tex index 1750eb7..6897e8d 100644 --- a/org.eclipse.rmf.documentation/rmf-latex/reference.tex +++ b/org.eclipse.rmf.documentation/rmf-latex/reference.tex
@@ -108,11 +108,43 @@ % ----------------------------------------------------------------------------------- \subsection{General Configuration} \index{Configuration!General} +\label{sec:general_configuration} % ----------------------------------------------------------------------------------- +This configuration is accessed either via \menu{ProR | General Configuration}, or +via the \includegraphics[height=0.8em]{../rmf-images/ReqIFUIToolExtension.png} button on the toolbar. + +Currently, there is only one configuration element: \menu{Label Configuration}. + +\subsubsection{Label Configuration} + +The ``Label Configuration'' is used to determine what to use for the text labels of elements +in places, where a shorthand is needed. Examples are elements in the Outline or link targets. + +\pror{} will determine the label by looking at the label configuration, which is a list of Strings. +It will go through the list, top to bottom. If the element has an attribute with a matching name, +that attribute value is used as the label. + +If none is found, then the element's internal ID is displayed. + +To configure, select \menu{Label Configuration} in the top pane of the dialog. On the bottom pane, +you see the \menu{Default Label} property. Doubleclick the value (on the right), then click on the +ellipses (...) to open the configuration dialog. Under \menu{Feature}, you see the list of attribute +names that will be used for the label, if found. + +Use the \menu{Add} and \menu{Remove} buttons to add more attribute names to be searched for. The +search order can be adjusted with \menu{Up} and \menu{Down}. + +\begin{info} +It is good practice to use the ID Presentation (\ref{sec:id_presentation}) to generate +user-friendly IDs, and to use these as the first match for a label. As IDs are unique, you'll always +have a unique identifier that is typically also used for communication. +\end{info} + % ----------------------------------------------------------------------------------- \subsection{Datatype Configuration} \index{Configuration!Datatype} +\label{sec:datatype_configuration} % ----------------------------------------------------------------------------------- This configuration is opened via ProR \textbar{} Datatype Configuration @@ -167,10 +199,12 @@ % ----------------------------------------------------------------------------------- \subsection{Presentation Configuration}\index{Configuration!Presentation} +\label{sec:presentation_configuration} % ----------------------------------------------------------------------------------- % ----------------------------------------------------------------------------------- \subsection{Column Configuration}\index{Configuration!Column} +\label{sec:column_configuration} % ----------------------------------------------------------------------------------- This configuration is specific to the Specification Editor.