Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCedric Dumoulin2014-12-11 20:38:39 +0000
committerCedric Dumoulin2015-01-05 10:09:50 +0000
commit90093cf0eb29d008828800cc55c5ed3fc541fac6 (patch)
tree148489d755e8e9d17be5a874e81a78e7a49dff28 /plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource
parentbd37dd21a63efb145d10f640656131cdaf528b6b (diff)
downloadorg.eclipse.papyrus-90093cf0eb29d008828800cc55c5ed3fc541fac6.tar.gz
org.eclipse.papyrus-90093cf0eb29d008828800cc55c5ed3fc541fac6.tar.xz
org.eclipse.papyrus-90093cf0eb29d008828800cc55c5ed3fc541fac6.zip
454275: [Profiles] Improve Documentation. Add Profile easy usage.
Task-Url: https://bugs.eclipse.org/bugs/show_bug.cgi?id=454275
Diffstat (limited to 'plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource')
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/profile-DialogExplained.pngbin0 -> 76750 bytes
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture-toc.xml2
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture.html2
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations-toc.xml6
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations.html4
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations.mediawiki7
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml16
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes-toc.xml6
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes.html6
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes.mediawiki36
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/whatIsAUmlProfile-toc.xml4
11 files changed, 82 insertions, 7 deletions
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/profile-DialogExplained.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/profile-DialogExplained.png
new file mode 100644
index 00000000000..b47281ff00e
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/images/profile-DialogExplained.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture-toc.xml
index 139f6f393af..5126390dafc 100644
--- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture-toc.xml
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture-toc.xml
@@ -1,8 +1,6 @@
<?xml version='1.0' encoding='utf-8' ?>
<toc topic="resource/users/papyrusProfileArchitecture.html" label="papyrusProfileArchitecture">
- <topic label="Papyrus Profile Architecture">
<topic href="resource/users/papyrusProfileArchitecture.html" label="Papyrus Profile Architecture"></topic>
<topic href="resource/users/papyrusProfileArchitecture.html#Profile_and_Stereotype_Definitions_Architecture" label="Profile and Stereotype Definitions Architecture"></topic>
<topic href="resource/users/papyrusProfileArchitecture.html#Profile_and_Stereotype_applications_Architecture" label="Profile and Stereotype applications Architecture"></topic>
- </topic>
</toc> \ No newline at end of file
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture.html
index 87fd4a0afba..bbfb5510cc2 100644
--- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture.html
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture.html
@@ -1,2 +1,2 @@
-<?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="Papyrus_Profile_Architecture">Papyrus Profile Architecture</h1><p>This section describes the architecture used to define uml Profiles in Papyrus. </p><p>Papyrus Profiles and Stereotypes implementation is made of two different parts:</p><ul><li>The Profile and Stereotype definitions - This part is used to handle the stereotype and profile definitions.</li><li>The Profile and Stereotype applications - This part is used to apply an existing stereotype or profile to an UML element.</li></ul><h1 id="Profile_and_Stereotype_Definitions_Architecture">Profile and Stereotype Definitions Architecture</h1><p>Papyrus allows to create Profiles and Sterotypes in any kind of models. But, if you want to define Profiles and Stereotypes in order to apply them to UML elements, <b>you need to define a Profile in a 'Papyrus profile resource</b>' (i.e. a file).</p><p>The definitions of Profiles and Stereoptypes is made of two parts: the UML definitions, and the corresponding dynamic model. User define profiles and stereotypes in UML. The corresponding dynamic model is computed by Papyrus when the resource is saved.</p><p>UML definition of profile follows UML standard: Stereotypes must be defined in a uml::Profile.</p><p>The dynamic model is defined by Papyrus using the EMF/UML framework. This dynamic model is associated to a version number. The version number is incremented each time the dynamic model is re-created, so each time the profile resource is saved.</p><h1 id="Profile_and_Stereotype_applications_Architecture">Profile and Stereotype applications Architecture</h1><p>When Profile or a Stereotype is applied to an UML element, this create a Application object referencing both the uml element, and the profile or stereotype definition.
+<?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="Papyrus_Profile_Architecture">Papyrus Profile Architecture</h1><p>This section describes the architecture used to define uml Profiles in Papyrus. </p><p>Papyrus Profiles and Stereotypes implementation is made of two different parts:</p><ul><li>The Profile and Stereotype <b>definitions</b> - This part is used to handle the stereotype and profile definitions.</li><li>The Profile and Stereotype <b>applications</b> - This part is used to apply an existing stereotype or profile to an UML element.</li></ul><h1 id="Profile_and_Stereotype_Definitions_Architecture">Profile and Stereotype Definitions Architecture</h1><p>Papyrus allows to create Profiles and Sterotypes in any kind of models. But, if you want to define Profiles and Stereotypes in order to apply them to UML elements, <b>you need to define a Profile in a 'Papyrus profile resource</b>' (i.e. a file).</p><p>The definitions of Profiles and Stereoptypes is made of two parts: the UML definitions, and the corresponding dynamic model. User define profiles and stereotypes in UML. The corresponding dynamic model is computed by Papyrus when the resource is saved.</p><p>UML definition of profile follows UML standard: Stereotypes must be defined in a uml::Profile.</p><p>The dynamic model is defined by Papyrus using the EMF/UML framework. This dynamic model is associated to a version number. The version number is incremented each time the dynamic model is re-created, so each time the profile resource is saved.</p><h1 id="Profile_and_Stereotype_applications_Architecture">Profile and Stereotype applications Architecture</h1><p>When Profile or a Stereotype is applied to an UML element, this create a Application object referencing both the uml element, and the profile or stereotype definition.
Thus, an uml element is not directly linked to an Application object.</p><p>Application objects are normally stored in the resource file containing the uml element they reference. They are not stored inside the UML model. Rather, they are stored alongside of the uml model. </p></body></html> \ No newline at end of file
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations-toc.xml
new file mode 100644
index 00000000000..79f8866b7fa
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations-toc.xml
@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc topic="resource/users/papyrusProfileLimitations.html" label="papyrusProfileLimitations">
+ <topic href="resource/users/papyrusProfileLimitations.html" label="Papyrus Profile Limitations">
+ <topic href="resource/users/papyrusProfileLimitations.html#Cyclic_Profile_Definitions" label="Cyclic Profile Definitions"></topic>
+ </topic>
+</toc> \ No newline at end of file
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations.html
new file mode 100644
index 00000000000..7e6de282694
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations.html
@@ -0,0 +1,4 @@
+<?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="Papyrus_Profile_Limitations">Papyrus Profile Limitations</h1><h2 id="Cyclic_Profile_Definitions">Cyclic Profile Definitions</h2><p>Due to the way the Dynamic ECore model is built, Papyrus does not support Definition of Profiles with cyclic references.
+See Bug 451613: ClassCastException when updating hierarchical profile with datatype
+<a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=451613">https://bugs.eclipse.org/bugs/show_bug.cgi?id=451613</a></p><pre>[
+</pre></body></html> \ No newline at end of file
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations.mediawiki b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations.mediawiki
new file mode 100644
index 00000000000..cc8d398af5e
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations.mediawiki
@@ -0,0 +1,7 @@
+= Papyrus Profile Limitations =
+
+== Cyclic Profile Definitions ==
+
+Due to the way the Dynamic ECore model is built, Papyrus does not support Definition of Profiles with cyclic references.
+
+See [[https://bugs.eclipse.org/bugs/show_bug.cgi?id=451613|Bug 451613]]: ClassCastException when updating hierarchical profile with datatype \ No newline at end of file
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml
index 4a24e9cb947..78eb905ee06 100644
--- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml
@@ -2,14 +2,26 @@
<toc label="Papyrus Profiles" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser">
<topic label="Using UML Profiles">
<anchor id="profiles-start"/>
- <link toc="resource/users/whatIsAUmlProfile-toc.xml"/>
- <link toc="resource/users/papyrusProfileArchitecture-toc.xml" />
+ <topic label="What is a UML Profile">
+ <link toc="resource/users/whatIsAUmlProfile-toc.xml"/>
+ </topic>
+ <topic label="Papyrus Profiles Architecture">
+ <link toc="resource/users/papyrusProfileArchitecture-toc.xml" />
+ </topic>
<topic label="Defining Profiles And Stereotypes">
<link toc="resource/users/definingProfilesAndStereotypes-toc.xml" />
</topic>
<topic label="Using Profiles And Stereotypes">
<link toc="resource/users/usingProfilesAndStereotypes-toc.xml" />
</topic>
+ <topic label="Simplified Usage of Profiles and Stereotypes">
+ <link toc="resource/users/simplifiedUsageOfProfilesAndStereotypes-toc.xml" />
+ </topic>
+ <anchor id="profiles" />
+ <topic label="Papyrus Profiles Limitations">
+ <link toc="resource/users/papyrusProfileLimitations-toc.xml" />
+ </topic>
<anchor id="profiles-end" />
+
</topic>
</toc>
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes-toc.xml
new file mode 100644
index 00000000000..ebab3dfd1f5
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes-toc.xml
@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc topic="resource/users/simplifiedUsageOfProfilesAndStereotypes.html" label="simplifiedUsageOfProfilesAndStereotypes">
+ <topic href="resource/users/simplifiedUsageOfProfilesAndStereotypes.html" label="Simplified Usage of Profiles and Stereotypes"></topic>
+ <topic href="resource/users/simplifiedUsageOfProfilesAndStereotypes.html#Creating_Profile_and_Stereotype" label="Creating Profile and Stereotype"></topic>
+ <topic href="resource/users/simplifiedUsageOfProfilesAndStereotypes.html#Updating_Stereotype" label="Updating Stereotype"></topic>
+</toc> \ No newline at end of file
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes.html
new file mode 100644
index 00000000000..55a1553eae4
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes.html
@@ -0,0 +1,6 @@
+<?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="Simplified_Usage_of_Profiles_and_Stereotypes">Simplified Usage of Profiles and Stereotypes</h1><p>Papyrus provides a simplified way to create, apply and modify Profiles and Stereotypes.
+We call it 'simplified' comparatively to the way where one should first define Profile and Stereotypes, then apply the Profile, and finally apply and modify the Stereotype.</p><p>The simplified usage propose one single Dialog used to create a Profile and a Stereotype, then apply both to the selected element, and all in no more than two clicks !
+Also, the same Dialog can be used to update the Stereotype definition, or the application values.</p><h1 id="Creating_Profile_and_Stereotype">Creating Profile and Stereotype</h1><p>Select the UML element to apply the profile, right click -&gt; Profile -&gt; Update Profile ...<br/>
+The following Dialog appears:</p><p><img title="Profile Easy Usage Dialog" alt="Profile Easy Usage Dialog" border="0" src="images/profile-DialogExplained.png"/><br/></p><p>In <b>Qualified Name</b>, type the Profile name and the Stereotype name separated by '::'.</p><p>The <b>metaclass</b> should already be selected, based on the metaclass of the currently selected UML element. You can add metaclasses if you whish.</p><p>In <b>Properties</b>, add properties to your profile: click '+', then set the name, select a type, and set a value.</p><p>Clicking '<b>OK</b>' will do the following:</p><ul><li><b>Create the Profile</b> if needed</li><li><b>Create the Stereotype</b> if needed</li><li><b>Create new properties</b></li><li><b>Apply the Profile</b>, if needed, to the uml::Package containing the selected uml element.</li><li><b>Apply the Stereotype</b>, if needed, to the selected uml element.</li><li><b>Set values to the applied stereotype</b>, if some values are set to the properties.</li></ul><h1 id="Updating_Stereotype">Updating Stereotype</h1><p>Select the UML element applying the profile to update, right click -&gt; Profile -&gt; Update Profile ...<br/>
+In <b>Qualified Name</b>, type the beginning of the name of the Stereotype to update. The Content Assist should propose Stereotypes matching your input. Select your Stereotype.
+The Dialog should show the actual values of the Stereotype. You can change the Properties and their values.</p><p>If you change the name of the Stereotype or the Profile, this will create a new Stereotype.</p></body></html> \ No newline at end of file
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes.mediawiki b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes.mediawiki
new file mode 100644
index 00000000000..6a4cb437ced
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes.mediawiki
@@ -0,0 +1,36 @@
+= Simplified Usage of Profiles and Stereotypes =
+
+__TOC__
+
+Papyrus provides a simplified way to create, apply and modify Profiles and Stereotypes.
+We call it 'simplified' comparatively to the way where one should first define Profile and Stereotypes, then apply the Profile, and finally apply and modify the Stereotype.
+
+The simplified usage propose one single Dialog used to create a Profile and a Stereotype, then apply both to the selected element, and all in no more than two clicks !
+Also, the same Dialog can be used to update the Stereotype definition, or the application values.
+
+= Creating Profile and Stereotype =
+Select the UML element to apply the profile, right click -> Profile -> Update Profile ...<br>
+The following Dialog appears:
+
+[[Image:images/profile-DialogExplained.png|Profile Easy Usage Dialog]]<br>
+
+In '''Qualified Name''', type the Profile name and the Stereotype name separated by '::'.
+
+The '''metaclass''' should already be selected, based on the metaclass of the currently selected UML element. You can add metaclasses if you whish.
+
+In '''Properties''', add properties to your profile: click '+', then set the name, select a type, and set a value.
+
+Clicking ''''OK'''' will do the following:
+* '''Create the Profile''' if needed
+* '''Create the Stereotype''' if needed
+* '''Create new properties'''
+* '''Apply the Profile''', if needed, to the uml::Package containing the selected uml element.
+* '''Apply the Stereotype''', if needed, to the selected uml element.
+* '''Set values to the applied stereotype''', if some values are set to the properties.
+
+= Updating Stereotype =
+Select the UML element applying the profile to update, right click -> Profile -> Update Profile ...<br>
+In '''Qualified Name''', type the beginning of the name of the Stereotype to update. The Content Assist should propose Stereotypes matching your input. Select your Stereotype.
+The Dialog should show the actual values of the Stereotype. You can change the Properties and their values.
+
+If you change the name of the Stereotype or the Profile, this will create a new Stereotype.
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/whatIsAUmlProfile-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/whatIsAUmlProfile-toc.xml
index 69bd0f69944..f51372d4b11 100644
--- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/whatIsAUmlProfile-toc.xml
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/whatIsAUmlProfile-toc.xml
@@ -1,4 +1,4 @@
<?xml version='1.0' encoding='utf-8' ?>
<toc topic="resource/users/whatIsAUmlProfile.html" label="whatIsAUmlProfile">
- <topic href="resource/users/whatIsAUmlProfile.html" label="What Is A UML Profile"></topic>
-</toc> \ No newline at end of file
+ <topic href="resource/users/whatIsAUmlProfile.html" label="What is a UML Profile"></topic>
+</toc>

Back to the top