org.eclipse.rmf.documentation/rmf-latex/intro_conventions.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
%******************************************************************************/

% ===================================================================================
\section{Conventions}
% ===================================================================================

Throughout this book you'll see the following conventions:

% Formatted like remark
\begin{info}
This is where you'll find useful information or tips.
\end{info}

\begin{warning}
This will mark things to be aware of.
\end{warning}

\begin{example}
Examples will be marked as such.
\end{example}

When referring to \menu{menus} or \menu{user interface elements}, they are marked as shown here.

When we introduce a new \term{term} or want it to stand out, it will be marked like \term{this} in the text.  

\begin{definition}{Definition}
Often, you will also find a definition nearby, which is referenced in the index.
\end{definition}