#162 Update documentation

Add information import rules for empty "requirement folders" converted to Requirement elements. Change-Id: I0000000000000000000000000000000000000000 Signed-off-by: Arnaud Dieumegard <arnaud.dieumegard@obeo.fr>
eclipse-capella · Jul 21, 2022 · f7df21f · f7df21f
1 parent ff4e234
commit f7df21f
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 5 deletions.
diff --git a/plugins/org.polarsys.capella.vp.requirements.doc/html/3_userguide/33_reqifimport.html b/plugins/org.polarsys.capella.vp.requirements.doc/html/3_userguide/33_reqifimport.html
@@ -1,10 +1,10 @@
 <?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>ReqIF Import in Capella</title>
-   </head>
+		<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+		<title>33_reqifimport</title>
+		<link type="text/css" rel="stylesheet" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css"/>
+	</head>
 	<body>
 		<h1 id="ReqIF_Import_in_Capella">ReqIF Import in Capella</h1>
 		<h2 id="Requirements">Requirements</h2>
@@ -24,6 +24,19 @@ <h2 id="Launch_the_import">Launch the import</h2>
 		</p>
 		<p>You will be asked to choose a .reqif file containing data to import.</p>
 		<p>Once the ReqIF elements are loaded from the selected file, a Diff/Merge dialog opens to allow integration of Requirement elements in your model.</p>
+		<table class="prettytable">
+			<tr>
+				<td>
+					<p>Please be aware of the following limitations/choices regarding imported content:</p>
+					<ol>
+						<li>Default ReqIf content generated from DOORS does not allow to discriminate between: a Requirement, and a Folder that does not contain any Requirements. Thus the result of importing an empty Folder will generate a Requirement.</li>
+						<li>Custom attributes added to Requirements can be automatically imported if they are correctly specified. Please refer to the dedicated 
+							<i>Preferences</i> documentation section.
+						</li>
+					</ol>
+				</td>
+			</tr>
+		</table>
 		<h2 id="Diff.2FMerge_Dialog">Diff/Merge Dialog</h2>
 		<p>
 			<img border="0" src="../../images/diffmerge.png"/>
@@ -143,4 +156,4 @@ <h2 id="Display_ReqIF_Text_content_in_Capella_Richtext_editor">Display ReqIF Tex
 		<h2 id="Iterativity">Iterativity</h2>
 		<p>After an import, a new file .bridgetraces is created aside the .capella file. This file is used to allow successive imports. It shall not be deleted.</p>
 	</body>
-</html>   
+</html>
diff --git a/....polarsys.capella.vp.requirements.doc/html/3_userguide/33_reqifimport.mediawiki b/....polarsys.capella.vp.requirements.doc/html/3_userguide/33_reqifimport.mediawiki
@@ -16,6 +16,18 @@ You will be asked to choose a .reqif file containing data to import.
 
 Once the ReqIF elements are loaded from the selected file, a Diff/Merge dialog opens to allow integration of Requirement elements in your model.
 
+{| class="prettytable"
+|-
+|
+
+Please be aware of the following limitations/choices regarding imported content:
+
+# Default ReqIf content generated from DOORS does not allow to discriminate between: a Requirement, and a Folder that does not contain any Requirements. Thus the result of importing an empty Folder will generate a Requirement.
+# Custom attributes added to Requirements can be automatically imported if they are correctly specified. Please refer to the dedicated ''Preferences'' documentation section.
+
+|}
+
+
 == Diff/Merge Dialog ==
 
 [[Image:../../images/diffmerge.png]]