org.eclipse.rmf.documentation/rmf-latex/presentations.tex

%*******************************************************************************
% Copyright (c) 2014 Formal Mind GmbH and others
% All rights reserved. This program and the accompanying materials
% are made available under the terms of the Eclipse Public License v1.0
% which accompanies this distribution, and is available at
% http://www.eclipse.org/legal/epl-v10.html
% 
% Contributors:
%     Michael Jastram - initial Copy
%     Maha Jastram - susequent improvements
%******************************************************************************/

ProR has an extension mechanism that allows custom rendering for certain
attributes of a SpecObject. The following Presentations have been
implemented:

% ===================================================================================
\section{ID Generator Presentation}
\index{Presentation!ID Generator}
\label{sec:id_presentation}
% ===================================================================================

This presentation allows the designation of Attributes to be used as
human-readable IDs. The user defines a prefix, and the presentation
manages a counter. When a new SpecObject with a designated Attribute is
created, then it will get an ID, consisting of prefix and number.

TODO: The plugin doesn't check whether an ID already exists - it simply
takes the next number and increments the counter. We should (1) Set the
counter correctly upon opening a ReqIF and (2) hook in a Validator.

% ===================================================================================
\section{Linewrap Presentation}
\index{Presentation!Linewrap}
\label{sec:linewrap_presentation}
% ===================================================================================

This presentation automatically renders long text with linebreaks and
allows editing with linebreaks.

% ===================================================================================
\section{Headline Presentation}
\index{Presentation!Headline}
\label{sec:headline_presentation}
% ===================================================================================

This presentation renders an attribute in bigger font and bold. It
allows setting the font size.