diff options
Diffstat (limited to 'extraplugins/layers/org.eclipse.papyrus.layers.documentation')
35 files changed, 218 insertions, 19 deletions
diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/.project b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/.project index 35787912949..99176fc7af7 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/.project +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/.project @@ -5,7 +5,18 @@ <projects> </projects> <buildSpec> + <buildCommand> + <name>org.eclipse.pde.ManifestBuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.pde.SchemaBuilder</name> + <arguments> + </arguments> + </buildCommand> </buildSpec> <natures> + <nature>org.eclipse.pde.PluginNature</nature> </natures> </projectDescription> diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/.settings/org.eclipse.core.resources.prefs b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/.settings/org.eclipse.core.resources.prefs new file mode 100644 index 00000000000..47ba1efd3d1 --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/.settings/org.eclipse.core.resources.prefs @@ -0,0 +1,7 @@ +eclipse.preferences.version=1
+encoding//guides/developpers/layersDevs-toc.xml=utf-8
+encoding//guides/developpers/layersDevs.html=utf-8
+encoding//guides/tutorials/derivedLayerTutorial-toc.xml=utf-8
+encoding//guides/tutorials/derivedLayerTutorial.html=utf-8
+encoding//guides/tutorials/simpleTutorial-toc.xml=utf-8
+encoding//guides/tutorials/simpleTutorial.html=utf-8
diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/META-INF/MANIFEST.MF b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/META-INF/MANIFEST.MF new file mode 100644 index 00000000000..73a0509f63f --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/META-INF/MANIFEST.MF @@ -0,0 +1,7 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: %pluginName +Bundle-SymbolicName: org.eclipse.papyrus.layers.documentation;singleton:=true +Bundle-Version: 1.0.0.qualifier +Require-Bundle: org.eclipse.help +Bundle-Vendor: %providerName diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/about.html b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/about.html new file mode 100644 index 00000000000..d35d5aed64c --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/about.html @@ -0,0 +1,28 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/> +<title>About</title> +</head> +<body lang="EN-US"> +<h2>About This Content</h2> + +<p>June 5, 2007</p> +<h3>License</h3> + +<p>The Eclipse Foundation makes available all content in this plug-in ("Content"). Unless otherwise +indicated below, the Content is provided to you under the terms and conditions of the +Eclipse Public License Version 1.0 ("EPL"). A copy of the EPL is available +at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>. +For purposes of the EPL, "Program" will mean the Content.</p> + +<p>If you did not receive this Content directly from the Eclipse Foundation, the Content is +being redistributed by another party ("Redistributor") and different terms and conditions may +apply to your use of any object code in the Content. Check the Redistributor's license that was +provided with the Content. If no such license exists, contact the Redistributor. Unless otherwise +indicated below, the terms and conditions of the EPL still apply to any source code in the Content +and such source code may be obtained at <a href="http://www.eclipse.org/">http://www.eclipse.org</a>.</p> + +</body> +</html> diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/build.properties b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/build.properties new file mode 100644 index 00000000000..415384e8a25 --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/build.properties @@ -0,0 +1,17 @@ +bin.includes = META-INF/,\
+ guides/,\
+ models/,\
+ build.properties,\
+ plugin.xml,\
+ plugin.properties,\
+ about.html,\
+ .settings/
+src.includes = guides/,\
+ models/,\
+ build.properties,\
+ META-INF/,\
+ .project,\
+ .settings/,\
+ plugin.properties,\
+ plugin.xml,\
+ about.html
diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/developpers/layers-toc.xml b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/developpers/layers-toc.xml new file mode 100644 index 00000000000..b54cf6ff390 --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/developpers/layers-toc.xml @@ -0,0 +1,7 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc label="Papyrus Layers" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocDev"> + <topic href="guides/developpers/layersDevs.html" label="Layers Developers Documentation"> + <link toc="guides/developpers/layersDevs-toc.xml"/> + <anchor id="layers.guides.devs"/> + </topic> +</toc> diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs-toc.xml b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs-toc.xml new file mode 100644 index 00000000000..0d173331c62 --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs-toc.xml @@ -0,0 +1,6 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc topic="guides/developpers/layersDevs.html" label="layersDevs"> + <topic href="guides/developpers/layersDevs.html" label="Layers Developpers"></topic> + <topic href="guides/developpers/layersDevs.html#General_Architecture" label="General Architecture"></topic> + <topic href="guides/developpers/layersDevs.html#Plugins" label="Plugins"></topic> +</toc>
\ No newline at end of file diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.html b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.html new file mode 100644 index 00000000000..98dd7080b47 --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.html @@ -0,0 +1 @@ +<?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><h2 id="Layers_Developpers">Layers Developpers</h2><p>This is the documentation for layers developpers</p><h2 id="General_Architecture">General Architecture</h2><h2 id="Plugins">Plugins</h2></body></html>
\ No newline at end of file diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDeveloppers.mediawiki b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.mediawiki index d9a33a73e11..d9a33a73e11 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDeveloppers.mediawiki +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.mediawiki diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial-toc.xml b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial-toc.xml new file mode 100644 index 00000000000..42a0f7e2d56 --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial-toc.xml @@ -0,0 +1,12 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc topic="guides/tutorials/derivedLayerTutorial.html" label="derivedLayerTutorial"> + <topic href="guides/tutorials/derivedLayerTutorial.html" label="Using Derived Layer (OCL Expression)"> + <topic href="guides/tutorials/derivedLayerTutorial.html#Creating_a_derived_Layer" label="Creating a derived Layer"></topic> + <topic href="guides/tutorials/derivedLayerTutorial.html#Writing_an_expression" label="Writing an expression"></topic> + <topic href="guides/tutorials/derivedLayerTutorial.html#Expressions_Examples" label="Expressions Examples"> + <topic href="guides/tutorials/derivedLayerTutorial.html#All_views_starting_with_a_particular_string" label="All views starting with a particular string"></topic> + <topic href="guides/tutorials/derivedLayerTutorial.html#All_classes_that_are_abstract" label="All classes that are abstract"></topic> + <topic href="guides/tutorials/derivedLayerTutorial.html#All_classes_containing_an_operation_named_.27abc.27" label="All classes containing an operation named 'abc'"></topic> + </topic> + </topic> +</toc>
\ No newline at end of file diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.html b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.html new file mode 100644 index 00000000000..cfbff6f7400 --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.html @@ -0,0 +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="Using_Derived_Layer_.28OCL_Expression.29">Using Derived Layer (OCL Expression)</h1><p>This tutorial show how to use a Derived Layer.</p><p>A derived layer is a leaf Layer where the views are automatically attached to +the layer, according to an expression. Actuallty, the expression is expressed in OCL.</p><h2 id="Creating_a_derived_Layer">Creating a derived Layer</h2><h2 id="Writing_an_expression">Writing an expression</h2><h2 id="Expressions_Examples">Expressions Examples</h2><h3 id="All_views_starting_with_a_particular_string">All views starting with a particular string</h3><h3 id="All_classes_that_are_abstract">All classes that are abstract</h3><h3 id="All_classes_containing_an_operation_named_.27abc.27">All classes containing an operation named 'abc'</h3></body></html>
\ No newline at end of file diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.mediawiki b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.mediawiki new file mode 100644 index 00000000000..0a111453132 --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.mediawiki @@ -0,0 +1,18 @@ += Using Derived Layer (OCL Expression) =
+
+This tutorial show how to use a Derived Layer.
+
+A derived layer is a leaf Layer where the views are automatically attached to
+the layer, according to an expression. Actuallty, the expression is expressed in OCL.
+
+== Creating a derived Layer ==
+
+== Writing an expression ==
+
+== Expressions Examples ==
+
+=== All views starting with a particular string ===
+
+=== All classes that are abstract ===
+
+=== All classes containing an operation named 'abc' ===
\ No newline at end of file diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/layers-toc.xml b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/layers-toc.xml new file mode 100644 index 00000000000..af14e0b84aa --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/layers-toc.xml @@ -0,0 +1,8 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc label="Layers Tutorials" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> + <topic label="Layers Tutorials"> + <link toc="guides/tutorials/simpleTutorial-toc.xml"/> + <link toc="guides/tutorials/derivedLayerTutorial-toc.xml"/> + <anchor id="layers.guides.tutorials"/> + </topic> +</toc> diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial-toc.xml b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial-toc.xml new file mode 100644 index 00000000000..cc37f9ba974 --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial-toc.xml @@ -0,0 +1,18 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc topic="guides/tutorials/simpleTutorial.html" label="simpleTutorial"> + <topic href="guides/tutorials/simpleTutorial.html" label="A simple Example and Tutorial"> + <topic href="guides/tutorials/simpleTutorial.html#Create_a_new_Class_Diagram" label="Create a new Class Diagram"></topic> + <topic href="guides/tutorials/simpleTutorial.html#Open_the_LayersExplorer" label="Open the LayersExplorer"></topic> + <topic href="guides/tutorials/simpleTutorial.html#Attach_a_LayersStack_to_your_diagram" label="Attach a LayersStack to your diagram"></topic> + <topic href="guides/tutorials/simpleTutorial.html#Create_a_new_Layer_in_the_LayersStack" label="Create a new Layer in the LayersStack"></topic> + <topic href="guides/tutorials/simpleTutorial.html#Attach_Classes_to_the_Layer" label="Attach Classes to the Layer"></topic> + <topic href="guides/tutorials/simpleTutorial.html#Attach_some_properties_to_the_layer" label="Attach some properties to the layer"></topic> + <topic href="guides/tutorials/simpleTutorial.html#Add_more_layers" label="Add more layers"></topic> + <topic href="guides/tutorials/simpleTutorial.html#Change_the_value_of_an_attached_property" label="Change the value of an attached property"></topic> + <topic href="guides/tutorials/simpleTutorial.html#Add_the_3rd_layer" label="Add the 3rd layer"></topic> + <topic href="guides/tutorials/simpleTutorial.html#Disabling_a_Layer" label="Disabling a Layer"></topic> + </topic> + <topic href="guides/tutorials/simpleTutorial.html#Layer_Operators" label="Layer Operators"> + <topic href="guides/tutorials/simpleTutorial.html#Top_Layer_Operator" label="Top Layer Operator"></topic> + </topic> +</toc>
\ No newline at end of file diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.html b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.html new file mode 100644 index 00000000000..16a657ecba0 --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.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="A_simple_Example_and_Tutorial">A simple Example and Tutorial</h1><p>In this example, we create a class diagram with 3 classes (class1, class2, class3), and a LayersStack with 3 layers (layer2, layer1, bottom). The bottom layer control the 3 classes and all the available properties. The layer1 control Class1 and Class2. The layer2 control Class2 and Class3.</p><p>This example is also a tutorial, if you follow it step by step.</p><h2 id="Create_a_new_Class_Diagram">Create a new Class Diagram</h2><p>Start by creating a Papyrus Class Diagram with 3 classes:</p><ul><li>Create a new ClassDiagram in a Papyrus model</li><li>Create three classes: Class1, Class2, Class3</li><li>Open the Papyrus ModelExplorer and the Property View.</li></ul><p>You should have a diagram and model explorer like in the following figure:</p><p><img border="0" src="simpleTutorialImages/diagramWith3Classes.png"/></p><h2 id="Open_the_LayersExplorer">Open the LayersExplorer</h2><p>To open the LayersExplorer:</p><ul><li>In the diagram, Right Click->Layers->Open LayersExplorer</li></ul><p><img border="0" src="simpleTutorialImages/opnLayersExplorer.png"/></p><ul><li>The explorer should open (not necessarly at the same position as in the following snapshoot):</li></ul><p><img border="0" src="simpleTutorialImages/OpenedLayersExplorer.png"/></p><h2 id="Attach_a_LayersStack_to_your_diagram">Attach a LayersStack to your diagram</h2><p>To attach a LayersStack to your diagram:</p><ul><li>Click in the diagram, then Right Click->Layers->Attach Layer Stack</li></ul><p><img border="0" src="simpleTutorialImages/attachLayersStack.png"/></p><ul><li>The LayersExplorer should show the layers attached to the LayersStack. By default, there is a 'Layer Operator' of type 'Top Layer'. The 'Top Layer Operator' contains layers that are ordered from top to bottom. When computing the value for a particular (view, property type) couple, it search the first layer that define a value for the couple, and return this value.</li></ul><p><img border="0" src="simpleTutorialImages/attachedLayersStack.png"/></p><h2 id="Create_a_new_Layer_in_the_LayersStack">Create a new Layer in the LayersStack</h2><p>We need now to create a layer in the stack.</p><p>To create a new Layer in the LayersStack:</p><ul><li>In the LayerExplorer, select the Top Layer Operator</li><li>right click->Layers->Create Layers ...->Create Layer</li></ul><p><img border="0" src="simpleTutorialImages/createLayer.png"/></p><ul><li>A new layer is created:<ul><li>Open the tree node to see the layer (1)</li><li>Select the layers tab in the Property view (2)</li><li>Change the name of the layer to 'bottomLayer' (3)</li></ul></li></ul><p><img border="0" src="simpleTutorialImages/createdLayer.png"/></p><h2 id="Attach_Classes_to_the_Layer">Attach Classes to the Layer</h2><p>Attaching some classes (also called views) to a layer means that this layer will partially control the value of some properties for this attached classes. +Here, we attach the 3 classes. +To Attach the classes to the Layer:</p><ul><li>Select the layer 'bottomLayer', right click->Layers->Attach Views</li></ul><p><img border="0" src="simpleTutorialImages/attachViewsToLayer.png"/> </p><ul><li>A window open, select the 3 classes (1) and click 'ok (2)'.:</li></ul><p><img border="0" src="simpleTutorialImages/attachViewWindowSelectClasses.png"/></p><h2 id="Attach_some_properties_to_the_layer">Attach some properties to the layer</h2><p>A layer is used to control some properties of the attached views. It is necessary to attach the properties +controled by the layer. Once attached, it is possible to modify the values of this properties.</p><p>To attach some properties to the layer:</p><ul><li>In the LayersExplorer, select the defaul layer, right click->Layers->Attach Properties</li></ul><p><img border="0" src="simpleTutorialImages/openAttachPropertiesWindow.png"/></p><ul><li>The Attach Properties window open. Select properties as in the screenshot, and then 'ok'.</li></ul><p><img border="0" src="simpleTutorialImages/attachPropertiesWindow.png"/></p><ul><li>The properties and the views are now attached to the layers. Properties for these views are computed according to the layer, and as a resul the fill color change. This is because the default value for 'fill color' of the layer property is different from the Papyrus value.<ul><li>You can open the property node in the LayersExplorer, select a property, and change its value in the Property view.</li></ul></li></ul><p><img border="0" src="simpleTutorialImages/defaulLayerProperties.png"/></p><h2 id="Add_more_layers">Add more layers</h2><p>Now, add a new Layer in the Top Layer Operator:</p><ul><li>Select the Top Layer Operator, </li><li>right click->Layers->Create Layers ...->Create Layer</li><li>The new layer shoul appear as the first layer of the top layer operator.</li><li>Attach the class1 and class2</li><li>Attach the fill property</li></ul><h2 id="Change_the_value_of_an_attached_property">Change the value of an attached property</h2><p>You can change the value of the fill property color for the layer.</p><ul><li>Open the node 'Color' of the 'Fill Property' </li><li>click on the color picker in the Property view. </li><li>Choose a new color (blue).</li><li>The color should be applied on the 2 classes attached to the layer (Class1 and Class2). </li><li>Class3 still have the color of the 'bottom' layer.</li></ul><p><img border="0" src="simpleTutorialImages/changeFillColorValue.png"/></p><ul><li>Note that Class1 and Class2 color change to 'blue' because when computing the color for Class1, the first layer that attach both Class1and Property Fill is the Layer1. In this layer, the value for the Property Fill is 'blue', so it is for Class1. The same happen for class2.</li></ul><h2 id="Add_the_3rd_layer">Add the 3rd layer</h2><ul><li>Add a 3rd layer<ul><li>Attach the 2 classes Class2 and Class3 to this layer.</li><li>Attach the property 'Fill Color'</li><li>Change the value of 'Fill Color' to orange<ul><li>Class2 and Class3 should change to orange.</li></ul></li></ul></li></ul><p><img border="0" src="simpleTutorialImages/layer2.png"/></p><h2 id="Disabling_a_Layer">Disabling a Layer</h2><p>It is possible to disable a layer without deleting it. A disabled layer do not participate in layer stack.</p><p>To disable a layer, select it in the LayersExplorer.</p><ul><li>Then in the PropertyView, open the Layers tab</li><li>select or unselect the layer with 'Is Layer Enable".<ul><li>Note that in our example, disabling the Layer2 will change the color of the Class2 and Class3. Class2 take the color specified by layer1, and Class3 the color specified by bottomLayer.</li></ul></li></ul><p><img border="0" src="simpleTutorialImages/disableLayer.png"/></p><h1 id="Layer_Operators">Layer Operators</h1><p>Layer Operators are a kind of layer that can contain other Layers.</p><p>A layer operator is called like this because it is used to apply an 'operator' on its nested layers. The operator compute the property values for attached layers.</p><p>It is not possible to attach directly views or properties to a layer operator. But a layer operator still have a set of attached views and a set of attached properties. The values of these properties are the results of applying the operator on the properties of the nested layers. The set of the attached views is generally the union of the views attached to the nested layers.</p><p>There is different kind of 'layer operators', each one proposing a different way of computing the property values.</p><h2 id="Top_Layer_Operator">Top Layer Operator</h2><p>The 'Top Layer Operator' contains layers that are ordered from top to bottom. It is called 'Top Layer Operator' because it return the top most value for a particular (view, property type) couple. </p><p>When computing the property value for a specified (view, property type), the Top Layer Operator return the first value found for this couple. It start from the top layer, and stop as soon as a layer as a value set for the specified (view, property type).</p></body></html>
\ No newline at end of file diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/layers.mediawiki b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.mediawiki index e4d64b4ff72..c4289c45315 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/layers.mediawiki +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.mediawiki @@ -1,33 +1,37 @@ -= Overview = -= A simple Example = + + += A simple Example and Tutorial = In this example, we create a class diagram with 3 classes (class1, class2, class3), and a LayersStack with 3 layers (layer2, layer1, bottom). The bottom layer control the 3 classes and all the available properties. The layer1 control Class1 and Class2. The layer2 control Class2 and Class3. +This example is also a tutorial, if you follow it step by step. + == Create a new Class Diagram == Start by creating a Papyrus Class Diagram with 3 classes: * Create a new ClassDiagram in a Papyrus model * Create three classes: Class1, Class2, Class3 * Open the Papyrus ModelExplorer and the Property View. +You should have a diagram and model explorer like in the following figure: -[[Image:]] +[[Image:simpleTutorialImages/diagramWith3Classes.png]] == Open the LayersExplorer == To open the LayersExplorer: * In the diagram, Right Click->Layers->Open LayersExplorer -[[Image:opnLayersExplorer.png]] +[[Image:simpleTutorialImages/opnLayersExplorer.png]] * The explorer should open (not necessarly at the same position as in the following snapshoot): -[[Image:OpenedLayersExplorer.png]] +[[Image:simpleTutorialImages/OpenedLayersExplorer.png]] == Attach a LayersStack to your diagram == To attach a LayersStack to your diagram: * Click in the diagram, then Right Click->Layers->Attach Layer Stack -[[Image:attachLayersStack.png]] +[[Image:simpleTutorialImages/attachLayersStack.png]] * The LayersExplorer should show the layers attached to the LayersStack. By default, there is a 'Layer Operator' of type 'Top Layer'. The 'Top Layer Operator' contains layers that are ordered from top to bottom. When computing the value for a particular (view, property type) couple, it search the first layer that define a value for the couple, and return this value. -[[Image:attachedLayersStack.png]] +[[Image:simpleTutorialImages/attachedLayersStack.png]] == Create a new Layer in the LayersStack == We need now to create a layer in the stack. @@ -36,13 +40,13 @@ To create a new Layer in the LayersStack: * In the LayerExplorer, select the Top Layer Operator * right click->Layers->Create Layers ...->Create Layer -[[Image:createLayer.png]] +[[Image:simpleTutorialImages/createLayer.png]] * A new layer is created: ** Open the tree node to see the layer (1) ** Select the layers tab in the Property view (2) ** Change the name of the layer to 'bottomLayer' (3) -[[Image:createdLayer.png]] +[[Image:simpleTutorialImages/createdLayer.png]] == Attach Classes to the Layer == @@ -51,10 +55,10 @@ Attaching some classes (also called views) to a layer means that this layer will Here, we attach the 3 classes. To Attach the classes to the Layer: * Select the layer 'bottomLayer', right click->Layers->Attach Views -[[Image:attachViewsToLayer.png]] +[[Image:simpleTutorialImages/attachViewsToLayer.png]] * A window open, select the 3 classes (1) and click 'ok (2)'.: -[[Image:attachViewWindowSelectClasses.png]] +[[Image:simpleTutorialImages/attachViewWindowSelectClasses.png]] == Attach some properties to the layer == @@ -63,14 +67,14 @@ controled by the layer. Once attached, it is possible to modify the values of th To attach some properties to the layer: * In the LayersExplorer, select the defaul layer, right click->Layers->Attach Properties -[[Image:openAttachPropertiesWindow.png]] +[[Image:simpleTutorialImages/openAttachPropertiesWindow.png]] * The Attach Properties window open. Select properties as in the screenshot, and then 'ok'. -[[Image:attachPropertiesWindow.png]] +[[Image:simpleTutorialImages/attachPropertiesWindow.png]] * The properties and the views are now attached to the layers. Properties for these views are computed according to the layer, and as a resul the fill color change. This is because the default value for 'fill color' of the layer property is different from the Papyrus value. ** You can open the property node in the LayersExplorer, select a property, and change its value in the Property view. -[[Image:defaulLayerProperties.png]] +[[Image:simpleTutorialImages/defaulLayerProperties.png]] @@ -90,7 +94,7 @@ You can change the value of the fill property color for the layer. * Choose a new color (blue). * The color should be applied on the 2 classes attached to the layer (Class1 and Class2). * Class3 still have the color of the 'bottom' layer. -[[Image:changeFillColorValue.png]] +[[Image:simpleTutorialImages/changeFillColorValue.png]] * Note that Class1 and Class2 color change to 'blue' because when computing the color for Class1, the first layer that attach both Class1and Property Fill is the Layer1. In this layer, the value for the Property Fill is 'blue', so it is for Class1. The same happen for class2. @@ -101,7 +105,7 @@ You can change the value of the fill property color for the layer. ** Attach the property 'Fill Color' ** Change the value of 'Fill Color' to orange *** Class2 and Class3 should change to orange. -[[Image:layer2.png]] +[[Image:simpleTutorialImages/layer2.png]] == Disabling a Layer == @@ -111,7 +115,7 @@ To disable a layer, select it in the LayersExplorer. * Then in the PropertyView, open the Layers tab * select or unselect the layer with 'Is Layer Enable". ** Note that in our example, disabling the Layer2 will change the color of the Class2 and Class3. Class2 take the color specified by layer1, and Class3 the color specified by bottomLayer. -[[Image:disableLayer.png]] +[[Image:simpleTutorialImages/disableLayer.png]] = Layer Operators = @@ -130,5 +134,3 @@ The 'Top Layer Operator' contains layers that are ordered from top to bottom. It When computing the property value for a specified (view, property type), the Top Layer Operator return the first value found for this couple. It start from the top layer, and stop as soon as a layer as a value set for the specified (view, property type). - - diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/OpenedLayersExplorer.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/OpenedLayersExplorer.png Binary files differindex 3243d6a59a0..3243d6a59a0 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/OpenedLayersExplorer.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/OpenedLayersExplorer.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/attachLayersStack.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachLayersStack.png Binary files differindex fb89859462d..fb89859462d 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/attachLayersStack.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachLayersStack.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/attachPropertiesWindow.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachPropertiesWindow.png Binary files differindex 43352b552f8..43352b552f8 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/attachPropertiesWindow.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachPropertiesWindow.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/attachViewWindow.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewWindow.png Binary files differindex 9aad29fef4c..9aad29fef4c 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/attachViewWindow.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewWindow.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/attachViewWindowSelectClasses.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewWindowSelectClasses.png Binary files differindex 3275da01c65..3275da01c65 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/attachViewWindowSelectClasses.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewWindowSelectClasses.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/attachViewsToLayer.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewsToLayer.png Binary files differindex 669be6f747e..669be6f747e 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/attachViewsToLayer.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewsToLayer.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/attachedLayersStack.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachedLayersStack.png Binary files differindex 8d536ad621e..8d536ad621e 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/attachedLayersStack.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachedLayersStack.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/changeFillColorValue.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/changeFillColorValue.png Binary files differindex db065e6effe..db065e6effe 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/changeFillColorValue.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/changeFillColorValue.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/createLayer.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/createLayer.png Binary files differindex 190ec7c5fba..190ec7c5fba 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/createLayer.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/createLayer.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/createdLayer.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/createdLayer.png Binary files differindex 27564e6d832..27564e6d832 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/createdLayer.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/createdLayer.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/defaulLayerProperties.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/defaulLayerProperties.png Binary files differindex e2da266906d..e2da266906d 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/defaulLayerProperties.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/defaulLayerProperties.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/diagramWith3Classes.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/diagramWith3Classes.png Binary files differnew file mode 100644 index 00000000000..45529bd2afa --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/diagramWith3Classes.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/disableLayer.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/disableLayer.png Binary files differindex f4cb2f36020..f4cb2f36020 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/disableLayer.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/disableLayer.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/layer2.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/layer2.png Binary files differindex 9181d275fcb..9181d275fcb 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/layer2.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/layer2.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/openAttachPropertiesWindow.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/openAttachPropertiesWindow.png Binary files differindex 79c2737f73e..79c2737f73e 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/openAttachPropertiesWindow.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/openAttachPropertiesWindow.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/opnLayersExplorer.png b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/opnLayersExplorer.png Binary files differindex 4a4a2c92104..4a4a2c92104 100644 --- a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/opnLayersExplorer.png +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/opnLayersExplorer.png diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/index-toc.xml b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/index-toc.xml new file mode 100644 index 00000000000..5794b056e91 --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/guides/users/index-toc.xml @@ -0,0 +1,7 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc label="Layers Documentation" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> + <topic label="Layers Documentation"> + <link toc="guides/tutorials/derivedLayerTutorial-toc.xml"/> + <anchor id="layers.guides.documentations"/> + </topic> +</toc> diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/plugin.properties b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/plugin.properties new file mode 100644 index 00000000000..d95844cddec --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/plugin.properties @@ -0,0 +1,12 @@ +################################################################################# +# Copyright (c) 2013 CEA LIST. +# All rights reserved. This program and the accompanying materials +# are made available under the terms of the Eclipse Public License v1.0 +# which accompanies this distribution, and is available at +# http://www.eclipse.org/legal/epl-v10.html +# +# Contributors: +# Cedric Dumoulin Cedric.dumoulin@lifl.fr - Initial API and implementation +################################################################################## +pluginName=Papyrus Layers Documentation +providerName=Eclipse Modeling Project diff --git a/extraplugins/layers/org.eclipse.papyrus.layers.documentation/plugin.xml b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/plugin.xml new file mode 100644 index 00000000000..b84c5ad70ff --- /dev/null +++ b/extraplugins/layers/org.eclipse.papyrus.layers.documentation/plugin.xml @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<?eclipse version="3.4"?>
+<plugin>
+ <extension
+ point="org.eclipse.help.toc">
+ <toc
+ file="guides/users/index-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="guides/tutorials/layers-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="guides/tutorials/simpleTutorial-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="guides/tutorials/derivedLayerTutorial-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="guides/developpers/layers-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="guides/developpers/layersDevs-toc.xml"
+ primary="false">
+ </toc>
+ </extension>
+
+</plugin>
|
