Skip to content

Commit

Permalink
#132 Migrate documentation to mediawiki (#133)
Browse files Browse the repository at this point in the history
Change-Id: I488044a1ec8ff47412a597b7aac646e6da3fcb69
Signed-off-by: Philippe DUL <philippe.dul@thalesgroup.com>
Signed-off-by: MalinaStefaniaStoicanescu <malina.stoicanescu@thalesgroup.com>
  • Loading branch information
MalinaStefaniaStoicanescu committed May 18, 2021
1 parent a7e9c94 commit 5ac5359
Show file tree
Hide file tree
Showing 46 changed files with 1,565 additions and 939 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
eclipse.preferences.version=1
encoding//html/1_gettingstarted/1_gettingstarted.html=UTF-8
encoding//html/2_programmerguide/21_architectureoverview.html=UTF-8
encoding//html/2_programmerguide/22_metamodels.html=UTF-8
encoding//html/2_programmerguide/23_extensionpoints.html=UTF-8
encoding//html/3_userguide/310_teamforcapella.html=UTF-8
encoding//html/3_userguide/311_diagrams.html=UTF-8
encoding//html/3_userguide/31_reqifexport.html=UTF-8
encoding//html/3_userguide/32_viewpointmanager.html=UTF-8
encoding//html/3_userguide/33_1_migration.html=UTF-8
encoding//html/3_userguide/33_reqifimport.html=UTF-8
encoding//html/3_userguide/34_preferences.html=UTF-8
encoding//html/3_userguide/35_propertiesview.html=UTF-8
encoding//html/3_userguide/37_semanticbrowser.html=UTF-8
encoding//html/3_userguide/38_validation_rule.html=UTF-8
encoding//html/3_userguide/39_commandline.html=UTF-8
encoding//html/3_userguide/3a_edition.html=UTF-8
encoding//html/4_knownissues/4.1_limitations.html=UTF-8
encoding//html/4_knownissues/4.2_knownissues.html=UTF-8
encoding//html/4_knownissues/4.3_team4capella.html=UTF-8
42 changes: 42 additions & 0 deletions plugins/org.polarsys.capella.vp.requirements.doc/build.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright (c) 2006, 2020 THALES GLOBAL SERVICES.
This program and the accompanying materials are made available under the
terms of the Eclipse Public License 2.0 which is available at
http://www.eclipse.org/legal/epl-2.0
SPDX-License-Identifier: EPL-2.0
Contributors:
Thales - initial API and implementation
-->

<project name="project" default="generate-html">

<!-- This property should be set to the path to wikitext standalone package or it can be run inside the current eclipse
platform if it contains mylyn/mediawiki plugins.
Set to ${eclipse.home}/plugins and run the build.xml with the following option checked
RunAs/ExternalToolsConfiguration/JRE/RunInTheSameJREThanWorkspace
-->
<property name="wikitext.standalone" value="${eclipse.home}/plugins"/>

<path id="wikitext.classpath">
<fileset dir="${wikitext.standalone}">
<include name="*.jar"/>
</fileset>
</path>

<taskdef classpathref="wikitext.classpath" resource="org/eclipse/mylyn/wikitext/ant/tasks.properties" />

<target name="generate-html" description="Generate HTML from textile source">
<wikitext-to-html markupLanguage="MediaWiki" formatOutput="true" defaultAbsoluteLinkTarget="_blank">
<fileset dir="${basedir}">
<include name="**/*.mediawiki"/>
</fileset>
<stylesheet url="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css" />
</wikitext-to-html>
</target>

</project>
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<link rel="stylesheet" type="text/css" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css" media="all"/>
<title>Getting Started</title>
</head>
<body>
<h1>Getting Started</h1>

<p>
The Requirements Viewpoint for Capella allows importing a set of requirements from a ReqIF file.<br/>
This file shall be exported from IBM Doors or any other requirement tool supporting the ReqIF OMG standard.
</p>
<p>
<strong>Note:</strong> Capella provides also Legacy Capella requirements (Right click, Add Element "Requirement Package"), but there is no relation with this advanced Requirement Viewpoint. For a next Major Release to plan, these Legacy Requirements will be removed from Capella and migrated to this new Viewpoint requirements through a dedicated migration tooling and, then, no more available within Capella core.
</p>

