diff options
author | ptessier | 2015-02-11 14:18:14 +0000 |
---|---|---|
committer | ptessier | 2015-02-11 14:18:14 +0000 |
commit | e9e1c43f854496e129c020452d1f50840b6d500a (patch) | |
tree | 4e03bf44c77e214f9bfb92bb3f34b22ac8dbc6a8 /plugins/doc | |
parent | c08c5e3eaf3974fb24adeccb251af266b218d7a9 (diff) | |
download | org.eclipse.papyrus-e9e1c43f854496e129c020452d1f50840b6d500a.tar.gz org.eclipse.papyrus-e9e1c43f854496e129c020452d1f50840b6d500a.tar.xz org.eclipse.papyrus-e9e1c43f854496e129c020452d1f50840b6d500a.zip |
447870: [Papyrus Req] Papyrus shall import or export reqIF file
https://bugs.eclipse.org/bugs/show_bug.cgi?id=447870
Change-Id: I18af2bdc6c21fbce6e1b159b6cae17739fd56bc8
Diffstat (limited to 'plugins/doc')
36 files changed, 331 insertions, 0 deletions
diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.classpath b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.classpath new file mode 100644 index 00000000000..8a8f1668cdc --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.classpath @@ -0,0 +1,7 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+ <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/>
+ <classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
+ <classpathentry kind="src" path="src"/>
+ <classpathentry kind="output" path="bin"/>
+</classpath>
diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.project b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.project new file mode 100644 index 00000000000..f5b8a7b60c4 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.project @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>org.eclipse.papyrus.req.reqif.doc</name>
+ <comment></comment>
+ <projects>
+ </projects>
+ <buildSpec>
+ <buildCommand>
+ <name>org.eclipse.jdt.core.javabuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.pde.ManifestBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.pde.SchemaBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ </buildSpec>
+ <natures>
+ <nature>org.eclipse.pde.PluginNature</nature>
+ <nature>org.eclipse.jdt.core.javanature</nature>
+ </natures>
+</projectDescription>
diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.settings/org.eclipse.core.resources.prefs b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.settings/org.eclipse.core.resources.prefs new file mode 100644 index 00000000000..2b3add74f34 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.settings/org.eclipse.core.resources.prefs @@ -0,0 +1,3 @@ +eclipse.preferences.version=1
+encoding//resource/reqif-toc.xml=utf-8
+encoding//resource/reqif.html=utf-8
diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.settings/org.eclipse.jdt.core.prefs b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.settings/org.eclipse.jdt.core.prefs new file mode 100644 index 00000000000..f287d53cf45 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,7 @@ +eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6
+org.eclipse.jdt.core.compiler.compliance=1.6
+org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.source=1.6
diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/META-INF/MANIFEST.MF b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/META-INF/MANIFEST.MF new file mode 100644 index 00000000000..92d6347c9e6 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/META-INF/MANIFEST.MF @@ -0,0 +1,13 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: %pluginName +Bundle-SymbolicName: org.eclipse.papyrus.req.reqif.doc;singleton:=true +Bundle-Version: 1.1.0.qualifier +Bundle-Activator: org.eclipse.papyrus.req.reqif.doc.Activator +Require-Bundle: org.eclipse.ui,
+ org.eclipse.core.runtime +Bundle-RequiredExecutionEnvironment: JavaSE-1.6 +Bundle-ActivationPolicy: lazy +Bundle-Vendor: %providerName +Bundle-Localization: plugin +Bundle-Description: This is the plugin that present the user documentation of the ReqIF import diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/about.html b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/about.html new file mode 100644 index 00000000000..82d49bf5f81 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/about.html @@ -0,0 +1,28 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/>
+<title>About</title>
+</head>
+<body lang="EN-US">
+<h2>About This Content</h2>
+
+<p>June 5, 2007</p>
+<h3>License</h3>
+
+<p>The Eclipse Foundation makes available all content in this plug-in ("Content"). Unless otherwise
+indicated below, the Content is provided to you under the terms and conditions of the
+Eclipse Public License Version 1.0 ("EPL"). A copy of the EPL is available
+at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.
+For purposes of the EPL, "Program" will mean the Content.</p>
+
+<p>If you did not receive this Content directly from the Eclipse Foundation, the Content is
+being redistributed by another party ("Redistributor") and different terms and conditions may
+apply to your use of any object code in the Content. Check the Redistributor's license that was
+provided with the Content. If no such license exists, contact the Redistributor. Unless otherwise
+indicated below, the terms and conditions of the EPL still apply to any source code in the Content
+and such source code may be obtained at <a href="http://www.eclipse.org/">http://www.eclipse.org</a>.</p>
+
+</body>
+</html>
diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/plugin.properties b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/plugin.properties new file mode 100644 index 00000000000..c5f01295549 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/plugin.properties @@ -0,0 +1,12 @@ +################################################################################# +# Copyright (c) 2008 CEA LIST. +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Eclipse Public License v1.0 +# which accompanies this distribution, and is available at +# http://www.eclipse.org/legal/epl-v10.html +# +# Contributors: +# Patrick Tessier (CEA LIST) Patrick.tessier@cea.fr - initial API and implementation +################################################################################## +pluginName=PapyrusReq.ReqIF doc +providerName=Eclipse Modeling Project diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/plugin.xml new file mode 100644 index 00000000000..5e6625a9d0c --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/plugin.xml @@ -0,0 +1,15 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<?eclipse version="3.4"?>
+<plugin>
+ <extension
+ point="org.eclipse.help.toc">
+ <toc
+ file="resource/reqif-main-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="resource/reqif-toc.xml"
+ primary="false">
+ </toc>
+ </extension>
+</plugin>
diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/pom.xml new file mode 100644 index 00000000000..2d419b0ed82 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/pom.xml @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project> + <modelVersion>4.0.0</modelVersion> + <parent> + <artifactId>org.eclipse.papyrus</artifactId> + <groupId>org.eclipse.papyrus</groupId> + <version>1.1.0-SNAPSHOT</version> + <relativePath>../../../releng/top-pom-main.xml</relativePath> + </parent> + <artifactId>org.eclipse.papyrus.req.reqif.doc</artifactId> + <groupId>org.eclipse.papyrus</groupId> + <version>1.1.0-SNAPSHOT</version> + <packaging>eclipse-plugin</packaging> +</project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/DeveloperDoc.mediawiki b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/DeveloperDoc.mediawiki new file mode 100644 index 00000000000..136ae6a7ea1 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/DeveloperDoc.mediawiki @@ -0,0 +1,107 @@ + + += Import Export of ReqIF elements into Papyrus = +<span id="_joeEYLH0EeSvo7o7Iu6GQQ">This model explains the functionality in Papyrus Req in order to import or export ReqIF files into Papyrus (OMG Document Number: formal/2013-10-01 Standard document URL: http://www.omg.org/spec/ReqIF/1.1) +</span> + +==<span id="_johHsbH0EeSvo7o7Iu6GQQ">Requirements</span>== +<span id="_jokyELH0EeSvo7o7Iu6GQQ">- ReqIfImport (id=ReqIF_001): + Darwin shall allow importation of Reqif elements to SysML Model</span> +<span id="_jon1YLH0EeSvo7o7Iu6GQQ">- Import SpecObjects (id=ReqIF_001_001): + The user shall be able to import spec object</span> +<span id="_joq4sLH0EeSvo7o7Iu6GQQ">- Two Kind of Users (id=ReqIF_001_002): + The simple User can only import SpecObject by choosing domain. The AdvancedUser can import Types and DataTypes. </span> +<span id="_jotU8LH0EeSvo7o7Iu6GQQ">- Import DataType Enumeration (id=ReqIF_001_003): + The advanced user shall be able to import DataType and enumeration</span> +<span id="_jovxMLH0EeSvo7o7Iu6GQQ">- Import SpecObjectTypes (id=ReqIF_001_004): + The advanced user shall be able to import specObjectType</span> +<span id="_joxmYLH0EeSvo7o7Iu6GQQ">- Import SpecRelationType (id=ReqIF_001_005): + The advanced user shall be able to import SpecRelationType</span> +<span id="_jozbkLH0EeSvo7o7Iu6GQQ">- Import SpecRelation (id=ReqIF_001_006): + Papyrus Req shall import SpecRelation</span> +<span id="_jo130LH0EeSvo7o7Iu6GQQ">- ReqIFExport (id=ReqIF_002): + Darwin shall enable export of SysML requirement to ReqIF Model</span> +<span id="_jo3tALH0EeSvo7o7Iu6GQQ">- ControlMode (id=ReqIF_003): + The managment with ReqIf must support Control Mode</span> +<span id="_jo6JQLH0EeSvo7o7Iu6GQQ">- WihtoutUI (id=ReqIF_004): + The export can be done programmatically, without GUI, in order to test it, or to be enable to pilot it programmatically</span> +<span id="_jo8lgLH0EeSvo7o7Iu6GQQ">- Re-Export (id=ReqIF_005): + Papyrus shall re-export requirements in existing reqIF file</span> +<span id="_jo-asLH0EeSvo7o7Iu6GQQ">- Re-Import (id=ReqIF_006): + Papyrus shall re-Import requirement from a ReqIF file</span> +==<span id="_jo_o0bH0EeSvo7o7Iu6GQQ">Use Cases</span>== + +====<span id="_jryeIbH0EeSvo7o7Iu6GQQ">Import ReqIF file</span>==== + +<span id="_jwVm8LH0EeSvo7o7Iu6GQQ">Before import requirement fro ReqIF file, the kinf of User has to be verified. + +There are two kind of users: + + - Simple User: he can only import instance of requirements inside the Papyrus tool. + + - Advancerd User: he can importe new types of requirements and instance of requirement inside the Papyrus tool + +To verify it, go to window--> preferences--> Papyrus--> ReqIF Import</span> + +[[Image:./imgDOC/Userkind.png|Two kinds of user]]<br> + +<span id="_jwXcIbH0EeSvo7o7Iu6GQQ">First the User must have a SysML model. Select the package where ReqIF elements will be imported. +</span> + +[[Image:./imgDOC/import_1.png|Import SysMLModel]]<br> + +<span id="_jwZ4YbH0EeSvo7o7Iu6GQQ">Select the menu Import of Eclipse.</span> + +[[Image:./imgDOC/import_2.png|Select import Menu of Eclipse]]<br> + +<span id="_jwcUobH0EeSvo7o7Iu6GQQ">Select the menu Import ReqIF from Papyrus Categories</span> + +[[Image:./imgDOC/import_3.png|Import ReqIF]]<br> + +<span id="_jwew4bH0EeSvo7o7Iu6GQQ">Select the ReqIF file to import</span> + +[[Image:./imgDOC/import_4.png|ReqIF file Selection]]<br> + +<span id="_jwhNILH0EeSvo7o7Iu6GQQ">Select Requirement types of ReqIF file that you want to import</span> + +[[Image:./imgDOC/import_5.png|SpecObject Type selection]]<br> + +<span id="_jwjCUbH0EeSvo7o7Iu6GQQ">When the current user is an "Advanced User", he can import Requirement types and all requirements from ReqIF , if needed he can select or create the profile that will contain imported types</span> + +[[Image:./imgDOC/import_6.png|Create or select Profile]]<br> + +<span id="_jwlekbH0EeSvo7o7Iu6GQQ">When the current user is a "Simple User", he can only import instances of requirements by choosen predefined types contained in the profile. +If the profile does not contain all needed types, the import is not done and a message is displayed on the screen. </span> + +[[Image:./imgDOC/Choose_Predefined_Profile.png|Choose predefined type contained in profile]]<br> + +[[Image:./imgDOC/CannotImport.png|The import cannot be done if the profile is not complete.]]<br> + +<span id="_jwpI8bH0EeSvo7o7Iu6GQQ">The model has now imported requirements with relations. Note that a comment explains the origin of the import.</span> + +[[Image:./imgDOC/import7.png|Resulted model]]<br> + + +====<span id="_jwyS4bH0EeSvo7o7Iu6GQQ">Export UML Model to ReqIF File</span>==== + +<span id="_jznkcbH0EeSvo7o7Iu6GQQ">Select the SysML that you want to export +</span> + +[[Image:./imgDOC/export1.png|SysML Model]]<br> + +<span id="_jzqnwbH0EeSvo7o7Iu6GQQ">Select the export Menu from Eclipse menu.</span> + +[[Image:./imgDOC/export2.png|Export Menu]]<br> + +<span id="_jztrELH0EeSvo7o7Iu6GQQ">Select the menu export ReqIF form the papyrus Category</span> + +[[Image:./imgDOC/export3.png|Import ReqIF file]]<br> + +<span id="_jzwHUbH0EeSvo7o7Iu6GQQ">Choose the name of the reqif file.</span> + +[[Image:./imgDOC/export5.png|Choose ReqIF File name]]<br> + +<span id="_jzzKobH0EeSvo7o7Iu6GQQ">At the end, a reqFile is generated. The header has an information that explain that the result comes from UML file. +</span> + +[[Image:./imgDOC/Export4.png|Result in the ReqIf file]]<br> diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/ActivityDiagram.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/ActivityDiagram.png Binary files differnew file mode 100644 index 00000000000..83f93dce02f --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/ActivityDiagram.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Architecture_of_ReqIF_Import-Export.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Architecture_of_ReqIF_Import-Export.png Binary files differnew file mode 100644 index 00000000000..88ca29c47e1 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Architecture_of_ReqIF_Import-Export.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/CannotImport.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/CannotImport.png Binary files differnew file mode 100644 index 00000000000..141507fc140 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/CannotImport.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Choose_Predefined_Profile.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Choose_Predefined_Profile.png Binary files differnew file mode 100644 index 00000000000..75184420307 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Choose_Predefined_Profile.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/ClassDiagram.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/ClassDiagram.png Binary files differnew file mode 100644 index 00000000000..f7a862a4aca --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/ClassDiagram.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Export4.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Export4.png Binary files differnew file mode 100644 index 00000000000..3e1ce645c9b --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Export4.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Export_Activity.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Export_Activity.png Binary files differnew file mode 100644 index 00000000000..4779d9612a9 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Export_Activity.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Import_Activity.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Import_Activity.png Binary files differnew file mode 100644 index 00000000000..9f4907f2826 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Import_Activity.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/UseCaseDiagram.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/UseCaseDiagram.png Binary files differnew file mode 100644 index 00000000000..566521d1065 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/UseCaseDiagram.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/UseCases_Diagram.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/UseCases_Diagram.png Binary files differnew file mode 100644 index 00000000000..7d67ecdf41e --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/UseCases_Diagram.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Userkind.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Userkind.png Binary files differnew file mode 100644 index 00000000000..2ccc675c07f --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Userkind.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export1.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export1.png Binary files differnew file mode 100644 index 00000000000..e2c94205722 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export1.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export2.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export2.png Binary files differnew file mode 100644 index 00000000000..23e146579a5 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export2.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export3.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export3.png Binary files differnew file mode 100644 index 00000000000..ce1ac09917a --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export3.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export5.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export5.png Binary files differnew file mode 100644 index 00000000000..ce1ac09917a --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export5.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import7.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import7.png Binary files differnew file mode 100644 index 00000000000..dbe4a7e8dd9 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import7.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_1.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_1.png Binary files differnew file mode 100644 index 00000000000..5e1326c147d --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_1.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_2.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_2.png Binary files differnew file mode 100644 index 00000000000..0e93c1807ce --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_2.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_3.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_3.png Binary files differnew file mode 100644 index 00000000000..7bc74271c1d --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_3.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_4.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_4.png Binary files differnew file mode 100644 index 00000000000..8715d79fd7c --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_4.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_5.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_5.png Binary files differnew file mode 100644 index 00000000000..c4bfc2781a1 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_5.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_6.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_6.png Binary files differnew file mode 100644 index 00000000000..947e6f80c85 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_6.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif-main-toc.xml b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif-main-toc.xml new file mode 100644 index 00000000000..3454eac4e9a --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif-main-toc.xml @@ -0,0 +1,7 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc label="ReqID Import Export" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> + <topic href="resource/reqif.html" label="ReqIF Import Export"> + <anchor id="ReqIF Import Export"/> + <link toc="resource/reqif-toc.xml"/> + </topic> +</toc> diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif-toc.xml b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif-toc.xml new file mode 100644 index 00000000000..b0755d06852 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif-toc.xml @@ -0,0 +1,10 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc topic="resource/DeveloperDoc.html" label="ReqIF Import Export"> + <topic href="resource/reqif.html" label="Import Export of ReqIF elements into Papyrus"> + <topic href="resource/reqif.html#Requirements" label="Requirements"></topic> + <topic href="resource/reqif.html#Use_Cases" label="Use Cases"> + <topic href="resource/reqif.html#Import_ReqIF_file" label="Import ReqIF file"></topic> + <topic href="resource/reqif.html#Export_UML_Model_to_ReqIF_File" label="Export UML Model to ReqIF File"></topic> + </topic> + </topic> +</toc> diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif.html b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif.html new file mode 100644 index 00000000000..09738368ac3 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif.html @@ -0,0 +1,30 @@ +<?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"/> +</head> +<body> +<h1 id="Import_Export_of_ReqIF_elements_into_Papyrus">Import Export of ReqIF elements into Papyrus</h1> +<p>This model explains the functionality in Papyrus Req in order to import or export ReqIF files into Papyrus (OMG Document Number: formal/2013-10-01 Standard document URL: <a href="http://www.omg.org/spec/ReqIF/1.1">http://www.omg.org/spec/ReqIF/1.1</a>)</p> +<h2 id="Requirements"> +Requirements +</h2> +<p> +- ReqIfImport (id=ReqIF_001): </p><pre>Darwin shall allow importation of Reqif elements to SysML Model + +</pre> +<p>- Import SpecObjects (id=ReqIF_001_001): </p><pre>The user shall be able to import spec object + +</pre><p>- Two Kind of Users (id=ReqIF_001_002): </p><pre>The simple User can only import SpecObject by choosing domain. The AdvancedUser can import Types and DataTypes. +</pre><p>- Import DataType Enumeration (id=ReqIF_001_003): </p><pre>The advanced user shall be able to import DataType and enumeration +</pre><p>- Import SpecObjectTypes (id=ReqIF_001_004): </p><pre>The advanced user shall be able to import specObjectType +</pre><p>- Import SpecRelationType (id=ReqIF_001_005): </p><pre>The advanced user shall be able to import SpecRelationType +</pre><p>- Import SpecRelation (id=ReqIF_001_006): </p><pre>Papyrus Req shall import SpecRelation +</pre><p>- ReqIFExport (id=ReqIF_002): </p><pre>Darwin shall enable export of SysML requirement to ReqIF Model +</pre><p>- ControlMode (id=ReqIF_003): </p><pre>The managment with ReqIf must support Control Mode +</pre><p>- WihtoutUI (id=ReqIF_004): </p><pre>The export can be done programmatically, without GUI, in order to test it, or to be enable to pilot it programmatically +</pre><p>- Re-Export (id=ReqIF_005): </p><pre>Papyrus shall re-export requirements in existing reqIF file +</pre><p>- Re-Import (id=ReqIF_006): </p><pre>Papyrus shall re-Import requirement from a ReqIF file +</pre><h2 id="Use_Cases">Use Cases</h2><h4 id="Import_ReqIF_file">Import ReqIF file</h4><p>Before import requirement fro ReqIF file, the kinf of User has to be verified.</p><p>There are two kind of users:</p><p> - Simple User: he can only import instance of requirements inside the Papyrus tool.</p><p> - Advancerd User: he can importe new types of requirements and instance of requirement inside the Papyrus tool </p><p>To verify it, go to window--> preferences--> Papyrus--> ReqIF Import</p><p><img title="Two kinds of user" alt="Two kinds of user" border="0" src="./imgDOC/Userkind.png"/><br/></p><p>First the User must have a SysML model. Select the package where ReqIF elements will be imported. +</p><p><img title="Import SysMLModel" alt="Import SysMLModel" border="0" src="./imgDOC/import_1.png"/><br/></p><p>Select the menu Import of Eclipse.</p><p><img title="Select import Menu of Eclipse" alt="Select import Menu of Eclipse" border="0" src="./imgDOC/import_2.png"/><br/></p><p>Select the menu Import ReqIF from Papyrus Categories</p><p><img title="Import ReqIF" alt="Import ReqIF" border="0" src="./imgDOC/import_3.png"/><br/></p><p>Select the ReqIF file to import</p><p><img title="ReqIF file Selection" alt="ReqIF file Selection" border="0" src="./imgDOC/import_4.png"/><br/></p><p>Select Requirement types of ReqIF file that you want to import</p><p><img title="SpecObject Type selection" alt="SpecObject Type selection" border="0" src="./imgDOC/import_5.png"/><br/></p><p>When the current user is an "Advanced User", he can import Requirement types and all requirements from ReqIF , if needed he can select or create the profile that will contain imported types</p><p><img title="Create or select Profile" alt="Create or select Profile" border="0" src="./imgDOC/import_6.png"/><br/></p><p>When the current user is a "Simple User", he can only import instances of requirements by choosen predefined types contained in the profile. +If the profile does not contain all needed types, the import is not done and a message is displayed on the screen. </p><p><img title="Choose predefined type contained in profile" alt="Choose predefined type contained in profile" border="0" src="./imgDOC/Choose_Predefined_Profile.png"/><br/></p><p><img title="The import cannot be done if the profile is not complete." alt="The import cannot be done if the profile is not complete." border="0" src="./imgDOC/CannotImport.png"/><br/></p><p>The model has now imported requirements with relations. Note that a comment explains the origin of the import.</p><p><img title="Resulted model" alt="Resulted model" border="0" src="./imgDOC/import7.png"/><br/></p><h4 id="Export_UML_Model_to_ReqIF_File">Export UML Model to ReqIF File</h4><p>Select the SysML that you want to export +</p><p><img title="SysML Model" alt="SysML Model" border="0" src="./imgDOC/export1.png"/><br/></p><p>Select the export Menu from Eclipse menu.</p><p><img title="Export Menu" alt="Export Menu" border="0" src="./imgDOC/export2.png"/><br/></p><p>Select the menu export ReqIF form the papyrus Category</p><p><img title="Import ReqIF file" alt="Import ReqIF file" border="0" src="./imgDOC/export3.png"/><br/></p><p>Choose the name of the reqif file.</p><p><img title="Choose ReqIF File name" alt="Choose ReqIF File name" border="0" src="./imgDOC/export5.png"/><br/></p><p>At the end, a reqFile is generated. The header has an information that explain that the result comes from UML file. +</p><p><img title="Result in the ReqIf file" alt="Result in the ReqIf file" border="0" src="./imgDOC/Export4.png"/><br/></p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/src/org/eclipse/papyrus/req/reqif/doc/Activator.java b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/src/org/eclipse/papyrus/req/reqif/doc/Activator.java new file mode 100644 index 00000000000..5cfa47db2cf --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/src/org/eclipse/papyrus/req/reqif/doc/Activator.java @@ -0,0 +1,50 @@ +package org.eclipse.papyrus.req.reqif.doc;
+
+import org.eclipse.ui.plugin.AbstractUIPlugin;
+import org.osgi.framework.BundleContext;
+
+/**
+ * The activator class controls the plug-in life cycle
+ */
+public class Activator extends AbstractUIPlugin {
+
+ // The plug-in ID
+ public static final String PLUGIN_ID = "org.eclipse.papyrus.req.reqif.doc"; //$NON-NLS-1$
+
+ // The shared instance
+ private static Activator plugin;
+
+ /**
+ * The constructor
+ */
+ public Activator() {
+ }
+
+ /*
+ * (non-Javadoc)
+ * @see org.eclipse.ui.plugin.AbstractUIPlugin#start(org.osgi.framework.BundleContext)
+ */
+ public void start(BundleContext context) throws Exception {
+ super.start(context);
+ plugin = this;
+ }
+
+ /*
+ * (non-Javadoc)
+ * @see org.eclipse.ui.plugin.AbstractUIPlugin#stop(org.osgi.framework.BundleContext)
+ */
+ public void stop(BundleContext context) throws Exception {
+ plugin = null;
+ super.stop(context);
+ }
+
+ /**
+ * Returns the shared instance
+ *
+ * @return the shared instance
+ */
+ public static Activator getDefault() {
+ return plugin;
+ }
+
+}
|