[doc] Consistency of addon documentation sections (#139)

Change-Id: Ie53495f57f07cdcc1cd1169f73befe165c059353 Signed-off-by: claudiasima <claudia.sima@thalesgroup.com>
eclipse-capella · May 24, 2021 · f55343e · f55343e
1 parent 909b27e
commit f55343e
Show file tree

Hide file tree

Showing 30 changed files with 211 additions and 93 deletions.
diff --git a/plugins/org.polarsys.capella.vp.requirements.doc/.settings/org.eclipse.core.resources.prefs b/plugins/org.polarsys.capella.vp.requirements.doc/.settings/org.eclipse.core.resources.prefs
@@ -1,8 +1,10 @@
 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/1_releasenotes/Knownissues.html=UTF-8
+encoding//html/1_releasenotes/Limitations.html=UTF-8
+encoding//html/1_releasenotes/TeamForCapella.html=UTF-8
+encoding//html/1_releasenotes/Whatsnew.html=UTF-8
+encoding//html/2_installation/2_installation.html=UTF-8
+encoding//html/3_userguide/1_gettingstarted.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
@@ -15,6 +17,6 @@ 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
+encoding//html/4_programmerguide/21_architectureoverview.html=UTF-8
+encoding//html/4_programmerguide/22_metamodels.html=UTF-8
+encoding//html/4_programmerguide/23_extensionpoints.html=UTF-8
diff --git a/...c/html/4_knownissues/4.2_knownissues.html → ....doc/html/1_releasenotes/Knownissues.html b/...c/html/4_knownissues/4.2_knownissues.html → ....doc/html/1_releasenotes/Knownissues.html
@@ -10,7 +10,7 @@ <h1 id="Known_Issues">Known Issues</h1>
 		<p>Retrieve all known issues by following this link.</p>
 		<ul>
 			<li>
-				<a href="https://github.com/eclipse/capella-requirements-vp/issues">Known issues</a>
+				<a href="https://github.com/eclipse/capella-requirements-vp/issues" target="_blank">Known issues</a>
 			</li>
 		</ul>
 	</body>

diff --git a/....polarsys.capella.vp.requirements.doc/html/1_releasenotes/Knownissues.mediawiki b/....polarsys.capella.vp.requirements.doc/html/1_releasenotes/Knownissues.mediawiki
@@ -0,0 +1,17 @@
+<!--
+	Copyright (c) 2021 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
+-->
+= Known Issues = 
+
+Retrieve all known issues by following this link.
+
+* [https://github.com/eclipse/capella-requirements-vp/issues Known issues]
diff --git a/...c/html/4_knownissues/4.1_limitations.html → ....doc/html/1_releasenotes/Limitations.html b/...c/html/4_knownissues/4.1_limitations.html → ....doc/html/1_releasenotes/Limitations.html
diff --git a/...l/4_knownissues/4.1_limitations.mediawiki → ...html/1_releasenotes/Limitations.mediawiki b/...l/4_knownissues/4.1_limitations.mediawiki → ...html/1_releasenotes/Limitations.mediawiki
@@ -1,3 +1,15 @@
+<!--
+	Copyright (c) 2021 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
+-->
 = Limitations = 
 
 == No compatiblity with previous prototypes ==

diff --git a/.../html/4_knownissues/4.3_team4capella.html → ...c/html/1_releasenotes/TeamForCapella.html b/.../html/4_knownissues/4.3_team4capella.html → ...c/html/1_releasenotes/TeamForCapella.html
diff --git a/.../4_knownissues/4.3_team4capella.mediawiki → ...l/1_releasenotes/TeamForCapella.mediawiki b/.../4_knownissues/4.3_team4capella.mediawiki → ...l/1_releasenotes/TeamForCapella.mediawiki
@@ -1,3 +1,15 @@
+<!--
+	Copyright (c) 2021 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
+-->
 = Team for Capella = 
 
 In the context of Team for Capella product, the import from a connected project is not supported

diff --git a/plugins/org.polarsys.capella.vp.requirements.doc/html/1_releasenotes/Whatsnew.html b/plugins/org.polarsys.capella.vp.requirements.doc/html/1_releasenotes/Whatsnew.html
@@ -0,0 +1,17 @@
+<?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>What's new</title>
+	</head>
+	<body>
+		<h1 id="What.27s_new">What's new</h1>
+		<p>Release notes describing enhancements and fixes done per release are available online on each dedicated release pages.</p>
+		<ul>
+			<li>
+				<a href="https://github.com/eclipse/capella-requirements-vp/releases" target="_blank">Requirements releases</a>
+			</li>
+		</ul>
+	</body>
+</html>
diff --git a/...org.polarsys.capella.vp.requirements.doc/html/1_releasenotes/Whatsnew.mediawiki b/...org.polarsys.capella.vp.requirements.doc/html/1_releasenotes/Whatsnew.mediawiki
@@ -0,0 +1,17 @@
+<!--
+	Copyright (c) 2021 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
+-->
+= What's new =
+
+Release notes describing enhancements and fixes done per release are available online on each dedicated release pages.
+
+* [https://github.com/eclipse/capella-requirements-vp/releases Requirements releases]
diff --git a/plugins/org.polarsys.capella.vp.requirements.doc/html/2_installation/2_installation.html b/plugins/org.polarsys.capella.vp.requirements.doc/html/2_installation/2_installation.html
@@ -0,0 +1,21 @@
+<?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=utf-8"/>
+		<title>Installation and Uninstallation</title>
+		<link type="text/css" rel="stylesheet" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css"/>
+	</head>
+	<body>
+		<h1 id="Installation_and_Uninstallation">Installation and Uninstallation</h1>
+		<p>Install Capella as described 
+			<a href="/wiki/../help/topic/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.html" title="../help/topic/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.html">here</a><span class="github-link">
+
+			<a href="/wiki/https://github.com/eclipse/capella/blob/master/doc/plugins/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.mediawiki" title="https://github.com/eclipse/capella/blob/master/doc/plugins/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.mediawiki">(online documentation)</a></span>.
+		</p>
+		<p>To install the Requirements Viewpoint read the 
+			<a href="/wiki/../help/topic/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.html?#Configuration_and_Extensibility" title="../help/topic/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.html?#Configuration_and_Extensibility">Configuration and Extensibility</a>
+<span class="github-link">
+			<a href="/wiki/https://github.com/eclipse/capella/blob/master/doc/plugins/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.mediawiki#Configuration_and_Extensibility" title="https://github.com/eclipse/capella/blob/master/doc/plugins/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.mediawiki#Configuration_and_Extensibility">(online documentation)</a></span> section.
+		</p>
+	</body>
+</html>
diff --git a/...larsys.capella.vp.requirements.doc/html/2_installation/2_installation.mediawiki b/...larsys.capella.vp.requirements.doc/html/2_installation/2_installation.mediawiki
@@ -0,0 +1,20 @@
+<!--
+	Copyright (c) 2021 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
+-->
+=Installation and Uninstallation=
+
+Install Capella as described [[../help/topic/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.html | here]]<span class="github-link">
+[[https://github.com/eclipse/capella/blob/master/doc/plugins/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.mediawiki|(online documentation)]]</span>.
+
+
+To install the Requirements Viewpoint read the [[../help/topic/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.html?#Configuration_and_Extensibility | Configuration and Extensibility]]
+<span class="github-link">[[https://github.com/eclipse/capella/blob/master/doc/plugins/org.polarsys.capella.ui.doc/html/Installation%20Guide/How%20to%20install%20Capella%20and%20Addons.mediawiki#Configuration_and_Extensibility|(online documentation)]]</span> section.
diff --git a/...la.vp.requirements.doc/html/2_programmerguide/21_architectureoverview.mediawiki b/...la.vp.requirements.doc/html/2_programmerguide/21_architectureoverview.mediawiki
diff --git a/...capella.vp.requirements.doc/html/2_programmerguide/23_extensionpoints.mediawiki b/...capella.vp.requirements.doc/html/2_programmerguide/23_extensionpoints.mediawiki
diff --git a/...ml/1_gettingstarted/1_gettingstarted.html → ...oc/html/3_userguide/1_gettingstarted.html b/...ml/1_gettingstarted/1_gettingstarted.html → ...oc/html/3_userguide/1_gettingstarted.html
@@ -3,10 +3,10 @@
 	<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>
+		<title>Introduction</title>
 	</head>
 	<body>
-		<h1 id="Getting_Started">Getting Started</h1>
+		<h1 id="Introduction">Introduction</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>

diff --git a/...gettingstarted/1_gettingstarted.mediawiki → ...ml/3_userguide/1_gettingstarted.mediawiki b/...gettingstarted/1_gettingstarted.mediawiki → ...ml/3_userguide/1_gettingstarted.mediawiki
@@ -1,4 +1,4 @@
-= Getting Started = 
+= Introduction = 
 
 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.

diff --git a/plugins/org.polarsys.capella.vp.requirements.doc/html/3_userguide/35_propertiesview.html b/plugins/org.polarsys.capella.vp.requirements.doc/html/3_userguide/35_propertiesview.html
@@ -55,10 +55,10 @@ <h2 id="Relations_between_elements_stored_in_different_layers">Relations between
 			<li>For incoming links, source elements are limited to those stored in the current layer and the lower ones</li>
 			<li>For internal links, target elements are limited to those stored in the current layer and the upper ones</li>
 		</ol>
-		<p>
-			<i>Some limitations should be noted for Libraries (see the suitable part of 
-				<a href="/wiki/../help/topic/org.polarsys.capella.vp.requirements.doc/html/4_knownissues/4.1_limitations.html" title="../help/topic/org.polarsys.capella.vp.requirements.doc/html/4_knownissues/4.1_limitations.html">Limitations</a> section).
-			</i>
+		<p>''Some limitations should be noted for Libraries (see the suitable part of 
+			<a href="/wiki/../help/topic/org.polarsys.capella.vp.requirements.doc/html/1_releasenotes/Limitations.html" title="../help/topic/org.polarsys.capella.vp.requirements.doc/html/1_releasenotes/Limitations.html">Limitations</a> <span class="github-link">
+
+			<a href="/wiki/../1_releasenotes/Limitations.mediawiki" title="../1_releasenotes/Limitations.mediawiki">(online documentation)</a></span> section).''
 
 			<br/>
 

diff --git a/...larsys.capella.vp.requirements.doc/html/3_userguide/35_propertiesview.mediawiki b/...larsys.capella.vp.requirements.doc/html/3_userguide/35_propertiesview.mediawiki
@@ -46,7 +46,8 @@ Certain rules are applied when creating relations between Requirements and Capel
 # For incoming links, source elements are limited to those stored in the current layer and the lower ones
 # For internal links, target elements are limited to those stored in the current layer and the upper ones
 
-''Some limitations should be noted for Libraries (see the suitable part of [[../help/topic/org.polarsys.capella.vp.requirements.doc/html/4_knownissues/4.1_limitations.html|Limitations]] section).''
+''Some limitations should be noted for Libraries (see the suitable part of [[../help/topic/org.polarsys.capella.vp.requirements.doc/html/1_releasenotes/Limitations.html|Limitations]] <span class="github-link">
+[[../1_releasenotes/Limitations.mediawiki|(online documentation)]]</span> section).''
 <br/>
 <br/>
 

diff --git a/...larsys.capella.vp.requirements.doc/html/4_knownissues/4.2_knownissues.mediawiki b/...larsys.capella.vp.requirements.doc/html/4_knownissues/4.2_knownissues.mediawiki
diff --git a/...grammerguide/21_architectureoverview.html → ...grammerguide/21_architectureoverview.html b/...grammerguide/21_architectureoverview.html → ...grammerguide/21_architectureoverview.html
diff --git a/...la.vp.requirements.doc/html/4_programmerguide/21_architectureoverview.mediawiki b/...la.vp.requirements.doc/html/4_programmerguide/21_architectureoverview.mediawiki
@@ -0,0 +1,18 @@
+<!--
+	Copyright (c) 2021 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
+-->
+= Architecture Overview = 
+
+The image below presents the architecture overview of the ReqIF importer for Capella.
+
+[[Image:../../images/overview.png]]
+
diff --git a/...html/2_programmerguide/22_metamodels.html → ...html/4_programmerguide/22_metamodels.html b/...html/2_programmerguide/22_metamodels.html → ...html/4_programmerguide/22_metamodels.html
diff --git a/...2_programmerguide/22_metamodels.mediawiki → ...4_programmerguide/22_metamodels.mediawiki b/...2_programmerguide/22_metamodels.mediawiki → ...4_programmerguide/22_metamodels.mediawiki
@@ -1,3 +1,15 @@
+<!--
+	Copyright (c) 2021 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
+-->
 = Meta-Models = 
 
 The generic part of the requirements meta-model only depends on ECore.

diff --git a/...2_programmerguide/23_extensionpoints.html → ...4_programmerguide/23_extensionpoints.html b/...2_programmerguide/23_extensionpoints.html → ...4_programmerguide/23_extensionpoints.html
diff --git a/...capella.vp.requirements.doc/html/4_programmerguide/23_extensionpoints.mediawiki b/...capella.vp.requirements.doc/html/4_programmerguide/23_extensionpoints.mediawiki
@@ -0,0 +1,22 @@
+<!--
+	Copyright (c) 2021 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
+-->
+= 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]]
diff --git a/plugins/org.polarsys.capella.vp.requirements.doc/plugin.xml b/plugins/org.polarsys.capella.vp.requirements.doc/plugin.xml
@@ -18,17 +18,11 @@
             file="toc/index.xml"
             primary="true">
       </toc>
-      <toc
-            file="toc/gettingstarted.xml">
-      </toc>
       <toc
             file="toc/programmerguide.xml">
       </toc>
       <toc
             file="toc/userguide.xml">
       </toc>
-      <toc
-            file="toc/knownissues.xml">
-      </toc>
    </extension>
 </plugin>
diff --git a/plugins/org.polarsys.capella.vp.requirements.doc/toc/gettingstarted.xml b/plugins/org.polarsys.capella.vp.requirements.doc/toc/gettingstarted.xml
diff --git a/plugins/org.polarsys.capella.vp.requirements.doc/toc/index.xml b/plugins/org.polarsys.capella.vp.requirements.doc/toc/index.xml
@@ -11,18 +11,26 @@
   Contributors:
        Thales - initial API and implementation
 -->
-<toc label="Requirements Viewpoint Guide">
-   <topic href="html/1_gettingstarted/1_gettingstarted.html" label="Getting Started">
-      <anchor id="gettingstarted"/>
+<toc label="Requirements Viewpoint Guide" sort="false">
+   <anchor id="requirementsviewpointforcapella"/>
+   <topic label="Release Notes">
+      <anchor id="releasenotes"/>
+      <topic href="html/1_releasenotes/Whatsnew.html" label="What&apos;s new">
+      </topic>
+      <topic href="html/1_releasenotes/KnownIssues.html" label="Known Issues">
+      </topic>
+      <topic href="html/1_releasenotes/Limitations.html" label="Limitations">
+         <topic href="html/1_releasenotes/TeamForCapella.html" label="Team for Capella">
+         </topic>
+      </topic>
    </topic>
-   <topic label="User's Guide">
-      <anchor id="userguide"/>
+   <topic href="html/2_installation/2_installation.html" label="Installation and Uninstallation">
+      <anchor id="installation"/>
    </topic>
-   <topic label="Limitations / Known Issues">
-      <anchor id="knownissues"/>
+   <topic label="User Manual">
+      <anchor id="usermanual"/>
    </topic>
-   <topic label="Programmer's Guide">
+   <topic label="Programmer&apos;s Guide">
       <anchor id="programmerguide"/>
    </topic>
-   <anchor id="requirementsviewpointforcapella"/>
 </toc>
diff --git a/plugins/org.polarsys.capella.vp.requirements.doc/toc/knownissues.xml b/plugins/org.polarsys.capella.vp.requirements.doc/toc/knownissues.xml