updated documentation
diff --git a/org.eclipse.capra.documentation/docu/capraDocumentation-toc.xml b/org.eclipse.capra.documentation/docu/capraDocumentation-toc.xml
index 183c9e3..d7a0e43 100644
--- a/org.eclipse.capra.documentation/docu/capraDocumentation-toc.xml
+++ b/org.eclipse.capra.documentation/docu/capraDocumentation-toc.xml
@@ -1,13 +1,13 @@
<?xml version='1.0' encoding='utf-8' ?>
-<toc label="Capra Documentation" link_to="capraDocumentation" topic="docu/capraDocumentation.html">
+<toc topic="docu/capraDocumentation.html" label="capraDocumentation">
<topic href="docu/capraDocumentation.html" label="Capra Help Contents">
<topic href="docu/capraDocumentation.html#user-guide" label="User Guide">
- <topic href="docu/capraDocumentation.html#introduction-what-is-capra" label="Introduction - What is Capra?"></topic>
+ <topic href="docu/capraDocumentation.html#introduction-what-is-capra" label="Introduction -- What is Capra?"></topic>
<topic href="docu/capraDocumentation.html#getting-started" label="Getting Started">
<topic href="docu/capraDocumentation.html#prerequisites" label="Prerequisites"></topic>
<topic href="docu/capraDocumentation.html#installing-capra" label="Installing Capra">
- <topic href="docu/capraDocumentation.html#installing-through-an-update-site" label="Installing through an update site"></topic>
- <topic href="docu/capraDocumentation.html#manual-installation-import-from-git" label="Manual installation (Import from Git)"></topic>
+ <topic href="docu/capraDocumentation.html#installing-through-an-update-site" label="Installing Capra through an update site"></topic>
+ <topic href="docu/capraDocumentation.html#manual-installation-import-from-git" label="Installing Capra manually with Git"></topic>
</topic>
</topic>
<topic href="docu/capraDocumentation.html#traceability-concepts" label="Traceability Concepts">
@@ -52,6 +52,6 @@
<topic href="docu/capraDocumentation.html#taking-care-of-multiple-handlers-for-the-same-artifact-type" label="Taking care of multiple handlers for the same artifact type"></topic>
<topic href="docu/capraDocumentation.html#adding-new-source-files" label="Adding new source files"></topic>
</topic>
- <topic href="docu/capraDocumentation.html#rerefences" label="Rerefences"></topic>
+ <topic href="docu/capraDocumentation.html#references" label="Rerefences"></topic>
</topic>
-</toc>
+</toc>
\ No newline at end of file
diff --git a/org.eclipse.capra.documentation/docu/capraDocumentation.html b/org.eclipse.capra.documentation/docu/capraDocumentation.html
index 8879a0e..346e514 100644
--- a/org.eclipse.capra.documentation/docu/capraDocumentation.html
+++ b/org.eclipse.capra.documentation/docu/capraDocumentation.html
@@ -6,8 +6,8 @@
<body>
<h1 id="capra-help-contents">Capra Help Contents</h1>
<h2 id="user-guide">User Guide</h2>
- <h3 id="introduction-what-is-capra">Introduction – What is Capra?</h3>
- <p>Capra is a dedicated traceability management tool that allows the creation, management, visualization, and analysis of traceability links within Eclipse. traceability links can be created between arbitrary artifacts, including all EMF model elements, all types of source code files supported by the Eclipse Platform through specialized development tools, tickets and bugs managed by Eclipse Mylyn, and all other artifacts for which an appropriate wrapper is provided. Capra is highly configurable and allows users (in a company or project) to define link types that are useful to them. </p>
+ <h3 id="introduction-what-is-capra">Introduction — What is Capra?</h3>
+ <p>Capra is a dedicated traceability management tool that allows the creation, management, visualization, and analysis of traceability links within Eclipse. Traceability links can be created between arbitrary artifacts, including all EMF model elements, all types of source code files supported by the Eclipse Platform through specialized development tools, tickets and bugs managed by Eclipse Mylyn, and all other artifacts for which an appropriate wrapper is provided. Capra is highly configurable and allows users (in a company or project) to define link types that are useful to them. </p>
<p>Compared to other similar projects which may have similar features, Capra is not a modeling tool or a tool for requirements management. All functionality is focused on providing traceability capabilities, i.e., the ability to create and visualize links between artifacts modeled in different domain-specific languages. This allows the architecture to be highly modular and the tool to be extremely customizable.</p>
<h3 id="getting-started">Getting Started</h3>
<p>This section describes the prerequisites to run Capra and how to install the tool.</p>
@@ -39,23 +39,23 @@
</li>
</ul>
<h4 id="installing-capra">Installing Capra</h4>
- <p>Capra can be installed either through an update site or manually .</p>
- <h5 id="installing-through-an-update-site">Installing through an update site</h5>
+ <p>Capra can be installed either through an update site or manually.</p>
+ <h5 id="installing-through-an-update-site">Installing Capra through an update site</h5>
<ul>
<li>Go to the
- <a href="https://github.com/Salome-Maro/TraceabilityManagement">Capra GitHub repository</a>.
+ <a href="https://github.com/Salome-Maro/TraceabilityManagement">Capra Github repository</a>.
</li>
<li>Click on “Releases” (Please note that the current release is a Pre-release and the official release will be available once the tool is an Eclipse project)</li>
<li>Download the file
<code>Capra_v.0.1.zip</code> (Note the location of your download)
</li>
<li>Open your Eclipse environment</li>
- <li>Make sure that you have all the dependencied listed above installed</li>
- <li>Click on Help >> Install New Softaware</li>
+ <li>Make sure that you have all the dependencies listed above installed</li>
+ <li>Click on Help >> Install New Software</li>
<li>Click on Add and select Archive</li>
<li>Select your zip file and click Add</li>
<li>You should see the features that Capra has grouped into several categories as shown in Figure 1.</li>
- <li>To get a minimum version of Capra working, install all the features in Core and at least one artifact wrapper. This means that if you for instance install only the EMFHandler, then you will only be able to create traceability links between EMF models. It is recommended to install all available artifact handlers.</li>
+ <li>To get a minimum version of Capra working, install all the features in Core and at least one artifact wrapper. This means that if you for instance install only the EMFHandler, then you will only be able to create traceability links between model elements contained in EMF models. It is recommended to install all available artifact handlers.</li>
<li>Install the features in the visualization and notification categories in order to get their functionality working. </li>
<li>Restart Eclipse</li>
<li>Go to perspectives and switch to the Capra perspective</li>
@@ -64,12 +64,12 @@
</li>
</ul>
<p><figure><img src="../images/updatesite.png" width="600"/><figcaption>Figure 1: Installing Capra from the Updatesite</figcaption></figure></p>
- <h5 id="manual-installation-import-from-git">Manual installation (Import from Git)</h5>
+ <h5 id="manual-installation-import-from-git">Installing Capra manually with Git</h5>
<ul>
<li>Open your Eclipse Environment</li>
<li>Go to File >> Import and select Git >> Projects from Git</li>
<li>Use the
- <a href="https://github.com/Salome-Maro/TraceabilityManagement">GitHub repository</a> and import all available projects to your workspace
+ <a href="https://git.eclipse.org/r/capra/org.eclipse.capra">Git repository</a> and import all available projects to your workspace
</li>
<li>Build your workspace</li>
<li>Make sure that all the projects have no errors.</li>
@@ -100,12 +100,12 @@
<h4 id="what-is-an-artifact">What is an artifact?</h4>
<p>Artifacts, and in particular software development artifacts refer to the resources that are either created or used as an input by a software development activity. For instance, the requirements elicitation activity produces artifacts known as requirements. Artifacts can be of different types, such as a requirement, a model element, a line of code, or a test case.</p>
<h4 id="what-is-an-artifact-handler">What is an artifact handler?</h4>
- <p>As previously mentioned, there are different types of artifacts that can exist in a software development environment. However, Capra stores the traceability links in form of an EMF model. This means that, basically only EMF artifact types can be supported. To support other artifact types, there is a need to create EMF representations of the artifacts. This is what an artifact handler does. It creates an EMF representation of non-EMF artifacts. The representations are known as “artifact wrappers”. For example to be able to link to Java Code, an artifact handler for Java needs to be created. For details on how to add new artifact handlers to the tool, refer to section
+ <p>As previously mentioned, there are different types of artifacts that can exist in a software development environment. However, Capra stores the traceability links in form of an EMF model. This means that, in principle, only EMF artifact types can be supported. To support other artifact types, there is a need to create EMF representations of the artifacts. This is what an artifact handler does. It creates an EMF representation of non-EMF artifacts. The representations are known as “artifact wrappers”. For example to be able to link to Java Code, an artifact handler for Java needs to be created. For details on how to add new artifact handlers to the tool, refer to
<a href="#adding-a-new-artifact-handler">Adding a new artifact handler</a>.
</p>
<h3 id="practical-examples">Practical Examples</h3>
- <p>To demonstrate features of Capra, we take an example of the development of a Heating, Ventilation and Air Conditioning (HVAC) System. The resources can be dowloaded through this
- <a href="https://www.dropbox.com/s/h6vzmca7sjpq83q/HVAC%20Projects.zip?dl=0">link</a>. The project contains the following artifacts:
+ <p>To demonstrate features of Capra, we take an example of the development of a Heating, Ventilation and Air Conditioning (HVAC) System. The resources can be dowloaded
+ <a href="https://www.dropbox.com/s/h6vzmca7sjpq83q/HVAC%20Projects.zip?dl=0">here</a>. The project contains the following artifacts:
</p>
<ul>
<li>A set of requirements which are written in
@@ -123,7 +123,7 @@
<p><figure><img src="../images/hvacProjects.png" width="800"/><figcaption>Figure 2: Resources for the HVAC system</figcaption></figure></p>
<h4 id="creating-traceability-links">Creating Traceability Links</h4>
<p>Capra provides the functionality to create traceability links between different artifacts as long as artifact handlers for those artifact types are available. The current version supports tracing to EMF models, Java code (up to method level), C/C++ code (up to function level), Task tickets from ticketing systems supported by Mylyn, arbitrary files (such as PDF or word), Test executions (Hudson and Jenkins), Papyrus models, and Capella models. </p>
- <p>To show how traceability links can be created, we continue with the HVAC example and its artifacts as described above. Our aim is to establish the following links. </p>
+ <p>To show how traceability links can be created, we continue with the HVAC example and its artifacts as described above. Our aim is to establish the following links:</p>
<ol>
<li>A link from a requirement to a feature representing the requirement in the feature model</li>
<li>A link from a feature to the state machine that describes the behavior of the feature</li>
@@ -189,7 +189,7 @@
</li>
<li>Expand the model to see the requirements. Drag Req 3 and drop it in the Selection view. </li>
<li>Select the
- <code>ISO26262 Requirements.pdf</code> file from the Project Explorer and drag and drop it to the selection view
+ <code>ISO26262 Requirements.png</code> file from the Project Explorer and drag and drop it to the selection view
</li>
<li>Right click on the selection view and click on “Create Trace”.</li>
<li>A pop up window will appear, showing the types of links that can be created based on the selected elements and the definition of the traceability metamodel. In this example the traceability metamodel has only one traceability link type which is called “RelatedTo”.</li>
@@ -211,14 +211,14 @@
<h5 id="graphical-view">Graphical view</h5>
<p>To view the traceability links related to an artifact and the connected artifacts, simply select the artifact while in the “Sample Reflective Editor” View. The “Plant UML View” needs to be open as well.</p>
<p>The graphical view allows you to explore directly connected elements or transitively connected elements. To use the latter functionality, click on the downward arrow on right hand corner of the Plant UML View and click on “Toggle Transitivity”. This enables you to move from viewing only directly connected elements to the selected element, to viewing all the transitively connected elements. Use the same button to return to the previously active view.</p>
- <p><figure> <img src="../images/toggleTransitivity.pdf" width="600"/> <figcaption> Figure 7: Toggle Transitivity </figcaption></figure></p>
+ <p><figure> <img src="../images/toggleTransitivity.png" width="600"/> <figcaption> Figure 7: Toggle Transitivity </figcaption></figure></p>
<h5 id="traceability-matrix">Traceability matrix</h5>
<p>The traceability matrix can be created by selecting at least two model elements when the “Plant UML View” is open. This will list all the model elements as rows and columns and an “x” mark will appear to show that there is a traceability link between two elements. For instance, the picture below shows the resulting matrix when selecting Req3 and the artifact wrapper representing the PDF document. </p>
<p><figure> <img src="../images/matrixView.png" width="400"/> <figcaption> Figure 8: Matrix View as a result of selecting two elements </figcaption></figure></p>
<p>Selecting more than two model elements expands the matrix into a square matrix with same elements listed vertically and horizontally. </p>
<p><figure> <img src="../images/matrixViewMany.png" width="600"/> <figcaption> Figure 9: Matrix view as a result of selecting more than two elements </figcaption></figure></p>
<h4 id="detecting-and-fixing-inconsistencies">Detecting and Fixing Inconsistencies</h4>
- <p>Traceability links need to be updated as the artifacts they connect evolve. Capra provides a feature to notify users when these artifacts evolve and give suggestions on how the traceability links can be evolved. The suggestions are offered as quick fixes to the user and if the user wants to make the changes suggested by the quick fix, the fix can be applied automatically by clicking on it. Currently Capra can uses the Eclipse notification Framework to detect changes and can capture rename, move, change and delete actions made on artifacts that have traceability links.</p>
+ <p>Traceability links need to be updated as the artifacts they connect evolve. Capra provides a feature to notify users when these artifacts change and to give suggestions on how the traceability links can be changed accordingly. The suggestions are offered as quick fixes to the user and if the user wants to make the changes suggested by the quick fix, the fix can be applied automatically by clicking on it. Currently Capra uses the Eclipse Notification Framework to detect changes and can capture rename, move, change and delete actions made on artifacts that have traceability links.</p>
<p>The problems detected by Capra are shown in the
<code>Problems View</code> with a type “Capra problem”. We demonstrate the use of the
<code>Problems View</code> and quick fixes using our practical example of the HVAC project.
@@ -240,18 +240,21 @@
<li>Notice that the traceability link has been deleted and the warning disappears.</li>
</ol>
<h4 id="analyzing-change-impact">Analyzing change impact</h4>
- <p>In this section, we describe scenarios in which Capra can be used to facilitate change impact analysis. Change impact analysis means being able to evaluate the effect a change to an artifact will have to other artifacts. Using the HVAC example, assume that the customer requests a change on the requirement
- <code>REQ-3</code>. Before such a change is made, it is important for the company to know which other artefacts will be affected. With Capra, this can be done by selecting
- <code>REQ-3</code> and then using the visualization, one can see all other artefacts that are related to
+ <p>In this section, we describe scenarios in which Capra can be used to facilitate change impact analysis. Change impact analysis allows to evaluate the effect a change to an artifact will have on other artifacts. Using the HVAC example, assume that the customer requests a change on the requirement
+ <code>REQ-3</code>. Before such a change is made, it is important for the company to know which other artefacts will be affected. With Capra, this can be achieved by selecting
+ <code>REQ-3</code> and, using the visualization, reviewing all other artefacts that are related to
<code>REQ-3</code> too.
</p>
- <p><figure> <img src="../images/toggleTransitivity.pdf" width="700"/> <figcaption> Figure 11: Capra graphical view showing directly connected elements </figcaption></figure> </p>
- <p>For further analysis, clicking on Toggle transitivity as shown in th figure below will show all artifacts connected to
+ <p><figure> <img src="../images/toggleTransitivity.png" width="700"/> <figcaption> Figure 11: Capra graphical view showing directly connected elements </figcaption></figure> </p>
+ <p>For further analysis, clicking on Toggle transitivity as shown in the figure below will show all artifacts connected to
<code>REQ-3</code> and their connnections to other artifacts. The end user can therefore use this information as a starting point for performing impact analysis.
</p>
- <p><figure> <img src="../images/graphical-view-transitive.pdf" width="500"/> <figcaption> Figure 12: Capra graphical view showing transitively connected elements </figcaption></figure> </p>
+ <p><figure> <img src="../images/graphical-view-transitive.png" width="500"/> <figcaption> Figure 12: Capra graphical view showing transitively connected elements </figcaption></figure> </p>
<h2 id="developer-guide">Developer Guide</h2>
- <p>The following subsection describes the technical architecture of the tool. This information is also available in more detail in a tool demonstration paper (1). Our motivation for choosing this architecture design is based on a study on factors and guidelines that affect how a traceability tool can support traceability maintenance(2). </p>
+ <p>The following subsection describes the technical architecture of the tool. This information is also available in more detail in a tool demonstration paper
+ <a href="#references">(1)</a>. Our motivation for choosing this architecture design is based on a study on factors and guidelines that affect how a traceability tool can support traceability maintenance
+ <a href="#references">(2)</a>.
+ </p>
<h3 id="architecture-of-capra">Architecture of Capra</h3>
<p>Capra is an Eclipse plugin and uses the Eclipse Modeling Framework (EMF) as its base technology. It stores the traceability model as an EMF model. The tool relies on the
<a href="https://wiki.eclipse.org/FAQ_What_are_extensions_and_extension_points">Eclipse Extension mechanism</a> and provides extension points for those parts of the tool that can be customized. Based on requirements we collected from many interested parties in the industry, the tool is customizable at four points:
@@ -267,7 +270,7 @@
<p><figure> <img src="../images/capraArchitecture.png" width="600"/> <figcaption> Figure 13: The Architecture of Capra </figcaption></figure> </p>
<h4 id="traceability-metamodel">Traceability Metamodel</h4>
<p>Depending on the company, development context, and process used, the traceability links required can differ. For example, traceability links for a company developing web-based solutions are not the same as links for companies developing embedded software. In the former case, traceability links can help connect certain entries in the server configuration files to specific requirements. The traceability links for embedded software need to relate, e.g., the hardware specification to the software design. Both concepts do not make sense in the respective other domain.</p>
- <p>To address the different link types, the tool offers an extension point for the traceability metamodel. Here the end user (company), can define the types of links through a metamodel and supply it to the tool. Examples of link types are “verifies”, “implements”, “refines”, “related to” etc. In addition to link types, the metamodel can also define additional information to be stored with each link. It might be desirable, e.g., to store the date and time the link was created or which user created it.</p>
+ <p>To address different link types, the tool offers an extension point for the traceability metamodel. Here the end user (company), can define the types of links through a metamodel and supply it to the tool. Examples of link types are “verifies”, “implements”, “refines”, “related to” etc. In addition to link types, the metamodel can also define additional information to be stored with each link. It might be desirable, e.g., to store the date and time the link was created or which user created it.</p>
<h4 id="artifact-handler">Artifact Handler</h4>
<p>Software development usually involves a number of activities such as requirements engineering, design, implementation, and testing. In most cases, each of these activities use different tools and produce artifacts of different formats. A traceability tool needs to ensure that the different formats can be traced to and from. Since different companies use different tools, it is not easy to foresee which formats a traceability tool should support. This problem of diverse artifacts existing in the development environment has been noted by several studies on traceability. Our tool offers an extension point for Artifact Handlers which allows adding artifact formats based on the needs of the end users.</p>
<p>As discussed, Capra stores the traceability links as an EMF model. To be able to support tracing to other formats, EMF representations of these other formats are required. Implementing an extension for a certain format means providing an EMF representation of that format to the tool using the artifact handler extension point. </p>
@@ -276,13 +279,13 @@
<h4 id="priority-handler">Priority Handler</h4>
<p>In situations where there is more than one artifact handler that can handle the same artifact type, the tool provides an extension point for a so called Priority Handler. Here the user can define which handler should be used. </p>
<h3 id="capra-api">Capra API</h3>
- <p>Capra provides several programming interfaces that can be used by other plugins to access the traceability data. Currently, this is in three interfaces which are the
+ <p>Capra provides several programming interfaces that can be used by other plugins to access the traceability data. Currently, there are three interfaces:
<code>ArtifactMetamodelAdapter</code>,
<code>TraceMetamodelAdapter</code> and
- <code>TracePersistenceAdapter</code>. The
- <code>ArtifactMetaodelAdapter</code> has methods that give you access to the artifact wrappers and their contents, the
- <code>TraceMetamodelAdapter</code> has methods that give you access to the traceability links and the content of the links and the
- <code>TracePersistenceAdapter</code> has methods that give access to the traceability model and the artifact wrapper model. The traceability model containing the traceability links is available to other tools this traceability data can be used for tasks such as impact analysis.
+ <code>TracePersistenceAdapter</code>.
+ <code>ArtifactMetaodelAdapter</code> has methods that provide access to the artifact wrappers and their contents,
+ <code>TraceMetamodelAdapter</code> has methods that provide access to the traceability links and the content of the links and the
+ <code>TracePersistenceAdapter</code> has methods that provide access to the traceability model and the artifact wrapper model. The traceability model containing the traceability links is available to other tools. That means that traceability data can be used by other tools for specialised tasks such as impact analysis.
</p>
<p>A good example on how these methods can be used is in the plugin
<code>org.eclipse.capra.ui.plantuml</code>. This plugin utilizes the methods to get the traceability model and its links and also to determine which artifacts are connected by the links. The plugin uses the results of these methods to create a string that can be rendered as a diagram using the PlantUML view. For example in the file
@@ -306,7 +309,7 @@
<code>model</code> folder create a new file and name it
<code>MyTraceabilityMetaModel.xcore</code>. A pop up window will appear asking if you want to add the Xtext nature to the project. Click “Yes”.
</li>
- <li>Define your traceability metamodel as required. In our example, we add two types of traceability links i.e “implements” and “tests” <figure> <img src="../images/traceMetamodelDefinition.pdf" width="400"/> <figcaption> Figure 15: Tracemetamodel Definition </figcaption> </figure> </li>
+ <li>Define your traceability metamodel as required. In our example, we add two types of traceability links i.e “implements” and “tests” <figure> <img src="../images/traceMetamodelDefinition.png" width="400"/> <figcaption> Figure 15: Tracemetamodel Definition </figcaption> </figure> </li>
<li>Open the
<code>plugin.xml</code> file of the new project and click on the “Extension Points” tab
</li>
@@ -314,19 +317,19 @@
<li>In the text box for the “Extension point filter” type “Traceability” and select
<code>org.eclipse.capra.configuration.TraceabilityMetaModel</code>
</li>
- <li>Click Finish. <figure> <img src="../images/addTraceExtension.pdf" width="500"/> <figcaption> Figure 16: Adding the Trace metamodel extension point </figcaption> </figure> </li>
+ <li>Click Finish. <figure> <img src="../images/addTraceExtension.png" width="500"/> <figcaption> Figure 16: Adding the Trace metamodel extension point </figcaption> </figure> </li>
<li>Another pop up window will appear asking if you want to add the project
<code>org.eclipse.capra.core</code> to the list of plugin dependencies. Click Yes
</li>
<li>Right click on the newly added extension, and click on “New” then
<code>TraceabilityMetaModelAdapter</code>. A new
- <code>TraceabilityMetaModelAdapter</code> will be created <figure> <img src="../images/newTMAdapter.pdf" width="700"/> <figcaption> Figure 17: Adding the Trace metamodel extension point </figcaption> </figure>
+ <code>TraceabilityMetaModelAdapter</code> will be created <figure> <img src="../images/newTMAdapter.png" width="700"/> <figcaption> Figure 17: Adding the Trace metamodel extension point </figcaption> </figure>
</li>
<li>Click on the newly created
- <code>TraceabilityMetaModelAdapter</code>. On the right hand side, we need to provide a class for this extension, where we will implement all the required interfaces.
+ <code>TraceabilityMetaModelAdapter</code>. On the right hand side, we need to provide a class for this extension in which we will implement all the required interfaces.
</li>
<li>Click on “Class” and a pop up window for creating a new class will appear. Make sure the folder is
- <code>src</code> and name your class <figure> <img src="../images/newClass.pdf" width="700"> </img> <figcaption> Figure 18: Add new Class </figcaption> </figure> <figure> <img src="../images/addNewTraceAdapterClass.png" width="500"/> <figcaption> Figure 19: Add new Trace Adapter Class </figcaption> </figure>
+ <code>src</code> and name your class <figure> <img src="../images/newClass.png" width="700"> </img> <figcaption> Figure 18: Add new Class </figcaption> </figure> <figure> <img src="../images/addNewTraceAdapterClass.png" width="500"/> <figcaption> Figure 19: Add new Trace Adapter Class </figcaption> </figure>
</li>
<li>Click Finish and a class will be created with the methods to be implemented in it. </li>
<li>Implement all the methods according to your new custom metamodel. Note that information about what each method does and its parameters can be obtained by hovering the mouse over the respective method name. </li>
@@ -392,7 +395,7 @@
<code>src</code> and name your class <figure> <img src="../images/newArtifactClass.png" width="500"/> <figcaption> Figure 24: New Artifact Handler Class definition </figcaption> </figure>
</li>
<li>Click Finish and a class will be created with the methods to be implemented in it. In this case there are only two methods.</li>
- <li>Implement all the methods according to your new custom metamodel. Note that information about what each method does and its parameters can be obtained by hovering the mouse over the respective method name. </li>
+ <li>Implement all required methods. Note that information about what each method does and its parameters can be obtained by hovering the mouse over the respective method name. </li>
</ol>
<h3 id="changing-the-storage-location-of-the-traceability-model">Changing the storage location of the traceability model</h3>
<p>The storage of the traceability model and the artifact handler model is not fixed and can be modified depending on the users' needs and requirements. To change the storage location of the traceability model there are two options.</p>
@@ -450,10 +453,10 @@
<code>src</code> and name your class. <figure> <img src="../images/newPersistenceHandlerClass.png" width="500"/> <figcaption> Figure 28: New Persistence Handler Class </figcaption> </figure>
</li>
<li>Click Finish and a class will be created with the methods to be implemented in it. In this case there are only two methods.</li>
- <li>Implement all the methods according to your needs. Note that information about what each method does and its parameters can be obtained by hovering the mouse over the respective method name.</li>
+ <li>Implement all methods according to your needs. Note that information about what each method does and its parameters can be obtained by hovering the mouse over the respective method name.</li>
</ol>
<h3 id="taking-care-of-multiple-handlers-for-the-same-artifact-type">Taking care of multiple handlers for the same artifact type</h3>
- <p>There are cases where for one artifact type, there are several handlers available. It is important during configuration to select which handler should be given a priority for the particular artifact type. This can be done by editing the code in the Priority Handler as follows:</p>
+ <p>There are cases in which several handlers are available for one artifact type. It is important during configuration to select which handler should be given a priority for the particular artifact type. This can be done by editing the code in the Priority Handler as follows:</p>
<ol>
<li>Expand the project
<code>org.eclipse.capra.generic.priority</code>.
@@ -464,8 +467,8 @@
<li>Open the file
<code>DefaultPriorityHander.java</code>.
</li>
- <li>Modify the code to have the right handler selected. For instance, the code below selects a
- <code>hudsonHandler</code> when the element selected is a Test element and also a build element. <figure> <img src="../images/priorityHandlerCode.png" width="700"/> <figcaption> Figure 29: Code for the Priority Handler </figcaption> </figure>
+ <li>Modify the code to select the correct handler. For instance, the code below selects a
+ <code>hudsonHandler</code> when the element selected is a Test element or a build element. <figure> <img src="../images/priorityHandlerCode.png" width="700"/> <figcaption> Figure 29: Code for the Priority Handler </figcaption> </figure>
</li>
</ol>
<h3 id="adding-new-source-files">Adding new source files</h3>
@@ -479,11 +482,11 @@
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
</code></pre>
- <p>Contributors:
- <br/> Chalmers | University of Gothenburg and rt-labs – initial API and implementation and/or initial documentation
- </p>
+ <pre><code>Contributors:
+bc. Chalmers | University of Gothenburg and rt-labs - initial API and implementation and/or initial documentation
+</code></pre>
<p>The Contributors entry can be replaced with the appropriate names. Use “Fix copyrights” from the context menu to add the copyrights to all relevant files in a project or folder.</p>
- <h2 id="rerefences">Rerefences</h2>
+ <h2 id="references">Rerefences</h2>
<p>1. Maro, S. and Steghöfer, JP., 2016, September. Capra: A Configurable and Extendable Traceability Management Tool. In 2016 IEEE 24th International Requirements Engineering Conference (RE). IEEE.
<br/>2. Maro, S., Anjorin A., Wohlrab R. and Steghöfer, JP., 2016, September. Traceability Maintenance: Factors and Guidelines. In Automated Software Engineering (ASE), 2016 31st IEEE/ACM International Conference. IEEE.
</p>
diff --git a/org.eclipse.capra.documentation/docu/capraDocumentation.textile b/org.eclipse.capra.documentation/docu/capraDocumentation.textile
index 0794204..4de89ae 100644
--- a/org.eclipse.capra.documentation/docu/capraDocumentation.textile
+++ b/org.eclipse.capra.documentation/docu/capraDocumentation.textile
@@ -2,9 +2,9 @@
h2(#user-guide). User Guide
-h3(#introduction-what-is-capra). Introduction - What is Capra?
+h3(#introduction-what-is-capra). Introduction -- What is Capra?
-Capra is a dedicated traceability management tool that allows the creation, management, visualization, and analysis of traceability links within Eclipse. traceability links can be created between arbitrary artifacts, including all EMF model elements, all types of source code files supported by the Eclipse Platform through specialized development tools, tickets and bugs managed by Eclipse Mylyn, and all other artifacts for which an appropriate wrapper is provided. Capra is highly configurable and allows users (in a company or project) to define link types that are useful to them.
+Capra is a dedicated traceability management tool that allows the creation, management, visualization, and analysis of traceability links within Eclipse. Traceability links can be created between arbitrary artifacts, including all EMF model elements, all types of source code files supported by the Eclipse Platform through specialized development tools, tickets and bugs managed by Eclipse Mylyn, and all other artifacts for which an appropriate wrapper is provided. Capra is highly configurable and allows users (in a company or project) to define link types that are useful to them.
Compared to other similar projects which may have similar features, Capra is not a modeling tool or a tool for requirements management. All functionality is focused on providing traceability capabilities, i.e., the ability to create and visualize links between artifacts modeled in different domain-specific languages. This allows the architecture to be highly modular and the tool to be extremely customizable.
@@ -26,20 +26,20 @@
h4(#installing-capra). Installing Capra
-Capra can be installed either through an update site or manually .
+Capra can be installed either through an update site or manually.
-h5(#installing-through-an-update-site). Installing through an update site
+h5(#installing-through-an-update-site). Installing Capra through an update site
-* Go to the "Capra GitHub repository":https://github.com/Salome-Maro/TraceabilityManagement.
+* Go to the "Capra Github repository":https://github.com/Salome-Maro/TraceabilityManagement.
* Click on "Releases" (Please note that the current release is a Pre-release and the official release will be available once the tool is an Eclipse project)
* Download the file @Capra_v.0.1.zip@ (Note the location of your download)
* Open your Eclipse environment
-* Make sure that you have all the dependencied listed above installed
-* Click on Help >> Install New Softaware
+* Make sure that you have all the dependencies listed above installed
+* Click on Help >> Install New Software
* Click on Add and select Archive
* Select your zip file and click Add
* You should see the features that Capra has grouped into several categories as shown in Figure 1.
-* To get a minimum version of Capra working, install all the features in Core and at least one artifact wrapper. This means that if you for instance install only the EMFHandler, then you will only be able to create traceability links between EMF models. It is recommended to install all available artifact handlers.
+* To get a minimum version of Capra working, install all the features in Core and at least one artifact wrapper. This means that if you for instance install only the EMFHandler, then you will only be able to create traceability links between model elements contained in EMF models. It is recommended to install all available artifact handlers.
* Install the features in the visualization and notification categories in order to get their functionality working.
* Restart Eclipse
* Go to perspectives and switch to the Capra perspective
@@ -47,11 +47,11 @@
<figure><img src="../images/updatesite.png" width="600"/><figcaption>Figure 1: Installing Capra from the Updatesite</figcaption></figure>
-h5(#manual-installation-import-from-git). Manual installation (Import from Git)
+h5(#manual-installation-import-from-git). Installing Capra manually with Git
* Open your Eclipse Environment
* Go to File >> Import and select Git >> Projects from Git
-* Use the "GitHub repository":https://github.com/Salome-Maro/TraceabilityManagement and import all available projects to your workspace
+* Use the "Git repository":https://git.eclipse.org/r/capra/org.eclipse.capra and import all available projects to your workspace
* Build your workspace
* Make sure that all the projects have no errors.
* Click on Run >> Run Configurations and create a new Eclipse Application Configuration
@@ -87,11 +87,11 @@
h4(#what-is-an-artifact-handler). What is an artifact handler?
-As previously mentioned, there are different types of artifacts that can exist in a software development environment. However, Capra stores the traceability links in form of an EMF model. This means that, basically only EMF artifact types can be supported. To support other artifact types, there is a need to create EMF representations of the artifacts. This is what an artifact handler does. It creates an EMF representation of non-EMF artifacts. The representations are known as "artifact wrappers". For example to be able to link to Java Code, an artifact handler for Java needs to be created. For details on how to add new artifact handlers to the tool, refer to section "Adding a new artifact handler":#adding-a-new-artifact-handler.
+As previously mentioned, there are different types of artifacts that can exist in a software development environment. However, Capra stores the traceability links in form of an EMF model. This means that, in principle, only EMF artifact types can be supported. To support other artifact types, there is a need to create EMF representations of the artifacts. This is what an artifact handler does. It creates an EMF representation of non-EMF artifacts. The representations are known as "artifact wrappers". For example to be able to link to Java Code, an artifact handler for Java needs to be created. For details on how to add new artifact handlers to the tool, refer to "Adding a new artifact handler":#adding-a-new-artifact-handler.
h3(#practical-examples). Practical Examples
-To demonstrate features of Capra, we take an example of the development of a Heating, Ventilation and Air Conditioning (HVAC) System. The resources can be dowloaded through this "link":https://www.dropbox.com/s/h6vzmca7sjpq83q/HVAC%20Projects.zip?dl=0. The project contains the following artifacts:
+To demonstrate features of Capra, we take an example of the development of a Heating, Ventilation and Air Conditioning (HVAC) System. The resources can be dowloaded "here":https://www.dropbox.com/s/h6vzmca7sjpq83q/HVAC%20Projects.zip?dl=0. The project contains the following artifacts:
* A set of requirements which are written in "ReqIF":http://www.omg.org/spec/ReqIF/ format.
* A feature model describing the different features that can form several products of the HVAC system.
@@ -108,7 +108,7 @@
Capra provides the functionality to create traceability links between different artifacts as long as artifact handlers for those artifact types are available. The current version supports tracing to EMF models, Java code (up to method level), C/C++ code (up to function level), Task tickets from ticketing systems supported by Mylyn, arbitrary files (such as PDF or word), Test executions (Hudson and Jenkins), Papyrus models, and Capella models.
-To show how traceability links can be created, we continue with the HVAC example and its artifacts as described above. Our aim is to establish the following links.
+To show how traceability links can be created, we continue with the HVAC example and its artifacts as described above. Our aim is to establish the following links:
# A link from a requirement to a feature representing the requirement in the feature model
# A link from a feature to the state machine that describes the behavior of the feature
@@ -153,7 +153,7 @@
# Expand the folder containing the requirements to reveal its contents.
# Open the requirements (@HVAC_Requirements.reqif@ file), with the "Sample Reflective Ecore Editor" view.
# Expand the model to see the requirements. Drag Req 3 and drop it in the Selection view.
-# Select the @ISO26262 Requirements.pdf@ file from the Project Explorer and drag and drop it to the selection view
+# Select the @ISO26262 Requirements.png@ file from the Project Explorer and drag and drop it to the selection view
# Right click on the selection view and click on "Create Trace".
# A pop up window will appear, showing the types of links that can be created based on the selected elements and the definition of the traceability metamodel. In this example the traceability metamodel has only one traceability link type which is called "RelatedTo".
# Choose a traceability link type to create (in our case "RelatedTo") and click OK.
@@ -177,7 +177,7 @@
The graphical view allows you to explore directly connected elements or transitively connected elements. To use the latter functionality, click on the downward arrow on right hand corner of the Plant UML View and click on "Toggle Transitivity". This enables you to move from viewing only directly connected elements to the selected element, to viewing all the transitively connected elements. Use the same button to return to the previously active view.
-<figure> <img src="../images/toggleTransitivity.pdf" width="600"/> <figcaption> Figure 7: Toggle Transitivity </figcaption></figure>
+<figure> <img src="../images/toggleTransitivity.png" width="600"/> <figcaption> Figure 7: Toggle Transitivity </figcaption></figure>
h5(#traceability-matrix). Traceability matrix
@@ -191,7 +191,7 @@
h4(#detecting-and-fixing-inconsistencies). Detecting and Fixing Inconsistencies
-Traceability links need to be updated as the artifacts they connect evolve. Capra provides a feature to notify users when these artifacts evolve and give suggestions on how the traceability links can be evolved. The suggestions are offered as quick fixes to the user and if the user wants to make the changes suggested by the quick fix, the fix can be applied automatically by clicking on it. Currently Capra can uses the Eclipse notification Framework to detect changes and can capture rename, move, change and delete actions made on artifacts that have traceability links.
+Traceability links need to be updated as the artifacts they connect evolve. Capra provides a feature to notify users when these artifacts change and to give suggestions on how the traceability links can be changed accordingly. The suggestions are offered as quick fixes to the user and if the user wants to make the changes suggested by the quick fix, the fix can be applied automatically by clicking on it. Currently Capra uses the Eclipse Notification Framework to detect changes and can capture rename, move, change and delete actions made on artifacts that have traceability links.
The problems detected by Capra are shown in the @Problems View@ with a type "Capra problem". We demonstrate the use of the @Problems View@ and quick fixes using our practical example of the HVAC project.
@@ -205,17 +205,17 @@
h4(#analyzing-change-impact). Analyzing change impact
-In this section, we describe scenarios in which Capra can be used to facilitate change impact analysis. Change impact analysis means being able to evaluate the effect a change to an artifact will have to other artifacts. Using the HVAC example, assume that the customer requests a change on the requirement @REQ-3@. Before such a change is made, it is important for the company to know which other artefacts will be affected. With Capra, this can be done by selecting @REQ-3@ and then using the visualization, one can see all other artefacts that are related to @REQ-3@ too.
+In this section, we describe scenarios in which Capra can be used to facilitate change impact analysis. Change impact analysis allows to evaluate the effect a change to an artifact will have on other artifacts. Using the HVAC example, assume that the customer requests a change on the requirement @REQ-3@. Before such a change is made, it is important for the company to know which other artefacts will be affected. With Capra, this can be achieved by selecting @REQ-3@ and, using the visualization, reviewing all other artefacts that are related to @REQ-3@ too.
-<figure> <img src="../images/toggleTransitivity.pdf" width="700"/> <figcaption> Figure 11: Capra graphical view showing directly connected elements </figcaption></figure>
+<figure> <img src="../images/toggleTransitivity.png" width="700"/> <figcaption> Figure 11: Capra graphical view showing directly connected elements </figcaption></figure>
-For further analysis, clicking on Toggle transitivity as shown in th figure below will show all artifacts connected to @REQ-3@ and their connnections to other artifacts. The end user can therefore use this information as a starting point for performing impact analysis.
+For further analysis, clicking on Toggle transitivity as shown in the figure below will show all artifacts connected to @REQ-3@ and their connnections to other artifacts. The end user can therefore use this information as a starting point for performing impact analysis.
-<figure> <img src="../images/graphical-view-transitive.pdf" width="500"/> <figcaption> Figure 12: Capra graphical view showing transitively connected elements </figcaption></figure>
+<figure> <img src="../images/graphical-view-transitive.png" width="500"/> <figcaption> Figure 12: Capra graphical view showing transitively connected elements </figcaption></figure>
h2(#developer-guide). Developer Guide
-The following subsection describes the technical architecture of the tool. This information is also available in more detail in a tool demonstration paper (1). Our motivation for choosing this architecture design is based on a study on factors and guidelines that affect how a traceability tool can support traceability maintenance(2).
+The following subsection describes the technical architecture of the tool. This information is also available in more detail in a tool demonstration paper "(1)":#references. Our motivation for choosing this architecture design is based on a study on factors and guidelines that affect how a traceability tool can support traceability maintenance "(2)":#references.
h3(#architecture-of-capra). Architecture of Capra
@@ -236,7 +236,7 @@
Depending on the company, development context, and process used, the traceability links required can differ. For example, traceability links for a company developing web-based solutions are not the same as links for companies developing embedded software. In the former case, traceability links can help connect certain entries in the server configuration files to specific requirements. The traceability links for embedded software need to relate, e.g., the hardware specification to the software design. Both concepts do not make sense in the respective other domain.
-To address the different link types, the tool offers an extension point for the traceability metamodel. Here the end user (company), can define the types of links through a metamodel and supply it to the tool. Examples of link types are "verifies", "implements", "refines", "related to" etc. In addition to link types, the metamodel can also define additional information to be stored with each link. It might be desirable, e.g., to store the date and time the link was created or which user created it.
+To address different link types, the tool offers an extension point for the traceability metamodel. Here the end user (company), can define the types of links through a metamodel and supply it to the tool. Examples of link types are "verifies", "implements", "refines", "related to" etc. In addition to link types, the metamodel can also define additional information to be stored with each link. It might be desirable, e.g., to store the date and time the link was created or which user created it.
h4(#artifact-handler). Artifact Handler
@@ -254,7 +254,7 @@
h3(#capra-api). Capra API
-Capra provides several programming interfaces that can be used by other plugins to access the traceability data. Currently, this is in three interfaces which are the @ArtifactMetamodelAdapter@, @TraceMetamodelAdapter@ and @TracePersistenceAdapter@. The @ArtifactMetaodelAdapter@ has methods that give you access to the artifact wrappers and their contents, the @TraceMetamodelAdapter@ has methods that give you access to the traceability links and the content of the links and the @TracePersistenceAdapter@ has methods that give access to the traceability model and the artifact wrapper model. The traceability model containing the traceability links is available to other tools this traceability data can be used for tasks such as impact analysis.
+Capra provides several programming interfaces that can be used by other plugins to access the traceability data. Currently, there are three interfaces: @ArtifactMetamodelAdapter@, @TraceMetamodelAdapter@ and @TracePersistenceAdapter@. @ArtifactMetaodelAdapter@ has methods that provide access to the artifact wrappers and their contents, @TraceMetamodelAdapter@ has methods that provide access to the traceability links and the content of the links and the @TracePersistenceAdapter@ has methods that provide access to the traceability model and the artifact wrapper model. The traceability model containing the traceability links is available to other tools. That means that traceability data can be used by other tools for specialised tasks such as impact analysis.
A good example on how these methods can be used is in the plugin @org.eclipse.capra.ui.plantuml@. This plugin utilizes the methods to get the traceability model and its links and also to determine which artifacts are connected by the links. The plugin uses the results of these methods to create a string that can be rendered as a diagram using the PlantUML view. For example in the file @VisualizationHelper@, the method @CreateMatrix()@ calls a method @isThereATraceBetween()@ which is part of the
@TraceMetamodelAdapter@ interface.
@@ -268,15 +268,15 @@
# Create a Java project and name it @org.eclipse.capra.MyTraceabilityMetaModel@
# Create a new folder and name it @model@
# In the @model@ folder create a new file and name it @MyTraceabilityMetaModel.xcore@. A pop up window will appear asking if you want to add the Xtext nature to the project. Click "Yes".
-# Define your traceability metamodel as required. In our example, we add two types of traceability links i.e "implements" and "tests" <figure> <img src="../images/traceMetamodelDefinition.pdf" width="400"/> <figcaption> Figure 15: Tracemetamodel Definition </figcaption> </figure>
+# Define your traceability metamodel as required. In our example, we add two types of traceability links i.e "implements" and "tests" <figure> <img src="../images/traceMetamodelDefinition.png" width="400"/> <figcaption> Figure 15: Tracemetamodel Definition </figcaption> </figure>
# Open the @plugin.xml@ file of the new project and click on the "Extension Points" tab
# Un-check the check box that says "Show only extension points from the required plugins"
# In the text box for the "Extension point filter" type "Traceability" and select @org.eclipse.capra.configuration.TraceabilityMetaModel@
-# Click Finish. <figure> <img src="../images/addTraceExtension.pdf" width="500"/> <figcaption> Figure 16: Adding the Trace metamodel extension point </figcaption> </figure>
+# Click Finish. <figure> <img src="../images/addTraceExtension.png" width="500"/> <figcaption> Figure 16: Adding the Trace metamodel extension point </figcaption> </figure>
# Another pop up window will appear asking if you want to add the project @org.eclipse.capra.core@ to the list of plugin dependencies. Click Yes
-# Right click on the newly added extension, and click on "New" then @TraceabilityMetaModelAdapter@. A new @TraceabilityMetaModelAdapter@ will be created <figure> <img src="../images/newTMAdapter.pdf" width="700"/> <figcaption> Figure 17: Adding the Trace metamodel extension point </figcaption> </figure>
-# Click on the newly created @TraceabilityMetaModelAdapter@. On the right hand side, we need to provide a class for this extension, where we will implement all the required interfaces.
-# Click on "Class" and a pop up window for creating a new class will appear. Make sure the folder is @src@ and name your class <figure> <img src="../images/newClass.pdf" width="700"> </img> <figcaption> Figure 18: Add new Class </figcaption> </figure> <figure> <img src="../images/addNewTraceAdapterClass.png" width="500"/> <figcaption> Figure 19: Add new Trace Adapter Class </figcaption> </figure>
+# Right click on the newly added extension, and click on "New" then @TraceabilityMetaModelAdapter@. A new @TraceabilityMetaModelAdapter@ will be created <figure> <img src="../images/newTMAdapter.png" width="700"/> <figcaption> Figure 17: Adding the Trace metamodel extension point </figcaption> </figure>
+# Click on the newly created @TraceabilityMetaModelAdapter@. On the right hand side, we need to provide a class for this extension in which we will implement all the required interfaces.
+# Click on "Class" and a pop up window for creating a new class will appear. Make sure the folder is @src@ and name your class <figure> <img src="../images/newClass.png" width="700"> </img> <figcaption> Figure 18: Add new Class </figcaption> </figure> <figure> <img src="../images/addNewTraceAdapterClass.png" width="500"/> <figcaption> Figure 19: Add new Trace Adapter Class </figcaption> </figure>
# Click Finish and a class will be created with the methods to be implemented in it.
# Implement all the methods according to your new custom metamodel. Note that information about what each method does and its parameters can be obtained by hovering the mouse over the respective method name.
@@ -313,7 +313,7 @@
# Click on the newly created @ArtifactHandler@. On the right hand side, we need to provide a class for this extension, where we will implement all the required interfaces.
# Click on "Class" and a pop up window for creating a new class will appear. Make sure the folder is @src@ and name your class <figure> <img src="../images/newArtifactClass.png" width="500"/> <figcaption> Figure 24: New Artifact Handler Class definition </figcaption> </figure>
# Click Finish and a class will be created with the methods to be implemented in it. In this case there are only two methods.
-# Implement all the methods according to your new custom metamodel. Note that information about what each method does and its parameters can be obtained by hovering the mouse over the respective method name.
+# Implement all required methods. Note that information about what each method does and its parameters can be obtained by hovering the mouse over the respective method name.
h3(#changing-the-storage-location-of-the-traceability-model). Changing the storage location of the traceability model
@@ -343,16 +343,16 @@
# Click on the newly created @persistenceHandler@. On the right hand side, we need to provide a class for this extension, where we will implement all the required interfaces.
# Click on "Class" and a pop up window for creating a new class will appear. Make sure the folder is @src@ and name your class. <figure> <img src="../images/newPersistenceHandlerClass.png" width="500"/> <figcaption> Figure 28: New Persistence Handler Class </figcaption> </figure>
# Click Finish and a class will be created with the methods to be implemented in it. In this case there are only two methods.
-# Implement all the methods according to your needs. Note that information about what each method does and its parameters can be obtained by hovering the mouse over the respective method name.
+# Implement all methods according to your needs. Note that information about what each method does and its parameters can be obtained by hovering the mouse over the respective method name.
h3(#taking-care-of-multiple-handlers-for-the-same-artifact-type). Taking care of multiple handlers for the same artifact type
-There are cases where for one artifact type, there are several handlers available. It is important during configuration to select which handler should be given a priority for the particular artifact type. This can be done by editing the code in the Priority Handler as follows:
+There are cases in which several handlers are available for one artifact type. It is important during configuration to select which handler should be given a priority for the particular artifact type. This can be done by editing the code in the Priority Handler as follows:
# Expand the project @org.eclipse.capra.generic.priority@.
# Expand the src folder and then the @org.eclipse.capra.generic.priority@ package.
# Open the file @DefaultPriorityHander.java@.
-# Modify the code to have the right handler selected. For instance, the code below selects a @hudsonHandler@ when the element selected is a Test element and also a build element. <figure> <img src="../images/priorityHandlerCode.png" width="700"/> <figcaption> Figure 29: Code for the Priority Handler </figcaption> </figure>
+# Modify the code to select the correct handler. For instance, the code below selects a @hudsonHandler@ when the element selected is a Test element or a build element. <figure> <img src="../images/priorityHandlerCode.png" width="700"/> <figcaption> Figure 29: Code for the Priority Handler </figcaption> </figure>
h3(#adding-new-source-files). Adding new source files
@@ -366,12 +366,12 @@
which accompanies this distribution, and is available at
http://www.eclipse.org/legal/epl-v10.html
-Contributors:
- Chalmers | University of Gothenburg and rt-labs - initial API and implementation and/or initial documentation
+bc. Contributors:
+bc. Chalmers | University of Gothenburg and rt-labs - initial API and implementation and/or initial documentation
The Contributors entry can be replaced with the appropriate names. Use "Fix copyrights" from the context menu to add the copyrights to all relevant files in a project or folder.
-h2(#rerefences). Rerefences
+h2(#references). Rerefences
1. Maro, S. and Steghöfer, JP., 2016, September. Capra: A Configurable and Extendable Traceability Management Tool. In 2016 IEEE 24th International Requirements Engineering Conference (RE). IEEE.
2. Maro, S., Anjorin A., Wohlrab R. and Steghöfer, JP., 2016, September. Traceability Maintenance: Factors and Guidelines. In Automated Software Engineering (ASE), 2016 31st IEEE/ACM International Conference. IEEE.
diff --git a/org.eclipse.capra.documentation/images/traceMetamodelDefinition.png b/org.eclipse.capra.documentation/images/traceMetamodelDefinition.png
new file mode 100644
index 0000000..1c8d670
--- /dev/null
+++ b/org.eclipse.capra.documentation/images/traceMetamodelDefinition.png
Binary files differ
diff --git a/org.eclipse.capra.documentation/mainTOC.xml b/org.eclipse.capra.documentation/mainTOC.xml
index 2147aef..24976e9 100644
--- a/org.eclipse.capra.documentation/mainTOC.xml
+++ b/org.eclipse.capra.documentation/mainTOC.xml
@@ -1,6 +1,4 @@
<toc label="Capra Documentation">
-<link toc="toc/capra_Documentation.xml"/>
-<anchor id="capraDocumentation"/>
<topic href="docu/capraDocumentation.html#user-guide" label="User Guide">
<link toc="toc/capra_Documentation.xml"/>
@@ -13,6 +11,6 @@
<link toc="toc/capra_Documentation.xml"/>
<topic href="docu/capraDocumentation.html#architecture-of-capra" label="Architecture of Capra"></topic>
<topic href="docu/capraDocumentation.html#capra-api" label="Capra API"></topic>
-<topic href="docu/capraDocumentation.html#rerefences" label="Rerefences"></topic>
+<topic href="docu/capraDocumentation.html#references" label="Rerefences"></topic>
</topic>
-</toc>
\ No newline at end of file
+</toc>
