From 29977a1d10071b45e4fcb38e88f99462e3738aa2 Mon Sep 17 00:00:00 2001 From: Benoit Maggi Date: Tue, 10 Jun 2014 15:26:27 +0200 Subject: Bug 290261 - [Usability] Papyrus shall provide a copy/paste/cut feature - add copy/paste user documentation Change-Id: Ib9086d1b0bb74f0d07e1f388573686debd00c211 Signed-off-by: Benoit Maggi --- .../org.eclipse.papyrus.doc.feature/feature.xml | 140 +++++++++++---------- .../org.eclipse.papyrus.copypaste.ui.doc/.project | 22 ++++ .../.settings/org.eclipse.core.resources.prefs | 3 + .../META-INF/MANIFEST.MF | 8 ++ .../about.html | 28 +++++ .../build.properties | 6 + .../plugin.properties | 16 +++ .../plugin.xml | 15 +++ .../org.eclipse.papyrus.copypaste.ui.doc/pom.xml | 14 +++ .../resource/copypaste-main-toc.xml | 7 ++ .../resource/copypaste-toc.xml | 30 +++++ .../resource/copypaste.html | 9 ++ .../resource/copypaste.mediawiki | 106 ++++++++++++++++ .../resource/images/ConstraintExample.png | Bin 0 -> 8326 bytes .../resource/images/DiagramMenus.png | Bin 0 -> 21943 bytes .../resource/images/ModelExplorerMenus.png | Bin 0 -> 16150 bytes .../resource/images/PastePreferences.png | Bin 0 -> 10794 bytes .../resource/images/RenameExample.png | Bin 0 -> 3797 bytes .../resource/images/StereotypeStrategy.png | Bin 0 -> 3799 bytes releng/top-pom-main.xml | 1 + 20 files changed, 338 insertions(+), 67 deletions(-) create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/.project create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/.settings/org.eclipse.core.resources.prefs create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/META-INF/MANIFEST.MF create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/about.html create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/build.properties create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/plugin.properties create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/plugin.xml create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/pom.xml create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste-main-toc.xml create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste-toc.xml create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste.html create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste.mediawiki create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/ConstraintExample.png create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/DiagramMenus.png create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/ModelExplorerMenus.png create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/PastePreferences.png create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/RenameExample.png create mode 100644 plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/StereotypeStrategy.png diff --git a/features/papyrus-main-features/org.eclipse.papyrus.doc.feature/feature.xml b/features/papyrus-main-features/org.eclipse.papyrus.doc.feature/feature.xml index 4c45abbca28..cc1ec626ec3 100644 --- a/features/papyrus-main-features/org.eclipse.papyrus.doc.feature/feature.xml +++ b/features/papyrus-main-features/org.eclipse.papyrus.doc.feature/feature.xml @@ -1,72 +1,78 @@ - - - - + + + + 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 - - - - %license - - - - - - - - - - - - - - - - - - - +http://www.eclipse.org/legal/epl-v10.html + + + + %license + + + + + + + + + + + + + + + + + + + + + diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/.project b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/.project new file mode 100644 index 00000000000..9bccafb869e --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/.project @@ -0,0 +1,22 @@ + + + org.eclipse.papyrus.copypaste.ui.doc + + + + + + org.eclipse.pde.ManifestBuilder + + + + + org.eclipse.pde.SchemaBuilder + + + + + + org.eclipse.pde.PluginNature + + diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/.settings/org.eclipse.core.resources.prefs b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/.settings/org.eclipse.core.resources.prefs new file mode 100644 index 00000000000..e778789326a --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/.settings/org.eclipse.core.resources.prefs @@ -0,0 +1,3 @@ +eclipse.preferences.version=1 +encoding//resource/copypaste-toc.xml=utf-8 +encoding//resource/copypaste.html=utf-8 diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/META-INF/MANIFEST.MF b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/META-INF/MANIFEST.MF new file mode 100644 index 00000000000..d96f4060e09 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/META-INF/MANIFEST.MF @@ -0,0 +1,8 @@ +Manifest-Version: 1.0 +Require-Bundle: org.eclipse.help +Bundle-ManifestVersion: 2 +Bundle-Name: %pluginName +Bundle-SymbolicName: org.eclipse.papyrus.copypaste.ui.doc;singleton:=true +Bundle-Version: 1.0.0.qualifier +Bundle-Vendor: %providerName +Bundle-Localization: plugin diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/about.html b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/about.html new file mode 100644 index 00000000000..35ab843b7db --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/about.html @@ -0,0 +1,28 @@ + + + + +About + + +

