Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicolas FAUVERGUE2019-09-11 12:55:55 +0000
committerPatrick Tessier2019-09-18 07:51:30 +0000
commite8bc9ba951a87fe317d09fcc25517aa2c4115fe6 (patch)
tree565bc32e7065e36183ec4b2e5b99b1c7393f3827
parent964ba135ccf082be2eb5e536720a6b4818ae1ca6 (diff)
downloadorg.eclipse.papyrus-e8bc9ba951a87fe317d09fcc25517aa2c4115fe6.tar.gz
org.eclipse.papyrus-e8bc9ba951a87fe317d09fcc25517aa2c4115fe6.tar.xz
org.eclipse.papyrus-e8bc9ba951a87fe317d09fcc25517aa2c4115fe6.zip
Bug 550902: [Doc] The papyrus embedded documentation must be the same
than the documentation on the wiki - Manage correctly the display of stereotypes documentation Change-Id: I0334d4165ee09a07cc4fedd8cbbaf9a295544d0e Signed-off-by: Nicolas FAUVERGUE <nicolas.fauvergue@cea.fr>
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/plugin.xml4
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/DisplayStereotypes.mediawiki222
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/stereotype-display-toc.xml3
3 files changed, 117 insertions, 112 deletions
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/plugin.xml
index 4e82804d17f..47739e0a7f1 100644
--- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/plugin.xml
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/plugin.xml
@@ -20,6 +20,10 @@
primary="false">
</toc>
<toc
+ file="target/generated-eclipse-help/DisplayStereotypes-toc.xml"
+ primary="false">
+ </toc>
+ <toc
file="target/generated-eclipse-help/stereotype-property-reference-edge-main-toc.xml"
primary="false">
</toc>
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/DisplayStereotypes.mediawiki b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/DisplayStereotypes.mediawiki
index 9a661366faf..d06b9ae168c 100644
--- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/DisplayStereotypes.mediawiki
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/DisplayStereotypes.mediawiki
@@ -1,105 +1,104 @@
-===Papyrus stereotype display===
+=Papyrus stereotype display=
__TOC__
-
-<br>
-
+==Display applied stereotype name==
====Display applied stereotype name====
-======Display applied stereotype name======
- - traces to [[#_uZluEPwOEeWkK6hum4lQXg|Apply a stereotype]], [[#_uZm8MPwOEeWkK6hum4lQXg|Drop from the model explorer]], [[#_uZoKUPwOEeWkK6hum4lQXg|Display the name of the stereotype ]], [[#_uZpYcPwOEeWkK6hum4lQXg|Display each applied stereotype name differently]], [[#_uZkf8PwOEeWkK6hum4lQXg|Display stereotype name]]<br>
The diagram contains a shape. When you applied a stereotype on the element, the applied stereotype name is displayed on the shape below the name of the element.
When an element is dropped form the model explorer to the diagram, the applied stereotype named is displayed on the shape.
-This is the same behavior for links. <br>
-=====How to=====
+This is the same behavior for links.
+===How to===
Inside papyrus, it is possible to display the name of applied stereotype.
To do that:
- 1. Apply the profile that contains the stereotype on your model.
- 2. Apply the wanted stereotype on the element.<br>
-<br>
+# Apply the profile that contains the stereotype on your model.
+# Apply the wanted stereotype on the element.
+
[[Image:images/ApplyProfile.png|Apply a profile]]
-<br>''Apply a profile''<br>
-<br>
-<br>
+
+''Apply a profile''
+
+
[[Image:images/applyStereotype.png|Apply the stereotype]]
-<br>''Apply the stereotype''<br>
-<br>
-<br>
+
+''Apply the stereotype''
+
+
[[Image:images/AppliedStereotype.png|Resulted applied stereotype]]
-<br>''Resulted applied stereotype''<br>
-<br>
+
+''Resulted applied stereotype''
+
+==Display stereotype properties==
====Display stereotype properties====
-======Display stereotype properties======
-- traces to [[#_uZdLMfwOEeWkK6hum4lQXg|Stereotype application properties dipslay]]<br>
-It is possible to display properties of stereotypes as "comment", as "compartment", as "brace"<br>
+It is possible to display properties of stereotypes as "comment", as "compartment", as "brace"
+==As "brace"==
====As "brace"====
-======As "brace"======
-- traces to [[#_uZiqwPwOEeWkK6hum4lQXg|Display Requirement as a "brace"]]<br>
-Properties of applied stereotype can be displayed as "brace". This is label that is set below the name, and contains a sequence of properties name with their values.<br>
-=====How to=====
+Properties of applied stereotype can be displayed as "brace". This is label that is set below the name, and contains a sequence of properties name with their values.
+===How to===
To do that:
- 1. Select your Element
- 2. Select the Appearance Tab in the property view
- 3. Select "In braces" for the line of your applied stereotype<br>
-<br>
+# Select your Element
+# Select the Appearance Tab in the property view
+# Select "In braces" for the line of your applied stereotype
[[Image:images/DisplayInBrace.png|Sequence of actions to display in brace]]
-<br>''Sequence of actions to display in brace''<br>
-<br>
-<br>
+
+''Sequence of actions to display in brace''
+
+
[[Image:images/ResultDisplayInBrace.png|Properties of stereotypes displayed in brace]]
-<br>''Properties of stereotypes displayed in brace''<br>
-<br>
+
+''Properties of stereotypes displayed in brace''
+
+==As "compartment"==
====As "compartment"====
-======As "compartment"======
-- traces to [[#_uZg1kPwOEeWkK6hum4lQXg|Display Requirement as a "compartment"]]<br>
-Properties of applied stereotype can be displayed as a compartment. This compartment contains all labels that are properties of the applied stereotype.<br>
-=====How to=====
+Properties of applied stereotype can be displayed as a compartment. This compartment contains all labels that are properties of the applied stereotype.
+===How to===
To do that:
- 1. Select your Element
- 2. Select the Appearance Tab in the property view
- 3. Select "In Compartment" for the line of your applied stereotype<br>
-<br>
+# Select your Element
+# Select the Appearance Tab in the property view
+# Select "In Compartment" for the line of your applied stereotype
+
[[Image:images/DisplayInCompartment.png|Sequence of actions to display in compartment]]
-<br>''Sequence of actions to display in compartment''<br>
-<br>
-<br>
+
+''Sequence of actions to display in compartment''
+
+
[[Image:images/ResultDisplayInCompartment.png|Properties of stereotypes displayed in compartment]]
-<br>''Properties of stereotypes displayed in compartment''<br>
-<br>
+
+''Properties of stereotypes displayed in compartment''
+
+==As "Comment"==
====As "Comment"====
-======As "Comment"======
-- traces to [[#_uZfAYfwOEeWkK6hum4lQXg|Display Requirement as a "comment"]]<br>
-Properties of applied stereotype can be displayed as a comment. This comment representation that contains all labels that are properties of the applied stereotype.<br>
+Properties of applied stereotype can be displayed as a comment. This comment representation that contains all labels that are properties of the applied stereotype.
To do that:
- 1. Select your Element
- 2. Select the Appearance Tab in the property view
- 3. Select "In Comment" for the line of your applied stereotype<br>
-<br>
+# Select your Element
+# Select the Appearance Tab in the property view
+# Select "In Comment" for the line of your applied stereotype
+
[[Image:images/DisplayInComment.png|Sequence of actions to display in comment]]
-<br>''Sequence of actions to display in comment''<br>
-<br>
-<br>
+
+''Sequence of actions to display in comment''
+
+
[[Image:images/ResultDisplayInComment.png|Properties of stereotype displayed in comment]]
-<br>''Properties of stereotype displayed in comment''<br>
-<br>
+
+''Properties of stereotype displayed in comment''
+
+==Choose properties to display==
====Choose properties to display====
-======Choose properties to display======
-- traces to [[#_uZtC0PwOEeWkK6hum4lQXg|Use CSS file]], [[#_uZuQ8fwOEeWkK6hum4lQXg|Use property view]], [[#_uZr0sPwOEeWkK6hum4lQXg|Choice on Stereotype properties to display]]<br>
The list of properties of stereotypes can be chosen by the user by using the property view or by writing a css.
-This choice runs for the 3 representations of applied stereotypes: brace, compartment, comment.<br>
-=====How to=====
+This choice runs for the 3 representations of applied stereotypes: brace, compartment, comment.
+===How to===
By using the property view, it is possible to select the list of property of stereotype.
To do that:
- 1. Select your element.
- 2. Check that the applied stereotype has been displayed as brace, compartment or comment
- 3. Select lines that correspond to wanted properties of stereotype.<br>
-<br>
+# Select your element.
+# Check that the applied stereotype has been displayed as brace, compartment or comment
+# Select lines that correspond to wanted properties of stereotype.
+
[[Image:images/ChooseProperties_PV.png|Select properties by using the property view]]
-<br>''Select properties by using the property view''<br>
-<br>
+
+''Select properties by using the property view''
+
By using CSS file:
-<code>
-<br>
- Compartment[type=StereotypeCompartment]{
+<source lang="css">
+Compartment[type=StereotypeCompartment]{
visible:true;
}
Compartment[type=StereotypeCompartment]>[property="derived"]{
@@ -108,18 +107,17 @@ By using CSS file:
Compartment[type=StereotypeCompartment]>[property="derivedFrom"]{
visible:false;
}
-</code>
+</source>
The compartment is displayed and the property derived and derivedFrom are not displayed
-<br>
-<br>
[[Image:images/ChooseProperties_CSS.png|Result by using the selection by CSS]]
-<br>''Result by using the selection by CSS''<br>
-<br>
+''Result by using the selection by CSS''
+
+
The following CSS rules are implemented by default for all the Diagrams:
-<code>
- Shape[type=StereotypeComment]{
+<source lang="css">
+Shape[type=StereotypeComment]{
visible:false;
}
@@ -168,50 +166,52 @@ The following CSS rules are implemented by default for all the Diagrams:
StereotypeComment Compartment[type=StereotypeBrace]{
visible:true;
}
-</code>
-<br>
+</source>
+
+==Choose QN depth==
====Choose QN depth====
-======Choose QN depth======
-- traces to [[#_uZqmkPwOEeWkK6hum4lQXg|Qualified name depth]]<br>
The stereotype name can be displayed by choosing the depth. I consists on choosing the size of the qualified name of the stereotype.
full = all the qualified name
0= only the name of stereotype
-1= the name of its parent + the name of the stereotype
--2=the name of its great-parent+ the name of its parent + the name of the stereotype<br>
-Using Css:
+-2=the name of its great-parent+ the name of its parent + the name of the stereotype
+Using CSS:
+<source lang="css">
Label[type=StereotypeLabel]{
depth:"-1";
}
+</source>
By using the property view:
- 1. Select the element.
- 2. Select the appearance Tab
- 3. Select the name depth and choose the size<br>
-<br>
+# Select the element.
+# Select the appearance Tab
+# Select the name depth and choose the size
+
[[Image:images/depth.png|Select the depth the applied stereotype name]]
-<br>''Select the depth the applied stereotype name''<br>
-<br>
+
+''Select the depth the applied stereotype name''
+
+==Remove display of stereotype properties==
====Remove display of stereotype properties====
-======Remove display of stereotype properties======
-- traces to [[#_uZvfEPwOEeWkK6hum4lQXg|Remove display of applied stereotype ]]<br>
-The display of stereotype can be removed by selection or by unapply stereotype or profile container<br>
+The display of stereotype can be removed by selection or by unapply stereotype or profile container
+==Update the display of applied stereotype properties==
====Update the display of applied stereotype properties====
-======Update the display of applied stereotype properties======
-- traces to [[#_uZwtMPwOEeWkK6hum4lQXg|Update display]]<br>
-When the value associated to the property of stereotype has been modified, the display must be modified.<br>
+When the value associated to the property of stereotype has been modified, the display must be modified.
It is possible to edit value of stereotype property by double click on the property in the diagram.
-Important: the property must be writable and Real are not yet editable. <br>
-<br>
+Important: the property must be writable and Real are not yet editable.
+
[[Image:images/PropertyEdition.png|Property of applied stereotype edition]]
-<br>''Property of applied stereotype edition''<br>
-<br>
-=====How to=====
+
+''Property of applied stereotype edition''
+
+===How to===
It is possible to edit property of applied stereotype by using the property view:
- 1. Select your element
- 2. Select the Profile tab
- 3. Expand the stereotype
- 4. Select the property
- 5. Edit at right the property of the stereotype<br>
-<br>
+# Select your element
+# Select the Profile tab
+# Expand the stereotype
+# Select the property
+# Edit at right the property of the stereotype
+
[[Image:images/PropertyEdition_PV.png|Property edition for applied stereotypes in the property view]]
-<br>''Property edition for applied stereotypes in the property view''<br>
-<br>
+
+''Property edition for applied stereotypes in the property view''
+
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/stereotype-display-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/stereotype-display-toc.xml
index 6b776aceb90..a467377e58f 100644
--- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/stereotype-display-toc.xml
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/stereotype-display-toc.xml
@@ -1,6 +1,7 @@
<?xml version='1.0' encoding='utf-8' ?>
<toc label="stereotype-display" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusTasks">
<topic label="Customizing stereotypes display">
- <topic href="org.eclipse.papyrus.uml.diagram.common.doc/resource/DisplayStereotypes.html" label="Display Stereotypes"></topic>
+ <anchor id="PapyrusDisplayStereotypes"/>
+ <link toc="target/generated-eclipse-help/DisplayStereotypes-toc.xml"/>
</topic>
</toc>

Back to the top