</body>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<link rel="stylesheet" type="text/css" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css" media="all"/>
<title>Getting Started</title>
</head>
<body>
<h1 id="Getting_Started">Getting Started</h1>
<p>The Requirements Viewpoint for Capella allows importing a set of requirements from a ReqIF file.
This file shall be exported from IBM Doors or any other requirement tool supporting the ReqIF OMG standard.</p>
<p><b>Note:</b> Capella provides also Legacy Capella requirements (Right click, Add Element "Requirement Package"), but there is no relation with this advanced Requirement Viewpoint. For a next Major Release to plan, these Legacy Requirements will be removed from Capella and migrated to this new Viewpoint requirements through a dedicated migration tooling and, then, no more available within Capella core.</p>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
= Getting Started =

The Requirements Viewpoint for Capella allows importing a set of requirements from a ReqIF file.
This file shall be exported from IBM Doors or any other requirement tool supporting the ReqIF OMG standard.

<b>Note:</b> Capella provides also Legacy Capella requirements (Right click, Add Element "Requirement Package"), but there is no relation with this advanced Requirement Viewpoint. For a next Major Release to plan, these Legacy Requirements will be removed from Capella and migrated to this new Viewpoint requirements through a dedicated migration tooling and, then, no more available within Capella core.

Original file line number Diff line number Diff line change
@@ -1,18 +1,15 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<link rel="stylesheet" type="text/css" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css" media="all"/>
<title>Architecture Overview</title>
</head>
<body>
<h1>Architecture Overview</h1>

<p>
The image below presents the architecture overview of the ReqIF importer for Capella.
</p>

<img src="../../images/overview.png" alt="Architecture Overview" title="Architecture Overview" height="80%"/>

</body>
<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<link rel="stylesheet" type="text/css" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css" media="all"/>
<title>Architecture Overview</title>
</head>
<body>
<h1 id="Architecture_Overview">Architecture Overview</h1>
<p>The image below presents the architecture overview of the ReqIF importer for Capella.</p>
<p>
<img border="0" src="../../images/overview.png"/>
</p>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
= Architecture Overview =

The image below presents the architecture overview of the ReqIF importer for Capella.

[[Image:../../images/overview.png]]

Original file line number Diff line number Diff line change
@@ -1,48 +1,35 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<link rel="stylesheet" type="text/css" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css" media="all"/>
<title>Meta-Models</title>
</head>
<body>
<h1>Meta-Models</h1>

<p>
The generic part of the requirements meta-model only depends on ECore.
</p>

<img src="../../images/metamodels/Requirements_package_dependencies.jpg" alt="Requirements package dependencies" title="Requirements package dependencies"/>

<p>
This class diagram shows the main concepts and relations related to the Requirements.
</p>

<img src="../../images/metamodels/Requirements_class_diagram.jpg" alt="Requirements class diagram" title="Requirements class diagram"/>

<p>
This class diagram shows the concepts and relations related to the Type Definitions.
</p>

<img src="../../images/metamodels/TypeDefinitions_class_diagram.jpg" alt="Type Definitions class diagram" title="Type Definitions class diagram"/>

<p>
This class diagram shows the concepts and relations related to the Enumerations.
</p>

<img src="../../images/metamodels/Enumerations_class_diagram.jpg" alt="Enumerations class diagram" title="Enumerations class diagram"/>

<p>
The Capella specific part of the requirements meta-model depends on eMDE and Capella.
</p>

<img src="../../images/metamodels/CapellaRequirements_package_dependencies.jpg" alt="Capella Requirements package dependencies" title="Capella Requirements package dependencies"/>

<p>
This class diagram shows how the requirement concepts of the generic meta-model are linked to Capella.
</p>

<img src="../../images/metamodels/CapellaRequirements_class_diagram.jpg" alt="Capella Requirements class diagram" title="Capella Requirements class diagram"/>