About This Content

+ +

May, 2014

+

License

+ +

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 http://www.eclipse.org/legal/epl-v10.html. +For purposes of the EPL, "Program" will mean the Content.

+ +

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 http://www.eclipse.org.

+ + + \ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/build.properties b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/build.properties new file mode 100644 index 00000000000..1b591767ffe --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/build.properties @@ -0,0 +1,6 @@ +bin.includes = META-INF/,\ + about.html,\ + resource/,\ + plugin.xml,\ + plugin.properties +src.includes = about.html diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/plugin.properties b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/plugin.properties new file mode 100644 index 00000000000..0b30868a038 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/plugin.properties @@ -0,0 +1,16 @@ +########################################################################################## +# Copyright (c) 2014 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: +# Benoit Maggi (CEA LIST) benoit.maggi@cea.fr - Initial API and implementation +# +######################################################################################## + +pluginName = Papyrus Copy/Paste Documentation +providerName = Eclipse Modeling Project diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/plugin.xml new file mode 100644 index 00000000000..c10abae3cb0 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/plugin.xml @@ -0,0 +1,15 @@ + + + + + + + + + + diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/pom.xml new file mode 100644 index 00000000000..96628b292c1 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/pom.xml @@ -0,0 +1,14 @@ + + + 4.0.0 + + org.eclipse.papyrus + org.eclipse.papyrus + 1.0.0-SNAPSHOT + ../../../releng/top-pom-main.xml + + org.eclipse.papyrus.copypaste.ui.doc + org.eclipse.papyrus + 1.0.0-SNAPSHOT + eclipse-plugin + \ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste-main-toc.xml b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste-main-toc.xml new file mode 100644 index 00000000000..57e9753760f --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste-main-toc.xml @@ -0,0 +1,7 @@ + + + + + + + diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste-toc.xml b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste-toc.xml new file mode 100644 index 00000000000..b6d645869cb --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste-toc.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste.html b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste.html new file mode 100644 index 00000000000..1f087e149d9 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste.html @@ -0,0 +1,9 @@ +

Copying/Cutting/Pasting in Papyrus

Introduction

Papyrus's policy is to ensure consistency between models and diagrams, so by default the cut/copy/paste functionalities act both on diagram and model elements.
+The Copy/Cut/Paste functionalities are available between models and diagrams but not between eclipse instances.  
+The Cut/Paste functionalities are disable on root and read only elements.
+

User Interface

Model Explorer Menu

Right click on a model explorer element

Model Explorer KeyBinding

M1 is the COMMAND key on MacOS X, and the CTRL key on most other platforms.
+M2 is the SHIFT key.
+

Diagram Menu

On a Diagram element Right Click>EDIT

Diagram KeyBinding

Preferences

Papyrus copy/paste/cut preferences is accessible on Window>Preferences>Papyrus>Paste
+The preference page lists all the available strategies and the checkbox to select whether the references should be kept.
+

List of Paste strategies

Common Strategies

Default Paste Strategy

The strategy paste all copied elements in the selected place. +It is required for all other strategies.

SterotypeStrategy

The strategy reapply profiles and stereotypes on the newly copied elements.

Preferences

Rename Strategy

Diagram in model Explorer Strategy

The strategy allows copy/paste for diagrams in model explorer.

Table in model Explorer Strategy

The strategy allows copy/paste for tables in model explorer.

Uml Strategies

The following strategies will only apply on uml models

Constraint Paste Strategy

This strategy works only on uml class diagrams. It draws the constraint "context" link after a paste.

Sysml Strategies

The following strategies will only apply on sysml models

Part Paste Strategy

This strategy duplicates the linked association for each property pasted.

