Skip to content

Commit

Permalink
#164 Update documentation
Browse files Browse the repository at this point in the history 
Update documentation to inform on potential modifications done on
images imported and migrated.
  • Loading branch information
@arnauddieumegard @pdulth
arnauddieumegard authored and pdulth committed Jul 21, 2022
1 parent 3fa23dd commit cedb0c3
Show file tree
Hide file tree
Showing 7 changed files with 31 additions and 22 deletions.
13 changes: 9 additions & 4 deletions plugins/org.polarsys.capella.vp.requirements.doc/html/3_userguide/33_1_migration.html
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?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>Migration</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<title>33_1_migration</title>
<link type="text/css" rel="stylesheet" href="PLUGINS_ROOT/org.polarsys.capella.doc/html/styles.css"/>
</head>
<body>
<h1 id="Migration_procedure">Migration procedure</h1>
Expand All @@ -13,7 +13,7 @@ <h1 id="Migration_procedure">Migration procedure</h1>
versions of Capella need to be migrated for this version, including
the .bridgetraces file.</p>
<ul>
<li>If the .bridgetraces file is present in your Capella project, it will be automatically migrated during the migration procedure. For more details regarding the migration please of Capella projects please consult <b>Capella Guide / User Manual / First steps with Capella / How to Migrate Capella Project</b></li>
<li>If the .bridgetraces file is present in your Capella project, it will be automatically migrated during the migration procedure. For more details regarding the migration of Capella projects please consult <b>Capella Guide / User Manual / First steps with Capella / How to Migrate Capella Project</b></li>
</ul>
<ul>
<li>
Expand All @@ -28,5 +28,10 @@ <h1 id="Migration_procedure">Migration procedure</h1>
<img border="0" src="../../images/migration2.png"/>
</li>
</ul>
<h1 id="Migration_result">Migration result</h1>
<p>Image management in RichText contents have been modified in Capella 6.0. Images are now only referred using paths that are relative to the workspace. It is thus important to notice the
<a href="/wiki/../help/topic/org.polarsys.capella.ui.doc/html/First%20steps%20with%20Capella/3.5.%20How%20to%20migrate%20Capella%20projects.html?cp=6_1_3_4_0#Special_attention_to_image_used_in_the_project" title="../help/topic/org.polarsys.capella.ui.doc/html/First%20steps%20with%20Capella/3.5.%20How%20to%20migrate%20Capella%20projects.html?cp=6_1_3_4_0#Special_attention_to_image_used_in_the_project">following modification</a> applied to your models during the migration.
This leads to potential differences raised during import of ReqIF content containing images on projects where the same ReqIf content was imported in a previous version of Capella.
</p>
</body>
</html>
7 changes: 6 additions & 1 deletion ....polarsys.capella.vp.requirements.doc/html/3_userguide/33_1_migration.mediawiki
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,15 @@ for successive imports. Models that have been created in previous
versions of Capella need to be migrated for this version, including
the .bridgetraces file.

* If the .bridgetraces file is present in your Capella project, it will be automatically migrated during the migration procedure. For more details regarding the migration please of Capella projects please consult <b>Capella Guide / User Manual / First steps with Capella / How to Migrate Capella Project</b>
* If the .bridgetraces file is present in your Capella project, it will be automatically migrated during the migration procedure. For more details regarding the migration of Capella projects please consult <b>Capella Guide / User Manual / First steps with Capella / How to Migrate Capella Project</b>
* [[Image:../../images/migration1.png]]
* If the .bridgetraces file is present in elsewhere in your workspace, you can migrate them independently by doing <b>Right Click / Migration / Migrate Trace resource to current version</b>
* [[Image:../../images/migration2.png]]
= Migration result =

