diff options
| author | cdamus | 2013-04-23 16:14:38 +0000 |
|---|---|---|
| committer | cdamus | 2013-04-23 16:14:38 +0000 |
| commit | 500301bed32132e43066eb98dc80a150bf57b4f7 (patch) | |
| tree | 79337c1b0765999b95b455e0d04c6e35deb4afc6 /plugins | |
| parent | 1395c33b443d441bf436a71ba1c0355c33b2d331 (diff) | |
| download | org.eclipse.papyrus-500301bed32132e43066eb98dc80a150bf57b4f7.tar.gz org.eclipse.papyrus-500301bed32132e43066eb98dc80a150bf57b4f7.tar.xz org.eclipse.papyrus-500301bed32132e43066eb98dc80a150bf57b4f7.zip | |
[405652] [CDO] Move the CDO doc plug-in to the main docs folder.
https://bugs.eclipse.org/bugs/show_bug.cgi?id=405652
Diffstat (limited to 'plugins')
26 files changed, 442 insertions, 0 deletions
diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/.classpath b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/.classpath new file mode 100644 index 00000000000..bc1d55c3059 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/.classpath @@ -0,0 +1,5 @@ +<?xml version="1.0" encoding="UTF-8"?> +<classpath> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/J2SE-1.5"/> + <classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/> +</classpath> diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/.project b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/.project new file mode 100644 index 00000000000..54b65bee1b4 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/.project @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>org.eclipse.papyrus.cdo.ui.doc</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.jdt.core.javabuilder</name> + <arguments> + </arguments> + </buildCommand> + <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> + <nature>org.eclipse.jdt.core.javanature</nature> + </natures> +</projectDescription> diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/.settings/org.eclipse.jdt.core.prefs b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/.settings/org.eclipse.jdt.core.prefs new file mode 100644 index 00000000000..af0f20f97a5 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/.settings/org.eclipse.jdt.core.prefs @@ -0,0 +1,7 @@ +eclipse.preferences.version=1 +org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled +org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.5 +org.eclipse.jdt.core.compiler.compliance=1.5 +org.eclipse.jdt.core.compiler.problem.assertIdentifier=error +org.eclipse.jdt.core.compiler.problem.enumIdentifier=error +org.eclipse.jdt.core.compiler.source=1.5 diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/META-INF/MANIFEST.MF b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/META-INF/MANIFEST.MF new file mode 100644 index 00000000000..a680f423a90 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/META-INF/MANIFEST.MF @@ -0,0 +1,10 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: %pluginName +Bundle-SymbolicName: org.eclipse.papyrus.cdo.ui.doc;singleton:=true +Bundle-Version: 0.10.0.qualifier +Bundle-Vendor: %providerName +Bundle-RequiredExecutionEnvironment: J2SE-1.5 +Bundle-Localization: plugin +Require-Bundle: org.eclipse.help;bundle-version="3.6.0", + org.eclipse.papyrus.infra.doc;bundle-version="0.10.0" diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/about.html b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/about.html new file mode 100644 index 00000000000..5ddc72c177f --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/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>November 20, 2008</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>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/build.properties b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/build.properties new file mode 100644 index 00000000000..b73395d4db9 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/build.properties @@ -0,0 +1,8 @@ +bin.includes = META-INF/,\ + .,\ + about.html,\ + plugin.properties,\ + plugin.xml,\ + resource/ +bin.excludes = **/*.md +src.includes = about.html diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/plugin.properties b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/plugin.properties new file mode 100644 index 00000000000..00cfe430fd3 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/plugin.properties @@ -0,0 +1,13 @@ +# 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:
+# CEA LIST - Initial API and implementation
+#
+
+pluginName=Papyrus CDO Model Repository Documentation (Incubation)
+providerName=Eclipse Modeling Project
diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/plugin.xml new file mode 100644 index 00000000000..196c66a420c --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/plugin.xml @@ -0,0 +1,38 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<?eclipse version="3.4"?>
+
+<!--
+ 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:
+ CEA LIST - Initial API and implementation
+
+-->
+
+<plugin>
+ <extension
+ point="org.eclipse.help.toc">
+ <toc
+ file="resource/cdo-main-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="resource/start/cdo-start-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="resource/team/cdo-team-toc.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="resource/bugs/cdo-bugs-toc.xml"
+ primary="false">
+ </toc>
+ </extension>
+
+</plugin>
diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/bugs/cdo-bugs-toc.xml b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/bugs/cdo-bugs-toc.xml new file mode 100644 index 00000000000..90f74048535 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/bugs/cdo-bugs-toc.xml @@ -0,0 +1,6 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<toc label="Limitations and Known Issues" topic="resource/bugs/cdo-bugs.html"> + <topic href="resource/bugs/cdo-bugs.html#Limitations" label="Limitations and Known Issues"></topic> + <anchor id="cdo-bugs-additions"/> + <anchor id="cdo-bugs-after"/> +</toc> diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/bugs/cdo-bugs.html b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/bugs/cdo-bugs.html new file mode 100644 index 00000000000..3ab30d88ca7 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/bugs/cdo-bugs.html @@ -0,0 +1,37 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"/> + <meta name="creator" content="Marked.app"/> +</head> +<body> +<h1 id="aidlimitationslimitationsandknownissuesa"><a id="Limitations">Limitations and Known Issues</a></h1> + +<p>The following Papyrus capabilities are supported on models in CDO repositories:</p> + +<ul> +<li>create new UML and SysML models + +<ul> +<li>initialize Papyrus model from existing domain model resource in the repository</li> +<li>import models from the workspace</li> +<li>reorganize models in folders by drag-and-drop</li> +</ul></li> +<li>create and edit all kinds of UML and SysML diagram</li> +<li>create and edit tables</li> +<li>export models to the workspace</li> +<li>browse connected repositories for importing packages and applying profiles</li> +<li>CSS diagram styling and themes (with restrictions, see below)</li> +<li>properties view customization models can be stored in and loaded from the repository</li> +</ul> + +<p>Some capabilities of Papyrus are not support on models in CDO repositories in this release:</p> + +<ul> +<li>compare/merge: the <strong>Model Repositories</strong> view does not support branches and no “compare with each other” action is provided</li> +<li>although CSS styling of diagrams is supported, this extends only to CSS stylsheets deployed in plug-ins. Custom stylesheets stored locally in the workspace or in a repository are not supported</li> +<li>controlled resources are not supported</li> +<li>attaching documents to model elements is not supported</li> +</ul> +</body> +</html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/bugs/cdo-bugs.md b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/bugs/cdo-bugs.md new file mode 100644 index 00000000000..47643dcada2 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/bugs/cdo-bugs.md @@ -0,0 +1,21 @@ +# <a id="Limitations">Limitations and Known Issues</a> + +The following Papyrus capabilities are supported on models in CDO repositories: + +* create new UML and SysML models + * initialize Papyrus model from existing domain model resource in the repository + * import models from the workspace + * reorganize models in folders by drag-and-drop +* create and edit all kinds of UML and SysML diagram +* create and edit tables +* export models to the workspace +* browse connected repositories for importing packages and applying profiles +* CSS diagram styling and themes (with restrictions, see below) +* properties view customization models can be stored in and loaded from the repository + +Some capabilities of Papyrus are not support on models in CDO repositories in this release: + +* compare/merge: the **Model Repositories** view does not support branches and no "compare with each other" action is provided +* although CSS styling of diagrams is supported, this extends only to CSS stylsheets deployed in plug-ins. Custom stylesheets stored locally in the workspace or in a repository are not supported +* controlled resources are not supported +* attaching documents to model elements is not supported
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/cdo-main-toc.xml b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/cdo-main-toc.xml new file mode 100644 index 00000000000..da6ee34c2d6 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/cdo-main-toc.xml @@ -0,0 +1,10 @@ +<?xml version='1.0' encoding='utf-8' ?>
+<toc label="CDO Model Repository" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser">
+ <topic href="resource/start/cdo-start.html" label="Working with CDO Model Repositories">
+ <link toc="resource/start/cdo-start-toc.xml"/>
+ <link toc="resource/team/cdo-team-toc.xml"/>
+ <link toc="resource/bugs/cdo-bugs-toc.xml"/>
+ <anchor id="cdo-additions"/>
+ </topic>
+
+</toc>
diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/addrepo.png b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/addrepo.png Binary files differnew file mode 100644 index 00000000000..0d379a8a77a --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/addrepo.png diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/cdo-start-toc.xml b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/cdo-start-toc.xml new file mode 100644 index 00000000000..7ea66ca775a --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/cdo-start-toc.xml @@ -0,0 +1,11 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<toc label="Getting Started" topic="resource/start/cdo-start.html"> + <topic href="resource/start/cdo-start.html" label="Getting Started"> + <topic href="resource/start/cdo-start.html#Installing" label="Installation"></topic> + <topic href="resource/start/cdo-start.html#Connecting" label="Connecting to a Repository"></topic> + <topic href="resource/start/cdo-start.html#Importing" label="Importing Models form the Workspace"></topic> + <topic href="resource/start/cdo-start.html#Validating" label="Validating Models"></topic> + <anchor id="cdo-start-additions"/> + </topic> + <anchor id="cdo-start-after"/> +</toc> diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/cdo-start.html b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/cdo-start.html new file mode 100644 index 00000000000..8deb614f798 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/cdo-start.html @@ -0,0 +1,82 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"/> + <meta name="creator" content="Marked.app"/> +</head> +<body> +<h1 id="workingwithcdomodelrepositories">Working with CDO Model Repositories</h1> + +<p>This document is a brief guide to getting started with Papyrus UML models in the CDO Model Repository.</p> + +<p>For more information about CDO, see the <a href="http://wiki.eclipse.org/CDO">EMF CDO wiki</a>.</p> + +<h2 id="aidinstallinginstallationa"><a id="Installing">Installation</a></h2> + +<p>The CDO Model Repository integration feature is not installed by default with Papyrus; it is an optional extra component. To install this feature, open the Papyrus discovery wizard from the <strong>Help → Install Papyrus Additional Components</strong> menu. You should find an entry like the following in the list:</p> + +<figure> +<img src="discovery_dialog.png" alt="Install additional components" /> +<figcaption>Install additional components</figcaption></figure> + + + +<p>Select the CDO integration feature by checking the box on the left side and press <strong>Finish</strong> to perform the installation.</p> + +<h2 id="aidconnectingconnectingtoarepositorya"><a id="Connecting">Connecting to a Repository</a></h2> + +<p>Repository connections are managed in the <strong>Model Repositories</strong> view. Use the <strong>Add Repository…</strong> button in the view to create a new repository connection:</p> + +<figure> +<img src="addrepo.png" alt="Add repository" /> +<figcaption>Add repository</figcaption></figure> + + + +<p>If your repository requires user authentication, a login dialog will appear to accept your credentials.</p> + +<p>The new repository is then added to the view. Select the new repository and pick <strong>New Papyrus Model</strong> in the context menu. Complete the wizard. You should now have a new blank model open and something like this in the <strong>Model Repositories</strong> view:</p> + +<figure> +<img src="modelreposview.png" alt="Model Repositories view" /> +<figcaption>Model Repositories view</figcaption></figure> + + + +<p>Note that because it is necessary to explicitly connect to model repositories, any model editors that are open when shutting down the Papyrus workbench are not re-opened on next launch.</p> + +<h2 id="aidimportingimportingmodelsfromtheworkspacea"><a id="Importing">Importing Models from the Workspace</a></h2> + +<p>You probably already have models in your workspace that you would like to import into a repository. To do this, select one or more models in the <strong>Project Explorer</strong> and choose the <strong>Import into Repository…</strong> action in the context menu. Alternatively, just drag and drop one or more model onto a repository.</p> + +<figure> +<img src="importmodels.png" alt="Import Models" /> +<figcaption>Import Models</figcaption></figure> + + + +<p>By default, the wizard maps incoming models to paths in the repository according to their paths in the workspace. This mapping may be customized in the last page.</p> + +<p>As a first step, the wizard analyzes the selected models for cross-reference dependencies. It is highly recommended also to import any models that references the initially selected models. Otherwise, they will be updated to reference the models in the repository and it may be difficult to edit them when Papyrus is not connected to the repository.</p> + +<p>It is also suggested to import models referenced by the initial selection. However, references from models in a repository to models in the workspace do not present the same kind of problem of availability as the reverse case.</p> + +<h2 id="aidvalidatingvalidatingmodelsa"><a id="Validating">Validating Models</a></h2> + +<p>The <strong>Validate</strong> context menu actions work in repository models just as in workspace models. Annotations are presented in the diagrams and in the <strong>Model Explorer</strong> view. The difference is that validation issues are not shown in the <strong>Problems</strong> view. Instead, they are shown in a new <strong>Model Validation</strong> view:</p> + +<figure> +<img src="validation.png" alt="Model Validation" /> +<figcaption>Model Validation</figcaption></figure> + + + +<p>The <strong>Model Validation</strong> view supports the usual functions, including:</p> + +<ul> +<li>double-click navigation to the problem element in the editor</li> +<li>copy selected problems to CSV text on the system clipboard</li> +<li>delete problems</li> +</ul> +</body> +</html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/cdo-start.md b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/cdo-start.md new file mode 100644 index 00000000000..a63f6961934 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/cdo-start.md @@ -0,0 +1,49 @@ +# Working with CDO Model Repositories +This document is a brief guide to getting started with Papyrus UML models in the CDO Model Repository. + +For more information about CDO, see the [EMF CDO wiki](http://wiki.eclipse.org/CDO). + +## <a id="Installing">Installation</a> +The CDO Model Repository integration feature is not installed by default with Papyrus; it is an optional extra component. To install this feature, open the Papyrus discovery wizard from the **Help → Install Papyrus Additional Components** menu. You should find an entry like the following in the list: + + + +Select the CDO integration feature by checking the box on the left side and press **Finish** to perform the installation. + +## <a id="Connecting">Connecting to a Repository</a> +Repository connections are managed in the **Model Repositories** view. Use the **Add Repository...** button in the view to create a new repository connection: + + + +If your repository requires user authentication, a login dialog will appear to accept your credentials. + +The new repository is then added to the view. Select the new repository and pick **New Papyrus Model** in the context menu. Complete the wizard. You should now have a new blank model open and something like this in the **Model Repositories** view: + + + +Note that because it is necessary to explicitly connect to model repositories, any model editors that are open when shutting down the Papyrus workbench are not re-opened on next launch. + +## <a id="Importing">Importing Models from the Workspace</a> + +You probably already have models in your workspace that you would like to import into a repository. To do this, select one or more models in the **Project Explorer** and choose the **Import into Repository...** action in the context menu. Alternatively, just drag and drop one or more model onto a repository. + + + +By default, the wizard maps incoming models to paths in the repository according to their paths in the workspace. This mapping may be customized in the last page. + +As a first step, the wizard analyzes the selected models for cross-reference dependencies. It is highly recommended also to import any models that references the initially selected models. Otherwise, they will be updated to reference the models in the repository and it may be difficult to edit them when Papyrus is not connected to the repository. + +It is also suggested to import models referenced by the initial selection. However, references from models in a repository to models in the workspace do not present the same kind of problem of availability as the reverse case. + +## <a id="Validating">Validating Models</a> + +The **Validate** context menu actions work in repository models just as in workspace models. Annotations are presented in the diagrams and in the **Model Explorer** view. The difference is that validation issues are not shown in the **Problems** view. Instead, they are shown in a new **Model Validation** view: + + + +The **Model Validation** view supports the usual functions, including: + +* double-click navigation to the problem element in the editor +* copy selected problems to CSV text on the system clipboard +* delete problems + diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/discovery_dialog.png b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/discovery_dialog.png Binary files differnew file mode 100644 index 00000000000..1f1080707d7 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/discovery_dialog.png diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/importmodels.png b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/importmodels.png Binary files differnew file mode 100644 index 00000000000..ff58c068c2b --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/importmodels.png diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/modelreposview.png b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/modelreposview.png Binary files differnew file mode 100644 index 00000000000..932508075f6 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/modelreposview.png diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/validation.png b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/validation.png Binary files differnew file mode 100644 index 00000000000..dcd7585597f --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/validation.png diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/cdo-team-toc.xml b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/cdo-team-toc.xml new file mode 100644 index 00000000000..5b08ea0e72f --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/cdo-team-toc.xml @@ -0,0 +1,9 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<toc label="Sharing Models with a Team" topic="resource/team/cdo-team.html"> + <topic href="resource/team/cdo-team.html" label="Sharing Models with a Team"> + <topic href="resource/team/cdo-team.html#Locking" label="Locking Objects"></topic> + <topic href="resource/team/cdo-team.html#Conflicts" label="Handling Conflicts"></topic> + <anchor id="cdo-team-additions"/> + </topic> + <anchor id="cdo-team-after"/> +</toc> diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/cdo-team.html b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/cdo-team.html new file mode 100644 index 00000000000..30968f22d18 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/cdo-team.html @@ -0,0 +1,52 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"/> + <meta name="creator" content="Marked.app"/> +</head> +<body> +<h1 id="sharingmodelswithateam">Sharing Models with a Team</h1> + +<p>One purpose of keeping Papyrus models in a CDO model repository is to share them with a team and enjoy the benefits of real-time collaboration that CDO offers. However, this entails certain consequences that need to be accounted for in the workflow.</p> + +<h2 id="aidlockinglockingobjectsa"><a id="Locking">Locking Objects</a></h2> + +<p>The context menu in both the <strong>Model Explorer</strong> view and the diagrams has actions for locking and unlocking objects. Locking a model element reserves it for the exclusive use of the editor that has it locked. Other users connected to the same repository cannot edit it. Locking an element in a diagram locks not only the model element, but also the view of it in the diagram.</p> + +<p>An object locked by you shows a key decoration. To lock an element, use the <strong>Locks/Conflicts → Lock</strong> context menu action:</p> + +<figure> +<img src="locked.png" alt="A locally locked element" /> +<figcaption>A locally locked element</figcaption></figure> + + + +<p>To unlock an object once you have finished editing it and saved the model, use the <strong>Locks/Conflicts → Unlock</strong> context menu action. Locks are also automatically released when the editor that holds them is closed.</p> + +<p>When another user has locked an element, the editor shows a lock decoration:</p> + +<figure> +<img src="remotely_locked.png" alt="A remotely locked element" /> +<figcaption>A remotely locked element</figcaption></figure> + + + +<p>Note that in this case, the element cannot be edited: the <strong>Properties</strong> view is disabled and the diagram editor does not show the selection handles.</p> + +<h2 id="aidconflictshandlingconflictsa"><a id="Conflicts">Handling Conflicts</a></h2> + +<p>CDO is a real-time collaborative editing platform. When other users save changes they have made in models that are open in your Papyrus workbench, the repository server pushes those changes into your editors. You see those changes in real time. There is no “synchronize” step as with Git or Subversion source control.</p> + +<p>Most changes saved by other users will be in different model elements and diagram views than those in which you have unsaved changes. These do not present a problem. However, the repository may push changes in objects that you <em>have</em> edited and have not yet saved. Many of these changes, too, are automatically merged by Papyrus: changes to features of an object that you have not modified and certain changes in multi-valued features can be merged automatically. Other changes leave the objects that you have edited in a state of conflict. This is indicated by a decoration in the diagrams and the <strong>Model Explorer</strong> view:</p> + +<figure> +<img src="conflict.png" alt="Conflicting changes" /> +<figcaption>Conflicting changes</figcaption></figure> + + + +<p>Papyrus cannot automatically resolve these conflicts by merging the incoming changes from the repository with the changes made in your editor. They require manual intervention to resolve.</p> + +<p>On an object that shows conflict, invoke the <strong>Locks/Conflicts → Resolve Conflicts</strong> context menu action. In the current release, the only strategy available is to rollback the editor’s unsaved changes, leaving only the changes pushed by the server from other users. Future releases will add more options, such as an interactive graphical merge.</p> +</body> +</html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/cdo-team.md b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/cdo-team.md new file mode 100644 index 00000000000..4a4ae0ea3f1 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/cdo-team.md @@ -0,0 +1,28 @@ +# Sharing Models with a Team +One purpose of keeping Papyrus models in a CDO model repository is to share them with a team and enjoy the benefits of real-time collaboration that CDO offers. However, this entails certain consequences that need to be accounted for in the workflow. + +## <a id="Locking">Locking Objects</a> +The context menu in both the **Model Explorer** view and the diagrams has actions for locking and unlocking objects. Locking a model element reserves it for the exclusive use of the editor that has it locked. Other users connected to the same repository cannot edit it. Locking an element in a diagram locks not only the model element, but also the view of it in the diagram. + +An object locked by you shows a key decoration. To lock an element, use the **Locks/Conflicts → Lock** context menu action: + + + +To unlock an object once you have finished editing it and saved the model, use the **Locks/Conflicts → Unlock** context menu action. Locks are also automatically released when the editor that holds them is closed. + +When another user has locked an element, the editor shows a lock decoration: + + + +Note that in this case, the element cannot be edited: the **Properties** view is disabled and the diagram editor does not show the selection handles. + +## <a id="Conflicts">Handling Conflicts</a> +CDO is a real-time collaborative editing platform. When other users save changes they have made in models that are open in your Papyrus workbench, the repository server pushes those changes into your editors. You see those changes in real time. There is no "synchronize" step as with Git or Subversion source control. + +Most changes saved by other users will be in different model elements and diagram views than those in which you have unsaved changes. These do not present a problem. However, the repository may push changes in objects that you *have* edited and have not yet saved. Many of these changes, too, are automatically merged by Papyrus: changes to features of an object that you have not modified and certain changes in multi-valued features can be merged automatically. Other changes leave the objects that you have edited in a state of conflict. This is indicated by a decoration in the diagrams and the **Model Explorer** view: + + + +Papyrus cannot automatically resolve these conflicts by merging the incoming changes from the repository with the changes made in your editor. They require manual intervention to resolve. + +On an object that shows conflict, invoke the **Locks/Conflicts → Resolve Conflicts** context menu action. In the current release, the only strategy available is to rollback the editor's unsaved changes, leaving only the changes pushed by the server from other users. Future releases will add more options, such as an interactive graphical merge.
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/conflict.png b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/conflict.png Binary files differnew file mode 100644 index 00000000000..781acd4759f --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/conflict.png diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/locked.png b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/locked.png Binary files differnew file mode 100644 index 00000000000..bf2133ddbdb --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/locked.png diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/remotely_locked.png b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/remotely_locked.png Binary files differnew file mode 100644 index 00000000000..46ec3aebc27 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/remotely_locked.png |
