summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPatrik Nandorf2014-06-11 10:20:06 (EDT)
committerCamille Letavernier2014-06-20 09:59:27 (EDT)
commitd05c912c95858a34c44835d3734398ebb1dccd8a (patch)
tree9b94277ce951cb404ed7dcd5449c7371012a1db6
parent0c708e11fb6e31d026db2e9d0d02db964b7c8752 (diff)
downloadorg.eclipse.papyrus-d05c912c95858a34c44835d3734398ebb1dccd8a.zip
org.eclipse.papyrus-d05c912c95858a34c44835d3734398ebb1dccd8a.tar.gz
org.eclipse.papyrus-d05c912c95858a34c44835d3734398ebb1dccd8a.tar.bz2
399858: [Documentation] Papyrus shall have an embedded documentation
https://bugs.eclipse.org/bugs/show_bug.cgi?id=399858 - Minor fixes for the Symbols documentation Signed-off-by: Patrik Nandorf <patrik.nandorf@ericsson.com>
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.html6
-rw-r--r--plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.mediawiki10
2 files changed, 9 insertions, 7 deletions
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.html
index c74e468..49b57fd 100644
--- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.html
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.html
@@ -1,6 +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><p>This short documentation will present the support for custom representations available to Papyrus users </p><h1 id="Introduction">Introduction</h1><p>The goal of the sympbol support in Papyrus is to give users access to some custom representations. They can use their own representation, i.e. their own svg files, in their diagrams, so the model can be easily read and understood. SVG file format was used, as this vectorial format scales easily. </p><p><img border="0" src="Symbol_Example.png"/> </p><h1 id="Symbol_display_place_in_diagrams">Symbol display place in diagrams</h1><p>There are 2 manners to display symbols on the diagrams. </p><h2 id="Symbol_representation_in_compartments">Symbol representation in compartments</h2><p>For all nodes, like Package or Class in a Class diagram, it is possible to display the symbols in a "shape" compartment. This compartment can be displayed/hidden using the context menu on the diagram </p><p><img border="0" src="Symbol_Compartment.png"/> </p><p>To display/hide shape compartment:&nbsp; </p><ul><li>Right click on the node </li><li>Filters </li><li>Show/Hide Compartments </li><li>Select "shape". you can also select if you wish to show/hide the title of the shape compartment. </li><li>OK</li></ul><p><br/> </p><pre>Hint: you can also select the node and press 'Ctrl'+'F5' simultaneously to display the Show/hide Compartment dialog
-</pre><p> </p><h2 id="Symbol_representation_as_a_decorator">Symbol representation as a decorator</h2><p>For all Nodes in diagrams, it is possible to display the available symbols as decorators. The decorators are small representations depicted above the figures. for example, validation errors and warnings are displayed as decorators on Papyrus diagrams. </p><p><img border="0" src="Symbol_Decorator.png"/> </p><p>The Appearance tab of the properties view allows user to toggle the visibility of decorators, and the location of the display on the figure. There are 9 positions on the figure (north/east/south/west and all valid combinations) </p><p><img border="0" src="Symbol_DecoratorPropertyView.png"/> </p><pre>Hint: if the properties view is not displayed in your Eclipse environnement, you can display it using context menu on a diagram =&amp;gt; show Properties view.
-</pre><p> </p><h1 id="Defining_symbols_in_models">Defining symbols in models</h1><p>This section explains how symbols can be associated to model elements. There are currently 3 ways to define specific symbols for model elements. </p><h2 id="Define_new_symbols_in_profiles">Define new symbols in profiles</h2><p>UML offers the possiblity to associate new icons to stereotyped elements, via the <i>image</i> Property of Stereotypes. In Papyrus, one of this image can be a shape. This shape will be availalbe for any node representation of a steoretyped element. </p><p>On the property view of a Stereotype, you can associate an image to the stereotype </p><p><img border="0" src="Symbol_AddImageToStereotype.png"/> </p><p>This shape wil now be available on all elements that are stereotyped by this given Stereotype. </p><pre>Hint: You can have more documentation about profiles in Papyrus on the website, users corner
+<?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><ol style="list-style: none;"><li><a href="#Introduction">Introduction</a></li><li><a href="#Symbol_display_place_in_diagrams">Symbol display place in diagrams</a><ol style="list-style: none;"><li><a href="#Symbol_representation_in_compartments">Symbol representation in compartments</a></li><li><a href="#Symbol_representation_as_a_decorator">Symbol representation as a decorator</a></li></ol></li><li><a href="#Defining_symbols_in_models">Defining symbols in models</a><ol style="list-style: none;"><li><a href="#Define_new_symbols_in_profiles">Define new symbols in profiles</a></li><li><a href="#Symbol_associated_to_Actor_UML_element">Symbol associated to Actor UML element</a></li><li><a href="#Symbol_associated_to_Type_element">Symbol associated to Type element</a></li></ol></li><li><a href="#FAQ">FAQ</a></li></ol><p>This short documentation will present the support for custom representations available to Papyrus users </p><h1 id="Introduction">Introduction</h1><p>The goal of the symbol support in Papyrus is to give users access to some custom representations. They can use their own representation, i.e. their own svg files, in their diagrams, so the model can be easily read and understood. SVG file format was used, as this vectorial format scales easily. </p><p><img border="0" src="Symbol_Example.png"/> </p><h1 id="Symbol_display_place_in_diagrams">Symbol display place in diagrams</h1><p>There are 2 manners to display symbols on the diagrams, in compartments and as decorators.</p><h2 id="Symbol_representation_in_compartments">Symbol representation in compartments</h2><p>For all nodes, like Package or Class in a Class diagram, it is possible to display the symbols in a "shape" compartment. This compartment can be displayed/hidden using the context menu on the diagram </p><p><img border="0" src="Symbol_Compartment.png"/> </p><p>To display/hide shape compartment:&nbsp; </p><ul><li>Right click on the node </li><li>Filters </li><li>Show/Hide Compartments </li><li>Select "shape". you can also select if you wish to show/hide the title of the shape compartment. </li><li>OK</li></ul><p><br/> </p><pre>Hint: you can also select the node and press 'Ctrl'+'F5' simultaneously to display the Show/hide Compartment dialog
+</pre><p> </p><h2 id="Symbol_representation_as_a_decorator">Symbol representation as a decorator</h2><p>For all Nodes in diagrams, it is possible to display the available symbols as decorators. The decorators are small representations depicted above the figures. for example, validation errors and warnings are displayed as decorators on Papyrus diagrams. </p><p><img border="0" src="Symbol_Decorator.png"/> </p><p>The Appearance tab of the properties view allows user to toggle the visibility of decorators, and the location of the display on the figure. There are 9 positions on the figure (north/east/south/west and all valid combinations) </p><p><img border="0" src="Symbol_DecoratorPropertyView.png"/> </p><pre>Hint: if the properties view is not displayed in your Eclipse environnement, you can display it using context menu on a diagram =&gt; show Properties view.
+</pre><p> </p><h1 id="Defining_symbols_in_models">Defining symbols in models</h1><p>This section explains how symbols can be associated to model elements. There are currently 3 ways to define specific symbols for model elements. </p><h2 id="Define_new_symbols_in_profiles">Define new symbols in profiles</h2><p>UML offers the possiblity to associate new icons to stereotyped elements, via the <i>image</i> Property of Stereotypes. In Papyrus, one of these images can be a shape. This shape will be availalbe for any node representation of a steoretyped element. </p><p>On the property view of a Stereotype, you can associate an image to the stereotype </p><p><img border="0" src="Symbol_AddImageToStereotype.png"/> </p><p>This shape wil now be available on all elements that are stereotyped by this given Stereotype. </p><pre>Hint: You can have more documentation about profiles in Papyrus on the website, users corner
</pre><p> </p><h2 id="Symbol_associated_to_Actor_UML_element">Symbol associated to Actor UML element</h2><p>By default, Actors and TypedElement that are typed by an Actor have a stickman symbol associated. </p><p><img border="0" src="Symbol_ActorAndTypedElementWithTypeActor.png"/> </p><h2 id="Symbol_associated_to_Type_element">Symbol associated to Type element</h2><p>The last way to associate symbols to model element is to apply the PapryusInternal profile. </p><p>Steps: </p><ul><li>Select the model in which you want to associate symbols to types. </li><li>Go to the property view </li><li>Go to the profile Tab </li><li>Select the icon for the registered profiles in the Applied Profile section</li></ul><p><img border="0" src="Symbol_ApplyRegisteredProfile.png"/> </p><ul><li>In the dialog, select the PapyrusInternal Profile</li></ul><p><img border="0" src="Symbol_ProfileSelectionDialog.png"/> </p><ul><li>In the next dialog, select all profiles and subprofiles</li></ul><p><img border="0" src="Symbol_ProfileSelectionDialogAllSubProfile.png"/> </p><ul><li>OK</li></ul><p><br/> </p><p>As soon as the Internal profile is applied, the user can apply a specific stereotype on Type elements. On this stereotype, a field allows user to define a symbol for the stereotyped Type. Then the symbol will be available for all representations of this Type and the representations of TypedElements typed by it. </p><p>Steps: </p><ul><li>Select the Type for which you want to associate a symbol </li><li>Go to the property view </li><li>Go to the profile Tab </li><li>Apply the TypeSymbolDefinition stereotype (available on Type elements, as soon as the internal profile is applied on the model)</li></ul><p><img border="0" src="Symbol_ApplyTypeSymbolDefinitionStereotype.png"/> </p><p><img border="0" src="Symbol_ApplyTypeSymbolDefinitionStereotypeDialog.png"/> </p><ul><li>Select the property symbolPath of the TypeSymbolDefinition stereotype.</li></ul><ul><li>Set the path to the symbol file</li></ul><p><img border="0" src="Symbol_TypeSymbolDefinition_SymbolPath.png"/> </p><h1 id="FAQ">FAQ</h1><ul><li>What is the format supported for the symbols?</li></ul><p>Currently, Papyrus supports SVG and PNG files. </p><ul><li>What are the limitations of the SVG support?</li></ul><p>Papyrus relies on a SVG render provided by the GMF project. This renderer do not support all the funny things provided by the SVG format. For example, it is known that the gradients are not supported. If a svg file has some gradient in its definition, it will not be displayed at all by Papryus. </p><ul><li>What is the syntax for the path to the symbol?</li></ul><p>Paths can be expressed as Eclipse URIs (Either absolute or relative to the current model), e.g: </p><pre>platform:/plugin/org.eclipse.papyrus.uml.diagram.common/icons/symbols/actor.svg
</pre><p>
=&gt; This is a svg image contained in the plug-in {oep}.uml.diagram.common </p><pre>Images/logo.svg
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.mediawiki b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.mediawiki
index 0df6c73..c07d80b 100644
--- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.mediawiki
+++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.mediawiki
@@ -1,14 +1,16 @@
+__TOC__
+
This short documentation will present the support for custom representations available to Papyrus users
= Introduction =
-The goal of the sympbol support in Papyrus is to give users access to some custom representations. They can use their own representation, i.e. their own svg files, in their diagrams, so the model can be easily read and understood. SVG file format was used, as this vectorial format scales easily.
+The goal of the symbol support in Papyrus is to give users access to some custom representations. They can use their own representation, i.e. their own svg files, in their diagrams, so the model can be easily read and understood. SVG file format was used, as this vectorial format scales easily.
[[Image:Symbol Example.png]]
= Symbol display place in diagrams =
-There are 2 manners to display symbols on the diagrams.
+There are 2 manners to display symbols on the diagrams, in compartments and as decorators.
== Symbol representation in compartments ==
@@ -36,7 +38,7 @@ For all Nodes in diagrams, it is possible to display the available symbols as de
The Appearance tab of the properties view allows user to toggle the visibility of decorators, and the location of the display on the figure. There are 9 positions on the figure (north/east/south/west and all valid combinations)
[[Image:Symbol DecoratorPropertyView.png]]
-<pre>Hint: if the properties view is not displayed in your Eclipse environnement, you can display it using context menu on a diagram =&gt; show Properties view.
+<pre>Hint: if the properties view is not displayed in your Eclipse environnement, you can display it using context menu on a diagram => show Properties view.
</pre>
= Defining symbols in models =
@@ -44,7 +46,7 @@ This section explains how symbols can be associated to model elements. There are
== Define new symbols in profiles ==
-UML offers the possiblity to associate new icons to stereotyped elements, via the ''image'' Property of Stereotypes. In Papyrus, one of this image can be a shape. This shape will be availalbe for any node representation of a steoretyped element.
+UML offers the possiblity to associate new icons to stereotyped elements, via the ''image'' Property of Stereotypes. In Papyrus, one of these images can be a shape. This shape will be availalbe for any node representation of a steoretyped element.
On the property view of a Stereotype, you can associate an image to the stereotype