Image management in RichText contents have been modified in Capella 6.0. Images are now only referred using paths that are relative to the workspace. It is thus important to notice the [[../help/topic/org.polarsys.capella.ui.doc/html/First%20steps%20with%20Capella/3.5.%20How%20to%20migrate%20Capella%20projects.html?cp=6_1_3_4_0#Special_attention_to_image_used_in_the_project | following modification]] applied to your models during the migration.
This leads to potential differences raised during import of ReqIF content containing images on projects where the same ReqIf content was imported in a previous version of Capella.
16 changes: 7 additions & 9 deletions plugins/org.polarsys.capella.vp.requirements.doc/html/3_userguide/33_reqifimport.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -141,18 +141,16 @@ <h2 id="Display_ReqIF_Text_content_in_Capella_Richtext_editor">Display ReqIF Tex
<img border="0" src="../../images/ReqIFText.png"/>
</p>
<p>
<b>Image importing strategies</b>
<b>Image importing</b>
</p>
<p>For imported images, users can choose one of three strategies: import to an absolute path, import to a relative path or embed image in Base64 format. Here below are the advantages and inconveniences for each approach.</p>
<p>Starting in Capella 6.0, images referenced in Requirements text shall be imported on projects available in the workspace. Users should then provide the path to the project and possibly sub-folder where images are to be stored.</p>
<p>
<img border="0" src="../../images/ImageImportStrategy.png"/>
<img border="0" src="../../images/ImageImportDialog.png"/>
</p>
<p>Images previously imported may have been modified if your project have been
<a href="/wiki/../help/topic/org.polarsys.capella.ui.doc/html/First%20steps%20with%20Capella/3.5.%20How%20to%20migrate%20Capella%20projects.html?cp=6_1_3_4_0#Special_attention_to_image_used_in_the_project" title="../help/topic/org.polarsys.capella.ui.doc/html/First%20steps%20with%20Capella/3.5.%20How%20to%20migrate%20Capella%20projects.html?cp=6_1_3_4_0#Special_attention_to_image_used_in_the_project">migrated</a>.
This leads to potential differences raised during import of ReqIF content containing images on projects where the same ReqIf content was imported in a previous version of Capella.
</p>
<ul>
<li>Absolute path: This is the recommended mode. However, images cannot be loaded if the image folder location is not known to Capella. Thus, users must make sure that the image folder is accessible (e.g. folder in a shared drive)</li>
<li>Relative path: The image folder is included in Capella project. However, due to some limitations, this mode does not work well with connected models in collaborative mode.</li>
<li>Embed in Base64: The image is directly embedded in Capella model. This can significantly increase the size of the model.</li>
</ul>
<p>Notice that between imports, if the image importing strategy is changed, the tool will consider that the text has been changed and thus, show the difference. If you do not want to see these differences, make sure to use the same image importing strategy in interative imports.</p>
<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>
Expand Down
13 changes: 5 additions & 8 deletions ....polarsys.capella.vp.requirements.doc/html/3_userguide/33_reqifimport.mediawiki
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,17 +98,14 @@ Requirement's ReqIf.Text field when imported into Capella model can be displayed

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

'''Image importing strategies'''
'''Image importing'''

For imported images, users can choose one of three strategies: import to an absolute path, import to a relative path or embed image in Base64 format. Here below are the advantages and inconveniences for each approach.
Starting in Capella 6.0, images referenced in Requirements text shall be imported on projects available in the workspace. Users should then provide the path to the project and possibly sub-folder where images are to be stored.

[[File:../../images/ImageImportStrategy.png]]
[[File:../../images/ImageImportDialog.png]]

* Absolute path: This is the recommended mode. However, images cannot be loaded if the image folder location is not known to Capella. Thus, users must make sure that the image folder is accessible (e.g. folder in a shared drive)
* Relative path: The image folder is included in Capella project. However, due to some limitations, this mode does not work well with connected models in collaborative mode.
* Embed in Base64: The image is directly embedded in Capella model. This can significantly increase the size of the model.
Notice that between imports, if the image importing strategy is changed, the tool will consider that the text has been changed and thus, show the difference. If you do not want to see these differences, make sure to use the same image importing strategy in interative imports.
Images previously imported may have been modified if your project have been [[../help/topic/org.polarsys.capella.ui.doc/html/First%20steps%20with%20Capella/3.5.%20How%20to%20migrate%20Capella%20projects.html?cp=6_1_3_4_0#Special_attention_to_image_used_in_the_project | migrated]].
This leads to potential differences raised during import of ReqIF content containing images on projects where the same ReqIf content was imported in a previous version of Capella.

== Iterativity ==

Expand Down
Binary file added plugins/org.polarsys.capella.vp.requirements.doc/images/ImageImportDialog.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed plugins/org.polarsys.capella.vp.requirements.doc/images/ImageImportStrategy.png
View file
Binary file not shown.
4 changes: 4 additions & 0 deletions plugins/org.polarsys.capella.vp.requirements.doc/toc/userguide.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@
<topic href="html/3_userguide/33_reqifimport.html" label="ReqIF Import in Capella">
</topic>
<topic href="html/3_userguide/33_1_migration.html" label="Project migration">
<topic href="html/3_userguide/33_1_migration.html#Migration_procedure" label="Migration procedure">
</topic>
<topic href="html/3_userguide/33_1_migration.html#Migration_result" label="Migration result">
</topic>
</topic>
<topic href="html/3_userguide/34_preferences.html" label="Preferences">
</topic>
Expand Down

0 comments on commit cedb0c3

Please sign in to comment.