Adding draft of documentation for the sysmlExport

Issue-Ref: 4316 Issue-Url: af3#4316 Signed-off-by: Konstantin Blaschke <blaschke@fortiss.org> Signed-off-by: Konstantin Blaschke <blaschke@fortiss.org>

Adding draft of documentation for the sysmlExport
4084da1e · Konstantin Blaschke · 7422d801 · 4084da1e · 4084da1e · 4084da1e
Commit 4084da1e authored 1 year ago by Konstantin Blaschke
--- a/org.fortiss.af3.rcp.help/html/.ratings
+++ b/org.fortiss.af3.rcp.help/html/.ratings
@@ -4,4 +4,5 @@ examples.MainPage.html 23ce7bffec3b2af97eb6da1f93337c0601b2a3c5 GREEN
 getting_started.html c7763727d5d22267130672f329c1f595b09bca41 GREEN
 managing_projects.html bbc4d46ac6e49f6a2c0bd44cbf68711d8a0c0b6c GREEN
 rcphelp.gettingstarted.MainPage.html 5815d47b9c562cc3b6eac749f9f8f3db148e222a GREEN
+sysmlExport.html 0a3f93f3aa70fc6d0333f4ea6b55472eff375dc5 YELLOW
 tipsAndTricks.html a8e8f548cb37237b6d728ad25cd5c6de9bedac9a GREEN
--- a/org.fortiss.af3.rcp.help/html/getting_started.html
+++ b/org.fortiss.af3.rcp.help/html/getting_started.html
@@ -131,6 +131,7 @@
 									<li><a href="ta/system_schedule.html">System Schedule</a></li>
 								</ul>
 								<li><a href="ta/code_generation.html">Code Generation</a></li>
+								<li><a href="sysmlExport.html">SysML Exporter Module</a></li>
 							</ul>
 						</div>
 					</div>

--- a/org.fortiss.af3.rcp.help/html/pictures/extractSysMLExample.PNG
+++ b/org.fortiss.af3.rcp.help/html/pictures/extractSysMLExample.PNG
--- a/org.fortiss.af3.rcp.help/html/pictures/mappingTable.png
+++ b/org.fortiss.af3.rcp.help/html/pictures/mappingTable.png
--- a/org.fortiss.af3.rcp.help/html/sysmlExport.html
+++ b/org.fortiss.af3.rcp.help/html/sysmlExport.html
+<html>
+<body>
+<h1>User Documentation for <i>AF3 SysML Exporter</i> (org.fortiss.af3.sysml)</h1>
+
+<h2> Plugin description </h2>
+<p>The Systems Modeling Language (SysML) is a standardized graphical modeling 
+language for systems engineering. It supports the model specification, analysis, 
+design, verification, and validation of systems. SysML is defined as a UML 2 profile, 
+which customizes the language to use only a small number of stereotypes, tagged 
+values, and constraints. To enable the transfer of .af3 models, AutoFOCUS3 offers a SysML exporter. 
+The exporter offers three different export functions for modeling environments MagicDraw, Enterprise Architect, and Papyrus.</p>
+
+<h3>Extractable Viewpoints</h3>
+<p>The viewpoints that can be extracted are are:</p>
+<ul>
+<li><a href="../../../org.fortiss.af3.expression/html/developer/documentation.html">Data Dictionary</a></li>
+<li><a href="../../../org.fortiss.af3.component/html/developer/documentation.html">Component Architecture</a></li>
+<li><a href="../../../org.fortiss.af3.task/html/developer/documentation.html">Task Architecture</a></li>
+<li><a href="../../../org.fortiss.af3.platform/html/developer/documentation.html">Platform Architecture</a></li>
+<li><a href="../../../org.fortiss.af3.function/html/developer/documentation.html">Function Architecture</a></li>
+<li><a href="../../../org.fortiss.af3.allocation/html/developer/documentation.html">Allocations Tables</a></li>
+</ul>
+<p>The SysML exporter validates the selection and therefore only offers an extraction if the combination is possible.</p>
+
+<h3> AF3 meta model element to SysML / UML mapping </h2>
+<img alt="mapping diagram from af3 model element to SysML and UML elements" src="pictures/mappingTable.png"/>
+
+<h2>Guideline to use the SysML Exporter </h2>
+<img alt="Display of how to export a project in SysML" src="pictures/extractSysMLExample.PNG"/>
+<p>To extract an AF3 project as SysML .xmi or .uml model the user needs to select a file-project which is mandatory. But then the user can decide
+to choose different viewpoints, which should be extracted. The SysML exporter is validating the evaluation and if the selection is valid the option is shown
+with a right click in the context menu for three different extraction mechanisms including the according specific headers and extension configurations.
+Through continuous development of the tools Enterprise Architect, Magic Draw and Papyrus we expect partially information loss with the export as some
+elements are not recognized or differently interpreted within new tool versions. This version of the 
+SysML converter was included for tool versions Enterprise Architect V16, Magic Draw 2021x and Papyrus 2022-12.
+
+</body>
+</html>
\ No newline at end of file