Adding Index generation
diff --git a/org.eclipse.rmf.documentation/rmf-latex/.gitignore b/org.eclipse.rmf.documentation/rmf-latex/.gitignore index db5a5a0..62a651a 100644 --- a/org.eclipse.rmf.documentation/rmf-latex/.gitignore +++ b/org.eclipse.rmf.documentation/rmf-latex/.gitignore
@@ -4,3 +4,8 @@ *.pdf *.backup *.toc +*.dvi +*.idx +*.ilg +*.ind +
diff --git a/org.eclipse.rmf.documentation/rmf-latex/glossary.tex b/org.eclipse.rmf.documentation/rmf-latex/glossary.tex index 33a7393..c68fbf5 100644 --- a/org.eclipse.rmf.documentation/rmf-latex/glossary.tex +++ b/org.eclipse.rmf.documentation/rmf-latex/glossary.tex
@@ -20,7 +20,9 @@ The \href{RMF/ProR}{ProR} GUI does support ReqIF. +% ----------------------------------------------------------------------------------- \subsection{History} +% ----------------------------------------------------------------------------------- For technical and organizational reasons, two companies in the manufacturing industry are rarely able to work on the same requirements repository and sometimes do not work with the same requirements authoring tools. A generic, non-proprietary format for requirements information is required to cross the chasm and to satisfy the urgent industry need for exchanging requirement information between different companies without losing the advantage of requirements management at the organizations' borders. @@ -30,13 +32,17 @@ The ReqIF team expects that making the Requirements Interchange Format an OMG standard increases the number of interoperable exchange tool implementations on the market, fosters the trust of companies exchanging requirement information in the exchange format and provides safety of investments to tool vendors. +% ----------------------------------------------------------------------------------- \subsection{Previous Versions of ReqIF} +% ----------------------------------------------------------------------------------- This document is submitted as RFC of the Requirements Interchange Format (ReqIF) to the OMG. Before the submission, the Requirements Interchange Format has been a specification proposed by the HIS and in its latest version, a recommendation of ProSTEP iViP. For these versions, the abbreviation ``RIF'' has been applied. The HIS released the Requirements Interchange Format as RIF 1.0, RIF1.0a, RIF 1.1; RIF1.1a and the ProSTEP iViP released the recommendation RIF 1.2. As the acronym RIF has an ambiguous meaning within the OMG, the acronym ReqIF has been introduced to separate it from the W3C`s Rule Interchange Format. ReqIF 1.0 is the direct successor of the ProSTEP iViP recommendation RIF 1.2. +% ----------------------------------------------------------------------------------- \section{RIF} +% ----------------------------------------------------------------------------------- RIF stands for Requirements Interchange Format. It is an exchange format for requirements and a data model. RIF is the predecessor of \href{RMF/ReqIF}{ReqIF}. @@ -49,9 +55,13 @@ The ProR GUI does currently not support RIF. +% =================================================================================== \section{Eclipse} +% =================================================================================== +% ----------------------------------------------------------------------------------- \subsection{Committer License Agreement (CLA)}\index{Committer License Agreement} +% ----------------------------------------------------------------------------------- The Committer License Agreement (CLA) needs to be signed by contributors to Eclipse projects. It essentially states that you hold all rights to your contribution and that you allow Eclipse to use them under the Eclipse Public License.
diff --git a/org.eclipse.rmf.documentation/rmf-latex/intro_contributing.tex b/org.eclipse.rmf.documentation/rmf-latex/intro_contributing.tex deleted file mode 100644 index 9fa3c8e..0000000 --- a/org.eclipse.rmf.documentation/rmf-latex/intro_contributing.tex +++ /dev/null
@@ -1,25 +0,0 @@ -%******************************************************************************* -% 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{Contributing} -% =================================================================================== - -Documentation is one of those things that gets easily neglected in open source projects. It is also one of the easiest for outsiders to contribute to. The documentation is managed as \LaTeX, which may scare some people. But no worries, those who don't want to learn \LaTeX don't have to. - -There are broadly two ways for contributing to the documentation: - -\begin{description} - \item[File a bug.] Visit the \href{https://bugs.eclipse.org/bugs/enter_bug.cgi?assigned_to=&blocked=&bug_severity=normal&bug_status=NEW&comment=&contenttypeentry=&contenttypemethod=autodetect&data=&dependson=&description=&flag_type-1=X&flag_type-11=X&flag_type-12=X&flag_type-2=X&flag_type-4=X&flag_type-6=X&flag_type-7=X&flag_type-8=X&form_name=enter_bug&keywords=&&op_sys=All&product=MDT.RMF&qa_contact=&rep_platform=All&short_desc=&version=unspecified}{RMF Bug Tracker}. You can just point out a problem or request for improvement. You can also provide some text to be added to the documentation (unformatted). If you do, however, then you need to sign a Committer License Agreement (CLA) - \item[Submit improved \LaTeX via Gerrit.] If you are technically inclined (meaning that you know what \LaTeX and git are, and how to use them), then you can contribute via the Gerrit code review system, as described \href{https://wiki.eclipse.org/Gerrit}{at eclipse.org}. -\end{description} -
diff --git a/org.eclipse.rmf.documentation/rmf-latex/intro_conventions.tex b/org.eclipse.rmf.documentation/rmf-latex/intro_conventions.tex index 2aab497..24f5bac 100644 --- a/org.eclipse.rmf.documentation/rmf-latex/intro_conventions.tex +++ b/org.eclipse.rmf.documentation/rmf-latex/intro_conventions.tex
@@ -31,6 +31,5 @@ Examples will be marked as such. \end{example} - When referring to \menu{menus} or \menu{user interface elements}, they are marked as shown here.
diff --git a/org.eclipse.rmf.documentation/rmf-latex/main.tex b/org.eclipse.rmf.documentation/rmf-latex/main.tex index 2142e35..7c301eb 100644 --- a/org.eclipse.rmf.documentation/rmf-latex/main.tex +++ b/org.eclipse.rmf.documentation/rmf-latex/main.tex
@@ -18,6 +18,7 @@ \usepackage[utf8]{inputenc} \usepackage{soul} \usepackage{wrapfig} +\usepackage{makeidx} %---------------------------------------------------------------------------------------- % MACROS %---------------------------------------------------------------------------------------- @@ -49,6 +50,7 @@ \title{Eclipse ProR User Guide} \author{by the RMF Community} +\makeindex %---------------------------------------------------------------------------------------- % START DOCUMENT @@ -60,26 +62,51 @@ \tableofcontents +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \chapter{Introduction} \input{intro_conventions} -\input{intro_contributing} + +\section{Improve this Document} +Documentation is one of those things that gets easily neglected in open source projects. +It is also one of the easiest for outsiders to contribute to. Please refer to +Chapter~\ref{sec:styleguide} if you would like to help improving this user guide. + \input{intro_acknowledgements} \input{intro_license} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \chapter{Tutorial} \input{tutorial} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \chapter{Reference} \input{reference} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \chapter{Presentations} \input{presentations} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \chapter{Glossary} \input{glossary} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \chapter{Style Guide} +\label{sec:styleguide} \input{style_guide} +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +\clearpage +\phantomsection +\addcontentsline{toc}{chapter}{Index} +\printindex +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \end{document}
diff --git a/org.eclipse.rmf.documentation/rmf-latex/reference.tex b/org.eclipse.rmf.documentation/rmf-latex/reference.tex index 4ed1104..bff3e06 100644 --- a/org.eclipse.rmf.documentation/rmf-latex/reference.tex +++ b/org.eclipse.rmf.documentation/rmf-latex/reference.tex
@@ -83,11 +83,17 @@ By default, ProR's Workbench displays the following three views: +% ----------------------------------------------------------------------------------- \subsection{Project Explorer View}\index{Project Explorer View} +% ----------------------------------------------------------------------------------- +% ----------------------------------------------------------------------------------- \subsection{Properties View}\index{Properties View} +% ----------------------------------------------------------------------------------- +% ----------------------------------------------------------------------------------- \subsection{Outline View}\index{Outline View} +% ----------------------------------------------------------------------------------- % =================================================================================== \section{Configurations} @@ -97,9 +103,15 @@ The ProR menu contains entries to launch a number of configuration dialogs. -\subsection{General Configuration}\index{Configuration!General} +% ----------------------------------------------------------------------------------- +\subsection{General Configuration} +\index{Configuration!General} +% ----------------------------------------------------------------------------------- -\subsection{Datatype Configuration}\index{Configuration!Datatype} +% ----------------------------------------------------------------------------------- +\subsection{Datatype Configuration} +\index{Configuration!Datatype} +% ----------------------------------------------------------------------------------- This configuration is opened via ProR \textbar{} Datatype Configuration ... @@ -151,9 +163,13 @@ \label{fig:Enumerations} \end{figure} +% ----------------------------------------------------------------------------------- \subsection{Presentation Configuration}\index{Configuration!Presentation} +% ----------------------------------------------------------------------------------- +% ----------------------------------------------------------------------------------- \subsection{Column Configuration}\index{Configuration!Column} +% ----------------------------------------------------------------------------------- This configuration is specific to the Specification Editor.
diff --git a/org.eclipse.rmf.documentation/rmf-latex/style_guide.tex b/org.eclipse.rmf.documentation/rmf-latex/style_guide.tex index bd89678..552a1f9 100644 --- a/org.eclipse.rmf.documentation/rmf-latex/style_guide.tex +++ b/org.eclipse.rmf.documentation/rmf-latex/style_guide.tex
@@ -15,7 +15,7 @@ The documentation was created with and is maintained with \LaTeX. That stands to reason that much of the formatting is software-dependent, leaving us to worry about more important things. But that still leaves some decisions for us to make. For example, alphabetization, certain punctuation, spelling and hyphenation of certain words, and the like will be accounted for here. % =================================================================================== -\section{alphabetization} +\section{Alphabetization} % =================================================================================== What should and should not be alphabetized: @@ -62,25 +62,4 @@ TODO - when done, update the parent section as well. -% =================================================================================== -\section{Licensed as EPL} -% =================================================================================== -This work is licensed under the Eclipse Public License. - -% =================================================================================== -\section{Acknowledgements} -% =================================================================================== - -Many parties were involved in the creation of RMF. We would like to thank the core team that made it possible. - -\begin{figure}[H] - \centering - \includegraphics[width=\textwidth]{../rmf-images/2012_03_sprint_team.jpg} - \caption{The RMF team during a Sprint in April 2012 in Düsseldorf, Germany - (left to right) Lukas Ladenberger, Mark Brörkens, Ingo Weigelt, Said Salem, Michael Jastram} - \label{fig:intro_core_team} -\end{figure} - - -The roots of this project were created by Andreas Graf, Michael Jastram and Nirmal Sasidharan, who joined together individual projects to create RMF. Their efforts were financed by the research projects itea Verde and FP7 Deploy. RMF was assembled at the Eclipse Foundation, where it has been active ever since. Figure~\ref{fig:intro_core_team} shows four of the five RMF Committers at a joint coding session (missing is Andreas Graf).
diff --git a/org.eclipse.rmf.documentation/rmf-latex/tutorial.tex b/org.eclipse.rmf.documentation/rmf-latex/tutorial.tex index 336e6eb..e79723c 100644 --- a/org.eclipse.rmf.documentation/rmf-latex/tutorial.tex +++ b/org.eclipse.rmf.documentation/rmf-latex/tutorial.tex
@@ -69,11 +69,15 @@ In this Section, we will build a ReqIF model from scratch, step by step. +% ----------------------------------------------------------------------------------- \subsection{Install \pror{}} +% ----------------------------------------------------------------------------------- You can download \pror{} from the \href{https://www.eclipse.org/rmf/download.php}{Download page}. Alternatively, you can install \pror{} in any Eclipse-Installation via its update site (also listed on the \href{https://www.eclipse.org/rmf/download.php}{Download page}). Using the update site allows you to use the Eclipse Update mechanism, something that is currently not yet enabled for the standalone version. +% ----------------------------------------------------------------------------------- \subsection{Create the Model} +% ----------------------------------------------------------------------------------- \begin{itemize} @@ -121,7 +125,9 @@ Above the main working windows it the tool bar (5) and, at the very top, the menu bar (6). +% ----------------------------------------------------------------------------------- \subsection{Customizing the SpecType} +% ----------------------------------------------------------------------------------- To get familiar with the system, we will: @@ -150,7 +156,9 @@ Upon closing the dialog, little will have changed - the Specification still shows just two columns, Description and Link. However, if you select the requirement, you will see the new Properties (ID and Owner) in the Property view. +% ----------------------------------------------------------------------------------- \subsection{Showing the new Attributes in the Specification} +% ----------------------------------------------------------------------------------- To show the new Attributes in the Specification, we have to configure the Specification columns. We do this by selecting \pror{} \textgreater{} Column Configuration. You can also click on the spreadsheet icon in the Tool Bar. @@ -171,7 +179,9 @@ You can actually adjust the width of the columns simply by dragging the column headers. +% ----------------------------------------------------------------------------------- \subsection{Adding new SpecObjects} +% ----------------------------------------------------------------------------------- Now we can finally add SpecObjects by right-clicking on a row in the Specification. In the context-menu, there are two submenus: "New Child" and "New Sibling". "New Child" is the only way to produce a hierarchical structure. @@ -209,11 +219,15 @@ \label{fig:improvedSpec} \end{figure} +% ----------------------------------------------------------------------------------- \subsection{Export Specification as HTML} +% ----------------------------------------------------------------------------------- If you want to export your Specification as HTML, go to File \textgreater{} Export as HTML. The HTML representation is generated and saved into your target folder. +% ----------------------------------------------------------------------------------- \subsection{Conclusion} +% ----------------------------------------------------------------------------------- Quite an achievement—but there's still a bit of a way to go. One improvement we can make is simplifying data entry. Another is improving the visibility of the descriptions. In the next part of the tutorial, we will address these issues. @@ -236,7 +250,9 @@ \pror{} comes with a number of standard presentations that we will introduce in this tutorial. +% ----------------------------------------------------------------------------------- \subsection{Linewrap Presentation} +% ----------------------------------------------------------------------------------- By default, text is not wrapped in cells. We will enable the Linewrap Presentation for the Description column. @@ -255,7 +271,9 @@ Upon closing the dialog, the lines that are too long should be wrapped automatically. Also, upon clicking on a cell, the content is now wrapped in the editor. +% ----------------------------------------------------------------------------------- \subsection{ID Presentation} +% ----------------------------------------------------------------------------------- It would be nice if every SpecObject had its own unique ID. Actually, it does (it is shown in the Property View, if a SpecObject is selected in the Outline View). But that ID is meant for machines and is not practical. @@ -292,7 +310,9 @@ So far, we have a model with only one SpecObjectType. In this tutorial, we will show how we can work with multiple SpecTypes, and we will introduce other SpecTypes. +% ----------------------------------------------------------------------------------- \subsection{Multiple SpecTypes} +% ----------------------------------------------------------------------------------- The first entry in our Specification ("A \pror{} Tutorial") isn't really a requirement. Thus, it doesn't need an ID or an owner, and it would be nice to Highlight it somehow. For Highlighting, we have the Headline Presentation. We will: @@ -356,7 +376,9 @@ \label{fig:headlineConfig2} \end{figure} +% ----------------------------------------------------------------------------------- \subsection{Other SpecTypes} +% ----------------------------------------------------------------------------------- You may have noticed in the Datatype Configuration Dialog, that right-clicking on "SpecTypes" offered more options, besides "SpecObject Type". A number of ReqIF-Elements can have Attributes. @@ -381,7 +403,9 @@ The implementation of SpecRelations is not complete yet. Still here are a few pointers to show what is planned. +% ----------------------------------------------------------------------------------- \subsection{Creating SpecRelations} +% ----------------------------------------------------------------------------------- SpecRelations are created by "Link-Dragging". This is platform specific: @@ -430,7 +454,9 @@ The link from REQ-1 has a description, and it shows the destination name in the "Link" column \end{itemize} +% ----------------------------------------------------------------------------------- \subsection{Outline View} +% ----------------------------------------------------------------------------------- Note that the Outline shows a folder with all SpecRelations.