\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste.mediawiki b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste.mediawiki new file mode 100644 index 00000000000..410a11bf974 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste.mediawiki @@ -0,0 +1,106 @@ + + +=Copying/Cutting/Pasting in Papyrus= +==Introduction== + +Papyrus's policy is to ensure consistency between models and diagrams, so by default the cut/copy/paste functionalities act both on diagram and model elements. +The Copy/Cut/Paste functionalities are available between models and diagrams but not between eclipse instances. +The Cut/Paste functionalities are disable on root and read only elements. + +==User Interface== +===Model Explorer Menu=== +Right click on a model explorer element + +[[Image:images/ModelExplorerMenus.png]] + +===Model Explorer KeyBinding=== +*Type M1+C for Papyrus copy +*Type M1+X for Papyrus cut +*Type M1+V for Papyrus paste + + M1 is the COMMAND key on MacOS X, and the CTRL key on most other platforms. + M2 is the SHIFT key. + +===Diagram Menu=== +On a Diagram element '''Right Click>EDIT''' + +[[Image:images/DiagramMenus.png]] + +===Diagram KeyBinding=== +*Type M1+C for Papyrus copy +*Type M1+X for Papyrus cut +*Type M1+V for Papyrus paste + +*Type M1+M2+C for Graphical copy +*Type M1+M2+X for Graphical cut +*Type M1+M2+V for Graphical paste + +===Preferences=== + +Papyrus copy/paste/cut preferences is accessible on '''Window>Preferences>Papyrus>Paste''' +The preference page lists all the available strategies and the checkbox to select whether the references should be kept. + +[[Image:images/PastePreferences.png]] + + + +== List of Paste strategies == + +=== Common Strategies === + +==== Default Paste Strategy ==== +The strategy paste all copied elements in the selected place. +It is required for all other strategies. + +==== SterotypeStrategy ==== +The strategy reapply profiles and stereotypes on the newly copied elements. + +===== Preferences ===== +* Always apply missing profiles: missing profiles will be applied to the root of the target model +* Never apply missing profiles: stereotypes referencing missing profiles will not be paste + + +[[Image:images/StereotypeStrategy.png]] + +==== Rename Strategy ==== + +* Only the duplications of the '''roots elements''' will be renamed +* An element is renamed only if there is already an element with the '''same name''' on the paste selection +* The element will be renamed in CopyOf_%NameOfTheElement%_%id%. The id will be incremented for each ''same'' copy/paste. Example: a Class1 will become CopyOf_Class1_1 then CopyOf_Class1_2… + + +[[Image:images/RenameExample.png]] + +==== Diagram in model Explorer Strategy ==== +The strategy allows copy/paste for diagrams in model explorer. + +==== Table in model Explorer Strategy ==== +The strategy allows copy/paste for tables in model explorer. + +=== Uml Strategies === +The following strategies will only apply on uml models + +==== Constraint Paste Strategy ==== +This strategy works only on uml class diagrams. It draws the constraint "context" link after a paste. + +[[Image:images/ConstraintExample.png]] + +=== Sysml Strategies === +The following strategies will only apply on sysml models +==== Part Paste Strategy ==== +This strategy duplicates the linked association for each property pasted. + diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/ConstraintExample.png b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/ConstraintExample.png new file mode 100644 index 00000000000..f2997d4e5da Binary files /dev/null and b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/ConstraintExample.png differ diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/DiagramMenus.png b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/DiagramMenus.png new file mode 100644 index 00000000000..69cf7d4ce8e Binary files /dev/null and b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/DiagramMenus.png differ diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/ModelExplorerMenus.png b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/ModelExplorerMenus.png new file mode 100644 index 00000000000..dffc6d0ac77 Binary files /dev/null and b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/ModelExplorerMenus.png differ diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/PastePreferences.png b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/PastePreferences.png new file mode 100644 index 00000000000..285346fd307 Binary files /dev/null and b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/PastePreferences.png differ diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/RenameExample.png b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/RenameExample.png new file mode 100644 index 00000000000..d7efc3db090 Binary files /dev/null and b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/RenameExample.png differ diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/StereotypeStrategy.png b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/StereotypeStrategy.png new file mode 100644 index 00000000000..d3a8ba7f95d Binary files /dev/null and b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/images/StereotypeStrategy.png differ diff --git a/releng/top-pom-main.xml b/releng/top-pom-main.xml index bdccb62405b..399b226989f 100755 --- a/releng/top-pom-main.xml +++ b/releng/top-pom-main.xml @@ -294,6 +294,7 @@ ../plugins/views/org.eclipse.papyrus.views.search ../plugins/views/validation/org.eclipse.papyrus.views.validation ../plugins/xwt/org.eclipse.papyrus.xwt + ../plugins/doc/org.eclipse.papyrus.copypaste.ui.doc main -- cgit v1.2.3