</body>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<link rel="stylesheet" type="text/css" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css" media="all"/>
<title>Meta-Models</title>
</head>
<body>
<h1 id="Meta-Models">Meta-Models</h1>
<p>The generic part of the requirements meta-model only depends on ECore.</p>
<p>
<img border="0" src="../../images/metamodels/Requirements_package_dependencies.jpg"/>
</p>
<p>This class diagram shows the main concepts and relations related to the Requirements.</p>
<p>
<img border="0" src="../../images/metamodels/Requirements_class_diagram.jpg"/>
</p>
<p>This class diagram shows the concepts and relations related to the Type Definitions.</p>
<p>
<img border="0" src="../../images/metamodels/TypeDefinitions_class_diagram.jpg"/>
</p>
<p>This class diagram shows the concepts and relations related to the Enumerations.</p>
<p>
<img border="0" src="../../images/metamodels/Enumerations_class_diagram.jpg"/>
</p>
<p>The Capella specific part of the requirements meta-model depends on eMDE and Capella.</p>
<p>
<img border="0" src="../../images/metamodels/CapellaRequirements_package_dependencies.jpg"/>
</p>
<p>This class diagram shows how the requirement concepts of the generic meta-model are linked to Capella.</p>
<p>
<img border="0" src="../../images/metamodels/CapellaRequirements_class_diagram.jpg"/>
</p>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
= Meta-Models =

The generic part of the requirements meta-model only depends on ECore.

[[Image:../../images/metamodels/Requirements_package_dependencies.jpg]]

This class diagram shows the main concepts and relations related to the Requirements.

[[Image:../../images/metamodels/Requirements_class_diagram.jpg]]

This class diagram shows the concepts and relations related to the Type Definitions.

[[Image:../../images/metamodels/TypeDefinitions_class_diagram.jpg]]

This class diagram shows the concepts and relations related to the Enumerations.

[[Image:../../images/metamodels/Enumerations_class_diagram.jpg]]

The Capella specific part of the requirements meta-model depends on eMDE and Capella.

[[Image:../../images/metamodels/CapellaRequirements_package_dependencies.jpg]]

This class diagram shows how the requirement concepts of the generic meta-model are linked to Capella.

[[Image:../../images/metamodels/CapellaRequirements_class_diagram.jpg]]

Original file line number Diff line number Diff line change
@@ -1,19 +1,24 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<link rel="stylesheet" type="text/css" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css" media="all"/>
<title>Extension Points</title>
</head>
<body>
<h1>Extension Points</h1>

The following extension points can be used to extend the capabilities of the Capella Requirements Viewpoint.

<h2>Importer</h2>
<ul>
<li><a href="PLUGINS_ROOT/org.polarsys.capella.vp.requirements.importer.extension/schema/doc/org_polarsys_capella_vp_requirements_importer_extension_attributesProvider.html">org.polarsys.capella.vp.requirements.importer.extension.attributesProvider</a></li>
</ul>

</body>
<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<link rel="stylesheet" type="text/css" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css" media="all"/>
<title>Extension Points</title>
</head>
<body>
<h1 id="Extension_Points">Extension Points</h1>
<p>The following extension points can be used to extend the capabilities of the Capella Requirements Viewpoint.</p>
<h2 id="Importer">Importer</h2>
<ol>
<li>
<b>"org.polarsys.capella.vp.requirements.importer.extension.attributesProvider"</b>
</li>
</ol>
<dl>
<dd>This extension point allows to extend the scope of the importer.</dd>
<dd>
<img border="0" src="../../images/extension_point.png"/>
</dd>
</dl>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
= Extension Points =

The following extension points can be used to extend the capabilities of the Capella Requirements Viewpoint.

== Importer ==

# '''"org.polarsys.capella.vp.requirements.importer.extension.attributesProvider"'''
: This extension point allows to extend the scope of the importer.
: [[Image:../../images/extension_point.png]]

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<link rel="stylesheet" type="text/css" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css" media="all"/>
<title>Team for Capella</title>
</head>
<body>
<h1>Team for Capella</h1>
<p>This add-on is compatible with Team for Capella product, allowing collaborative requirement allocations to model elements and representations.</p>
</body>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<link rel="stylesheet" type="text/css" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css" media="all"/>
<title>Team for Capella</title>
</head>
<body>
<h1 id="Team_for_Capella">Team for Capella</h1>
<p>This add-on is compatible with Team for Capella product, allowing collaborative requirement allocations to model elements and representations.</p>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
= Team for Capella =
This add-on is compatible with Team for Capella product, allowing collaborative requirement allocations to model elements and representations.

0 comments on commit 5ac5359

Please sign in to comment.