diff options
Diffstat (limited to 'plugins/doc')
414 files changed, 1532 insertions, 1497 deletions
diff --git a/plugins/doc/.gitignore b/plugins/doc/.gitignore new file mode 100644 index 00000000000..d0ef5a53fe4 --- /dev/null +++ b/plugins/doc/.gitignore @@ -0,0 +1,3 @@ +#ignoring neested eclipse project, keeping it as a pure maven project +.project +.classpath diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/build.properties b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/build.properties index b73395d4db9..a17ae1c5dd3 100644 --- a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/build.properties @@ -3,6 +3,7 @@ bin.includes = META-INF/,\ about.html,\ plugin.properties,\ plugin.xml,\ - resource/ -bin.excludes = **/*.md -src.includes = about.html + target/generated-eclipse-help/** +bin.excludes = **/*.markdown +src.includes = about.html,\ + resource/ diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/plugin.xml index 196c66a420c..cb934f3c8b7 100644 --- a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/plugin.xml @@ -18,19 +18,19 @@ <extension
point="org.eclipse.help.toc">
<toc
- file="resource/cdo-main-toc.xml"
+ file="target/generated-eclipse-help/cdo-main-toc.xml"
primary="false">
</toc>
<toc
- file="resource/start/cdo-start-toc.xml"
+ file="target/generated-eclipse-help/start/cdo-start-toc.xml"
primary="false">
</toc>
<toc
- file="resource/team/cdo-team-toc.xml"
+ file="target/generated-eclipse-help/team/cdo-team-toc.xml"
primary="false">
</toc>
<toc
- file="resource/bugs/cdo-bugs-toc.xml"
+ file="target/generated-eclipse-help/bugs/cdo-bugs-toc.xml"
primary="false">
</toc>
</extension>
diff --git a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/pom.xml index c7d4088b716..b6471916635 100644 --- a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.markdown.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file 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 deleted file mode 100644 index 90f74048535..00000000000 --- a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/bugs/cdo-bugs-toc.xml +++ /dev/null @@ -1,6 +0,0 @@ -<?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 deleted file mode 100644 index 3ab30d88ca7..00000000000 --- a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/bugs/cdo-bugs.html +++ /dev/null @@ -1,37 +0,0 @@ -<!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.markdown index 47643dcada2..47643dcada2 100644 --- 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.markdown 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 index da6ee34c2d6..b21d14421c5 100644 --- 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 @@ -1,9 +1,9 @@ <?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"/>
+ <topic href="target/generated-eclipse-help/start/cdo-start.html" label="Working with CDO Model Repositories">
+ <link toc="target/generated-eclipse-help/start/cdo-start-toc.xml"/>
+ <link toc="target/generated-eclipse-help/team/cdo-team-toc.xml"/>
+ <link toc="target/generated-eclipse-help/bugs/cdo-bugs-toc.xml"/>
<anchor id="cdo-additions"/>
</topic>
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 deleted file mode 100644 index 7ea66ca775a..00000000000 --- a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/cdo-start-toc.xml +++ /dev/null @@ -1,11 +0,0 @@ -<?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 deleted file mode 100644 index 8deb614f798..00000000000 --- a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/start/cdo-start.html +++ /dev/null @@ -1,82 +0,0 @@ -<!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.markdown index a63f6961934..a63f6961934 100644 --- 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.markdown 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 deleted file mode 100644 index 5b08ea0e72f..00000000000 --- a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/cdo-team-toc.xml +++ /dev/null @@ -1,9 +0,0 @@ -<?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 deleted file mode 100644 index 30968f22d18..00000000000 --- a/plugins/doc/org.eclipse.papyrus.cdo.ui.doc/resource/team/cdo-team.html +++ /dev/null @@ -1,52 +0,0 @@ -<!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.markdown index 4a4ae0ea3f1..4a4ae0ea3f1 100644 --- 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.markdown 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 index 6cdbd169fb0..3e1c251418e 100644 --- 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 @@ -1,5 +1,6 @@ Manifest-Version: 1.0
-Require-Bundle: org.eclipse.help
+Require-Bundle: org.eclipse.help;bundle-version="3.6.0",
+ org.eclipse.papyrus.infra.doc;bundle-version="1.1.0"
Bundle-Vendor: %providerName
Bundle-Version: 1.1.0.qualifier
Bundle-Name: %pluginName
diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/build.properties b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/build.properties index 1b591767ffe..b7f01d49a76 100644 --- a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/build.properties @@ -1,6 +1,7 @@ bin.includes = META-INF/,\ about.html,\ - resource/,\ plugin.xml,\ - plugin.properties -src.includes = about.html + plugin.properties,\ + target/generated-eclipse-help/** +src.includes = about.html,\ + resource/ diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/plugin.xml index c10abae3cb0..f157befd554 100644 --- a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/plugin.xml @@ -4,11 +4,11 @@ <extension point="org.eclipse.help.toc"> <toc - file="resource/copypaste-toc.xml" + file="target/generated-eclipse-help/copypaste-toc.xml" primary="false"> </toc> <toc - file="resource/copypaste-main-toc.xml" + file="target/generated-eclipse-help/copypaste-main-toc.xml" primary="false"> </toc> </extension> diff --git a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/pom.xml index a278a3482b2..65769807685 100644 --- a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ 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 index 57e9753760f..df6fceb8ba4 100644 --- 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 @@ -1,7 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?> <toc label="Copy/Paste" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> - <topic href="resource/copypaste.html" label="Using Copy/paste"> - <link toc="resource/copypaste-toc.xml"/> + <topic href="target/generated-eclipse-help/copypaste.html" label="Using Copy/paste"> + <link toc="target/generated-eclipse-help/copypaste-toc.xml"/> <anchor id="copypaste"/> </topic> </toc> 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 deleted file mode 100644 index b6d645869cb..00000000000 --- a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste-toc.xml +++ /dev/null @@ -1,30 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/copypaste.html" label="copypaste"> - <topic href="resource/copypaste.html" label="Copying/Cutting/Pasting in Papyrus"> - <topic href="resource/copypaste.html#Introduction" label="Introduction"></topic> - <topic href="resource/copypaste.html#User_Interface" label="User Interface"> - <topic href="resource/copypaste.html#Model_Explorer_Menu" label="Model Explorer Menu"></topic> - <topic href="resource/copypaste.html#Model_Explorer_KeyBinding" label="Model Explorer KeyBinding"></topic> - <topic href="resource/copypaste.html#Diagram_Menu" label="Diagram Menu"></topic> - <topic href="resource/copypaste.html#Diagram_KeyBinding" label="Diagram KeyBinding"></topic> - <topic href="resource/copypaste.html#Preferences" label="Preferences"></topic> - </topic> - <topic href="resource/copypaste.html#List_of_Paste_strategies" label="List of Paste strategies"> - <topic href="resource/copypaste.html#Common_Strategies" label="Common Strategies"> - <topic href="resource/copypaste.html#Default_Paste_Strategy" label="Default Paste Strategy"></topic> - <topic href="resource/copypaste.html#SterotypeStrategy" label="SterotypeStrategy"> - <topic href="resource/copypaste.html#Preferences_2" label="Preferences"></topic> - </topic> - <topic href="resource/copypaste.html#Rename_Strategy" label="Rename Strategy"></topic> - <topic href="resource/copypaste.html#Diagram_in_model_Explorer_Strategy" label="Diagram in model Explorer Strategy"></topic> - <topic href="resource/copypaste.html#Table_in_model_Explorer_Strategy" label="Table in model Explorer Strategy"></topic> - </topic> - <topic href="resource/copypaste.html#Uml_Strategies" label="Uml Strategies"> - <topic href="resource/copypaste.html#Constraint_Paste_Strategy" label="Constraint Paste Strategy"></topic> - </topic> - <topic href="resource/copypaste.html#Sysml_Strategies" label="Sysml Strategies"> - <topic href="resource/copypaste.html#Part_Paste_Strategy" label="Part Paste Strategy"></topic> - </topic> - </topic> - </topic> -</toc>
\ 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 deleted file mode 100644 index 1f087e149d9..00000000000 --- a/plugins/doc/org.eclipse.papyrus.copypaste.ui.doc/resource/copypaste.html +++ /dev/null @@ -1,9 +0,0 @@ -<?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="Copying.2FCutting.2FPasting_in_Papyrus">Copying/Cutting/Pasting in Papyrus</h1><h2 id="Introduction">Introduction</h2><pre>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. -</pre><h2 id="User_Interface">User Interface</h2><h3 id="Model_Explorer_Menu">Model Explorer Menu</h3><p>Right click on a model explorer element</p><p><img border="0" src="images/ModelExplorerMenus.png"/></p><h3 id="Model_Explorer_KeyBinding">Model Explorer KeyBinding</h3><ul><li>Type M1+C for Papyrus copy</li><li>Type M1+X for Papyrus cut</li><li>Type M1+V for Papyrus paste</li></ul><pre>M1 is the COMMAND key on MacOS X, and the CTRL key on most other platforms. -M2 is the SHIFT key. -</pre><h3 id="Diagram_Menu">Diagram Menu</h3><p>On a Diagram element <b>Right Click>EDIT</b> </p><p><img border="0" src="images/DiagramMenus.png"/></p><h3 id="Diagram_KeyBinding">Diagram KeyBinding</h3><ul><li>Type M1+C for Papyrus copy</li><li>Type M1+X for Papyrus cut</li><li>Type M1+V for Papyrus paste</li></ul><ul><li>Type M1+M2+C for Graphical copy</li><li>Type M1+M2+X for Graphical cut</li><li>Type M1+M2+V for Graphical paste</li></ul><h3 id="Preferences">Preferences</h3><pre>Papyrus copy/paste/cut preferences is accessible on <b>Window>Preferences>Papyrus>Paste</b> -The preference page lists all the available strategies and the checkbox to select whether the references should be kept. -</pre><p><img border="0" src="images/PastePreferences.png"/></p><h2 id="List_of_Paste_strategies">List of Paste strategies</h2><h3 id="Common_Strategies">Common Strategies</h3><h4 id="Default_Paste_Strategy">Default Paste Strategy</h4><p>The strategy paste all copied elements in the selected place. -It is required for all other strategies.</p><h4 id="SterotypeStrategy">SterotypeStrategy</h4><p>The strategy reapply profiles and stereotypes on the newly copied elements.</p><h5 id="Preferences_2">Preferences</h5><ul><li>Always apply missing profiles: missing profiles will be applied to the root of the target model</li><li>Never apply missing profiles: stereotypes referencing missing profiles will not be paste</li></ul><p><img border="0" src="images/StereotypeStrategy.png"/></p><h4 id="Rename_Strategy">Rename Strategy</h4><ul><li>Only the duplications of the <b>roots elements</b> will be renamed</li><li>An element is renamed only if there is already an element with the <b>same name</b> on the paste selection</li><li>The element will be renamed in CopyOf_%NameOfTheElement%_%id%. The id will be incremented for each <i>same</i> copy/paste. Example: a Class1 will become CopyOf_Class1_1 then CopyOf_Class1_2…</li></ul><p><img border="0" src="images/RenameExample.png"/></p><h4 id="Diagram_in_model_Explorer_Strategy">Diagram in model Explorer Strategy</h4><p>The strategy allows copy/paste for diagrams in model explorer. </p><h4 id="Table_in_model_Explorer_Strategy">Table in model Explorer Strategy</h4><p>The strategy allows copy/paste for tables in model explorer. </p><h3 id="Uml_Strategies">Uml Strategies</h3><p>The following strategies will only apply on uml models</p><h4 id="Constraint_Paste_Strategy">Constraint Paste Strategy</h4><p>This strategy works only on uml class diagrams. It draws the constraint "context" link after a paste. </p><p><img border="0" src="images/ConstraintExample.png"/></p><h3 id="Sysml_Strategies">Sysml Strategies</h3><p>The following strategies will only apply on sysml models</p><h4 id="Part_Paste_Strategy">Part Paste Strategy</h4><p>This strategy duplicates the linked association for each property pasted. </p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/build.properties b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/build.properties index eaf743af822..08c955df26a 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/build.properties @@ -3,7 +3,8 @@ output.. = bin/ bin.includes = META-INF/,\
.,\
plugin.xml,\
- resource/,\
about.html,\
plugin.properties
-src.includes = about.html + target/generated-eclipse-help/**
+src.includes = about.html,\
+ resource/ diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/plugin.xml index 368dc50a301..054206f3230 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/plugin.xml @@ -2,7 +2,7 @@ <?eclipse version="3.4"?>
<plugin>
<extension point="org.eclipse.help.toc">
- <toc file="resource/dsml-validation-main-toc.xml" primary="false"/>
- <toc file="resource/dsml-validation-toc.xml" primary="false"/>
+ <toc file="target/generated-eclipse-help/dsml-validation-main-toc.xml" primary="false"/>
+ <toc file="target/generated-eclipse-help/dsml-validation-toc.xml" primary="false"/>
</extension>
</plugin>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/pom.xml index bae2d6df262..46c77f656ba 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/dsml-validation-main-toc.xml b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/dsml-validation-main-toc.xml index d83123369ae..f8bd1b976e3 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/dsml-validation-main-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/dsml-validation-main-toc.xml @@ -1,7 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?>
-<toc label="Write and validate (OCL) constraints of a profile" link_to="../org.eclipse.papyrus.uml.diagram.common.doc/resource/constraints-toc.xml#Constraints">
- <topic href="resource/dsml-validation.html" label="Validate (OCL) constraints of a profile">
- <link toc="resource/dsml-validation-toc.xml"/>
+<toc label="Write and validate (OCL) constraints of a profile" link_to="../org.eclipse.papyrus.uml.diagram.common.doc/target/generatedeclipse-help/constraints-toc.xml#Constraints">
+ <topic href="target/generated-eclipse-help/dsml-validation.html" label="Validate (OCL) constraints of a profile">
+ <link toc="target/generated-eclipse-help/dsml-validation-toc.xml"/>
<anchor id="ValidateConstraints"/>
</topic>
</toc>
diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/dsml-validation-toc.xml b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/dsml-validation-toc.xml deleted file mode 100644 index ee1d57c8adb..00000000000 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/dsml-validation-toc.xml +++ /dev/null @@ -1,11 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/dsml-validation.html" label="dsml-validation"> - <topic href="resource/dsml-validation.html#Generation_from_Constraints" label="Generation from Constraints"> - <topic href="resource/dsml-validation.html#Generate_constraints_directly_into_the_definition" label="Generate constraints directly into the definition"> - <topic href="resource/dsml-validation.html#How_to_5" label="How to"></topic> - </topic> - <topic href="resource/dsml-validation.html#Generate_constraints_as_EMF_validation_plugins" label="Generate constraints as EMF validation plugins"> - <topic href="resource/dsml-validation.html#How_to_6" label="How to"></topic> - </topic> - </topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/dsml-validation.html b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/dsml-validation.html deleted file mode 100644 index df694e17a52..00000000000 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/dsml-validation.html +++ /dev/null @@ -1,52 +0,0 @@ -<?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="Constraint_validation">Constraint validation</h1><p>Papyrus supports two alternative ways of validating whether constraints are respected by models. Both ways provide the option to augment the information presented to the user when a given constraint fails. The user is always presented a list of constraints that failed. While this is an important information, it is better to have a customized message describing what is wrong. It's also useful to specify the severity, in particular, whether a constraint violation is an error or warning.</p><p>To augment the default constraint failure information you can either generate the constraints directly into the profile definition or generate a plugin that embeds the constraints. Both approaches are described below.</p><h2 id="Generate_constraints_directly_into_the_profile_definition">Generate constraints directly into the profile definition</h2><h3 id="Embedding_Basic_OCL_Constraint_Definitions">Embedding Basic OCL Constraint Definitions</h3><p>Constraints written in OCL within a UML profile can be generated into the definition of the profile. The constraint definition is taken into account during the validation of models that have applied the profile. This method is only applicable for OCL constraints.</p><p>How to embed the constraints definitions into a UML Profile:</p><ul><li>1. Save the profile</li><li>2. Papyrus asks: "Would you like to define it" (the profile), select Yes</li><li>3. Ensure "Save OCL constraints, if any, into the profile definition" is selected (this is checked by default). Please note that you should not embed constraints into the profile, if you plan to generate a plugin (see next section)<br/></li></ul><p><center> -<img border="0" src="PapyrusDSML-ConstraintDefinition.png"/><br/> -Save OCL Constraints in the Profile Definition -</center></p><h3 id="Refine_constraint_validation">Refine constraint validation</h3><p>The OCL pivot delegate supports a specific way to define a customized message and severity in the OCL constraint: The constraint needs to be written in form of a tuple, as shown here for an example.</p><pre> -Tuple{ - status=base_Class.isActive, - message='\'' + base_Class.name + '\' is not active', - severity=-5 -}.status -</pre><p>The original constraint expression is defined in the status field of the tuple, as well as the message and severity fields. Whereas only the status field is returned during evaluation, OCL evaluation with the Pivot delegate will also evaluate the custom message and severity.</p><p>Please note that this is just a different way to write OCL constraints, they are put into the profile definition in the same way as described above. -At the moment, there is no specific support in Papyrus to facilitate entering OCL expressions in this way. Since the whole tuple is a "normal" OCL expression, syntax validation and completion is supported by the xtext based expression editor. But it is currently not clear whether Papyrus will offer a way to edit this tuple in a user friendly way, e.g. by synchronizing message and severity with information from the DSML stereotype and only showing the original OCL constraint to the user.</p><h3 id="Summary">Summary</h3><p>If you only deal with OCL constraints, this method is simple and straightforward. But it is not possible to select whether constraints defined in this way are included for validation or not (they are always included).</p><h2 id="Generate_a_plugin_that_embeds_the_constraints">Generate a plugin that embeds the constraints</h2><p>Users can generate a plugin from a profile that embeds the constraints, which are expressed either in OCL or Java. OCL constraints are embedded into the plugin.xml while Java constraints can directly be compiled into code. This is supported by the EMF validation framework.</p><p>CAVEAT: The validation of OCL rules within a plugin is a rather old mechanism. It does not take the user preference of an OCL validation delegate into account. Therefore, validation is done with the classical LPG mechanism whereas the constraint editor within Papyrus validates the constraint itself (not whether other parts of the model respect the constraint) using the Pivot OCL mechanism. In particular, the qualified name of UML meta classes in LPG must start with uml:: whereas Pivot requires UML:: (upper case). In the future Papyrus will offer a way to ensure that the Pivot will be used for OCL contraints within plugins.</p><h3 id="How_to_embed_the_generate_constraints_into_a_plugin">How to embed the generate constraints into a plugin</h3><ul><li>1. Install the DSML validation support from the Papyrus extensions</li></ul><p>Help->Install New Software, select Papyrus update site, deselect "group items by category" and search for DSML.</p><ul><li>2. Select the UML Profile element in the Model Explorer</li><li>3. Right click UML Profile element</li><li>4. Select "Create validation plugin for this DSML" from the context menu</li></ul><p><center> -<img border="0" src="PapyrusDSML-PluginValidationGeneration.png"/><br/> -Starting the validation plugin creation process -</center></p><ul><li>5. Choose whether you want to create a new plugin or generate the code into the plugin containing the profile. The latter is the default.</li></ul><p><center> -<img border="0" src="PapyrusDSML-GenPluginQuestion.png"/><br/> -Running the constraint validation creation wizard -</center></p><ul><li>6. <a href="Only">in case of new plugin</a>: Enter a Project name when prompted by the wizard, complete the wizard and select Finish</li></ul><p><center> -<img border="0" src="PapyrusDSML-PluginWizard.png"/><br/> -Running the constraint validation creation wizard -</center></p><ul><li>7. Install or deploy the plugin with associated profile</li></ul><h3 id="Refine_constraint_validation_2">Refine constraint validation</h3><p>Papyrus supports a UML profile that enables a developer to refine how constraints are violated. This profile is called Domain Specific Modeling Language (DSML), since it is often used in the context of profiles that adds domain specific concepts to UML.</p><p>The additional profile enables a specification of the following properties:</p><ul><li>Mode: Defines if the validation of the constraint is done in “batch” or “live” mode</li><li>Severity: Defines the severity of the constraint violation. It can be one of INFORMATION, WARNING or ERROR. The latter is the default severity (if none is specified). The CANCEL severity should be used with caution, as it causes the validation operation to be interrupted, possibly resulting in the loss of valuable diagnostic information from other constraints.</li><li>Message: Defines the message that will be displayed if the constraint is violated</li><li>Description: Provides a description of the constraint </li><li>Enabled by default: Defined if this constraint should be enabled by default or not</li></ul><p>The attributes of the profile correspond quite closely to the possibilities that the EMF validation framework offers when constraints are specified in the plugin.xml of a profile.</p><p>Advanced users can also define:</p><ul><li>Status code: The plug-in unique status code, useful for logging. </li><li>Target: The element to be validated (normally not required since generated context selectors take care of that, see section below)</li></ul><p>Please note that the additional constraint information is only taken in to account if you generate a plugin embedding the constraints into the plugin.xml, as discussed above.</p><h3 id="How_to_apply_the_DSML_validation_profile">How to apply the DSML validation profile</h3><ul><li>1. Install the DSML profile from the Papyrus extensions</li></ul><p>Help->Install New Software, select Papyrus update site, deselect "group items by category" and search for DSML</p><ul><li>2. Select the UML Profile element in the Model Explorer</li></ul><ul><li>3. Select the Profile tab in the Properties View</li></ul><ul><li>4. Click on the "Apply registered profile" button</li></ul><ul><li>5. Select the "DSML Validation" profile</li></ul><p><center> -<img border="0" src="PapyrusDSML-profileApplication.png"/><br/> -Applying the DSML Validation Profile -</center></p><ul><li>5. Select the UML Constraint element in the Model Explorer or diagram</li></ul><ul><li>6. Select the Profile tab of the Properties View</li></ul><ul><li>7. Click on the "Apply stereotype" button</li></ul><ul><li>8. Select the ValidationRule stereotype</li></ul><p><center> -<img border="0" src="PapyrusDSML-stereotypeApplication.png"/><br/> -Applying the ValidationRule Stereotype -</center></p><ul><li>9. Edit the stereotype properties to define information about the behavior of the validation</li></ul><p><center> -<img border="0" src="PapyrusDSML-AnnotationEdition.png"/><br/> -Editing the DSML Stereotype Properties<br/> -</center></p><h3 id="Summary_2">Summary</h3><p>This method is a bit more complicated than the first, but also more powerful. It works for both OCL and Java. The constraints are grouped in a category that can be included in the validation or not. A message and severity specified via the DSML validation profile is taken into account. It is also possible to distinguish between Live and Batch constraints. Note that this approach is currently of limited use in the case of OCL constraints as different OCL backends are used during constraint definition and validation.</p><h3 id="Information_about_generated_code">Information about generated code</h3><p>This section contains information about the code in the generated plugin. It is intended for readers that want to understand how the generated plugin works.<br/></p><p>The EMF validation framework supports constraints by means of a suitable definition in the plugin.xml file that embeds OCL or Java constraints, as shown here (example taken from the <a href="http://help.eclipse.org/helios/index.jsp?topic=%2Forg.eclipse.emf.validation.doc%2Ftutorials%2FoclValidationTutorial.html">OCL tutorial</a>).</p><p>First define a category</p><pre> -<extension point="org.eclipse.emf.validation.constraintProviders"> - <category - name="Your category" id="emf-validation-example/ocl"> - Category description - </category> -</pre><p>Then define constraints within the category</p><pre> - <constraint lang="OCL" severity="WARNING" mode="Batch" name="An example" id="example1" statusCode="101"> - <description>Describe it</description> - <message>Write the message</message> - <target class="Writer"/> - <![CDATA[ - self.books->collect(b : Book | b.category)->asSet()->size() <= 2 - ]]> - </constraint> -</pre><p>Constraint validation needs to be done on the context element. Therefore, the plug-in definition needs to associate constraints with the elements that should be validated. This is called constraint binding. The following snipped shows an example of such a binding.</p><pre> - <extension point="org.eclipse.emf.validation.constraintBindings"> - <clientContext id="MyContextID"> - <selector class=myplugin.selectors.ConstraintSelector"/> - </clientContext> - <binding context="MyContextID"> - <constraint ref="myplugin.example1"/> - </binding> -</pre><p>The generator creates a selector for each context element (typically a stereotype). The selector checks the element to be validated and selects those typed with the context element or a sub-types thereof. The constraint binding associates a list of constraints with the selector: those that share the same context element.</p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/dsml-validation.mediawiki b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/dsml-validation.mediawiki index 46a90e5cea6..09567cd925d 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/dsml-validation.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/dsml-validation.mediawiki @@ -15,7 +15,7 @@ How to embed the constraints definitions into a UML Profile: *2. Papyrus asks: "Would you like to define it" (the profile), select Yes *3. Ensure "Save OCL constraints, if any, into the profile definition" is selected (this is checked by default). Please note that you should not embed constraints into the profile, if you plan to generate a plugin (see next section)<br/> <center> -[[image:PapyrusDSML-ConstraintDefinition.png]]<br> +[[Image:images/PapyrusDSML-ConstraintDefinition.png]]<br> Save OCL Constraints in the Profile Definition </center> @@ -56,19 +56,19 @@ Help->Install New Software, select Papyrus update site, deselect "group items by *3. Right click UML Profile element *4. Select "Create validation plugin for this DSML" from the context menu <center> -[[image:PapyrusDSML-PluginValidationGeneration.png]]<br/> +[[Image:images/PapyrusDSML-PluginValidationGeneration.png]]<br/> Starting the validation plugin creation process </center> *5. Choose whether you want to create a new plugin or generate the code into the plugin containing the profile. The latter is the default. <center> -[[image:PapyrusDSML-GenPluginQuestion.png]]<br> +[[Image:images/PapyrusDSML-GenPluginQuestion.png]]<br> Running the constraint validation creation wizard </center> *6. [Only in case of new plugin]: Enter a Project name when prompted by the wizard, complete the wizard and select Finish <center> -[[image:PapyrusDSML-PluginWizard.png]]<br> +[[Image:images/PapyrusDSML-PluginWizard.png]]<br> Running the constraint validation creation wizard </center> @@ -109,7 +109,7 @@ Help->Install New Software, select Papyrus update site, deselect "group items by *5. Select the "DSML Validation" profile <center> -[[Image:PapyrusDSML-profileApplication.png]]<br> +[[Image:images/PapyrusDSML-profileApplication.png]]<br> Applying the DSML Validation Profile </center> @@ -122,14 +122,14 @@ Applying the DSML Validation Profile *8. Select the ValidationRule stereotype <center> -[[Image:PapyrusDSML-stereotypeApplication.png]]<br> +[[Image:images/PapyrusDSML-stereotypeApplication.png]]<br> Applying the ValidationRule Stereotype </center> *9. Edit the stereotype properties to define information about the behavior of the validation <center> -[[Image:PapyrusDSML-AnnotationEdition.png]]<br> +[[Image:images/PapyrusDSML-AnnotationEdition.png]]<br> Editing the DSML Stereotype Properties<br/> </center> diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/MEConstraintCreation.png b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/MEConstraintCreation.png Binary files differindex 9d3db996a19..9d3db996a19 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/MEConstraintCreation.png +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/MEConstraintCreation.png diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-AnnotationEdition.png b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-AnnotationEdition.png Binary files differindex e722d70aa1f..e722d70aa1f 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-AnnotationEdition.png +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-AnnotationEdition.png diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-ConstraintDefinition.png b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-ConstraintDefinition.png Binary files differindex bf24d63f234..bf24d63f234 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-ConstraintDefinition.png +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-ConstraintDefinition.png diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-GenPluginQuestion.png b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-GenPluginQuestion.png Binary files differindex e6867c07f3d..e6867c07f3d 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-GenPluginQuestion.png +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-GenPluginQuestion.png diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-PluginValidationGeneration.png b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-PluginValidationGeneration.png Binary files differindex 86f002c75f6..86f002c75f6 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-PluginValidationGeneration.png +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-PluginValidationGeneration.png diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-PluginWizard.png b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-PluginWizard.png Binary files differindex 056f345b12a..056f345b12a 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-PluginWizard.png +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-PluginWizard.png diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-UseCaseGeneration.png b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-UseCaseGeneration.png Binary files differindex a42a3de81b2..a42a3de81b2 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-UseCaseGeneration.png +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-UseCaseGeneration.png diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-profileApplication.png b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-profileApplication.png Binary files differindex da5989da57b..da5989da57b 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-profileApplication.png +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-profileApplication.png diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-stereotypeApplication.png b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-stereotypeApplication.png Binary files differindex 9b8b0157d1d..9b8b0157d1d 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/PapyrusDSML-stereotypeApplication.png +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/PapyrusDSML-stereotypeApplication.png diff --git a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/SpecificationCreation.png b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/SpecificationCreation.png Binary files differindex 99111be2833..99111be2833 100644 --- a/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/SpecificationCreation.png +++ b/plugins/doc/org.eclipse.papyrus.dsml.validation.doc/resource/images/SpecificationCreation.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/.project b/plugins/doc/org.eclipse.papyrus.infra.doc/.project new file mode 100644 index 00000000000..a304ab2be14 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/.project @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>org.eclipse.papyrus.infra.doc</name>
+ <comment></comment>
+ <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/plugins/doc/org.eclipse.papyrus.infra.doc/META-INF/MANIFEST.MF b/plugins/doc/org.eclipse.papyrus.infra.doc/META-INF/MANIFEST.MF new file mode 100644 index 00000000000..1b7a2d3259f --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/META-INF/MANIFEST.MF @@ -0,0 +1,10 @@ +Manifest-Version: 1.0
+Require-Bundle: org.eclipse.help;bundle-version="3.6.0",
+ org.eclipse.ui.intro;bundle-version="3.4.0",
+ org.eclipse.pde.ui;bundle-version="3.8.0"
+Bundle-Vendor: %Bundle-Vendor
+Bundle-Version: 1.1.0.qualifier
+Bundle-Name: %Bundle-Name
+Bundle-ManifestVersion: 2
+Bundle-SymbolicName: org.eclipse.papyrus.infra.doc;singleton:=true
+
diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/OSGI-INF/l10n/bundle.properties b/plugins/doc/org.eclipse.papyrus.infra.doc/OSGI-INF/l10n/bundle.properties new file mode 100644 index 00000000000..48d97b00463 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/OSGI-INF/l10n/bundle.properties @@ -0,0 +1,3 @@ +#Properties file for org.eclipse.papyrus.infra.doc
+Bundle-Vendor = Eclipse Modeling Project
+Bundle-Name = Papyrus Infrastructure Documentation Plugin
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/about.html b/plugins/doc/org.eclipse.papyrus.infra.doc/about.html new file mode 100644 index 00000000000..82d49bf5f81 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.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>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/plugins/doc/org.eclipse.papyrus.infra.doc/build.properties b/plugins/doc/org.eclipse.papyrus.infra.doc/build.properties new file mode 100644 index 00000000000..270493cb64d --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/build.properties @@ -0,0 +1,9 @@ +bin.includes = META-INF/,\ + plugin.xml,\ + OSGI-INF/,\ + intro/,\ + toc.xml,\ + about.html,\ + resource/ +src.includes = about.html,\ + resource/ diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/intro/css/firststeps.css b/plugins/doc/org.eclipse.papyrus.infra.doc/intro/css/firststeps.css new file mode 100644 index 00000000000..74f9c98b8e7 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/intro/css/firststeps.css @@ -0,0 +1,3 @@ +
+a#newpapyrusproject-introLink img { background-image : url(graphics/newproject.png); }
+a#newpapyrusproject-introLink:hover img { background-image : url(graphics/newproject_hov.png); }
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/intro/css/graphics/newproject.png b/plugins/doc/org.eclipse.papyrus.infra.doc/intro/css/graphics/newproject.png Binary files differnew file mode 100644 index 00000000000..1a6ee9b632f --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/intro/css/graphics/newproject.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/intro/css/graphics/newproject_hov.png b/plugins/doc/org.eclipse.papyrus.infra.doc/intro/css/graphics/newproject_hov.png Binary files differnew file mode 100644 index 00000000000..1a6ee9b632f --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/intro/css/graphics/newproject_hov.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/intro/css/overview.css b/plugins/doc/org.eclipse.papyrus.infra.doc/intro/css/overview.css new file mode 100644 index 00000000000..74f9c98b8e7 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/intro/css/overview.css @@ -0,0 +1,3 @@ +
+a#newpapyrusproject-introLink img { background-image : url(graphics/newproject.png); }
+a#newpapyrusproject-introLink:hover img { background-image : url(graphics/newproject_hov.png); }
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/intro/firststeps.xml b/plugins/doc/org.eclipse.papyrus.infra.doc/intro/firststeps.xml new file mode 100644 index 00000000000..9d84d6b5484 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/intro/firststeps.xml @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="utf-8" ?>
+<introContent>
+ <extensionContent id="org.eclipse.team.papyrus.firststeps" name="Papyrus First Steps" style="css/firststeps.css" path="firststeps/@">
+ <group label="Papyrus" style-id="content-group" id="org.eclipse.papyrus-firststeps-group">
+ <link label="New Papyrus Project"
+ url="http://org.eclipse.ui.intro/runAction?pluginId=org.eclipse.papyrus.uml.diagram.wizards&class=org.eclipse.papyrus.uml.diagram.wizards.NewProjectAction"
+ id="newpapyrusproject-introLink" style-id="content-link">
+ <text>Start with creation of new Papyrus project</text>
+ </link>
+ </group>
+ </extensionContent>
+</introContent>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/intro/overview.xml b/plugins/doc/org.eclipse.papyrus.infra.doc/intro/overview.xml new file mode 100644 index 00000000000..6d8ef3b5184 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/intro/overview.xml @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="utf-8" ?>
+<introContent>
+ <extensionContent id="org.eclipse.team.papyrus.overview" name="Papyrus overview" style="css/overview.css" path="overview/@">
+ <group style-id="content-group" id="org.eclipse.papyrus-firststeps-group">
+ <link label="New Papyrus Project"
+ url="http://org.eclipse.ui.intro/runAction?pluginId=org.eclipse.papyrus.uml.diagram.wizards&class=org.eclipse.papyrus.uml.diagram.wizards.NewProjectAction"
+ id="newpapyrusproject-introLink" style-id="content-link">
+ <text>Start with creation of new Papyrus project</text>
+ </link>
+ </group>
+ </extensionContent>
+</introContent>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.infra.doc/plugin.xml new file mode 100644 index 00000000000..fb0251c8839 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/plugin.xml @@ -0,0 +1,23 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<?eclipse version="3.4"?>
+<plugin>
+ <extension
+ point="org.eclipse.ui.intro.configExtension">
+ <configExtension
+ configId="org.eclipse.ui.intro.universalConfig"
+ content="intro/firststeps.xml">
+ </configExtension>
+ <configExtension
+ configId="org.eclipse.ui.intro.universalConfig"
+ content="intro/overview.xml">
+ </configExtension>
+ </extension>
+ <extension
+ point="org.eclipse.help.toc">
+ <toc
+ category="org.eclipse.papyrus"
+ file="toc.xml"
+ primary="true">
+ </toc>
+ </extension>
+</plugin>
diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.doc/pom.xml new file mode 100644 index 00000000000..6d4e31ab6d7 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/pom.xml @@ -0,0 +1,14 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project> + <modelVersion>4.0.0</modelVersion> + <parent> + <artifactId>org.eclipse.papyrus</artifactId> + <groupId>org.eclipse.papyrus</groupId> + <version>1.1.0-SNAPSHOT</version> + <relativePath>../../../releng/top-pom-main.xml</relativePath> + </parent> + <artifactId>org.eclipse.papyrus.infra.doc</artifactId> + <groupId>org.eclipse.papyrus</groupId> + <version>1.1.0-SNAPSHOT</version> + <packaging>eclipse-plugin</packaging> +</project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/resource/PapyrusLeftBanner.gif b/plugins/doc/org.eclipse.papyrus.infra.doc/resource/PapyrusLeftBanner.gif Binary files differnew file mode 100644 index 00000000000..6b17dfbb5c2 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/resource/PapyrusLeftBanner.gif diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/resource/stylesheet.css b/plugins/doc/org.eclipse.papyrus.infra.doc/resource/stylesheet.css new file mode 100644 index 00000000000..fc44366498a --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/resource/stylesheet.css @@ -0,0 +1,8 @@ +h1 {
+ font-weight:darkblue
+}
+
+body {
+ background: url(PapyrusLeftBanner.gif) left no-repeat fixed;
+ padding-left: 300px;
+}
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.doc/toc.xml b/plugins/doc/org.eclipse.papyrus.infra.doc/toc.xml new file mode 100644 index 00000000000..a3633c0dabe --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.doc/toc.xml @@ -0,0 +1,19 @@ +<?xml version="1.0" encoding="UTF-8"?> +<?NLS TYPE="org.eclipse.help.toc"?> + +<toc label="Papyrus Guide"> + <topic label="User Guide"> + <anchor id="PapyrusDocUser"/> + </topic> + <topic href="http://wiki.eclipse.org/Papyrus_Developer_Guide" label="Developer Guide"> + <anchor id="PapyrusDocDev"/> + </topic> + <topic label="Customization Guide"> + <anchor id="PapyrusDocCustom"/> + </topic> + <topic label="Online Help"> + <topic href="http://wiki.eclipse.org/Papyrus-FAQ" label="FAQ"/> + <anchor id="PapyrusDocOnline"/> + </topic> + <anchor id="PapyrusDocMain"/> +</toc> diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/META-INF/MANIFEST.MF b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/META-INF/MANIFEST.MF index aa47f65088d..2a95669f6f5 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/META-INF/MANIFEST.MF +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/META-INF/MANIFEST.MF @@ -1,5 +1,6 @@ Manifest-Version: 1.0
-Require-Bundle: org.eclipse.help;bundle-version="3.6.0"
+Require-Bundle: org.eclipse.help;bundle-version="3.6.0",
+ org.eclipse.papyrus.infra.doc;bundle-version="1.1.0"
Bundle-Vendor: %providerName
Bundle-Version: 1.1.0.qualifier
Bundle-Name: %pluginName
diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/build.properties b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/build.properties index 372c4fa9ca7..6023a417405 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/build.properties @@ -2,5 +2,6 @@ bin.includes = META-INF/,\ about.html,\
plugin.properties,\
plugin.xml,\
- resource/
-src.includes = about.html
+ target/generated-eclipse-help/**
+src.includes = about.html,\
+ resource/
diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/plugin.xml index ff24d120716..cc2180c8961 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/plugin.xml @@ -4,19 +4,19 @@ <extension point="org.eclipse.help.toc"> <toc - file="resource/marqueeSelectionTool-toc.xml" + file="target/generated-eclipse-help/marqueeSelectionTool-toc.xml" primary="false"> </toc> <toc - file="resource/tools-toc.xml" + file="target/generated-eclipse-help/tools-toc.xml" primary="false"> </toc> <toc - file="resource/alignmentTool-toc.xml" + file="target/generated-eclipse-help/alignmentTool-toc.xml" primary="false"> </toc> <toc - file="resource/textAlignment-toc.xml" + file="target/generated-eclipse-help/textAlignment-toc.xml" primary="false"> </toc> </extension> diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/pom.xml index f8829d95201..bd5e05a17b9 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/alignmentTool-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/alignmentTool-toc.xml deleted file mode 100644 index 46bc9aa3b5c..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/alignmentTool-toc.xml +++ /dev/null @@ -1,18 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/alignmentTool.html" label="Tool"> - <topic href="resource/alignmentTool.html" label="Alignment Tool"> - <topic href="resource/alignmentTool.html#Introduction" label="Introduction"></topic> - <topic href="resource/alignmentTool.html#General_Rules" label="General Rules"></topic> - <topic href="resource/alignmentTool.html#Using_of_Alignment_Tool" label="Using of Alignment Tool"> - <topic href="resource/alignmentTool.html#General_Case" label="General Case"></topic> - <topic href="resource/alignmentTool.html#Hierarchy" label="Hierarchy"></topic> - <topic href="resource/alignmentTool.html#Labels" label="Labels"></topic> - <topic href="resource/alignmentTool.html#Edges" label="Edges"></topic> - </topic> - <topic href="resource/alignmentTool.html#Limitation" label="Limitation"> - <topic href="resource/alignmentTool.html#Hierarchy_2" label="Hierarchy"></topic> - <topic href="resource/alignmentTool.html#Label" label="Label"></topic> - <topic href="resource/alignmentTool.html#Edge" label="Edge"></topic> - </topic> - </topic> -</toc> diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/alignmentTool.html b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/alignmentTool.html deleted file mode 100644 index 42e415216de..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/alignmentTool.html +++ /dev/null @@ -1,13 +0,0 @@ -<?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="Alignment_Tool">Alignment Tool</h1><h2 id="Introduction">Introduction</h2><p>Alignment Tool is available in the Papyrus toolbar:<br/> -<img border="0" src="images/Alignment/Alignment_Toolbar.JPG"/><br/> -Alignment allows to align the different objects of the model based on a reference object. -The reference object is basically the last object selected (primary selection) and can be identified with the handles color:<br/></p><table style="margin: auto;"><tr><td><img title="Normal Selection" alt="Normal Selection" border="1" src="images/Alignment/normal_Align_selection.JPG"/> </td><td><img title="Primary Selection" alt="Primary Selection" border="1" src="images/Alignment/Reference_Align_selection.JPG"/> </td></tr></table><p><br/> -To implement Alignment, some rules have been defined. </p><h2 id="General_Rules">General Rules</h2><p>The Alignment Tools allows 6 types of alignment: -<img align="right" title="Alignment Types" alt="Alignment Types" border="0" src="images/Alignment/Alignment_Toolbar.JPG"/></p><ul><li>Horizontally<ul><li>Left</li><li>Center</li><li>Right</li></ul></li><li>Vertically<ul><li>Top</li><li>Middle</li><li>Bottom</li></ul></li></ul><p>These types can be disable if the alignment is not possible. -Here is the different rules on which the alignment is based:</p><ol><li>The alignment is available only if the selected object can be moved on the reference</li><li>When an object and one or several children should be aligned on a third object, only the parent is aligned</li><li>An object can only be aligned inside of its container's bounds.(In order to avoid scrollbar and invisible objects) </li><li>An object cannot be aligned on one of its children.</li></ol><h2 id="Using_of_Alignment_Tool">Using of Alignment Tool</h2><p>Here under, some examples of using of alignment tool. <br/></p><h3 id="General_Case">General Case</h3><p>Basically, alignment is used in order to make the model easier to be read and more aesthetic. -To align objects:</p><ul><li>Select the object to be aligned</li><li>Click on the align tool button <img border="0" src="images/Alignment/Align_button.JPG"/> </li><li>Choose the proper type of alignment </li></ul><p><br/></p><ol><li>Example A: Standard alignment<dl><dd><img border="0" src="images/Alignment/General_Align1_before.JPG"/> </dd><dd><img border="0" src="images/Alignment/General_Align1_after.JPG"/></dd><dd>In this case the reference object is the right one. <br/></dd></dl></li><li>Example B: Parent alignment<dl><dd>In this second example, the object (the Class ) is aligned on his parent (the Package), the unauthorized alignment appears disable (in grey)</dd><dd><img border="0" src="images/Alignment/General_Align2_before.JPG"/> </dd><dd><img border="0" src="images/Alignment/General_Align2_after.JPG"/></dd></dl></li></ol><h3 id="Hierarchy">Hierarchy</h3><p>In this section, some examples of alignment in case of hierarchy between objects (parent / children).</p><ol><li>Example A: Only the parent is aligned <dl><dd><img border="0" src="images/Alignment/Hierarchy_Align1_before.JPG"/> </dd><dd>As shown in the result screenshot below , only the parent (the Package) has been aligned. </dd><dd><img border="0" src="images/Alignment/Hierarchy_Align1_after.JPG"/></dd></dl></li><li>Example B: Alignment inside the Container bounds is available<dl><dd><img border="0" src="images/Alignment/Hierarchy_Align2_before.JPG"/> </dd><dd>In the align options list, only the ones that keep the objects inside his container are enable.</dd><dd><img border="0" src="images/Alignment/Hierarchy_Align2_after.JPG"/></dd></dl></li></ol><h3 id="Labels">Labels</h3><p>In this section, some examples of labels alignments.</p><ol><li>Example A: Standard label alignment<dl><dd><img border="0" src="images/Alignment/Label_Align1_before.JPG"/> </dd><dd><img border="0" src="images/Alignment/Label_Align1_after.JPG"/></dd></dl></li><li>Example B: Dependency with another selected object<dl><dd><img border="0" src="images/Alignment/Label_Align2_before.JPG"/> </dd><dd>As shown in the result screenshot below, only the class is aligned. The label moves according to the connection move.</dd><dd><img border="0" src="images/Alignment/Label_Align2_after.JPG"/></dd></dl></li></ol><h3 id="Edges">Edges</h3><p>Edges alignment could sound not realistic. Actually, edge alignment is an alignment between the extremities of the edge, to make the edge horizontal or vertical. -Example: Standard edge alignment</p><dl><dd><img border="0" src="images/Alignment/Link_Align1_before.JPG"/> </dd></dl><p>The extremities are alignment in order to have an horizontal connection. The connection handles remained at the same place on the object</p><dl><dd><img border="0" src="images/Alignment/Link_Align1_after.JPG"/></dd></dl><h2 id="Limitation">Limitation</h2><p>This section will describe some limitations of the alignment tool.</p><h3 id="Hierarchy_2">Hierarchy</h3><p>A parent cannot be aligned on one of his child: -<img border="0" src="images/Alignment/Hierarchy_Align3_limitation.JPG"/></p><h3 id="Label">Label</h3><p>The extremities (source or target )of a connection cannot be aligned on any Labels of this connection. -<img border="0" src="images/Alignment/Label_Align3_limitation.JPG"/></p><h3 id="Edge">Edge</h3><p>To make the edge alignment available, the edge handles should correspond to the same direction (horizontal or vertical). -In the following case, source handle is on TOP and target handle is on LEFT. it is then impossible to align the edge. -<img border="0" src="images/Alignment/Link_Align2_Limitation.JPG"/></p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/marqueeSelectionTool-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/marqueeSelectionTool-toc.xml deleted file mode 100644 index 1a29ff761ba..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/marqueeSelectionTool-toc.xml +++ /dev/null @@ -1,18 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc label="Tool" topic="resource/marqueeSelectionTool.html"> - <topic href="resource/marqueeSelectionTool.html" label="Marquee Selection Tools"> - <topic href="resource/marqueeSelectionTool.html#Introduction" label="Introduction"></topic> - <topic href="resource/marqueeSelectionTool.html#Standard_Marquee_Selection" label="Standard Marquee Selection"> - <topic href="resource/marqueeSelectionTool.html#Select_All" label="Select All"></topic> - <topic href="resource/marqueeSelectionTool.html#Select_Nodes_Only" label="Select Nodes Only"></topic> - <topic href="resource/marqueeSelectionTool.html#Select_Connections_Only" label="Select Connections Only"></topic> - <topic href="resource/marqueeSelectionTool.html#Select_Labels_Only" label="Select Labels Only"></topic> - </topic> - <topic href="resource/marqueeSelectionTool.html#Rubberband_Marquee_Selection" label="Rubberband Marquee Selection"> - <topic href="resource/marqueeSelectionTool.html#Select_All_2" label="Select All"></topic> - <topic href="resource/marqueeSelectionTool.html#Select_Nodes_Only_2" label="Select Nodes Only"></topic> - <topic href="resource/marqueeSelectionTool.html#Select_Connections_Only_2" label="Select Connections Only"></topic> - <topic href="resource/marqueeSelectionTool.html#Select_Labels_Only_2" label="Select Labels Only"></topic> - </topic> - </topic> -</toc> diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/marqueeSelectionTool.html b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/marqueeSelectionTool.html deleted file mode 100644 index f4bcaf6872d..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/marqueeSelectionTool.html +++ /dev/null @@ -1,14 +0,0 @@ -<?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="Marquee_Selection_Tools">Marquee Selection Tools</h1><h2 id="Introduction">Introduction</h2><p>In order to enlarge the default selection tool available in the Palette, additionnal marquee selection tools have been added into Papyrus.<br/> -<img border="0" src="images/Palette1.JPG"/> -<br/> -A marquee selection is a multi-selection that allows to select several elements through a rectangle area.</p><p>Two types of marquee selections are available:</p><ul><li><i>Standard selection</i> : Select all elements included inside of the drawn marquee.</li></ul><p><img border="0" src="images/Palette2-Include.JPG"/></p><ul><li><i>Rubberband selection</i> : Select all elements intersecting the marquee in addition with all elements included in the marquee.<br/></li></ul><p><img border="0" src="images/Palette3-Rubberband.JPG"/> -<br/></p><p>A demonstration of this tool is available on the Papyrus Channel : -<a href="https://www.youtube.com/watch?v=sRSKYJ1mKBk">Marquee Selection Tool Demonstration</a></p><h2 id="Standard_Marquee_Selection">Standard Marquee Selection</h2><p>The Standard Marquee selection tool comes in a variety of 4 options:</p><ul><li>Select All</li><li>Nodes Only</li><li>Labels Only</li><li>Connections Only</li></ul><h3 id="Select_All">Select All</h3><p>Select blocks, labels and connections inside of the marquee area. -<img border="0" src="images/SelectAllInclude.JPG"/></p><h3 id="Select_Nodes_Only">Select Nodes Only</h3><p>Select only the blocks inside of the marquee area. -<img border="0" src="images/SelectNodeInclude.JPG"/></p><h3 id="Select_Connections_Only">Select Connections Only</h3><p>Select only the connectors inside of the marquee area. -<img border="0" src="images/SelectConnectionInclude.JPG"/></p><h3 id="Select_Labels_Only">Select Labels Only</h3><p>Select only the floating labels inside of the marquee area. -<img border="0" src="images/SelectLabelInclude.JPG"/></p><h2 id="Rubberband_Marquee_Selection">Rubberband Marquee Selection</h2><p>The Rubberband Marquee selection tool comes in a variety of 4 options:</p><ul><li>Select All</li><li>Nodes Only</li><li>Labels Only</li><li>Connections Only</li></ul><h3 id="Select_All_2">Select All</h3><p>Select the blocks, the labels and the connectors intersecting the marquee area or included inside of the marquee area. -<img border="0" src="images/SelectAllTouched.JPG"/></p><h3 id="Select_Nodes_Only_2">Select Nodes Only</h3><p>Select only the blocks intersecting the marquee area or included inside of the marquee area. -<img border="0" src="images/SelectNodeTouched.JPG"/></p><h3 id="Select_Connections_Only_2">Select Connections Only</h3><p>Select only the connectors intersecting the marquee area or included inside of the marquee area. -<img border="0" src="images/SelectConnectionTouched.JPG"/></p><h3 id="Select_Labels_Only_2">Select Labels Only</h3><p>Select only the labels intersecting the marquee area or included inside of the marquee area. -<img border="0" src="images/SelectLabelTouched.JPG"/></p><p><hr/></p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/textAlignment-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/textAlignment-toc.xml deleted file mode 100644 index 9a311032d57..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/textAlignment-toc.xml +++ /dev/null @@ -1,8 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc label="textAlignment" link_to="Tool" topic="resource/textAlignment.html"> - <topic href="resource/textAlignment.html" label="Text Alignment"> - <topic href="resource/textAlignment.html#Introduction" label="Introduction"></topic> - <topic href="resource/textAlignment.html#Apply_text_alignment_with_button" label="Apply text alignment with button"></topic> - <topic href="resource/textAlignment.html#Apply_text_alignment_with_CSS" label="Apply text alignment with CSS"></topic> - </topic> -</toc> diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/textAlignment.html b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/textAlignment.html deleted file mode 100644 index 8e8613ee1dd..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/textAlignment.html +++ /dev/null @@ -1,4 +0,0 @@ -<?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="Text_Alignment">Text Alignment</h1><h2 id="Introduction">Introduction</h2><p>Papyrus allows text alignment on external label, that means that when you're editing text, it will be moved on the selected side. You can align text to the left, to the center or to the right. </p><p>Example of text alignment to the right:</p><ul><li>Before a rename of the label</li></ul><p><img border="0" src="images/textAlignment/TextAlignmentBefore.png"/> </p><ul><li>After a rename of the label</li></ul><p><img border="0" src="images/textAlignment/TextAlignmentAfter.png"/></p><p>There is two ways to align text: with the existing button or thanks CSS:</p><h2 id="Apply_text_alignment_with_button">Apply text alignment with button</h2><p>To apply text alignment you can use button. There are available in tree places:</p><ul><li>In the papyrus menu</li></ul><p><img border="0" src="images/textAlignment/TextAlignmentButton01.png"/></p><ul><li>In the toolbar</li></ul><p><img border="0" src="images/textAlignment/TextAlignmentButton02.png"/></p><ul><li>In the contextual menu</li></ul><p><img border="0" src="images/textAlignment/TextAlignmentButton03.png"/></p><h2 id="Apply_text_alignment_with_CSS">Apply text alignment with CSS</h2><p>Text alignment can be defined through the CSS attributes "textAlignment" :</p><p>Example for Label of Port aligned to the right:</p><pre class="source-css">Port > Label { - textAlignment:"right"; - } -</pre><p>Note: Text alignment of port's label is forced according to the position of its parent when it is constrained.</p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/textAlignment.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/textAlignment.mediawiki index 4b5273ea13f..96ada3b4206 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/textAlignment.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/textAlignment.mediawiki @@ -5,10 +5,10 @@ Papyrus allows text alignment on external label, that means that when you're edi Example of text alignment to the right: *Before a rename of the label -[[File:images/textAlignment/TextAlignmentBefore.png]] +[[Image:images/textAlignment/textAlignmentBefore.png]] *After a rename of the label -[[File:images/textAlignment/TextAlignmentAfter.png]] +[[File:images/textAlignment/textAlignmentAfter.png]] There is two ways to align text: with the existing button or thanks CSS: @@ -16,15 +16,15 @@ There is two ways to align text: with the existing button or thanks CSS: To apply text alignment you can use button. There are available in tree places: *In the papyrus menu -[[File:images/textAlignment/TextAlignmentButton01.png]] +[[File:images/textAlignment/textAlignmentButton01.png]] *In the toolbar -[[File:images/textAlignment/TextAlignmentButton02.png]] +[[File:images/textAlignment/textAlignmentButton02.png]] *In the contextual menu -[[File:images/textAlignment/TextAlignmentButton03.png]] +[[File:images/textAlignment/textAlignmentButton03.png]] ==Apply text alignment with CSS== Text alignment can be defined through the CSS attributes "textAlignment" : diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/tools-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/tools-toc.xml index e4d8fe0bb2c..81d97da7438 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/tools-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/tools-toc.xml @@ -2,7 +2,7 @@ <toc label="Papyrus Modelling Tools" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> <topic label="Using Papyrus modelling tools"> <anchor id="Tool"/> - <link toc="resource/marqueeSelectionTool-toc.xml"/> - <link toc="resource/alignmentTool-toc.xml"/> - <link toc="resource/textAlignment-toc.xml"/></topic> + <link toc="target/generated-eclipse-help/marqueeSelectionTool-toc.xml"/> + <link toc="target/generated-eclipse-help/alignmentTool-toc.xml"/> + <link toc="target/generated-eclipse-help/textAlignment-toc.xml"/></topic> </toc> diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/build.properties b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/build.properties index 4887a1c42cb..3abab9716c1 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/build.properties @@ -1,5 +1,7 @@ bin.includes = META-INF/,\
about.html,\
resource/,\
- plugin.xml
-src.includes = about.html
+ plugin.xml,\
+ target/generated-eclipse-help/**
+src.includes = about.html,\
+ resource/
diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/plugin.xml index bb0a32197dd..8033502770f 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/plugin.xml @@ -4,11 +4,11 @@ <extension
point="org.eclipse.help.toc">
<toc
- file="resource/css-main-toc.xml"
+ file="target/generated-eclipse-help/css-main-toc.xml"
primary="false">
</toc>
<toc
- file="resource/css-toc.xml"
+ file="target/generated-eclipse-help/css-toc.xml"
primary="false">
</toc>
</extension>
diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/pom.xml index 7247a9367fb..8aca04cfb0c 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/pom.xml @@ -11,4 +11,39 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css-main-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css-main-toc.xml index e2409e8153f..74e70784dd6 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css-main-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css-main-toc.xml @@ -1,7 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?> <toc label="CSS Stylesheets" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> - <topic href="resource/css.html" label="CSS Stylesheets"> + <topic href="target/generated-eclipse-help/css.html" label="CSS Stylesheets"> <anchor id="CSS"/> - <link toc="resource/css-toc.xml"/> + <link toc="target/generated-eclipse-help/css-toc.xml"/> </topic> </toc> diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css-toc.xml deleted file mode 100644 index 01cea67865c..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css-toc.xml +++ /dev/null @@ -1,36 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/css.html" label="css"> - <topic href="resource/css.html" label="Introduction"></topic> - <topic href="resource/css.html#Installation" label="Installation"></topic> - <topic href="resource/css.html#Using_StyleSheets" label="Using StyleSheets"> - <topic href="resource/css.html#Diagram_Stylesheets" label="Diagram Stylesheets"></topic> - <topic href="resource/css.html#Model_StyleSheet" label="Model StyleSheet"></topic> - <topic href="resource/css.html#Project_Stylesheets" label="Project Stylesheets"></topic> - </topic> - <topic href="resource/css.html#Deploying_a_CSS_Theme" label="Deploying a CSS Theme"> - <topic href="resource/css.html#With_extension_point" label="With extension point"></topic> - <topic href="resource/css.html#In_workspace_preference" label="In workspace preference"></topic> - </topic> - <topic href="resource/css.html#Editing_a_StyleSheet" label="Editing a StyleSheet"> - <topic href="resource/css.html#Manually:_The_CSS_Syntax" label="Manually: The CSS Syntax"> - <topic href="resource/css.html#Syntax_elements" label="Syntax elements"></topic> - <topic href="resource/css.html#Examples" label="Examples"></topic> - </topic> - <topic href="resource/css.html#With_the_Papyrus_tooling" label="With the Papyrus tooling"></topic> - </topic> - <topic href="resource/css.html#Supported_properties" label="Supported properties"> - <topic href="resource/css.html#Selector_properties" label="Selector properties"></topic> - <topic href="resource/css.html#Style_properties" label="Style properties"> - <topic href="resource/css.html#Value_types" label="Value types"></topic> - <topic href="resource/css.html#Mask_Label" label="Mask Label"></topic> - </topic> - </topic> - <topic href="resource/css.html#Manipulating_styles" label="Manipulating styles"></topic> - <topic href="resource/css.html#Limitations_and_issues" label="Limitations and issues"> - <topic href="resource/css.html#Selectors" label="Selectors"> - <topic href="resource/css.html#Selector_inheritance" label="Selector inheritance"></topic> - <topic href="resource/css.html#Events_support" label="Events support"></topic> - </topic> - <topic href="resource/css.html#Known_bugs" label="Known bugs"></topic> - </topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css.html b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css.html deleted file mode 100644 index 3e8b27ade53..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css.html +++ /dev/null @@ -1,92 +0,0 @@ -<?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"/><link rel="stylesheet" type="text/css" href="documentation.css"/></head><body><ol style="list-style: none;"><li><a href="#Introduction">Introduction</a></li><li><a href="#Installation">Installation</a></li><li><a href="#Using_StyleSheets">Using StyleSheets</a><ol style="list-style: none;"><li><a href="#Diagram_Stylesheets">Diagram Stylesheets</a></li><li><a href="#Model_StyleSheet">Model StyleSheet</a></li><li><a href="#Project_Stylesheets">Project Stylesheets</a></li></ol></li><li><a href="#Deploying_a_CSS_Theme">Deploying a CSS Theme</a><ol style="list-style: none;"><li><a href="#With_extension_point">With extension point</a></li><li><a href="#In_workspace_preference">In workspace preference</a></li></ol></li><li><a href="#Editing_a_StyleSheet">Editing a StyleSheet</a><ol style="list-style: none;"><li><a href="#Manually:_The_CSS_Syntax">Manually: The CSS Syntax</a><ol style="list-style: none;"><li><a href="#Syntax_elements">Syntax elements</a></li><li><a href="#Examples">Examples</a></li></ol></li><li><a href="#With_the_Papyrus_tooling">With the Papyrus tooling</a></li></ol></li><li><a href="#Supported_properties">Supported properties</a><ol style="list-style: none;"><li><a href="#Selector_properties">Selector properties</a></li><li><a href="#Style_properties">Style properties</a><ol style="list-style: none;"><li><a href="#Value_types">Value types</a></li><li><a href="#Mask_Label">Mask Label</a></li></ol></li></ol></li><li><a href="#Manipulating_styles">Manipulating styles</a></li><li><a href="#Limitations_and_issues">Limitations and issues</a><ol style="list-style: none;"><li><a href="#Selectors">Selectors</a><ol style="list-style: none;"><li><a href="#Selector_inheritance">Selector inheritance</a></li><li><a href="#Events_support">Events support</a></li></ol></li><li><a href="#Known_bugs">Known bugs</a></li></ol></li></ol><h1 id="Introduction">Introduction</h1><p>The standard UML specification provides a few hints to represent graphical elements. However, it only focuses on the general representation of these elements (e.g. A Class is a rectangle, with optional compartments for its attributes and operations, and its name should be displayed in italic if the Class is abstract). </p><p>Nevertheless, for a better readability (and even esthetic), the user has a certain freedom for changing some graphical properties, such as an Element's color. Until now, in Papyrus, this customization could be done by two complement means: </p><ul><li>Appearance tab (Properties view): change the appearance of the selected element(s) </li><li>Preferences page: change the initial appearance of all newly created element(s)</li></ul><p>While this allows defining a custom theme for our diagrams, this mechanism suffers from a few limitations: </p><ul><li>It is not possible to create different categories of appearance for the same semantic Element (e.g. "Blue Class" and "Green class"). We'd have to create "Blue classes" and change some of them to "Green"manually. </li><li>If we wanted to change the current theme, we'd have either to change each object's appearance one by one, or to write an automatic transformation, which could be really complicated. </li><li>It is not easy to export a Theme, as they are stored in the Eclipse preferences. It is almost impossible to ship a ready-to-use distribution of Papyrus with a custom theme.</li></ul><p>The Cascading StyleSheets (CSS) component adds the capacity to define some Stylesheets for your diagrams. Just like in web pages, the CSS format is used to separate the contents of our diagrams from their appearance. It becomes possible to change the appearance of a whole diagram, or even a set of diagrams, independently of the number of represented elements, in a single click.<br/></p><h1 id="Installation">Installation</h1><p>The CSS Stylesheet support is now shipped in the base installation of Papyrus. It doesn't require any specific installation step anymore.</p><p>Without the CSS component, or with the "Black & White" CSS Theme, your diagrams look like: </p><p><img title="Papyrus diagram without CSS Theme" alt="Papyrus diagram without CSS Theme" border="0" src="Papyrus_CSS_no_theme.png"/><br/></p><p>With the default "Papyrus" CSS Theme, your diagrams look like:</p><p><img title="Papyrus Diagram with CSS Theme" alt="Papyrus Diagram with CSS Theme" border="0" src="Papyrus_CSS_theme.png"/><br/></p><p>Note: If you opened a diagram which has been created without the CSS Support, it may still have a user-defined appearance, e.g. without Element icons. This might or might not be a problem, as this may conflict with the CSS Theme. You can reset all custom appearances by pressing the "Default style" button in the Style tab of the Diagram's properties view.</p><h1 id="Using_StyleSheets">Using StyleSheets</h1><p>To define a custom style, the first step is to create a Stylesheet. The creation is really straightforward: a Stylesheet is a text file with the .css extension. You can create such a file using the "New > File" wizard.<br/> There are several options for using stylesheets.</p><h2 id="Diagram_Stylesheets">Diagram Stylesheets</h2><p>You can define a particular style for a diagram.</p><ol><li>Select a diagram</li><li>Go to the Style tab of the properties view</li><li>Add a new "Diagram style sheet". There isn't currently any style sheet available from the diagram, so you need to create a new "Stylesheet reference".<br/><img title="Import stylesheet in Papyrus" alt="Import stylesheet in Papyrus" border="0" src="Papyrus_CSS_Import_stylesheet.png"/> </li><li>Browse your workspace to find your css file, and press OK. Your stylesheet is now associated to your diagram.</li></ol><h2 id="Model_StyleSheet">Model StyleSheet</h2><p>Similarily to "Diagram Stylesheet" you can define a particular style for a Model.</p><ol><li>Select a model</li><li>Go to the Style tab of the properties view</li><li>Add a new "Model style sheet"</li><li>Browse your workspace to find your css file, and press OK. Your stylesheet is now associated to your Model.</li></ol><h2 id="Project_Stylesheets">Project Stylesheets</h2><p>You can associate to a project specific stylesheets.</p><ol><li>Select a project in "Project Explorer" view</li><li>Open project preference properties: "Right click > properties"</li><li>Go to CSS stylesheets page: "Papyrus > Style sheets"</li><li>Add a new "Project style sheet". There isn't currently any style sheet available from project, so you need to create a new "Stylesheet reference".<br/><img title="Style sheets project properties in Papyrus" alt="Style sheets project properties in Papyrus" border="0" src="Papyrus_CSS_project.png"/></li><li>Browse your workspace to find your css file, and press OK. Now, your stylesheet is associated with the project.</li></ol><h1 id="Deploying_a_CSS_Theme">Deploying a CSS Theme</h1><p>Once you have defined your style sheets, you may want to export it to create a new theme (Or to extend an existing theme). To do so, Papyrus provides two ways to define a theme.</p><h2 id="With_extension_point">With extension point</h2><p>Papyrus provides an extension point: org.eclipse.papyrus.infra.gmfdiag.css.theme. </p><p>This extension point needs two entries: a Theme Definition (ID, Label and icon of the Theme), and Theme contributions (A set of style sheets which will compose the Theme). More than one plug-in can contribute to the same Theme, which makes it possible to extend a Theme. </p><p>The Theme can be modified from the Papyrus preferences page "CSS Theme". Only one theme can be activated at the same time. A Theme applies to all Papyrus Diagrams from the workspace.<br/> </p><h2 id="In_workspace_preference">In workspace preference</h2><p>You can define theme in workspace preferences. A theme is defined by style sheets.</p><ol><li>Go to the Papyrus preference: "Window > Preferences > Papyrus > CSS Theme"</li><li>Add a new theme. There are currently two existing themes: "Papyrus Theme" and "Black & White".<br/><img title="Creation of theme in Papyrus" alt="Creation of theme in Papyrus" border="0" src="Papyrus_CSS_theme_creation.png"/></li><li>Write a name for this new theme</li><li>(optional) Choose an icon</li><li>Associate one or more style sheets with this theme</li><li>Press OK to finish creation</li></ol><p>You can edit or create a theme with a selection of CSS files in Project Explorer view. For this, select the CSS files, right click and select "CSS Theme"</p><h1 id="Editing_a_StyleSheet">Editing a StyleSheet</h1><p>Papyrus Stylesheets are stored in text files with the ".css" extension (e.g. stylesheet.css).<br/> </p><h2 id="Manually:_The_CSS_Syntax">Manually: The CSS Syntax</h2><h3 id="Syntax_elements">Syntax elements</h3><p>The CSS syntax is a list of rules, which associates selectors and properties.<br/> </p><ul><li>The selector: describes the condition which has to be fulfilled for a rule to be applied<br/> </li><li>The properties: describes the appearance of the elements matching the rule<br/></li></ul><p>Eclipse implements the 2.1 version of the CSS syntax. The available selectors are:<br/> </p><ul><li><b>*</b>: Matches all elements<br/> </li><li><b>ElementType</b>: Matches the elements of type "ElementType"<br/> </li><li><b>.myStyle</b>: Matches the elements on which the style "myStyle" is applied<br/> </li><li><b>#myID</b>: Matches the element with the CSS ID "myID". The CSS ID must be unique among a diagram. To avoid confusing the users, and because this selector doesn't make much sense on diagrams, this selector has been disabled in Papyrus.<br/> </li><li><b>[property=value]</b>: Matches the elements which have a property "property" with the value "value". It can also match the properties of Stereotypes<br/></li><li><b>[appliedStereotypes~="MyStereotype"]</b>: Matches the elements on which the Stereotype "MyStereotype" is applied. You can use either the Stereotype's name or qualified name (MyProfile::MyPackage::MyStereotype). Note: always use the "~=" operator (Which means "contains"), because UML elements can have more than one applied stereotype.</li><li><b>:pseudo</b>: Matches the element on which the pseudo-selector "pseudo" is applied. Pseudo-selectors are typically used for dynamic events, and for filtering some non-semantic properties. In Papyrus, they are used for identifying more precisely the floating labels (When an element has more than one label: see the <a href="#Mask_Label">Mask Label</a> chapter below), and they are also used by the animation framework to specify events (See the Moka documentation)</li></ul><p>These selectors can be combined using one of the following combinators:<br/> </p><ul><li><b>Selector1 Selector2</b>: Descendant selector. Matches the elements which match Selector2 and are contained in an element matching Selector1<br/> </li><li><b>Selector1 > Selector2</b>: Child selector. Matches the elements which match Selector2 and are directly contained in an element matching Selector2<br/> </li><li><b>Selector1 + Selector2</b>: Sibling selector. Matches the elements which match Selector2 and are immediately preceded by a Sibling element which match Selector1.<br/> </li><li><b>Selector1, Selector2</b>: Alternative selector. Matches elements matching either Selector1 or Selector2<br/></li></ul><p>A rule also contains a list of properties, in the form property:value; </p><p>In Papyrus, the selectors apply to semantic elements and properties (i.e. UML Elements), and the properties apply to the appearance properties (i.e. GMF Appearance properties). A few custom properties (Independent from the GMF Appearance model) are also available (See "Supported properties" below).<br/> </p><h3 id="Examples">Examples</h3><pre class="source-css">* { - fillColor: red; - fontColor: #0000FF; -} -</pre><p> </p><p>Meaning: all elements should be filled in red, and all texts should be blue (RGB Color #0000FF)<br/> </p><pre class="source-css">Class { - gradient: white vertical; - elementIcon:true; - shadow:true; - qualifiedNameDepth:full; -} -</pre><p> </p><p>Meaning: this style applies to all UML Classes. They will have a white and vertical gradient. The Element icon and the shadow will be displayed, as well as their fully qualified name.<br/> </p><pre class="source-css">ClassDiagram Class>Property { - fontColor: red; -} -</pre><p> </p><p>Meaning: The properties directly contained in a Class, which is drawn on a ClassDiagram (Either as a root element of the diagram, or in a Package) will be displayed in red.<br/> </p><pre class="source-css">[appliedStereotypes~="Block"]{ - bold:true; -} - -/* Equivalent: qualified name */ -[appliedStereotypes~="SysML::Blocks::Block"]{ - bold:true; -} -</pre><p>Meaning: The elements with the "Block" stereotype must be displayed in bold.</p><pre class="source-css">[appliedStereotypes~=Block][isEncapsulated=true]{ - fontColor:red; -} -</pre><p>Meaning: The elements with the "Block" stereotype, and the stereotype property "isEncapsulated" set to true, must be displayed in red.</p><p>All these rules can be combined:</p><pre class="source-css">Class[appliedStereotypes~=Block][appliedStereotypes~=MyCustomStereotype][isEncapsulated=true][myCustomProperty=SomeValue][isAbstract=false]{ - /* A class on which the stereotypes "Block" and "MyCustomStereotype" are applied, - * and on which the stereotype property "isEncapsulated" is set to true, - * the stereotype property "myCustomProperty" is set to "SomeValue", and - * the UML Property "isAbstract" is set to false */ - - fillColor:red; -} -</pre><h2 id="With_the_Papyrus_tooling">With the Papyrus tooling</h2><p>Papyrus also provides a tool to generate a CSS Rule from an element displayed in the diagram. You need to create a stylesheet before you can edit it with the Create style tool, and it is recommended (Although not required) to associate this style sheet with your current diagram. </p><p>To use it, create an element and change its appearance via the "Appearance" tab of the properties view. Then, right click on the element, and select "Format", "Create a new style". The dialog box contains three tabs:<br/> </p><ul><li>Conditions: The conditions under which the style will be applied (Corresponds to the "CSS Selectors") </li><li>Properties: The graphical properties to export to the style sheet </li><li>Stylesheet: The style sheet to edit<br/></li></ul><p><img title="Create style dialog" alt="Create style dialog" border="0" src="Papyrus_CSS_Export_style.png"/><br/> </p><p>In the Stylesheet tab, select your stylesheet:<br/> </p><ul><li>If you have already associated the style sheet to your diagram, you can use the "Applies stylesheet" button. </li><li>Otherwise, you need to select "External stylesheet", and browse your workspace to retrieve the file. Note that in this case, as the edited stylesheet might not be applied to your diagram, you won't be able to see the changes in the current diagram.<br/></li></ul><p>In the conditions tab, there are three groups of options:<br/> </p><ul><li>The kind of element to which the style applies (e.g. the style will be applied to "Class" elements, or to any kind of elements). It can be restricted to a specific diagram. </li><li>You can add restrictions on the current value(s) of the element (e.g. the style will be applied to concrete classes). Only primitive type and enumerated attributes are supported here. </li><li>The style name is used to apply a style manually.<br/></li></ul><p>The properties tab contains all the graphical properties that can be applied to the selected object. It is used to choose the graphical properties to apply on the objects matching the conditions.<br/></p><h1 id="Supported_properties">Supported properties</h1><h2 id="Selector_properties">Selector properties</h2><p>Selector properties are semantic element properties. They can be used with one of the following syntaxes:</p><p><b>[isAbstract=true]</b></p><p><b>Class[isAbstract=true]</b></p><p>The supported semantic element properties are:</p><ul><li>Strings: <b>[name=MyName]</b>, <b>[name="My name"]</b> (Quotes are required for complex Strings)<br/></li><li>Integers: <b>[size="12"]</b> (Quotes are required) <br/></li><li>Booleans: <b>[isAbstract=true]</b> (Quotes are optional)<br/></li><li>Enumerations: <b>[visibility=visible]</b> (Quotes are optional)<br/></li><li>References to named elements (UML NamedElement or Ecore ENamedElement): <b>[type=String]</b><br/></li></ul><p>The supported properties are the semantic properties of the UML element (e.g. isAbstract, name, type, ...), as well as the semantic properties of the stereotypes applied to the UML element (e.g. isEncapsulated for a SysML Block)</p><p>Some selectors can also be used to represent some specific parts of an element. For example, it is possible to hide a specific compartment:</p><pre class="source-css">Class > Compartment[kind="attribute"] { - visible:false; -} - -Class > Compartment[kind="symbol"] { - visible:true; -} - -Compartment[kind="structure"]{ - collapsed:true; -} - -Port > Label { - visible: false; -} -</pre><h2 id="Style_properties">Style properties</h2><p>Style properties are graphical properties supported by the display. Note that some graphical elements may not support some specific properties (Either because they shouldn't support them, or because they are not yet implemented). For example, a UML::Class will not support the <i>italic</i> property, because in UML, <i>italic</i> means <i>abstract</i>.</p><p>The CSS Supports all GMF Notation properties, as well as a few Papyrus-specific properties. This chapter will only list all the Papyrus-specific properties.</p><p>The simplest way to discover new style properties is to use the Appearance tab of the Properties view in Papyrus. When hovering one of the appearance properties, the tooltip indicates the name of the corresponding CSS property</p><p><img title="CSS Property in tooltip" alt="CSS Property in tooltip" border="0" src="Papyrus_CSS_tooltip.png"/><br/></p><p>This table lists the most common properties:</p><table class="wikitable"><tr><th>Property name</th><th>Value type</th><th>Initial Value</th><th>Applies to</th><th>Comment</th></tr><tr><td>fillColor</td><td>Color</td><td>white</td><td>Shapes</td><td>In the default "Papyrus Theme", the fill color depends on the type of element. The used colors are #C3D1D5 (Light blue, Default), #C3D7DD (Lighter blue, Class), #FFFFCC (Yellow, Comment), #C8FFE6 (Teal, Constraints)</td></tr><tr><td>transparency</td><td>integer</td><td>0</td><td>Shapes</td><td>Value is a percentage: values in the range (0, 100) are supported. Transparency works only if the gradient is activated: <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=419320">Bug 419320</a></td></tr><tr><td>gradient</td><td>[Color Color [ horizontal | vertical ] | none]</td><td>none</td><td>Shapes</td><td>Examples: "white blue horizontal" or "none"</td></tr><tr><td>fontColor</td><td>Color</td><td>black</td><td>Shapes, floating labels</td><td>Comments support HTML syntax. Most style-properties have no effect on comments</td></tr><tr><td>fontName</td><td>String</td><td>"Segoe UI"</td><td>Shapes, floating labels</td><td>Most fonts are platform-specific. The list of available Fonts can be found in the "Appearance" tab of the properties view</td></tr><tr><td>fontSize</td><td>integer</td><td>9</td><td>Shapes, floating labels</td></tr><tr><td>bold</td><td>boolean</td><td>false</td><td>Shapes, floating labels</td></tr><tr><td>italic</td><td>boolean</td><td>false</td><td>Shapes, floating labels</td><td>In UML, "italic" means "isAbstract=true". This property is disabled for all elements which can be abstract (e.g. Class)</td></tr><tr><td>underline</td><td>boolean</td><td>false</td><td>Shapes, floating labels</td><td>In UML, "underline" means "isStatic=true". This property is disabled for all elements which can be static (e.g. Property)</td></tr><tr><td>strikeThrough</td><td>boolean</td><td>false</td><td>Shapes, floating labels</td></tr><tr><td>visible</td><td>boolean</td><td>true</td><td>All elements</td><td>Although this property will work for any diagram elements, it is probably a bad idea to use it with anything else than a Compartment or a Label </td></tr><tr><td>collapsed</td><td>boolean</td><td>false</td><td>Compartments</td></tr><tr><td>showTitle</td><td>boolean</td><td>false</td><td>Compartments</td></tr><tr><td>lineColor</td><td>Color</td><td>black</td><td>Shapes, Connectors</td></tr><tr><td>lineWidth</td><td>integer</td><td>-1</td><td>Shapes, Connectors</td><td>-1 means "default", and typically corresponds to 1px</td></tr><tr><td>routing</td><td>[Manual | Rectilinear | Tree]</td><td>Manual</td><td>Connectors</td><td>The value is case-sensitive: don't forget the initial Capital</td></tr><tr><td>roundedBendpointsRadius</td><td>integer</td><td>0</td><td>Connectors</td><td>Applies to connectors with routingStyle = Rectilinear or Tree</td></tr><tr><td>smoothness</td><td>[None | Normal | Less | More]</td><td>None</td><td>Connectors</td></tr><tr><td>avoidObstructions</td><td>boolean</td><td>false</td><td>Connectors</td></tr><tr><td>closestDistance</td><td>boolean</td><td>false</td><td>Connectors</td></tr><tr><td>jumpLinkStatus</td><td>[None | All | Below | Above]</td><td>None</td><td>Connectors</td><td>It is not recommended to use jump links via CSS, as it gives strange results for overlapping connectors</td></tr><tr><td>jumpLinkType</td><td>[Semicircle | Square | Chamfered]</td><td>Semicircle</td><td>Connectors</td></tr><tr><td>jumpLinkReverse</td><td>boolean</td><td>false</td><td>Connectors</td></tr><tr><td>leftMarginLabel</td><td>integer</td><td>0</td><td>Labels</td><td>Define the left margin of the label in pixel. This is the space between the text box and his container</td></tr><tr><td>topMarginLabel</td><td>integer</td><td>0</td><td>Labels</td><td>Define the top margin of the label in pixel. This is the space between the text box and his container</td></tr><tr><td>rightMarginLabel</td><td>integer</td><td>0</td><td>Labels</td><td>Define the right margin of the label in pixel. This is the space between the text box and his container</td></tr><tr><td>bottomMarginLabel</td><td>integer</td><td>0</td><td>Labels</td><td>Define the bottom margin of the label in pixel. This is the space between the text box and his container</td></tr><tr></tr></table><p>The following properties can be used to bypass the standard UML notation. They can typically be used for pure DSML notations:</p><table class="wikitable"><tr><th>Property name</th><th>Value type</th><th>Initial Value</th><th>Applies to</th><th>Comment</th></tr><tr><td>displayBorder</td><td>boolean</td><td>true</td><td>Shapes</td><td>If set to false, the borders of the Shape will be hidden.</td></tr><tr><td>displayName</td><td>boolean</td><td>true</td><td>Shapes</td><td>If set to false, the name of the Shape will be hidden</td></tr><tr><td>displayTag</td><td>boolean</td><td>true</td><td>Shapes, connectors</td><td>If set to false, the tags (e.g. « component ») of the element will be hidden </td></tr><tr><td>maintainSymbolRatio</td><td>boolean</td><td>true</td><td>Shapes</td><td>If the shape is represented with a Symbol, specifies whether the ratio should be maintained or not. If the Symbol is displayed in a compartment, it is usually a good idea to maintain the ratio. If the symbol is the only representation (e.g. when the name, border and compartments are hidden), it is recommended to not maintain the ratio</td></tr><tr><td>elementIcon</td><td>boolean</td><td>false</td><td>Shapes, floating labels</td><td>Whether the icon should be displayed next to the label of the element. In the default "Papyrus Theme", the icon is displayed by default</td></tr><tr><td>shadow</td><td>boolean</td><td>false</td><td>Shapes</td><td>Display a shadow under the shape</td></tr><tr><td>qualifiedNameDepth</td><td>[full | none | integer]</td><td>none</td><td>Shapes, floating labels</td><td>The depth of the qualified name to display. Applies to UML::NamedElement</td></tr><tr><td>lineStyle</td><td>[solid | dashed | dotted | hidden | double]</td><td>N/A</td><td>Connectors</td><td>In UML, the line type depends on the semantic element (e.g. solid line for associations, dashed line for dependencies...). In most cases, you should avoid using this property, as this would change the well-known UML notation. However, it can be useful for creating pure DSML, where the UML notation should be hidden.</td></tr><tr><td>lineDashLength</td><td>integer</td><td>N/A</td><td>Connectors</td><td>When the lineStyle is set to "Dash", specifies the length of the dash</td></tr><tr><td>lineDashGap</td><td>integer</td><td>N/A</td><td>Connectors</td><td>When the lineStyle is set to "Dash", specifies the gap between the dashes</td></tr><tr><td>targetDecoration</td><td>[none]</td><td>N/A</td><td>Connectors</td><td>If "targetDecoration" is set to None, hides the target decoration of the Connector (e.g. the arrow)</td></tr><tr><td>sourceDecoration</td><td>[none]</td><td>N/A</td><td>Connectors</td><td>If "sourceDecoration" is set to None, hides the source decoration of the Connector (e.g. the arrow)</td></tr><tr><td>maskLabel</td><td>string[]</td><td>N/A</td><td>Labels, floating labels</td><td>This property can be used to configure the display of complex labels (e.g. properties). See examples in the <a href="#Mask_Label">Mask Label</a> chapter below</td></tr><tr><td>svgFile</td><td>path</td><td>N/A</td><td>Shapes</td><td>The path to an SVG file, which should be used as a symbol for the element. It will be displayed in the "symbol" compartment of the shape</td></tr><tr><td>followSVGSymbol</td><td>boolean</td><td>false</td><td>Shapes</td><td>If the SVG file has a path with the ID "papyrusPath", this path will be used to connect edges</td></tr><tr><td>svgCssFile</td><td>path</td><td>N/A</td><td>Shapes</td><td>The path to a CSS file which will be applied to the SVG symbol (If an SVG symbol is used). Can be used to dynamically change the appearance of the SVG image (e.g. change color, ...)</td></tr><tr><td>svgCssClass</td><td>string</td><td>N/A</td><td>Shapes</td><td>The CSS Class to be applied at the root of the SVG document (If an SVG symbol is used). Can be used to dynamically change the appearance of the SVG image</td></tr><tr><td>textAlignment</td><td>string</td><td>left/center</td><td>Floating labels</td><td>Set the text alignment of the label. (left, center, right)</td></tr><tr><td>labelConstrained</td><td>boolean</td><td>false</td><td>Labels of Port</td><td>Constraint the label, it will be automatic positioned at the proper position according to the position of the Port on its parents. Text alignment will be forced according to the position of its parent.The label can't be moved.</td></tr><tr><td>labelOffsetX</td><td>integer</td><td>0</td><td>Labels of Port</td><td>Set the offset on X when label is constrained</td></tr><tr><td>labelOffsetY</td><td>integer</td><td>0</td><td>Labels of Port</td><td>Set the offset on Y when label is constrained</td></tr><tr></tr></table><h3 id="Value_types">Value types</h3><p><b>String:</b> Simple (Ascii) strings can be written without quotes: <i>property:value</i>. Complex strings must be written with quotes: <i>property: "my value"</i>; <i>path: "platform:/plugin/my.example.plugin/resources/myFile.ext";</i><br/> -<b>Integer:</b> Quotes are optional: <i>size: 18</i><br/> -<b>Boolean:</b> Quotes are optional: <i>bold: true</i><br/> -<b>Color:</b> There are three ways for using colors. The simplest one is to use the list of predefined <a href="http://www.w3.org/TR/css3-color/#svg-color">CSS Color names</a>: <i>fillColor: teal</i>. It is also possible to use the Hexadecimal RGB notation: <i>fillColor: #008080</i>. The last option is to use the rgb() function: <i>fillColor: rgb(0, 128, 128)</i></p><h3 id="Mask_Label">Mask Label</h3><p>Some labels can be configured with a "Mask": in the appearance tab of the properties view, some elements have a list of checkboxes which are used to select which parts of the label should be displayed (e.g. visibility, type, name, multiplicity...)</p><p>The CSS property "maskLabel" has the same purpose. The value of this property is the list of labels to display. For example, if you want to display only the name of the Ports, write:</p><pre class="source-css">/* Broken in Papyrus 1.0.0 (See Erratum below) */ -Port > Label { - maskLabel: name; -} -</pre><pre class="source-css">/* Works in Papyrus 1.0.0 (See Erratum below) */ -Port { - maskLabel: name; -} -</pre><p>If you want to display the name, type and multiplicity of a Property, write:</p><pre class="source-css">Property { - maskLabel: name type multiplicity; -} -</pre><p>Note that the order of the values doesn't matter. It is also important to understand the difference between the port and the property: the rule to match the port's label is different than the one for the property, because the Port is represented with two graphical elements: a square for the Port, and a floating text for its label. The Property is represented with a single text element. It is especially important for Associations, as Association have six different labels: one label for the Association itself, two labels for each association end (Source and target), and one label for the Association's stereotypes. The rules for configuring associations thus needs to be more precise. </p><p><font color="red">Erratum:</font> Due to <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=437186">Bug 437186</a>, in Papyrus 1.0.0 / Luna, the rule <b>Port > Label</b> doesn't work for maskLabel. You need to use <b>Port</b>. In Papyrus 1.0.1, both rules should be valid. The syntax <b>Association > Label</b> is still valid for Associations, because we still need to distinguish the different labels (Whereas the Port has a single Label and doesn't require the distinction)</p><p>For example:</p><pre class="source-css">Association > Label:sourceMultiplicity { - visible:false; -} - -Association > Label:targetMultiplicity { - visible:false; -} - -Association > Label:sourceRole { - maskLabel: name multiplicity; -} - -Association > Label:targetRole { - maskLabel: name multiplicity; -} - -Association > Label:name { - visible:false; -} -</pre><p>These rules result in:</p><p><img title="Association labels result" alt="Association labels result" border="0" src="Papyrus_CSS_maskLabel_association.png"/><br/></p><p>The list of accepted values depends on the element. To find the list of values, select an element in a Diagram (e.g. a Property), go to the Appearance tab of the properties view, and find the list of checkboxes named "Label customization". Hover the checkboxes, and look at the tooltip to find the value:</p><p><img title="Mask label" alt="Mask label" border="0" src="Papyrus_CSS_maskLabel.png"/><br/></p><p>To obtain the result shown in this screenshot, write:</p><pre class="source-css">Property { - maskLabel: name type defaultValue; -} -</pre><p>Which results in:</p><p><img title="Mask label result" alt="Mask label result" border="0" src="Papyrus_CSS_maskLabel_result.png"/><br/></p><h1 id="Manipulating_styles">Manipulating styles</h1><p>The computed styles will be applied automatically. For example, if your stylesheet tells that all your abstract classes must be red, the classes color will change automatically according to the value of their "isAbstract" property. </p><p>In some other cases, however, you may want to specify manually the style that should be applied to your objects. For this case, you can use the "Applied styles" property in the "Style" tab of the properties view.<br/> </p><pre class="source-css">.myOwnStyle { - fillColor: #A6C198; - gradient:white horizontal; -} -</pre><p> </p><p><img title="Result" alt="Result" border="0" src="Papyrus_CSS_CustomStyle.png"/><br/> </p><p>Once a style is applied on an object, the object will be refreshed each time the style definition changes. For example, changing the style "myOwnStyle" to the following declaration:<br/> </p><pre class="source-css">.myOwnStyle { - fillColor: #E3A49C; - gradient: #FFFFFF horizontal; -} -</pre><p> </p><p>All the green classes will become red.<br/></p><h1 id="Limitations_and_issues">Limitations and issues</h1><p>There are currently a few identified limitations to the Stylesheet framework, as well as a few minor bugs:<br/> </p><h2 id="Selectors">Selectors</h2><p>Currently, some complex selectors are not supported in the Papyrus stylesheets. Especially, the following are not supported yet:<br/> </p><h3 id="Selector_inheritance">Selector inheritance</h3><p>It is not possible to apply a style to all descendant of a given Metaclass. For example, a Behavior will not inherit styles from a Class, although a Behavior actually is a Class.<br/> </p><h3 id="Events_support">Events support</h3><p>Selectors based on user events are not yet implemented. For example, the CSS specification defines the :hover pseudo-selector to represent an element hovered by the mouse, which is not yet supported in Papyrus.<br/> </p><h2 id="Known_bugs">Known bugs</h2><p>The following bugs have been identified:<br/> </p><ul><li><a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=372322">Bug 372322</a>: [Diagram - Refresh] The refresh action is not correctly binded to F5<br/> </li><li><a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=386574">Bug 386574</a>: [CSS - Refresh] Only the active diagram is refresh when the stylesheets change<br/></li><li><a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=436665">Bug 436665</a>: [CSS] Refresh issue when an element is moved to a different owner</li></ul><p><a href="/wiki/Category:Papyrus" title="Category:Papyrus">Category:Papyrus</a></p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css.mediawiki index edb382c5b93..d0c3830ecda 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css.mediawiki @@ -22,11 +22,11 @@ The CSS Stylesheet support is now shipped in the base installation of Papyrus. I Without the CSS component, or with the "Black & White" CSS Theme, your diagrams look like: -[[Image:Papyrus CSS no theme.png|Papyrus diagram without CSS Theme]]<br> +[[Image:images/Papyrus_CSS_no_theme.png|Papyrus diagram without CSS Theme]]<br> With the default "Papyrus" CSS Theme, your diagrams look like: -[[Image:Papyrus CSS theme.png|Papyrus Diagram with CSS Theme]]<br> +[[Image:images/Papyrus_CSS_theme.png|Papyrus Diagram with CSS Theme]]<br> Note: If you opened a diagram which has been created without the CSS Support, it may still have a user-defined appearance, e.g. without Element icons. This might or might not be a problem, as this may conflict with the CSS Theme. You can reset all custom appearances by pressing the "Default style" button in the Style tab of the Diagram's properties view. @@ -36,7 +36,7 @@ To define a custom style, the first step is to create a Stylesheet. The creation You can define a particular style for a diagram. # Select a diagram # Go to the Style tab of the properties view -# Add a new "Diagram style sheet". There isn't currently any style sheet available from the diagram, so you need to create a new "Stylesheet reference".<br/>[[Image:Papyrus CSS Import stylesheet.png|Import stylesheet in Papyrus]] +# Add a new "Diagram style sheet". There isn't currently any style sheet available from the diagram, so you need to create a new "Stylesheet reference".<br/>[[Image:images/Papyrus_CSS_Import_stylesheet.png|Import stylesheet in Papyrus]] # Browse your workspace to find your css file, and press OK. Your stylesheet is now associated to your diagram. == Model StyleSheet == Similarily to "Diagram Stylesheet" you can define a particular style for a Model. @@ -49,7 +49,7 @@ You can associate to a project specific stylesheets. # Select a project in "Project Explorer" view # Open project preference properties: "Right click > properties" # Go to CSS stylesheets page: "Papyrus > Style sheets" -# Add a new "Project style sheet". There isn't currently any style sheet available from project, so you need to create a new "Stylesheet reference".<br/>[[Image:Papyrus_CSS_project.png|Style sheets project properties in Papyrus]] +# Add a new "Project style sheet". There isn't currently any style sheet available from project, so you need to create a new "Stylesheet reference".<br/>[[Image:images/Papyrus_CSS_project.png|Style sheets project properties in Papyrus]] # Browse your workspace to find your css file, and press OK. Now, your stylesheet is associated with the project. = Deploying a CSS Theme = @@ -64,7 +64,7 @@ The Theme can be modified from the Papyrus preferences page "CSS Theme". Only on == In workspace preference == You can define theme in workspace preferences. A theme is defined by style sheets. # Go to the Papyrus preference: "Window > Preferences > Papyrus > CSS Theme" -# Add a new theme. There are currently two existing themes: "Papyrus Theme" and "Black & White".<br/>[[Image:Papyrus_CSS_theme_creation.png|Creation of theme in Papyrus]] +# Add a new theme. There are currently two existing themes: "Papyrus Theme" and "Black & White".<br/>[[Image:images/Papyrus_CSS_theme_creation.png|Creation of theme in Papyrus]] # Write a name for this new theme # (optional) Choose an icon # Associate one or more style sheets with this theme @@ -168,7 +168,7 @@ To use it, create an element and change its appearance via the "Appearance" tab *Properties: The graphical properties to export to the style sheet *Stylesheet: The style sheet to edit<br> -[[Image:Papyrus CSS Export style.png|Create style dialog]]<br> +[[Image:images/Papyrus_CSS_Export_style.png|Create style dialog]]<br> In the Stylesheet tab, select your stylesheet:<br> @@ -229,7 +229,7 @@ The CSS Supports all GMF Notation properties, as well as a few Papyrus-specific The simplest way to discover new style properties is to use the Appearance tab of the Properties view in Papyrus. When hovering one of the appearance properties, the tooltip indicates the name of the corresponding CSS property -[[Image:Papyrus CSS tooltip.png|CSS Property in tooltip]]<br> +[[Image:images/Papyrus_CSS_tooltip.png|CSS Property in tooltip]]<br> This table lists the most common properties: @@ -401,12 +401,12 @@ Association > Label:name { These rules result in: -[[Image:Papyrus_CSS_maskLabel_association.png|Association labels result]]<br> +[[Image:images/Papyrus_CSS_maskLabel_association.png|Association labels result]]<br> The list of accepted values depends on the element. To find the list of values, select an element in a Diagram (e.g. a Property), go to the Appearance tab of the properties view, and find the list of checkboxes named "Label customization". Hover the checkboxes, and look at the tooltip to find the value: -[[Image:Papyrus_CSS_maskLabel.png|Mask label]]<br> +[[Image:images/Papyrus_CSS_maskLabel.png|Mask label]]<br> To obtain the result shown in this screenshot, write: @@ -416,7 +416,7 @@ To obtain the result shown in this screenshot, write: Which results in: -[[Image:Papyrus_CSS_maskLabel_result.png|Mask label result]]<br> +[[Image:images/Papyrus_CSS_maskLabel_result.png|Mask label result]]<br> = Manipulating styles = @@ -429,7 +429,7 @@ In some other cases, however, you may want to specify manually the style that sh gradient:white horizontal; }</source> -[[Image:Papyrus CSS CustomStyle.png|Result]]<br> +[[Image:images/Papyrus_CSS_CustomStyle.png|Result]]<br> Once a style is applied on an object, the object will be refreshed each time the style definition changes. For example, changing the style "myOwnStyle" to the following declaration:<br> diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_customStyle.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_customStyle.png Binary files differindex fd0122f970e..fd0122f970e 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_customStyle.png +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_customStyle.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_default_style.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_default_style.png Binary files differindex 80df20f3ffd..80df20f3ffd 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_default_style.png +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_default_style.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_export_style.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_export_style.png Binary files differindex 6a930cf737a..6a930cf737a 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_export_style.png +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_export_style.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_import_stylesheet.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_import_stylesheet.png Binary files differindex 4d34280c2d6..4d34280c2d6 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_import_stylesheet.png +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_import_stylesheet.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_installation.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_installation.png Binary files differindex 6ec9164e4d7..6ec9164e4d7 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_installation.png +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_installation.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_maskLabel.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_maskLabel.png Binary files differindex 5cbadf4a7f0..5cbadf4a7f0 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_maskLabel.png +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_maskLabel.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_maskLabel_association.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_maskLabel_association.png Binary files differindex c7172a79f5a..c7172a79f5a 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_maskLabel_association.png +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_maskLabel_association.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_maskLabel_result.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_maskLabel_result.png Binary files differindex ad3c7006e6a..ad3c7006e6a 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_maskLabel_result.png +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_maskLabel_result.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_no_theme.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_no_theme.png Binary files differindex e890a228d35..e890a228d35 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_no_theme.png +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_no_theme.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_project.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_project.png Binary files differindex cf1600abd10..cf1600abd10 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_project.png +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_project.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_theme.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_theme.png Binary files differindex fe6558c5d11..fe6558c5d11 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_theme.png +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_theme.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_theme_creation.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_theme_creation.png Binary files differindex b71d0a2b28a..b71d0a2b28a 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_theme_creation.png +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_theme_creation.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_tooltip.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_tooltip.png Binary files differindex 917fa97468c..917fa97468c 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/Papyrus_CSS_tooltip.png +++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/images/Papyrus_CSS_tooltip.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/.project b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/.project new file mode 100644 index 00000000000..d38510b07bd --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/.project @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>org.eclipse.papyrus.infra.nattable.doc</name>
+ <comment></comment>
+ <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/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/META-INF/MANIFEST.MF b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/META-INF/MANIFEST.MF new file mode 100644 index 00000000000..c6adca5fd3e --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/META-INF/MANIFEST.MF @@ -0,0 +1,9 @@ +Manifest-Version: 1.0
+Bundle-Vendor: Eclipse Modeling Project
+Require-Bundle: org.eclipse.help;bundle-version="3.6.0",
+ org.eclipse.papyrus.infra.doc;bundle-version="1.1.0"
+Bundle-Version: 1.1.0.qualifier
+Bundle-Name: Papyrus Table Documentation
+Bundle-ManifestVersion: 2
+Bundle-SymbolicName: org.eclipse.papyrus.infra.nattable.doc;singleton:=true
+Bundle-Description: %pluginDescription
diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/about.html b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/about.html new file mode 100644 index 00000000000..598b3684879 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.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>May 12, 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.infra.nattable.doc/build.properties b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/build.properties new file mode 100644 index 00000000000..a886e4fd4a0 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/build.properties @@ -0,0 +1,7 @@ +bin.includes = META-INF/,\
+ about.html,\
+ site/mediawiki/,\
+ plugin.xml,\
+ target/generated-eclipse-help/**
+src.includes = about.html,\
+ site/mediawiki/
diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/plugin.properties b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/plugin.properties new file mode 100644 index 00000000000..37734d357e4 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/plugin.properties @@ -0,0 +1,12 @@ +################################################################################# +# Copyright (c) 2015 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 +##################################################################################) + +pluginDescription=This plugin provides the documentation for the Papyrus Table (the new version of the Papyrus Table).
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/plugin.xml new file mode 100644 index 00000000000..7797b391971 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/plugin.xml @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8"?> +<?eclipse version="3.4"?> +<plugin> + <extension + point="org.eclipse.help.toc"> + <toc + file="target/generated-eclipse-help/nattable-main-toc.xml" + primary="false"> + </toc> + <toc + file="target/generated-eclipse-help/tablemetamodeldocumentation-toc.xml" + primary="false"> + </toc> + </extension> + +</plugin> diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/pom.xml new file mode 100644 index 00000000000..31aee60199a --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/pom.xml @@ -0,0 +1,52 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project> + <modelVersion>4.0.0</modelVersion> + <parent> + <artifactId>org.eclipse.papyrus</artifactId> + <groupId>org.eclipse.papyrus</groupId> + <version>1.1.0-SNAPSHOT</version> + <relativePath>../../../releng/top-pom-main.xml</relativePath> + </parent> + <artifactId>org.eclipse.papyrus.infra.nattable.doc</artifactId> + <groupId>org.eclipse.papyrus</groupId> + <version>1.1.0-SNAPSHOT</version> + <packaging>eclipse-plugin</packaging> + + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>site/mediawiki</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> + <title>${help.documentTitle}</title--> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> + <param>styles/main.css</param> + </stylesheetUrls--> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> +</project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/site/mediawiki/nattable-main-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/site/mediawiki/nattable-main-toc.xml new file mode 100644 index 00000000000..fd52ecd2d1e --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/site/mediawiki/nattable-main-toc.xml @@ -0,0 +1,7 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc label="Nattable" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> + <topic href="target/generated-eclipse-help/tablemetamodeldocumentation.html" label="Nattable"> + <link toc="target/generated-eclipse-help/tablemetamodeldocumentation-toc.xml"/> + <anchor id="nattable"/> + </topic> +</toc> diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/site/mediawiki/tablemetamodeldocumentation.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/site/mediawiki/tablemetamodeldocumentation.mediawiki new file mode 100644 index 00000000000..385eddec6a4 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/site/mediawiki/tablemetamodeldocumentation.mediawiki @@ -0,0 +1,99 @@ +=Metamodel Description= + +==CellEditorDeclaration== +This enumeration allows to describe the way to declare the cell editor in the table : +<li>by column </li> +<li>by row </li> +<li>by cell </li> + +==AxisIndexStyle== +This enumeration allows to describe how to display the index of the axis : +<li>Alphabetic : A, B, C ... Y, Z, AA, AB, ... </li> +<li>Numeric : 1, 2, 3 </li> + +==TableNamedElement== +abstract object used when an element need to have a name and a description + +==TableConfiguration== +this object is used to configure the table + +===Fields=== + <li>type : the type of the table</li> + <li>iconPath : the icon associated to the table</li> + <li>cellEditorDeclaration : describe how the cell editor will be declared in the table : They can be declared by row, by column or by cells</li> + <li>rowAxisProviders : the possible axis providers used for rows for this configuration</li> + <li>columnAxisProviders : the possible axis providers used for the columns for this configuration</li> + <li>defaultRowAxisProvider : the axis provider used for row just after the table creation </li> + <li>defaultColumnAxisProvider : the axis provider used for column just after the table creation </li> + + + ????rowAxisProviderConfiguration -> a la bonne place ? -> peut-�tre sur un (local)AbstractAxisProvider? + ????columnAxisProviderConfiguration -> � la bonne place? -> peut-�tre sur un (local)AbstractAxisProvider? + + ===Constraints=== + the field defaultRowAxisProvider must references an axis owned by rowAxisProviders + the field defaultColumnAxisProvider must references an axis owned by columnAxisProviders + + +==Table== +This object represents the model of the table used in Papyrus +===Fields=== +<li>invertAxis : indicates if the rows and the columns are inverted</li> +<li>tableConfiguration : the configuration used for the table</li> +<li>currentColumnAxisProvider : the current axis provider used for columns</li> +<li>currentRowAxisProvider : the current axis provider used for rows</li> +<li>rowAxisProvidersHistory : an history of the axis provider used for rows</li> +<li>columnAxisProvidersHistory : an history of the axis provider used for columns</li> + +===Constraints=== +<li>the field currentRowAxisProvider must references an axis owned by rowAxisProviderHistory</li> +<li>The field currentColumnAxisProvider must references one of axis provider referenced by columnAxisProviderHistory </li> +<li>the field rowAxisProviderHistory will contains only 1 axisProvider just after the table creation even if the config provides several row axis providers in rowAxisProviders</li> +<li>the field columnAxisProviderHistory will contains only 1 axisProvider just after the table creation even if the config provides several column axis providers in columnAxisProviders</li> +<li> the axis providers owned by columnAxisProviderHistory and rowAxisProviderHistory contains only the axis provider already used by the user. </li> + + +??? localTableConfiguration : must be here? + +??? add header in the name of the label configuration???? +==AbstractLabelConfiguration== +This object allows to store the configuration for the label provider. +===Fields=== +<li>labelProviderContext : the context to use to find the label provider to use</li> + + +==ObjectLabelProviderConfiguration== +This label provider can be used for all element displayed in a table +===Fields=== +<li>displayIcon : indicates if we want display the icon of the object in the header</li> +<li>displayLabel : indicates if we want display the label of the object in the header</li> + +==FeatureLabelProviderConfiguration== +The label provider used for object representing properties/features of others objects +===Fields=== +<li>displayIsDerived: indicates if we want display the "/" for the derived feature</li> +<li>displayType: indicates if we want display the type of the feature</li> +<li>displayMultiplicity: : indicates if we want display the multiplicity of the feature</li> +<li>displayName:indicates if the want display the name of the feature</li> + + +==AbstractAxisProvider== +This class stores in an ordered list the IAxis displayed in rows or in columns + + +=Table Refresh= + There are 2 kinds of refresh in the tables : +#a refresh of the appearance of the table <br> This refresh is done after each command executed in the command stack. +#a refresh of the rows and columns of the table <br> This refresh needs to recalculate the rows and the columns to display before to refresh the table. This refresh is called thanks to listen which listen specific modifications on the model : +##add/remove/move/... IAxis inside the model of the table, if the table is not synchronized +##add/remove/move/... elements in the display feature if the table is synchronized + +=Refresh Rows/Columns to display= +A table is managed by 2 CompositeAxisManager one for Rows and one for Columns. These managers refers one or several Axis Manager, identified in the model by an id (AxisManager#managerId). The CompositeAxisManager is used to update the list of the element to display as rows/columns. Here, we need to distinguish 2 kinds of AxisManager +#the axis manager which provides a contents stored in the model of the table <br> the user can reorder and 'mix'/reoder the elements provided by this kind of AxisManager. <br> The CompositeAxisManager reads the table model to update the list of the elements to display. +#the axis manager which provides a contents derived of the (UML) model. These one are dynamic, because they doesn't contribute to the table model. <br>the elements can't be mixed with the elements managed by the non-dynamic AxisManager, but they can be reorder 'inside' the Axismanager <br> in case of dynamic and non-dynamic AxisManager used on the same axis, the dynamic will always be displayed at the end of the axis. + +The distinction between them is done by a boolean 'isDynamic' stored in the AxisManager class + + + diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.settings/org.eclipse.core.resources.prefs b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.settings/org.eclipse.core.resources.prefs deleted file mode 100644 index 98553c18ede..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/.settings/org.eclipse.core.resources.prefs +++ /dev/null @@ -1,3 +0,0 @@ -eclipse.preferences.version=1
-encoding//resource/newChild-toc.xml=utf-8
-encoding//resource/newChild.html=utf-8
diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/build.properties b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/build.properties index db10df1d840..c1a2f1fa035 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/build.properties @@ -1,6 +1,7 @@ bin.includes = META-INF/,\
about.html,\
plugin.xml,\
- resource/
-src.includes = about.html
+ target/generated-eclipse-help/**
+src.includes = about.html,\
+ resource/
diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/plugin.xml index 1d9a4f45f85..ac128d6671d 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/plugin.xml @@ -4,11 +4,11 @@ <extension
point="org.eclipse.help.toc">
<toc
- file="resource/newChild-main-toc.xml"
+ file="target/generated-eclipse-help/newChild-main-toc.xml"
primary="false">
</toc>
<toc
- file="resource/newChild-toc.xml"
+ file="target/generated-eclipse-help/newChild-toc.xml"
primary="false">
</toc>
</extension>
diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/pom.xml index 30063f8c7d9..9a5eeb4818f 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/AllPossibleActivities.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/AllPossibleActivities.png Binary files differindex 93a409795ee..93a409795ee 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/AllPossibleActivities.png +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/AllPossibleActivities.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/AllPossibleActivitiesIllustration.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/AllPossibleActivitiesIllustration.png Binary files differindex 2ead41a7865..2ead41a7865 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/AllPossibleActivitiesIllustration.png +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/AllPossibleActivitiesIllustration.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/Architecture.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/Architecture.png Binary files differindex 9b86fcb30c2..9b86fcb30c2 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/Architecture.png +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/Architecture.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/EnableCreationMenu.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/EnableCreationMenu.png Binary files differindex 2ee0b82d010..2ee0b82d010 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/EnableCreationMenu.png +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/EnableCreationMenu.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/MenuExample.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/MenuExample.png Binary files differindex e0996bc1801..e0996bc1801 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/MenuExample.png +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/MenuExample.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NestedClassifier.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/NestedClassifier.png Binary files differindex 26d8b568537..26d8b568537 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NestedClassifier.png +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/NestedClassifier.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NestedClassifierIllustration.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/NestedClassifierIllustration.png Binary files differindex 40046cf4bf3..40046cf4bf3 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NestedClassifierIllustration.png +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/NestedClassifierIllustration.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NewDiagram.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/NewDiagram.png Binary files differindex 9f50a45041d..9f50a45041d 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/NewDiagram.png +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/NewDiagram.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/PackageWithIconO.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/PackageWithIconO.png Binary files differindex 63772d65186..63772d65186 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/PackageWithIconO.png +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/PackageWithIconO.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/PackageWithIconOIllustration.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/PackageWithIconOIllustration.png Binary files differindex f88d08f681e..f88d08f681e 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/PackageWithIconOIllustration.png +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/PackageWithIconOIllustration.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/UseCaseDiagram.png b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/UseCaseDiagram.png Binary files differindex 7d475969113..7d475969113 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/UseCaseDiagram.png +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/UseCaseDiagram.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/codeXML.PNG b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/codeXML.PNG Binary files differindex 94721d526ab..94721d526ab 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/codeXML.PNG +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/images/codeXML.PNG diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-main-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-main-toc.xml index b2354f3915e..f9d043cc461 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-main-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-main-toc.xml @@ -1,7 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?> -<toc label="CSS Stylesheets" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> - <topic href="resource/newChild.html" label="Menu new child"> +<toc label="Papyrus Guide" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> + <topic href="target/generated-eclipse-help/newChild.html" label="Menu new child"> <anchor id="new Child"/> - <link toc="resource/newChild-toc.xml"/> + <link toc="target/generated-eclipse-help/newChild-toc.xml"/> </topic> </toc> diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-toc.xml deleted file mode 100644 index 09bc9744e31..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild-toc.xml +++ /dev/null @@ -1,17 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/newChild.html" label="newChild"> - <topic href="resource/newChild.html" label="Requirements"></topic> - <topic href="resource/newChild.html#Use_Cases" label="Use Cases"> - <topic href="resource/newChild.html#UseCreateMenu" label="UseCreateMenu"> - <topic href="resource/newChild.html#How_to" label="How to"></topic> - </topic> - <topic href="resource/newChild.html#Create_or_modify_ElementCreationModel" label="Create or modify ElementCreationModel"> - <topic href="resource/newChild.html#How_to_2" label="How to"></topic> - </topic> - <topic href="resource/newChild.html#Generate_.22ElementCreationModel.22_from_a_profile" label="Generate "ElementCreationModel" from a profile"></topic> - <topic href="resource/newChild.html#Hide.2C_change_order_or_add_submenus" label="Hide, change order or add submenus"> - <topic href="resource/newChild.html#How_to_3" label="How to"></topic> - </topic> - <topic href="resource/newChild.html#Create_or_modify_ElementCreationModel_at_runtime_thanks_to_a_GUI" label="Create or modify ElementCreationModel at runtime thanks to a GUI"></topic> - </topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.html b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.html deleted file mode 100644 index 41bb3e024b1..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.html +++ /dev/null @@ -1,18 +0,0 @@ -<?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="#Requirements">Requirements</a></li><li><a href="#Use_Cases">Use Cases</a><ol style="list-style: none;"><li><a href="#UseCreateMenu">UseCreateMenu</a><ol style="list-style: none;"><li><a href="#How_to">How to</a></li></ol></li><li><a href="#Create_or_modify_ElementCreationModel">Create or modify ElementCreationModel</a><ol style="list-style: none;"><li><a href="#How_to_2">How to</a></li></ol></li><li><a href="#Generate_.22ElementCreationModel.22_from_a_profile">Generate "ElementCreationModel" from a profile</a></li><li><a href="#Hide.2C_change_order_or_add_submenus">Hide, change order or add submenus</a><ol style="list-style: none;"><li><a href="#How_to_3">How to</a></li></ol></li><li><a href="#Create_or_modify_ElementCreationModel_at_runtime_thanks_to_a_GUI">Create or modify ElementCreationModel at runtime thanks to a GUI</a></li></ol></li></ol><h1 id="Requirements">Requirements</h1><dl><dt>AddNewChild (id=newChild001):</dt><dd>Papyrus shall add in the menu new child for new customized elements by using extended type</dd><dt>HideElement (id=newChild002):</dt><dd>Papyrus shall not display all UML or SysML element creation</dd><dt>newChildFromProfile (id=newChild003):</dt><dd>Papyrus shall add the creation of new element from a subset of profile</dd><dt>newChildMenuDisplay (id=newChild004):</dt><dd>Papyrus shall be able to associate icons to folder or creation menu</dd><dt>RoleAndElementCreation (id=newChild005):</dt><dd>When an element can be created from several roles for a container, Papyrus shall let the possibility to choose the role or to let to the possibility to be created from all roles.</dd></dl><h1 id="Use_Cases">Use Cases</h1><p><img title="UseCaseDiagram" alt="UseCaseDiagram" border="0" src="UseCaseDiagram.png"/><br/></p><h2 id="UseCreateMenu">UseCreateMenu</h2><p>The Papyrus User shall use this functionality from the model explorer in order to create elements in the model. He can decide to display or not this element creation.</p><h3 id="How_to">How to</h3><p>In order to not display a menu, a user can edit the model that represents the creation menu and set the attribute visibility to false. -<img title="EnableCreationMenu" alt="EnableCreationMenu" border="0" src="EnableCreationMenu.png"/><br/></p><h2 id="Create_or_modify_ElementCreationModel">Create or modify ElementCreationModel</h2><p>An advanced User is able to create or modify creation menu. This menu is a model that can be edited </p><h3 id="How_to_2">How to</h3><p>An advanced user can contribute to the menu by adding a new plugin that contains:</p><ul><li>a xmi file that represents a creation menu. The model must be an instance of org.eclipse.papyrus.infra.newchild/resource/elementCreationMenuModel.ecore. It contains<br/><ul><li>CreationMenu<br/><ul><li>It corresponds to a menu<br/></li><li>The ElemenTypeIDRef corresponds a reference to the element Type.<br/></li><li>The role can be filled in order to specify the role play by the element.<br/></li><li>If displayAllRole is set to true, it displays all roles played by the element if the number of roles is greater than 1. By default this property is true;<br/></li></ul></li><li>Folder<br/><ul><li>It is possible to add owns label an icon.<br/></li></ul></li><li>Visibility to specify if the folder is visible.<br/></li></ul></li><li>a reference to an extension point, to specify that papyrus must take in account this file to display the menu<br/></li></ul><pre class="source-xml"><extension - point="org.eclipse.papyrus.infra.newchild"> - <menuCreationModel - model="YourCreationMenu.xmi"> - </menuCreationModel> -</extension> - -</pre><p>In the following example, a menu creation for a package is presented. This menu is contained in the folder SimpleUMLTest. We have associated an image for this menu. -<br/><img title="Creation menu for a package with a specific icon" alt="Creation menu for a package with a specific icon" border="0" src="PackageWithIconO.png"/><br/> -<br/><img title="Result for this menu" alt="Result for this menu" border="0" src="PackageWithIconOIllustration.png"/><br/></p><p>In this following example, a creation menu will be specified to allow creation of nested classifier. That 's why the role "nestedClassifier" is precised. The label for this creation is "nestedClass" -<br/><img title="Result for the menu nestedClass" alt="Result for the menu nestedClass" border="0" src="NestedClassifierIllustration.png"/><br/> -<br/><img title="Creation menu model for nested class" alt="Creation menu model for nested class" border="0" src="NestedClassifier.png"/><br/></p><p>In the following example a creation menu is created for activities. In this case, all roles are displayed. Thanks to this, when we want to associate an activity to a state, 3 roles are proposed. -<br/><img title="Creation menu model for activity" alt="Creation menu model for activity" border="0" src="AllPossibleActivities.png"/><br/> -<br/><img title="Result for this menu activity" alt="Result for this menu activity" border="0" src="AllPossibleActivitiesIllustration.png"/><br/></p><h2 id="Generate_.22ElementCreationModel.22_from_a_profile">Generate "ElementCreationModel" from a profile</h2><p>From a stereotyped profile, a model of new child menu can be generated. -For example a user after designing a profile, want to have a dedicated menu from this profile/ -For the moment this function is not implemented.</p><h2 id="Hide.2C_change_order_or_add_submenus">Hide, change order or add submenus</h2><p>The User can modify the creation menu by adding submenus: order about new child menu, precise if the role must be displayed.</p><h3 id="How_to_3">How to</h3><p>It only needed to change the order of element in the corresponding creation menu model</p><h2 id="Create_or_modify_ElementCreationModel_at_runtime_thanks_to_a_GUI">Create or modify ElementCreationModel at runtime thanks to a GUI</h2><p>A user can edit a the model that represents the creation menu at runtime for papyrus thanks to a dedicated UI. -For the moment this function is not implemented.</p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.mediawiki index 916f8d09911..89cb72512d8 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.infra.newchild.doc/resource/newChild.mediawiki @@ -7,12 +7,12 @@ __TOC__ ; newChildMenuDisplay (id=newChild004): : Papyrus shall be able to associate icons to folder or creation menu ; RoleAndElementCreation (id=newChild005): : When an element can be created from several roles for a container, Papyrus shall let the possibility to choose the role or to let to the possibility to be created from all roles. =Use Cases= -[[Image:UseCaseDiagram.png|UseCaseDiagram]]<br> +[[Image:images/UseCaseDiagram.png|UseCaseDiagram]]<br> ==UseCreateMenu== The Papyrus User shall use this functionality from the model explorer in order to create elements in the model. He can decide to display or not this element creation. ===How to=== In order to not display a menu, a user can edit the model that represents the creation menu and set the attribute visibility to false. -[[Image:EnableCreationMenu.png|EnableCreationMenu]]<br> +[[Image:images/EnableCreationMenu.png|EnableCreationMenu]]<br> ==Create or modify ElementCreationModel== An advanced User is able to create or modify creation menu. This menu is a model that can be edited ===How to=== @@ -38,16 +38,16 @@ An advanced user can contribute to the menu by adding a new plugin that contains </source> In the following example, a menu creation for a package is presented. This menu is contained in the folder SimpleUMLTest. We have associated an image for this menu. -<br>[[Image:PackageWithIconO.png|Creation menu for a package with a specific icon]]<br> -<br>[[Image:PackageWithIconOIllustration.png|Result for this menu]]<br> +<br>[[Image:images/PackageWithIconO.png|Creation menu for a package with a specific icon]]<br> +<br>[[Image:images/PackageWithIconOIllustration.png|Result for this menu]]<br> In this following example, a creation menu will be specified to allow creation of nested classifier. That 's why the role "nestedClassifier" is precised. The label for this creation is "nestedClass" -<br>[[Image:NestedClassifierIllustration.png|Result for the menu nestedClass]]<br> -<br>[[Image:NestedClassifier.png|Creation menu model for nested class]]<br> +<br>[[Image:images/NestedClassifierIllustration.png|Result for the menu nestedClass]]<br> +<br>[[Image:images/NestedClassifier.png|Creation menu model for nested class]]<br> In the following example a creation menu is created for activities. In this case, all roles are displayed. Thanks to this, when we want to associate an activity to a state, 3 roles are proposed. -<br>[[Image:AllPossibleActivities.png|Creation menu model for activity]]<br> -<br>[[Image:AllPossibleActivitiesIllustration.png|Result for this menu activity]]<br> +<br>[[Image:images/AllPossibleActivities.png|Creation menu model for activity]]<br> +<br>[[Image:images/AllPossibleActivitiesIllustration.png|Result for this menu activity]]<br> ==Generate "ElementCreationModel" from a profile== From a stereotyped profile, a model of new child menu can be generated. For example a user after designing a profile, want to have a dedicated menu from this profile/ diff --git a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/.settings/org.eclipse.core.resources.prefs b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/.settings/org.eclipse.core.resources.prefs deleted file mode 100644 index 609a5c7a1a9..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/.settings/org.eclipse.core.resources.prefs +++ /dev/null @@ -1,3 +0,0 @@ -eclipse.preferences.version=1
-encoding//resource/controlMode-toc.xml=utf-8
-encoding//resource/controlMode.html=utf-8
diff --git a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/build.properties b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/build.properties index 6d0849257d3..bfc88885d62 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/build.properties @@ -2,6 +2,7 @@ bin.includes = META-INF/,\ .,\
plugin.xml,\
about.html,\
- resource/,\
- OSGI-INF/
-src.includes = about.html
+ OSGI-INF/,\
+ target/generated-eclipse-help/**
+src.includes = about.html,\
+ resource/
diff --git a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/plugin.xml index 58ed1218e42..92665f116e5 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/plugin.xml @@ -3,8 +3,8 @@ <plugin>
<extension
point="org.eclipse.help.toc">
- <toc file="resource/controlMode-main-toc.xml" primary="false"/>
- <toc file="resource/controlMode-toc.xml" primary="false"/>
+ <toc file="target/generated-eclipse-help/controlMode-main-toc.xml" primary="false"/>
+ <toc file="target/generated-eclipse-help/controlMode-toc.xml" primary="false"/>
</extension>
</plugin>
diff --git a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/pom.xml index 6f80703987d..a168bf5308d 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/pom.xml @@ -11,4 +11,37 @@ <groupId>org.eclipse.papyrus</groupId>
<version>1.1.0-SNAPSHOT</version>
<packaging>eclipse-plugin</packaging>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.eclipse.mylyn.docs</groupId>
+ <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId>
+ <configuration>
+ <sourceFolder>resource</sourceFolder>
+ <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder>
+ <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title -->
+ <multipleOutputFiles>false</multipleOutputFiles>
+ <navigationImages>true</navigationImages>
+ <formatOutput>true</formatOutput>
+ <htmlFilenameFormat>$1.html</htmlFilenameFormat>
+ <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat>
+ <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls -->
+ </configuration>
+ <executions>
+ <execution>
+ <goals>
+ <goal>eclipse-help</goal>
+ </goals>
+ </execution>
+ </executions>
+ <dependencies>
+ <dependency>
+ <groupId>org.eclipse.mylyn.docs</groupId>
+ <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId>
+ <version>${mylyn.wikitext.version}</version>
+ </dependency>
+ </dependencies>
+ </plugin>
+ </plugins>
+ </build>
</project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/controlMode-main-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/controlMode-main-toc.xml index 01d8eea6382..8f246f8b86e 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/controlMode-main-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/controlMode-main-toc.xml @@ -1,7 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?>
<toc label="Submodel Creation and Reintegration" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser">
- <topic href="resource/controlMode.html" label="Submodel Creation and Reintegration">
- <link toc="resource/controlMode-toc.xml"/>
+ <topic href="target/generated-eclipse-help/controlMode.html" label="Submodel Creation and Reintegration">
+ <link toc="target/generated-eclipse-help/controlMode-toc.xml"/>
<anchor id="controlMode"/>
</topic>
</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/controlMode-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/controlMode-toc.xml deleted file mode 100644 index 4aaebb8f54e..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/controlMode-toc.xml +++ /dev/null @@ -1,8 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/controlMode.html" label="controlMode"> - <topic href="resource/controlMode.html" label="Creation of submodels and reintegration"> - <topic href="resource/controlMode.html#What_is_it.3F" label="What is it?"></topic> - <topic href="resource/controlMode.html#Create_a_submodel" label="Create a submodel"></topic> - <topic href="resource/controlMode.html#Reintegrate_a_submodel_into_the_main_model" label="Reintegrate a submodel into the main model"></topic> - </topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/controlMode.html b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/controlMode.html deleted file mode 100644 index 75650b87356..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/controlMode.html +++ /dev/null @@ -1,5 +0,0 @@ -<?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="Creation_of_submodels_and_reintegration">Creation of submodels and reintegration</h1><p>In this page we will show the Papyrus capabilities to create and reintegrate submodels, also known as <i>control mode</i>. </p><h2 id="What_is_it.3F">What is it?</h2><p>As a model grows large in number of elements, it is convenient to split them into different physical resources i.e. files. -Papyrus provides a feature to perform this splitting in a seamless fashion, allowing to move parts of the model to another resource. We call this <i>create a submodel</i>. -This is specially helpful working in collaborative environments, since the Team features can be applied individually to the different resources i.e. make changes and commit them in only one part of the model.</p><h2 id="Create_a_submodel">Create a submodel</h2><p>To create a submodel, right click on the element which you wish to move to a different resource (a Package in the common case) and select <i>Create submodel unit</i> -<img border="0" src="img/ControlAction.png"/> </p><p>The following dialog appears. Select the desired location for the new resource and click <i>OK</i>.</p><p><img border="0" src="img/ControlDialog.png"/> </p><p><b>Important:</b> The selected element has not been moved just yet. The model editor will be dirty i.e. there will be an asterisk next to its name in the tab. In order to complete the submodel creation, you need to <b>save</b> your model.</p><p>The new resource is created in the chosen location with the chosen file name, whilst a green decorator is shown in the model explorer view of the parent model to indicate this element is in a submodel.</p><h2 id="Reintegrate_a_submodel_into_the_main_model">Reintegrate a submodel into the main model</h2><p>To reintegrate a submodel into the main model, open the parent model and right click on the submodel element in the model explorer (recognizable with the green decorator). -<img border="0" src="img/UncontrolAction.png"/> </p><p>The submodel is reintegrated into the main model resource, and the submodel resource is deleted. </p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/controlMode.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/controlMode.mediawiki index 4f86a80ebec..facbeffe137 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/controlMode.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/controlMode.mediawiki @@ -9,11 +9,11 @@ This is specially helpful working in collaborative environments, since the Team ==Create a submodel==
To create a submodel, right click on the element which you wish to move to a different resource (a Package in the common case) and select ''Create submodel unit''
-[[Image:img/ControlAction.png]]
+[[Image:images/ControlAction.png]]
The following dialog appears. Select the desired location for the new resource and click ''OK''.
-[[Image:img/ControlDialog.png]]
+[[Image:images/ControlDialog.png]]
'''Important:''' The selected element has not been moved just yet. The model editor will be dirty i.e. there will be an asterisk next to its name in the tab. In order to complete the submodel creation, you need to '''save''' your model.
@@ -22,6 +22,6 @@ The new resource is created in the chosen location with the chosen file name, wh ==Reintegrate a submodel into the main model==
To reintegrate a submodel into the main model, open the parent model and right click on the submodel element in the model explorer (recognizable with the green decorator).
-[[Image:img/UncontrolAction.png]]
+[[Image:images/UncontrolAction.png]]
The submodel is reintegrated into the main model resource, and the submodel resource is deleted.
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/img/ControlAction.png b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/images/ControlAction.png Binary files differindex 54fcdabeb45..54fcdabeb45 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/img/ControlAction.png +++ b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/images/ControlAction.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/img/ControlDialog.png b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/images/ControlDialog.png Binary files differindex 6152f6cd50a..6152f6cd50a 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/img/ControlDialog.png +++ b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/images/ControlDialog.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/img/UncontrolAction.png b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/images/UncontrolAction.png Binary files differindex 11adcfcbf74..11adcfcbf74 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/img/UncontrolAction.png +++ b/plugins/doc/org.eclipse.papyrus.infra.services.controlmode.doc/resource/images/UncontrolAction.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/META-INF/MANIFEST.MF b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/META-INF/MANIFEST.MF index 2032e6c6ba5..0409147eab9 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/META-INF/MANIFEST.MF +++ b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/META-INF/MANIFEST.MF @@ -1,5 +1,6 @@ Manifest-Version: 1.0
-Require-Bundle: org.eclipse.help
+Require-Bundle: org.eclipse.help;bundle-version="3.6.0",
+ org.eclipse.papyrus.infra.doc;bundle-version="1.1.0"
Bundle-Vendor: %providerName
Bundle-Version: 1.1.0.qualifier
Bundle-Name: %pluginName
diff --git a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/build.properties b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/build.properties index 6f7dcdff777..f33d8fa50e2 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/build.properties @@ -3,5 +3,6 @@ bin.includes = META-INF/,\ plugin.xml,\
about.html,\
plugin.properties,\
- resources/
-src.includes = about.html + target/generated-eclipse-help/**
+src.includes = about.html,\
+ resources/ diff --git a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/plugin.xml index 2fba0cfd74f..c8744786dda 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/plugin.xml @@ -4,7 +4,7 @@ <extension
point="org.eclipse.help.toc">
<toc
- file="resources/viewpoints-toc.xml"
+ file="target/generated-eclipse-help/viewpoints-toc.xml"
primary="false">
</toc>
</extension>
diff --git a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/pom.xml index 7d3cd77844c..afbe390a86e 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resources</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/captures/explorer.png b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/images/explorer.png Binary files differindex f412ac7f575..f412ac7f575 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/captures/explorer.png +++ b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/images/explorer.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/captures/preferences.png b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/images/preferences.png Binary files differindex d0270ff1ff8..d0270ff1ff8 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/captures/preferences.png +++ b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/images/preferences.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/captures/properties.png b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/images/properties.png Binary files differindex 9663d824ce5..9663d824ce5 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/captures/properties.png +++ b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/images/properties.png diff --git a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/viewpoints-main-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/viewpoints-main-toc.xml new file mode 100644 index 00000000000..5d6cdd9a971 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/viewpoints-main-toc.xml @@ -0,0 +1,7 @@ +<?xml version='1.0' encoding='utf-8' ?>
+<toc label="Papyrus Guide" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser">
+ <topic href="target/generated-eclipse-help/viewpoints.html" label="Viewpoints">
+ <anchor id="viewpoint"/>
+ <link toc="target/generated-eclipse-help/viewpoints-toc.xml"/>
+ </topic>
+</toc>
diff --git a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/viewpoints-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/viewpoints-toc.xml deleted file mode 100644 index 45a1e184ada..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/viewpoints-toc.xml +++ /dev/null @@ -1,13 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc label="viewpoints" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser" topic="resources/viewpoints.html"> - <topic href="resources/viewpoints.html" label="Viewpoints in Papyrus"> - <topic href="resources/viewpoints.html#Introduction" label="Introduction"></topic> - <topic href="resources/viewpoints.html#Configuration_Options_for_Viewpoints" label="Configuration Options for Viewpoints"></topic> - <topic href="resources/viewpoints.html#Viewpoints-Related_UI_Elements" label="Viewpoints-Related UI Elements"></topic> - <topic href="resources/viewpoints.html#Definition_of_New_Viewpoints" label="Definition of New Viewpoints"> - <topic href="resources/viewpoints.html#Basic_Concepts" label="Basic Concepts"></topic> - <topic href="resources/viewpoints.html#Walkthrough" label="Walkthrough"></topic> - <topic href="resources/viewpoints.html#Diagram_Specification" label="Diagram Specification"></topic> - </topic> - </topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/viewpoints.html b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/viewpoints.html deleted file mode 100644 index f097c3ec210..00000000000 --- a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/viewpoints.html +++ /dev/null @@ -1 +0,0 @@ -<?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="Viewpoints_in_Papyrus">Viewpoints in Papyrus</h1><h2 id="Introduction">Introduction</h2><p>Viewpoints in Papyrus enable the specialization and customization of the user experience by constraining what can be seen and interacted with in Papyrus diagrams and tables. Viewpoints can be used for the following purposes in Papyrus:</p><ul><li>Constrain the set of diagrams and tables that are available to a particular class of users</li><li>Define new kinds of diagrams with custom names, icons, figures and palette in order to implement domain-specific views in Papyrus, based on the classical UML and SysML diagrams.</li></ul><h2 id="Configuration_Options_for_Viewpoints">Configuration Options for Viewpoints</h2><p>At any given time, there can only be one viewpoint that is currently applied to an Eclipse instance. Users are free to select any viewpoint that is provided to them. Papyrus itself comes with a default viewpoint that is automatically selected when to other viewpoint is specified.</p><p>All the viewpoints-related configuration options available to the users are provided in the <i>Papyrus > Viewpoints Configuration</i> preference page of Eclipse:</p><p><img border="0" src="captures/preferences.png"/></p><p>The first available option is the <i>Configuration selection</i>. It determines how the current viewpoint is selected. The possible options are:</p><ul><li><b>Default (Papyrus built-in configuration)</b>. This option forces the selection of the default viewpoint provided by Papyrus. This default viewpoint exposes all the UML and SysML diagrams and tables implemented in Papyrus and does not restrict their use.</li><li><b>Deployed through the extension point</b>. This option allows Papyrus to choose the viewpoint with the highest priority provided through the appropriate extension point. This option is typically chosen when 3rd party viewpoints are provided through the extension point. In this way they are automatically applied. When no custom viewpoint is provide through the extension point the default Papyrus viewpoint is applied instead.</li><li><b>Manual configuration selection</b>. This option allows the user to force the application of a specific viewpoint that is manually selected. When this option is chosen the second part of the preference page becomes available. The appropriate configuration file containing the viewpoint can be selected through 3 possible schemes:<ul><li><b>Absolute path</b>: The absolute path a file in the local file system.</li><li><b>Workspace file</b>: The selection of a file in the current Eclipse workspace</li><li><b>Embedded in a plugin</b>: The selection of a file contained within a plugin that has been loaded by the current Eclipse instance.</li></ul></li></ul><p>In the case where multiple viewpoints are available through the current configuration options as explained above the specific viewpoint to be applied can be chosen through the two drop-down lists:</p><ul><li><b>Stakeholder</b>. The class of user that is associated to a list of possible viewpoints.</li><li><b>Viewpoint</b>. The viewpoint will be applied. The list is populated based on the Stakeholder field.</li></ul><p>In addition, the checkbox <b>Multiplicity</b> can be activated so that at most one diagram or table of the each kind defined in the applied viewpoint can be created for each model element. For example, at most one class diagram per package, etc.</p><p>It is possible at any time to see the details of the diagrams and tables offered by the currently used viewpoint in the <i>Viewpoint Explorer</i> view in Eclipse. This view is available in <i>Window > Show View > Other</i>, and then selecting <i>Papyrus > Viewpoint Explorer</i>.</p><p><img border="0" src="captures/explorer.png"/></p><p>This view summarizes the currently available diagrams and tables, as well as the conditions for their availability.</p><h2 id="Viewpoints-Related_UI_Elements">Viewpoints-Related UI Elements</h2><p>The application of a viewpoint has some impacts on the following UI elements in Papyrus:</p><ul><li>The diagram selection window in the <b>New Model</b> wizard is populated with only the diagrams and tables that are available in the current viewpoint.</li><li>The <b>New Diagram</b> and <b>New Table</b> contextual menus for the model elements provides only the diagrams and tables that are available in the current viewpoint and are applicable to the currently selected model element. For example, when a UML Activity is selected, the <b>New Diagram</b> context menu will not offer to create a Package diagram, or a class diagram.</li><li>The same holds for the toolbar elements for the creation of diagrams and tables.</li><li>The diagrams properties show the following information:</li></ul><p><img border="0" src="captures/properties.png"/></p><ul><li><b>View Type</b> is the qualified name of the diagram’s type. It gives an indication of which viewpoint is providing it.</li><li>The <b>Owner</b> attribute is the model element that syntactically contains the diagram in the model explorer. It can be different from the root element.</li><li>The <b>Root</b> element attribute is the model element that is the diagram’s root semantic element.</li></ul><h2 id="Definition_of_New_Viewpoints">Definition of New Viewpoints</h2><p>Papyrus supports the definition of new viewpoints that can subsequently be used by selecting them in the Papyrus Viewpoints preference panel, as presented above. Papyrus viewpoints are defined in configuration files with the ‘.configuration’ extension. They are really just an ECore model that can be edited with the specialized viewpoint configuration editor provided by Papyrus.</p><h3 id="Basic_Concepts">Basic Concepts</h3><p>Viewpoints in Papyrus are implemented as an extension to the ISO 42010 standard for architecture description framework. Hence many concepts presented here are derived from those presented in the ISO 42010 standard. However, the standard has been extended with Papyrus-specific concepts and properties.</p><ul><li>A <i>configuration</i> is a top element of a configuration file. It contains can contains <i>viewpoints</i> specifications, <i>stakeholders</i>, as well as <i>view categories</i>.</li><li>A <i>stakeholder</i> (from ISO 42010) represents in Papyrus an archetype of users. They can be attributed <i>viewpoints</i>, thus defining what users of this kind can see.</li><li>A <i>viewpoint</i> (from ISO 42010) in Papyrus is simply set of <i>views</i>, which can be <i>diagrams</i> or <i>tables</i>.</li><li>A <i>diagram</i> in this context does not represent a single instance (for example the diagram named X in model Y), but the specification (or prototype) of future diagrams of this kind. For example the <i>UML Class Diagram</i>.</li><li>A <i>table</i> is another kind of view in Papyrus that enables the presentation of models in a tabular format.</li></ul><h3 id="Walkthrough">Walkthrough</h3><p>The definition of a new viewpoint in Papyrus starts with the creation of a new configuration file: <i>Viewpoint s configuration</i> in the Papyrus folder of the Eclipse new element creation dialog. The top element of the file should be a <i>Papyrus Configuration</i> element.</p><p><u>Step 1</u>: Select the metamodel that is applicable to this configuration. Generally, this should be UML. The metamodel is selected as the <i>metamodel</i> property of the <i>Papyrus Configuration</i> root element. The drop-down value selection is automatically filled with the currently metamodel currently loaded in Eclipse. For UML select, "<a href="http://www.eclipse.org/uml2/5.0.0/UML">http://www.eclipse.org/uml2/5.0.0/UML</a>".</p><p><u>Step 2</u>: Add the basic elements. The setting of the elements below is required for the configuration to work correctly.</p><ul><li>Right click on the <i>Papyrus Configuration</i> root element to a new <i>Stakeholder</i> child.</li><li>Give it an appropriate name</li><li>Right click on the <i>Papyrus Configuration</i> root element to a new <i>Viewpoint</i> child.</li><li>Give it an appropriate name</li><li>In the properties of the new stakeholder, add the new viewpoint to the <i>viewpoints</i> property to specify that this stakeholder will have to the specified viewpoint.</li><li>In the properties of the <i>Papyrus Configuration</i> root element, select the new stakeholder in the <i>Default Stakeholder</i> property.</li></ul><p>Notes:</p><ul><li>Stakeholder attributes other than <i>viewpoints</i> and <i>name</i> are inherited from the ISO 42010 implementation and are currently not used in Papyrus.</li><li>Viewpoint attributes other than <i>parent</i> and <i>name</i> are inherited from the ISO 42010 implementation and are currently not used in Papyrus.</li></ul><p><u>Step 3</u>: Complete the viewpoint with new diagrams and tables. Those elements can be added by right clicking on the viewpoint element, in the <i>New child</i> menu. Refer to the sections below for more information on the specification of diagrams and tables.</p><p><u>Step 4</u>: Deploy the configuration. The new configuration file can be deployed in an Eclipse plugin and registered through an extension point. The extension point to use is <code>org.eclipse.papyrus.infra.viewpoints.policy.custom</code>. It comes in two flavors that are the possible child elements for it:</p><ul><li>The <i>configuration</i> element lets you register a configuration file and give it a priority. The configuration file is selected with the <i>file</i> property. Giving an URI of the form <code>platform:/plugin/my.plugin.name/path/myconfig.configuration</code> is a good practice. The <i>priority</i> is a value between 0 and 100, 100 is the highest priority. This value will be used to select the configuration with the highest priority when the user selects the <i>Deployed through the extension point</i> option in the configuration page as explained above. In this mode, the deployed configuration replaces the default Papyrus configuration and its viewpoint. This means that unless the provided viewpoint extends the default one or replicate it, the UML and SysML diagrams and tables will not be available.</li><li>The <i>contribution</i> elements lets you specifies a configuration file as an extension of another one. The custom configuration file is selected with the <i>file</i> property. The <i>original</i> property is used to select the configuration file that is extended. To extend the default Papyrus configuration, this value must be <code>platform:/plugin/org.eclipse.papyrus.infra.viewpoints.policy/builtin/default.configuration</code>. In this mode the custom viewpoints must have the same name as the extended on in the original configuration file. In essence, the diagrams and tables defined in the new custom viewpoint will be available along the one in the original viewpoints, instead of replacing them. This mode is used by RobotML to add the RobotML diagrams to the default Papyrus viewpoint.</li></ul><h3 id="Diagram_Specification">Diagram Specification</h3><p>A diagram has the following attributes:</p><ul><li>A <i>name</i> (required) that is the user-visible name of the diagram. It will appear in the creation menus and property panel.</li><li>An <i>icon</i> (required), as an URI of the form <code>platform:/plugin/...</code>.</li><li>An <i>implementation ID</i> (required) which selects the physical (hard-coded) diagram in Papyrus that will be used as a base. The possible values for this property are summarized in the following table.</li><li>An optional <i>parent</i> that specifies a parent viewpoint-defined diagram to inherit from. Essentially, the inheriting diagram will defer to its parent’s rules (see below) when its own are not sufficient to take a decision.</li><li>An optional list of <i>profiles</i> that must be applied on the model for this diagram to be available. The possible values are automatically populated from the loaded EPackages.</li><li>An optional <i>custom style</i> as an URI of the form <code>platform:/plugin/...</code>. It must point to a CSS file that will then be automatically applied to the diagram.</li><li>An optional <i>custom palette</i> as an URI of the form <code>platform:/plugin/...</code>. It must point a palette definition in XML that will be automatically applied to the diagram.</li><li>Other attributes are inherited from the ISO 42010 implementation and are currently not used in Papyrus.</li></ul><table border="solid 1px grey"><tr><th>Implementation ID</th><th>Description</th></tr><tr><td><b>PapyrusUMLActivityDiagram</b></td><td>UML Activity Diagram</td></tr><tr><td><b>PapyrusUMLClassDiagram</b></td><td>UML Class Diagram</td></tr><tr><td><b>PapyrusUMLCommunicationDiagram</b></td><td>UML Communication Diagram</td></tr><tr><td><b>PapyrusUMLComponentDiagram</b></td><td>UML Component Diagram</td></tr><tr><td><b>CompositeStructure</b></td><td>UML Composite Diagram</td></tr><tr><td><b>PapyrusUMLDeploymentDiagram</b></td><td>UML Deployment Diagram</td></tr><tr><td><b>PapyrusUMLProfileDiagram</b></td><td>UML Profile Diagram</td></tr><tr><td><b>PapyrusUMLSequenceDiagram</b></td><td>UML Sequence Diagram</td></tr><tr><td><b>PapyrusUMLStateMachineDiagram</b></td><td>UML State Machine Diagram</td></tr><tr><td><b>PapyrusUMLTimingDiagram</b></td><td>UML Timing Diagram</td></tr><tr><td><b>UseCase</b></td><td>UML Use Case Diagram</td></tr><tr><td><b>PapyrusUMLInteractionOverviewDiagram</b></td><td>UML Interaction Overview Diagram</td></tr><tr><td><b>BlockDefinition</b></td><td>SysML Block Definition Diagram</td></tr><tr><td><b>InternalBlock</b></td><td>SysML Internal Block Diagram</td></tr><tr><td><b>Parametric</b></td><td>SysML Parametric Diagram</td></tr><tr><td><b>RequirementDiagram</b></td><td>SysML Requirements Diagram</td></tr></table><p>Once a diagram has been created it is possible to constraint it using rules. There are four kinds of rules:</p><ul><li>Model rules constrain the type of the (root) model elements that can be visualized through this view. Hence model rules control what model elements can be selected for the <i>Root element</i> property of the diagrams, as shown in the capture below.</li><li>Owning rules constrain the type of the model elements that can own the diagram itself. In practice this materializes as the type of model elements under which the diagrams can appear in the model explorer. Owning rules control what model elements can be selected for the <i>Owner</i> property of the diagrams, as shown in the capture below.</li><li>Child rules constrain the type of the model elements that can be dropped within this diagram.</li><li>Palette rules constrain the display of the diagram's palette elements.</li></ul><p><img border="0" src="captures/properties.png"/></p><p>Each rule has a <i>permit</i> property that specify whether the rule authorizes or forbids the action it represents. Otherwise, the properties of the rules are as follow:</p><ul><li><i>Model rules</i><ul><li><i>element</i> (required) represents the type of the model elements to apply the rule on.</li><li><i>multiplicity</i> (required, default is -1) represents the maximum number of this kind of diagram that can be created for the referenced model element. -1 represents an unbounded number.</li><li><i>stereotypes</i> represents the set of stereotypes that must be applied in the model element for the rule to match. The stereotypes can be picked from the classifiers of the <i>profiles</i> defined in the parent diagram.</li></ul></li><li><i>Owning rules</i><ul><li><i>element</i> (required) represents the type of the model elements to apply the rule on.</li><li><i>multiplicity</i> (required, default is -1) represents the maximum number of this kind of diagram that can be created for the referenced model element. -1 represents an unbounded number.</li><li><i>stereotypes</i> represents the set of stereotypes that must be applied in the model element for the rule to match. The stereotypes can be picked from the classifiers of the <i>profiles</i> defined in the parent diagram.</li></ul></li><li><i>Child rules</i><ul><li><i>element</i> (required) represents the type of the model elements begin dropped.</li><li><i>stereotypes</i> represents the set of stereotypes that must be applied in the model element for the rule to match. The stereotypes can be picked from the classifiers of the <i>profiles</i> defined in the parent diagram.</li><li><i>origin</i> (required) represents the type of the model elements that are the target of the drop. It is usually one of the type defined in the <i>model rules</i>.</li><li>Additionally, <i>child rules</i> can be completed with children called <i>path elements</i> using the <b>New Child</b> contextual menu. <i>Path elements</i> defines a path of properties that must be used from the <i>origin</i> to insert the new <i>element</i> in the model.</li></ul></li><li><i>Palette rules</i><ul><li><i>element</i> (required) represents a pattern to match for the identifier of a palette element.<ul><li>If the value ends with '*', it will match any palette element with the prefix specified before the '*'.</li><li>If the value is '*', it will match any palette element.</li></ul></li></ul></li></ul><p>The minimal required rules for a diagram specification to work are:</p><ul><li>A model rule that allows the diagram to be created for a model element. For example, a model rule with <i>element</i> set to UML Package, <i>multiplicity</i> to -1 and <i>permit</i> to true; meaning this diagram can be created for UML Packages and an unlimited number of diagrams can be created for each UML Package.</li><li>An owning rule that allows the diagram to be owned by a model element (appear under an element in the model explorer). For example, an owning rule with <i>element</i> set to UML Package, <i>multiplicity</i> set to -1 and <i>permit</i> to true; meaning an unlimited number of diagrams of this kind can be placed under each UML Package element in the model explorer.</li><li>A child rule that allows the dropping of any element in the diagram, expressed with the <i>permit</i> attribute set to true and other attributes left empty.</li></ul></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/viewpoints.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/viewpoints.mediawiki index 9bc8d18acec..d52167bd1cc 100644 --- a/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/viewpoints.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.infra.viewpoints.doc/resources/viewpoints.mediawiki @@ -24,7 +24,7 @@ At any given time, there can only be one viewpoint that is currently applied to All the viewpoints-related configuration options available to the users are provided in the ''Papyrus > Viewpoints Configuration'' preference page of Eclipse:
-[[image:captures/preferences.png]]
+[[Image:images/preferences.png]]
The first available option is the ''Configuration selection''. It determines how the current viewpoint is selected. The possible options are:
@@ -44,7 +44,7 @@ In addition, the checkbox '''Multiplicity''' can be activated so that at most on It is possible at any time to see the details of the diagrams and tables offered by the currently used viewpoint in the ''Viewpoint Explorer'' view in Eclipse. This view is available in ''Window > Show View > Other'', and then selecting ''Papyrus > Viewpoint Explorer''.
-[[image:captures/explorer.png]]
+[[Image:images/explorer.png]]
This view summarizes the currently available diagrams and tables, as well as the conditions for their availability.
@@ -57,16 +57,16 @@ The application of a viewpoint has some impacts on the following UI elements in * The same holds for the toolbar elements for the creation of diagrams and tables.
* The diagrams properties show the following information:
-[[image:captures/properties.png]]
+[[Image:images/properties.png]]
-* '''View Type''' is the qualified name of the diagrams type. It gives an indication of which viewpoint is providing it.
+* '''View Type''' is the qualified name of the diagram�s type. It gives an indication of which viewpoint is providing it.
* The '''Owner''' attribute is the model element that syntactically contains the diagram in the model explorer. It can be different from the root element.
-* The '''Root''' element attribute is the model element that is the diagrams root semantic element.
+* The '''Root''' element attribute is the model element that is the diagram�s root semantic element.
==Definition of New Viewpoints==
-Papyrus supports the definition of new viewpoints that can subsequently be used by selecting them in the Papyrus Viewpoints preference panel, as presented above. Papyrus viewpoints are defined in configuration files with the .configuration extension. They are really just an ECore model that can be edited with the specialized viewpoint configuration editor provided by Papyrus.
+Papyrus supports the definition of new viewpoints that can subsequently be used by selecting them in the Papyrus Viewpoints preference panel, as presented above. Papyrus viewpoints are defined in configuration files with the �.configuration� extension. They are really just an ECore model that can be edited with the specialized viewpoint configuration editor provided by Papyrus.
===Basic Concepts===
@@ -106,7 +106,7 @@ A diagram has the following attributes: * A ''name'' (required) that is the user-visible name of the diagram. It will appear in the creation menus and property panel.
* An ''icon'' (required), as an URI of the form <code>platform:/plugin/...</code>.
* An ''implementation ID'' (required) which selects the physical (hard-coded) diagram in Papyrus that will be used as a base. The possible values for this property are summarized in the following table.
-* An optional ''parent'' that specifies a parent viewpoint-defined diagram to inherit from. Essentially, the inheriting diagram will defer to its parents rules (see below) when its own are not sufficient to take a decision.
+* An optional ''parent'' that specifies a parent viewpoint-defined diagram to inherit from. Essentially, the inheriting diagram will defer to its parent�s rules (see below) when its own are not sufficient to take a decision.
* An optional list of ''profiles'' that must be applied on the model for this diagram to be available. The possible values are automatically populated from the loaded EPackages.
* An optional ''custom style'' as an URI of the form <code>platform:/plugin/...</code>. It must point to a CSS file that will then be automatically applied to the diagram.
* An optional ''custom palette'' as an URI of the form <code>platform:/plugin/...</code>. It must point a palette definition in XML that will be automatically applied to the diagram.
@@ -171,7 +171,7 @@ Once a diagram has been created it is possible to constraint it using rules. The * Child rules constrain the type of the model elements that can be dropped within this diagram.
* Palette rules constrain the display of the diagram's palette elements.
-[[image:captures/properties.png]]
+[[Image:images/properties.png]]
Each rule has a ''permit'' property that specify whether the rule authorizes or forbids the action it represents. Otherwise, the properties of the rules are as follow:
* ''Model rules''
diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/META-INF/MANIFEST.MF b/plugins/doc/org.eclipse.papyrus.layers.documentation/META-INF/MANIFEST.MF index a616a7407fe..5fe0fe5ef32 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/META-INF/MANIFEST.MF +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/META-INF/MANIFEST.MF @@ -1,5 +1,6 @@ Manifest-Version: 1.0
-Require-Bundle: org.eclipse.help
+Require-Bundle: org.eclipse.help;bundle-version="3.6.0",
+ org.eclipse.papyrus.infra.doc;bundle-version="1.1.0"
Bundle-Vendor: %providerName
Bundle-Version: 1.1.0.qualifier
Bundle-Name: %pluginName
diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/build.properties b/plugins/doc/org.eclipse.papyrus.layers.documentation/build.properties index 14023a435e2..cfb4713cd5a 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/build.properties +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/build.properties @@ -1,6 +1,6 @@ bin.includes = META-INF/,\
- guides/,\
plugin.xml,\
plugin.properties,\
- about.html
-src.includes = about.html
+ target/generated-eclipse-help/**
+src.includes = about.html,\
+ resources/
diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layers-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layers-toc.xml deleted file mode 100644 index b54cf6ff390..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layers-toc.xml +++ /dev/null @@ -1,7 +0,0 @@ -<?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/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs-toc.xml deleted file mode 100644 index 0d173331c62..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs-toc.xml +++ /dev/null @@ -1,6 +0,0 @@ -<?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/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.html b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.html deleted file mode 100644 index 98dd7080b47..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.html +++ /dev/null @@ -1 +0,0 @@ -<?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/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial-toc.xml deleted file mode 100644 index 42a0f7e2d56..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial-toc.xml +++ /dev/null @@ -1,12 +0,0 @@ -<?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/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.html b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.html deleted file mode 100644 index c335b620d42..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.html +++ /dev/null @@ -1,5 +0,0 @@ -<?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. Actually, the expression is expressed in OCL.</p><h2 id="Creating_a_derived_Layer">Creating a derived Layer</h2><p>Derived Layer are actually called 'RegExp Layer'.</p><p>To create a derived layer:</p><ul><li>Click on the Layer stack</li><li>Click Layer->Create Layers ...->Create RegExp Layer</li></ul><p><img border="0" src="derivedLayerTutorial/createRegExpLayer.png"/></p><p>The new Layer appears under the Layer Stack. You can add Properties to the layer.</p><h2 id="Writing_an_expression">Writing an expression</h2><p>A derived layer is a Layer where views are automatically attached to -the layer. The expression is used for this purpose.</p><p>Actually, the expression can only be written in OCL.</p><p>The expression is a boolean expression returning true or false. The expression is applied on each <b><i>view</i></b> (ie Shapes and Links) in the diagram. If the expression return true, the corresponding element is attached to the layer. If the expression return false, the element is not attached to the layer.</p><p>The OCL expression has a predefined variable called 'self'. It is the 'view' that must be checked. -This variable is of type <b><i>notation::View</i></b> . It can be subclassed in <b><i>notation::Shape</i></b> and <b><i>notation::Link</i></b> .</p><p>A view in a uml diagram is always associated to a UML element. This element can be accessed with the expression <b><i>self.element</i></b> .</p><p>The expression is written in the Layer property->Expr -<img border="0" src="derivedLayerTutorial/writeExpression.png"/></p><h2 id="Expressions_Examples">Expressions Examples</h2><h3 id="All_Shapes">All Shapes</h3><ul><li>self.oclIsKindOf(Shape)</li></ul><h3 id="All_Classes.2FInterface.2F_...">All Classes/Interface/ ...</h3><ul><li>self.element.oclIsKindOf(uml::NamedElement)</li><li>self.element.oclIsKindOf(uml::Class)</li><li>self.element.oclIsKindOf(uml::Package)</li></ul><h3 id="All_Classes.2FNamedElement.2F..._starting_with_a_particular_string">All Classes/NamedElement/... starting with a particular string</h3><ul><li>self.element.oclAsType(uml::NamedElement).name.startsWith('D') = true</li><li>self.element.oclAsType(uml::Class).name.startsWith('Cl') = true</li><li>self.element.oclAsType(uml::Interface).name.startsWith('I') = true</li></ul><h3 id="and_.2F_or">and / or</h3><ul><li>self.oclIsKindOf(Shape) <b>and</b> self.oclAsType(Shape).visible = true </li></ul><ul><li>self.element.oclIsKindOf(uml::Class) <b>or</b> self.element.oclIsKindOf(uml::Package) </li></ul><h3 id="All_classes_that_are_abstract">All classes that are abstract</h3><ul><li>self.element.oclAsType(uml::Class).isAbstract</li></ul><h3 id="All_classes_containing_an_operation_named_.27op1.27">All classes containing an operation named 'op1'</h3><ul><li>self.element.oclAsType(uml::Class).ownedOperation->exists( op | op.name = 'op1')</li></ul><p>Also:</p><ul><li>self.element.oclAsType(uml::Class).ownedAttribute->exists( attr | attr.name = 'name')</li></ul></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/layers-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/layers-toc.xml deleted file mode 100644 index 7baf497198d..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/layers-toc.xml +++ /dev/null @@ -1,8 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc label="Layers Tutorials" > - <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/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial-toc.xml deleted file mode 100644 index cc37f9ba974..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial-toc.xml +++ /dev/null @@ -1,18 +0,0 @@ -<?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/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.html b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.html deleted file mode 100644 index 16a657ecba0..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.html +++ /dev/null @@ -1,4 +0,0 @@ -<?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/plugins/doc/org.eclipse.papyrus.layers.documentation/pom.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/pom.xml index fd471886590..8e8b904d569 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resources</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/developpers/layers-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/developpers/layers-toc.xml new file mode 100644 index 00000000000..8392350d660 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/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="target/generated-eclipse-help/guides/developpers/layersDevs.html" label="Layers Developers Documentation"> + <link toc="target/generated-eclipse-help/guides/developpers/layersDevs-toc.xml"/> + <anchor id="layers.guides.devs"/> + </topic> +</toc> diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.mediawiki b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/developpers/layersDevs.mediawiki index d9a33a73e11..d9a33a73e11 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/developpers/layersDevs.mediawiki diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/index-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/index-toc.xml index da056b58757..2de1876a0a8 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/index-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/index-toc.xml @@ -1,9 +1,9 @@ <?xml version='1.0' encoding='utf-8' ?> <toc label="Layers" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> <topic label="Layers" > - <link toc="guides/tutorials/layers-toc.xml"/> + <link toc="target/generated-eclipse-help/guides/tutorials/layers-toc.xml"/> <anchor id="tutorials"/> - <link toc="guides/users/index-toc.xml"/> + <link toc="target/generated-eclipse-help/guides/users/index-toc.xml"/> <anchor id="documentation"/> </topic> </toc> diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.mediawiki b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/derivedLayerTutorial.mediawiki index 583466e2f44..583466e2f44 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/derivedLayerTutorial.mediawiki diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial/createRegExpLayer.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/derivedLayerTutorial/createRegExpLayer.png Binary files differindex e277553b384..e277553b384 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial/createRegExpLayer.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/derivedLayerTutorial/createRegExpLayer.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial/writeExpression.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/derivedLayerTutorial/writeExpression.png Binary files differindex 81061e0e1a5..81061e0e1a5 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial/writeExpression.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/derivedLayerTutorial/writeExpression.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/layers-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/layers-toc.xml new file mode 100644 index 00000000000..d19a8577eb5 --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/layers-toc.xml @@ -0,0 +1,8 @@ +<?xml version='1.0' encoding='utf-8' ?> +<toc label="Layers Tutorials" > + <topic label="Layers Tutorials"> + <link toc="target/generated-eclipse-help/guides/tutorials/simpleTutorial-toc.xml"/> + <link toc="target/generated-eclipse-help/guides/tutorials/derivedLayerTutorial-toc.xml"/> + <anchor id="layers.guides.tutorials"/> + </topic> +</toc> diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.mediawiki b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorial.mediawiki index c4289c45315..c4289c45315 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorial.mediawiki diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/OpenedLayersExplorer.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/OpenedLayersExplorer.png Binary files differindex 3243d6a59a0..3243d6a59a0 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/OpenedLayersExplorer.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/OpenedLayersExplorer.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachLayersStack.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/attachLayersStack.png Binary files differindex fb89859462d..fb89859462d 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachLayersStack.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/attachLayersStack.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachPropertiesWindow.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/attachPropertiesWindow.png Binary files differindex 43352b552f8..43352b552f8 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachPropertiesWindow.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/attachPropertiesWindow.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewWindow.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/attachViewWindow.png Binary files differindex 9aad29fef4c..9aad29fef4c 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewWindow.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/attachViewWindow.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewWindowSelectClasses.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/attachViewWindowSelectClasses.png Binary files differindex 3275da01c65..3275da01c65 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewWindowSelectClasses.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/attachViewWindowSelectClasses.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewsToLayer.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/attachViewsToLayer.png Binary files differindex 669be6f747e..669be6f747e 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewsToLayer.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/attachViewsToLayer.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachedLayersStack.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/attachedLayersStack.png Binary files differindex 8d536ad621e..8d536ad621e 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachedLayersStack.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/attachedLayersStack.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/changeFillColorValue.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/changeFillColorValue.png Binary files differindex db065e6effe..db065e6effe 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/changeFillColorValue.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/changeFillColorValue.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/createLayer.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/createLayer.png Binary files differindex 190ec7c5fba..190ec7c5fba 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/createLayer.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/createLayer.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/createdLayer.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/createdLayer.png Binary files differindex 27564e6d832..27564e6d832 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/createdLayer.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/createdLayer.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/defaulLayerProperties.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/defaulLayerProperties.png Binary files differindex e2da266906d..e2da266906d 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/defaulLayerProperties.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/defaulLayerProperties.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/diagramWith3Classes.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/diagramWith3Classes.png Binary files differindex 45529bd2afa..45529bd2afa 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/diagramWith3Classes.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/diagramWith3Classes.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/disableLayer.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/disableLayer.png Binary files differindex f4cb2f36020..f4cb2f36020 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/disableLayer.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/disableLayer.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/layer2.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/layer2.png Binary files differindex 9181d275fcb..9181d275fcb 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/layer2.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/layer2.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/openAttachPropertiesWindow.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/openAttachPropertiesWindow.png Binary files differindex 79c2737f73e..79c2737f73e 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/openAttachPropertiesWindow.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/openAttachPropertiesWindow.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/opnLayersExplorer.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/opnLayersExplorer.png Binary files differindex 4a4a2c92104..4a4a2c92104 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/opnLayersExplorer.png +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/tutorials/simpleTutorialImages/opnLayersExplorer.png diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/users/index-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/users/index-toc.xml index 6dc87b4974a..0e395c226c0 100644 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/users/index-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.layers.documentation/resources/guides/users/index-toc.xml @@ -1,7 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?> <toc label="Layers Documentation" > <topic label="Layers Documentation"> - <link toc="guides/tutorials/derivedLayerTutorial-toc.xml"/> + <link toc="target/generated-eclipse-help/guides/²tutorials/derivedLayerTutorial-toc.xml"/> <anchor id="layers.guides.documentations"/> </topic> </toc> diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/META-INF/MANIFEST.MF b/plugins/doc/org.eclipse.papyrus.moka.doc/META-INF/MANIFEST.MF index 270c1114d66..a4a1ddb6a2c 100755 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/META-INF/MANIFEST.MF +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/META-INF/MANIFEST.MF @@ -1,6 +1,7 @@ Manifest-Version: 1.0
Require-Bundle: org.eclipse.core.runtime,
- org.eclipse.help;bundle-version="3.6.0"
+ org.eclipse.help;bundle-version="3.6.0",
+ org.eclipse.papyrus.infra.doc;bundle-version="1.1.0"
Bundle-Vendor: Eclipse Modeling Project
Bundle-ActivationPolicy: lazy
Bundle-Version: 1.1.0.qualifier
diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/build.properties b/plugins/doc/org.eclipse.papyrus.moka.doc/build.properties index 65c4043115b..81b22d20c08 100755 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/build.properties @@ -3,6 +3,7 @@ output.. = bin/ bin.includes = META-INF/,\
.,\
about.html,\
- resource/,\
- plugin.xml
-src.includes = about.html
+ plugin.xml,\
+ target/generated-eclipse-help/**
+src.includes = about.html,\
+ resource/
diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.moka.doc/plugin.xml index 53bafee9b90..c4d8bc2a1bf 100755 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/plugin.xml @@ -4,11 +4,11 @@ <extension
point="org.eclipse.help.toc">
<toc
- file="resource/moka-main-toc.xml"
+ file="target/generated-eclipse-help/moka-main-toc.xml"
primary="false">
</toc>
<toc
- file="resource/moka-toc.xml"
+ file="target/generated-eclipse-help/moka-toc.xml"
primary="false">
</toc>
</extension>
diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.moka.doc/pom.xml index 3b3ac78973e..529edaa8f25 100755 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ActiveClassDiagram.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/ActiveClassDiagram.png Binary files differindex d7b42d11c98..d7b42d11c98 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ActiveClassDiagram.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/ActiveClassDiagram.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/AnimationConfiguration.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/AnimationConfiguration.png Binary files differindex 812fbe6d763..812fbe6d763 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/AnimationConfiguration.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/AnimationConfiguration.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/BreakpointDiagramView.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/BreakpointDiagramView.png Binary files differindex 32ec55daa83..32ec55daa83 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/BreakpointDiagramView.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/BreakpointDiagramView.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/BreakpointsView.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/BreakpointsView.png Binary files differindex 4e59ae7f65b..4e59ae7f65b 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/BreakpointsView.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/BreakpointsView.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Debug_Configuration.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/Debug_Configuration.png Binary files differindex 400ecfe1daa..400ecfe1daa 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Debug_Configuration.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/Debug_Configuration.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/EmptyLaunchConfiguration.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/EmptyLaunchConfiguration.png Binary files differindex 1af79b7d573..1af79b7d573 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/EmptyLaunchConfiguration.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/EmptyLaunchConfiguration.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/GenerateFactory.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/GenerateFactory.png Binary files differindex ccfd5c9a9f9..ccfd5c9a9f9 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/GenerateFactory.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/GenerateFactory.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/MyStyleSheets.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/MyStyleSheets.png Binary files differindex e5450262eea..e5450262eea 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/MyStyleSheets.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/MyStyleSheets.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/NewStyleSheets.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/NewStyleSheets.png Binary files differindex f64cdfa9eef..f64cdfa9eef 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/NewStyleSheets.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/NewStyleSheets.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/New_Configuration.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/New_Configuration.png Binary files differindex b613b716098..b613b716098 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/New_Configuration.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/New_Configuration.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Papyrus_Moka_ExecutionEngines.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/Papyrus_Moka_ExecutionEngines.png Binary files differindex ce252a39b33..ce252a39b33 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Papyrus_Moka_ExecutionEngines.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/Papyrus_Moka_ExecutionEngines.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/PropertiesView_EmptyStyleSheets.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/PropertiesView_EmptyStyleSheets.png Binary files differindex b6b4a6c3af0..b6b4a6c3af0 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/PropertiesView_EmptyStyleSheets.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/PropertiesView_EmptyStyleSheets.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/RemoveBreakpoints.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/RemoveBreakpoints.png Binary files differindex 299d3fa9c9e..299d3fa9c9e 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/RemoveBreakpoints.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/RemoveBreakpoints.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Setup_launch_configuration.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/Setup_launch_configuration.png Binary files differindex ec20e9e1d3f..ec20e9e1d3f 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Setup_launch_configuration.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/Setup_launch_configuration.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ThreadStatusView_empty.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/ThreadStatusView_empty.png Binary files differindex 3d55740a814..3d55740a814 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ThreadStatusView_empty.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/ThreadStatusView_empty.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToggleBreakpoint.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/ToggleBreakpoint.png Binary files differindex 971f72af9f6..971f72af9f6 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToggleBreakpoint.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/ToggleBreakpoint.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToggleBreakpointModelExplorer.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/ToggleBreakpointModelExplorer.png Binary files differindex 2fd1644792e..2fd1644792e 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToggleBreakpointModelExplorer.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/ToggleBreakpointModelExplorer.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToogleBreakpointActivation.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/ToogleBreakpointActivation.png Binary files differindex b563f8acf4c..b563f8acf4c 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/ToogleBreakpointActivation.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/ToogleBreakpointActivation.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/VariableView.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/VariableView.png Binary files differindex d64ef6433e5..d64ef6433e5 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/VariableView.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/VariableView.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Window_Preferences.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/Window_Preferences.png Binary files differindex b3d99eda6aa..b3d99eda6aa 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/Window_Preferences.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/Window_Preferences.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/modelExplorer_Create.png b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/modelExplorer_Create.png Binary files differindex 051f1e5a8ec..051f1e5a8ec 100644 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/modelExplorer_Create.png +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/images/modelExplorer_Create.png diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka-main-toc.xml b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka-main-toc.xml index 75384be892a..91fab5f24ed 100755 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka-main-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka-main-toc.xml @@ -1,7 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?>
<toc label="Model Execution" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser">
- <topic href="resource/moka.html" label="Execute UML Models using MOKA">
- <link toc="resource/moka-toc.xml"/>
+ <topic href="target/generated-eclipse-help/moka.html" label="Execute UML Models using MOKA">
+ <link toc="target/generated-eclipse-help/moka-toc.xml"/>
<anchor id="ModelExecution"/>
</topic>
</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka-toc.xml b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka-toc.xml deleted file mode 100755 index 5e78a64999c..00000000000 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka-toc.xml +++ /dev/null @@ -1,16 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/moka.html" label="moka"> - <topic href="resource/moka.html" label="Moka Overview"> - <topic href="resource/moka.html#Based_on_standards" label="Based on standards"></topic> - <topic href="resource/moka.html#Interactive_executions" label="Interactive executions"></topic> - <topic href="resource/moka.html#Extensible_framework" label="Extensible framework"></topic> - </topic> - <topic href="resource/moka.html#Getting_started_with_Moka" label="Getting started with Moka"> - <topic href="resource/moka.html#Your_first_executable_model" label="Your first executable model"></topic> - <topic href="resource/moka.html#Selecting_the_execution_engine" label="Selecting the execution engine"></topic> - <topic href="resource/moka.html#Starting_an_execution_with_a_launch_configuration" label="Starting an execution with a launch configuration"></topic> - <topic href="resource/moka.html#Managing_breakpoints" label="Managing breakpoints"></topic> - <topic href="resource/moka.html#Controlling_Executions" label="Controlling Executions"></topic> - <topic href="resource/moka.html#Configuring_animation" label="Configuring animation"></topic> - </topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka.html b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka.html deleted file mode 100755 index c753da1052a..00000000000 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka.html +++ /dev/null @@ -1 +0,0 @@ -<?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="Moka_Overview">Moka Overview</h1><p>Moka is a Papyrus module for execution of UML models, which natively includes an execution engine complying with OMG standards foundational UML (fUML <a href="http://www.omg.org/spec/FUML/">http://www.omg.org/spec/FUML/</a>) and Precise Semantics of UML Composite Structures (PSCS <i>[link to OMG webpage available soon</i>]). These standards deal with execution semantics of UML. Moka is integrated with the Eclipse debug framework to provide control, observation and animation facilities over executions. Moka can be easily extended to support alternative execution semantics, and thereby be adapted to multiple usage scenarios and domains. The key features of Moka are:</p><h2 id="Based_on_standards">Based on standards</h2><p>Moka provides basic execution and debugging facilities for fUML and its extension PSCS, which capture an executable subset of UML with precise and standard semantics. This subset is expressive enough to model structure and behavior of systems involving concurrent communicating entities, independently of technological platform details.</p><h2 id="Interactive_executions">Interactive executions</h2><p>Moka provides debug and animation facilities through a contribution and an extension to the Eclipse debug API. It is thereby possible to control execution of models(e.g., suspending/resuming executions after breakpoints have been encountered) as well as to observing states of executed models at runtime (e.g., emphasizing graphical views of model elements on which execution has suspended, retrieving and displaying any state information about the runtime manifestation of these model elements).</p><h2 id="Extensible_framework">Extensible framework</h2><p>Moka can be easily extended to address new execution semantics. This can be done through extension points enabling registration of executable model libraries (e.g., new MoCs, trace libraries, etc.) or simply tool-level extensions of the execution engine.</p><h1 id="Getting_started_with_Moka">Getting started with Moka</h1><h2 id="Your_first_executable_model">Your first executable model</h2><p>This tutorial is based on a simple executable model. It consists in an active class, with a classifier behavior that indefinitely increments a counter. The corresponding Papyrus model is available here <a href="https://wiki.eclipse.org/File:BasicActiveObjectExample.zip">https://wiki.eclipse.org/File:BasicActiveObjectExample.zip</a>. Download it, define a project in your workspace, and then import the model in this project. Once the model is imported and open in Papyrus, the Increment class should look like:</p><p><img title="The active class increment" alt="The active class increment" border="0" src="ActiveClassDiagram.png"/></p><p>The behaviors associated with this class (i.e., IncrementClassifierBehavior, which is the classifier behavior, and incrementMethod, which is the implementation of operation increment) are specified by activity diagrams. Corresponding activities are executable, according to the semantics given in OMG standards fUML and PSCS. Anyway, in fUML and PSCS, the execution of a model usually starts by executing a kind of "main" activity, which is responsible for instantiating objects, and stimulate them if needed (through signals or operation calls). Moka provides some facilities to generate this kind of activities. Just right click on class Increment, then go to Moka / Modeling Utils / Generate Factory.</p><p><img border="0" src="GenerateFactory.png"/></p><p>A factory activity for class Increment (Increment_Factory in the figure below) is then generated. This activity will be used in the next steps of this tutorial to actually start the execution of the model. Do not forget to save your model, otherwise the factory will not be visible in the launch configuration definition step described below in this tutorial.</p><p><img border="0" src="modelExplorer_Create.png"/></p><h2 id="Selecting_the_execution_engine">Selecting the execution engine</h2><p>Since Moka is an extensible execution framework, multiple execution engines can be registered in your environment. Before starting an execution, you should make sure that the appropriate execution engine is selected. To do so, go to Eclipse preferences, as shown in the figure below.</p><p><img border="0" src="Window_Preferences.png"/></p><p>Once the preference page is open, go to Papyrus/Moka. Moka is released with 3 execution engines. There are two versions of the PSCS execution engine (one is multi-threaded, with on thread per active object, and the other one is single-threaded). There is also an implementation of the fUML execution engine.</p><p><img border="0" src="Papyrus_Moka_ExecutionEngines.png"/></p><p>To make sure that the Increment example properly executes, you should select one of the two PSCS engines, press Apply and then OK.</p><h2 id="Starting_an_execution_with_a_launch_configuration">Starting an execution with a launch configuration</h2><p>Moka is integrated with the Eclipse Debug Framework. It implies that, in order to start an execution, a launch configuration has to be defined. A launch configuration can be created by clicking on the "Debug As" tool from the Eclipse tool bar, and then by pressing Debug Configurations.</p><p><img border="0" src="Debug_Configuration.png"/></p><p>Then create a new Moka launch configuration, as shown in the figure below.</p><p><img border="0" src="New_Configuration.png"/></p><p>A Moka launch configuration requires two pieces of information: the UML model from which the execution will be started, and the actual model element to be executed.</p><p><img border="0" src="EmptyLaunchConfiguration.png"/></p><p>Press the Browse button to select a UML model from your workspace (a .uml file shall be selected). Then, select the actual model element to be executed in the list "Element to be executed". This list is sorted alphabetically, by qualified names. Note that, in the case of the fUML and PSCS execution engines provided by Moka, the "Element to be executed" shall be an Activity. Your launch configuration should now look like:</p><p><img border="0" src="Setup_launch_configuration.png"/></p><p>To start the execution, simply press the Debug button. In our example, according to the semantics of PSCS, the effect of executing activity Increment_Factory will be to instantiate an Increment object, to construct this object (please refer to the default construction strategy described in the PSCS specification), and then start its classifier behavior. Our increment object will start to increment, and will go on until you stop the execution. Note that a Launch configuration is a persistent artifact, so that, if you close Papyrus and then open it again, your launch configuration will still be available, and you will be able to relaunch it.</p><h2 id="Managing_breakpoints">Managing breakpoints</h2><p>In order to easily observe and control the state of you model at some specific points of the execution, Moka lets you associate breakpoints with model elements. This can be done through the contextual menu Moka/Debug, which is available from the model explorer and from diagrams.</p><p><img border="0" src="ToggleBreakpointModelExplorer.png"/></p><p><img border="0" src="ToggleBreakpoint.png"/></p><p>Once a breakpoint has been created, a small icon (blue circle) appears on top of the corresponding model element.</p><p><img border="0" src="BreakpointDiagramView.png"/></p><p>Using the Moka/Debug menu, an existing breakpoing can also be de-activated (without being removed), using the "Toggle breakpoint activation" button. In this case, it will be depicted by a small white circle on top of the corresponding model element.</p><p><img border="0" src="ToogleBreakpointActivation.png"/></p><p>The set of existing breakpoints (as well as their status - Enabled / Disabled) is given in the breakpoint control panel, which is usually located in the upper, righ-hand part of the Debug perspective.</p><p><img border="0" src="BreakpointsView.png"/></p><p>The breakpoint control panel more generally lets you enable, disable and remove breakpoints. Just right click in the panel, as depicted in the figure below.</p><p><img border="0" src="RemoveBreakpoints.png"/></p><p>From an execution standpoint, it is important to note that the selected execution engine (see section on "Selecting the execution engine") is responsible for interpreting breakpoints. In the case of the fUML and PSCS execution engines provided by Moka, only breakpoints associated with activity nodes or edges will be taken into account (even if Moka lets you associate breakpoints with any kind of model element). Other breakpoints are simply ignored.</p><h2 id="Controlling_Executions">Controlling Executions</h2><p>Executions can be controlled using the execution control panel, provided by the Eclipse Debug perspective.</p><p><img border="0" src="ThreadStatusView_empty.png"/></p><p>It is thereby possible to resume, suspend, stop, or even do step-by-step executions. Note also that, when execution is suspended, variables may be observable in the variable panel.</p><p><img border="0" src="VariableView.png"/></p><p>The selected execution engine is responsible to determine what the visible variables are in the context of an execution. In the case of the fUML and PSCS engines provided by Moka, visible variables are properties of the context object in which in the suspended activity is executing (in our example, the suspended activity is the classifier behavior of class Increment, which executes in the context of a particular Increment object, which holds a value for property counter).</p><h2 id="Configuring_animation">Configuring animation</h2><p>By default, Moka is configured to animate diagrams during executions, without automatically giving focus / making visible a diagram where a model element being executed has a graphical representation. This can be configured in the Animation control panel, which is available in the Debug perspective.</p><p><img border="0" src="AnimationConfiguration.png"/></p><p>The slide bar enables to control the artificial animation delay between two animation steps. Note that option "Open diagrams automatically" may decrease performances of the execution engine. By default, Moka is released with some default animation styles, which determine the emphasis style to be applied to graphical elements when the execution is suspended, or more generally for animation. This default style can be overloaded per diagram, by attaching a CSS style sheet, as depicted in the figures below.</p><p><img border="0" src="PropertiesView_EmptyStyleSheets.png"/></p><p><img border="0" src="NewStyleSheets.png"/></p><p><img border="0" src="MyStyleSheets.png"/></p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka.mediawiki b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka.mediawiki index cf4262b98af..0a82648b995 100755 --- a/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.moka.doc/resource/moka.mediawiki @@ -19,25 +19,25 @@ Moka can be easily extended to address new execution semantics. This can be don This tutorial is based on a simple executable model. It consists in an active class, with a classifier behavior that indefinitely increments a counter. The corresponding Papyrus model is available here [https://wiki.eclipse.org/File:BasicActiveObjectExample.zip]. Download it, define a project in your workspace, and then import the model in this project. Once the model is imported and open in Papyrus, the Increment class should look like: -[[Image:ActiveClassDiagram.png|The active class increment]] +[[Image:images/ActiveClassDiagram.png|The active class increment]] The behaviors associated with this class (i.e., IncrementClassifierBehavior, which is the classifier behavior, and incrementMethod, which is the implementation of operation increment) are specified by activity diagrams. Corresponding activities are executable, according to the semantics given in OMG standards fUML and PSCS. Anyway, in fUML and PSCS, the execution of a model usually starts by executing a kind of "main" activity, which is responsible for instantiating objects, and stimulate them if needed (through signals or operation calls). Moka provides some facilities to generate this kind of activities. Just right click on class Increment, then go to Moka / Modeling Utils / Generate Factory. -[[Image:GenerateFactory.png]] +[[Image:images/GenerateFactory.png]] A factory activity for class Increment (Increment_Factory in the figure below) is then generated. This activity will be used in the next steps of this tutorial to actually start the execution of the model. Do not forget to save your model, otherwise the factory will not be visible in the launch configuration definition step described below in this tutorial. -[[Image:modelExplorer_Create.png]] +[[Image:images/modelExplorer_Create.png]] == Selecting the execution engine == Since Moka is an extensible execution framework, multiple execution engines can be registered in your environment. Before starting an execution, you should make sure that the appropriate execution engine is selected. To do so, go to Eclipse preferences, as shown in the figure below. -[[Image:Window_Preferences.png]] +[[Image:images/Window_Preferences.png]] Once the preference page is open, go to Papyrus/Moka. Moka is released with 3 execution engines. There are two versions of the PSCS execution engine (one is multi-threaded, with on thread per active object, and the other one is single-threaded). There is also an implementation of the fUML execution engine. -[[Image:Papyrus_Moka_ExecutionEngines.png]] +[[Image:images/Papyrus_Moka_ExecutionEngines.png]] To make sure that the Increment example properly executes, you should select one of the two PSCS engines, press Apply and then OK. @@ -45,19 +45,19 @@ To make sure that the Increment example properly executes, you should select one Moka is integrated with the Eclipse Debug Framework. It implies that, in order to start an execution, a launch configuration has to be defined. A launch configuration can be created by clicking on the "Debug As" tool from the Eclipse tool bar, and then by pressing Debug Configurations. -[[Image:Debug_Configuration.png]] +[[Image:images/Debug_Configuration.png]] Then create a new Moka launch configuration, as shown in the figure below. -[[Image:New_Configuration.png]] +[[Image:images/New_Configuration.png]] A Moka launch configuration requires two pieces of information: the UML model from which the execution will be started, and the actual model element to be executed. -[[Image:EmptyLaunchConfiguration.png]] +[[Image:images/EmptyLaunchConfiguration.png]] Press the Browse button to select a UML model from your workspace (a .uml file shall be selected). Then, select the actual model element to be executed in the list "Element to be executed". This list is sorted alphabetically, by qualified names. Note that, in the case of the fUML and PSCS execution engines provided by Moka, the "Element to be executed" shall be an Activity. Your launch configuration should now look like: -[[Image:Setup_launch_configuration.png]] +[[Image:images/Setup_launch_configuration.png]] To start the execution, simply press the Debug button. In our example, according to the semantics of PSCS, the effect of executing activity Increment_Factory will be to instantiate an Increment object, to construct this object (please refer to the default construction strategy described in the PSCS specification), and then start its classifier behavior. Our increment object will start to increment, and will go on until you stop the execution. Note that a Launch configuration is a persistent artifact, so that, if you close Papyrus and then open it again, your launch configuration will still be available, and you will be able to relaunch it. @@ -65,25 +65,25 @@ To start the execution, simply press the Debug button. In our example, according In order to easily observe and control the state of you model at some specific points of the execution, Moka lets you associate breakpoints with model elements. This can be done through the contextual menu Moka/Debug, which is available from the model explorer and from diagrams. -[[Image:ToggleBreakpointModelExplorer.png]] +[[Image:images/ToggleBreakpointModelExplorer.png]] -[[Image:ToggleBreakpoint.png]] +[[Image:images/ToggleBreakpoint.png]] Once a breakpoint has been created, a small icon (blue circle) appears on top of the corresponding model element. -[[Image:BreakpointDiagramView.png]] +[[Image:images/BreakpointDiagramView.png]] Using the Moka/Debug menu, an existing breakpoing can also be de-activated (without being removed), using the "Toggle breakpoint activation" button. In this case, it will be depicted by a small white circle on top of the corresponding model element. -[[Image:ToogleBreakpointActivation.png]] +[[Image:images/ToogleBreakpointActivation.png]] The set of existing breakpoints (as well as their status - Enabled / Disabled) is given in the breakpoint control panel, which is usually located in the upper, righ-hand part of the Debug perspective. -[[Image:BreakpointsView.png]] +[[Image:images/BreakpointsView.png]] The breakpoint control panel more generally lets you enable, disable and remove breakpoints. Just right click in the panel, as depicted in the figure below. -[[Image:RemoveBreakpoints.png]] +[[Image:images/RemoveBreakpoints.png]] From an execution standpoint, it is important to note that the selected execution engine (see section on "Selecting the execution engine") is responsible for interpreting breakpoints. In the case of the fUML and PSCS execution engines provided by Moka, only breakpoints associated with activity nodes or edges will be taken into account (even if Moka lets you associate breakpoints with any kind of model element). Other breakpoints are simply ignored. @@ -91,11 +91,11 @@ From an execution standpoint, it is important to note that the selected executi Executions can be controlled using the execution control panel, provided by the Eclipse Debug perspective. -[[Image:ThreadStatusView_empty.png]] +[[Image:images/ThreadStatusView_empty.png]] It is thereby possible to resume, suspend, stop, or even do step-by-step executions. Note also that, when execution is suspended, variables may be observable in the variable panel. -[[Image:VariableView.png]] +[[Image:images/VariableView.png]] The selected execution engine is responsible to determine what the visible variables are in the context of an execution. In the case of the fUML and PSCS engines provided by Moka, visible variables are properties of the context object in which in the suspended activity is executing (in our example, the suspended activity is the classifier behavior of class Increment, which executes in the context of a particular Increment object, which holds a value for property counter). @@ -103,13 +103,13 @@ The selected execution engine is responsible to determine what the visible varia By default, Moka is configured to animate diagrams during executions, without automatically giving focus / making visible a diagram where a model element being executed has a graphical representation. This can be configured in the Animation control panel, which is available in the Debug perspective. -[[Image:AnimationConfiguration.png]] +[[Image:images/AnimationConfiguration.png]] The slide bar enables to control the artificial animation delay between two animation steps. Note that option "Open diagrams automatically" may decrease performances of the execution engine. By default, Moka is released with some default animation styles, which determine the emphasis style to be applied to graphical elements when the execution is suspended, or more generally for animation. This default style can be overloaded per diagram, by attaching a CSS style sheet, as depicted in the figures below. -[[Image:PropertiesView_EmptyStyleSheets.png]] +[[Image:images/PropertiesView_EmptyStyleSheets.png]] -[[Image:NewStyleSheets.png]] +[[Image:images/NewStyleSheets.png]] -[[Image:MyStyleSheets.png]] +[[Image:images/MyStyleSheets.png]] diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.settings/org.eclipse.core.resources.prefs b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.settings/org.eclipse.core.resources.prefs deleted file mode 100644 index 2b3add74f34..00000000000 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/.settings/org.eclipse.core.resources.prefs +++ /dev/null @@ -1,3 +0,0 @@ -eclipse.preferences.version=1
-encoding//resource/reqif-toc.xml=utf-8
-encoding//resource/reqif.html=utf-8
diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/META-INF/MANIFEST.MF b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/META-INF/MANIFEST.MF index 92d6347c9e6..2cad14fb5a1 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/META-INF/MANIFEST.MF +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/META-INF/MANIFEST.MF @@ -5,7 +5,9 @@ Bundle-SymbolicName: org.eclipse.papyrus.req.reqif.doc;singleton:=true Bundle-Version: 1.1.0.qualifier Bundle-Activator: org.eclipse.papyrus.req.reqif.doc.Activator Require-Bundle: org.eclipse.ui,
- org.eclipse.core.runtime + org.eclipse.core.runtime, + org.eclipse.help;bundle-version="3.6.0", + org.eclipse.papyrus.infra.doc;bundle-version="1.1.0" Bundle-RequiredExecutionEnvironment: JavaSE-1.6 Bundle-ActivationPolicy: lazy Bundle-Vendor: %providerName diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/build.properties b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/build.properties index db6ac4ca2a7..12534c7cb6b 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/build.properties @@ -3,5 +3,6 @@ output.. = bin/ bin.includes = META-INF/,\
.,\
plugin.xml,\
- resource/
-src.includes = resource/DeveloperDoc.mediawiki
+ target/generated-eclipse-help/**
+src.includes = about.html,\
+ resource/
diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/plugin.xml index 5e6625a9d0c..2ae7a648b53 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/plugin.xml @@ -4,11 +4,11 @@ <extension
point="org.eclipse.help.toc">
<toc
- file="resource/reqif-main-toc.xml"
+ file="target/generated-eclipse-help/reqif-main-toc.xml"
primary="false">
</toc>
<toc
- file="resource/reqif-toc.xml"
+ file="target/generated-eclipse-help/reqif-toc.xml"
primary="false">
</toc>
</extension>
diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/pom.xml index 2d419b0ed82..d342d418c81 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif-main-toc.xml b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/DeveloperDoc-main-toc.xml index 3454eac4e9a..0c48a2cb376 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif-main-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/DeveloperDoc-main-toc.xml @@ -1,7 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?> <toc label="ReqID Import Export" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> - <topic href="resource/reqif.html" label="ReqIF Import Export"> + <topic href="target/generated-eclipse-help/reqif.html" label="ReqIF Import Export"> <anchor id="ReqIF Import Export"/> - <link toc="resource/reqif-toc.xml"/> + <link toc="target/generated-eclipse-help/reqif-toc.xml"/> </topic> </toc> diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/DeveloperDoc.mediawiki b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/DeveloperDoc.mediawiki index 136ae6a7ea1..f4449603634 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/DeveloperDoc.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/DeveloperDoc.mediawiki @@ -43,43 +43,43 @@ There are two kind of users: To verify it, go to window--> preferences--> Papyrus--> ReqIF Import</span> -[[Image:./imgDOC/Userkind.png|Two kinds of user]]<br> +[[Image:./images/Userkind.png|Two kinds of user]]<br> <span id="_jwXcIbH0EeSvo7o7Iu6GQQ">First the User must have a SysML model. Select the package where ReqIF elements will be imported. </span> -[[Image:./imgDOC/import_1.png|Import SysMLModel]]<br> +[[Image:./images/import_1.png|Import SysMLModel]]<br> <span id="_jwZ4YbH0EeSvo7o7Iu6GQQ">Select the menu Import of Eclipse.</span> -[[Image:./imgDOC/import_2.png|Select import Menu of Eclipse]]<br> +[[Image:./images/import_2.png|Select import Menu of Eclipse]]<br> <span id="_jwcUobH0EeSvo7o7Iu6GQQ">Select the menu Import ReqIF from Papyrus Categories</span> -[[Image:./imgDOC/import_3.png|Import ReqIF]]<br> +[[Image:./images/import_3.png|Import ReqIF]]<br> <span id="_jwew4bH0EeSvo7o7Iu6GQQ">Select the ReqIF file to import</span> -[[Image:./imgDOC/import_4.png|ReqIF file Selection]]<br> +[[Image:./images/import_4.png|ReqIF file Selection]]<br> <span id="_jwhNILH0EeSvo7o7Iu6GQQ">Select Requirement types of ReqIF file that you want to import</span> -[[Image:./imgDOC/import_5.png|SpecObject Type selection]]<br> +[[Image:./images/import_5.png|SpecObject Type selection]]<br> <span id="_jwjCUbH0EeSvo7o7Iu6GQQ">When the current user is an "Advanced User", he can import Requirement types and all requirements from ReqIF , if needed he can select or create the profile that will contain imported types</span> -[[Image:./imgDOC/import_6.png|Create or select Profile]]<br> +[[Image:./images/import_6.png|Create or select Profile]]<br> <span id="_jwlekbH0EeSvo7o7Iu6GQQ">When the current user is a "Simple User", he can only import instances of requirements by choosen predefined types contained in the profile. If the profile does not contain all needed types, the import is not done and a message is displayed on the screen. </span> -[[Image:./imgDOC/Choose_Predefined_Profile.png|Choose predefined type contained in profile]]<br> +[[Image:./images/Choose_Predefined_Profile.png|Choose predefined type contained in profile]]<br> -[[Image:./imgDOC/CannotImport.png|The import cannot be done if the profile is not complete.]]<br> +[[Image:./images/CannotImport.png|The import cannot be done if the profile is not complete.]]<br> <span id="_jwpI8bH0EeSvo7o7Iu6GQQ">The model has now imported requirements with relations. Note that a comment explains the origin of the import.</span> -[[Image:./imgDOC/import7.png|Resulted model]]<br> +[[Image:./images/import7.png|Resulted model]]<br> ====<span id="_jwyS4bH0EeSvo7o7Iu6GQQ">Export UML Model to ReqIF File</span>==== @@ -87,21 +87,21 @@ If the profile does not contain all needed types, the import is not done and a m <span id="_jznkcbH0EeSvo7o7Iu6GQQ">Select the SysML that you want to export </span> -[[Image:./imgDOC/export1.png|SysML Model]]<br> +[[Image:./images/export1.png|SysML Model]]<br> <span id="_jzqnwbH0EeSvo7o7Iu6GQQ">Select the export Menu from Eclipse menu.</span> -[[Image:./imgDOC/export2.png|Export Menu]]<br> +[[Image:./images/export2.png|Export Menu]]<br> <span id="_jztrELH0EeSvo7o7Iu6GQQ">Select the menu export ReqIF form the papyrus Category</span> -[[Image:./imgDOC/export3.png|Import ReqIF file]]<br> +[[Image:./images/export3.png|Import ReqIF file]]<br> <span id="_jzwHUbH0EeSvo7o7Iu6GQQ">Choose the name of the reqif file.</span> -[[Image:./imgDOC/export5.png|Choose ReqIF File name]]<br> +[[Image:./images/export5.png|Choose ReqIF File name]]<br> <span id="_jzzKobH0EeSvo7o7Iu6GQQ">At the end, a reqFile is generated. The header has an information that explain that the result comes from UML file. </span> -[[Image:./imgDOC/Export4.png|Result in the ReqIf file]]<br> +[[Image:./images/Export4.png|Result in the ReqIf file]]<br> diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/ActivityDiagram.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/ActivityDiagram.png Binary files differindex 83f93dce02f..83f93dce02f 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/ActivityDiagram.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/ActivityDiagram.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Architecture_of_ReqIF_Import-Export.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/Architecture_of_ReqIF_Import-Export.png Binary files differindex 88ca29c47e1..88ca29c47e1 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Architecture_of_ReqIF_Import-Export.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/Architecture_of_ReqIF_Import-Export.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/CannotImport.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/CannotImport.png Binary files differindex 141507fc140..141507fc140 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/CannotImport.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/CannotImport.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Choose_Predefined_Profile.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/Choose_Predefined_Profile.png Binary files differindex 75184420307..75184420307 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Choose_Predefined_Profile.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/Choose_Predefined_Profile.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/ClassDiagram.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/ClassDiagram.png Binary files differindex f7a862a4aca..f7a862a4aca 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/ClassDiagram.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/ClassDiagram.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Export4.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/Export4.png Binary files differindex 3e1ce645c9b..3e1ce645c9b 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Export4.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/Export4.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Export_Activity.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/Export_Activity.png Binary files differindex 4779d9612a9..4779d9612a9 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Export_Activity.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/Export_Activity.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Import_Activity.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/Import_Activity.png Binary files differindex 9f4907f2826..9f4907f2826 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Import_Activity.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/Import_Activity.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/UseCaseDiagram.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/UseCaseDiagram.png Binary files differindex 566521d1065..566521d1065 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/UseCaseDiagram.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/UseCaseDiagram.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/UseCases_Diagram.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/UseCases_Diagram.png Binary files differindex 7d67ecdf41e..7d67ecdf41e 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/UseCases_Diagram.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/UseCases_Diagram.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Userkind.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/Userkind.png Binary files differindex 2ccc675c07f..2ccc675c07f 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/Userkind.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/Userkind.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export1.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/export1.png Binary files differindex e2c94205722..e2c94205722 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export1.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/export1.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export2.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/export2.png Binary files differindex 23e146579a5..23e146579a5 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export2.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/export2.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export3.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/export3.png Binary files differindex ce1ac09917a..ce1ac09917a 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export3.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/export3.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export5.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/export5.png Binary files differindex ce1ac09917a..ce1ac09917a 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/export5.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/export5.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import7.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/import7.png Binary files differindex dbe4a7e8dd9..dbe4a7e8dd9 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import7.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/import7.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_1.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/import_1.png Binary files differindex 5e1326c147d..5e1326c147d 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_1.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/import_1.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_2.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/import_2.png Binary files differindex 0e93c1807ce..0e93c1807ce 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_2.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/import_2.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_3.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/import_3.png Binary files differindex 7bc74271c1d..7bc74271c1d 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_3.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/import_3.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_4.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/import_4.png Binary files differindex 8715d79fd7c..8715d79fd7c 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_4.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/import_4.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_5.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/import_5.png Binary files differindex c4bfc2781a1..c4bfc2781a1 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_5.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/import_5.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_6.png b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/import_6.png Binary files differindex 947e6f80c85..947e6f80c85 100644 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/imgDOC/import_6.png +++ b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/images/import_6.png diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif-toc.xml b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif-toc.xml deleted file mode 100644 index b0755d06852..00000000000 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif-toc.xml +++ /dev/null @@ -1,10 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/DeveloperDoc.html" label="ReqIF Import Export"> - <topic href="resource/reqif.html" label="Import Export of ReqIF elements into Papyrus"> - <topic href="resource/reqif.html#Requirements" label="Requirements"></topic> - <topic href="resource/reqif.html#Use_Cases" label="Use Cases"> - <topic href="resource/reqif.html#Import_ReqIF_file" label="Import ReqIF file"></topic> - <topic href="resource/reqif.html#Export_UML_Model_to_ReqIF_File" label="Export UML Model to ReqIF File"></topic> - </topic> - </topic> -</toc> diff --git a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif.html b/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif.html deleted file mode 100644 index 09738368ac3..00000000000 --- a/plugins/doc/org.eclipse.papyrus.req.reqif.doc/resource/reqif.html +++ /dev/null @@ -1,30 +0,0 @@ -<?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="Import_Export_of_ReqIF_elements_into_Papyrus">Import Export of ReqIF elements into Papyrus</h1> -<p>This model explains the functionality in Papyrus Req in order to import or export ReqIF files into Papyrus (OMG Document Number: formal/2013-10-01 Standard document URL: <a href="http://www.omg.org/spec/ReqIF/1.1">http://www.omg.org/spec/ReqIF/1.1</a>)</p> -<h2 id="Requirements"> -Requirements -</h2> -<p> -- ReqIfImport (id=ReqIF_001): </p><pre>Darwin shall allow importation of Reqif elements to SysML Model - -</pre> -<p>- Import SpecObjects (id=ReqIF_001_001): </p><pre>The user shall be able to import spec object - -</pre><p>- Two Kind of Users (id=ReqIF_001_002): </p><pre>The simple User can only import SpecObject by choosing domain. The AdvancedUser can import Types and DataTypes. -</pre><p>- Import DataType Enumeration (id=ReqIF_001_003): </p><pre>The advanced user shall be able to import DataType and enumeration -</pre><p>- Import SpecObjectTypes (id=ReqIF_001_004): </p><pre>The advanced user shall be able to import specObjectType -</pre><p>- Import SpecRelationType (id=ReqIF_001_005): </p><pre>The advanced user shall be able to import SpecRelationType -</pre><p>- Import SpecRelation (id=ReqIF_001_006): </p><pre>Papyrus Req shall import SpecRelation -</pre><p>- ReqIFExport (id=ReqIF_002): </p><pre>Darwin shall enable export of SysML requirement to ReqIF Model -</pre><p>- ControlMode (id=ReqIF_003): </p><pre>The managment with ReqIf must support Control Mode -</pre><p>- WihtoutUI (id=ReqIF_004): </p><pre>The export can be done programmatically, without GUI, in order to test it, or to be enable to pilot it programmatically -</pre><p>- Re-Export (id=ReqIF_005): </p><pre>Papyrus shall re-export requirements in existing reqIF file -</pre><p>- Re-Import (id=ReqIF_006): </p><pre>Papyrus shall re-Import requirement from a ReqIF file -</pre><h2 id="Use_Cases">Use Cases</h2><h4 id="Import_ReqIF_file">Import ReqIF file</h4><p>Before import requirement fro ReqIF file, the kinf of User has to be verified.</p><p>There are two kind of users:</p><p> - Simple User: he can only import instance of requirements inside the Papyrus tool.</p><p> - Advancerd User: he can importe new types of requirements and instance of requirement inside the Papyrus tool </p><p>To verify it, go to window--> preferences--> Papyrus--> ReqIF Import</p><p><img title="Two kinds of user" alt="Two kinds of user" border="0" src="./imgDOC/Userkind.png"/><br/></p><p>First the User must have a SysML model. Select the package where ReqIF elements will be imported. -</p><p><img title="Import SysMLModel" alt="Import SysMLModel" border="0" src="./imgDOC/import_1.png"/><br/></p><p>Select the menu Import of Eclipse.</p><p><img title="Select import Menu of Eclipse" alt="Select import Menu of Eclipse" border="0" src="./imgDOC/import_2.png"/><br/></p><p>Select the menu Import ReqIF from Papyrus Categories</p><p><img title="Import ReqIF" alt="Import ReqIF" border="0" src="./imgDOC/import_3.png"/><br/></p><p>Select the ReqIF file to import</p><p><img title="ReqIF file Selection" alt="ReqIF file Selection" border="0" src="./imgDOC/import_4.png"/><br/></p><p>Select Requirement types of ReqIF file that you want to import</p><p><img title="SpecObject Type selection" alt="SpecObject Type selection" border="0" src="./imgDOC/import_5.png"/><br/></p><p>When the current user is an "Advanced User", he can import Requirement types and all requirements from ReqIF , if needed he can select or create the profile that will contain imported types</p><p><img title="Create or select Profile" alt="Create or select Profile" border="0" src="./imgDOC/import_6.png"/><br/></p><p>When the current user is a "Simple User", he can only import instances of requirements by choosen predefined types contained in the profile. -If the profile does not contain all needed types, the import is not done and a message is displayed on the screen. </p><p><img title="Choose predefined type contained in profile" alt="Choose predefined type contained in profile" border="0" src="./imgDOC/Choose_Predefined_Profile.png"/><br/></p><p><img title="The import cannot be done if the profile is not complete." alt="The import cannot be done if the profile is not complete." border="0" src="./imgDOC/CannotImport.png"/><br/></p><p>The model has now imported requirements with relations. Note that a comment explains the origin of the import.</p><p><img title="Resulted model" alt="Resulted model" border="0" src="./imgDOC/import7.png"/><br/></p><h4 id="Export_UML_Model_to_ReqIF_File">Export UML Model to ReqIF File</h4><p>Select the SysML that you want to export -</p><p><img title="SysML Model" alt="SysML Model" border="0" src="./imgDOC/export1.png"/><br/></p><p>Select the export Menu from Eclipse menu.</p><p><img title="Export Menu" alt="Export Menu" border="0" src="./imgDOC/export2.png"/><br/></p><p>Select the menu export ReqIF form the papyrus Category</p><p><img title="Import ReqIF file" alt="Import ReqIF file" border="0" src="./imgDOC/export3.png"/><br/></p><p>Choose the name of the reqif file.</p><p><img title="Choose ReqIF File name" alt="Choose ReqIF File name" border="0" src="./imgDOC/export5.png"/><br/></p><p>At the end, a reqFile is generated. The header has an information that explain that the result comes from UML file. -</p><p><img title="Result in the ReqIf file" alt="Result in the ReqIf file" border="0" src="./imgDOC/Export4.png"/><br/></p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/.settings/org.eclipse.core.resources.prefs b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/.settings/org.eclipse.core.resources.prefs index be4bb130864..dc35234bfad 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/.settings/org.eclipse.core.resources.prefs +++ b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/.settings/org.eclipse.core.resources.prefs @@ -1,3 +1,2 @@ eclipse.preferences.version=1 encoding//resource/profileapplications-toc.xml=utf-8 -encoding//resource/profileapplications.html=utf-8 diff --git a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/build.properties b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/build.properties index ee908ced3ab..b4dab6d6286 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/build.properties @@ -15,5 +15,6 @@ bin.includes = META-INF/,\ plugin.xml,\ plugin.properties,\ about.html,\ - resource/ -src.includes = about.html + target/generated-eclipse-help/** +src.includes = about.html,\ + resource/ diff --git a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/plugin.xml index a73d0128793..5fd1ee91234 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/plugin.xml @@ -4,11 +4,11 @@ <extension point="org.eclipse.help.toc"> <toc - file="resource/profileapplications-main-toc.xml" + file="target/generated-eclipse-help/profileapplications-main-toc.xml" primary="false"> </toc> <toc - file="resource/profileapplications-toc.xml" + file="target/generated-eclipse-help/profileapplications-toc.xml" primary="false"> </toc> </extension> diff --git a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/pom.xml index 21fe9d68963..9d39cd3b8e1 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/resource/profileapplications-main-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/resource/profileapplications-main-toc.xml index 5c69665bb0d..4c8a4259be3 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/resource/profileapplications-main-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/resource/profileapplications-main-toc.xml @@ -1,7 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?> <toc label="Externalized Profile Applications" link_to="../org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml#profiles"> - <topic href="resource/profileapplications.html" label="Externalizing Profile Applications"> - <link toc="resource/profileapplications-toc.xml"/> + <topic href="target/generated-eclipse-help/profileapplications.html" label="Externalizing Profile Applications"> + <link toc="target/generated-eclipse-help/profileapplications-toc.xml"/> <anchor id="profileapplications"/> </topic> diff --git a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/resource/profileapplications-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/resource/profileapplications-toc.xml index f043391eee1..ddd2feb8bb1 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/resource/profileapplications-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/resource/profileapplications-toc.xml @@ -1,10 +1,10 @@ <?xml version='1.0' encoding='utf-8' ?> <toc label="profileapplications" topic="resource/profileapplications.html"> - <topic href="resource/profileapplications.html" label="About Externalized Profile Applications"></topic> - <topic href="resource/profileapplications.html#Externalizing_a_Profile_Application" label="Externalizing a Profile Application"></topic> - <topic href="resource/profileapplications.html#Loading_and_Unloading_Profile_Applications" label="Loading and Unloading Profile Applications"></topic> - <topic href="resource/profileapplications.html#Duplicating_Profile_Applications" label="Duplicating Profile Applications"></topic> - <topic href="resource/profileapplications.html#Opening_Profile_Application_Models" label="Opening Profile Application Models"></topic> - <topic href="resource/profileapplications.html#Reintegrating_Profile_Applications" label="Reintegrating Profile Applications"></topic> - <topic href="resource/profileapplications.html#Preferences" label="Preferences"></topic> + <topic href="target/generated-eclipse-help/profileapplications.html" label="About Externalized Profile Applications"></topic> + <topic href="target/generated-eclipse-help/profileapplications.html#Externalizing_a_Profile_Application" label="Externalizing a Profile Application"></topic> + <topic href="target/generated-eclipse-help/profileapplications.html#Loading_and_Unloading_Profile_Applications" label="Loading and Unloading Profile Applications"></topic> + <topic href="target/generated-eclipse-help/profileapplications.html#Duplicating_Profile_Applications" label="Duplicating Profile Applications"></topic> + <topic href="target/generated-eclipse-help/profileapplications.html#Opening_Profile_Application_Models" label="Opening Profile Application Models"></topic> + <topic href="target/generated-eclipse-help/profileapplications.html#Reintegrating_Profile_Applications" label="Reintegrating Profile Applications"></topic> + <topic href="target/generated-eclipse-help/profileapplications.html#Preferences" label="Preferences"></topic> </toc> diff --git a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/resource/profileapplications.html b/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/resource/profileapplications.html deleted file mode 100644 index f934950f191..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.decoratormodel.doc/resource/profileapplications.html +++ /dev/null @@ -1,3 +0,0 @@ -<?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="About_Externalized_Profile_Applications">About Externalized Profile Applications</h1><p>Ordinarily, profile applications in UML models are owned by the packages to which they apply profiles. However, Papyrus provides an extended -semantics that externalizes the application of profiles, letting profile applications be defined separately from the packages that apply them. -This has a few advantages:</p><ul><li>profile applications may be loaded and unloaded as required, to present extended attributes of model elements (as defined by stereotypes) when and if they are needed by the modeling user</li><li>multiple applications of the same profile to a package can provide alternative values for stereotype extensions of model elements</li></ul><h1 id="Externalizing_a_Profile_Application">Externalizing a Profile Application</h1><p>Consider the following small example of a model that has the Ecore profile applied: </p><p><img border="0" src="images/profile.png"/> </p><p>This model has two classes, both stereotyped as <tt>«eClass»</tt>. A CSS stylesheet paints EClasses yellow that specify the <tt>xmlName</tt> attribute and red that do not. Initially, this profile application is owned by the model. To separate it out into its own resource, invoke the <b>Refactor → Externalize Profile Applications...</b> context menu action on the applying package:</p><p><img border="0" src="images/refactor_externalize_menu.png"/></p><p>or select the profile application in the applying package's properties and press the externalize action button:</p><p><img border="0" src="images/externalize_button.png"/></p><p>Either way brings up the <b>Externalize Profile Applications</b> dialog:</p><p><img border="0" src="images/externalize_dlg.png"/></p><p>In this dialog, you must:</p><ul><li>select which profile applications to externalize (there may be more than one)</li><li>enter or browse to a model resource in which to put the profile application. It may be a new resource, or it may be an existing resource<ul><li><b><i>Note</i></b> that in the case of an existing resource, it must be a "profile application model". Profile applications may not be added to regular UML models</li></ul></li><li>enter a name for the profile application model (if it is new)<ul><li>if an existing profile application model is chosen to add the profile application to, then the name field is not editable as the model already has a name</li></ul></li></ul><p>After completing this dialog, it is recommended to save to create the new profile application model. This is similar to sub-model units, which are created when saving the parent model. The result is something like this:</p><p><img border="0" src="images/externalized.png"/></p><p>Note the new elements in the user interface, indicated by the arrows in the graphic above:</p><ul><li>a new UML resource is created containing the profile application. It shows a decoration indicating that it is a special kind of model, a <i>profile application model</i></li><li>the Model Explorer decorates the applying package (in this case, the root package) with the names of all of its externalized profile applications that are currently loaded</li><li>the properties of the applying package decorate the names of externalized profile applications to show which profile application model they are loaded from</li></ul><p>Moreover, the applying package has a new tab in its property sheet listing available and loaded profile applications. This is discussed further in the next section.</p><p>Note that in this example, the profile application model was created in the same project as the model to which it applies profiles. Profile application models may be created in any project in the workspace; they do not have to be in the same project as the models that they extend. Also, a profile application model may contain applications of any number of profiles on any number of packages in any number of models. The only restriction is that a single profile application model may not apply the same profile more than once to the same package. Two or more different profile application models may apply the profile to the same package in a user model, but then only one of them may be loaded at any one time in the context of that package.</p><h1 id="Loading_and_Unloading_Profile_Applications">Loading and Unloading Profile Applications</h1><p>Once a profile application has been externalized (see the preceding section), it may be unloaded and loaded again as needed. There are two ways to unload profile applications.</p><h2 id="Unload_In_Model_Explorer_View">Unload In Model Explorer View</h2><p>In the Model Explorer, select a package that has profile applications loaded and choose the <b>Unload Profile Applications...</b> action in the context menu:</p><p><img border="0" src="images/unload_menu.png"/></p><p>This brings up a dialog that lets you choose which profile application models to unload:</p><p><img border="0" src="images/unload_dlg.png"/></p><p>Finish the dialog to unload the selected models.</p><h2 id="Unload_in_Properties_View">Unload in Properties View</h2><p>Alternatively, in the <b>Applications</b> tab of the property sheet for a package that has externalized profile applications, select one or more loaded profile applications and press the unload button to quickly unload them:</p><p><img border="0" src="images/unload_button.png"/></p><p>The result on our example Ecore-profiled model is this:</p><p><img border="0" src="images/unloaded.png"/></p><p>The default styling in the diagram suggests that the <tt>«eClass»</tt> stereotype applications are now unloaded and the profile application's state in the property sheet is changed to <b>Unloaded</b>. Also, the root package no longer shows the decoration indicating loaded profile applications.</p><h2 id="Load_in_Model_Explorer_View">Load in Model Explorer View</h2><p>For packages that have available unloaded profile applications, the Model Explorer provides a <b>Load Profile Applications...</b> context menu action:</p><p><img border="0" src="images/load_menu.png"/></p><p>This brings up the <b>Load Profile Applications</b> dialog in which you may select the profile applications to load:</p><p><img border="0" src="images/load_dlg.png"/></p><p>Select the profile applications to load and finish the dialog to load them.</p><h2 id="Load_in_Properties_View">Load in Properties View</h2><p>In addition to any profile applications that are already loaded, the <b>Applications</b> tab in the property sheet shows those that are currently available to load:</p><p><img border="0" src="images/load_button.png"/></p><p>Select one or more unloaded profile applications and press the load action button to load them:</p><p><img border="0" src="images/loaded.png"/></p><p>As a quick alternative, you can double-click on an unloaded profile application to load it.</p><h2 id="Profile_Application_Resources">Profile Application Resources</h2><p>An externalized profile application is defined in a UML package in its own, separate, resource. As such, when it is loaded into the Papyrus editor, it appears in many respects like any other UML package. For convenience, the packages containing profile applications are hidden in the Model Explorer. However, they can be revealed if necessary by disabling the filter in the <b>Customize View...</b> view menu action:</p><p><img border="0" src="images/customize_view.png"/></p><p>Uncheck the <b>Profile Applications</b> filter and complete the dialog to see the loaded profile application models in the explorer:</p><p><img border="0" src="images/show_in_explorer.png"/></p><h1 id="Duplicating_Profile_Applications">Duplicating Profile Applications</h1><p>Using externalized profile applications, not only is it possible to apply multiple profiles externally to a package, but the same profile may be applied multiple times to the same package. This facilitates development of alternative extensions of the same model elements, such as for "what if" analysis or other comparisons.</p><p>The simplest way to create another application of the same profile is to duplicate an existing one. Simply select a profile application in the property sheet (it may be either loaded or unloaded) and press the duplicate action button:</p><p><img border="0" src="images/duplicate_button.png"/></p><p>This opens the <b>Duplicate Profile Application</b> dialog in which you select which of the profile applications in the model that you are duplicating you want to copy (you don't have to duplicate all of them) and then specify a new file name and profile-application model name:</p><p><img border="0" src="images/duplicate_dlg.png"/></p><p>The result looks something like this:</p><p><img border="0" src="images/duplicated.png"/></p><p>If the original profile application was loaded, then the new duplicate is loaded in its place (because the new profile application applies at least one of the same profiles as the original to the same package, only one can be loaded at a time). Otherwise, you can proceed by opening the new profile application and configuring its stereotype applications differently than in the original:</p><p><img border="0" src="images/variant2.png"/></p><h2 id="Restrictions">Restrictions</h2><p>There are certain restrictions in working with multiple profile applications, especially when they concern the same combinations of profiles and applying packages:</p><ul><li>a profile application model cannot be loaded if it applies a profile to a package that already has that profile applied<ul><li>this is concerned only with the actual package that the profile is applied to. A package may apply a profile that is also applied to some package containing it</li><li>this applies equally to the case where the package already owns an application of the profile and also the case where an externalized application of the profile is already loaded. However, in the latter case, there is a remedy available: the current profile application model may be unloaded. Papyrus will prompt to unload the conflicting profile application, with the option to just automatically unload it in the future, which is convenient for quickly switching between alternative configurations of stereotypes</li></ul></li><li>a profile application may not be externalized into a model that already has an application of the same profile for the same package. A different model must be selected or created</li></ul><h1 id="Opening_Profile_Application_Models">Opening Profile Application Models</h1><p>Profile application models may be opened in their own editors to provide convenient access to the perspective that they offer on the models that they extend. Ordinarily, they contain only stereotype applications extending elements in the user model, but it may be useful in some circumstances to create diagrams in a profile application model that are specific to the profile applications that it contains. It is <b>highly recommended</b> never to add UML content to a profile application model; only stereotype applications extending UML content. </p><p>The <b>New → Papyrus Model</b> wizard may be used to initialize a complete Papyrus model from the UML resource of a profile application:</p><p><img border="0" src="images/init_model_menu.png"/></p><p>Complete the wizard, creating for example a class diagram, and you can drag and drop elements from the profiled model onto the diagram to visualize them in some way specific to the profile application:</p><p><img border="0" src="images/decorator_model.png"/></p><p>Note that the Model Explorer shows the profile model, not the profile application model itself, simply by virtue of the latter being filtered out of the view by default (see above for details). In this way, various different perspectives on the same user model may be revealed in separate editors through the profile applications. Of course, the same caveats apply for making changes to the same UML content in multiple such editors as would normally apply to editing shared "library" models.</p><h1 id="Reintegrating_Profile_Applications">Reintegrating Profile Applications</h1><p>The opposite process to externalizing a profile application is reintegrating it into the model proper. There are two ways to reintegrate a loaded profile application: using the <b>Refactor → Internalize Profile Applications...</b> action in the context menu:</p><p><img border="0" src="images/internalize_menu.png"/></p><p>or by selecting one or more profile applications in the property sheet and pressing the internalize action button:</p><p><img border="0" src="images/internalize_button.png"/></p><p>The context menu action opens a dialog in which you may choose which profile applications, for the selected package, that are currently loaded should be reintegrated. Upon saving the model, then, these profile applications and the stereotype applications that they define are stored once more in the same resources as the UML elements that they extend.</p><h1 id="Preferences">Preferences</h1><p>A few preference options are available to control how Papyrus behaves in working with externalized profile applications. These are:</p><p><img border="0" src="images/preferences.png"/></p><ol><li>Whether Papyrus should automatically prompt you to select one or more profile applications to load when opening a model that has externalized profile applications available for one or more packages within the model.</li><li>When loading a profile application model, whether Papyrus should prompt to confirm that applications of the same profile(s) to the same package(s) that are already loaded should first be unloaded, or else cancel loading the new profile application. Disabling this prompt makes for quick switching of profile applications by double-clicking in the property sheet to load alternatives.</li><li>What to do when a profile application model is emptied of all profile applications by reintegration. Ordinarily, no useful data besides stereotype applications is stored in a profile application model, and these are simply moved into the main model resource by reintegration, so it is safe and practical to delete the profile application model when it is no longer needed. However, in the case that it has specialized diagrams or (though not recommended) other UML content, it may be important to retain that model.</li></ol></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/META-INF/MANIFEST.MF b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/META-INF/MANIFEST.MF index 1e3526d8205..824358a12f5 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/META-INF/MANIFEST.MF +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/META-INF/MANIFEST.MF @@ -1,5 +1,6 @@ Manifest-Version: 1.0
-Require-Bundle: org.eclipse.help
+Require-Bundle: org.eclipse.help;bundle-version="3.6.0",
+ org.eclipse.papyrus.infra.doc;bundle-version="1.1.0"
Bundle-Vendor: %Bundle-Vendor
Bundle-Version: 1.1.0.qualifier
Bundle-Name: %Bundle-Name
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/build.properties b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/build.properties index 92a2ba56dcf..0fc01342315 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/build.properties @@ -1,6 +1,7 @@ bin.includes = META-INF/,\
plugin.xml,\
- resource/,\
about.html,\
- OSGI-INF/
-src.includes = about.html + OSGI-INF/,\
+ target/generated-eclipse-help/**
+src.includes = about.html,\
+ resource/ diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/plugin.xml index d492aa6226c..afd829760f3 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/plugin.xml @@ -4,19 +4,19 @@ <extension
point="org.eclipse.help.toc">
<toc
- file="resource/symbols-main-toc.xml"
+ file="target/generated-eclipse-help/symbols-main-toc.xml"
primary="false">
</toc>
<toc
- file="resource/symbols-toc.xml"
+ file="target/generated-eclipse-help/symbols-toc.xml"
primary="false">
</toc>
<toc
- file="resource/constraints-toc.xml"
+ file="target/generated-eclipse-help/constraints-toc.xml"
primary="false">
</toc>
<toc
- file="resource/constraint-creation-toc.xml"
+ file="target/generated-eclipse-help/constraint-creation-toc.xml"
primary="false">
</toc>
</extension>
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/pom.xml index ae51d06a79a..f341b4b07e9 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraint-creation-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraint-creation-toc.xml index 87199061f03..fdac3be9ea6 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraint-creation-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraint-creation-toc.xml @@ -1,9 +1,9 @@ <?xml version='1.0' encoding='utf-8' ?> <toc topic="resource/constraint-creation.html" label="Create constraints" link_to="constraints-toc.xml"> - <topic href="resource/constraint-creation.html" label="Create and edit constraints"> - <topic href="resource/constraint-creation.html#Specify_the_context" label="Specify the context"> + <topic href="target/generated-eclipse-help/constraint-creation.html" label="Create and edit constraints"> + <topic href="target/generated-eclipse-help/constraint-creation.html#Specify_the_context" label="Specify the context"> </topic> - <topic href="resource/constraint-creation.html#Define_specification" label="Define constraint specification"> + <topic href="target/generated-eclipse-help/constraint-creation.html#Define_specification" label="Define constraint specification"> </topic> </topic> </toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraint-creation.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraint-creation.html deleted file mode 100644 index 0bde6404e72..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraint-creation.html +++ /dev/null @@ -1,26 +0,0 @@ -<?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="Create_and_edit_constraints">Create and edit constraints</h1><p>Creation and edition comprises includes multiple use case, namely creation of a constraint and its context and setting a specification.</p><p><center> -<img border="0" src="PapyrusConstraint-CreationUseCase.png"/><br/> -</center></p><h2 id="Define_a_constraint_and_its_context">Define a constraint and its context</h2><p>Papyrus supports the creation of UML constraints. To create a constraint, and associated context, do one of the following:</p><ul><li>Within any Papyrus diagram select the constraint tool from the palette and then press the mouse button at the position where you want to create the constraint on the diagram canvas. The constraint should then be connected to another element on the diagram, via a ContextLink relationship, by clicking on the target element in the diagram (in two-click mode). If you are in one-click-mode (connection tool preference), press the mouse button on the constraint and keep it pressed until the context object is selected. This ContextLink relationship defines the context for which the constraint will be evaluated.</li></ul><p><center> -<img border="0" src="PapyrusConstraint-CreateViaDiagram.png"/> <img border="0" src="PapyrusConstraint-ContextViaDiagram.png"/><br/> -The constraint and context-link tools in the palette -</center></p><ul><li>Within the Model Explorer via right clicking a model element and then selecting New Child -> Create a new Constraint. The context is automatically set to the parent of the constraint. The context can be changed via the Properties View if required.<br/></li></ul><p><center> -<img border="0" src="PapyrusConstraint-CreateViaME.png"/><br/> -Create a constraint via the model explorer -</center></p><p><center> -<img border="0" src="PapyrusConstraint-ContextViaPropertyView.png"/><br/> -Set the context via the property view -</center></p><h2 id="Define_constraint_specification">Define constraint specification</h2><p>Each constraint has a specification containing a condition. Whereas it may be an arbitrary value specification, such as a StringExpression or LiteralInteger, it is in most cases useful to define an opaque expression consisting of a pair of language and body (a list of these pairs). The constraint body may be written in at least OCL, JAVA, or natural language. In order to make constraints evaluable by Papyrus the constraint must be written in either OCL or JAVA. To define a constraint's specification, first select a constraint on either a diagram or in the Model Explorer, then do the following:</p><ul><li>On the diagram open the default editor for constraints using the keyboard shortcut F2 or with a second click on an already selected constraint. The editor assume the language is OCL but this can be changed later via the Properties View. The constraint text is defined directly in the editor. The default editor can be controlled via the preferences. </li></ul><ul><li>On the diagram select a specific editor via the context menu, as shown in the following screenshot.</li></ul><p><center> -<img border="0" src="PapyrusConstraint-ChooseEditor.png"/><br/> -Explicitly choose the editor for the constraint -</center></p><p>Use the property view to create a new or open an existing specification, as shown in the following figure. -In the sequel, we assume that the specification is an opaque expression.</p><p><center> -<img border="0" src="PapyrusConstraint-SpecViaPropertyView.png"/><br/> -Open the specification via the property view -</center></p><p>You can add the language, as in the following figure:<br/></p><p><center> -<img border="0" src="PapyrusConstraint-OpaqueExpressionAddLang.png"/><br/> -Specify a language. -</center></p><p><center> -<img border="0" src="PapyrusConstraint-OpaqueExpressionEdit.png"/><br/> -Write the body of the opaque expression -</center></p><p>This method is a bit more complicated, but gives the user full control over the opaque specification. In particular, -it is possible to enter more than one language, body pair (even if this is rarely needed).</p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraint-creation.mediawiki b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraint-creation.mediawiki index 16d61ff1925..87a3870aa02 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraint-creation.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraint-creation.mediawiki @@ -3,7 +3,7 @@ Creation and edition comprises includes multiple use case, namely creation of a constraint and its context and setting a specification. <center> -[[image:PapyrusConstraint-CreationUseCase.png]]<br/> +[[Image:images/PapyrusConstraint-CreationUseCase.png]]<br/> </center> == Define a constraint and its context == @@ -13,19 +13,19 @@ Papyrus supports the creation of UML constraints. To create a constraint, and as * Within any Papyrus diagram select the constraint tool from the palette and then press the mouse button at the position where you want to create the constraint on the diagram canvas. The constraint should then be connected to another element on the diagram, via a ContextLink relationship, by clicking on the target element in the diagram (in two-click mode). If you are in one-click-mode (connection tool preference), press the mouse button on the constraint and keep it pressed until the context object is selected. This ContextLink relationship defines the context for which the constraint will be evaluated. <center> -[[Image:PapyrusConstraint-CreateViaDiagram.png]] [[Image:PapyrusConstraint-ContextViaDiagram.png]]<br> +[[Image:images/PapyrusConstraint-CreateViaDiagram.png]] [[Image:images/PapyrusConstraint-ContextViaDiagram.png]]<br> The constraint and context-link tools in the palette </center> * Within the Model Explorer via right clicking a model element and then selecting New Child -> Create a new Constraint. The context is automatically set to the parent of the constraint. The context can be changed via the Properties View if required.<br> <center> -[[Image:PapyrusConstraint-CreateViaME.png]]<br> +[[Image:images/PapyrusConstraint-CreateViaME.png]]<br> Create a constraint via the model explorer </center> <center> -[[Image:PapyrusConstraint-ContextViaPropertyView.png]]<br> +[[Image:images/PapyrusConstraint-ContextViaPropertyView.png]]<br> Set the context via the property view </center> @@ -38,7 +38,7 @@ Each constraint has a specification containing a condition. Whereas it may be an * On the diagram select a specific editor via the context menu, as shown in the following screenshot. <center> -[[Image:PapyrusConstraint-ChooseEditor.png]]<br> +[[Image:images/PapyrusConstraint-ChooseEditor.png]]<br> Explicitly choose the editor for the constraint </center> @@ -46,19 +46,19 @@ Use the property view to create a new or open an existing specification, as show In the sequel, we assume that the specification is an opaque expression. <center> -[[Image:PapyrusConstraint-SpecViaPropertyView.png]]<br> +[[Image:images/PapyrusConstraint-SpecViaPropertyView.png]]<br> Open the specification via the property view </center> You can add the language, as in the following figure:<br> <center> -[[Image:PapyrusConstraint-OpaqueExpressionAddLang.png]]<br> +[[Image:images/PapyrusConstraint-OpaqueExpressionAddLang.png]]<br> Specify a language. </center> <center> -[[Image:PapyrusConstraint-OpaqueExpressionEdit.png]]<br> +[[Image:images/PapyrusConstraint-OpaqueExpressionEdit.png]]<br> Write the body of the opaque expression </center> diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraints-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraints-toc.xml deleted file mode 100644 index d15a17d0302..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraints-toc.xml +++ /dev/null @@ -1,7 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?>
-<toc label="Constraints in Papyrus" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser">
- <topic href="resource/constraints.html" label="Constraints in Papyrus">
- <anchor id="Constraints"/>
- <link toc="resource/constraint-creation-toc.xml"/>
- </topic>
-</toc>
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraints.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraints.html deleted file mode 100644 index 4fef1890ee5..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/constraints.html +++ /dev/null @@ -1,18 +0,0 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<?xml version='1.0' encoding='utf-8'?> -<head> - <meta name="generator" content="HTML Tidy for Linux/x86 (vers 25 March 2009), see www.w3.org" /> - <meta http-equiv="Content-Type" content="text/html; charset=us-ascii" /> - <title>Constraint creation</title> -</head> - -<body> -<h1 id="constraints">Constraints in Papyrus</h1> - -Constraint describe valid intervals for values, e.g. a value of a stereotype attribute or a -value of a slot in an instance specification. Thus, constraints are important elements of a user model. -Constraints can also be defined in the context of a profile, since the use of a specific stereotype -might only be valid, if the element applying the stereotype satisfies certain constraints. - -</body> -</html> diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-ChooseEditor.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-ChooseEditor.png Binary files differindex 45da47a8afb..45da47a8afb 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-ChooseEditor.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-ChooseEditor.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-ContextViaDiagram.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-ContextViaDiagram.png Binary files differindex 2530c64e2a0..2530c64e2a0 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-ContextViaDiagram.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-ContextViaDiagram.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-ContextViaPropertyView.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-ContextViaPropertyView.png Binary files differindex a3d325cfbe0..a3d325cfbe0 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-ContextViaPropertyView.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-ContextViaPropertyView.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-CreateViaDiagram.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-CreateViaDiagram.png Binary files differindex d7928a19f34..d7928a19f34 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-CreateViaDiagram.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-CreateViaDiagram.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-CreateViaME.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-CreateViaME.png Binary files differindex f920598521b..f920598521b 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-CreateViaME.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-CreateViaME.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-CreationUseCase.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-CreationUseCase.png Binary files differindex a6965fb8519..a6965fb8519 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-CreationUseCase.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-CreationUseCase.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-OpaqueExpressionAddLang.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-OpaqueExpressionAddLang.png Binary files differindex c69dd04d6a6..c69dd04d6a6 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-OpaqueExpressionAddLang.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-OpaqueExpressionAddLang.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-OpaqueExpressionEdit.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-OpaqueExpressionEdit.png Binary files differindex d6560ee0c1e..d6560ee0c1e 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-OpaqueExpressionEdit.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-OpaqueExpressionEdit.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-SpecViaPropertyView.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-SpecViaPropertyView.png Binary files differindex 44d41af47f9..44d41af47f9 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/PapyrusConstraint-SpecViaPropertyView.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/PapyrusConstraint-SpecViaPropertyView.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_ActorAndTypedElementWithTypeActor.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_ActorAndTypedElementWithTypeActor.png Binary files differindex 90ccc78680a..90ccc78680a 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_ActorAndTypedElementWithTypeActor.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_ActorAndTypedElementWithTypeActor.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_AddImageToStereotype.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_AddImageToStereotype.png Binary files differindex fd4fa2880c2..fd4fa2880c2 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_AddImageToStereotype.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_AddImageToStereotype.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_ApplyRegisteredProfile.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_ApplyRegisteredProfile.png Binary files differindex 542cc3945d0..542cc3945d0 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_ApplyRegisteredProfile.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_ApplyRegisteredProfile.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_ApplyTypeSymbolDefinitionStereotype.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_ApplyTypeSymbolDefinitionStereotype.png Binary files differindex 3648449a4af..3648449a4af 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_ApplyTypeSymbolDefinitionStereotype.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_ApplyTypeSymbolDefinitionStereotype.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_ApplyTypeSymbolDefinitionStereotypeDialog.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_ApplyTypeSymbolDefinitionStereotypeDialog.png Binary files differindex e056adb27c4..e056adb27c4 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_ApplyTypeSymbolDefinitionStereotypeDialog.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_ApplyTypeSymbolDefinitionStereotypeDialog.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_Compartment.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_Compartment.png Binary files differindex 87abab342b6..87abab342b6 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_Compartment.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_Compartment.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_CompartmentDialog.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_CompartmentDialog.png Binary files differindex 54c3e3f136a..54c3e3f136a 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_CompartmentDialog.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_CompartmentDialog.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_Decorator.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_Decorator.png Binary files differindex 29f79c29d04..29f79c29d04 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_Decorator.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_Decorator.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_DecoratorPropertyView.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_DecoratorPropertyView.png Binary files differindex a6e568960a6..a6e568960a6 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_DecoratorPropertyView.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_DecoratorPropertyView.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_Example.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_Example.png Binary files differindex 82b06fdb502..82b06fdb502 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_Example.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_Example.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_ProfileSelectionDialog.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_ProfileSelectionDialog.png Binary files differindex a4c2abfe353..a4c2abfe353 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_ProfileSelectionDialog.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_ProfileSelectionDialog.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_ProfileSelectionDialogAllSubProfile.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_ProfileSelectionDialogAllSubProfile.png Binary files differindex 40e9b841add..40e9b841add 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_ProfileSelectionDialogAllSubProfile.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_ProfileSelectionDialogAllSubProfile.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_TypeSymbolDefinition_SymbolPath.png b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_TypeSymbolDefinition_SymbolPath.png Binary files differindex d94cba91a91..d94cba91a91 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/Symbol_TypeSymbolDefinition_SymbolPath.png +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/images/Symbol_TypeSymbolDefinition_SymbolPath.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols-main-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols-main-toc.xml index 2db77f51781..4b9fd0124eb 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols-main-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols-main-toc.xml @@ -1,7 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?> <toc label="Symbols" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> - <topic href="resource/symbols.html" label="Symbols"> - <link toc="resource/symbols-toc.xml"/> + <topic href="target/generated-eclipse-help/symbols.html" label="Symbols"> + <link toc="target/generated-eclipse-help/symbols-toc.xml"/> <anchor id="UMLCommon"/> </topic> </toc> diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols-toc.xml deleted file mode 100644 index 9368f9a0d8a..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols-toc.xml +++ /dev/null @@ -1,14 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/symbols.html" label="symbols"> - <topic href="resource/symbols.html" label="Introduction"></topic> - <topic href="resource/symbols.html#Symbol_display_place_in_diagrams" label="Symbol display place in diagrams"> - <topic href="resource/symbols.html#Symbol_representation_in_compartments" label="Symbol representation in compartments"></topic> - <topic href="resource/symbols.html#Symbol_representation_as_a_decorator" label="Symbol representation as a decorator"></topic> - </topic> - <topic href="resource/symbols.html#Defining_symbols_in_models" label="Defining symbols in models"> - <topic href="resource/symbols.html#Define_new_symbols_in_profiles" label="Define new symbols in profiles"></topic> - <topic href="resource/symbols.html#Symbol_associated_to_Actor_UML_element" label="Symbol associated to Actor UML element"></topic> - <topic href="resource/symbols.html#Symbol_associated_to_Type_element" label="Symbol associated to Type element"></topic> - </topic> - <topic href="resource/symbols.html#FAQ" label="FAQ"></topic> -</toc>
\ No newline at end of file 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 deleted file mode 100644 index 49b57fdb171..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.common.doc/resource/symbols.html +++ /dev/null @@ -1,12 +0,0 @@ -<?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: </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 => 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> -=> This is a svg image contained in the plug-in {oep}.uml.diagram.common </p><pre>Images/logo.svg -</pre><p> -=> This is a svg image contained in an images/ folder next to my current model </p><pre>platform:/resource/my-project/images/logo.svg -</pre><p> -=> This is a svg image contained in the project “my-project”, in the current workspace </p><pre>file:/home/images/logo.svg -</pre><p> -=> This is an absolute filesystem URI </p><ul><li>(Developers) Can I implement my own policy for Symbol support?</li></ul><p>Yes. Papyrus relies on the Eclipse extension point framework to associate symbols with elements. It is possible for users to declare new extensions to provide their own symbol associations. See the extension point: org.eclipse.papyrus.infra.gmfdiag.common.shapeProvider for more information.</p></body></html>
\ No newline at end of file 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 c07d80b1d29..e3a289c9036 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 @@ -6,7 +6,7 @@ This short documentation will present the support for custom representations ava 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]]
+[[Image:images/Symbol_Example.png]]
= Symbol display place in diagrams =
@@ -16,7 +16,7 @@ There are 2 manners to display symbols on the diagrams, in compartments and as d 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
-[[Image:Symbol Compartment.png]]
+[[Image:images/Symbol_Compartment.png]]
To display/hide shape compartment:
@@ -33,11 +33,11 @@ To display/hide shape compartment: 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.
-[[Image:Symbol Decorator.png]]
+[[Image:images/Symbol_Decorator.png]]
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]]
+[[Image:images/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 => show Properties view.
</pre>
= Defining symbols in models =
@@ -50,7 +50,7 @@ UML offers the possiblity to associate new icons to stereotyped elements, via th On the property view of a Stereotype, you can associate an image to the stereotype
-[[Image:Symbol AddImageToStereotype.png]]
+[[Image:images/Symbol_AddImageToStereotype.png]]
This shape wil now be available on all elements that are stereotyped by this given Stereotype.
<pre>Hint: You can have more documentation about profiles in Papyrus on the website, users corner
@@ -59,7 +59,7 @@ This shape wil now be available on all elements that are stereotyped by this giv By default, Actors and TypedElement that are typed by an Actor have a stickman symbol associated.
-[[Image:Symbol ActorAndTypedElementWithTypeActor.png]]
+[[Image:images/Symbol_ActorAndTypedElementWithTypeActor.png]]
== Symbol associated to Type element ==
@@ -72,15 +72,15 @@ Steps: *Go to the profile Tab
*Select the icon for the registered profiles in the Applied Profile section
-[[Image:Symbol ApplyRegisteredProfile.png]]
+[[Image:images/Symbol_ApplyRegisteredProfile.png]]
*In the dialog, select the PapyrusInternal Profile
-[[Image:Symbol ProfileSelectionDialog.png]]
+[[Image:images/Symbol_ProfileSelectionDialog.png]]
*In the next dialog, select all profiles and subprofiles
-[[Image:Symbol ProfileSelectionDialogAllSubProfile.png]]
+[[Image:images/Symbol_ProfileSelectionDialogAllSubProfile.png]]
*OK
@@ -95,15 +95,15 @@ Steps: *Go to the profile Tab
*Apply the TypeSymbolDefinition stereotype (available on Type elements, as soon as the internal profile is applied on the model)
-[[Image:Symbol ApplyTypeSymbolDefinitionStereotype.png]]
+[[Image:images/Symbol_ApplyTypeSymbolDefinitionStereotype.png]]
-[[Image:Symbol ApplyTypeSymbolDefinitionStereotypeDialog.png]]
+[[Image:images/Symbol_ApplyTypeSymbolDefinitionStereotypeDialog.png]]
*Select the property symbolPath of the TypeSymbolDefinition stereotype.
*Set the path to the symbol file
-[[Image:Symbol TypeSymbolDefinition SymbolPath.png]]
+[[Image:images/Symbol_TypeSymbolDefinition_SymbolPath.png]]
= FAQ =
@@ -126,7 +126,7 @@ Paths can be expressed as Eclipse URIs (Either absolute or relative to the curre => This is a svg image contained in an images/ folder next to my current model
<pre>platform:/resource/my-project/images/logo.svg
</pre>
-=> This is a svg image contained in the project my-project, in the current workspace
+=> This is a svg image contained in the project �my-project�, in the current workspace
<pre>file:/home/images/logo.svg
</pre>
=> This is an absolute filesystem URI
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/build.properties b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/build.properties index 4887a1c42cb..3abab9716c1 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/build.properties @@ -1,5 +1,7 @@ bin.includes = META-INF/,\
about.html,\
resource/,\
- plugin.xml
-src.includes = about.html
+ plugin.xml,\
+ target/generated-eclipse-help/**
+src.includes = about.html,\
+ resource/
diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/plugin.xml index 23577ac4f75..c4880e8531f 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/plugin.xml @@ -4,35 +4,35 @@ <extension point="org.eclipse.help.toc"> <toc - file="resource/users/profile-main-toc.xml" + file="target/generated-eclipse-help/users/profile-main-toc.xml" primary="false"> </toc> <toc - file="resource/users/profile-toc.xml" + file="target/generated-eclipse-help/users/profile-toc.xml" primary="false"> </toc> <toc - file="resource/users/whatIsAUmlProfile-toc.xml" + file="target/generated-eclipse-help/users/whatIsAUmlProfile-toc.xml" primary="false"> </toc> <toc - file="resource/users/usingProfilesAndStereotypes-toc.xml" + file="target/generated-eclipse-help/users/usingProfilesAndStereotypes-toc.xml" primary="false"> </toc> <toc - file="resource/users/definingProfilesAndStereotypes-toc.xml" + file="target/generated-eclipse-help/users/definingProfilesAndStereotypes-toc.xml" primary="false"> </toc> <toc - file="resource/users/papyrusProfileArchitecture-toc.xml" + file="target/generated-eclipse-help/users/papyrusProfileArchitecture-toc.xml" primary="false"> </toc> <toc - file="resource/users/papyrusProfileLimitations-toc.xml" + file="target/generated-eclipse-help/users/papyrusProfileLimitations-toc.xml" primary="true"> </toc> <toc - file="resource/users/simplifiedUsageOfProfilesAndStereotypes-toc.xml" + file="target/generated-eclipse-help/users/simplifiedUsageOfProfilesAndStereotypes-toc.xml" primary="true"> </toc> </extension> diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/pom.xml index ad9849a3aaa..c4bcaf3199b 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/definingProfilesAndStereotypes-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/definingProfilesAndStereotypes-toc.xml deleted file mode 100644 index 804cd6ee7f5..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/definingProfilesAndStereotypes-toc.xml +++ /dev/null @@ -1,14 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/users/definingProfilesAndStereotypes.html" label="definingProfilesAndStereotypes"> - <topic href="resource/users/definingProfilesAndStereotypes.html" label="Defining Profiles and Stereotypes"> - <topic href="resource/users/definingProfilesAndStereotypes.html#Creating_a_Profile_Resource" label="Creating a Profile Resource"></topic> - <topic href="resource/users/definingProfilesAndStereotypes.html#Defining_a_Stereotype" label="Defining a Stereotype"> - <topic href="resource/users/definingProfilesAndStereotypes.html#Creating_a_Stereotype" label="Creating a Stereotype"></topic> - <topic href="resource/users/definingProfilesAndStereotypes.html#Importing_Metaclass" label="Importing Metaclass"></topic> - <topic href="resource/users/definingProfilesAndStereotypes.html#Linking_Stereotype_to_Metaclass_:_Extension_Creation" label="Linking Stereotype to Metaclass : Extension Creation"></topic> - </topic> - <topic href="resource/users/definingProfilesAndStereotypes.html#Creating_a_Subprofile" label="Creating a Subprofile"></topic> - <topic href="resource/users/definingProfilesAndStereotypes.html#Generalizing_Stereotype" label="Generalizing Stereotype"></topic> - <topic href="resource/users/definingProfilesAndStereotypes.html#Displaying_Stereotype_Options" label="Displaying Stereotype Options"></topic> - </topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/definingProfilesAndStereotypes.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/definingProfilesAndStereotypes.html deleted file mode 100644 index 49b34b4260e..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/definingProfilesAndStereotypes.html +++ /dev/null @@ -1,2 +0,0 @@ -<?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="Defining_Profiles_and_Stereotypes">Defining Profiles and Stereotypes</h1><p><b>Contents</b></p><ol style="list-style: none;"><li><a href="#Defining_Profiles_and_Stereotypes">Defining Profiles and Stereotypes</a><ol style="list-style: none;"><li><a href="#Creating_a_Profile_Resource">Creating a Profile Resource</a></li><li><a href="#Defining_a_Stereotype">Defining a Stereotype</a><ol style="list-style: none;"><li><a href="#Creating_a_Stereotype">Creating a Stereotype</a></li><li><a href="#Importing_Metaclass">Importing Metaclass</a></li><li><a href="#Linking_Stereotype_to_Metaclass_:_Extension_Creation">Linking Stereotype to Metaclass : Extension Creation</a></li></ol></li><li><a href="#Creating_a_Subprofile">Creating a Subprofile</a></li><li><a href="#Generalizing_Stereotype">Generalizing Stereotype</a></li><li><a href="#Displaying_Stereotype_Options">Displaying Stereotype Options</a></li></ol></li></ol><p>In UML, Stereotypes should be defined in a UML Profile. A UML Profile is a kind of uml::Package.</p><p>Papyrus allows to create Profiles and Sterotypes in any kind of models. But, if you want to define Profiles and Stereotypes in order to apply them to UML elements, <b>you need to define a Profile in a Papyrus profile resource (file)</b>.</p><p>Defining Stereotypes with Papyrus required the following:</p><ul><li>A <b>profile resource</b> - The resource (file) containing the profile (uml+di+notation files)</li><li>A <b>uml::Profile</b> - The uml element containing the Stereotypes</li><li>The <b>Stereotype</b> - The uml::Stereotype element defining the Stereotype</li></ul><h2 id="Creating_a_Profile_Resource">Creating a Profile Resource</h2><p>To create a new Profile, select File > New > Papyrus Project (Or Papyrus model, if you already have an opened project). When asked for a Diagram Language, Select "Profile":</p><p><img title="New Profile" alt="New Profile" border="0" src="images/newProfile.png"/><br/></p><p><img title="New Profile Diagram" alt="New Profile Diagram" border="0" src="images/newProfileDiagram.png"/><br/></p><p><img title="Profile Editor" alt="Profile Editor" border="0" src="images/profileEditor.png"/><br/></p><p>This creates a Resource containing a uml::Profile as root element.</p><h2 id="Defining_a_Stereotype">Defining a Stereotype</h2><p>Once a profile is created, it is now time to populate this latter with UML extensions, i.e. stereotypes, and their related concepts such as properties, extensions, and metaclasses.</p><h3 id="Creating_a_Stereotype">Creating a Stereotype</h3><p>A stereotype is created as any other UML model elements in Papyrus: select the related tool in the palette of the profile diagram editor, and then click in the place you want to create this element on the background of the diagram. If the palette is not open, just click on the small arrow on the upper right corner of the diagram editor. Papyrus will then ask you to provide a name. Once done, hit the return key and that all.</p><p><img title="Stereotype Palette" alt="Stereotype Palette" border="0" src="images/stereotypePalette.png"/><br/></p><p><img title="Stereotype Name" alt="Stereotype Name" border="0" src="images/stereotypeName.png"/><br/></p><h3 id="Importing_Metaclass">Importing Metaclass</h3><p>Once you have created a stereotype, you need to import the UML2 metaclasses you want to extend. First, you have to select the tool “Import Metaclass� within the palette of the profile diagram editor. Then, let’s click on the profile diagram where you want to drop the imported metaclass. A Papyrus dialog box is then opened in order to ask you to specify which metaclasses you want to import. Select the metaclasses in the left list and either drag and drop these latter in the right list or press the button with arrow directed from left to right and located between both aforementioned lists. Then, let’s press the button “ok� and it is done. The imported metaclasses are then shown in the diagram as illustrated.</p><p><img title="Import Metaclass" alt="Import Metaclass" border="0" src="images/importMetaclassDialog.png"/><br/></p><p><img title="Imported Metaclass" alt="Imported Metaclass" border="0" src="images/importedMetaclass.png"/><br/></p><p>Note: When you import UML2 metaclasses, Papyrus is creating ImportElement model element referent to the metaclasses of the UML2 metamodel itself. Those so-called specific model elements, the ImportElement, are indeed a kind of proxy to the model elements contained in another model, in the UML2 metamodel. If a metaclass has already be imported, you do not need to import it again to use it in another context. You can select the imported meta-class from the model browser and drag and drop this latter on the diagram you want to use it.</p><h3 id="Linking_Stereotype_to_Metaclass_:_Extension_Creation">Linking Stereotype to Metaclass : Extension Creation</h3><p>Once the stereotype is created and the meta-class is imported, you may then model the extension relation from the stereotype to the meta-class as shown in the following figure. The extension relationship is modeled using the extension tool in the profile diagram palette, <img title="Extension" alt="Extension" border="0" src="images/Extension.gif"/>. Within the diagram shown in next figure, both stereotypes «Requirement» and «Refinement» extend respectively both meta-classes Class and Dependency:</p><p><img title="Metaclass Extension" alt="Metaclass Extension" border="0" src="images/metaclassExtension.png"/><br/></p><h2 id="Creating_a_Subprofile">Creating a Subprofile</h2><p>Some profile may be complex due as for example to their scope that may be large. In order to cope with this complexity, it is then possible to decompose a profile into a hierarchy of subprofiles. A subprofile behaves such as a sub-package; it is a container of stereotypes.</p><p>To create a sub profile, select the profile tool in the profile diagram palette (<img title="Profile" alt="Profile" border="0" src="images/Profile.gif"/>) and then click on the profile diagram where you want to create your new profile.</p><p>In the example denoted below, we have created two sub-profiles of the SimplifiedReqML profile in order to gather in one hand the extensions that apply to node elements of the models and in the other hand the extension defined in the DSML for modeling relationships between those nodes:</p><p><img title="Sub Profiles" alt="Sub Profiles" border="0" src="images/subProfiles.png"/><br/></p><h2 id="Generalizing_Stereotype">Generalizing Stereotype</h2><p>When designing a profile, it is possible to reuse existing stereotypes defined in other existing profiles. Stereotypes can indeed be generalized enabling to create child stereotypes that inherit features of one or more generalized stereotype define either locally in the profile or externally other profiles.</p><p>To create a stereotype generalization using the profile diagram editor, let’s draw a generalization relationship using the tool <img title="Generalization" alt="Generalization" border="0" src="images/Generalization.gif"/> from the palette. As any relationship within Papyrus, you need to click first on the source and then on the target of the relationship you want to model.</p><p>In our example, there exists in the UML predefined profile a stereotype extending the dependency relationship in order to introduce the concept of refinement: «Refine». Consequently, we will redesign our sub-profile SRMLRelationship in order our stereotype «Refinement» to be a specialization of this UML stereotype instead of directly extending the UML dependency meta-class.</p><p>As previously mentioned, you may extend a stereotype defined in your profile or a stereotype defined in another external profile. In the latter case, the first thing to do is to import the profile where the stereotype has been defined, as denoted in the following example:</p><p><img title="Import Profile" alt="Import Profile" border="0" src="images/importProfile.png"/><br/></p><p><img title="Select Profile" alt="Select Profile" border="0" src="images/selectProfile.png"/><br/></p><p>Once the profile has been imported, you can select the stereotype you want to generalize from the imported profile (In the Model Explorer) and drop this latter in the diagram of profile description: </p><p><img title="Drop Stereotype" alt="Drop Stereotype" border="0" src="images/dropStereotype.png"/><br/></p><p>Now, let’s draw the generalization relationship from your stereotype (e.g., «Refinement» in the figure below) to the generalized stereotype (e.g., «Refine» in the figure below). </p><p><img title="Generalize Stereotype" alt="Generalize Stereotype" border="0" src="images/generalizeStereotype.png"/><br/></p><p>At this point, your diagram should look like something like the one shown here:</p><p><img title="Result Profile" alt="Result Profile" border="0" src="images/resultProfile.png"/><br/></p><h2 id="Displaying_Stereotype_Options">Displaying Stereotype Options</h2><p>When a stereotype application is shown in a diagram, the by-default way to show it within diagrams is using a string where the name of the stereotype is shown within a pair of French guillemets above or before the name of the model element. However, it is also possible to modify the graphical appearance of the annotated model element using icons. If the graphical representation of the model element is something like a box (including ellipse of the use cases), the icons can be displayed inside and on top of the figures, or it may replace this latter. In that latter case, the property of the element cannot be shown and the name of the model element appears within a label displayed near the icon. If the model element is graphically denoted by a line, the icon is shown in front of the name of the link.</p><p>In order to specify the icons you want to attach to a stereotype, select the stereotype and the tab UML of the property view. In the right-upper corner of the widget named “icons�, press the button <img title="Add" alt="Add" border="0" src="images/Add.gif"/> to add a new icon as shown in step 1. Once done, the dialog box shown at step 2 is open. Within this latter, let’s fill in a name and select an image file using the button <img title="Add" alt="Add" border="0" src="images/Add.gif"/> defining the content of the icon. Next, you have to define the kind value: icon or shape. Using this property, you can choose to associate the selected image either as an icon or as a shape.</p><p><img title="Step 1: Icons for Stereotypes" alt="Step 1: Icons for Stereotypes" border="0" src="images/iconsForStereotype.png"/><br/></p><p><img title="Step 2: Select Icon" alt="Step 2: Select Icon" border="0" src="images/selectIcon.png"/><br/></p><p>It is possible to associate only one shape to a stereotype, but you can associate different icons to a same stereotype. In that latter case, there is a description property that is used to select which one to display. By default, if no expression is defined, the first one is the list is chosen for displaying. The expression has to be on a property of the stereotype which type is an enumeration type. -In our example, we can set different icons to the stereotype «Requirement» depending on the value of its importance property. This latter is indeed typed by the ImportanceLevel enumeration which values may be High, Medium of Low (figure shown below). For this example, we will then associate the three following images <img title="High" alt="High" border="0" src="images/high.png"/>, <img title="Medium" alt="Medium" border="0" src="images/medium.png"/>, and <img title="Low" alt="Low" border="0" src="images/low.png"/>, to the stereotype «Requirement» and their related expression will be respectively importance=High (e.g. figure shown below), importance=Medium and importance=Low.</p><p><img title="Many Stereotype Icons" alt="Many Stereotype Icons" border="0" src="images/manyStereotypeIcons.png"/><br/></p><p><img title="Icon Kind" alt="Icon Kind" border="0" src="images/iconKind.png"/><br/></p><p><img title="Icon Expressions" alt="Icon Expressions" border="0" src="images/iconExpressions.png"/><br/></p><p><img title="High Req. Icon" alt="High Req. Icon" border="0" src="images/highReqIcon.png"/><br/></p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture-toc.xml deleted file mode 100644 index 3b127e17ba8..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture-toc.xml +++ /dev/null @@ -1,7 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/users/papyrusProfileArchitecture.html" label="papyrusProfileArchitecture"> - <topic href="resource/users/papyrusProfileArchitecture.html" label="Papyrus Profile Architecture"> - <topic href="resource/users/papyrusProfileArchitecture.html#Profile_and_Stereotype_Definitions_Architecture" label="Profile and Stereotype Definitions Architecture"></topic> - <topic href="resource/users/papyrusProfileArchitecture.html#Profile_and_Stereotype_applications_Architecture" label="Profile and Stereotype applications Architecture"></topic> - </topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture.html deleted file mode 100644 index 14e15bc6024..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileArchitecture.html +++ /dev/null @@ -1,2 +0,0 @@ -<?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="Papyrus_Profile_Architecture">Papyrus Profile Architecture</h1><p><b>Contents</b></p><ol style="list-style: none;"><li><a href="#Papyrus_Profile_Architecture">Papyrus Profile Architecture</a><ol style="list-style: none;"><li><a href="#Profile_and_Stereotype_Definitions_Architecture">Profile and Stereotype Definitions Architecture</a></li><li><a href="#Profile_and_Stereotype_applications_Architecture">Profile and Stereotype applications Architecture</a></li></ol></li></ol><p>This section describes the architecture used to define uml Profiles in Papyrus. </p><p>Papyrus Profiles and Stereotypes implementation is made of two different parts:</p><ul><li>The Profile and Stereotype <b>definitions</b> - This part is used to handle the stereotype and profile definitions.</li><li>The Profile and Stereotype <b>applications</b> - This part is used to apply an existing stereotype or profile to an UML element.</li></ul><h2 id="Profile_and_Stereotype_Definitions_Architecture">Profile and Stereotype Definitions Architecture</h2><p>Papyrus allows to create Profiles and Sterotypes in any kind of models. But, if you want to define Profiles and Stereotypes in order to apply them to UML elements, <b>you need to define a Profile in a 'Papyrus profile resource</b>' (i.e. a file).</p><p>The definitions of Profiles and Stereoptypes is made of two parts: the UML definitions, and the corresponding dynamic model. User define profiles and stereotypes in UML. The corresponding dynamic model is computed by Papyrus when the resource is saved.</p><p>UML definition of profile follows UML standard: Stereotypes must be defined in a uml::Profile.</p><p>The dynamic model is defined by Papyrus using the EMF/UML framework. This dynamic model is associated to a version number. The version number is incremented each time the dynamic model is re-created, so each time the profile resource is saved.</p><h2 id="Profile_and_Stereotype_applications_Architecture">Profile and Stereotype applications Architecture</h2><p>When Profile or a Stereotype is applied to an UML element, this create a Application object referencing both the uml element, and the profile or stereotype definition. -Thus, an uml element is not directly linked to an Application object.</p><p>Application objects are normally stored in the resource file containing the uml element they reference. They are not stored inside the UML model. Rather, they are stored alongside of the uml model. </p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations-toc.xml deleted file mode 100644 index 79f8866b7fa..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations-toc.xml +++ /dev/null @@ -1,6 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/users/papyrusProfileLimitations.html" label="papyrusProfileLimitations"> - <topic href="resource/users/papyrusProfileLimitations.html" label="Papyrus Profile Limitations"> - <topic href="resource/users/papyrusProfileLimitations.html#Cyclic_Profile_Definitions" label="Cyclic Profile Definitions"></topic> - </topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations.html deleted file mode 100644 index 78688f35ac2..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/papyrusProfileLimitations.html +++ /dev/null @@ -1 +0,0 @@ -<?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="Papyrus_Profile_Limitations">Papyrus Profile Limitations</h1><p><b>Contents</b></p><ol style="list-style: none;"><li><a href="#Papyrus_Profile_Limitations">Papyrus Profile Limitations</a><ol style="list-style: none;"><li><a href="#Cyclic_Profile_Definitions">Cyclic Profile Definitions</a></li></ol></li></ol><h2 id="Cyclic_Profile_Definitions">Cyclic Profile Definitions</h2><p>Due to the way the Dynamic ECore model is built, Papyrus does not support Definition of Profiles with cyclic references.</p><p>See <a href="/wiki/https://bugs.eclipse.org/bugs/show_bug.cgi?id=451613" title="https://bugs.eclipse.org/bugs/show_bug.cgi?id=451613">Bug 451613</a>: ClassCastException when updating hierarchical profile with datatype</p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml index cbcc0662ee4..a9cc04d1492 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml @@ -2,13 +2,13 @@ <toc label="Papyrus Profiles" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> <topic label="Using UML Profiles"> <anchor id="profiles-start"/> - <link toc="resource/users/whatIsAUmlProfile-toc.xml"/> - <link toc="resource/users/papyrusProfileArchitecture-toc.xml" /> - <link toc="resource/users/definingProfilesAndStereotypes-toc.xml" /> - <link toc="resource/users/usingProfilesAndStereotypes-toc.xml" /> - <link toc="resource/users/simplifiedUsageOfProfilesAndStereotypes-toc.xml" /> + <link toc="target/generated-eclipse-help/users/whatIsAUmlProfile-toc.xml"/> + <link toc="target/generated-eclipse-help/users/papyrusProfileArchitecture-toc.xml" /> + <link toc="target/generated-eclipse-help/users/definingProfilesAndStereotypes-toc.xml" /> + <link toc="target/generated-eclipse-help/users/usingProfilesAndStereotypes-toc.xml" /> + <link toc="target/generated-eclipse-help/users/simplifiedUsageOfProfilesAndStereotypes-toc.xml" /> <anchor id="profiles" /> - <link toc="resource/users/papyrusProfileLimitations-toc.xml" /> + <link toc="target/generated-eclipse-help/users/papyrusProfileLimitations-toc.xml" /> <anchor id="profiles-end" /> </topic> diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-toc.xml deleted file mode 100644 index e46a2c21144..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-toc.xml +++ /dev/null @@ -1,24 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/profile.html" label="profile"> - <topic href="resource/profile.html" label="Introduction"></topic> - <topic href="resource/profile.html#Profile_Creation_and_Modeling" label="Profile Creation and Modeling"> - <topic href="resource/profile.html#Profile_Creation" label="Profile Creation"></topic> - <topic href="resource/profile.html#Stereotype_Definition" label="Stereotype Definition"> - <topic href="resource/profile.html#Stereotype_Creation" label="Stereotype Creation"></topic> - <topic href="resource/profile.html#Metaclass_Import" label="Metaclass Import"></topic> - <topic href="resource/profile.html#Extension_Creation" label="Extension Creation"></topic> - <topic href="resource/profile.html#Subprofile_Creation" label="Subprofile Creation"></topic> - <topic href="resource/profile.html#Stereotype_Generalization" label="Stereotype Generalization"></topic> - </topic> - <topic href="resource/profile.html#Stereotype_display_options" label="Stereotype display options"></topic> - </topic> - <topic href="resource/profile.html#Profile_Definition_and_Export" label="Profile Definition and Export"></topic> - <topic href="resource/profile.html#Profile_Application_and_Usage" label="Profile Application and Usage"> - <topic href="resource/profile.html#Applying_a_Profile" label="Applying a Profile"></topic> - <topic href="resource/profile.html#Using_the_Stereotypes_of_a_Profile" label="Using the Stereotypes of a Profile"> - <topic href="resource/profile.html#Applying_a_Stereotype" label="Applying a Stereotype"></topic> - <topic href="resource/profile.html#Assigning_values_to_properties_of_stereotypes" label="Assigning values to properties of stereotypes"></topic> - <topic href="resource/profile.html#Display_options_of_a_stereotype_application" label="Display options of a stereotype application"></topic> - </topic> - </topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile.html deleted file mode 100644 index d20358f0f02..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile.html +++ /dev/null @@ -1,3 +0,0 @@ -<?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="Introduction">Introduction</h1><p>The purpose of this chapter is to provide the Papyrus users all the documentation needed in order to be able to use UML profiles. It includes the information for modeling and defining a profile using the Papyrus UML profile editor, but also the information for the usage of a profile within a user application model.</p><p>The basic premise of profiles is that all domain-specific concepts are derived as extensions or refinements of existing UML concepts, called UML metaclasses. These extensions are called stereotypes. A stereotype definition must be consistent with the abstract syntax and semantics of standard UML meta-classes it extends. Consequently, a profile-based model can be created and manipulated by any tool that supports standard UML. Moreover, because the concepts underlying a profile are specializations of existing UML concepts, it is more easily learned by anyone with knowledge of UML.</p><p>A stereotype is defined either as an extension of a UML base metaclass or as a specialization of an existing stereotype. The extension relationship of UML is not an association but a kind of association directed from the stereotype to the extended metaclass. Consequently, the metadata conveyed by the associated the attributes of the stereotype are associated to the extended metaclass in a transparent manner for the metaclass itself. This allows profiles owning the stereotypes to be applied and removed dynamically without modifying the underlying models — a fundamental feature of the profile mechanism.</p><p>A stereotype may have attributes and may be associated with other stereotypes or existing UML metaclasses.</p><p>Constraints, such as OCL constraints, can also be defined in a profile. They can apply to stereotypes defined in the profile or those imported by the profile. They can also be used to further constrain elements of the UML metamodel. For instance, one could define an OCL constraint that all instances of Class in a model are active, or that all instances of Class must have at least one Operation (regardless of whether the Class is extended by a stereotype or not). However, not all constraints can be written in OCL. In that case, it is common to denote those latter in natural language. The drawback is that such constraints are no more automatically interpretable and need to be first rewritten in some language the UML tool will understand. In the context of Papyrus, it is then usual to use Java.</p><h1 id="Profile_Creation_and_Modeling">Profile Creation and Modeling</h1><h2 id="Profile_Creation">Profile Creation</h2><p>To create a new Profile, select File > New > Papyrus Project (Or Papyrus model, if you already have an opened project). When asked for a Diagram Language, Select "Profile":</p><p><img title="New Profile" alt="New Profile" border="0" src="images/newProfile.png"/><br/></p><p><img title="New Profile Diagram" alt="New Profile Diagram" border="0" src="images/newProfileDiagram.png"/><br/></p><p><img title="Profile Editor" alt="Profile Editor" border="0" src="images/profileEditor.png"/><br/></p><h2 id="Stereotype_Definition">Stereotype Definition</h2><p>Once a profile has been created, it is now time to populate this latter with UML extensions, i.e. stereotypes, and their related concepts such as properties, extensions, and metaclasses.</p><h3 id="Stereotype_Creation">Stereotype Creation</h3><p>A stereotype is created as any other UML model elements in Papyrus: select the related tool in the palette of the profile diagram editor, and then click in the place you want to create this element on the background of the diagram. If the palette is not open, just click on the small arrow on the upper right corner of the diagram editor. Papyrus will then ask you to provide a name. Once done, hit the return key and that all.</p><p><img title="Stereotype Palette" alt="Stereotype Palette" border="0" src="images/stereotypePalette.png"/><br/></p><p><img title="Stereotype Name" alt="Stereotype Name" border="0" src="images/stereotypeName.png"/><br/></p><h3 id="Metaclass_Import">Metaclass Import</h3><p>Once you have created a stereotype, you need to import the UML2 metaclasses you want to extend. First, you have to select the tool “Import Metaclass” within the palette of the profile diagram editor. Then, let’s click on the profile diagram where you want to drop the imported metaclass. A Papyrus dialog box is then opened in order to ask you to specify which metaclasses you want to import. Select the metaclasses in the left list and either drag and drop these latter in the right list or press the button with arrow directed from left to right and located between both aforementioned lists. Then, let’s press the button “ok” and it is done. The imported metaclasses are then shown in the diagram as illustrated.</p><p><img title="Import Metaclass" alt="Import Metaclass" border="0" src="images/importMetaclassDialog.png"/><br/></p><p><img title="Imported Metaclass" alt="Imported Metaclass" border="0" src="images/importedMetaclass.png"/><br/></p><p>Note: When you import UML2 metaclasses, Papyrus is creating ImportElement model element referent to the metaclasses of the UML2 metamodel itself. Those so-called specific model elements, the ImportElement, are indeed a kind of proxy to the model elements contained in another model, in the UML2 metamodel. If a metaclass has already be imported, you do not need to import it again to use it in another context. You can select the imported meta-class from the model browser and drag and drop this latter on the diagram you want to use it.</p><h3 id="Extension_Creation">Extension Creation</h3><p>Once the stereotype is created and the meta-class is imported, you may then model the extension relation from the stereotype to the meta-class as shown in the following figure. The extension relationship is modeled using the extension tool in the profile diagram palette, <img title="Extension" alt="Extension" border="0" src="images/Extension.gif"/>. Within the diagram shown in next figure, both stereotypes «Requirement» and «Refinement» extend respectively both meta-classes Class and Dependency:</p><p><img title="Metaclass Extension" alt="Metaclass Extension" border="0" src="images/metaclassExtension.png"/><br/></p><h3 id="Subprofile_Creation">Subprofile Creation</h3><p>Some profile may be complex due as for example to their scope that may be large. In order to cope with this complexity, it is then possible to decompose a profile into a hierarchy of subprofiles. A subprofile behaves such as a sub-package; it is a container of stereotypes.</p><p>To create a sub profile, select the profile tool in the profile diagram palette (<img title="Profile" alt="Profile" border="0" src="images/Profile.gif"/>) and then click on the profile diagram where you want to create your new profile.</p><p>In the example denoted below, we have created two sub-profiles of the SimplifiedReqML profile in order to gather in one hand the extensions that apply to node elements of the models and in the other hand the extension defined in the DSML for modeling relationships between those nodes:</p><p><img title="Sub Profiles" alt="Sub Profiles" border="0" src="images/subProfiles.png"/><br/></p><h3 id="Stereotype_Generalization">Stereotype Generalization</h3><p>When designing a profile, it is possible to reuse existing stereotypes defined in other existing profiles. Stereotypes can indeed be generalized enabling to create child stereotypes that inherit features of one or more generalized stereotype define either locally in the profile or externally other profiles.</p><p>To create a stereotype generalization using the profile diagram editor, let’s draw a generalization relationship using the tool <img title="Generalization" alt="Generalization" border="0" src="images/Generalization.gif"/> from the palette. As any relationship within Papyrus, you need to click first on the source and then on the target of the relationship you want to model.</p><p>In our example, there exists in the UML predefined profile a stereotype extending the dependency relationship in order to introduce the concept of refinement: «Refine». Consequently, we will redesign our sub-profile SRMLRelationship in order our stereotype «Refinement» to be a specialization of this UML stereotype instead of directly extending the UML dependency meta-class.</p><p>As previously mentioned, you may extend a stereotype defined in your profile or a stereotype defined in another external profile. In the latter case, the first thing to do is to import the profile where the stereotype has been defined, as denoted in the following example:</p><p><img title="Import Profile" alt="Import Profile" border="0" src="images/importProfile.png"/><br/></p><p><img title="Select Profile" alt="Select Profile" border="0" src="images/selectProfile.png"/><br/></p><p>Once the profile has been imported, you can select the stereotype you want to generalize from the imported profile (In the Model Explorer) and drop this latter in the diagram of profile description: </p><p><img title="Drop Stereotype" alt="Drop Stereotype" border="0" src="images/dropStereotype.png"/><br/></p><p>Now, let’s draw the generalization relationship from your stereotype (e.g., «Refinement» in the figure below) to the generalized stereotype (e.g., «Refine» in the figure below). </p><p><img title="Generalize Stereotype" alt="Generalize Stereotype" border="0" src="images/generalizeStereotype.png"/><br/></p><p>At this point, your diagram should look like something like the one shown here:</p><p><img title="Result Profile" alt="Result Profile" border="0" src="images/resultProfile.png"/><br/></p><h2 id="Stereotype_display_options">Stereotype display options</h2><p>When a stereotype application is shown in a diagram, the by-default way to show it within diagrams is using a string where the name of the stereotype is shown within a pair of French guillemets above or before the name of the model element. However, it is also possible to modify the graphical appearance of the annotated model element using icons. If the graphical representation of the model element is something like a box (including ellipse of the use cases), the icons can be displayed inside and on top of the figures, or it may replace this latter. In that latter case, the property of the element cannot be shown and the name of the model element appears within a label displayed near the icon. If the model element is graphically denoted by a line, the icon is shown in front of the name of the link.</p><p>In order to specify the icons you want to attach to a stereotype, select the stereotype and the tab UML of the property view. In the right-upper corner of the widget named “icons”, press the button <img title="Add" alt="Add" border="0" src="images/Add.gif"/> to add a new icon as shown in step 1. Once done, the dialog box shown at step 2 is open. Within this latter, let’s fill in a name and select an image file using the button <img title="Add" alt="Add" border="0" src="images/Add.gif"/> defining the content of the icon. Next, you have to define the kind value: icon or shape. Using this property, you can choose to associate the selected image either as an icon or as a shape.</p><p><img title="Step 1: Icons for Stereotypes" alt="Step 1: Icons for Stereotypes" border="0" src="images/iconsForStereotype.png"/><br/></p><p><img title="Step 2: Select Icon" alt="Step 2: Select Icon" border="0" src="images/selectIcon.png"/><br/></p><p>It is possible to associate only one shape to a stereotype, but you can associate different icons to a same stereotype. In that latter case, there is a description property that is used to select which one to display. By default, if no expression is defined, the first one is the list is chosen for displaying. The expression has to be on a property of the stereotype which type is an enumeration type. -In our example, we can set different icons to the stereotype «Requirement» depending on the value of its importance property. This latter is indeed typed by the ImportanceLevel enumeration which values may be High, Medium of Low (figure shown below). For this example, we will then associate the three following images <img title="High" alt="High" border="0" src="images/high.png"/>, <img title="Medium" alt="Medium" border="0" src="images/medium.png"/>, and <img title="Low" alt="Low" border="0" src="images/low.png"/>, to the stereotype «Requirement» and their related expression will be respectively importance=High (e.g. figure shown below), importance=Medium and importance=Low.</p><p><img title="Many Stereotype Icons" alt="Many Stereotype Icons" border="0" src="images/manyStereotypeIcons.png"/><br/></p><p><img title="Icon Kind" alt="Icon Kind" border="0" src="images/iconKind.png"/><br/></p><p><img title="Icon Expressions" alt="Icon Expressions" border="0" src="images/iconExpressions.png"/><br/></p><p><img title="High Req. Icon" alt="High Req. Icon" border="0" src="images/highReqIcon.png"/><br/></p><h1 id="Profile_Definition_and_Export">Profile Definition and Export</h1><p>Once a profile has been modeled, we need to define it before being able to apply it on user models. The definition of a profile consists in:</p><p><i>“When defining a dynamic profile representation, the contents of a profile are converted to an equivalent Ecore format that is stored as an annotation on the profile. Then, when a profile and its stereotypes are applied to a model and its elements, dynamic EMF (see the EMF book for details) is used to store property values for the stereotypes. For the most part, you can ignore this complexity, as long as you remember to define your profile before using it.”</i></p><p>(This definition has been extracted from <a href="/wiki/http://wiki.eclipse.org/MDT/UML2/Introduction_to_UML2_Profiles" title="http://wiki.eclipse.org/MDT/UML2/Introduction_to_UML2_Profiles">http://wiki.eclipse.org/MDT/UML2/Introduction_to_UML2_Profiles</a>)</p><p><i>PS: The implementation of profile support in the UML2 component of MDT supports defining both dynamic and static profile representations. In this the document, we will focus on dynamic profiles.</i></p><p>To define a profile within Papyrus, you just need to save it doing as for example following actions: either through the menu bar action File > Save or using the key shortcut “CTRL S”. -Let’s notice, that it is not mandatory to define a profile each time you save it. If you do not want to define your profile when saving it, just answer no to the related question asked by Papyrus when saving profile modifications. However, if you want to apply the modifications you have done on a given profile, this you have to define it again in order the modifications may be taken into account at the user model level.</p><p><img title="Profile Definition" alt="Profile Definition" border="0" src="images/profileDefinition1.png"/><br/></p><p><img title="Profile Definition" alt="Profile Definition" border="0" src="images/profileDefinition2.png"/><br/></p><p>Note: If the profile contains errors (Such as an untyped Property or unnamed Stereotype), you won't be able to define it. However, it can still be saved. In such a case, a Diagnostic dialog displays all the validation errors preventing the profile from being defined.</p><p><img title="Profile Definition Errors" alt="Profile Definition Errors" border="0" src="images/profileDefinitionErrors.png"/><br/></p><h1 id="Profile_Application_and_Usage">Profile Application and Usage</h1><p>Once a profile has been designed and defined as previously explained, it now times to use it. The first step to process is to apply the profile on your model or a part of the model. This is the purpose of the next section to explain this first step. Then, we will explain how to use the applied profile and mainly how to use its extensions, i.e. its stereotypes.</p><h2 id="Applying_a_Profile">Applying a Profile</h2><p>To apply a profile, first you need to open your model.</p><p>The first step consists in selecting the part of the model you want to apply the profile on. Profiles can be applied either on Models or Packages. Then to apply the profile on this part, let’s select the profile tab in the property view, and press the <img title="Apply Profile" alt="Apply Profile" border="0" src="images/Add.gif"/> button.</p><p><img title="Select Package" alt="Select Package" border="0" src="images/applyProfile.png"/><br/></p><p><img title="Profile Tab" alt="Profile Tab" border="0" src="images/applyProfile2.png"/><br/></p><p><img title="Apply Profile" alt="Apply Profile" border="0" src="images/applyProfile3.png"/><br/></p><p>Then, Papyrus will ask you firstly to choose the profile to apply from your workspace, and secondly to choose which part of the selected profile you want to apply. It is indeed possible that your profile may be composed of sub-profiles as explained in the previous chapter. It is then possible to apply partially a profile by applying one or more of its sub-profiles.</p><p><img title="Select Profile" alt="Select Profile" border="0" src="images/selectProfileModel.png"/><br/></p><p><img title="Select Profiles" alt="Select Profiles" border="0" src="images/selectProfiles.png"/><br/></p><p>Your model should now look like this:</p><p><img title="Applied Profiles" alt="Applied Profiles" border="0" src="images/appliedProfiles.png"/><br/></p><h2 id="Using_the_Stereotypes_of_a_Profile">Using the Stereotypes of a Profile</h2><p>Once the profile is applied on you model, its extensions, i.e. stereotypes, are available in the modeling tool and can be used in your model to annotate it.</p><h3 id="Applying_a_Stereotype">Applying a Stereotype</h3><p>To annotate a model element, you first need to select it either through the model explorer or in one open diagram. Then, select the tab named “profile” in the properties view, and add your stereotype using the <img title="Apply Profile" alt="Apply Profile" border="0" src="images/Add.gif"/> button of the widget named “Applied stereotypes”</p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype.png"/><br/></p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype2.png"/><br/></p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype3.png"/><br/></p><p>A dialog box enables you to select the stereotype(s) you want to apply (left part of the dialog box) and using the <img title="Add" alt="Add" border="0" src="images/arrow_right.gif"/> button located in the middle of the dialog box enables to define which stereotypes have to be applied. The list located on the right of the dialog box denotes the list of applied stereotype. If you want to unapply stereotypes, you can select those latter from the right list and use the <img title="Remove" alt="Remove" border="0" src="images/arrow_left.gif"/> button to unapply them.</p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype4.png"/><br/></p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype5.png"/><br/></p><p>At this point, your Papyrus should look like this:</p><p><img title="Applied Stereotype" alt="Applied Stereotype" border="0" src="images/appliedStereotype.png"/><br/></p><h3 id="Assigning_values_to_properties_of_stereotypes">Assigning values to properties of stereotypes</h3><p>As already mentioned, Stereotypes may have properties. Consequently, when applying a stereotype to a model element, it may be necessary to set the values of those properties. For that, you will go to the profile tab of the properties view and then you can unfold the stereotype application as shown in following figure:</p><p><img title="Stereotype Properties" alt="Stereotype Properties" border="0" src="images/stereotypeProperties.png"/><br/></p><p>Once you have selected the property to edit, its value (if already set, as for example if there is a default value defined in the profile for the property) appear in the right part of the property view. If the property has not yet been valued, you can add a value by using the <img title="Add" alt="Add" border="0" src="images/add.gif"/> button located on the top right of the widget named “Properties values”. If there is a value, double-click on the value to edit this latter.</p><p><img title="Edit Property" alt="Edit Property" border="0" src="images/stereotypePropertyEdition.png"/><br/></p><p>Ps: If you want to delete a value set to property, let’s use the <img title="Delete" alt="Delete" border="0" src="images/Delete.gif"/> button located on the top right of the widget named “Properties values”.</p><h3 id="Display_options_of_a_stereotype_application">Display options of a stereotype application</h3><p>Stereotype applications may be graphically rendered under different forms, either textually, or using specific icons. Details to specify those icons associated to a stereotype are given in previous chapters (See <a href="#Stereotype_display_options">Stereotype display options</a>).</p><p>Let’s remind that in UML, you can apply several stereotypes on a same model element. In Papyrus, it is then possible to select the ones you want to show for each diagram. For showing or hiding a stereotype application, you have to select the tab “appearance” in the properties view. As shown in the next figure, there is one widget named “Applied stereotypes” that denotes the list of stereotypes applied on the current selected model element. On the example illustrated within this figure, you can see on the upper corner of the icon placed in front of the stereotype name “Requirement” an overlay denoting that this stereotype application is shown.</p><p><img title="Stereotype Display" alt="Stereotype Display" border="0" src="images/stereotypeDisplayOptions.png"/><br/></p><p><i>Warning: Let’s notice that the appearance tab of the property view is only visible if you select a model element from one of the open diagram. In other case, if you select the model element from the model explorer, the concept of graphical does not make sense because the information specified within this view are only related to graphical information.</i></p><p><i>Consequently, the values set to the appearance properties of model element are valid only in the context of the diagram where the element is selected. It is then possible to show a stereotype on a diagram and hide it in another diagram depending on the concerns of the view realized by the diagram.</i></p><p>To hide or show stereotype applications, you have to select them from the list of applied stereotypes available within the appearance tab and then either press the <img title="Display qualified name" alt="Display qualified name" border="0" src="images/ConsoleViewQN.gif"/> button or <img title="Display" alt="Display" border="0" src="images/change_display.gif"/>.</p><p>The former is to be used if you want to display the stereotype application with its qualified name, and the latter is to be used if you want to show it without qualified name. Using one of both depends if you may have ambiguities or not on the origin of the stereotype when as for example applying several profiles defining similar stereotypes. As for example, both profiles, MARTE and SysML, define a stereotype named «FlowPort».</p><p>In addition, there are three other widgets dedicated to configure the stereotype display options:</p><ul><li>“Stereotype display” is an enumeration which values may be Text, Icon, Text and Icon or Shape. In UML, as explained previously, a stereotype may be denoted either as a string between a pair of French guillemets (e.g., «Requirement»), or as an icon embedded in the figure or as a shape with a label. In case of the shape option, it substitutes the normal graphical figure used to represent the element and its label denotes the name of the element.</li></ul><ul><li>“Text alignment” is an enumeration which values may be Horizontal or Vertical. When several applied stereotypes are shown, it is rendered as a list of string separated by a comma and enclosed between a pair of French guillemets. By default, this string is shown horizontally. But some times for aesthetic reasons, it may be useful to show it vertically, that is to say showing one stereotype per line.</li></ul><ul><li>“Display place” is an enumeration which values may be Compartment, Comment or With brace. This appearance property is used to set where to show the properties values of the applied stereotypes. In UML, those values can be shown either within a pair of braces located just near (above or on top) the name label of the model element (“With brace” option), or into a dedicated compartment, or in a text note associated with the annotated model element.</li></ul><p><i>PS: if you display several stereotype applications, and if you select the options to display them with icon or with icon and text, this is the icon of the first stereotype application in the list which is chosen to be displayed.</i></p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes-toc.xml deleted file mode 100644 index a75bb434755..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes-toc.xml +++ /dev/null @@ -1,7 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/users/simplifiedUsageOfProfilesAndStereotypes.html" label="simplifiedUsageOfProfilesAndStereotypes"> - <topic href="resource/users/simplifiedUsageOfProfilesAndStereotypes.html" label="Simplified Usage of Profiles and Stereotypes"> - <topic href="resource/users/simplifiedUsageOfProfilesAndStereotypes.html#Creating_Profile_and_Stereotype" label="Creating Profile and Stereotype"></topic> - <topic href="resource/users/simplifiedUsageOfProfilesAndStereotypes.html#Updating_Stereotype" label="Updating Stereotype"></topic> - </topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes.html deleted file mode 100644 index 5f224fb02d7..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/simplifiedUsageOfProfilesAndStereotypes.html +++ /dev/null @@ -1,6 +0,0 @@ -<?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="Simplified_Usage_of_Profiles_and_Stereotypes">Simplified Usage of Profiles and Stereotypes</h1><p><b>Contents</b></p><ol style="list-style: none;"><li><a href="#Simplified_Usage_of_Profiles_and_Stereotypes">Simplified Usage of Profiles and Stereotypes</a><ol style="list-style: none;"><li><a href="#Creating_Profile_and_Stereotype">Creating Profile and Stereotype</a></li><li><a href="#Updating_Stereotype">Updating Stereotype</a></li></ol></li></ol><p>Papyrus provides a simplified way to create, apply and modify Profiles and Stereotypes. -We call it 'simplified' comparatively to the way where one should first define Profile and Stereotypes, then apply the Profile, and finally apply and modify the Stereotype.</p><p>The simplified usage propose one single Dialog used to create a Profile and a Stereotype, then apply both to the selected element, and all in no more than two clicks ! -Also, the same Dialog can be used to update the Stereotype definition, or the application values.</p><h2 id="Creating_Profile_and_Stereotype">Creating Profile and Stereotype</h2><p>Select the UML element to apply the profile, right click -> Profile -> Update Profile ...<br/> -The following Dialog appears:</p><p><img title="Profile Easy Usage Dialog" alt="Profile Easy Usage Dialog" border="0" src="images/profile-DialogExplained.png"/><br/></p><p>In <b>Qualified Name</b>, type the Profile name and the Stereotype name separated by '::'.</p><p>The <b>metaclass</b> should already be selected, based on the metaclass of the currently selected UML element. You can add metaclasses if you whish.</p><p>In <b>Properties</b>, add properties to your profile: click '+', then set the name, select a type, and set a value.</p><p>Clicking '<b>OK</b>' will do the following:</p><ul><li><b>Create the Profile</b> if needed</li><li><b>Create the Stereotype</b> if needed</li><li><b>Create new properties</b></li><li><b>Apply the Profile</b>, if needed, to the uml::Package containing the selected uml element.</li><li><b>Apply the Stereotype</b>, if needed, to the selected uml element.</li><li><b>Set values to the applied stereotype</b>, if some values are set to the properties.</li></ul><h2 id="Updating_Stereotype">Updating Stereotype</h2><p>Select the UML element applying the profile to update, right click -> Profile -> Update Profile ...<br/> -In <b>Qualified Name</b>, type the beginning of the name of the Stereotype to update. The Content Assist should propose Stereotypes matching your input. Select your Stereotype. -The Dialog should show the actual values of the Stereotype. You can change the Properties and their values.</p><p>If you change the name of the Stereotype or the Profile, this will create a new Stereotype.</p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/usingProfilesAndStereotypes-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/usingProfilesAndStereotypes-toc.xml deleted file mode 100644 index 5211d50f0ad..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/usingProfilesAndStereotypes-toc.xml +++ /dev/null @@ -1,9 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/users/usingProfilesAndStereotypes.html" label="usingProfilesAndStereotypes"> - <topic href="resource/users/usingProfilesAndStereotypes.html" label="Using Profiles and Stereotypes"> - <topic href="resource/users/usingProfilesAndStereotypes.html#Applying_a_Profile" label="Applying a Profile"></topic> - <topic href="resource/users/usingProfilesAndStereotypes.html#Applying_a_Stereotype" label="Applying a Stereotype"></topic> - <topic href="resource/users/usingProfilesAndStereotypes.html#Setting_values_to_stereotype.27_properties" label="Setting values to stereotype' properties"></topic> - <topic href="resource/users/usingProfilesAndStereotypes.html#Display_options_of_a_stereotype_application" label="Display options of a stereotype application"></topic> - </topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/usingProfilesAndStereotypes.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/usingProfilesAndStereotypes.html deleted file mode 100644 index edef6cdb52d..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/usingProfilesAndStereotypes.html +++ /dev/null @@ -1 +0,0 @@ -<?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_Profiles_and_Stereotypes">Using Profiles and Stereotypes</h1><p><b>Contents</b></p><ol style="list-style: none;"><li><a href="#Using_Profiles_and_Stereotypes">Using Profiles and Stereotypes</a><ol style="list-style: none;"><li><a href="#Applying_a_Profile">Applying a Profile</a></li><li><a href="#Applying_a_Stereotype">Applying a Stereotype</a></li><li><a href="#Setting_values_to_stereotype.27_properties">Setting values to stereotype' properties</a></li><li><a href="#Display_options_of_a_stereotype_application">Display options of a stereotype application</a></li></ol></li></ol><p>Once a profile has been designed and defined as previously explained, it now times to use it. The first step to process is to apply the profile on your model or a part of the model. This is the purpose of the next section to explain this first step. Then, we will explain how to use the applied profile and mainly how to use its extensions, i.e. its stereotypes.</p><h2 id="Applying_a_Profile">Applying a Profile</h2><p>To apply a profile, first you need to open your model.</p><p>The first step consists in selecting the part of the model you want to apply the profile on. Profiles can be applied either on Models or Packages. Then to apply the profile on this part, let’s select the profile tab in the property view, and press the <img title="Apply Profile" alt="Apply Profile" border="0" src="images/Add.gif"/> button.</p><p><img title="Select Package" alt="Select Package" border="0" src="images/applyProfile.png"/><br/></p><p><img title="Profile Tab" alt="Profile Tab" border="0" src="images/applyProfile2.png"/><br/></p><p><img title="Apply Profile" alt="Apply Profile" border="0" src="images/applyProfile3.png"/><br/></p><p>Then, Papyrus will ask you firstly to choose the profile to apply from your workspace, and secondly to choose which part of the selected profile you want to apply. It is indeed possible that your profile may be composed of sub-profiles as explained in the previous chapter. It is then possible to apply partially a profile by applying one or more of its sub-profiles.</p><p><img title="Select Profile" alt="Select Profile" border="0" src="images/selectProfileModel.png"/><br/></p><p><img title="Select Profiles" alt="Select Profiles" border="0" src="images/selectProfiles.png"/><br/></p><p>Your model should now look like this:</p><p><img title="Applied Profiles" alt="Applied Profiles" border="0" src="images/appliedProfiles.png"/><br/></p><h2 id="Applying_a_Stereotype">Applying a Stereotype</h2><p>Once the profile is applied on your model, its extensions, i.e. stereotypes, are available in the modeling tool and can be used in your model to annotate uml elements.</p><p>To annotate a model element, you first need to select it either through the model explorer or in one open diagram. Then, select the tab named “profile” in the properties view, and add your stereotype using the <img title="Apply Profile" alt="Apply Profile" border="0" src="images/Add.gif"/> button of the widget named “Applied stereotypes”</p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype.png"/><br/></p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype2.png"/><br/></p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype3.png"/><br/></p><p>A dialog box enables you to select the stereotype(s) you want to apply (left part of the dialog box) and using the <img title="Add" alt="Add" border="0" src="images/arrow_right.gif"/> button located in the middle of the dialog box enables to define which stereotypes have to be applied. The list located on the right of the dialog box denotes the list of applied stereotype. If you want to unapply stereotypes, you can select those latter from the right list and use the <img title="Remove" alt="Remove" border="0" src="images/arrow_left.gif"/> button to unapply them.</p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype4.png"/><br/></p><p><img title="Apply Stereotype" alt="Apply Stereotype" border="0" src="images/applyStereotype5.png"/><br/></p><p>At this point, your Papyrus should look like this:</p><p><img title="Applied Stereotype" alt="Applied Stereotype" border="0" src="images/appliedStereotype.png"/><br/></p><h2 id="Setting_values_to_stereotype.27_properties">Setting values to stereotype' properties</h2><p>As already mentioned, Stereotypes may have properties. Consequently, when applying a stereotype to a model element, it may be necessary to set the values of those properties. For that, you will go to the profile tab of the properties view and then you can unfold the stereotype application as shown in following figure:</p><p><img title="Stereotype Properties" alt="Stereotype Properties" border="0" src="images/stereotypeProperties.png"/><br/></p><p>Once you have selected the property to edit, its value (if already set, as for example if there is a default value defined in the profile for the property) appear in the right part of the property view. If the property has not yet been valued, you can add a value by using the <img title="Add" alt="Add" border="0" src="images/add.gif"/> button located on the top right of the widget named “Properties values”. If there is a value, double-click on the value to edit this latter.</p><p><img title="Edit Property" alt="Edit Property" border="0" src="images/stereotypePropertyEdition.png"/><br/></p><p>Ps: If you want to delete a value set to property, let’s use the <img title="Delete" alt="Delete" border="0" src="images/Delete.gif"/> button located on the top right of the widget named “Properties values”.</p><h2 id="Display_options_of_a_stereotype_application">Display options of a stereotype application</h2><p>Stereotype applications may be graphically rendered under different forms, either textually, or using specific icons. Details to specify those icons associated to a stereotype are given in previous chapters (See <a href="/wiki/definingProfilesAndStereotypes#Stereotype_display_options" title="definingProfilesAndStereotypes#Stereotype display options">definingProfilesAndStereotypes#Stereotype display options</a>).</p><p>Let’s remind that in UML, you can apply several stereotypes on a same model element. In Papyrus, it is then possible to select the ones you want to show for each diagram. For showing or hiding a stereotype application, you have to select the tab “appearance” in the properties view. As shown in the next figure, there is one widget named “Applied stereotypes” that denotes the list of stereotypes applied on the current selected model element. On the example illustrated within this figure, you can see on the upper corner of the icon placed in front of the stereotype name “Requirement” an overlay denoting that this stereotype application is shown.</p><p><img title="Stereotype Display" alt="Stereotype Display" border="0" src="images/stereotypeDisplayOptions.png"/><br/></p><p><i>Warning: Let’s notice that the appearance tab of the property view is only visible if you select a model element from one of the open diagram. In other case, if you select the model element from the model explorer, the concept of graphical does not make sense because the information specified within this view are only related to graphical information.</i></p><p><i>Consequently, the values set to the appearance properties of model element are valid only in the context of the diagram where the element is selected. It is then possible to show a stereotype on a diagram and hide it in another diagram depending on the concerns of the view realized by the diagram.</i></p><p>To hide or show stereotype applications, you have to select them from the list of applied stereotypes available within the appearance tab and then either press the <img title="Display qualified name" alt="Display qualified name" border="0" src="images/ConsoleViewQN.gif"/> button or <img title="Display" alt="Display" border="0" src="images/change_display.gif"/>.</p><p>The former is to be used if you want to display the stereotype application with its qualified name, and the latter is to be used if you want to show it without qualified name. Using one of both depends if you may have ambiguities or not on the origin of the stereotype when as for example applying several profiles defining similar stereotypes. As for example, both profiles, MARTE and SysML, define a stereotype named «FlowPort».</p><p>In addition, there are three other widgets dedicated to configure the stereotype display options:</p><ul><li>“Stereotype display” is an enumeration which values may be Text, Icon, Text and Icon or Shape. In UML, as explained previously, a stereotype may be denoted either as a string between a pair of French guillemets (e.g., «Requirement»), or as an icon embedded in the figure or as a shape with a label. In case of the shape option, it substitutes the normal graphical figure used to represent the element and its label denotes the name of the element.</li></ul><ul><li>“Text alignment” is an enumeration which values may be Horizontal or Vertical. When several applied stereotypes are shown, it is rendered as a list of string separated by a comma and enclosed between a pair of French guillemets. By default, this string is shown horizontally. But some times for aesthetic reasons, it may be useful to show it vertically, that is to say showing one stereotype per line.</li></ul><ul><li>“Display place” is an enumeration which values may be Compartment, Comment or With brace. This appearance property is used to set where to show the properties values of the applied stereotypes. In UML, those values can be shown either within a pair of braces located just near (above or on top) the name label of the model element (“With brace” option), or into a dedicated compartment, or in a text note associated with the annotated model element.</li></ul><p><i>PS: if you display several stereotype applications, and if you select the options to display them with icon or with icon and text, this is the icon of the first stereotype application in the list which is chosen to be displayed.</i></p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/whatIsAUmlProfile-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/whatIsAUmlProfile-toc.xml deleted file mode 100644 index 56645bfea3a..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/whatIsAUmlProfile-toc.xml +++ /dev/null @@ -1,4 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/users/whatIsAUmlProfile.html" label="whatIsAUmlProfile"> - <topic href="resource/users/whatIsAUmlProfile.html" label="What is a UML Profile"></topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/whatIsAUmlProfile.html b/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/whatIsAUmlProfile.html deleted file mode 100644 index 0f660e8f490..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/whatIsAUmlProfile.html +++ /dev/null @@ -1 +0,0 @@ -<?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="What_is_a_UML_Profile">What is a UML Profile</h1><p><b>Contents</b></p><ol style="list-style: none;"><li><a href="#What_is_a_UML_Profile">What is a UML Profile</a></li></ol><p>The purpose of this chapter is to provide the Papyrus users all the documentation needed in order to be able to use UML profiles. It includes the information for modeling and defining a profile using the Papyrus UML profile editor, but also the information for the usage of a profile within a user application model.</p><p>The basic premise of profiles is that all domain-specific concepts are derived as extensions or refinements of existing UML concepts, called UML metaclasses. These extensions are called stereotypes. A stereotype definition must be consistent with the abstract syntax and semantics of standard UML meta-classes it extends. Consequently, a profile-based model can be created and manipulated by any tool that supports standard UML. Moreover, because the concepts underlying a profile are specializations of existing UML concepts, it is more easily learned by anyone with knowledge of UML.</p><p>A stereotype is defined either as an extension of a UML base metaclass or as a specialization of an existing stereotype. The extension relationship of UML is not an association but a kind of association directed from the stereotype to the extended metaclass. Consequently, the metadata conveyed by the associated the attributes of the stereotype are associated to the extended metaclass in a transparent manner for the metaclass itself. This allows profiles owning the stereotypes to be applied and removed dynamically without modifying the underlying models — a fundamental feature of the profile mechanism.</p><p>A stereotype may have attributes and may be associated with other stereotypes or existing UML metaclasses.</p><p>Constraints, such as OCL constraints, can also be defined in a profile. They can apply to stereotypes defined in the profile or those imported by the profile. They can also be used to further constrain elements of the UML metamodel. For instance, one could define an OCL constraint that all instances of Class in a model are active, or that all instances of Class must have at least one Operation (regardless of whether the Class is extended by a stereotype or not). However, not all constraints can be written in OCL. In that case, it is common to denote those latter in natural language. The drawback is that such constraints are no more automatically interpretable and need to be first rewritten in some language the UML tool will understand. In the context of Papyrus, it is then usual to use Java.</p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/.settings/org.eclipse.core.resources.prefs b/plugins/doc/org.eclipse.papyrus.uml.doc/.settings/org.eclipse.core.resources.prefs deleted file mode 100644 index 4216b790e5b..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/.settings/org.eclipse.core.resources.prefs +++ /dev/null @@ -1,3 +0,0 @@ -eclipse.preferences.version=1
-encoding//resource/PapyrusStarterGuide-toc.xml=utf-8
-encoding//resource/PapyrusStarterGuide.html=utf-8
diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/build.properties b/plugins/doc/org.eclipse.papyrus.uml.doc/build.properties index 1fc4f90e0c9..d8b52f252bd 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/build.properties @@ -1,5 +1,6 @@ bin.includes = META-INF/,\
plugin.xml,\
about.html,\
- resource/
-src.includes = about.html + target/generated-eclipse-help/**
+src.includes = about.html,\
+ resource/ diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.uml.doc/plugin.xml index 443cdcda029..9796e3d71be 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/plugin.xml @@ -4,11 +4,11 @@ <extension
point="org.eclipse.help.toc">
<toc
- file="resource/PapyrusStarterGuide-main-toc.xml"
+ file="target/generated-eclipse-help/PapyrusStarterGuide-main-toc.xml"
primary="false">
</toc>
<toc
- file="resource/PapyrusStarterGuide-toc.xml"
+ file="target/generated-eclipse-help/PapyrusStarterGuide-toc.xml"
primary="false">
</toc>
</extension>
diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.uml.doc/pom.xml index e68b417746b..cce56e6c28b 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PapyrusStarterGuide-main-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PapyrusStarterGuide-main-toc.xml index cd8a9501ee4..cd4672bdb80 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PapyrusStarterGuide-main-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PapyrusStarterGuide-main-toc.xml @@ -1,7 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?> <toc label="Papyrus UML Starter Guide" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> - <topic href="resource/PapyrusStarterGuide.html" label="Papyrus UML Starter Guide"> - <link toc="resource/PapyrusStarterGuide-toc.xml"/> + <topic href="target/generated-eclipse-help/PapyrusStarterGuide.html" label="Papyrus UML Starter Guide"> + <link toc="target/generated-eclipse-help/PapyrusStarterGuide-toc.xml"/> <anchor id="UMLStarterDoc"/> </topic> </toc> diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PapyrusStarterGuide-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PapyrusStarterGuide-toc.xml deleted file mode 100644 index ec44f564d2c..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PapyrusStarterGuide-toc.xml +++ /dev/null @@ -1,146 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/PapyrusStarterGuide.html" label="PapyrusStarterGuide"> - <topic href="resource/PapyrusStarterGuide.html" label="1 Overview"> - <topic href="resource/PapyrusStarterGuide.html#1.1_Table_of_Contents" label="1.1 Table of Contents"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#2_Introduction" label="2 Introduction"> - <topic href="resource/PapyrusStarterGuide.html#2.1_Legend" label="2.1 Legend"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#3_Installation" label="3 Installation"> - <topic href="resource/PapyrusStarterGuide.html#3.1_Install_Eclipse_Standard" label="3.1 Install Eclipse Standard"></topic> - <topic href="resource/PapyrusStarterGuide.html#3.2_Install_basic_Papyrus" label="3.2 Install basic Papyrus"></topic> - <topic href="resource/PapyrusStarterGuide.html#3.3_Additional_installation_for_Papyrus_UML_RT_modeling" label="3.3 Additional installation for Papyrus UML RT modeling"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#4_Eclipse" label="4 Eclipse"> - <topic href="resource/PapyrusStarterGuide.html#4.1_Architecture" label="4.1 Architecture"></topic> - <topic href="resource/PapyrusStarterGuide.html#4.2_Workspace" label="4.2 Workspace"></topic> - <topic href="resource/PapyrusStarterGuide.html#4.3_Resources" label="4.3 Resources"></topic> - <topic href="resource/PapyrusStarterGuide.html#4.4_Workbench" label="4.4 Workbench"> - <topic href="resource/PapyrusStarterGuide.html#4.4.1_Views" label="4.4.1 Views"> - <topic href="resource/PapyrusStarterGuide.html#4.4.1.1_Single_views" label="4.4.1.1 Single views"></topic> - <topic href="resource/PapyrusStarterGuide.html#4.4.1.2_Stacked_views" label="4.4.1.2 Stacked views"></topic> - </topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#4.5_Preferences" label="4.5 Preferences"></topic> - <topic href="resource/PapyrusStarterGuide.html#4.6_Import_and_Export" label="4.6 Import and Export"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#5_Modeling" label="5 Modeling"> - <topic href="resource/PapyrusStarterGuide.html#5.1_Model_and_diagrams" label="5.1 Model and diagrams"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#6_Tutorials" label="6 Tutorials"> - <topic href="resource/PapyrusStarterGuide.html#6.1_Getting_started" label="6.1 Getting started"> - <topic href="resource/PapyrusStarterGuide.html#6.1.1_Exploring_perspectives" label="6.1.1 Exploring perspectives"> - <topic href="resource/PapyrusStarterGuide.html#6.1.1.1_Exploring_the_.27.27Papyrus.27.27_perspective" label="6.1.1.1 Exploring the ''Papyrus'' perspective"></topic> - <topic href="resource/PapyrusStarterGuide.html#6.1.1.2_Exploring_and_customizing_the_Resource_perspective" label="6.1.1.2 Exploring and customizing the Resource perspective"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#6.1.2_Creating_a_project.2C_folder_and_files" label="6.1.2 Creating a project, folder and files"> - <topic href="resource/PapyrusStarterGuide.html#6.1.2.1_Creating_a_new_general_project" label="6.1.2.1 Creating a new general project"></topic> - <topic href="resource/PapyrusStarterGuide.html#6.1.2.2_Creating_a_new_folder" label="6.1.2.2 Creating a new folder"></topic> - <topic href="resource/PapyrusStarterGuide.html#6.1.2.3_Creating_and_editing_a_new_file" label="6.1.2.3 Creating and editing a new file"></topic> - <topic href="resource/PapyrusStarterGuide.html#6.1.2.4_Creating_another_file" label="6.1.2.4 Creating another file"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#6.1.3_Exploring_editors_and_views" label="6.1.3 Exploring editors and views"> - <topic href="resource/PapyrusStarterGuide.html#6.1.3.1_Maximizing_and_restoring_an_editor" label="6.1.3.1 Maximizing and restoring an editor"></topic> - <topic href="resource/PapyrusStarterGuide.html#6.1.3.2_Tiling_and_restacking_the_editors" label="6.1.3.2 Tiling and restacking the editors"></topic> - <topic href="resource/PapyrusStarterGuide.html#6.1.3.3_Organizing_views" label="6.1.3.3 Organizing views"></topic> - <topic href="resource/PapyrusStarterGuide.html#6.1.3.4_Using_view_menus" label="6.1.3.4 Using view menus"></topic> - <topic href="resource/PapyrusStarterGuide.html#6.1.3.5_Closing_and_opening_views" label="6.1.3.5 Closing and opening views"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#6.1.4_Exporting_and_importing_a_project" label="6.1.4 Exporting and importing a project"> - <topic href="resource/PapyrusStarterGuide.html#6.1.4.1_Exporting_a_project" label="6.1.4.1 Exporting a project"></topic> - <topic href="resource/PapyrusStarterGuide.html#6.1.4.2_Removing_the_project_from_the_workspace" label="6.1.4.2 Removing the project from the workspace"></topic> - <topic href="resource/PapyrusStarterGuide.html#6.1.4.3_Importing_a_project" label="6.1.4.3 Importing a project"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#6.1.5_Conclusion" label="6.1.5 Conclusion"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#6.2_Creating_profiles" label="6.2 Creating profiles"></topic> - <topic href="resource/PapyrusStarterGuide.html#6.3_Creating_models" label="6.3 Creating models"> - <topic href="resource/PapyrusStarterGuide.html#6.3.1_Use_case_modeling" label="6.3.1 Use case modeling"></topic> - <topic href="resource/PapyrusStarterGuide.html#6.3.2_Design_modeling" label="6.3.2 Design modeling"></topic> - <topic href="resource/PapyrusStarterGuide.html#6.3.3_RT_modeling" label="6.3.3 RT modeling"></topic> - </topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#7_Papyrus" label="7 Papyrus"> - <topic href="resource/PapyrusStarterGuide.html#7.1_Papyrus_resources_in_the_workspace" label="7.1 Papyrus resources in the workspace"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.2_The_Papyrus_perspective" label="7.2 The Papyrus perspective"> - <topic href="resource/PapyrusStarterGuide.html#7.2.1_Project_Explorer_view" label="7.2.1 Project Explorer view"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.2.2_Model_Explorer_view" label="7.2.2 Model Explorer view"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.2.3_Editing_view" label="7.2.3 Editing view"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.2.4_Outline_view" label="7.2.4 Outline view"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.2.5_Properties_view" label="7.2.5 Properties view"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.2.6_Model_Validation_view" label="7.2.6 Model Validation view"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.2.7_Search_view" label="7.2.7 Search view"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#7.3_Diagram_editing_in_Papyrus" label="7.3 Diagram editing in Papyrus"> - <topic href="resource/PapyrusStarterGuide.html#7.3.1_Diagram_editors" label="7.3.1 Diagram editors"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.3.2_Basic_tool_techniques" label="7.3.2 Basic tool techniques"> - <topic href="resource/PapyrusStarterGuide.html#7.3.2.1_Creating_diagrams" label="7.3.2.1 Creating diagrams"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.3.2.2_Scrolling_and_panning_in_diagrams" label="7.3.2.2 Scrolling and panning in diagrams"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.3.2.3_Creating_an_element_in_a_diagram" label="7.3.2.3 Creating an element in a diagram"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.3.2.4_Delete_and_hide" label="7.3.2.4 Delete and hide"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.3.2.5_Formating_and_validating_diagrams" label="7.3.2.5 Formating and validating diagrams"></topic> - </topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#7.4_UML_modeling" label="7.4 UML modeling"> - <topic href="resource/PapyrusStarterGuide.html#7.4.1_Diagrams" label="7.4.1 Diagrams"> - <topic href="resource/PapyrusStarterGuide.html#7.4.1.1_Diagrams_related_to_Use_Cases" label="7.4.1.1 Diagrams related to Use Cases"> - <topic href="resource/PapyrusStarterGuide.html#7.4.1.1.1_Use_case_diagram" label="7.4.1.1.1 Use case diagram"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.4.1.1.2_Activity_diagram" label="7.4.1.1.2 Activity diagram"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.4.1.1.3_Interaction_diagrams" label="7.4.1.1.3 Interaction diagrams"> - <topic href="resource/PapyrusStarterGuide.html#7.4.1.1.3.1_Sequence_diagram" label="7.4.1.1.3.1 Sequence diagram"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.4.1.1.3.2_Communication_diagram" label="7.4.1.1.3.2 Communication diagram"></topic> - </topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#7.4.1.2_Diagrams_related_to_Classes" label="7.4.1.2 Diagrams related to Classes"> - <topic href="resource/PapyrusStarterGuide.html#7.4.1.2.1_Class_diagram" label="7.4.1.2.1 Class diagram"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.4.1.2.2_Composite_structure_diagram" label="7.4.1.2.2 Composite structure diagram"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.4.1.2.3_State_machine_diagram" label="7.4.1.2.3 State machine diagram"></topic> - </topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#7.4.2_Model_elements" label="7.4.2 Model elements"> - <topic href="resource/PapyrusStarterGuide.html#7.4.2.1_Package" label="7.4.2.1 Package"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.4.2.2_Use_Case" label="7.4.2.2 Use Case"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.4.2.3_Actor" label="7.4.2.3 Actor"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.4.2.4_Class" label="7.4.2.4 Class"> - <topic href="resource/PapyrusStarterGuide.html#7.4.2.5.1_Attributes_on_Classes" label="7.4.2.5.1 Attributes on Classes"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.4.2.5.2_Operations_on_Classes" label="7.4.2.5.2 Operations on Classes"></topic> - </topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#7.4.3_Relationships" label="7.4.3 Relationships"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#7.5_UML_RT_modeling" label="7.5 UML RT modeling"> - <topic href="resource/PapyrusStarterGuide.html#7.5.1_Additional_modeling_elements" label="7.5.1 Additional modeling elements"> - <topic href="resource/PapyrusStarterGuide.html#7.5.1.1_Capsule_Class" label="7.5.1.1 Capsule Class"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.5.1.2_Protocol_Class" label="7.5.1.2 Protocol Class"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#7.5.2_Using_C_in_a_model" label="7.5.2 Using C in a model"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.5.3_C_service_library" label="7.5.3 C service library"> - <topic href="resource/PapyrusStarterGuide.html#7.5.3.1_Sending_messages" label="7.5.3.1 Sending messages"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#7.5.4_Transformation_from_model_to_code" label="7.5.4 Transformation from model to code"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.5.5_Edit_the_generated_code" label="7.5.5 Edit the generated code"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.5.6_Compiling_and_linking_the_generated_code" label="7.5.6 Compiling and linking the generated code"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.5.7_Using_external_libraries" label="7.5.7 Using external libraries"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.5.8_Running_the_application" label="7.5.8 Running the application"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.5.9_Model_components" label="7.5.9 Model components"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#7.6_Papyrus_in_a_team_environment" label="7.6 Papyrus in a team environment"> - <topic href="resource/PapyrusStarterGuide.html#7.6.1_Model_fragmentation" label="7.6.1 Model fragmentation"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.6.2_Source_configuration_management" label="7.6.2 Source configuration management"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.6.3_Compare_and_Merge" label="7.6.3 Compare and Merge"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#7.7_Model_validation" label="7.7 Model validation"> - <topic href="resource/PapyrusStarterGuide.html#7.7.1_Object_Constrain_Language_.28OCL.29" label="7.7.1 Object Constrain Language (OCL)"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.7.2_Defining_constraints_using_OCL" label="7.7.2 Defining constraints using OCL"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#7.8_Searching" label="7.8 Searching"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.9_Sample_models" label="7.9 Sample models"> - <topic href="resource/PapyrusStarterGuide.html#7.9.1_Class_model_with_inheritance" label="7.9.1 Class model with inheritance"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.9.2_Send_and_receive_data" label="7.9.2 Send and receive data"></topic> - <topic href="resource/PapyrusStarterGuide.html#7.9.3_Interprocess_communication" label="7.9.3 Interprocess communication"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#7.10_UML_profiling" label="7.10 UML profiling"></topic> - </topic> - <topic href="resource/PapyrusStarterGuide.html#8_Support" label="8 Support"></topic> - <topic href="resource/PapyrusStarterGuide.html#9_References" label="9 References"></topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PapyrusStarterGuide.html b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PapyrusStarterGuide.html deleted file mode 100644 index 0eedcc90492..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PapyrusStarterGuide.html +++ /dev/null @@ -1,4 +0,0 @@ -<?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="1_Overview">1 Overview</h1><p>Papyrus is an environment for editing any kind of <a href="http://www.eclipse.org/modeling/emf/">EMF model</a>, particularly supporting UML 2 (<a href="http://www.omg.org/spec/UML/2.4.1/">Unified Modeling Language (UML) version 2.4.1</a> ) and related modeling languages such as SysML (<a href="http://www.omg.org/spec/SysML/">System Modeling Language</a> ) and MARTE (<a href="http://www.omg.org/omgmarte/Specification.htm/">Modeling and Analysis of Real-Time and Embedded systems</a> ). Papyrus also offers very advanced support for UML profiles that enables users to define editors for DSLs (Domain Specific Languages) based on the UML 2 standard.</p><p>Papyrus is a collection of plug-ins and features on top of the Eclipse Modeling Framework. For more information about Eclipse, please go to the Eclipse web site <a href="http://www.eclipse.org/">eclipse.org</a>. Some of the terminology used in this Papyrus user guide are basic Eclipse concepts and briefly described here. To get more information about the Eclipse concepts, please visit the <i>Workbench User Guide</i> by selecting <b>Help > Help Contents</b> from within Eclipse.</p><h2 id="1.1_Table_of_Contents">1.1 Table of Contents</h2><ol style="list-style: none;"><li><a href="#1_Overview">1 Overview</a><ol style="list-style: none;"><li><a href="#1.1_Table_of_Contents">1.1 Table of Contents</a></li></ol></li><li><a href="#2_Introduction">2 Introduction</a><ol style="list-style: none;"><li><a href="#2.1_Legend">2.1 Legend</a></li></ol></li><li><a href="#3_Installation">3 Installation</a><ol style="list-style: none;"><li><a href="#3.1_Install_Eclipse_Standard">3.1 Install Eclipse Standard</a></li><li><a href="#3.2_Install_basic_Papyrus">3.2 Install basic Papyrus</a></li><li><a href="#3.3_Additional_installation_steps">3.3 Additional installation steps</a></li></ol></li><li><a href="#4_Eclipse">4 Eclipse</a><ol style="list-style: none;"><li><a href="#4.1_Architecture">4.1 Architecture</a></li><li><a href="#4.2_Workspace">4.2 Workspace</a></li><li><a href="#4.3_Resources">4.3 Resources</a></li><li><a href="#4.4_Workbench">4.4 Workbench</a><ol style="list-style: none;"><li><a href="#4.4.1_Views">4.4.1 Views</a><ol style="list-style: none;"><li><a href="#4.4.1.1_Single_views">4.4.1.1 Single views</a></li><li><a href="#4.4.1.2_Stacked_views">4.4.1.2 Stacked views</a></li></ol></li></ol></li><li><a href="#4.5_Preferences">4.5 Preferences</a></li><li><a href="#4.6_Import_and_Export">4.6 Import and Export</a></li></ol></li><li><a href="#5_Modeling">5 Modeling</a><ol style="list-style: none;"><li><a href="#5.1_Model_and_diagrams">5.1 Model and diagrams</a></li></ol></li><li><a href="#6_Tutorials">6 Tutorials</a><ol style="list-style: none;"><li><a href="#6.1_Getting_started_with_general_Eclipse_functionality">6.1 Getting started with general Eclipse functionality</a><ol style="list-style: none;"><li><a href="#6.1.1_Exploring_perspectives">6.1.1 Exploring perspectives</a><ol style="list-style: none;"><li><a href="#6.1.1.1_Exploring_the_.27.27Papyrus.27.27_perspective">6.1.1.1 Exploring the ''Papyrus'' perspective</a></li><li><a href="#6.1.1.2_Exploring_and_customizing_the_Resource_perspective">6.1.1.2 Exploring and customizing the Resource perspective</a></li></ol></li><li><a href="#6.1.2_Creating_a_new_project.2C_folder_and_files">6.1.2 Creating a new project, folder and files</a><ol style="list-style: none;"><li><a href="#6.1.2.1_Creating_a_new_general_project">6.1.2.1 Creating a new general project</a></li><li><a href="#6.1.2.2_Creating_a_new_folder">6.1.2.2 Creating a new folder</a></li><li><a href="#6.1.2.3_Creating_and_editing_a_new_file">6.1.2.3 Creating and editing a new file</a></li><li><a href="#6.1.2.4_Creating_another_file">6.1.2.4 Creating another file</a></li></ol></li><li><a href="#6.1.3_Exploring_editors_and_views">6.1.3 Exploring editors and views</a><ol style="list-style: none;"><li><a href="#6.1.3.1_Maximizing_and_restoring_an_editor">6.1.3.1 Maximizing and restoring an editor</a></li><li><a href="#6.1.3.2_Tiling_and_restacking_the_editors">6.1.3.2 Tiling and restacking the editors</a></li><li><a href="#6.1.3.3_Organizing_views">6.1.3.3 Organizing views</a></li><li><a href="#6.1.3.4_Using_view_menus">6.1.3.4 Using view menus</a></li><li><a href="#6.1.3.5_Closing_and_opening_views">6.1.3.5 Closing and opening views</a></li></ol></li><li><a href="#6.1.4_Exporting_and_importing_a_project">6.1.4 Exporting and importing a project</a><ol style="list-style: none;"><li><a href="#6.1.4.1_Exporting_a_project">6.1.4.1 Exporting a project</a></li><li><a href="#6.1.4.2_Removing_the_project_from_the_workspace">6.1.4.2 Removing the project from the workspace</a></li><li><a href="#6.1.4.3_Importing_a_project">6.1.4.3 Importing a project</a></li></ol></li><li><a href="#6.1.5_Conclusion">6.1.5 Conclusion</a></li></ol></li><li><a href="#6.2_Creating_profiles">6.2 Creating profiles</a></li><li><a href="#6.3_Creating_models_using_Papyrus">6.3 Creating models using Papyrus</a><ol style="list-style: none;"><li><a href="#6.3.1_Use-case_modeling">6.3.1 Use-case modeling</a></li><li><a href="#6.3.2_Design_modeling">6.3.2 Design modeling</a><ol style="list-style: none;"><li><a href="#6.3.2.1_Create_a_new_UML_project">6.3.2.1 Create a new UML project</a></li><li><a href="#6.3.2.2_Create_new_packages_to_be_used_for_classes">6.3.2.2 Create new packages to be used for classes</a></li><li><a href="#6.3.2.3_Create_new_classes">6.3.2.3 Create new classes</a></li><li><a href="#6.3.2.4_Create_new_class_diagrams">6.3.2.4 Create new class diagrams</a></li><li><a href="#6.3.2.5_Create_new_operations_and_attributes">6.3.2.5 Create new operations and attributes</a></li><li><a href="#6.3.2.6_Create_new_relationships_between_classes">6.3.2.6 Create new relationships between classes</a></li><li><a href="#6.3.2.7_Create_a_new_package_to_be_used_for_objects">6.3.2.7 Create a new package to be used for objects</a></li><li><a href="#6.3.2.8_Create_new_objects">6.3.2.8 Create new objects</a></li><li><a href="#6.3.2.9_Create_a_new_class_diagram">6.3.2.9 Create a new class diagram</a></li><li><a href="#6.3.2.10_Create_new_relationships_between_objects">6.3.2.10 Create new relationships between objects</a></li><li><a href="#6.3.2.11_Conclusion">6.3.2.11 Conclusion</a></li></ol></li><li><a href="#6.3.3_RT_modeling">6.3.3 RT modeling</a></li></ol></li></ol></li><li><a href="#7_Papyrus">7 Papyrus</a><ol style="list-style: none;"><li><a href="#7.1_Papyrus_resources_in_the_workspace">7.1 Papyrus resources in the workspace</a></li><li><a href="#7.2_The_Papyrus_perspective">7.2 The Papyrus perspective</a><ol style="list-style: none;"><li><a href="#7.2.1_Project_Explorer_view">7.2.1 Project Explorer view</a></li><li><a href="#7.2.2_Model_Explorer_view">7.2.2 Model Explorer view</a></li><li><a href="#7.2.3_Editing_view">7.2.3 Editing view</a></li><li><a href="#7.2.4_Outline_view">7.2.4 Outline view</a></li><li><a href="#7.2.5_Properties_view">7.2.5 Properties view</a></li><li><a href="#7.2.6_Model_Validation_view">7.2.6 Model Validation view</a></li><li><a href="#7.2.7_Search_view">7.2.7 Search view</a></li></ol></li><li><a href="#7.3_Diagram_editing_in_Papyrus">7.3 Diagram editing in Papyrus</a><ol style="list-style: none;"><li><a href="#7.3.1_Diagram_editors">7.3.1 Diagram editors</a></li><li><a href="#7.3.2_Basic_tool_techniques">7.3.2 Basic tool techniques</a><ol style="list-style: none;"><li><a href="#7.3.2.1_Creating_diagrams">7.3.2.1 Creating diagrams</a></li><li><a href="#7.3.2.2_Scrolling_and_panning_in_diagrams">7.3.2.2 Scrolling and panning in diagrams</a></li><li><a href="#7.3.2.3_Creating_an_element_in_a_diagram">7.3.2.3 Creating an element in a diagram</a></li><li><a href="#7.3.2.4_Delete_and_hide">7.3.2.4 Delete and hide</a></li><li><a href="#7.3.2.5_Formating_and_validating_diagrams">7.3.2.5 Formating and validating diagrams</a></li></ol></li></ol></li><li><a href="#7.4_UML_modeling">7.4 UML modeling</a><ol style="list-style: none;"><li><a href="#7.4.1_Package">7.4.1 Package</a></li><li><a href="#7.4.2_Use-case">7.4.2 Use-case</a></li><li><a href="#7.4.3_Actor">7.4.3 Actor</a></li><li><a href="#7.4.4_Class">7.4.4 Class</a><ol style="list-style: none;"><li><a href="#7.4.4.1_Attributes_on_classes">7.4.4.1 Attributes on classes</a></li><li><a href="#7.4.4.2_Operations_on_classes">7.4.4.2 Operations on classes</a></li></ol></li><li><a href="#7.4.5_Object">7.4.5 Object</a></li><li><a href="#7.4.6_Relationships">7.4.6 Relationships</a></li><li><a href="#7.4.7_Diagrams">7.4.7 Diagrams</a><ol style="list-style: none;"><li><a href="#7.4.7.1_Diagrams_related_to_use-cases">7.4.7.1 Diagrams related to use-cases</a></li><li><a href="#7.4.7.2_Diagrams_related_to_classes">7.4.7.2 Diagrams related to classes</a></li></ol></li></ol></li><li><a href="#7.5_UML_RT_modeling">7.5 UML RT modeling</a><ol style="list-style: none;"><li><a href="#7.5.1_Additional_modeling_elements">7.5.1 Additional modeling elements</a><ol style="list-style: none;"><li><a href="#7.5.1.1_Capsule_class">7.5.1.1 Capsule class</a></li><li><a href="#7.5.1.2_Protocol_class">7.5.1.2 Protocol class</a></li></ol></li><li><a href="#7.5.2_Using_C.2B.2B_in_a_model">7.5.2 Using C++ in a model</a></li><li><a href="#7.5.3_C.2B.2B_service_library">7.5.3 C++ service library</a><ol style="list-style: none;"><li><a href="#7.5.3.1_Sending_messages">7.5.3.1 Sending messages</a></li></ol></li><li><a href="#7.5.4_Transformation_from_model_to_code">7.5.4 Transformation from model to code</a></li><li><a href="#7.5.5_Edit_the_generated_code">7.5.5 Edit the generated code</a></li><li><a href="#7.5.6_Compiling_and_linking_the_generated_code">7.5.6 Compiling and linking the generated code</a></li><li><a href="#7.5.7_Using_external_libraries">7.5.7 Using external libraries</a></li><li><a href="#7.5.8_Running_the_system">7.5.8 Running the system</a></li></ol></li><li><a href="#7.6_Papyrus_in_a_team_environment">7.6 Papyrus in a team environment</a><ol style="list-style: none;"><li><a href="#7.6.1_Model_fragmentation">7.6.1 Model fragmentation</a></li><li><a href="#7.6.2_Source_configuration_management">7.6.2 Source configuration management</a></li><li><a href="#7.6.3_Compare_and_Merge">7.6.3 Compare and Merge</a></li></ol></li><li><a href="#7.7_Model_validation">7.7 Model validation</a><ol style="list-style: none;"><li><a href="#7.7.1_Object_Constrain_Language_.28OCL.29">7.7.1 Object Constrain Language (OCL)</a></li><li><a href="#7.7.2_Defining_constraints_using_OCL">7.7.2 Defining constraints using OCL</a></li></ol></li><li><a href="#7.8_Searching">7.8 Searching</a></li><li><a href="#7.9_Sample_models">7.9 Sample models</a><ol style="list-style: none;"><li><a href="#7.9.1_Class_model_with_inheritance">7.9.1 Class model with inheritance</a></li><li><a href="#7.9.2_Send_and_receive_data">7.9.2 Send and receive data</a></li><li><a href="#7.9.3_Interprocess_communication">7.9.3 Interprocess communication</a></li></ol></li><li><a href="#7.10_UML_profiling">7.10 UML profiling</a></li></ol></li><li><a href="#8_Support">8 Support</a></li><li><a href="#9_References">9 References</a></li></ol><h1 id="2_Introduction">2 Introduction</h1><p>Papyrus is built on the extensible Eclipse framework and is an implementation of the OMG (Object Management Group) specification <a href="http://www.omg.org/spec/UML/2.4.1/">Unified Modeling Language (UML) version 2.4.1</a>. Papyrus is a comprehensive UML modeling environment, where many diagrams can be used to view different aspects of a system. Behind all diagrams, there is a model where all modeling elements, used in these diagrams, are kept. The model keeps the consistency between the diagrams.</p><p>UML diagrams can help system architects and developers understand, collaborate on and develop a system. Architects and managers can use diagrams to visualize an entire system or project and separate systems into smaller components for development.</p><p>System developers can use diagrams to specify, visualize, and document systems, which can increase efficiency and improve their system design. Also code can be generated from UML models.</p><p>Since UML is general-purpose modeling language in the field of software engineering, it is possible to adapt UML to specific domains. This is done by creating and applying UML profiles. Papyrus is a complete UML modeling environment, which also can be used to develop UML profiles.</p><h2 id="2.1_Legend">2.1 Legend</h2><p>In this user guide, bold text is used for menu selections, e.g. <b>Help > Welcome</b> means from the <b>Help</b> item on the main menu, select the <b>Welcome</b> item.</p><p>A context menu is the pop-up menu that appears when right clicking on something, e.g. right click on a class select <b>New Child > Create a new Operation</b>, will create a new operation on the class, using the class' context menu.</p><p>When text should be typed in, it is indicated by inline code, e.g. <code>this text should be typed in</code>.</p><p>Fields in wizards, pop-up windows, different editors, radio buttons and check boxes are indicated by italic text, e.g. set the field <i>Name</i> to <code>MyClass</code>.</p><h1 id="3_Installation"><div id="Installation">3 Installation</div></h1><p>It is a several step process to install Papyrus and its optional components. The <i>Eclipse Standard</i> must first be installed and when that is done, Papyrus is installed on top of <i>Eclipse Standard</i>.</p><h2 id="3.1_Install_Eclipse_Standard">3.1 Install Eclipse Standard</h2><p><i>Eclipse Standard</i> is installed from the <a href="http://www.eclipse.org/downloads/">Eclipse download page</a>. On the download page select <i>Eclipse Standard <version number></i> to install. Follow the install wizard to complete the installation.</p><h2 id="3.2_Install_basic_Papyrus">3.2 Install basic Papyrus</h2><p>When <i>Eclipse Standard</i> is installed, go to <b>Help > Install New Software</b> and type in <code><a href="http://download.eclipse.org/releases/kepler/">http://download.eclipse.org/releases/kepler/</a></code> in the field named <i>Work with:</i>.</p><p><b>Note!</b> When this user guide was written, the Kepler release of Eclipse was the latest. Select the latest official Eclipse release.</p><p><b>Note!</b> In some industrial environments, a proxy has to be used instead of this type of direct URL to the Eclipse web-site. To configure Eclipse to use a proxy is done under <b>Windows > Preferences</b> and <b>General > Network Connections</b></p><p><center><div class="thumb middle"><div class="thumbinner" style="width:566px;"><a href="InstallNewSoftware.bmp" class="image"><img class="thumbimage" width="564" align="middle" border="0" src="InstallNewSoftware.bmp"/></a><div class="thumbcaption">Figure 1: Install New Software wizard</div></div></div></center></p><p>In the <i>Name</i> column of the wizard, scroll down to <i>Modeling</i> and expand to the next level. Under <i>Modeling</i>, select <i>Papyrus UML</i> and follow the installation wizard to complete the installation.</p><p>When Eclipse is restarted, the environment is now ready for UML modeling.</p><h2 id="3.3_Additional_installation_steps">3.3 Additional installation steps</h2><p>After installation of the basic Papyrus feature, go to <b>Help > Install Papyrus Additional Components</b>. In the wizard that pops up, select the needed additional Papyrus components, e.g. to be able to do UML RT modeling, the <i>Real Time</i> component is needed. It is also recommended to install the <i>Diagram Stylesheets</i> and <i>Papyrus Compare</i> components. Follow the installation wizard to complete the installation.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:439px;"><a href="InstallPapyrusComp.bmp" class="image"><img class="thumbimage" width="437" align="middle" border="0" src="InstallPapyrusComp.bmp"/></a><div class="thumbcaption">Figure 2: The Install Papyrus Additional Components wizard</div></div></div></center></p><h1 id="4_Eclipse">4 Eclipse</h1><p>Papyrus is built on the Eclipse framework, so most of its look and feel is inherited from Eclipse.</p><p>The Eclipse framework has a plug-in architecture, where plug-ins can be grouped into features. Features and plug-ins can be added to an existing Eclipse installation.</p><h2 id="4.1_Architecture">4.1 Architecture</h2><p>The plug-in architecture applies also for all subsystems. A plug-in is the smallest unit of Eclipse Platform functionality that can be developed and delivered separately. Usually, a small tool is written as a single plug-in, whereas a complex tool has its functionality split across several plug-ins. Except for a small kernel known as the Platform Runtime, all of the Eclipse Platform's functionality is located in plug-ins. Plug-ins can be grouped into features.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="EclipseArchitecture.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="EclipseArchitecture.bmp"/></a><div class="thumbcaption">Figure 3: The Eclipse architecture</div></div></div></center></p><p>Plug-ins are coded in Java. A typical plug-in consists of Java code in a JAR (Java Archive) library, some read-only files, and other resources such as images, Web templates, message catalogs, native code libraries, and so on. Some plug-ins do not contain code at all. One such example is a plug-in that contributes online help in the form of HTML pages. A single plug-in’s code libraries and read-only content are located together in a directory in the file system, or at a base URL on a server. There is also a mechanism that permits a plug-in to be synthesized from several separate fragments, each in their own directory or URL. This is the mechanism used to deliver separate language packs for an internationalized plug-in.</p><p>Each plug-in has a manifest file declaring its interconnections to other plug-ins. The interconnection model is simple: a plug-in declares any number of named extension points, and any number of extensions to one or more extension points in other plug-ins.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:292px;"><a href="Feature-Plug-in.bmp" class="image"><img class="thumbimage" width="290" align="middle" border="0" src="Feature-Plug-in.bmp"/></a><div class="thumbcaption">Figure 4: Plug-ins and Features</div></div></div></center></p><h2 id="4.2_Workspace"><div id="Workspace">4.2 Workspace</div></h2><p>The workspace is located in the file-system and is the place where Eclipse resources (files, folders and projects) are stored. When Eclipse is started, a pop-up window appears, where a workspace should be selected. One instance of Eclipse is connected to one workspace.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:595px;"><a href="WorkspacePopup.bmp" class="image"><img class="thumbimage" width="593" align="middle" border="0" src="WorkspacePopup.bmp"/></a><div class="thumbcaption">Figure 5: Pop-up window to select the workspace</div></div></div></center></p><p>In the file system all resources are stored in the selected workspace and in the same hierarchical structure as in the <i>Project Explorer</i>.</p><h2 id="4.3_Resources">4.3 Resources</h2><p>Resources are a collective term for the projects, folders, and files that exist in the workbench. The resources are stored in the workspace, where the projects are on the first level. Inside a project, there are files and folders in the same hierarchical structure as in the <i>Project Explorer</i> and <i>Model Explorer</i>.</p><p>Files appear in the file system as files and folders are Unix directories or Windows folders and may contain other files and folders. Each time a file is saved, a copy is saved, which makes it possible to replace the current file with a previous edit or even restore a deleted file. Earlier versions of a file can be compared to the contents of all the local edits. Each edit in the local history is time stamped, i.e. is uniquely represented by the date and time the file was saved.</p><p>Projects can be viewed as the top level folder in the file system under the workspace. In Eclipse there are different types of projects, e.g. Model, C/C or Java projects and they are the top level resource in the <i>Project Explorer</i>. Projects can be closed and opened in the <i>Project Explorer</i>.</p><h2 id="4.4_Workbench"><div id="Workbench">4.4 Workbench</div></h2><p>The workbench is the Eclipse user interface and is used to navigate, view, and edit resources in a workspace, i.e. the workbench is the Eclipse IDE's application window. The workbench presents one or more editors and <i>views</i> that are gathered into adjustable groups (<i>perspectives</i>).</p><p>The first time Eclipse is started, after the installation, a <i>Welcome</i> page is presented. Take a few minutes to explore the product overview and getting started information that is located here.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:482px;"><a href="WelcomePage.bmp" class="image"><img class="thumbimage" width="480" align="middle" border="0" src="WelcomePage.bmp"/></a><div class="thumbcaption">Figure 6: The Eclipse welcome page</div></div></div></center></p><p>To return to the ordinary workbench, just click on the workbench icon up to the right. When starting Eclipse, subsequent times, the workbench appears directly. To visit the welcome page at any time, just select <b>Help > Welcome</b>.</p><p>The title bar of the workbench window and the little Papyrus icon to the right indicates which <i>perspective</i> is active. In this example, the Papyrus <i>perspective</i> is in use. The <i>Project Explorer</i> and the <i>Model Explorer, Outline, Properties</i> views, etc. are open, along with a <i>Class Diagram</i> editor and its tool palette.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:514px;"><a href="Workbench.bmp" class="image"><img class="thumbimage" width="512" align="middle" border="0" src="Workbench.bmp"/></a><div class="thumbcaption">Figure 7: The Papyrus perspective in the workbench</div></div></div></center></p><p>It is easy to toggle between perspectives by clicking on some shown <i>perspective</i> in top of the right hand corner or open a new one by clicking on the <i>Open Perspective</i> icon <img border="0" src="IkonOpenPerspective.png"/> and browse to the <i>perspective</i> to open. It is also possible to reorganize a <i>perspective</i>, open/close <i>views</i>, customize menus, etc. and then save the <i>perspective</i> with a new name by <b>Window > Save Perspective As ...</b>.</p><h3 id="4.4.1_Views">4.4.1 Views</h3><p><i>Views</i> and editors are the main visual entities that appear in the workbench. Any given <i>perspective</i> can contain multiple editors and a number of surrounding <i>views</i> that provide context.<i>Views</i> provide different ways to visualize, navigate and edit the resources in the Eclipse workspace. <i>Views</i> can be single or stacked on top of each other.</p><p><i>Views</i>, including editor views, can be resize, moved, detached. In addition, a <i>view</i> can be maximized to cover the entire workbench by double-clicking on its tab. By double-clicking once more, it will return to its original size. Some <i>views</i> has a view specific menu, e.g. <i>Project Explorer</i> view, where some specific view settings could be done.</p><p>To add a new <i>view</i> to the active <i>perspective</i>, use <b>Window > Show View</b>and if the desired <i>view</i> does not appear on top of the pop-up menu, select <b>Other</b>, which opens up a <i>view</i> browser, where all available <i>views</i> are organized in different categories.</p><h4 id="4.4.1.1_Single_views">4.4.1.1 Single views</h4><p>In the workbench figure, above, several single views appears, e.g. <i>Outline, Class Diagram</i> editor, <i>Help, Project Explorer</i> and <i>Model Explorer</i> views. The <i>single view</i> has only one tab with the view name. By draging a <i>single view</i> tab and release it on another <i>single view</i> tab, <i>stacked views</i> are created.</p><h4 id="4.4.1.2_Stacked_views">4.4.1.2 Stacked views</h4><p>In the workbench figure, above, also <i>stacked views</i> appear, e.g. <i>Properties</i> and <i>Model Validation</i> views. To select the one that should be on top of the stack, just click on its tab and it becomes visible. By selecting a <i>stacked view</i> and drag it besides another view in the workbench, a <i>single view</i> will appear.</p><h2 id="4.5_Preferences">4.5 Preferences</h2><p>To customize the settings for the Eclipse workbench and the installed features, the preference window is used. Use <b>Windows > Preferences</b> to open it, e.g. under <b>General > Keys</b> in the preference window there are shortcuts and keys defined for the user interface. Here they can be redefined or own sets could be defined.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:558px;"><a href="Preferences.bmp" class="image"><img class="thumbimage" width="556" align="middle" border="0" src="Preferences.bmp"/></a><div class="thumbcaption">Figure 8: The preference window</div></div></div></center></p><p>The preference window pages can be searched using the filter function. To filter by matching the page title, simply type the name of the page and the available pages will be presented below.</p><p>The filter also searches on keywords. By the history controls (the left, right and drop-down arrows up in the right corner of the preference window) it is possible to navigate through previously viewed pages. To step back or forward several pages at a time, click the drop-down arrow and a list of the most recently viewed preference pages are displayed.</p><h2 id="4.6_Import_and_Export">4.6 Import and Export</h2><p>Projects can be shared between workspaces by using project import and export, which are done through wizards. To open the import wizard, use <b>File > Import</b> and in several steps select what, where from and if it should be imported as a copy or just referenced. To export resources, There are also an export wizard, which is opened by <b>File > Export</b> and select details about what should be exported, if it should be compressed and where to export it to.</p><table><tr><td><p><div class="thumb middle"><div class="thumbinner" style="width:422px;"><a href="ImportWiz.bmp" class="image"><img class="thumbimage" width="420" align="middle" border="0" src="ImportWiz.bmp"/></a><div class="thumbcaption">Figure 9: Import wizard</div></div></div> </p></td><td><p><div class="thumb middle"><div class="thumbinner" style="width:540px;"><a href="ExportWiz.bmp" class="image"><img class="thumbimage" width="538" align="middle" border="0" src="ExportWiz.bmp"/></a><div class="thumbcaption">Figure 10: Export wizard</div></div></div></p></td></tr></table><p>When importing a project into the used workspace, it can be copied by checking the box <i>Copy ...</i> in the import wizard. If this check box is unchecked, there will just be a reference to the other workspace and when editing that project, it will be edited in its original place. Be aware of that when doing so, several instances of Eclipse may edit the same resource.</p><p>When exporting a project, browse to the place where to export it to name it and select if and how compression should be used.</p><h1 id="5_Modeling">5 Modeling</h1><p>Papyrus is a comprehensive UML modeling environment, where diagrams can be used to view different aspects of a system. Behind all the diagrams, there is a model where the modeling elements, used in these diagrams, are stored. The model maintains the consistency between all diagrams.</p><p>A model is the collection of all the modeling elements and relationships that compose a software system. Papyrus enables the creation, viewing and manipulation of UML diagrams as specified in the <a href="http://www.omg.org/spec/UML/2.4.1/">UML 2 specification</a>.</p><p>The model defines every element, representing some part of the system. Multiple model diagrams can reference an element many times. Each of the different diagrams can view a different aspect of the system.</p><p>The model is the basis of the diagrams and keep the diagrams consistent. The diagrams are stored in the model's hierarchical structure. Some are owned by a modeling element like a class and some are just organized into packages and then owned by the package (a.k.a folders in basic Eclipse projects). <b>Note!</b> the top level of the model is the model package, which is a special kind of a package.</p><h2 id="5.1_Model_and_diagrams">5.1 Model and diagrams</h2><p>The model is the basis for all diagrams and maintains the consistency between the diagrams. The model is a collection of definitions of elements that compose the system and the relationships between them. Diagrams can be used to view subsets of the underlying model and from various view points. A model of a system may require many different diagrams to represent different views of the system for different project stakeholders.</p><p>In Papyrus, diagrams are be viewed and created in the <i>Model Explorer</i> view. The <i>Model Explorer</i> shows diagrams in their logical place within the model.</p><p>The visual representation of a system that diagrams provide can offer both low-level and high-level insights into the concepts and design of a system.</p><h1 id="6_Tutorials">6 Tutorials</h1><p>The tutorials are focused on selected topics regarding the use of Papyrus and contains step by step instructions on how to create and manipulate the workbench and models.</p><h2 id="6.1_Getting_started_with_general_Eclipse_functionality">6.1 Getting started with general Eclipse functionality</h2><p>This tutorial is about to understand the workbench environment and the basic Eclipse terminology.</p><h3 id="6.1.1_Exploring_perspectives">6.1.1 Exploring perspectives</h3><p>This part demonstrates the differences between the <i>Papyrus</i> and the <i>Resource</i> perspectives and also how to customize the <i>Resource</i> perspective.</p><h4 id="6.1.1.1_Exploring_the_.27.27Papyrus.27.27_perspective">6.1.1.1 Exploring the <i>Papyrus</i> perspective</h4><p>Explore the Papyrus default menus, toolbar, and views in the <i>Papyrus</i> perspective.</p><ol><li>To switch to the <i>Payrus</i> perspective, click <b>Window > Open Perspective > Other</b>. Then choose the <i>Papyrus</i> perspective. (Notice the workbench title bar and perspective bar reflect that the <i>Papyrus</i> perspective is active. Notice also the main menu items, toolbar buttons, and views that is visible in this perspective.)</li><li>Click <b>File > New</b> and notice that the menu contains the items <i>Papyrus Project</i> and <i>Papyrus Model</i> among other items.</li><li>Click <b>Window > Show View</b> and notice that the menu contains the items <i>Model Explorer</i>, <i>Model Validation</i> and more.</li></ol><h4 id="6.1.1.2_Exploring_and_customizing_the_Resource_perspective">6.1.1.2 Exploring and customizing the Resource perspective</h4><p>Explore the default menu, toolbar, and views in the <i>Resource</i> perspective and customize a menu.</p><ol><li>To switch to the <i>Resource</i> perspective, click <b>Window > Open Perspective > Other</b>. Then choose the <i>Resource</i> perspective. Notice that the workbench title bar and perspective bar reflect that the <i>Resource</i> perspective is active. (Notice the main menu items, toolbar buttons, and views visible in this perspective)</li><li>Click <b>File > New</b> and notice that there are no Papyrus items in the menu.</li><li>Click <b>Window > Show View</b> and notice that the menu does NOT contain the items <i>Model Explorer</i> and <i>Model Validation</i>.</li><li>Click <b>Window > Customize Perspective</b>. Ensure that the workbench title bar and perspective bar reflect that the <i>Resource</i> perspective is active.</li><li>In the <i>Customize Perspective - Resource</i> pop-up window, select the <i>Shortcuts</i> tab and select <b>Show View</b> from the <i>Submenus</i> combo box.</li><li>Clear all check boxes in the <i>Shortcut Categories</i> list.</li><li>Click <i>General</i>(not check the check box) in the <i>Shortcut Categories</i> list, select the check box next to <i>Project Explorer</i> in the <i>Shortcuts</i> list, and click <i>OK</i>.</li><li>Click <b>Window > Show View</b> and notice the menu now just contains the <i>Project Explorer</i> item.</li></ol><h3 id="6.1.2_Creating_a_new_project.2C_folder_and_files">6.1.2 Creating a new project, folder and files</h3><p>In this section a new project, folder and files will be created in the <i>Resource</i> perspective.</p><h4 id="6.1.2.1_Creating_a_new_general_project">6.1.2.1 Creating a new general project</h4><p>Create a new project in the <i>Resource</i> perspective by completing these steps:</p><ol><li>If necessary switch to the <i>Resource</i> perspective by clicking on <b>Window > Open Perspective > Other</b>. Then choose the <i>Resource</i> perspective. If the <i>Resource</i> perspective already is active, click on <b>Window > Reset Perspective...</b> to get back to its default configuration.</li><li>Click <b>File > New > Project</b>.</li><li>In the <i>New Project</i> wizard, name the project <code>My Project</code> and click <i>Finish</i>.</li></ol><h4 id="6.1.2.2_Creating_a_new_folder">6.1.2.2 Creating a new folder</h4><p>Create a folder in the project:</p><ol><li>Right-click on <i>My Project</i> in the <i>Project Explorer</i> and select <b>New > Folder</b>.</li><li>Type <code>Text Files</code> in the the field <i>Folder name</i>, and then click <i>Finish</i>.</li></ol><h4 id="6.1.2.3_Creating_and_editing_a_new_file">6.1.2.3 Creating and editing a new file</h4><p>Create a file in the folder:</p><ol><li>In the <i>Project Explorer</i>, right-click on the <i>Text Files</i> folder and select <b>New > File</b>.</li><li>In the <i>New File</i> wizard, ensure that <i>My Project/Text Files</i> is the parent folder. Type <code>My File</code> as the file name and click <i>Finish</i>. (Notice that a text editor opens in the editing view for the created resource)</li><li>Enter any text into the editor view for <i>My File</i>. Notice the asterisk (*) next to the file name indicates unsaved changes.</li><li>Press <i>Ctrl S</i> to save the work. Notice that the asterisk disappears.</li></ol><h4 id="6.1.2.4_Creating_another_file">6.1.2.4 Creating another file</h4><p>Create another file in the <i>Text Files</i> folder, using the workbench menu this time.</p><ol><li>On the workbench menu, click <b>File > New > File</b>.</li><li>In the <i>New File</i> wizard, expand <i>My Project</i> and then select <i>Text Files</i> as the parent folder.</li><li>Type <code>My Other File</code> as the file name and click <i>Finish</i>.</li><li>Reviewing the contents of the <i>Project Explorer</i> view, which should be like this</li></ol><p><center><div class="thumb middle"><div class="thumbinner" style="width:202px;"><a href="MyProject.bmp" class="image"><img class="thumbimage" width="200" align="middle" border="0" src="MyProject.bmp"/></a></div></div></center></p><h3 id="6.1.3_Exploring_editors_and_views">6.1.3 Exploring editors and views</h3><p>This section demonstrates how to manipulate views and editors.</p><h4 id="6.1.3.1_Maximizing_and_restoring_an_editor">6.1.3.1 Maximizing and restoring an editor</h4><p>Maximize one of the editors to expand the viewable area:</p><ol><li>Double-click the file name on the editor tab for <i>My File</i>.</li><li>Double-click the file name again to restore the editor to its original size.</li></ol><h4 id="6.1.3.2_Tiling_and_restacking_the_editors">6.1.3.2 Tiling and restacking the editors</h4><p>Currently, the editors are stacked one in front of the other. Try tiling them horizontally and vertically:</p><ol><li>Click the <i>My Other File</i> editor tab and drag it to the bottom of the editor pane. Colored frames indicates how the views will be tiled. Drop the editor and notice that the editors are tiled horizontally.</li><li>Drag the <i>My Other File</i> editor tab to the left of the editor pane and release it. Notice that the editors are tiled vertically.</li><li>Restack the editors by dragging one of the editor tabs on top of the other.</li></ol><h4 id="6.1.3.3_Organizing_views">6.1.3.3 Organizing views</h4><p>Try moving a view:</p><ol><li>Drag the title bar of the <i>Outline</i> view onto the title bar of the <i>Project Explorer</i>.</li><li>Experiment by dragging the title bar of the <i>Outline</i> view to various locations within the workbench.</li><li>Return the <i>Outline</i> view to its original place to the lower left of the workbench. It is always possible to return to the default configuration of the active perspective by clicking on <b>Windows > Reset Perspective...</b></li></ol><h4 id="6.1.3.4_Using_view_menus">6.1.3.4 Using view menus</h4><p>Some views has view menus, e.g. <i>Project Explorer</i> view, which is indicated by a down arrow in the upper-right corner of the view. Click this down arrow of the <i>Project Explorer</i> view and review the pull-down menu options specific for this view.</p><h4 id="6.1.3.5_Closing_and_opening_views">6.1.3.5 Closing and opening views</h4><p>If a view does not appear in the workbench, it can be open by using the <b>Window</b> menu:</p><ol><li>Close the <i>Project Explorer</i> view by right-click on the <i>Project Explorer</i> view tab and select <b>Close</b>.</li><li>Click <b>Window > Show View > Other</b> and type <code>Project Explorer</code> in the filter text box.</li><li>Select <i>Project Explorer</i> and click <i>OK</i> which opens the view again.</li></ol><h3 id="6.1.4_Exporting_and_importing_a_project">6.1.4 Exporting and importing a project</h3><p>This section demonstrates how projects can be shared between users and workspaces using the <i>export</i> and <i>import</i> feature.</p><h4 id="6.1.4.1_Exporting_a_project">6.1.4.1 Exporting a project</h4><p>Export <i>My Project</i> to a compressed file:</p><ol><li>Select <b>File > Export...</b> from the workbench menu.</li><li>In the <i>Export</i> wizard, expand <b>General</b>, and then select <b>Archive File</b>. Click <i>Next</i>.</li><li>Check the check box next to <i>My Project</i> in the resource list.</li><li>Click <i>Browse</i> to specify an export destination in the <i>To archive file</i> field. Note the available options for archive formats.</li><li>In the <i>Browse</i> window, select the <i>Desktop</i> as the destination folder and type <code>My Project</code> as the file name. Click <i>OK</i>.</li><li>In the <i>Export</i> wizard, click <i>Finish</i> to perform the export process.</li><li>View the desktop and notice the new compressed (.zip) file.</li></ol><h4 id="6.1.4.2_Removing_the_project_from_the_workspace">6.1.4.2 Removing the project from the workspace</h4><p>Remove <i>My Project</i> from the workspace:</p><ol><li>Right-click <i>My Project</i> in the <i>Project Explorer</i> and select <b>Delete</b> from the context menu.</li><li>In the <i>Delete Resources</i> pop-up window, make sure to check the</li></ol><p><i>Delete project contents on disk</i> check box. Click <i>OK</i>. Note: If this check box is unchecked, the resource will just be deleted from the Workbench, but it will still exist in the workspace. (Notice <i>My Project</i> is no longer listed in the <i>Project Explorer</i>)</p><h4 id="6.1.4.3_Importing_a_project">6.1.4.3 Importing a project</h4><p>Import <i>My Project</i> from a compressed file:</p><ol><li>Select <b>File > Import...</b> from the workbench menu.</li><li>In the <i>Import</i> wizard, expand <b>General</b>, and then select <b>Existing Projects into Workspace</b>. Click <i>Next</i>.</li><li>Click the <b>Select archive file</b> radio button.</li><li>Click the <i>Browse</i> button.</li><li>In the <i>Browse</i> window, browse to the <i>Desktop</i> and select <b>My Project.zip</b> and click <i>Open</i>.</li></ol>#In the <p><i>Import</i> wizard, check the check box next to <i>My Project</i> and click <i>Finish</i> to perform the import process. (Notice <i>My Project</i> is once again listed in the <i>Project Explorer</i>)</p><h3 id="6.1.5_Conclusion">6.1.5 Conclusion</h3><p>The basic features of the Eclipse workbench have now been demonstrated.</p><ul><li>How to view and customize perspectives.</li><li>How to create a project, folder and files.</li><li>How to manipulate editors and views.</li><li>How to export and import projects.</li></ul><h2 id="6.2_Creating_profiles">6.2 Creating profiles</h2><h2 id="6.3_Creating_models_using_Papyrus">6.3 Creating models using Papyrus</h2><h3 id="6.3.1_Use-case_modeling">6.3.1 Use-case modeling</h3><h3 id="6.3.2_Design_modeling">6.3.2 Design modeling</h3><p>This is a tutorial about general class and object modeling using Papyrus.</p><h4 id="6.3.2.1_Create_a_new_UML_project">6.3.2.1 Create a new UML project</h4><p>Create a new UML modeling project as follows:</p><ol><li>If necessary switch to the <i>Papyrus</i> perspective by clicking on <b>Window > Open Perspective > Other</b>. Then choose the <i>Papyrus</i> perspective. If the <i>Papyrus</i> perspective is already active, click on <b>Window > Reset Perspective...</b> to get back to its default configuration.</li><li>Click <b>File > New > Papyrus Project</b>.</li><li>In the <i>New Papyrus Project</i> wizard, name the project <code>My Design Model</code> and click <i>Next</i>.</li><li>Make sure that the radio button <i>UML</i> is selected and click <i>Next</i>.</li><li>Under the section <i>You can load a template</i>, check the box <i>A UML model with basic primitive types (ModelWithBasicTypes)</i> and click on <i>Finish</i>.</li></ol><h4 id="6.3.2.2_Create_new_packages_to_be_used_for_classes">6.3.2.2 Create new packages to be used for classes</h4><p>Create two packages in the model:</p><ol><li>Right-click on the <i>model</i> package in the <i>Model Explorer</i>, select <b>New Child > Create a new Package</b> and select the created package in the <i>Model Explorer</i>.</li><li>In the <i>Properties</i> view type <code>Clients</code> in the the field <i>Name</i>.</li><li>Right-click on the <i>model</i> package in the <i>Model Explorer</i>, select <b>New Child > Create a new Package</b> and select the created package in the <i>Model Explorer</i>.</li><li>In the <i>Properties</i> view type <code>Server</code> in the the field <i>Name</i>.</li></ol><h4 id="6.3.2.3_Create_new_classes">6.3.2.3 Create new classes</h4><p>Create two classes in the <i>Server</i> package. One is called <i>Server1</i> and the other is called <i>DataClass1</i>:</p><ol><li>Right-click on the <i>Server</i> package in the <i>Model Explorer</i>, select <b>New Child > Create a new Class</b> and select the created class in the <i>Model Explorer</i>.</li><li>In the <i>Properties</i> view type <code>Server1</code> in the the field <i>Name</i>.</li><li>Right-click on the <i>Server</i> package in the <i>Model Explorer</i>, select <b>New Child > Create a new Class</b> and select the created class in the <i>Model Explorer</i>.</li><li>In the <i>Properties</i> view type <code>DataClass1</code> in the the field <i>Name</i>.</li></ol><p>Create three different client classes in the <i>Clients</i> package:</p><ol><li>Right-click on the <i>Clients</i> package in the <i>Model Explorer</i>, select <b>New Child > Create a new Class</b> and select the created class in the <i>Model Explorer</i>.</li><li>In the <i>Properties</i> view type <code>Client1</code> in the the field <i>Name</i>.</li><li>Right-click on the <i>Clients</i> package in the <i>Model Explorer</i>, select <b>New Child > Create a new Class</b> and select the created class in the <i>Model Explorer</i>.</li><li>In the <i>Properties</i> view type <code>Client2</code> in the the field <i>Name</i>.</li><li>Right-click on the <i>Clients</i> package in the <i>Model Explorer</i>, select <b>New Child > Create a new Class</b> and select the created class in the <i>Model Explorer</i>.</li><li>In the <i>Properties</i> view type <code>ClientRoot</code> in the the field <i>Name</i>.</li></ol><h4 id="6.3.2.4_Create_new_class_diagrams">6.3.2.4 Create new class diagrams</h4><p>Create two class diagrams in the model:</p><ol><li>Right-click on the <i>model</i> package in the <i>Model Explorer</i>, select <b>New Diagram > Create a new Class Diagram</b> and type <code>Packages</code> in the <i>Enter a new diagram name</i> pop-up window.</li><li>Right-click on the <i>model</i> package in the <i>Model Explorer</i>, select <b>New Diagram > Create a new Class Diagram</b> and type <code>Classes</code> in the <i>Enter a new diagram name</i> pop-up window.</li></ol><h4 id="6.3.2.5_Create_new_operations_and_attributes">6.3.2.5 Create new operations and attributes</h4><ol><li>Right-click on the class <i>DataClass1</i> and select <b>New Child > Create a new Property</b> and select the created attribute in the <i>Model Explorer</i>. </li><li>In the <i>Properties</i> view, type <code>Field1</code> in the field <i>Name</i> and by the <i>Type</i> field click on the <img border="0" src="TypeKey.bmp"/> key and select <i>Integer</i> from the <i>UML Primitive Types</i>. This cause the created attribute to be named <i>Field1</i> and to be of type <i>Integer</i>.</li><li>Follow the above pattern to also create the attributes <i>Field2</i> of type <i>Integer</i>, <i>Field3</i> of type <i>String</i>, and <i>Field4</i> of type <i>String</i> on class <i>DataClass1</i>.</li><li>Create the attributes <i>Attribute2</i> of type <i>String</i>, <i>Attribute4</i> of type <i>Integer</i> and <i>Attribute5</i> of type <i>DataClass1</i> on class <i>Client1</i>.</li><li>Create the attribute <i>Attribute3</i> on class <i>Client2</i>.</li><li>Create the attribute <i>Attribute1</i> on class <i>Server1</i>.</li><li>Create the operation <i>service1</i> on class <i>Server1</i> by right-click on on the class <i>Server1</i> and select <b>New Child > Create a new Operation</b> and select the created operation in the <i>Model Explorer</i>.</li><li>In the <i>Properties</i> view, type <code>service1</code> in the the field <i>Name</i> and by the <i>Owned parameter</i> field click on the <img border="0" src="PlusKey.bmp"/> key.</li><li>In the <i>Create a new parameter</i> pop-up window, type <code>service1return</code> in the <i>Name</i> field, select <i>return</i> from the <i>Direction</i> field drop down list and by the <i>Type</i> field click on the <img border="0" src="TypeKey.bmp"/> key and select <i>Integer</i> from the <i>UML Primitive Types</i>. This causes the return type of the operation to be defined as an integer.</li></ol><h4 id="6.3.2.6_Create_new_relationships_between_classes">6.3.2.6 Create new relationships between classes</h4><p>Create a <i>Dependency</i> relationship between the <i>Clients</i> and the <i>Server</i> packages:</p><ol><li>Open the <i>Diagram Packages</i> diagram by double click on it in the <i>Model Explorer</i></li><li>Drag the <i>Clients</i> package to the class diagram (by click on it and while holding the mouse button down, move the cursor to the editing area in the class diagram editor and release it).</li><li>Drag the <i> Server</i> package to the class diagram.</li><li>Select the <i>Dependency</i> tool from the <i>Edges</i> drawer in the <i>Palette</i>, click on the <i>Clients</i> package and then on the <i>Server</i> package in the class diagram.</li><li>Type <code>Dependency</code> as the name of the relationship.</li></ol><p>Create a <i>Generalization</i> relationship between the classes <i>Client2</i> and <i>Client1</i>, i.e. make <i>Client2</i> a sub-class of <i>Client1</i>:</p><ol><li>Open the <i>Diagram Classes</i> diagram by double click on it in the <i>Model Explorer</i></li><li>Drag the <i>Client1</i> class to the class diagram.</li><li>Drag the <i>Client2</i> class to the class diagram.</li><li>Select the <i>Generalization</i> tool from the <i>Edges</i> drawer in the <i>Palette</i>, click on the <i>Client2</i> class and then on the <i>Client1</i> class in the class diagram.</li></ol><p>Create a <i>Composite</i> relationships between the classes <i>ClientRoot</i> and <i>Client1</i> plus <i>ClientRoot</i> and <i>Client2</i>:</p><ol><li>Continue with the already opened class diagram <i>Diagram Classes</i>.</li><li>Drag the <i>ClientRoot</i> class to the class diagram.</li><li>Select the <i>Association</i> tool from the <i>Edges</i> drawer in the <i>Palette</i>, click on the <i>ClientRoot</i> class and the on the <i>Client1</i> class in the class diagram.</li><li>Select the created association in the class diagram and in the <i>Properties</i> view, rename the association to <code>cr-c1</code>.</li><li>Also in the same <i>Properties</i> view, at the member end, named <i>client1</i>, by the <i>Aggregation</i> field, select <i>composite</i> from the drop down list.</li><li>Select the <i>Association</i> tool from the <i>Edges</i> drawer in the <i>Palette</i>, click on the <i>ClientRoot</i> class and the on the <i>Client2</i> class in the class diagram.</li><li>Select the created association in the class diagram and in the <i>Properties</i> view, rename the association to <code>cr-c2</code>.</li><li>Also in the same <i>Properties</i> view, at the member end, named <i>client2</i>, by the <i>Aggregation</i> field, select <i>composite</i> from the drop down list.</li></ol><h4 id="6.3.2.7_Create_a_new_package_to_be_used_for_objects">6.3.2.7 Create a new package to be used for objects</h4><p>Create a new package in the model:</p><ol><li>Right-click on the <i>model</i> package in the <i>Model Explorer</i>, select <b>New Child > Create a new Package</b> and select the created package in the <i>Model Explorer</i>.</li><li>In the <i>Properties</i> view type <code>Objects</code> in the the field <i>Name</i>.</li></ol><h4 id="6.3.2.8_Create_new_objects">6.3.2.8 Create new objects</h4><p>Create objects (instances of classes) in the <i>Objects</i> package:</p><ol><li>Right-click on the <i>Objects</i> package in the <i>Model Explorer</i>, select <b>New Child > Create a new InstanceSpecification</b> and select the created object (InstanceSpecification) in the <i>Model Explorer</i>.</li><li>In the <i>Properties</i> view type <code>clientObj1</code> in the the field <i>Name</i> and by the <i>Classifier</i> field click on the <img border="0" src="PlusKey.bmp"/> key. In the <i>Classifier</i> window that pops up, browse to the <i>Client2</i> class and click on the <img border="0" src="Arrow.bmp"/> key, which specifies the object's class as shown in figure 11.</li></ol><p><center><div class="thumb middle"><div class="thumbinner" style="width:402px;"><a href="ClassifierPopUp.bmp" class="image"><img class="thumbimage" width="400" align="middle" border="0" src="ClassifierPopUp.bmp"/></a><div class="thumbcaption">Figure 11: The Classifier pop up window</div></div></div></center></p><p>Follow the same pattern to create:</p><ol><li>An object called <i>clientObj2</i> in the <i>Objects</i> package based on class <i>Clent2</i>.</li><li>An object called <i>serverObj1</i> in the <i>Objects</i> package based on class <i>Server1</i>.</li></ol><h4 id="6.3.2.9_Create_a_new_class_diagram">6.3.2.9 Create a new class diagram</h4><p>Create a class diagrams in the model to depicts the created objects:</p><ol><li>Right-click on the <i>model</i> package in the <i>Model Explorer</i>, select <b>New Diagram > Create a new Class Diagram</b> and type <code>Objects</code> in the the <i>Enter a new diagram name</i> pop-up window.</li></ol><h4 id="6.3.2.10_Create_new_relationships_between_objects">6.3.2.10 Create new relationships between objects</h4><p>Create a <i>Dependency</i> relationship between the clients and the server objects:</p><ol><li>Open the <i>Diagram Objects</i> diagram by double click on it in the <i>Model Explorer</i></li><li>Drag the <i>clientObj1</i> object to the class diagram (by click on it and while holding the mouse button down, move the cursor to the editing area in the class diagram editor and release it).</li><li>Drag the <i>clientObj2</i> object to the class diagram</li><li>Drag the <i>serverObj1</i> object to the class diagram.</li><li>Select the <i>Dependency</i> tool from the <i>Edges</i> drawer in the <i>Palette</i>, click on the <i>clientObj1</i> object and then on the <i>serverObj1</i> object in the class diagram. Leave the default name on the relationship.</li><li>Also create a <i>Dependency</i> relationship between the <i>clientObj2 and the </i>serverObj1''.</li></ol><h4 id="6.3.2.11_Conclusion">6.3.2.11 Conclusion</h4><p>In this tutorial the following model was created:</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:402px;"><a href="DesignModelEx1.bmp" class="image"><img class="thumbimage" width="400" align="middle" border="0" src="DesignModelEx1.bmp"/></a><div class="thumbcaption">Figure 12: Two packages on top in the model</div></div></div></center></p><p><center><div class="thumb middle"><div class="thumbinner" style="width:402px;"><a href="DesignModelEx2.bmp" class="image"><img class="thumbimage" width="400" align="middle" border="0" src="DesignModelEx2.bmp"/></a><div class="thumbcaption">Figure 13: Relationships between the client classes</div></div></div></center></p><p><b>Note!</b> The inherited attributes depicted in figure 13 on the <i>Client2</i> class.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:402px;"><a href="ObjectDiagram.bmp" class="image"><img class="thumbimage" width="400" align="middle" border="0" src="ObjectDiagram.bmp"/></a><div class="thumbcaption">Figure 14: Objects in the model and their relationships</div></div></div></center></p><h3 id="6.3.3_RT_modeling">6.3.3 RT modeling</h3><h1 id="7_Papyrus">7 Papyrus</h1><p>Papyrus can be used to do</p><ul><li>General UML modeling.</li><li>UML RT modeling, which is described in the section <a href="#6.3.3_RT_modeling">6.3.3_RT_modeling</a> when the UML RT profile is applied.</li><li>SysML modeling when the SysML profile is applied.</li><li>MARTE modeling when the MARTE profile is applied.</li><li>UML profiles, which is described in the section <a href="#7.10_UML_profiling">UMLprofiling</a> .</li></ul><p>In Papyrus, different UML profiles can be applied. When installing Papyrus, as described in section <a href="#3_Installation">Installation</a> , also the UML, UML RT, SysML and MARTE profiles can be added. When creating a new Papyrus project, the type of Papyrus project is selected. Project types to chose from are SysML, Profile and UML.</p><h2 id="7.1_Papyrus_resources_in_the_workspace">7.1 Papyrus resources in the workspace</h2><p>When modeling in Papyrus, three types of resources are stored in the workspace.</p><table><tr><td><p><div class="thumb middle"><div class="thumbinner" style="width:402px;"><a href="ModelProjResourcesFS.bmp" class="image"><img class="thumbimage" width="400" align="middle" border="0" src="ModelProjResourcesFS.bmp"/></a><div class="thumbcaption">Figure 15: Resources in the file system</div></div></div></p></td><td><p><div class="thumb middle"><div class="thumbinner" style="width:202px;"><a href="ModelProjResourcesPE.bmp" class="image"><img class="thumbimage" width="200" align="middle" border="0" src="ModelProjResourcesPE.bmp"/></a><div class="thumbcaption">Figure 16: Resources in the Project Explorer</div></div></div></p></td></tr></table><ul><li><b>.di</b> file persists the status of the workbench, i.e. which diagrams and views are opened, etc.</li><li><b>.notation</b> file persists the information about the diagrams in the model.</li><li><b>.uml</b> file persists the UML model.</li></ul><p>Note! In this case the model is contained in three files. When working in an industrial context, the model may need to be split up into several fragments in order for several designers to work concurrently with the same model. This is described in section <a href="#7.6_Papyrus_in_a_team_environment">Papyrus in a team environment</a> .</p><h2 id="7.2_The_Papyrus_perspective">7.2 The Papyrus perspective</h2><p>When Papyrus is installed a predefined perspective called <i>Papyrus</i> is made available. This is the perspective to use when modeling with Papyrus. The Papyrus perspective can be customized to the user needs and saved as new perspective ( see section <a href="#4.4_Workbench">Workbench</a> ).</p><h3 id="7.2.1_Project_Explorer_view">7.2.1 Project Explorer view</h3><p>The <i>Project Explorer</i> view is used to browse, select and manipulate resources in the workspace. Projects or working sets are the top level in this view. From the <i>Project Explorer's</i> (right click on the white space) context menu, e.g. new projects can be created.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:202px;"><a href="ProjectExpl.bmp" class="image"><img class="thumbimage" width="200" align="middle" border="0" src="ProjectExpl.bmp"/></a><div class="thumbcaption">Figure 17: The Project Explorer</div></div></div></center></p><p>In some views, as in this case, there is a view specific menu (indicated in Figure 13 with a red ring). Here some settings can be applied for the view, e.g. if the top level should be working sets or projects.</p><h3 id="7.2.2_Model_Explorer_view">7.2.2 Model Explorer view</h3><p>In the <i>Model Explorer</i> view, the model that has been opened in the <i>Project Explorer</i>, can be browsed and edited. Model elements can be added by using the context menu of any existing modeling element, including the model package and packages. Diagrams can also be added by using the context menus. Existing diagrams can be opened in an appropriate editor by just double clicking on the diagram in the <i>Model Explorer</i>.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:202px;"><a href="ModelExpl.bmp" class="image"><img class="thumbimage" width="200" align="middle" border="0" src="ModelExpl.bmp"/></a><div class="thumbcaption">Figure 18: The Model Explorer</div></div></div></center></p><h3 id="7.2.3_Editing_view">7.2.3 Editing view</h3><p>The <i>Editing View</i> is in the middle part of the workbench and here opens different types of editors, depending on the type of resource to edit, e.g. if a class diagram is opened, the class diagram editor will be visible in the <i>Editing View</i>.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:402px;"><a href="EditingView.bmp" class="image"><img class="thumbimage" width="400" align="middle" border="0" src="EditingView.bmp"/></a><div class="thumbcaption">Figure 19: The Editing View</div></div></div></center></p><p>How to use editors is described in section <a href="#7.3_Diagram_editing_in_Papyrus">Editors in Papyrus</a>.</p><h3 id="7.2.4_Outline_view">7.2.4 Outline view</h3><p>The <i>Outline View</i> is connected to the <i>Editing View</i> and gives an overview of what is open in the <i>Editing View</i>. The <i>Outline View</i> may be used to pan the <i>Editing View</i> or to select some information that will be highlighted in the <i>Editing View</i>. The shaded area is the area that is visible in the <i>Editing View</i>.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:202px;"><a href="OutlineView.bmp" class="image"><img class="thumbimage" width="200" align="middle" border="0" src="OutlineView.bmp"/></a><div class="thumbcaption">Figure 20: The Outline View</div></div></div></center></p><h3 id="7.2.5_Properties_view">7.2.5 Properties view</h3><p>The <i>Properties view</i> is a stacked view which is located at the bottom of the workbench and shows the properties of a selected modeling element. The modeling element can be selected in the Model Explorer or in a diagram. The properties are categorized under different tabs located to the left in the <i>Properties view</i>.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="PropertiesView.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="PropertiesView.bmp"/></a><div class="thumbcaption">Figure 21: The Properties View</div></div></div></center></p><p>In this view the properties may be viewed and edited, e.g. rename the operation and change the visibility of the operation.</p><h3 id="7.2.6_Model_Validation_view">7.2.6 Model Validation view</h3><p>From the context menu in the <i>Model Explorer</i> it is possible to validate the entire model or parts of it (for more details see section <a href="#7.7_Model_validation">Model validation</a> . All warnings and errors appear in the <i>Model Validation View</i>, which is a stacked view together with the <i>Properties View</i> and the <i>Search View</i> at the bottom of the workbench.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="ModelValidationView.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="ModelValidationView.bmp"/></a><div class="thumbcaption">Figure 22: The Model Validation View</div></div></div></center></p><p>The model validation constraints are customizable and how to work with it is described in section <a href="#7.7_Model_validation">Model validation</a> .</p><h3 id="7.2.7_Search_view">7.2.7 Search view</h3><p>It is possible to do searches on a selected resource in a specific project or in the entire workspace. When the search is finished, the result appears in the <i>Search View</i>. Details about specifying searches is described in the <a href="#7.8_Searching">Searching</a> section.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="SearchView.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="SearchView.bmp"/></a><div class="thumbcaption">Figure 23: The Search View</div></div></div></center></p><p>The example in Figure 23 shows the result of a model search for <i>Class1</i> in the entire workspace.</p><h2 id="7.3_Diagram_editing_in_Papyrus"><div id="EditorsinPapyrus">7.3 Diagram editing in Papyrus</div></h2><p>To edit diagrams different editors are available in Papyrus. They have the same basic look and feel. When double clicking on some diagram in the <i>Model Explorer</i>, the diagram opens in the editing view. An outline view and a tool palette are also opened. Creating a new diagram in the <i>Model Explorer</i> will also open up a diagram editor together with its tool palette and outline view.</p><h3 id="7.3.1_Diagram_editors">7.3.1 Diagram editors</h3><p>When a diagram editor is opened in Papyrus, three views are opened:</p><ul><li>Editing surface</li><li>Palette</li><li>Outline</li></ul><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="DiagramEditorFieldsPointers.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="DiagramEditorFieldsPointers.bmp"/></a><div class="thumbcaption">Figure 24: Parts of a diagram editor (as an example, the class diagram editor is used)</div></div></div></center></p><p>Figure 24 shows the different parts of a diagram editor. In this case the class diagram editor has been chosen as an example. The <i>Editing surface</i> is where the diagram editing is taken place. The <i>Outline view</i> gives an overview of the entire diagram. The blue shaded part in the <i>Outline view</i> shows what is visible in the editing surface. The <i>Palette</i> contains <i>Drawers</i> and in each drawer there are <i>Tools</i> to be used to add different things into the diagram. In Figure 22, the <i>Nodes</i> drawer is closed and the <i>Edges</i> drawer is opened. In the <i>Edges</i> drawer there are <i>Tools</i> to create different types of edges. By clicking on a drawer, it toggles open and close drawer.</p><h3 id="7.3.2_Basic_tool_techniques">7.3.2 Basic tool techniques</h3><p>Diagrams can be created in different places in the model such as they can be owned by model elements like classes or packages. Diagrams can also be placed on top of the model directly under the model package.</p><h4 id="7.3.2.1_Creating_diagrams">7.3.2.1 Creating diagrams</h4><p>To create a diagram, right click on the model element that should be the owner of the diagram and select <b>New Diagram</b> from the context menu. A new level of menu appears, displaying all types of diagrams that are available to create in this place, e.g. Figure 21 shows the available diagram types that can be created directly on top in the model package.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="NewDiagram.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="NewDiagram.bmp"/></a><div class="thumbcaption">Figure 25: Available diagram types that can be created directly under the model package</div></div></div></center></p><p><b>Note!</b> In Figure 25, no adaptation of Papyrus has taken place, hence all diagram types according pops up.</p><h4 id="7.3.2.2_Scrolling_and_panning_in_diagrams">7.3.2.2 Scrolling and panning in diagrams</h4><p>Scrolling and panning in diagrams can be done by either:</p><ul><li>Use the outline view and click (hold down) and drag the blue shaded area around, which simultaneously pans the editing surface.</li><li>Use the vertical and horizontal scroll bars in the editing surface.</li></ul><h4 id="7.3.2.3_Creating_an_element_in_a_diagram">7.3.2.3 Creating an element in a diagram</h4><p>Elements can be created in a diagram directly, by using a tool from the palette, e.g. to create a class</p><ol><li>Open a class diagram</li><li>Open the nodes drawer</li><li>Click on the class tool</li><li>Click somewhere in the editing surface</li><li>Name the class</li></ol><p>If an element already exists in the model, just click on (hold down) the element in the <i>Model Explorer</i> and drag it to the editing surface. When releasing the mouse key, the modeling element appears in the diagram.</p><h4 id="7.3.2.4_Delete_and_hide">7.3.2.4 Delete and hide</h4><p>In a diagram, elements can be deleted or hided.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:202px;"><a href="ElementContextMenuDiaDelHide.bmp" class="image"><img class="thumbimage" width="200" align="middle" border="0" src="ElementContextMenuDiaDelHide.bmp"/></a><div class="thumbcaption">Figure 26: Context menu of an element in a diagram</div></div></div></center></p><p>Right click on an element in a diagram and do</p><ul><li><b>Delete Selected Element</b> will delete the element from the entire model and also from all diagrams where it was present.</li><li><b>Hide Selected Element</b> will hide the element just in this diagram.</li></ul><p><b>Note!</b> These menu items have short cuts, i.e. instead of using the context menu, just select the element in the diagram and use the <b>Delete</b> or <b>Shift-Delete</b> keys</p><h4 id="7.3.2.5_Formating_and_validating_diagrams">7.3.2.5 Formating and validating diagrams</h4><p>Diagrams can be adjusted and graphically edited to get a nicer look also using the element context menu. From the same context menu it is also possible to validate the model or specific parts of the model.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:302px;"><a href="ElementContextMenuDiaFormat.bmp" class="image"><img class="thumbimage" width="300" align="middle" border="0" src="ElementContextMenuDiaFormat.bmp"/></a><div class="thumbcaption">Figure 27: Example of the Format sub context menu</div></div></div></center></p><p>In Figure 27 several menu items are shown, e.g.:</p><ul><li><b>Validation</b> to validate the model partly or fully</li><li><b>Format</b> to do some advanced formating of the diagram like adjustments, routing, etc. as shown in the sub context menu in Figure 25</li><li><b>Filter</b> to select/unselect parts of symbols that should be visible or not</li></ul><h2 id="7.4_UML_modeling"><div id="UMLmodeling">7.4 UML modeling</div></h2><p>With Papyrus, UML models can be created. This is done using different types of diagrams. Modeling elements can be created in these diagrams or directly in the <i>Model Explorer</i>. Diagrams are created in the <i>Model Explorer</i> and when doing so a diagram editor together with its tool palette and outline view are also opened. Section <a href="#7.3_Diagram_editing_in_Papyrus">Diagram editing in Papyrus</a> describes how to work with diagram editors.</p><p>The most common modeling elements are:</p><ul><li>Package</li><li>Use-case</li><li>Actor</li><li>Class</li><li>Object</li></ul><h3 id="7.4.1_Package">7.4.1 Package</h3><p>A <i>package</i> is a general UML grouping element, comparable to a folder in Windows or a directory in Unix. It is used to bring order in the model. A <i>package</i> may have a semantical meaning (e.g. representing a subsystem) and then a UML stereotype, defined in a applied UML Profile, may be added to it (e.g. << subsystem >>). To create a new <i>package</i>, right click on the owning element, e.g. the model package and from the context menu select <b>New Child > Create a new Package</b></p><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="NewPackage.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="NewPackage.bmp"/></a><div class="thumbcaption">Figure 28: Create a new Package</div></div></div></center></p><h3 id="7.4.2_Use-case">7.4.2 Use-case</h3><p>A <i>use-case</i> is a functionality in the system. A <i>use-case</i> is a model of the dialogue between actors and the system. It should return a result of measurable value to at least one actor. A <i>use-case</i> is initiated by an actor to invoke a certain functionality in the system. -A <i>use-case</i> is a complete and meaningful flow of events. -Taken together, all <i>use-cases</i> constitute all possible ways of using the system.</p><p>To create a new <i>use-case</i>, right click on the owning element, e.g. a package and from the context menu select <b>New Child > Create a new UseCase</b></p><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="NewUseCase.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="NewUseCase.bmp"/></a><div class="thumbcaption">Figure 29: Create a new use-case</div></div></div></center></p><h3 id="7.4.3_Actor">7.4.3 Actor</h3><p>An <i>actor</i> is something external to the system, but interacts with it. An <i>actor</i> may be a human being or another system. It may be active or passive. An <i>actor</i> interacts (active <i>actor</i>) or receive (passive <i>actor</i>) information from one or several use-cases.</p><p>To create a new <i>actor</i>, right click on the owning element, e.g. a package and from the context menu select <b>New Child > Create a new Actor</b></p><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="NewActor.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="NewActor.bmp"/></a><div class="thumbcaption">Figure 30: Create a new actor</div></div></div></center></p><h3 id="7.4.4_Class">7.4.4 Class</h3><p>A <i>class</i> is an extensible template for creating objects, providing initial values for state (member variables, attributes) and implementations of behavior (member functions, methods, operations). </p><p>Collectively attributes define the structure of a <i>class</i>. A class may have any number of attributes or none. Attributes are typically implemented as variables. An attribute has a type, which tells us what kind of attribute it is. Typical types of attributes are integer, Boolean, real, and enumeration. These types are called primitive types. More complex types are defined by other <i>classes</i>.</p><p>Collectively operations define the behavior of the <i>class</i>. A <i>class</i> may have any number of operations or none. Operations are implemented as functions or procedures.</p><p>To create a new <i>class</i>, right click on the owning element, e.g. a package and from the context menu select <b>New Child > Create a new Class</b></p><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="NewClass.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="NewClass.bmp"/></a><div class="thumbcaption">Figure 31: Create a new class</div></div></div></center></p><h4 id="7.4.4.1_Attributes_on_classes">7.4.4.1 Attributes on classes</h4><p>When a <i>class</i> is created, <i>attributes</i> can be added to it by using the context menu of the <i>class</i>. To create a new <i>attribute</i> on the a <i>class</i> select <b>New Child > Create a new Property</b> from its context menu.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="NewAttribute.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="NewAttribute.bmp"/></a><div class="thumbcaption">Figure 32: Create a new attribute</div></div></div></center></p><p>The visibility, type and default value of the attribute are set in the properties view when the attribute is selected.</p><h4 id="7.4.4.2_Operations_on_classes">7.4.4.2 Operations on classes</h4><p>When a <i>class</i> is created, <i>operations</i> can be added to it by using the context menu of the <i>class</i>. To create a new <i>operation</i> on the a <i>class</i> select <b>New Child > Create a new Operation</b> from its context menu.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="NewOperation.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="NewOperation.bmp"/></a><div class="thumbcaption">Figure 33: Create a new operation</div></div></div></center></p><p>The visibility, arguments and return type of the operation are set in the properties view when the operation is selected.</p><p>Regarding the arguments and return type of the an operation, select the <img border="0" src="PlusKey.bmp"/> key by the <i>Owned parameter</i> field.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:602px;"><a href="ClassOp1.bmp" class="image"><img class="thumbimage" width="600" align="middle" border="0" src="ClassOp1.bmp"/></a><div class="thumbcaption">Figure 34: Create a new argument</div></div></div></center></p><p>Then the following window pops up and from the drop list in the <i>Direction</i> field, select the direction of the argument. In the <i>Name</i> field the name of the argument is written and the type is defined in the <i>Type</i> field.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:602px;"><a href="ClassOp2.bmp" class="image"><img class="thumbimage" width="600" align="middle" border="0" src="ClassOp2.bmp"/></a><div class="thumbcaption">Figure 35: Select the argument´s direction</div></div></div></center></p><p>The direction <i>return</i> defines the return type of the operation. Only one argument can have the return direction.</p><h3 id="7.4.5_Object">7.4.5 Object</h3><p>An <i>object</i> is an instance of a class. In UML it is called and <i>InstanceSpecification</i>, which is a more general term since it can be used for instances of other classifiers than classes. </p><p>To create a new <i>object</i>, right click on the owning element, e.g. a package and from the context menu select <b>New Child > Create a new InstanceSpecification</b></p><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="NewObject.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="NewObject.bmp"/></a><div class="thumbcaption">Figure 36: Create a new object</div></div></div></center></p><p>The class to be instanciated is selected by clicking on the <img border="0" src="PlusKey.bmp"/> key by the <i>Classifier</i> field in the <i>Properties</i> view of the <i>InstanceSpecification</i>. This will open the <i>Classifier</i> pop-up window (figure 37), where the class to be used is selected.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="ClassifierPopup.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="ClassifierPopup.bmp"/></a><div class="thumbcaption">Figure 37: Classifier pop-up window</div></div></div></center></p><h3 id="7.4.6_Relationships">7.4.6 Relationships</h3><p>There are different types of relationships that can be used in diagrams, hence in the model between different modeling elements.</p><pre> <div class="thumb middle"><div class="thumbinner" style="width:302px;"><a href="Relationships.bmp" class="image"><img class="thumbimage" width="300" align="middle" border="0" src="Relationships.bmp"/></a></div></div> -</pre><p>Navigability can be unidirectional or bidirectional for <i>Association</i>, <i>Aggregation</i> and <i>Composition</i>.</p><p><i>Association</i> specifies peer-to-peer relationships between model elements, e.g. if a Class-x has an attribute of type Class-y, it can be viewed in a class diagram as and <i>Association</i> between Class-x and Class-y.</p><p><i>Aggregation</i> is used to model a whole/part relationship between model elements. The part element can exist without the whole. <i>Aggregation</i> causes the generated code to contain the aggregate either by reference or by value, depending on the details of the relationship. E.g. to model an aggregation, the aggregate (Department) has an aggregation association to its constituent parts (Employee). A hollow diamond is attached to the end of an association path on the side of the aggregate (the whole) to indicate aggregation.</p><p><i>Composition</i> is an aggregation with strong ownership, i.e. when the container is destroyed, all of its composite objects are destroyed as well.</p><p><i>Dependency</i> is a relationship in which one model element uses another. <i>Dependency</i> may exist between classes if a message is sent from one class to the other or if one class mentions the other as a parameter to an operation. <i>Dependency</i> may exist between packages if one package is dependent on another.</p><p>A <i>Dependency</i> relationship causes a class to be generated with inclusions or references to another class.</p><p>A <i>Generalization</i> relationship causes a class to be generated as a subclass of another class.</p><p>The <i>Realizes</i> relationship specifies that, e.g. an implementation realizes a specification. The <i>Realizes</i> relationship does not affect the code.</p><p>To create a relationship between two modeling elements, use the tool palette in the diagram editor, e.g. to create an <i>Association</i> between two classes, select the <i>Association</i> tool in the tool palette, click on the source element and then click on the destination element as described in figure 38.</p><p><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="ClassDiagramEditorNewAss.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="ClassDiagramEditorNewAss.bmp"/></a><div class="thumbcaption">Figure 38: Create a new Association</div></div></div></p><p>In the <i>Edges</i> drawer in the tool palette, all available relationships are shown. To create a <i>Generalization</i> relationship, select the <i>Generalization</i> tool from the tool palette and follow the same procedure as described.</p><p>The <i>Aggregation</i> and the <i>Composition</i> relationships are a special kind of an <i>Association</i> relationship. To create any of these, an <i>Association</i> relationship needs first to be created. Then select the created <i>Association</i> and in the properties view, change the <i>Aggregation</i> field at the appropriate end of the <i>Association</i> to <i>shared</i>(if an <i>Aggregation</i> is desired) or to <i>composite</i> (if a <i>Composition</i> is desired). Figure 39 shows how to do it.</p><p><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="ClassDiagramEditorNewAgg.bmp" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="ClassDiagramEditorNewAgg.bmp"/></a><div class="thumbcaption">Figure 39: Create a new Association</div></div></div></p><p>When the <i>Association</i> is created, the <i>Aggregation</i> field is set to <i>none</i> by default. When doing the change at the destination end (as in figure 35), the diamond shows up at the source end of the relationship.</p><h3 id="7.4.7_Diagrams">7.4.7 Diagrams</h3><p>UML has many different types of diagrams to capture all different aspects of a system. To capture and refine requirements, diagrams related to use-cases are used. To specify the architecture and design, diagrams related to classes and packages are used. To specify the implementation, state and activity diagrams are used, etc.</p><p>The different diagrams in UML 2 are shown in figure 40 and here they are structured after diagram type. In the following of this section they are organized how they are used. </p><p><center><div class="thumb middle"><div class="thumbinner" style="width:502px;"><a href="UMLdiagrams.png" class="image"><img class="thumbimage" width="500" align="middle" border="0" src="UMLdiagrams.png"/></a><div class="thumbcaption">Figure 40: UMl 2 diagram types</div></div></div></center></p><p><b>Note!</b> In Papyrus class diagrams are also used as object diagrams.</p><h4 id="7.4.7.1_Diagrams_related_to_use-cases">7.4.7.1 Diagrams related to use-cases</h4><p>When working with requirement capture and refinement, use-case modeling is used and any or all of the following diagrams can be used:</p><ul><li>Use-case diagram</li><li>Activity diagram</li><li>Interaction diagram<ul><li>Sequence diagram</li><li>Collaboration diagram</li></ul></li></ul><p>A <i>use-case diagram</i> describe how different <i>Actors</i> use different functionality of the system. Implicitly, it also define the system boundary, since it shows what should be performed by the system and what exists outside the system. The elements used in <i>use-case diagrams</i> are:</p><ul><li><b>Actors</b> interact with, but are outside the system.</li><li><b>Use-cases</b> are some functionality that are performed by the system.</li><li><b>Relationships</b> between elements.</li></ul><p>A diagram may depict all or some of the use-cases of a system.</p><p><center><div class="thumb middle"><div class="thumbinner" style="width:602px;"><a href="UCdiagram.bmp" class="image"><img class="thumbimage" width="600" align="middle" border="0" src="UCdiagram.bmp"/></a><div class="thumbcaption">Figure 41: Use-case diagram</div></div></div></center></p><p>A <i>use-case</i> interacts with an <i>actor</i> and perform something useful for that <i>actor</i>. A <i>use-case</i> exist because of its main flow, but all odd cases and error situations have to be specified. A <i>use-case</i> has a black box and a white box view. The black box view is preferably described in plain text or by using activity diagrams. The white box view is described by one or several sequence diagrams.</p><p>All <i>use-cases</i> together span the entire functionality of the system. <i>Actors</i>, <i>use-cases</i> and <i>use-case diagrams</i> are owned by packages (general UML packages or model packages).</p><p>To create a <i>use-case diagram</i>, right click on the owning package and select <b>New Diagram > Create a new UseCase Diagram</b> from its context menu.</p><p>An <i>activity diagram</i> is a kind of behavioral diagram and shows flow of control from activity to activity. It is used to specify a use-case black box view. It can also be used to specify a flow chart for a class operation.</p><p>The main elements in an <i>activity diagram</i> are:</p><ul><li>Initial and end states</li><li>Activities</li><li>States</li><li>Transitions</li><li>Synchronization lines</li><li>Decisions</li><li>Partitions</li></ul><p><center><div class="thumb middle"><div class="thumbinner" style="width:602px;"><a href="ActivityDiagram.bmp" class="image"><img class="thumbimage" width="600" align="middle" border="0" src="ActivityDiagram.bmp"/></a><div class="thumbcaption">Figure 42: Activity diagram</div></div></div></center></p><p>The <i>activity diagram</i> is preferably used to specify the black box behavior of a use-case instead of using plain text. It may also be used to specify a flow chart for a class operation.<i>Activity diagrams</i> are owned by use-cases or classes. </p><p>To create an <i>activity diagram</i>, right click on the owning use-case or class and select <b>New Diagram > Create a new Activity Diagram</b> from its context menu.</p><p>Interaction diagrams are used to specify how different modeling elements interacts. Here two types are described, the <i>sequence diagram</i> and the <i>communication diagram</i>.</p><p>A <i>sequence diagram</i> describes the interactions between elements as a time ordered set of messages. One or several <i>sequence diagrams</i> are used to specify the white box view of a use-case.</p><p>Sequences involving collaborating elementsThe main elements in a <i>sequence diagram</i> are:</p><ul><li>Class instances (objects)</li><li>Life lines</li><li>Messages</li><li>Combined fragments</li></ul><p><center><div class="thumb middle"><div class="thumbinner" style="width:602px;"><a href="SequenceDiagram.bmp" class="image"><img class="thumbimage" width="600" align="middle" border="0" src="SequenceDiagram.bmp"/></a><div class="thumbcaption">Figure 43: Sequence diagram</div></div></div></center></p><p>The example (Figure 43) describes Interaction1, two objects (instances of Class1 and Class2) are created and interacts by messages. The time goes down along the life lines. In the bottom, there is a combined fragment of type "Ref" which is a reference to another interaction, Interaction2, meaning that the sequences in that interaction are executed.There are a lot of combined fragment types, e.g. type "Loop" specifies a loop, type "Alt" specifies alternatives, etc. All combined fragment types are defined in <a href="http://www.omg.org/spec/UML/2.4.1/">Unified Modeling Language (UML) version 2.4.1</a></p><p><i>Sequence diagrams</i> are owned by use-cases or communication diagrams (see below). </p><p>To create a <i>sequence diagram</i>, right click on the owning use-case or communication diagram and select <b>New Diagram > Create a new Sequence Diagram</b> from its context menu.</p><p><i>Communication diagrams</i> show the lines of communication among a set of objects to accomplish a specific purpose. They act as the framework for sequence diagrams and define access paths between elements. i.e. <i>communication diagrams</i> are used to specify a use-case's white box communication channels between elements in the system.</p><p>The main elements in a <i>collaboration diagram</i> are:</p><ul><li>Class instances (objects)</li><li>Access paths</li><li>Messages</li></ul><p><center><div class="thumb middle"><div class="thumbinner" style="width:602px;"><a href="CommunicationDiagram.bmp" class="image"><img class="thumbimage" width="600" align="middle" border="0" src="CommunicationDiagram.bmp"/></a><div class="thumbcaption">Figure 44: Communication diagram</div></div></div></center></p><p>The example (Figure 44) describes access paths between objects and which messages are passed in these paths.<i>Communication diagrams</i> are owned by use-cases. </p><p>To create a <i>communication diagram</i>, right click on the owning use-case and select <b>New Diagram > Create a new Communication Diagram</b> from its context menu.</p><h4 id="7.4.7.2_Diagrams_related_to_classes">7.4.7.2 Diagrams related to classes</h4><p>When modeling classes, any or all of the following diagrams may be used:</p><ul><li><i>Class diagrams</i></li><li><i>Composite structure diagrams</i></li><li><i>State diagrams</i></li></ul><p>As described above, activity diagrams may also be used to specify a flowchart for a class operation.</p><p><i>Class diagrams</i> depict static views of the system. A <i>class diagram</i> may represent all or part of the class structure of a system. Typically there are many <i>class diagrams</i> in a model. Usually one or many <i>class diagrams</i> are used to specify the inheritance structure in the system. <i>Class diagrams</i> may also be used to define dependency rules between packages.</p><p>The main elements in a <i>class diagram</i> are:</p><ul><li>Packages</li><li>Classes</li><li>Relationships</li></ul><p><center><div class="thumb middle"><div class="thumbinner" style="width:602px;"><a href="ClassDiagram.bmp" class="image"><img class="thumbimage" width="600" align="middle" border="0" src="ClassDiagram.bmp"/></a><div class="thumbcaption">Figure 45: Class diagram</div></div></div></center></p><p>The example (Figure 45) shows a <i>class diagram</i> used to specify an inheritance structure between classes. Note: The <i>Generalization</i> relationship and the indication of the inherited attributes in Class1 and Class2.</p><p><i>Class diagrams</i> are owned by ordinary UML packages or model packages. </p><p>To create a <i>class diagram</i>, right click on the owning package and select <b>New Diagram > Create a new Class Diagram</b> from its context menu.</p><p>The <i>composite structure diagram</i> specifies structure classes contents, i.e. how the class uses <i>roles</i> (instances from other classes) and how they are connected to fulfill its responsibility.</p><p>The main elements in a <i>composite structure diagram</i> are:</p><ul><li>Contained roles (instances of classes)</li><li>Ports (interface objects)</li><li>Connectors</li></ul><p><center><div class="thumb middle"><div class="thumbinner" style="width:602px;"><a href="CompositeStructure.bmp" class="image"><img class="thumbimage" width="600" align="middle" border="0" src="CompositeStructure.bmp"/></a><div class="thumbcaption">Figure 46: Composite structure diagram</div></div></div></center></p><p>The example (Figure 46) shows a <i>composite structure diagram</i> used to specify the structural contents of Class4. Note: Class4 uses one instance (class2) of Class2 and one instance (class3) of Class3 and they are connected between Class2/Port1 and Class3/Port2.</p><p><i>Composite structure diagrams</i> are owned by structured classes. </p><p>To create a <i>composite structure diagram</i>, right click on the owning class and select <b>New Diagram > Create a new Composite Structure Diagram</b> from its context menu.</p><p>The <i>state machine diagram</i> specifies the behavior of a class. It is used when the class is state rich, i.e. has an event driven behavior. If the class has no states, activity diagrams can be used.</p><p>The main elements in a <i>state machine diagram</i> are:</p><ul><li>States</li><li>Transitions</li><li>Effect code</li><li>Triggering events</li><li>Pseudo states, e.g. initial, final and choice points</li></ul><p><center><div class="thumb middle"><div class="thumbinner" style="width:602px;"><a href="StateDiagram.bmp" class="image"><img class="thumbimage" width="600" align="middle" border="0" src="StateDiagram.bmp"/></a><div class="thumbcaption">Figure 47: State machine diagram</div></div></div></center></p><p>The example (Figure 47) shows a <i>state machine diagram</i> that has an initial pseudo state, three states and transitions between them. On each transition (except for initialize), a <i>triggering event</i> is specified, which defines the event that makes the transition to be taken. Transitions and states may have effect code, which specify detailed behavior to be executed when an associated transition is taken.</p><p><i>State machine diagrams</i> are owned by classes. </p><p>To create a <i>state machine diagram</i>, right click on the owning class and select <b>New Diagram > Create a new State Machine Diagram</b> from its context menu.</p><h2 id="7.5_UML_RT_modeling"><div id="UMLRTmodeling">7.5 UML RT modeling</div></h2><p>When creating models UML is used. Since UML is general-purpose modeling language in the field of software engineering, it is possible to adapt UML to specific domains. This is done by creating and applying UML profiles. When using UML for RT modeling with Capsules and Protocols, the UML RT profile is applied. When a profile is applied we can say that Papyrus has been specialized. There is a specific use-case in Papyrus to develop UML profiles and when doing so a domain specific modeling language is defined. This use-case is described in section <a href="#7.10_UML_profiling">UML profiling</a> in this user guide.</p><h3 id="7.5.1_Additional_modeling_elements">7.5.1 Additional modeling elements</h3><h4 id="7.5.1.1_Capsule_class">7.5.1.1 Capsule class</h4><h4 id="7.5.1.2_Protocol_class">7.5.1.2 Protocol class</h4><h3 id="7.5.2_Using_C.2B.2B_in_a_model">7.5.2 Using C++ in a model</h3><h3 id="7.5.3_C.2B.2B_service_library">7.5.3 C++ service library</h3><h4 id="7.5.3.1_Sending_messages">7.5.3.1 Sending messages</h4><h3 id="7.5.4_Transformation_from_model_to_code">7.5.4 Transformation from model to code</h3><h3 id="7.5.5_Edit_the_generated_code">7.5.5 Edit the generated code</h3><h3 id="7.5.6_Compiling_and_linking_the_generated_code">7.5.6 Compiling and linking the generated code</h3><h3 id="7.5.7_Using_external_libraries">7.5.7 Using external libraries</h3><h3 id="7.5.8_Running_the_system">7.5.8 Running the system</h3><h2 id="7.6_Papyrus_in_a_team_environment"><div id="Papyrusinateamenvironment">7.6 Papyrus in a team environment</div></h2><h3 id="7.6.1_Model_fragmentation">7.6.1 Model fragmentation</h3><h3 id="7.6.2_Source_configuration_management">7.6.2 Source configuration management</h3><h3 id="7.6.3_Compare_and_Merge">7.6.3 Compare and Merge</h3><h2 id="7.7_Model_validation"><div id="Modelvalidation">7.7 Model validation</div></h2><h3 id="7.7.1_Object_Constrain_Language_.28OCL.29">7.7.1 Object Constrain Language (OCL)</h3><h3 id="7.7.2_Defining_constraints_using_OCL">7.7.2 Defining constraints using OCL</h3><h2 id="7.8_Searching"><div id="Searching">7.8 Searching</div></h2><h2 id="7.9_Sample_models">7.9 Sample models</h2><p>In the Papyrus installation directory There are several sample models</p><h3 id="7.9.1_Class_model_with_inheritance">7.9.1 Class model with inheritance</h3><h3 id="7.9.2_Send_and_receive_data">7.9.2 Send and receive data</h3><h3 id="7.9.3_Interprocess_communication">7.9.3 Interprocess communication</h3><h2 id="7.10_UML_profiling"><div id="UMLprofiling">7.10 UML profiling</div></h2><p>TBD include the information in the user guide "About UML profiling"</p><h1 id="8_Support">8 Support</h1><p>To report bugs, suggest improvements, view the status of the Papyrus project, discuss different Papyrus subjects, etc. please use the following references:</p><ul><li><a href="http://www.eclipse.org/papyrus/">The Papyrus project home page</a></li><li><a href="http://www.eclipse.org/forums/index.php/f/121/">The Papyrus discussion forum</a></li><li>Proposals for Papyrus improvements</li><li><a href="https://bugs.eclipse.org/bugs/buglist.cgi?query_format=advanced&short_desc_type=allwordssubstr&short_desc=&classification=Modeling&product=MDT.Papyrus&component=Core&long_desc_type=allwordssubstr&long_desc=&bug_file_loc_type=allwordssubstr&bug_file_loc=&status_whiteboard_type=allwordssubstr&status_whiteboard=&keywords_type=allwords&keywords=&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&emailtype1=exact&email1=&emailtype2=substring&email2=&bugidtype=include&bug_id=&votes=&chfieldfrom=&chfieldto=Now&chfieldvalue=&cmdtype=doit&order=Reuse%20same%20sort%20as%20last%20time&field0-0-0=noop&type0-0-0=noop&value0-0-0=">Bugzilla_to_report_bugs</a></li></ul><h1 id="9_References">9 References</h1><ol><li><a href="http://www.eclipse.org/">eclipse.org</a></li><li><a href="http://www.eclipse.org/modeling/emf/">EMF model</a></li><li><a href="http://www.eclipse.org/downloads/">Eclipse download page</a></li><li><a href="http://www.omg.org/spec/UML/2.4.1/">Unified Modeling Language (UML) version 2.4.1</a></li><li><a href="http://www.omg.org/spec/SysML/">System Modeling Language</a></li><li><a href="http://www.omg.org/omgmarte/Specification.htm/">Modeling and Analysis of Real-Time and Embedded systems</a></li></ol></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PapyrusStarterGuide.mediawiki b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PapyrusStarterGuide.mediawiki index 5b96dc2f7b0..d043edfc408 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PapyrusStarterGuide.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PapyrusStarterGuide.mediawiki @@ -45,7 +45,7 @@ When ''Eclipse Standard'' is installed, go to '''Help > Install New Software' '''Note!''' In some industrial environments, a proxy has to be used instead of this type of direct URL to the Eclipse web-site. To configure Eclipse to use a proxy is done under '''Windows > Preferences''' and '''General > Network Connections'''
-<center>[[File:InstallNewSoftware.bmp|thumb|center|thumb|564px|Figure 1: Install New Software wizard]]</center>
+<center>[[Image:images/InstallNewSoftware.bmp|thumb|center|thumb|564px|Figure 1: Install New Software wizard]]</center>
In the ''Name'' column of the wizard, scroll down to ''Modeling'' and expand to the next level. Under ''Modeling'', select ''Papyrus UML'' and follow the installation wizard to complete the installation.
@@ -55,7 +55,7 @@ When Eclipse is restarted, the environment is now ready for UML modeling. After installation of the basic Papyrus feature, go to '''Help > Install Papyrus Additional Components'''. In the wizard that pops up, select the needed additional Papyrus components, e.g. to be able to do UML RT modeling, the ''Real Time'' component is needed. It is also recommended to install the ''Diagram Stylesheets'' and ''Papyrus Compare'' components. Follow the installation wizard to complete the installation.
-<center>[[File:InstallPapyrusComp.bmp|thumb|center|thumb|437px|Figure 2: The Install Papyrus Additional Components wizard]]</center>
+<center>[[Image:images/InstallPapyrusComp.bmp|thumb|center|thumb|437px|Figure 2: The Install Papyrus Additional Components wizard]]</center>
= 4 Eclipse =
@@ -67,19 +67,19 @@ The Eclipse framework has a plug-in architecture, where plug-ins can be grouped The plug-in architecture applies also for all subsystems. A plug-in is the smallest unit of Eclipse Platform functionality that can be developed and delivered separately. Usually, a small tool is written as a single plug-in, whereas a complex tool has its functionality split across several plug-ins. Except for a small kernel known as the Platform Runtime, all of the Eclipse Platform's functionality is located in plug-ins. Plug-ins can be grouped into features.
-<center>[[File:EclipseArchitecture.bmp|center|thumb|500px|Figure 3: The Eclipse architecture]]</center>
+<center>[[Image:images/EclipseArchitecture.bmp|center|thumb|500px|Figure 3: The Eclipse architecture]]</center>
Plug-ins are coded in Java. A typical plug-in consists of Java code in a JAR (Java Archive) library, some read-only files, and other resources such as images, Web templates, message catalogs, native code libraries, and so on. Some plug-ins do not contain code at all. One such example is a plug-in that contributes online help in the form of HTML pages. A single plug-in’s code libraries and read-only content are located together in a directory in the file system, or at a base URL on a server. There is also a mechanism that permits a plug-in to be synthesized from several separate fragments, each in their own directory or URL. This is the mechanism used to deliver separate language packs for an internationalized plug-in.
Each plug-in has a manifest file declaring its interconnections to other plug-ins. The interconnection model is simple: a plug-in declares any number of named extension points, and any number of extensions to one or more extension points in other plug-ins.
-<center>[[File:Feature-Plug-in.bmp|center|thumb|290px|Figure 4: Plug-ins and Features]]</center>
+<center>[[Image:images/Feature-Plug-in.bmp|center|thumb|290px|Figure 4: Plug-ins and Features]]</center>
== <div id="Workspace">4.2 Workspace</div> ==
The workspace is located in the file-system and is the place where Eclipse resources (files, folders and projects) are stored. When Eclipse is started, a pop-up window appears, where a workspace should be selected. One instance of Eclipse is connected to one workspace.
-<center>[[File:WorkspacePopup.bmp|center|thumb|593px|Figure 5: Pop-up window to select the workspace]]</center>
+<center>[[Image:images/WorkspacePopup.bmp|center|thumb|593px|Figure 5: Pop-up window to select the workspace]]</center>
In the file system all resources are stored in the selected workspace and in the same hierarchical structure as in the ''Project Explorer''.
@@ -97,15 +97,15 @@ The workbench is the Eclipse user interface and is used to navigate, view, and e The first time Eclipse is started, after the installation, a ''Welcome'' page is presented. Take a few minutes to explore the product overview and getting started information that is located here.
-<center>[[File:WelcomePage.bmp|center|thumb|480px|Figure 6: The Eclipse welcome page]]</center>
+<center>[[Image:images/WelcomePage.bmp|center|thumb|480px|Figure 6: The Eclipse welcome page]]</center>
To return to the ordinary workbench, just click on the workbench icon up to the right. When starting Eclipse, subsequent times, the workbench appears directly. To visit the welcome page at any time, just select '''Help > Welcome'''.
The title bar of the workbench window and the little Papyrus icon to the right indicates which ''perspective'' is active. In this example, the Papyrus ''perspective'' is in use. The ''Project Explorer'' and the ''Model Explorer, Outline, Properties'' views, etc. are open, along with a ''Class Diagram'' editor and its tool palette.
-<center>[[File:Workbench.bmp|center|thumb|512px|Figure 7: The Papyrus perspective in the workbench]]</center>
+<center>[[Image:images/Workbench.bmp|center|thumb|512px|Figure 7: The Papyrus perspective in the workbench]]</center>
-It is easy to toggle between perspectives by clicking on some shown ''perspective'' in top of the right hand corner or open a new one by clicking on the ''Open Perspective'' icon [[File:IkonOpenPerspective.png]] and browse to the ''perspective'' to open. It is also possible to reorganize a ''perspective'', open/close ''views'', customize menus, etc. and then save the ''perspective'' with a new name by '''Window > Save Perspective As ...'''.
+It is easy to toggle between perspectives by clicking on some shown ''perspective'' in top of the right hand corner or open a new one by clicking on the ''Open Perspective'' icon [[Image:images/IkonOpenPerspective.png]] and browse to the ''perspective'' to open. It is also possible to reorganize a ''perspective'', open/close ''views'', customize menus, etc. and then save the ''perspective'' with a new name by '''Window > Save Perspective As ...'''.
=== 4.4.1 Views ===
@@ -127,7 +127,7 @@ In the workbench figure, above, also ''stacked views'' appear, e.g. ''Properties To customize the settings for the Eclipse workbench and the installed features, the preference window is used. Use '''Windows > Preferences''' to open it, e.g. under '''General > Keys''' in the preference window there are shortcuts and keys defined for the user interface. Here they can be redefined or own sets could be defined.
-<center>[[File:Preferences.bmp|center|thumb|556px|Figure 8: The preference window]]</center>
+<center>[[Image:images/Preferences.bmp|center|thumb|556px|Figure 8: The preference window]]</center>
The preference window pages can be searched using the filter function. To filter by matching the page title, simply type the name of the page and the available pages will be presented below.
@@ -139,9 +139,9 @@ Projects can be shared between workspaces by using project import and export, wh {|
|
-[[File:ImportWiz.bmp|center|thumb|420px|Figure 9: Import wizard]]
+[[Image:images/images/ImportWiz.bmp|center|thumb|420px|Figure 9: Import wizard]]
|
-[[File:ExportWiz.bmp|center|thumb|538px|Figure 10: Export wizard]]
+[[Image:images/images/ExportWiz.bmp|center|thumb|538px|Figure 10: Export wizard]]
|}
When importing a project into the used workspace, it can be copied by checking the box ''Copy ...'' in the import wizard. If this check box is unchecked, there will just be a reference to the other workspace and when editing that project, it will be edited in its original place. Be aware of that when doing so, several instances of Eclipse may edit the same resource.
@@ -236,7 +236,7 @@ Create another file in the ''Text Files'' folder, using the workbench menu this # Type <code>My Other File</code> as the file name and click ''Finish''.
# Reviewing the contents of the ''Project Explorer'' view, which should be like this
-<center>[[File:MyProject.bmp|center|thumb|200px]]</center>
+<center>[[Image:images/MyProject.bmp|center|thumb|200px]]</center>
=== 6.1.3 Exploring editors and views ===
@@ -380,14 +380,14 @@ Create two class diagrams in the model: ==== 6.3.2.5 Create new operations and attributes ====
# Right-click on the class ''DataClass1'' and select '''New Child > Create a new Property''' and select the created attribute in the ''Model Explorer''.
-# In the ''Properties'' view, type <code>Field1</code> in the field ''Name'' and by the ''Type'' field click on the [[File:TypeKey.bmp]] key and select ''Integer'' from the ''UML Primitive Types''. This cause the created attribute to be named ''Field1'' and to be of type ''Integer''.
+# In the ''Properties'' view, type <code>Field1</code> in the field ''Name'' and by the ''Type'' field click on the [[Image:images/TypeKey.bmp]] key and select ''Integer'' from the ''UML Primitive Types''. This cause the created attribute to be named ''Field1'' and to be of type ''Integer''.
# Follow the above pattern to also create the attributes ''Field2'' of type ''Integer'', ''Field3'' of type ''String'', and ''Field4'' of type ''String'' on class ''DataClass1''.
# Create the attributes ''Attribute2'' of type ''String'', ''Attribute4'' of type ''Integer'' and ''Attribute5'' of type ''DataClass1'' on class ''Client1''.
# Create the attribute ''Attribute3'' on class ''Client2''.
# Create the attribute ''Attribute1'' on class ''Server1''.
# Create the operation ''service1'' on class ''Server1'' by right-click on on the class ''Server1'' and select '''New Child > Create a new Operation''' and select the created operation in the ''Model Explorer''.
-# In the ''Properties'' view, type <code>service1</code> in the the field ''Name'' and by the ''Owned parameter'' field click on the [[File:PlusKey.bmp]] key.
-# In the ''Create a new parameter'' pop-up window, type <code>service1return</code> in the ''Name'' field, select ''return'' from the ''Direction'' field drop down list and by the ''Type'' field click on the [[File:TypeKey.bmp]] key and select ''Integer'' from the ''UML Primitive Types''. This causes the return type of the operation to be defined as an integer.
+# In the ''Properties'' view, type <code>service1</code> in the the field ''Name'' and by the ''Owned parameter'' field click on the [[Image:images/PlusKey.bmp]] key.
+# In the ''Create a new parameter'' pop-up window, type <code>service1return</code> in the ''Name'' field, select ''return'' from the ''Direction'' field drop down list and by the ''Type'' field click on the [[Image:images/TypeKey.bmp]] key and select ''Integer'' from the ''UML Primitive Types''. This causes the return type of the operation to be defined as an integer.
==== 6.3.2.6 Create new relationships between classes ====
@@ -430,9 +430,9 @@ Create a new package in the model: Create objects (instances of classes) in the ''Objects'' package:
# Right-click on the ''Objects'' package in the ''Model Explorer'', select '''New Child > Create a new InstanceSpecification''' and select the created object (InstanceSpecification) in the ''Model Explorer''.
-# In the ''Properties'' view type <code>clientObj1</code> in the the field ''Name'' and by the ''Classifier'' field click on the [[File:PlusKey.bmp]] key. In the ''Classifier'' window that pops up, browse to the ''Client2'' class and click on the [[File:Arrow.bmp]] key, which specifies the object's class as shown in figure 11.
+# In the ''Properties'' view type <code>clientObj1</code> in the the field ''Name'' and by the ''Classifier'' field click on the [[Image:images/PlusKey.bmp]] key. In the ''Classifier'' window that pops up, browse to the ''Client2'' class and click on the [[Image:images/Arrow.bmp]] key, which specifies the object's class as shown in figure 11.
-<center>[[File:ClassifierPopUp.bmp|center|thumb|400px|Figure 11: The Classifier pop up window]]</center>
+<center>[[Image:images/ClassifierPopUp.bmp|center|thumb|400px|Figure 11: The Classifier pop up window]]</center>
Follow the same pattern to create:
@@ -460,13 +460,13 @@ Create a ''Dependency'' relationship between the clients and the server objects: In this tutorial the following model was created:
-<center>[[File:DesignModelEx1.bmp|center|thumb|400px|Figure 12: Two packages on top in the model]]</center>
+<center>[[Image:images/DesignModelEx1.bmp|center|thumb|400px|Figure 12: Two packages on top in the model]]</center>
-<center>[[File:DesignModelEx2.bmp|center|thumb|400px|Figure 13: Relationships between the client classes]]</center>
+<center>[[Image:images/DesignModelEx2.bmp|center|thumb|400px|Figure 13: Relationships between the client classes]]</center>
'''Note!''' The inherited attributes depicted in figure 13 on the ''Client2'' class.
-<center>[[File:ObjectDiagram.bmp|center|thumb|400px|Figure 14: Objects in the model and their relationships]]</center>
+<center>[[Image:images/ObjectDiagram.bmp|center|thumb|400px|Figure 14: Objects in the model and their relationships]]</center>
=== 6.3.3 RT modeling ===
@@ -489,9 +489,9 @@ In Papyrus, different UML profiles can be applied. When installing Papyrus, as d When modeling in Papyrus, three types of resources are stored in the workspace.
{|
|
-[[File:ModelProjResourcesFS.bmp|center|thumb|400px|Figure 15: Resources in the file system]]
+[[Image:images/ModelProjResourcesFS.bmp|center|thumb|400px|Figure 15: Resources in the file system]]
|
-[[File:ModelProjResourcesPE.bmp|center|thumb|200px|Figure 16: Resources in the Project Explorer]]
+[[Image:images/ModelProjResourcesPE.bmp|center|thumb|200px|Figure 16: Resources in the Project Explorer]]
|}
* '''.di''' file persists the status of the workbench, i.e. which diagrams and views are opened, etc.
* '''.notation''' file persists the information about the diagrams in the model.
@@ -507,7 +507,7 @@ When Papyrus is installed a predefined perspective called ''Papyrus'' is made av The ''Project Explorer'' view is used to browse, select and manipulate resources in the workspace. Projects or working sets are the top level in this view. From the ''Project Explorer's'' (right click on the white space) context menu, e.g. new projects can be created.
-<center>[[File:ProjectExpl.bmp|center|thumb|200px|Figure 17: The Project Explorer]]</center>
+<center>[[Image:images/ProjectExpl.bmp|center|thumb|200px|Figure 17: The Project Explorer]]</center>
In some views, as in this case, there is a view specific menu (indicated in Figure 13 with a red ring). Here some settings can be applied for the view, e.g. if the top level should be working sets or projects.
@@ -515,13 +515,13 @@ In some views, as in this case, there is a view specific menu (indicated in Figu In the ''Model Explorer'' view, the model that has been opened in the ''Project Explorer'', can be browsed and edited. Model elements can be added by using the context menu of any existing modeling element, including the model package and packages. Diagrams can also be added by using the context menus. Existing diagrams can be opened in an appropriate editor by just double clicking on the diagram in the ''Model Explorer''.
-<center>[[File:ModelExpl.bmp|center|thumb|200px|Figure 18: The Model Explorer]]</center>
+<center>[[Image:images/ModelExpl.bmp|center|thumb|200px|Figure 18: The Model Explorer]]</center>
=== 7.2.3 Editing view ===
The ''Editing View'' is in the middle part of the workbench and here opens different types of editors, depending on the type of resource to edit, e.g. if a class diagram is opened, the class diagram editor will be visible in the ''Editing View''.
-<center>[[File:EditingView.bmp|center|thumb|400px|Figure 19: The Editing View]]</center>
+<center>[[Image:images/EditingView.bmp|center|thumb|400px|Figure 19: The Editing View]]</center>
How to use editors is described in section [[#7.3_Diagram_editing_in_Papyrus|Editors in Papyrus]].
@@ -529,14 +529,14 @@ How to use editors is described in section [[#7.3_Diagram_editing_in_Papyrus|Edi The ''Outline View'' is connected to the ''Editing View'' and gives an overview of what is open in the ''Editing View''. The ''Outline View'' may be used to pan the ''Editing View'' or to select some information that will be highlighted in the ''Editing View''. The shaded area is the area that is visible in the ''Editing View''.
-<center>[[File:OutlineView.bmp|center|thumb|200px|Figure 20: The Outline View]]</center>
+<center>[[Image:images/OutlineView.bmp|center|thumb|200px|Figure 20: The Outline View]]</center>
=== 7.2.5 Properties view ===
The ''Properties view'' is a stacked view which is located at the bottom of the workbench and shows the properties of a selected modeling element. The modeling element can be selected in the Model Explorer or in a diagram. The properties are categorized under different tabs located to the left in the ''Properties view''.
-<center>[[File:PropertiesView.bmp|center|thumb|500px|Figure 21: The Properties View]]</center>
+<center>[[Image:images/PropertiesView.bmp|center|thumb|500px|Figure 21: The Properties View]]</center>
In this view the properties may be viewed and edited, e.g. rename the operation and change the visibility of the operation.
@@ -545,7 +545,7 @@ In this view the properties may be viewed and edited, e.g. rename the operation From the context menu in the ''Model Explorer'' it is possible to validate the entire model or parts of it (for more details see section [[#7.7_Model_validation|Model validation]] . All warnings and errors appear in the ''Model Validation View'', which is a stacked view together with the ''Properties View'' and the ''Search View'' at the bottom of the workbench.
-<center>[[File:ModelValidationView.bmp|center|thumb|500px|Figure 22: The Model Validation View]]</center>
+<center>[[Image:images/ModelValidationView.bmp|center|thumb|500px|Figure 22: The Model Validation View]]</center>
The model validation constraints are customizable and how to work with it is described in section [[#7.7_Model_validation|Model validation]] .
@@ -554,7 +554,7 @@ The model validation constraints are customizable and how to work with it is des It is possible to do searches on a selected resource in a specific project or in the entire workspace. When the search is finished, the result appears in the ''Search View''. Details about specifying searches is described in the [[#7.8_Searching|Searching]] section.
-<center>[[File:SearchView.bmp|center|thumb|500px|Figure 23: The Search View]]</center>
+<center>[[Image:images/SearchView.bmp|center|thumb|500px|Figure 23: The Search View]]</center>
The example in Figure 23 shows the result of a model search for ''Class1'' in the entire workspace.
@@ -570,7 +570,7 @@ When a diagram editor is opened in Papyrus, three views are opened: * Palette
* Outline
-<center>[[File:DiagramEditorFieldsPointers.bmp|center|thumb|500px|Figure 24: Parts of a diagram editor (as an example, the class diagram editor is used)]]</center>
+<center>[[Image:images/DiagramEditorFieldsPointers.bmp|center|thumb|500px|Figure 24: Parts of a diagram editor (as an example, the class diagram editor is used)]]</center>
Figure 24 shows the different parts of a diagram editor. In this case the class diagram editor has been chosen as an example. The ''Editing surface'' is where the diagram editing is taken place. The ''Outline view'' gives an overview of the entire diagram. The blue shaded part in the ''Outline view'' shows what is visible in the editing surface. The ''Palette'' contains ''Drawers'' and in each drawer there are ''Tools'' to be used to add different things into the diagram. In Figure 22, the ''Nodes'' drawer is closed and the ''Edges'' drawer is opened. In the ''Edges'' drawer there are ''Tools'' to create different types of edges. By clicking on a drawer, it toggles open and close drawer.
@@ -582,7 +582,7 @@ Diagrams can be created in different places in the model such as they can be own To create a diagram, right click on the model element that should be the owner of the diagram and select '''New Diagram''' from the context menu. A new level of menu appears, displaying all types of diagrams that are available to create in this place, e.g. Figure 21 shows the available diagram types that can be created directly on top in the model package.
-<center>[[File:NewDiagram.bmp|center|thumb|500px|Figure 25: Available diagram types that can be created directly under the model package]]</center>
+<center>[[Image:images/NewDiagram.bmp|center|thumb|500px|Figure 25: Available diagram types that can be created directly under the model package]]</center>
'''Note!''' In Figure 25, no adaptation of Papyrus has taken place, hence all diagram types according pops up.
@@ -609,7 +609,7 @@ If an element already exists in the model, just click on (hold down) the element In a diagram, elements can be deleted or hided.
-<center>[[File:ElementContextMenuDiaDelHide.bmp|center|thumb|200px|Figure 26: Context menu of an element in a diagram]]</center>
+<center>[[Image:images/ElementContextMenuDiaDelHide.bmp|center|thumb|200px|Figure 26: Context menu of an element in a diagram]]</center>
Right click on an element in a diagram and do
@@ -622,7 +622,7 @@ Right click on an element in a diagram and do Diagrams can be adjusted and graphically edited to get a nicer look also using the element context menu. From the same context menu it is also possible to validate the model or specific parts of the model.
-<center>[[File:ElementContextMenuDiaFormat.bmp|center|thumb|300px|Figure 27: Example of the Format sub context menu]]</center>
+<center>[[Image:images/ElementContextMenuDiaFormat.bmp|center|thumb|300px|Figure 27: Example of the Format sub context menu]]</center>
In Figure 27 several menu items are shown, e.g.:
@@ -646,7 +646,7 @@ The most common modeling elements are: A ''package'' is a general UML grouping element, comparable to a folder in Windows or a directory in Unix. It is used to bring order in the model. A ''package'' may have a semantical meaning (e.g. representing a subsystem) and then a UML stereotype, defined in a applied UML Profile, may be added to it (e.g. << subsystem >>). To create a new ''package'', right click on the owning element, e.g. the model package and from the context menu select '''New Child > Create a new Package'''
-<center>[[File:NewPackage.bmp|center|thumb|500px|Figure 28: Create a new Package]]</center>
+<center>[[Image:images/NewPackage.bmp|center|thumb|500px|Figure 28: Create a new Package]]</center>
=== 7.4.2 Use-case ===
@@ -656,7 +656,7 @@ Taken together, all ''use-cases'' constitute all possible ways of using the syst To create a new ''use-case'', right click on the owning element, e.g. a package and from the context menu select '''New Child > Create a new UseCase'''
-<center>[[File:NewUseCase.bmp|center|thumb|500px|Figure 29: Create a new use-case]]</center>
+<center>[[Image:images/NewUseCase.bmp|center|thumb|500px|Figure 29: Create a new use-case]]</center>
=== 7.4.3 Actor ===
@@ -664,7 +664,7 @@ An ''actor'' is something external to the system, but interacts with it. An ''ac To create a new ''actor'', right click on the owning element, e.g. a package and from the context menu select '''New Child > Create a new Actor'''
-<center>[[File:NewActor.bmp|center|thumb|500px|Figure 30: Create a new actor]]</center>
+<center>[[Image:images/NewActor.bmp|center|thumb|500px|Figure 30: Create a new actor]]</center>
=== 7.4.4 Class ===
@@ -676,13 +676,13 @@ Collectively operations define the behavior of the ''class''. A ''class'' may ha To create a new ''class'', right click on the owning element, e.g. a package and from the context menu select '''New Child > Create a new Class'''
-<center>[[File:NewClass.bmp|center|thumb|500px|Figure 31: Create a new class]]</center>
+<center>[[Image:images/NewClass.bmp|center|thumb|500px|Figure 31: Create a new class]]</center>
==== 7.4.4.1 Attributes on classes ====
When a ''class'' is created, ''attributes'' can be added to it by using the context menu of the ''class''. To create a new ''attribute'' on the a ''class'' select '''New Child > Create a new Property''' from its context menu.
-<center>[[File:NewAttribute.bmp|center|thumb|500px|Figure 32: Create a new attribute]]</center>
+<center>[[Image:images/NewAttribute.bmp|center|thumb|500px|Figure 32: Create a new attribute]]</center>
The visibility, type and default value of the attribute are set in the properties view when the attribute is selected.
@@ -690,17 +690,17 @@ The visibility, type and default value of the attribute are set in the propertie When a ''class'' is created, ''operations'' can be added to it by using the context menu of the ''class''. To create a new ''operation'' on the a ''class'' select '''New Child > Create a new Operation''' from its context menu.
-<center>[[File:NewOperation.bmp|center|thumb|500px|Figure 33: Create a new operation]]</center>
+<center>[[Image:images/NewOperation.bmp|center|thumb|500px|Figure 33: Create a new operation]]</center>
The visibility, arguments and return type of the operation are set in the properties view when the operation is selected.
-Regarding the arguments and return type of the an operation, select the [[File:PlusKey.bmp]] key by the ''Owned parameter'' field.
+Regarding the arguments and return type of the an operation, select the [[Image:images/PlusKey.bmp]] key by the ''Owned parameter'' field.
-<center>[[File:ClassOp1.bmp|center|thumb|600px|Figure 34: Create a new argument]]</center>
+<center>[[Image:images/ClassOp1.bmp|center|thumb|600px|Figure 34: Create a new argument]]</center>
Then the following window pops up and from the drop list in the ''Direction'' field, select the direction of the argument. In the ''Name'' field the name of the argument is written and the type is defined in the ''Type'' field.
-<center>[[File:ClassOp2.bmp|center|thumb|600px|Figure 35: Select the arguments direction]]</center>
+<center>[[Image:images/ClassOp2.bmp|center|thumb|600px|Figure 35: Select the argument�s direction]]</center>
The direction ''return'' defines the return type of the operation. Only one argument can have the return direction.
@@ -710,17 +710,17 @@ An ''object'' is an instance of a class. In UML it is called and ''InstanceSpeci To create a new ''object'', right click on the owning element, e.g. a package and from the context menu select '''New Child > Create a new InstanceSpecification'''
-<center>[[File:NewObject.bmp|center|thumb|500px|Figure 36: Create a new object]]</center>
+<center>[[Image:images/NewObject.bmp|center|thumb|500px|Figure 36: Create a new object]]</center>
-The class to be instanciated is selected by clicking on the [[File:PlusKey.bmp]] key by the ''Classifier'' field in the ''Properties'' view of the ''InstanceSpecification''. This will open the ''Classifier'' pop-up window (figure 37), where the class to be used is selected.
+The class to be instanciated is selected by clicking on the [[Image:images/PlusKey.bmp]] key by the ''Classifier'' field in the ''Properties'' view of the ''InstanceSpecification''. This will open the ''Classifier'' pop-up window (figure 37), where the class to be used is selected.
-<center>[[File:ClassifierPopup.bmp|center|thumb|500px|Figure 37: Classifier pop-up window]]</center>
+<center>[[Image:images/ClassifierPopup.bmp|center|thumb|500px|Figure 37: Classifier pop-up window]]</center>
=== 7.4.6 Relationships ===
There are different types of relationships that can be used in diagrams, hence in the model between different modeling elements.
- [[Image:Relationships.bmp|center|thumb|300px]]
+ [[Image:./images/Relationships.bmp|center|thumb|300px]]
Navigability can be unidirectional or bidirectional for ''Association'', ''Aggregation'' and ''Composition''.
@@ -740,14 +740,14 @@ The ''Realizes'' relationship specifies that, e.g. an implementation realizes a To create a relationship between two modeling elements, use the tool palette in the diagram editor, e.g. to create an ''Association'' between two classes, select the ''Association'' tool in the tool palette, click on the source element and then click on the destination element as described in figure 38.
-[[Image:ClassDiagramEditorNewAss.bmp|center|thumb|500px|Figure 38: Create a new Association]]
+[[Image:./images/ClassDiagramEditorNewAss.bmp|center|thumb|500px|Figure 38: Create a new Association]]
In the ''Edges'' drawer in the tool palette, all available relationships are shown. To create a ''Generalization'' relationship, select the ''Generalization'' tool from the tool palette and follow the same procedure as described.
The ''Aggregation'' and the ''Composition'' relationships are a special kind of an ''Association'' relationship. To create any of these, an ''Association'' relationship needs first to be created. Then select the created ''Association'' and in the properties view, change the ''Aggregation'' field at the appropriate end of the ''Association'' to ''shared''(if an ''Aggregation'' is desired) or to ''composite'' (if a ''Composition'' is desired). Figure 39 shows how to do it.
-[[Image:ClassDiagramEditorNewAgg.bmp|center|thumb|500px|Figure 39: Create a new Association]]
+[[Image:./images/ClassDiagramEditorNewAgg.bmp|center|thumb|500px|Figure 39: Create a new Association]]
When the ''Association'' is created, the ''Aggregation'' field is set to ''none'' by default. When doing the change at the destination end (as in figure 35), the diamond shows up at the source end of the relationship.
@@ -757,7 +757,7 @@ UML has many different types of diagrams to capture all different aspects of a s The different diagrams in UML 2 are shown in figure 40 and here they are structured after diagram type. In the following of this section they are organized how they are used.
-<center>[[File:UMLdiagrams.png|center|thumb|500px|Figure 40: UMl 2 diagram types]]</center>
+<center>[[Image:images/UMLdiagrams.png|center|thumb|500px|Figure 40: UMl 2 diagram types]]</center>
'''Note!''' In Papyrus class diagrams are also used as object diagrams.
@@ -780,7 +780,7 @@ A ''use-case diagram'' describe how different ''Actors'' use different functiona A diagram may depict all or some of the use-cases of a system.
-<center>[[File:UCdiagram.bmp|center|thumb|600px|Figure 41: Use-case diagram]]</center>
+<center>[[Image:images/UCdiagram.bmp|center|thumb|600px|Figure 41: Use-case diagram]]</center>
A ''use-case'' interacts with an ''actor'' and perform something useful for that ''actor''. A ''use-case'' exist because of its main flow, but all odd cases and error situations have to be specified. A ''use-case'' has a black box and a white box view. The black box view is preferably described in plain text or by using activity diagrams. The white box view is described by one or several sequence diagrams.
@@ -801,7 +801,7 @@ The main elements in an ''activity diagram'' are: * Decisions
* Partitions
-<center>[[File:ActivityDiagram.bmp|center|thumb|600px|Figure 42: Activity diagram]]</center>
+<center>[[Image:images/ActivityDiagram.bmp|center|thumb|600px|Figure 42: Activity diagram]]</center>
The ''activity diagram'' is preferably used to specify the black box behavior of a use-case instead of using plain text. It may also be used to specify a flow chart for a class operation.''Activity diagrams'' are owned by use-cases or classes.
@@ -820,7 +820,7 @@ Sequences involving collaborating elementsThe main elements in a ''sequence diag * Messages
* Combined fragments
-<center>[[File:SequenceDiagram.bmp|center|thumb|600px|Figure 43: Sequence diagram]]</center>
+<center>[[Image:images/SequenceDiagram.bmp|center|thumb|600px|Figure 43: Sequence diagram]]</center>
The example (Figure 43) describes Interaction1, two objects (instances of Class1 and Class2) are created and interacts by messages. The time goes down along the life lines. In the bottom, there is a combined fragment of type "Ref" which is a reference to another interaction, Interaction2, meaning that the sequences in that interaction are executed.There are a lot of combined fragment types, e.g. type "Loop" specifies a loop, type "Alt" specifies alternatives, etc. All combined fragment types are defined in [http://www.omg.org/spec/UML/2.4.1/ Unified Modeling Language (UML) version 2.4.1]
@@ -837,7 +837,7 @@ The main elements in a ''collaboration diagram'' are: * Access paths
* Messages
-<center>[[File:CommunicationDiagram.bmp|center|thumb|600px|Figure 44: Communication diagram]]</center>
+<center>[[Image:images/CommunicationDiagram.bmp|center|thumb|600px|Figure 44: Communication diagram]]</center>
The example (Figure 44) describes access paths between objects and which messages are passed in these paths.''Communication diagrams'' are owned by use-cases.
@@ -863,7 +863,7 @@ The main elements in a ''class diagram'' are: * Classes
* Relationships
-<center>[[File:ClassDiagram.bmp|center|thumb|600px|Figure 45: Class diagram]]</center>
+<center>[[Image:images/ClassDiagram.bmp|center|thumb|600px|Figure 45: Class diagram]]</center>
The example (Figure 45) shows a ''class diagram'' used to specify an inheritance structure between classes. Note: The ''Generalization'' relationship and the indication of the inherited attributes in Class1 and Class2.
@@ -880,7 +880,7 @@ The main elements in a ''composite structure diagram'' are: * Ports (interface objects)
* Connectors
-<center>[[File:CompositeStructure.bmp|center|thumb|600px|Figure 46: Composite structure diagram]]</center>
+<center>[[Image:images/CompositeStructure.bmp|center|thumb|600px|Figure 46: Composite structure diagram]]</center>
The example (Figure 46) shows a ''composite structure diagram'' used to specify the structural contents of Class4. Note: Class4 uses one instance (class2) of Class2 and one instance (class3) of Class3 and they are connected between Class2/Port1 and Class3/Port2.
@@ -899,7 +899,7 @@ The main elements in a ''state machine diagram'' are: * Triggering events
* Pseudo states, e.g. initial, final and choice points
-<center>[[File:StateDiagram.bmp|center|thumb|600px|Figure 47: State machine diagram]]</center>
+<center>[[Image:images/StateDiagram.bmp|center|thumb|600px|Figure 47: State machine diagram]]</center>
The example (Figure 47) shows a ''state machine diagram'' that has an initial pseudo state, three states and transitions between them. On each transition (except for initialize), a ''triggering event'' is specified, which defines the event that makes the transition to be taken. Transitions and states may have effect code, which specify detailed behavior to be executed when an associated transition is taken.
diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ActivityDiagram.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ActivityDiagram.bmp Binary files differindex ce150ed16d0..ce150ed16d0 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ActivityDiagram.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ActivityDiagram.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ClassDiagram.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ClassDiagram.bmp Binary files differindex ecbfd96c698..ecbfd96c698 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ClassDiagram.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ClassDiagram.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ClassDiagramEditorBase.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ClassDiagramEditorBase.bmp Binary files differindex d39a0d74fd5..d39a0d74fd5 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ClassDiagramEditorBase.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ClassDiagramEditorBase.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ClassDiagramEditorNewAgg.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ClassDiagramEditorNewAgg.bmp Binary files differindex a72ba31434c..a72ba31434c 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ClassDiagramEditorNewAgg.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ClassDiagramEditorNewAgg.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ClassDiagramEditorNewAgg.png b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ClassDiagramEditorNewAgg.png Binary files differnew file mode 100644 index 00000000000..b0f05a5641c --- /dev/null +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ClassDiagramEditorNewAgg.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ClassDiagramEditorNewAss.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ClassDiagramEditorNewAss.bmp Binary files differindex 251060abd70..251060abd70 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ClassDiagramEditorNewAss.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ClassDiagramEditorNewAss.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/CommunicationDiagram.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/CommunicationDiagram.bmp Binary files differindex 35e1cdd0c9f..35e1cdd0c9f 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/CommunicationDiagram.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/CommunicationDiagram.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/CompositeStructure.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/CompositeStructure.bmp Binary files differindex adbeeb8cfcb..adbeeb8cfcb 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/CompositeStructure.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/CompositeStructure.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/DiagramEditor.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/DiagramEditor.bmp Binary files differindex 4e82c94cba3..4e82c94cba3 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/DiagramEditor.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/DiagramEditor.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/DiagramEditorFields.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/DiagramEditorFields.bmp Binary files differindex b30e976b628..b30e976b628 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/DiagramEditorFields.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/DiagramEditorFields.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/DiagramEditorFieldsPointers.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/DiagramEditorFieldsPointers.bmp Binary files differindex 5259119a843..5259119a843 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/DiagramEditorFieldsPointers.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/DiagramEditorFieldsPointers.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/EclipseArchitecture.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/EclipseArchitecture.bmp Binary files differindex cea20f60bc0..cea20f60bc0 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/EclipseArchitecture.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/EclipseArchitecture.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/EclipseView.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/EclipseView.bmp Binary files differindex 18d6597bfaf..18d6597bfaf 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/EclipseView.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/EclipseView.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/EditingView.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/EditingView.bmp Binary files differindex 28f04781b6e..28f04781b6e 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/EditingView.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/EditingView.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ElementContextMenuDia.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ElementContextMenuDia.bmp Binary files differindex bd79eb310d0..bd79eb310d0 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ElementContextMenuDia.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ElementContextMenuDia.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ElementContextMenuDiaDelHide.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ElementContextMenuDiaDelHide.bmp Binary files differindex a0680064d83..a0680064d83 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ElementContextMenuDiaDelHide.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ElementContextMenuDiaDelHide.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ElementContextMenuDiaFormat.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ElementContextMenuDiaFormat.bmp Binary files differindex 0e1c51a9fb6..0e1c51a9fb6 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ElementContextMenuDiaFormat.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ElementContextMenuDiaFormat.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ExportWiz.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ExportWiz.bmp Binary files differindex 48e6c07a047..48e6c07a047 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ExportWiz.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ExportWiz.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/Feature-Plug-in.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/Feature-Plug-in.bmp Binary files differindex 4a4eeab0274..4a4eeab0274 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/Feature-Plug-in.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/Feature-Plug-in.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/IkonOpenPerspective.png b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/IkonOpenPerspective.png Binary files differindex d887221695c..d887221695c 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/IkonOpenPerspective.png +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/IkonOpenPerspective.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ImportWiz.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ImportWiz.bmp Binary files differindex f505187abb8..f505187abb8 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ImportWiz.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ImportWiz.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/InstallNewSoftware.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/InstallNewSoftware.bmp Binary files differindex 7e2ce2c8036..7e2ce2c8036 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/InstallNewSoftware.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/InstallNewSoftware.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/InstallPapyrusComp.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/InstallPapyrusComp.bmp Binary files differindex ec0306a73bd..ec0306a73bd 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/InstallPapyrusComp.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/InstallPapyrusComp.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ModelExpl.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ModelExpl.bmp Binary files differindex 4c96e45b6ed..4c96e45b6ed 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ModelExpl.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ModelExpl.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ModelProjResourcesFS.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ModelProjResourcesFS.bmp Binary files differindex 9b83f8dd607..9b83f8dd607 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ModelProjResourcesFS.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ModelProjResourcesFS.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ModelProjResourcesPE.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ModelProjResourcesPE.bmp Binary files differindex 11157c7c6da..11157c7c6da 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ModelProjResourcesPE.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ModelProjResourcesPE.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ModelValidationView.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ModelValidationView.bmp Binary files differindex bd40576507f..bd40576507f 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ModelValidationView.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ModelValidationView.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/MyProject.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/MyProject.bmp Binary files differindex b07a71f5abc..b07a71f5abc 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/MyProject.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/MyProject.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/NewActor.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/NewActor.bmp Binary files differindex 3ee16271152..3ee16271152 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/NewActor.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/NewActor.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/NewAttribute.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/NewAttribute.bmp Binary files differindex 3ae5925c9e0..3ae5925c9e0 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/NewAttribute.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/NewAttribute.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/NewClass.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/NewClass.bmp Binary files differindex d4292e62b98..d4292e62b98 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/NewClass.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/NewClass.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/NewDiagram.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/NewDiagram.bmp Binary files differindex 0f77a431dff..0f77a431dff 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/NewDiagram.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/NewDiagram.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/NewOperation.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/NewOperation.bmp Binary files differindex 1de99f275d9..1de99f275d9 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/NewOperation.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/NewOperation.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/NewPackage.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/NewPackage.bmp Binary files differindex 87e43b999dd..87e43b999dd 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/NewPackage.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/NewPackage.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/NewUseCase.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/NewUseCase.bmp Binary files differindex 313587fbbe5..313587fbbe5 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/NewUseCase.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/NewUseCase.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/OutlineView.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/OutlineView.bmp Binary files differindex 55390342176..55390342176 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/OutlineView.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/OutlineView.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/Preferences.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/Preferences.bmp Binary files differindex 4ae9abb00d2..4ae9abb00d2 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/Preferences.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/Preferences.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ProjectExpl.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ProjectExpl.bmp Binary files differindex 3c5171557d6..3c5171557d6 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ProjectExpl.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ProjectExpl.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PropertiesView.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/PropertiesView.bmp Binary files differindex 5fbed2fa110..5fbed2fa110 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/PropertiesView.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/PropertiesView.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/Relationships.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/Relationships.bmp Binary files differindex 2e739eabe47..2e739eabe47 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/Relationships.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/Relationships.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/SearchView.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/SearchView.bmp Binary files differindex b74183c0777..b74183c0777 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/SearchView.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/SearchView.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/SequenceDiagram.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/SequenceDiagram.bmp Binary files differindex 104d2da3fcb..104d2da3fcb 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/SequenceDiagram.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/SequenceDiagram.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/StateDiagram.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/StateDiagram.bmp Binary files differindex 0005e29f839..0005e29f839 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/StateDiagram.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/StateDiagram.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/UCdiagram.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/UCdiagram.bmp Binary files differindex 5a0ce561e9d..5a0ce561e9d 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/UCdiagram.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/UCdiagram.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ValidationConstraints.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ValidationConstraints.bmp Binary files differindex 1c69e697969..1c69e697969 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/ValidationConstraints.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/ValidationConstraints.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/WelcomePage.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/WelcomePage.bmp Binary files differindex 4d63a9ba7c0..4d63a9ba7c0 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/WelcomePage.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/WelcomePage.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/Workbench.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/Workbench.bmp Binary files differindex 8dbb1476af0..8dbb1476af0 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/Workbench.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/Workbench.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/WorkspacePopup.bmp b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/WorkspacePopup.bmp Binary files differindex 267fd10af3a..267fd10af3a 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.doc/resource/WorkspacePopup.bmp +++ b/plugins/doc/org.eclipse.papyrus.uml.doc/resource/images/WorkspacePopup.bmp diff --git a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/.settings/org.eclipse.core.resources.prefs b/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/.settings/org.eclipse.core.resources.prefs deleted file mode 100644 index fe2780158d6..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/.settings/org.eclipse.core.resources.prefs +++ /dev/null @@ -1,3 +0,0 @@ -eclipse.preferences.version=1 -encoding//resource/stereotype-repair-toc.xml=utf-8 -encoding//resource/stereotype-repair.html=utf-8 diff --git a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/build.properties b/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/build.properties index 0b4f3c00f95..fa5ca4804a2 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/build.properties @@ -15,5 +15,6 @@ bin.includes = META-INF/,\ plugin.xml,\ plugin.properties,\ about.html,\ - resource/ -src.includes = about.html + target/generated-eclipse-help/** +src.includes = about.html,\ + resource/ diff --git a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/plugin.xml index 3539faf71c1..ad72e82f3ad 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/plugin.xml @@ -18,11 +18,11 @@ <extension point="org.eclipse.help.toc"> <toc - file="resource/model-repair-main-toc.xml" + file="target/generated-eclipse-help/model-repair-main-toc.xml" primary="false"> </toc> <toc - file="resource/stereotype-repair-toc.xml" + file="target/generated-eclipse-help/stereotype-repair-toc.xml" primary="false"> </toc> </extension> diff --git a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/pom.xml index 85b4e8ca1b8..8149aa705a7 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/resource/model-repair-main-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/resource/model-repair-main-toc.xml index 61aec4c6887..8f17d75d77a 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/resource/model-repair-main-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/resource/model-repair-main-toc.xml @@ -1,8 +1,8 @@ <?xml version='1.0' encoding='utf-8' ?> <toc label="Repairing UML Models" link_to="../org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml#profiles"> <anchor id="model-repair-start"/> - <topic href="resource/stereotype-repair.html" label="Repairing Stereotype Applications"> - <link toc="resource/stereotype-repair-toc.xml"/> + <topic href="target/generated-eclipse-help/stereotype-repair.html" label="Repairing Stereotype Applications"> + <link toc="target/generated-eclipse-help/stereotype-repair-toc.xml"/> <anchor id="stereotype-repair"/> </topic> <anchor id="model-repair-end"/> diff --git a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/resource/stereotype-repair-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/resource/stereotype-repair-toc.xml deleted file mode 100644 index fb4bfd20530..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/resource/stereotype-repair-toc.xml +++ /dev/null @@ -1,7 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc label="stereotype-repair" topic="resource/stereotype-repair"> - <topic href="resource/stereotype-repair.html" label="About Stereotype Application Repair"></topic> - <topic href="resource/stereotype-repair.html#Invocation_of_Stereotype_Application_Repair" label="Invocation of Stereotype Application Repair"> - <topic href="resource/stereotype-repair.html#Model_Validation" label="Model Validation"> - </topic></topic> -</toc> diff --git a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/resource/stereotype-repair.html b/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/resource/stereotype-repair.html deleted file mode 100644 index 41889482cfe..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.modelrepair.doc/resource/stereotype-repair.html +++ /dev/null @@ -1,26 +0,0 @@ -<?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="About_Stereotype_Application_Repair">About Stereotype Application Repair</h1><p>The EMF-based implementation of UML profiles in Papyrus has consequences for the storage of stereotype applications -in Papyrus model files. Essentially, each profile applied to a model maps to an XML schema namespace which, upon -loading a model, must be resolvable in the form of an EMF <tt>EPackage</tt> located either in a deployed plug-in or -embedded in the UML profile, itself. Because of the dynamic nature of profiles, which can be moved from one location -to another or re-defined to produce new versions over time, there are a number of ways in which stereotype applications -(being effectively instances of the stereotypes defined in the profile as though they were metaclasses) can drift out -of sync with the profile definition:</p><ul><li>the profile defining the stereotype applications may no longer be applied to the model. Normally, unapplying a profile removes all applications of its stereotypes, but this may be undone by various means: bad merges in a version control system, model units (resources) that were not available/loaded at the time, etc. </li><li>the profile may be applied but the model may have applied a different version of the profile than the version on which the stereotype applications in the model are based. Thus the stereotype applications are properly loaded (the XML schema describing them is resolved) but they may not function correctly in the Papyrus editor</li><li>the profile may have moved or been undeployed or is otherwise not known, resulting in the XML schema namespace in the model file being unresolved</li></ul><p>Also, stereotype applications may sometimes become disconnected from the UML elements that they extend (effectively -"dangling stereotypes") even though the correct version of the profile is properly applied. Reasons may be bad merges -or bugs in the software, but the result is objects in the model resource that are no longer stereotype applications -because they do not extend any model element.</p><p>The Stereotype Application Repair function can resolve or otherwise address all of these problems.</p><h1 id="Invocation_of_Stereotype_Application_Repair">Invocation of Stereotype Application Repair</h1><p>Papyrus scans all UML model resources when they are loaded to look for problems with stereotype applications. -If any are found, the <b>Repair Stereotypes</b> dialog opens automatically to let the user fix them. </p><p><img border="0" src="images/repair_dialog.png"/> </p><p>For each discrete XML namespace in a resource that has a problem, the dialog presents:</p><ul><li>the resource in which the problem is found</li><li>the number of stereotype applications affected</li><li>the name of the profile that defines the affected stereotypes. If the profile cannot be found automatically, a name is inferred from the XML namespace name (this is indicated by the "unknown schema" annotation as shown in the figure above</li><li>the available actions for resolution of the problem</li></ul><p>The dialog may be cancelled at any time, in which case no further action will be taken until the next time the -repair dialog is launched. Any problems for which a repair action is selected (being not the <i>Postpone</i> action; see below) -may be repaired by pressing the <b>Apply</b> button. The dialog will then remain open to continue with the -remaining problems. Or press <b>OK</b> to apply all selected actions (including <i>Postpone</i>) and close the dialog.</p><p>The complete set of actions available for fixing a group of stereotype applications is</p><ul><li><i>Migrate Profile</i>: if the profile defining the stereotype applications can be determined automatically, in the case where the problem is simply that a different version of the profile is applied to the model, this action migrates the stereotype applications to the currently applied profile definition. Otherwise, the user is asked to find the profile (either in the workspace or registered by an installed plug-in) and that profile is applied to the model, implicitly migrating the stereotype applications to its current definition</li><li><i>Create Markers</i>: this action does not change the model or the stereotype applications in any way but simply creates a problem marker for each affected model element as a reminder that there is an unresolved problem in its applied stereotype</li><li><i>Delete Stereotypes</i>: this action deletes the affected stereotype applications. Use it when the profile simply no longer exists or is otherwise obsolete and no longer required by the model</li><li><i>Postpone</i>: this action simply does nothing. Fixing the problem is deferred to the next time that Papyrus scans the resource for problems in stereotype applications</li></ul><p>The dialog initially suggests the best available repair action for each group of broken stereotype applications. -Usually this is the <i>Migrate Profile</i> action, which has the best chance of fixing the problem and not losing -valuable information from the model. However, in the case of dangling stereotypes (which have become disconnected -from the UML elements that they extend), the <i>Migrate Profile</i> action is not available and <i>Delete Stereotypes</i> -is suggested instead. This is because these objects are not actually stereotype applications, being not extensions -of any UML element, and so there is nothing to repair. If it happens that the elements they were meant to extend -still exist and they need to be reconnected, then Papyrus cannot determine two which elements they should be -reconnected. In that case, the user must simply take the <i>Postpone</i> option and fix up these objects' base -element references by some other means.</p><h2 id="Model_Validation">Model Validation</h2><p>Papyrus contributes a model validation constraint, enabled by default, that scans the model's stereotypes for problems when the entire model -is validated. This uses the same repair analysis capability described above. Problems reported by this constraint have a "quick fix" -available in the <b>Model Validation</b> view and in the <b>Problems</b> view that launches the same dialog described above for resolution -of stereotype application issues.</p><p>This is useful, for example, after completing a compare/merge operation, profile migration, or other complex operation that may have resulted -in structural problems in the model (whether in stereotype applications or otherwise).</p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/.settings/org.eclipse.core.resources.prefs b/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/.settings/org.eclipse.core.resources.prefs deleted file mode 100644 index 148d2d22c24..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/.settings/org.eclipse.core.resources.prefs +++ /dev/null @@ -1,3 +0,0 @@ -eclipse.preferences.version=1 -encoding//resource/profile-assistants-toc.xml=utf-8 -encoding//resource/profile-assistants.html=utf-8 diff --git a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/build.properties b/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/build.properties index 0b4f3c00f95..fa5ca4804a2 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/build.properties @@ -15,5 +15,6 @@ bin.includes = META-INF/,\ plugin.xml,\ plugin.properties,\ about.html,\ - resource/ -src.includes = about.html + target/generated-eclipse-help/** +src.includes = about.html,\ + resource/ diff --git a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/plugin.xml index 2018ed66862..ddcfff958dc 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/plugin.xml @@ -4,11 +4,11 @@ <extension point="org.eclipse.help.toc"> <toc - file="resource/profile-assistants-main-toc.xml" + file="target/generated-eclipse-help/profile-assistants-main-toc.xml" primary="false"> </toc> <toc - file="resource/profile-assistants-toc.xml" + file="target/generated-eclipse-help/profile-assistants-toc.xml" primary="false"> </toc> </extension> diff --git a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/pom.xml index f97756bff53..c55f70be75e 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/resource/profile-assistants-main-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/resource/profile-assistants-main-toc.xml index edafa1a0868..194d95527b6 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/resource/profile-assistants-main-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/resource/profile-assistants-main-toc.xml @@ -1,7 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?> <toc label="Diagram Assistants for UML Profiles" link_to="../org.eclipse.papyrus.uml.diagram.profile.doc/resource/users/profile-main-toc.xml#profiles"> - <topic href="resource/profile-assistants.html" label="Diagram Assistants for UML Profiles"> - <link toc="resource/profile-assistants-toc.xml"/> + <topic href="target/generated-eclipse-help/profile-assistants.html" label="Diagram Assistants for UML Profiles"> + <link toc="target/generated-eclipse-help/profile-assistants-toc.xml"/> <anchor id="profile-diagram-assistants"/> </topic> diff --git a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/resource/profile-assistants-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/resource/profile-assistants-toc.xml deleted file mode 100644 index b00be201856..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/resource/profile-assistants-toc.xml +++ /dev/null @@ -1,15 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc label="profile-assistants" topic="resource/profile-assistants.html"> - <topic href="resource/profile-assistants.html" label="About Diagram Assistants for UML Profiles"></topic> - <topic href="resource/profile-assistants.html#Diagram_Assistant_Models" label="Diagram Assistant Models"></topic> - <topic href="resource/profile-assistants.html#Generating_Diagram_Assistants" label="Generating Diagram Assistants"> - <topic href="resource/profile-assistants.html#Choosing_a_Base_Element_Types_Set" label="Choosing a Base Element Types Set"> - </topic> - <topic href="resource/profile-assistants.html#Considerations_for_Designing_Assistants_Models" label="Considerations for Designing Assistants Models"> - </topic></topic> - <topic href="resource/profile-assistants.html#Deploying_a_Diagram_Assistants_Model" label="Deploying a Diagram Assistants Model"> - <topic href="resource/profile-assistants.html#Deploying_Models_in_the_Host_Workbench" label="Deploying Models in the Host Workbench"> - </topic> - <topic href="resource/profile-assistants.html#Deploying_Models_in_Plug-ins" label="Deploying Models in Plug-ins"> - </topic></topic> -</toc> diff --git a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/resource/profile-assistants.html b/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/resource/profile-assistants.html index e5b0ba6b08b..e69de29bb2d 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/resource/profile-assistants.html +++ b/plugins/doc/org.eclipse.papyrus.uml.profile.assistants.doc/resource/profile-assistants.html @@ -1,6 +0,0 @@ -<?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="About_Diagram_Assistants_for_UML_Profiles">About Diagram Assistants for UML Profiles</h1><p>Papyrus UML diagrams provide a feature called <i>Diagram Assistants</i> that offer context-sensitive tools directly in the diagram. These are manifest in two forms:</p><ul><li>pop-up bar: an orange rounded rectangle containing a variety of tools for creation of new model elements</li><li>connection handles: a pair of arrows handles, one incoming and outgoing, appearing at the border of a shape from which new connections can be dragged to other shapes in the diagram</li></ul><p>The diagram assistants provided out-of-the-box by Papyrus support creation of the basic UML elements. However, you can extend the capabilities of the diagram assistants to create elements from your profile-based DSL, by creating new UML elements having your stereotypes applied.</p><h1 id="Diagram_Assistant_Models">Diagram Assistant Models</h1><p>Papyrus uses EMF-based models to describe the diagram assistants that can be presented in UML diagrams. The core UML assistants are described by these models, and so are the assistants for your DSLs.</p><p>Consider a trivial example of a profile for design of use cases in a J2EE-based system: </p><p><img border="0" src="images/usecase-stereotypes.png"/> </p><p>This profile has several stereotypes:</p><ul><li>«webScenario» extending UseCase</li><li>«branchPoint» extending ExtensionPoint</li><li>«user» and «browser» extending Actor</li><li>«web» extending Association</li></ul><p>Diagram assistants that might be provided for such a profile should offer to create «branchPoint» ExtensionPoints in «webScenario» use cases:</p><p><img border="0" src="images/popup-bar.png"/></p><p>and «web» Associations between «webScenario» UseCases and «user» or «browser» Actors, thus:</p><p><img border="0" src="images/connection-assistant.png"/></p><p>The model is described by a <b>ModelingAssistantProvider</b> in a <code>*.assistants</code> resource. The ModelingAssistantProvider captures essentially the same information as is provided by implementations of the <code>org.eclipse.gmf.runtime.emf.ui.services.modelingassistant.IModelingAssistantProvider</code> interface, with the exception of "show related elements" queries. In particular, it provides:</p><ul><li>a list of element types (by ID) for which the provider offers diagram assistants</li><li>a list of <b>PopupAssistant</b>s describing creation tools presented in the pop-up bar. Each of these specifies:<ul><li>the element type (by ID) of the model element that the tool creates</li><li>a <b>Filter</b> matching model elements on which the popup assistant should be shown</li></ul></li><li>a list of <b>ConnectionAssistant</b>s describing relationships (elements and references) that should be presented by the connection handles. Each of these specifies:<ul><li>the element type (by ID) of the model element or reference that the tool creates</li><li>a <b>Filter</b> matching source model elements on which the popup assistant should be shown</li><li>a <b>Filter</b> matching target model elements on which the popup assistant should be shown</li></ul></li></ul><p>The filters specified by the different kinds of assistants may be owned by the assistants that require them (private one-offs) or may be shared for re-use by any number of assistants. The latter are commonly stored in the root <b>ModelingAssistantProvider</b> element, which just serves as a container. Several different kinds of filter are provided by Papyrus:</p><ul><li><b>ElementTypeFilter</b>: matches the element type of any <code>EObject</code> or <code>IAdaptable</code> (such as a diagram <code>EditPart</code>) by ID. The match is a subtype match: any object that matches the given element type or any specialization of that element type is accepted by the filter. This is particularly useful with the visual-ID hinted types that distinguish different visualizations of UML elements in the different diagrams.</li><li><b>Equals</b>: matches an element that is equal to (the same as) the element referenced by the filter</li><li><b>ProfileApplied</b>: matches an element that is in the context of a UML Package that has a particular profile applied. The profile may be specified by URI (preferred) or by qualified name (which is susceptible to shadowing by name conflicts)</li><li><b>AssistedElementTypeFilter</b>: a special filter that matches any object of an element type that is referenced as one of the element types for which the containing ModelAssistantProvider provides assistants</li><li><b>CompoundFilter</b>: groups filters with boolean expressions. Filters in an expression may be owned or referenced by the compound. Supported operators are:<ul><li><b>and</b>: matches objects for which all filters matches. An empty compound matches no objects</li><li><b>or</b>: matches objects for which at least one filter matches. An empty compound matches no objects</li><li><b>xor</b>: matches objects for which exactly one filter matches. An empty compound matches no objects</li><li><b>not</b>: matches objects for which none of the filters match (more than one filter may be referenced). An empty compound matches any object</li></ul></li></ul><p>Extenders can define custom filters by extending the filter model defined in the <code>org.eclipse.papyrus.infra.filters</code> plug-in. The editor makes use of EMF's "child creation extenders" facility to integrate your custom filters with the core set.</p><p><img border="0" src="images/assistant-filter.png"/></p><p>The image above shows a detail of the filter generated by Papyrus for a «branchPoint» ExtensionPoint pop-up tool in the example J2EE profile in Use Case diagrams. The filter is an <b>and</b> combination of</p><ul><li>the "pertains to Profile1" filter (which is based on a ProfileApplied filter referencing the J2EE profile)</li><li>an <b>or</b> combination of the various visualizations of UseCase supported by the diagram, including UseCases visualized as ellipse or as classifier shapes. To restrict the pop-up assistant to only «webScenario» UseCases from this DSL, one would replace the generic UseCase element type filters with filters selecting the more specific <code>org.eclipse.papyrus.example.j2ee.WebScenario</code> element type that specializes UseCase for the stereotype extension</li></ul><h1 id="Generating_Diagram_Assistants">Generating Diagram Assistants</h1><p>Building a diagram assistant model by hand is a tedious undertaking. To ease this process, Papyrus provides a wizard that generates an assistants model from a Profile selected in the <b>Model Explorer</b> view:</p><p><img border="0" src="images/generate-assistants-menu.png"/></p><p>Because the diagram assistants model specifies the element types that are created by the assistant tools, the wizard also generates the element types for your DSL as an <code>*.elementtypesconfigurations</code> model. If you only need to generate this latter model, that option is also available in the menu.</p><p>The diagram assistants wizard dialog requires several pieces of information as inputs (as identified in the image below):</p><ol><li>An unique identifier for the assistants model. This is used as a prefix for element types that are generated for your DSL</li><li>The element types set model on which to base the element types generated for your DSL. This has important consequences discussed below</li><li>Whether to suppress the reference to a semantic supertype distinct from the diagram-specific ("visual") element type in the list of specialized types for generated element types. This option is only applicable when generating a diagram-specific diagram assistants model</li><li>The workspace folder or project in which to create the model</li><li>The name of the <code>*.assistants</code> model file to create. The element types model will use the same name, except with the <code>*.elementtypesconfigurations</code> extension</li></ol><p><img border="0" src="images/generate-assistants-wizard.png"/></p><p>Upon completion of the wizard, element types and modeling assistants are generated as follows:</p><ul><li>for each metaclass extension of a stereotype in the profile, <b>SpecializationTypeConfiguration</b>s are generated that specialize each of the element types in the base element types set that are based on the same UML metaclass. So, in our trivial J2EE profile example, the «branchPoint» stereotype generates two element types: one for each of the 3007 and 3008 visualizations of the ExtensionPoint metaclass in the Use Case diagram<ul><li>if your assistants model is based on a diagram-specific element types model, then the visualization-specific element types that are generated will specialize the visual UML element types of the diagram and also semantic element types representing the stereotyped element in the model (unless the option to suppress the semantic supertype was selected)</li><li>if your stereotypes include Image specifications that reference an icon by a <code>profile:/plugin/...</code> URI, then that is used to generate an equivalent <b>IconEntry</b> in the element type configuration</li></ul></li><li>for each profile-specific element type, a diagram assistant is generated, either<ul><li>a <b>ConnectionAssistant</b> if the element type is not a relationship or reference type, or</li><li>a <b>PopupAssistant</b> otherwise</li></ul></li><li>for each pop-up assistant, a filter is generated that is an <b>or</b> combination of <b>ElementTypeFilter</b>s for each of the element types in the base set that can contain an instance of the profile element type</li><li>for each connection assistant, filters are generated that are <b>or</b> combinations of <b>ElementTypeFilter</b>s for each of the element types in the base set that can be sources and targets, respectively, of the profile element type</li><li>a few common filters are generated for use by all of the assistants, including:<ul><li>an <b>AssistedElementTypeFilter</b> matching objects of an element type that is provided by the model as an assistant</li><li>a <b>ProfileApplied</b> filter that matches objects in the context of some package that has the source profile applied</li><li>a "pertains to <i>profile name</i>" filter that is an <b>or</b> combination of the previous two</li></ul></li><li>the generated <b>ModelingAssistantProvider</b> lists the element types generated in the accompanying <code>*.elementtypesconfigurations</code> model as the element types that it provides as assistants. This restricts the sources and targets of connections from/to new elements to only element types specific to your profile. You can edit this list as necessary to further restrict or widen the end types created by the connection assistants</li></ul><h2 id="Choosing_a_Base_Element_Types_Set">Choosing a Base Element Types Set</h2><p>As mentioned above, the decision of which element types set model to base the generated assistants on is crucial in determining the shape of the result. There are essentially two choices to be made:</p><ul><li>generate assistants based on the core UML element types, describing the unprofiled UML metamodel without reference to any particular visualizations of elements in any diagram</li><li>generate assistants based on the visual-ID hinted element types of a specific UML diagram</li></ul><h3 id="Generating_Generic_UML-based_Assistants">Generating Generic UML-based Assistants</h3><p>To generate modeling assistants that will be applicable to any diagram in which the elements of your DSL can be visualized, choose the <b>uml</b> element types set from the <code>org.eclipse.papyrus.uml.service.types</code> plug-in. This option has the advantage that if your profile has stereotypes extending metaclasses in several different diagrams, you will need only the one assistants model to cover all of those diagrams.</p><p>However, there are some drawbacks that you will have to account for. The most important of these is that, as generated, the assistants model has to infer on-the-fly specializations of your profile element types for the various visual ID hinted types supported by the different specific diagrams. This inference is automatic and can result in</p><ul><li>repetition of the same element type (for different visual IDs) on some selections</li><li>presentation of element types in contexts that actually are inappropriate (such as N-ary association branch in a use case diagram) if the diagram's view provider is not sufficiently specific about the visualizations that it supports</li></ul><p>These problems can usually be remedied by careful crafting of filters to restrict the applicability of each assistant. It may be necessary in some cases to resort to custom filters.</p><h3 id="Generating_Diagram-specific_Assistants">Generating Diagram-specific Assistants</h3><p>To generate modeling assistants that are applicable only to a particular diagram in which the elements of your DSL can be visualized, choose that diagram's element types set from the list (the example screen shot above shows the Use Case Diagram selected). This option has the advantage of giving the most accurate/appropriate assistants out of the box but it does require a separate model for each diagram that your DSL covers.</p><p>In this case, the element types generated for your assistants are specializations of the particular visual-ID hinted types supported by the diagram for the different visualizations, in that diagram context, of the base UML metaclass. The most significant customization that you would do after generating the assistants model is to delete assistants that are not required.</p><p>By default, the wizard will also reference a second supertype in each generated specialization element type: an element type representing the -stereotyped element in the model, irrespective of any visualization in the diagram. This is effectively referencing the element type that would be -generated in the "Generic UML-based Assistants" case, asdescribed above. At run-time, these "semantic element types" will be expected to be -available, so it is necessary to generate them using the <b>Generate Tooling Model → Element Types...</b> action in the context menu and -selecting the generic UML element types as the base model. However, the reference to the semantic super-types may be ommitted, if desired, by -checking the <b>Suppress semantic parent in diagram-specific element types</b> box in the wizard.</p><h2 id="Considerations_for_Designing_Assistants_Models">Considerations for Designing Assistants Models</h2><p>The most important considerations in designing assistant models are appropriateness of the element types suggested to the user and the number of element types suggested to the user.</p><p>As discussed above, the generation of the assistants model just provides a starting point that needs to be fine-tuned. The generator outputs every combination that seems to be valid; these need to be culled in practice. Some assistants are not valid in every context where they may be shown (which requires customization of their filters) whereas many assistants just may not be necessary because they are element types that are rarely used, or only in advanced use cases.</p><p>Of particular concern is the scaling of the diagram assistants user interface: it is important not to overwhelm users with too many options. There is a practical limit to how large the pop-up bar can be before its usability degrades; likewise the menus that are popped up for completion of connections. When designing the assistants model for your profile, keep in mind that the diagram assistants will include proposals from five sources:</p><ul><li>the base UML assistants models deployed by Papyrus for each of the diagrams</li><li>the assistant models deployed by Papyrus for first-party profiles such as SysML and UML-RT</li><li>assistant models deployed from the workspace or in third-party plug-ins for other profiles</li><li>the assistant model that you are designing for your profile</li><li>the pop-up bar shows hyperlinks created by the user, in addition to the green "plus" button for creation of new hyperlinks</li></ul><p>The number of assistants presented on any given selection in a diagram can add up rather quickly. Precise filtering of assistants is critical and restricting the overall number of assistants that are defined to only the most commonly used elements is highly recommended.</p><h1 id="Deploying_a_Diagram_Assistants_Model">Deploying a Diagram Assistants Model</h1><p>There are two ways to deploy diagram assistants. The assistants in a <code>*.assistants</code> resource can be hot-deployed directly from the workspace or they may be statically deployed in a plug-in installed in the Papyrus workbench.</p><h2 id="Deploying_Models_in_the_Host_Workbench">Deploying Models in the Host Workbench</h2><p>The simplest method, which is best for testing during development of the assistants model, is to deploy the assistants model in your workspace directly into the running Papyrus workbench. In the <b>Project Explorer</b>, select your assistants model and choose the <b>Deploy Modeling Assistants</b> action in the context menu:</p><p><img border="0" src="images/deploy.png"/></p><p>Note that you may first need to deploy the element types configuration model if you have not already done so.</p><p>From this point, the assistants described in your model are active in the system. Whenever you save changes, the model is "hot re-deployed" to update the diagrams in real time. Papyrus remembers which assistant models in the workspace are deployed so that you don't have to deploy them again the next time you open that workspace.</p><p>To remove the assistants in a model from the Papyrus run-time, just select the <b>Deactivate Modeling Assistants</b> action in the context menu:</p><p><img border="0" src="images/undeploy.png"/></p><h2 id="Deploying_Models_in_Plug-ins">Deploying Models in Plug-ins</h2><p>When your assistants model is ready to ship, together with your profile and other DSL tooling, you should deploy it statically in the plug-in that installs your profile into your users' Papyrus workbenches. Simply bundle the <code>*.assistants</code> resource in your plug-in and register it on the <code>org.eclipse.papyrus.infra.gmfdiag.assistants.modelProviders</code> extension point just as Papyrus, itself, does for the core UML diagram assistants:</p><p><img border="0" src="images/providers-extpt.png"/></p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/build.properties b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/build.properties index 51024c6f314..073e47dfbc3 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/build.properties @@ -3,5 +3,6 @@ bin.includes = META-INF/,\ plugin.xml,\
plugin.properties,\
about.html,\
- resource/
-src.includes = about.html + target/generated-eclipse-help/**
+src.includes = about.html,\
+ resource/ diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/plugin.xml index 08907a88250..baf1deb2d2f 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/plugin.xml @@ -4,11 +4,11 @@ <extension
point="org.eclipse.help.toc">
<toc
- file="resource/search-main-toc.xml"
+ file="target/generated-eclipse-help/search-main-toc.xml"
primary="false">
</toc>
<toc
- file="resource/search-toc.xml"
+ file="target/generated-eclipse-help/search-toc.xml"
primary="false">
</toc>
</extension>
diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/pom.xml index b0ddf3c7987..a855dedce90 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/C-result.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/C-result.png Binary files differindex 6b5e8b1d262..6b5e8b1d262 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/C-result.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/C-result.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/C-search.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/C-search.png Binary files differindex bd99157a3c7..bd99157a3c7 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/C-search.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/C-search.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/OCL.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/OCL.png Binary files differindex 8aa959e3ea7..8aa959e3ea7 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/OCL.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/OCL.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/a-results.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/a-results.png Binary files differindex 9669ff43c22..9669ff43c22 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/a-results.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/a-results.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/a-search.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/a-search.png Binary files differindex 3e3b7542f8e..3e3b7542f8e 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/a-search.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/a-search.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/advanced_search.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/advanced_search.png Binary files differindex 5d8932cfe9a..5d8932cfe9a 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/advanced_search.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/advanced_search.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/body_result.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/body_result.png Binary files differindex 38b096c9671..38b096c9671 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/body_result.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/body_result.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/body_search.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/body_search.png Binary files differindex 7a88be13b15..7a88be13b15 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/body_search.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/body_search.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/comment-result.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/comment-result.png Binary files differindex 0039b81f4fb..0039b81f4fb 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/comment-result.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/comment-result.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/comment-search.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/comment-search.png Binary files differindex fa6b2ef026d..fa6b2ef026d 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/comment-search.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/comment-search.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/filter.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/filter.png Binary files differindex 87c456b6b46..87c456b6b46 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/filter.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/filter.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/my-filtered.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/my-filtered.png Binary files differindex 50a22cd3d3c..50a22cd3d3c 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/my-filtered.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/my-filtered.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/my-search.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/my-search.png Binary files differindex b3cc3c8a2d0..b3cc3c8a2d0 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/my-search.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/my-search.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/papyrus-search.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/papyrus-search.png Binary files differindex f5cdc6f98af..f5cdc6f98af 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/papyrus-search.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/papyrus-search.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/query_kind.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/query_kind.png Binary files differindex 2ec1ff8e877..2ec1ff8e877 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/query_kind.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/query_kind.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/replace.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/replace.png Binary files differindex 32e0df131ea..32e0df131ea 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/replace.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/replace.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/requirement_result.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/requirement_result.png Binary files differindex 93156cf8603..93156cf8603 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/requirement_result.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/requirement_result.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/requirement_search.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/requirement_search.png Binary files differindex c7fa4152bc1..c7fa4152bc1 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/requirement_search.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/requirement_search.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search-model1.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/search-model1.png Binary files differindex 6c540f51972..6c540f51972 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search-model1.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/search-model1.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search_kind.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/search_kind.png Binary files differindex ebb7fb584bc..ebb7fb584bc 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search_kind.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/search_kind.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/select-filters.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/select-filters.png Binary files differindex f0f5f668f2c..f0f5f668f2c 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/select-filters.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/select-filters.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/simple_search.png b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/simple_search.png Binary files differindex 8ab34b99fdd..8ab34b99fdd 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/simple_search.png +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/images/simple_search.png diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search-main-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search-main-toc.xml index 14ecc4b1eb5..ba4f15b99a1 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search-main-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search-main-toc.xml @@ -1,7 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?>
<toc label="Search" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser">
- <topic href="resource/search.html" label="Search in Models">
- <link toc="resource/search-toc.xml"/>
+ <topic href="target/generated-eclipse-help/search.html" label="Search in Models">
+ <link toc="target/generated-eclipse-help/search-toc.xml"/>
<anchor id="SearchID"/>
</topic>
diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search-toc.xml b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search-toc.xml deleted file mode 100644 index 200de63be1a..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search-toc.xml +++ /dev/null @@ -1,6 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc label="search" topic="resource/search.html"> - <topic href="resource/search.html" label="Search elements"></topic> - <topic href="resource/search.html#Replace_String" label="Replace String"></topic> - <topic href="resource/search.html#Filter" label="Filter"></topic> -</toc> diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search.html b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search.html deleted file mode 100644 index 978df0a3cd5..00000000000 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search.html +++ /dev/null @@ -1,6 +0,0 @@ -<?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>In this documentation, we will use this UML model to illustrate the search features. </p><p><img border="0" src="search-model1.png"/></p><h1 id="Search_elements">Search elements</h1><p>The search feature of Papyrus helps the user to find elements in the models. The user can choose between a text search and an OCL search.</p><p>As it is shown in the following image the user chooses the query kind he wants to use: </p><p><img border="0" src="query_kind.png"/> </p><h1 id="Text_search">Text search</h1><p>The user can do a simple search or an advanced search. -The user makes his choice in the A area of the following image which represents the text search dialog.</p><p><img border="0" src="search_kind.png"/> </p><h2 id="Simple_search">Simple search</h2><p>The following image illustrates a simple text search dialog:</p><p><img border="0" src="simple_search.png"/> </p><ul><li>The user can specify the string pattern he/she is looking for in the A area. <ul><li>Check the "Case sensitive" if case must be considered. </li><li>The user may also want to use regular expression to express the query. Then check "Regular expression" button. The regular expression must respect Java Regex.</li></ul></li><li>The user chooses whether he wants to search only in the name attribute of instances of UML::NamedElement or in all string attributes of instances of UML metaClasses, in B area.</li></ul><p>For instance, the following search: </p><p><img border="0" src="C-search.png"/></p><p>will provide the following results: </p><p><img border="0" src="C-result.png"/></p><p>The comment is not returned because we were note looking for all string attributes. </p><p>However, this search:</p><p><img border="0" src="comment-search.png"/></p><p>will return : </p><p><img border="0" src="comment-result.png"/></p><h2 id="Advanced_search">Advanced search</h2><p>The following image shows the advanced text search dialog.</p><p><img border="0" src="advanced_search.png"/></p><ul><li>As in the simple search the user can specify the string pattern he/she is looking for, and may indicate if he uses regular expression or if he wants to consider case, in the A area. </li><li>The user can filter the types of elements to search the string pattern in by selecting the UML metaClasses or applied stereotypes in area B . He can also choose in which attributes he wants to do the research. The stereotypes displayed in the B area are the stereotypes which can be applied on elements from the model(s) corresponding to the selected scope, for example if the selected scope is "Selected resources" only the stereotypes defined in the profiles applied on the current model will be displayed, but if the selected scope is "Workspace" the stereotypes defined in all the profiles applied on models from the current workspace will be displayed.</li><li>In the C area, the user can select all subelements of the actual selected element. For example, if the user selects "NamedElement" and clicks on "Select subelements",all metaClasses which inherit of UML::NamedElement will be checked. If the name attribute of "NamedElement" is checked and the user selects "NamedElement" and then clicks on "Select subelements",all instances of UML::NamedElement and their name attribute will be checked. If the user changes the selected scope he should click on the refresh types button, this will update the list of stereotypes displayed.</li><li>The user can specify, in the D area, if he wants to search for model elements with all the specified stereotype (the ones checked in the B area).</li></ul><p>In the following image we search the pattern "my" in the attribute body of the metaClass "Comment". The research will give us all the instances of "Comment" having an attribute body matching with the string pattern. </p><p><img border="0" src="body_search.png"/></p><p>The result will be</p><p><img border="0" src="body_result.png"/></p><p>If the user select a stereotype or an UML metaClass without indicating a string pattern, the research will give him all the instances of the metaClasses he checked and all the elements having the applied stereotypes he checked.</p><p>For example the result of this research:</p><pre><img border="0" src="requirement_search.png"/> -</pre><p>will be</p><pre><img border="0" src="requirement_result.png"/> -</pre><h1 id="OCL_search">OCL search</h1><p>The following image shows an OCL search dialog</p><p><img border="0" src="OCL.png"/></p><p>The user writes his OCL query in the A area. -The scope must be "Selected resources" if the user wants to do this kind of query.</p><h1 id="Replace_String">Replace String</h1><p>Should the user want to replace the matches of your search with another string, he/she may click on the "Replace" button in the search dialog. A new dialog will popup:</p><p><img border="0" src="replace.png"/></p><p>More details about the refactoring tool in the Model Refactor Wizard page.</p><h1 id="Filter">Filter</h1><p>The user can filter the results of the search by selecting the types of the elements he/she wants to show.</p><p>For instance, on the following search (we use the model 1): </p><p><img border="0" src="a-search.png"/></p><p>the user may filter the results by clicking on the icon identified in a red rectangle in the following picture: </p><p><img border="0" src="a-results.png"/></p><p>this will open a new dialog where the user can select the metaclasses he/she want to show: </p><p><img border="0" src="filter.png"/></p><p>then, the result page will show only the matches of the selected type: </p><p><img border="0" src="my-filtered.png"/></p><p>If the user wants to remove this filtering, he/she may click on the Filters button as illustrated in previous picture. This will open the following dialog: </p><p><img border="0" src="select-filters.png"/></p><p><hr/> -This work is developed by <a href="http://www-list.cea.fr">CEA LIST</a> and sponsored by <a href="http://www.ericsson.com">Ericsson</a> in the context of Polarsys <a href="http://wiki.eclipse.org/Polarsys">http://wiki.eclipse.org/Polarsys</a></p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search.mediawiki b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search.mediawiki index 444807ed899..a3cbd8bdafa 100644 --- a/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.uml.search.ui.doc/resource/search.mediawiki @@ -1,25 +1,25 @@ In this documentation, we will use this UML model to illustrate the search features.
-[[image:search-model1.png]]
+[[Image:images/search-model1.png]]
=Search elements=
The search feature of Papyrus helps the user to find elements in the models. The user can choose between a text search and an OCL search.
As it is shown in the following image the user chooses the query kind he wants to use:
-[[image:query_kind.png]]
+[[Image:images/query_kind.png]]
=Text search=
The user can do a simple search or an advanced search.
The user makes his choice in the A area of the following image which represents the text search dialog.
-[[image:search_kind.png]]
+[[Image:images/search_kind.png]]
==Simple search==
The following image illustrates a simple text search dialog:
-[[image:simple_search.png]]
+[[Image:images/simple_search.png]]
* The user can specify the string pattern he/she is looking for in the A area.
** Check the "Case sensitive" if case must be considered.
@@ -28,26 +28,26 @@ The following image illustrates a simple text search dialog: For instance, the following search:
-[[image:C-search.png]]
+[[Image:images/C-search.png]]
will provide the following results:
-[[image:C-result.png]]
+[[Image:images/C-result.png]]
The comment is not returned because we were note looking for all string attributes.
However, this search:
-[[image:comment-search.png]]
+[[Image:images/comment-search.png]]
will return :
-[[image:comment-result.png]]
+[[Image:images/comment-result.png]]
==Advanced search==
The following image shows the advanced text search dialog.
-[[image:advanced_search.png]]
+[[Image:images/advanced_search.png]]
* As in the simple search the user can specify the string pattern he/she is looking for, and may indicate if he uses regular expression or if he wants to consider case, in the A area.
* The user can filter the types of elements to search the string pattern in by selecting the UML metaClasses or applied stereotypes in area B . He can also choose in which attributes he wants to do the research. The stereotypes displayed in the B area are the stereotypes which can be applied on elements from the model(s) corresponding to the selected scope, for example if the selected scope is "Selected resources" only the stereotypes defined in the profiles applied on the current model will be displayed, but if the selected scope is "Workspace" the stereotypes defined in all the profiles applied on models from the current workspace will be displayed.
@@ -58,28 +58,28 @@ The following image shows the advanced text search dialog. In the following image we search the pattern "my" in the attribute body of the metaClass "Comment". The research will give us all the instances of "Comment" having an attribute body matching with the string pattern.
-[[Image:body_search.png]]
+[[Image:images/body_search.png]]
The result will be
-[[Image:body_result.png]]
+[[Image:images/body_result.png]]
If the user select a stereotype or an UML metaClass without indicating a string pattern, the research will give him all the instances of the metaClasses he checked and all the elements having the applied stereotypes he checked.
For example the result of this research:
- [[Image:requirement_search.png]]
+ [[Image:images/requirement_search.png]]
will be
- [[Image:requirement_result.png]]
+ [[Image:images/requirement_result.png]]
=OCL search=
The following image shows an OCL search dialog
-[[Image:OCL.png]]
+[[Image:images/OCL.png]]
The user writes his OCL query in the A area.
The scope must be "Selected resources" if the user wants to do this kind of query.
@@ -88,7 +88,7 @@ The scope must be "Selected resources" if the user wants to do this kind of quer =Replace String=
Should the user want to replace the matches of your search with another string, he/she may click on the "Replace" button in the search dialog. A new dialog will popup:
-[[Image:replace.png]]
+[[Image:images/replace.png]]
More details about the refactoring tool in the Model Refactor Wizard page.
@@ -97,23 +97,23 @@ The user can filter the results of the search by selecting the types of the elem For instance, on the following search (we use the model 1):
-[[image:a-search.png]]
+[[Image:images/a-search.png]]
the user may filter the results by clicking on the icon identified in a red rectangle in the following picture:
-[[image:a-results.png]]
+[[Image:images/a-results.png]]
this will open a new dialog where the user can select the metaclasses he/she want to show:
-[[image:filter.png]]
+[[Image:images/filter.png]]
then, the result page will show only the matches of the selected type:
-[[image:my-filtered.png]]
+[[Image:images/my-filtered.png]]
If the user wants to remove this filtering, he/she may click on the Filters button as illustrated in previous picture. This will open the following dialog:
-[[image:select-filters.png]]
+[[Image:images/select-filters.png]]
----
This work is developed by [http://www-list.cea.fr CEA LIST] and sponsored by [http://www.ericsson.com Ericsson] in the context of Polarsys [http://wiki.eclipse.org/Polarsys]
diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/build.properties b/plugins/doc/org.eclipse.papyrus.views.properties.doc/build.properties index 43e3cf466aa..064e816b187 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/build.properties +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/build.properties @@ -1,6 +1,6 @@ bin.includes = META-INF/,\
about.html,\
plugin.xml,\
- resource/,\
- resource/properties-view-main-toc.xml
-src.includes = about.html
+ target/generated-eclipse-help/**
+src.includes = about.html,\
+ resource/
diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.views.properties.doc/plugin.xml index 2da83e6a412..3559a4b0d41 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/plugin.xml +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/plugin.xml @@ -4,11 +4,11 @@ <extension
point="org.eclipse.help.toc">
<toc
- file="resource/properties-view-main-toc.xml"
+ file="target/generated-eclipse-help/properties-view-main-toc.xml"
primary="false">
</toc>
<toc
- file="resource/properties-view-toc.xml"
+ file="target/generated-eclipse-help/properties-view-toc.xml"
primary="false">
</toc>
</extension>
diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/pom.xml b/plugins/doc/org.eclipse.papyrus.views.properties.doc/pom.xml index aacd4505ae3..da9b0400e6e 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/pom.xml +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/pom.xml @@ -11,4 +11,38 @@ <groupId>org.eclipse.papyrus</groupId> <version>1.1.0-SNAPSHOT</version> <packaging>eclipse-plugin</packaging> + <build> + <plugins> + <plugin> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.core.maven</artifactId> + <configuration> + <sourceFolder>resource</sourceFolder> + <outputFolder>${project.build.directory}/generated-eclipse-help</outputFolder> + <!-- copyrightNotice>${help.copyrightNotice}</copyrightNotice> <title>${help.documentTitle}</title --> + <multipleOutputFiles>false</multipleOutputFiles> + <navigationImages>true</navigationImages> + <formatOutput>true</formatOutput> + <htmlFilenameFormat>$1.html</htmlFilenameFormat> + <xmlFilenameFormat>$1-toc.xml</xmlFilenameFormat> + <helpPrefix>target/generated-eclipse-help</helpPrefix> + <!-- stylesheetUrls> <param>styles/main.css</param> </stylesheetUrls --> + </configuration> + <executions> + <execution> + <goals> + <goal>eclipse-help</goal> + </goals> + </execution> + </executions> + <dependencies> + <dependency> + <groupId>org.eclipse.mylyn.docs</groupId> + <artifactId>org.eclipse.mylyn.wikitext.mediawiki.core</artifactId> + <version>${mylyn.wikitext.version}</version> + </dependency> + </dependencies> + </plugin> + </plugins> + </build> </project>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig1.png b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig1.png Binary files differindex 3d2d1cc8400..3d2d1cc8400 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig1.png +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig1.png diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig10.png b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig10.png Binary files differindex 821f836738c..821f836738c 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig10.png +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig10.png diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig11.png b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig11.png Binary files differindex 2d4b2083184..2d4b2083184 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig11.png +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig11.png diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig12.png b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig12.png Binary files differindex f204a909cd7..f204a909cd7 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig12.png +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig12.png diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig13.png b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig13.png Binary files differindex b6ae9861817..b6ae9861817 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig13.png +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig13.png diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig14.png b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig14.png Binary files differindex 81746438e79..81746438e79 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig14.png +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig14.png diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig2.png b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig2.png Binary files differindex b5712ef6266..b5712ef6266 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig2.png +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig2.png diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig3.png b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig3.png Binary files differindex 8f7403353cd..8f7403353cd 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig3.png +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig3.png diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig4.png b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig4.png Binary files differindex 52c37965379..52c37965379 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig4.png +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig4.png diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig5.png b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig5.png Binary files differindex ebff4ac7ee5..ebff4ac7ee5 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig5.png +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig5.png diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig6.png b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig6.png Binary files differindex 806380aced8..806380aced8 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig6.png +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig6.png diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig7.png b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig7.png Binary files differindex b0968464086..b0968464086 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig7.png +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig7.png diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig8.png b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig8.png Binary files differindex f76736bca29..f76736bca29 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig8.png +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig8.png diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig9.png b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig9.png Binary files differindex cc2a2e442a0..cc2a2e442a0 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/fig9.png +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/images/fig9.png diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/properties-view-main-toc.xml b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/properties-view-main-toc.xml index 8c3854bcdd3..f026f340756 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/properties-view-main-toc.xml +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/properties-view-main-toc.xml @@ -1,7 +1,7 @@ <?xml version='1.0' encoding='utf-8' ?>
<toc label="Search" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser">
- <topic href="resource/properties-view.html" label="Properties view customization">
- <link toc="resource/properties-view-toc.xml"/>
+ <topic href="target/generated-eclipse-help/properties-view.html" label="Properties view customization">
+ <link toc="target/generated-eclipse-help/properties-view-toc.xml"/>
<anchor id="properties-view"/>
</topic>
</toc>
diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/properties-view-toc.xml b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/properties-view-toc.xml deleted file mode 100644 index be8502d6810..00000000000 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/properties-view-toc.xml +++ /dev/null @@ -1,27 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="resource/properties-view.html" label="properties-view"> - <topic href="resource/properties-view.html" label="INTRODUCTION"></topic> - <topic href="resource/properties-view.html#THE_CUSTOMIZATION_TOOL" label="THE CUSTOMIZATION TOOL"> - <topic href="resource/properties-view.html#Edit_a_configuration" label="Edit a configuration"></topic> - <topic href="resource/properties-view.html#The_property_view_elements" label="The property view elements"> - <topic href="resource/properties-view.html#Preview" label="Preview"></topic> - <topic href="resource/properties-view.html#Property_view" label="Property view"></topic> - </topic> - <topic href="resource/properties-view.html#Priorities_between_views" label="Priorities between views"></topic> - <topic href="resource/properties-view.html#Preferences" label="Preferences"></topic> - </topic> - <topic href="resource/properties-view.html#ADVANCED_CUSTOMIZATION" label="ADVANCED CUSTOMIZATION"> - <topic href="resource/properties-view.html#The_Environment_model" label="The Environment model"></topic> - <topic href="resource/properties-view.html#Create_a_new_widget" label="Create a new widget"></topic> - <topic href="resource/properties-view.html#Constraints" label="Constraints"></topic> - <topic href="resource/properties-view.html#ModelElement" label="ModelElement"></topic> - <topic href="resource/properties-view.html#ModelElement_Factory" label="ModelElement Factory"></topic> - <topic href="resource/properties-view.html#Content_Providers_and_Widgets" label="Content Providers and Widgets"></topic> - <topic href="resource/properties-view.html#Dynamic_sections" label="Dynamic sections"></topic> - <topic href="resource/properties-view.html#Property_view_Header" label="Property view Header"></topic> - <topic href="resource/properties-view.html#Binding_and_Validation" label="Binding and Validation"></topic> - <topic href="resource/properties-view.html#Field_coloration" label="Field coloration"></topic> - </topic> - <topic href="resource/properties-view.html#GENERATION_TOOL" label="GENERATION TOOL"></topic> - <topic href="resource/properties-view.html#DEPLOYING_A_PROPERTY_VIEW" label="DEPLOYING A PROPERTY VIEW"></topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/properties-view.html b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/properties-view.html deleted file mode 100644 index 5749a8205f3..00000000000 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/properties-view.html +++ /dev/null @@ -1,6 +0,0 @@ -<?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="INTRODUCTION">INTRODUCTION</h2><p>In UML, the main information is represented in graphical diagrams. However, it is not always possible to represent graphically the whole semantic of UML, not talking of all the cosmetic properties. For example, it is pretty easy to represent and to edit a Class’ name graphically. While we still can represent the “is abstract” property graphically (By using the italic font for the Class’ name), it is harder to edit this property directly from the diagram. Worse, the “is leaf” property doesn’t even have a graphical representation. Thus, we often need a different view for representing all the properties of a UML Element, without polluting the graphical view.</p><p>As UML is highly extensible, through the mean of Profiles, it is also important to be able to represent and edit the profile’s properties, without managing everything from the diagram view.</p><p>Eclipse provides a standard view for these properties: the Properties Page. This view is a table representing all the properties available for the selected Element, including the ones that cannot be represented or edited graphically. This view is pretty useful, but is neither really user-friendly nor optimal, as it may require up to four clicks to simply edit a comment’s body. Moreover, it can only be extended via Java code, which requires some technical skills and prevents a dynamic modification of the view, as the Java code needs to be recompiled after each modification.</p><p>There is an extension of the base Property View framework, still in the standard Eclipse implementation, which fixes some of these problems. It is called the “Eclipse Tabbed Properties View” framework. It provides a better look and feel for the property view, with more flexibility, and a better usability. However, it keeps being difficult to customize, as it still hard-coded in Java.</p><p>Papyrus provides its own Property View framework, based on the Tabbed Property View framework. The Papyrus Property View can be extended in two ways:</p><ul><li>Dynamically, for the layout of the property view: show/hide a property, reorder the properties, add/remove a tab…</li><li>Statically, through Java code, for advanced operations: create a new widget for editing the properties, add a custom Content Provider for selecting a reference value…</li></ul><p>This document aims at detailing all the features related to the property view customization, both dynamically and statically.</p><h2 id="THE_CUSTOMIZATION_TOOL">THE CUSTOMIZATION TOOL</h2><p>Most customizations can be done through the Property view customization Editor. It provides native support for EMF Models, UML models and profiles. It also provides a set of basic widgets and property editors.</p><h3 id="Edit_a_configuration">Edit a configuration</h3><p>Each property view configuration is defined in a different set of files. Each configuration can contain elements from different contexts, but we typically have one configuration per Ecore Metamodel or UML Profile (i.e. one configuration for UML, one for the Diagram Appearance tab, another one for the SysML profile…)</p><p>To see the list of available configurations, open the properties view (Window -> Show View -> Other… -> General/Properties). Click on the white arrow in the upper right corner of the Properties view, and select “Customize property view”. You should see a dialog with the list of all available configurations.</p><p><img title="Open the property view customization menu" alt="Open the property view customization menu" border="0" src="fig1.png"/></p><p>As the standard configurations are read-only, you cannot edit them directly. You will first need to make a copy of the configuration. You will then be able to edit the copy.</p><p><img title="Copy an existing configuration to edit it" alt="Copy an existing configuration to edit it" border="0" src="fig2.png"/></p><p>The Property View Editor has three panes:</p><ul><li>The Editor part</li><li>The Preview part</li><li>The Properties part</li></ul><p>The Editor presents the elements defined by this configuration. The Preview displays an overview of the selected View, as it will be displayed in the property view at runtime. The properties view displays the properties of the selected element</p><p><img title="The property view Editor" alt="The property view Editor" border="0" src="fig3.png"/></p><h3 id="The_property_view_elements">The property view elements</h3><p>The editor contains a Tree, containing the following elements :</p><ul><li>Context: it is a property view configuration. You will typically have one property view Context per Ecore Metamodel or UML Profile, but you can choose the granularity you want. A context has a list of tabs, and a list of views.</li><li>Tab: describes a tab in the property view. A tab has a label, an (optional) image, and can be indented. It also has a priority.</li><li>View: describes a property view associated to a selection. The view has a name, a constraint, a multiplicity and a list of sections. The constraint is used to determine for what kind of object the view should be displayed.</li><li>Constraint: a query that inputs a selection, and outputs a boolean (true if the constraint matches the input object, false otherwise). It is possible to implement your own constraint type (In Java).</li><li>Section: a section is a sub-part of a view. A view generally needs only one section, but there are cases where you need more than one section. A section is associated to a single tab, so, if you want to display more than one tab in a single view (For example, « UML » and « Profile » in the UML property view), you will need at least two sections in that view (One for each tab). Another (advanced) case is described in « Dynamic sections ». A section has a name, a tab, and a Composite.</li><li>Composite: this is the actual presentation element. The composite is a widget which can contain other widgets. A composite has a type, and a list of widgets.</li><li>Layout: all composites need a layout. The default is « PropertiesLayout », which is a variant of the SWT standard GridLayout. A PropertiesLayout has a number of columns. The default is one column.</li><li>Property Editor: a property editor is a widget which is used to edit a single property of the selected object. You will typically have one Property editor for each property that you want to edit in the property view. The property editor has a property, and a widget to edit that property.</li><li>Standard Widget: a widget from the standard SWT Library. Few of them are currently available, because they are rarely needed.</li></ul><p>The Tree allows reordering or removing easily the elements (Through drag & drop, delete). The editor also supports the Undo/Redo commands.</p><h4 id="Preview">Preview</h4><p>The preview displays a real-time overview of the selected View. However, some widgets can only be computed at runtime, which prevents a pertinent preview. This is the case of the “Enum Radio” widget, for example, as the enumerated values are only known at runtime.</p><h4 id="Property_view">Property view</h4><p>The property view is used to edit the properties of the element selected in the tree. The property view uses the Papyrus Property View framework, thus can be customized just the same way you would customize any other property view.</p><p><img title=" the three panes of the Property view editor" alt=" the three panes of the Property view editor" border="0" src="fig4.png"/></p><h3 id="Priorities_between_views">Priorities between views</h3><p>When more than one view match a selection, a priority mechanism will determine which one(s) should be displayed. The priorities are defined at the level of the view’s constraints, i.e. if the constraint for a View A overrides a constraint for the View B, the View B won’t be displayed. For example, a UML Class from a Class Diagram will match many views (The list is not exhaustive):</p><ul><li>SingleClass (From UML)</li><li>MultipleClass (As the -1 multiplicity actually means “any number of elements”)</li><li>SingleElement (And MultipleElement)</li><li>SingleClassifier (And MultipleClassifier)</li><li>*Style (From GMF Notation model)</li><li>StereotypeDisplay (From UML Notation model)</li></ul><p>The priorities are computed in two ways:</p><ul><li>Automatic, according to the Java constraints implementations</li><li>Statically, according to the property view configuration</li></ul><p>When the “isOverrideable” property is set to false for a Constraint (In the property view model), only the static rules will be taken into account.</p><p><img title="The constraint cannot be dynamically overridden" alt="The constraint cannot be dynamically overridden" border="0" src="fig5.png"/></p><p>The automatic rules are the following:</p><ul><li>A constraint with a multiplicity of 1 always overrides the same constraint with a multiplicity of -1 (Or >1). Thus, “MultipleClass” won’t be displayed, because “SingleClass” also matches our selection.</li><li>An EMF (Or UML) “Instance of” constraint always overrides a constraint matching a supertype. Thus, “SingleClassifier” won’t be displayed, because a Class is more specific than a Classifier. However, “SingleElement” *will be* displayed, because it is not overrideable (isOverrideable=false).</li><li>A stereotype constraint (HasStereotype) will *not* override its UML “Instance of” constraint. However, a specific implementation of this constraint has been provided for Scade, which *will* override the UML metaclass (i.e., a Block will override a Class’ property view, hiding the UML tab).</li><li>For CompositeConstraints: if a composite constraint is a superset of another constraint, it will override it (It is more specific). For example, a Composite Constraint “isA and isB” will override a constraint “isB”, but will not override a constraint “isB and isC”.</li></ul><p>Please note that each constraint has its own implementation of the overrides() method. See the advanced chapter for more information</p><p>The static rule is simple: when a Constraint explicitly overrides another constraint, it will always override it. This is especially useful when you’ve marked a constraint as “overrideable=false”, but still want to override it in a specific case (Remember that overrideable=false only applies to *automatic* constraint resolution).</p><p><img title="Force this constraint to override another constraint" alt="Force this constraint to override another constraint" border="0" src="fig6.png"/></p><p>Finally, in the previous example, the following views will be displayed:</p><ul><li>SingleClass (Overrides MultipleClass, Single/MultipleClassifier ; UML Tab)</li><li>SingleElement (overrideable=false ; Profile tab)</li><li>FillStyle, FontStyle, LineStyle (Appearance tab)</li><li>StereotypeDisplay (overrideable=false ; Appearance tab)</li></ul><h3 id="Preferences">Preferences</h3><p>When you make a copy of a property view, it is not automatically activated. Thus, the modifications brought to the copy are not immediately visible on your property view. To activate a property view, you need to open the Papyrus preferences, from Window > Preferences.</p><p><img title="Preferences" alt="Preferences" border="0" src="fig7.png"/></p><p>When making a copy of an existing configuration, you should uncheck the default one, and check the new one.</p><h2 id="ADVANCED_CUSTOMIZATION">ADVANCED CUSTOMIZATION</h2><p>The customization tool only allows basic operations, such as adding, removing or reordering properties.</p><p>The property view framework is much more powerful, but this requires some Java development. This chapter will focus on the advanced customization of the property view.</p><h3 id="The_Environment_model">The Environment model</h3><p>To associate Java implementations with the property view model, you need to declare an Environment model. You can create a new Environment model with the “Environment Model” wizard in “Example EMF Model Creation Wizards” category. Select “Environment” as the Model Object.</p><p>Once you’ve added your Java class declarations, you should register the environment model so that the property view knows about it. Add an extension to org.eclipse.papyrus.properties.environment, and select your model file.</p><h3 id="Create_a_new_widget">Create a new widget</h3><p>You can create new widgets for the property view. There are four kinds of graphical elements: CompositeWidget, Layout, StandardWidget and PropertyEditor. -The widgets contain three common fields:</p><ul><li>Label: The label displayed in the Customization editor when the user selects a widget type.</li><li>Namespace: The XWT namespace associated to the Widget.</li><li>WidgetClass: The simple name of the Java class implementing the Widget.</li></ul><p>The PropertyEditor contains two additional fields:</p><ul><li>Multiplicity: The multiplicity of the properties it can handle (1 for single-valued properties, -1 for multivalued properties)</li><li>Type: The type of the properties it can handle.</li></ul><p>To implement a Composite, Layout or Standard widget, you should simply follow the SWT rules, i.e. extend either Composite, Canvas or Layout, and have a (Composite, int) constructor. To define a PropertyEditor, you have two options:</p><ul><li>Extend Composite, have a (Composite, int) constructor, and implement the CustomizablePropertyEditor interface (From org.eclipse.papyrus.properties.widgets)</li><li>Extend directly AbstractPropertyEditor (From org.eclipse.papyrus.properties.widgets)</li></ul><h3 id="Constraints">Constraints</h3><p>Adding a Constraint is similar to creating a new Widget. You have two options to implement a new Constraint:</p><ul><li>Implement the Constraint interface (From org.eclipse.papyrus.properties.constraints)</li><li>Extend the AbstractConstraint class (From org.eclipse.papyrus.properties.constraints)</li></ul><p>The important methods are the following (depending on whether you’re implement Constraint or extending AbstractConstraint):</p><ul><li>setDescriptor/setConstraintDescriptor: <ul><li>Configures the constraint.</li></ul></li><li>match(Object)/match(IStructuredSelection) : Boolean<ul><li>Indicates whether this constraint matches the given given or not</li></ul></li><li>overrides(Constraint) : Boolean<ul><li>Indicates whether this constraint overrides another constraint or not. A constraint should override another constraint when it is more specific.</li></ul></li><li>equivalent(Constraint) : Boolean<ul><li>This is only used by AbstractConstraint. Two constraints are equivalent if they have the same parameters (ConstraintDescriptor). Two equivalent constraints can have different multiplicities.</li></ul></li></ul><p>The equivalent() and overrides() methods are used to automatically resolve constraints conflicts (Two different constraints matching the same element). -Once the Constraint is implemented, don’t forget to register it in your environment model.</p><h3 id="ModelElement">ModelElement</h3><p>The ModelElement is the interface between the property view and your domain model. It is used to retrieve information about the object(s) being edited from the property. These informations will be used to configure the widget. AbstractModelElement provides a base implementation for this interface.</p><p>All methods from this interface take a single parameter, which is the name of the property being edited.</p><ul><li>getObservable(String) / doGetObservable(String) :</li></ul><p>This method returns an IObservable which will be used to read and write a single property from the represented object. It should return an IObservableValue for single-valued properties, and IObservableList for multi-valued properties.</p><ul><li>getContentProvider(String) :</li></ul><p>This method is only used for reference and enumerated properties. It should return a list of values which can be set to the edited property. Unlike IStructuredContentProvider, this provider will not rely on a StructuredViewer to retrieve an input object: the method getElement() will be called without any parameter, so the implementation should be able to retrieve its own typically. This will typically be achieved by passing a context object in the provider’s constructor.</p><ul><li>getLabelProvider(String) :</li></ul><p>This method is used to display an element’s label for a few widgets. Note that the same instance of label provider can be used by more than one Viewer for a given property. For example, the MultiReference widget will display three viewers, each using the same label provider. Each viewer will try to dispose the LabelProvider as soon as they are themselves disposed (For example, when closing the selection dialog from MultiReference). Thus, you should probably not implement the dispose() method, to avoid inconsistent providers.</p><ul><li>getValidator(String) : </li></ul><p>This method returns an IValidator, if there’s one which is set up for the current property. </p><h3 id="ModelElement_Factory">ModelElement Factory</h3><p>The ModelElements are associated to DataContextElements through a ModelElementFactory. The ModelElementFactory is defined on the DataContextRoot. All children of a DataContextRoot will share the same ModelElementFactory.</p><p>To add a new ModelElement, you should also create a new ModelElementFactory, and register it in your Environment model. Then, you can set this factory to your DataContextRoot.</p><p>Note: to display the Data contexts, you need to check the toggle button on top of the editor: <img border="0" src="fig8.png"/></p><p><img title="The UML DataContextRoots, with their own factories" alt="The UML DataContextRoots, with their own factories" border="0" src="fig9.png"/></p><h3 id="Content_Providers_and_Widgets">Content Providers and Widgets</h3><p>Note: The ContentProviders have been refactored in Papyrus 0.9, to be simplified. However, most of this chapter should remain true.</p><p>The ContentProvider is a complex features, which often evolves in the Papyrus property view. The ModelElement has been designed to be compatible with many kinds of different widgets (Combo-box, Tree-based dialogs…). The problem is that these widgets typically use different kinds of JFace ContentProvider (IStructuredContentProvider for flat display, ITreeContentProvider for Tree display). In the Property view, we needed to unify these providers.</p><p>Thus, it is recommended to use a IHierarchicContentProvider, which extends ITreeContentProvider, with an additional method: isValidValue(Object). In a Tree, we typically have two kinds of elements: the elements which can potentially be selected, and their containers, which often cannot. The isValidValue() method is used to distinguish between these values.</p><p>When a flat widget (e.g. ReferenceCombo) is used, only the valid values will be displayed. When a tree-based widget (e.g. ReferenceDialog) is used, a sub-tree will be displayed, excluding the sub-trees which don’t contain any valid value. Moreover, the invalid values won’t be selectable (For example, in the ReferenceDialog, the “ok” button will be grayed).</p><p><img title="IHierarchicContentProvider at runtime" alt="IHierarchicContentProvider at runtime" border="0" src="fig10.png"/></p><h3 id="Dynamic_sections">Dynamic sections</h3><p>Sometimes, the property view should not depend on a selection, but on a specific property of the selected element. In such a case, it is frequent that this specific property might be edited by the property view itself. However, the property view is only refreshed when the selection changes.</p><p>To overcome this problem, Papyrus offers a “Dynamic section” feature, which allows refreshing dynamically one or more sections of the property view. For example, when you’re editing a View’s constraint in the Property view Editor, the constraint’s properties directly depend on the constraint’s type. When you select an UML constraint, the constraint’s parameter is the name of a UML Metaclass. When you select an EMF constraint, the constraint has two parameters: Namespace URI of the Metamodel, and the name of the Metaclass. Changing the constraint type should also change the constraint’s parameters editors.</p><p><img title="A view with a static and a dynamic section" alt="A view with a static and a dynamic section" border="0" src="fig11.png"/></p><p>This can be achieved with dynamic sections, i.e. a section with a constraint. The constraint will be executed once at the beginning, and once again each time a property from the property view changes. If the constraint is matched, the section will be displayed. Otherwise, it will be hidden. -A view with dynamic sections will typically look like the following:</p><ul><li>A single unconstrained section containing the common parameters</li><li>One dynamic (i.e. constrained) section for each specific case</li></ul><p><img title="Dynamic sections configuration" alt="Dynamic sections configuration" border="0" src="fig12.png"/></p><p>Please note that tabs cannot be added nor removed dynamically. For example, when you apply a stereotype on a UML Element, the tab associated to the stereotype’s property view cannot be displayed until you select the element again.</p><h3 id="Property_view_Header">Property view Header</h3><p>The Eclipse Tabbed Property View offers an extension point to define the label provider for the property view header. However, this label provider will be specific to the editor. For generic editors, it is not always possible to provide a pertinent label provider: they will always be too generic, and won’t be able to handle specific elements. For example, a generic EMF Model Editor with the customizable property view will only be able to display standard EMF labels and icons. To overcome this problem, Papyrus offers a configurable label provider for the header: org.eclipse.papyrus.properties.provider.SelectionLabelProvider</p><p>This label provider uses the selected element to find the most appropriate label provider, then dispatches the getText and getIcon calls to it. This label provider can be configured through an extension point: org.eclipse.papyrus.properties.labelprovider</p><p>This extension point takes an implementation of IFilteredLabelProvider and a priority. The IFilteredLabelProvider is a label provider with an additional method: boolean accept(IStructuredSelection). For each selection, the label provider accepting the selection, and having the highest priority will be used to display a header for it. It will then be possible to define a generic label provider for all java objects, with the lowest priority; another generic label provider for all EMF Objects, and a really specific label provider for a given metamodel (with the highest priority). -In Papyrus, we have such an example for UML. The Papyrus UML Diagrams use the GMF model, which doesn’t have icons. We wanted to have a different icon for each type of Diagram: this is not possible with a standard EMF label provider, which associates an icon to an EClass, independently of its instances’ attributes.</p><p>So, we registered the standard EMF Label Provider with a medium priority, which can handle any kind of EObject, and a UML Label Provider, which can only handle UML Elements and GMF Diagrams, with a higher priority.</p><p>The lower the priority number, the higher the priority actually is: </p><ul><li>100: Lowest priority. The standard EMF Object label provider has a priority of 100, and is called iff no other label provider can accept an EObject.</li><li>50: Medium priority. The Papyrus UML Label Provider has a priority of 50.</li><li>10: High priority. </li><li>0: Highest priority.</li></ul><p>If no label provider matches the selection, the default JFace LabelProvider is used.</p><h3 id="Binding_and_Validation">Binding and Validation</h3><p>View Properties support JFace Databinding, which connects our UI to our model. For the validation there are two kinds of validators: </p><ul><li>Widget validators: they check that our input is the kind of data expected by our widget before synchronizing it ( e.g IntegerEditor must have a correct integer for input) </li></ul><ul><li>Model validators: they check that our input verifies our model constraint, they must be instantiate in UmlModelElement#getValidator();</li></ul><p>If there are errors during the binding a control decoration is shown next to the widget. It also supports three level of severity (Ok, Warning, Error).</p><p><img title="Example of binding with a model validator and warning severity result" alt="Example of binding with a model validator and warning severity result" border="0" src="fig13.png"/></p><h3 id="Field_coloration">Field coloration</h3><p>Properties views have fields’ coloration. If you modify a value the background of the field will be orange, when you validate a change the background will turn green for couple of seconds if the synchronization was successful, it will turn red otherwise. </p><p><img title="Example of a field being modified" alt="Example of a field being modified" border="0" src="fig14.png"/></p><h2 id="GENERATION_TOOL">GENERATION TOOL</h2><p>Editing an existing property view can be useful, but most of the time, you’ll want a brand new configuration for your own profile or meta-model. Thus, the framework provides a tool to automatically generate the initial property view, which you can then customize using the customization tool. -The generator can create a property view configuration from either a UML Profile or an Ecore Meta-model. The wizard is available in the Papyrus category: File -> New -> Other… -> Papyrus/Property view configuration.</p><p>The wizard provides two default generators:</p><ul><li>Generate a property view from a UML Profile</li><li>Generate a property view from an Ecore Meta-model</li></ul><p>The source file must be located in your workspace. A default target file named will be filled with the .ctx extension (This is the extension for a property view configuration).</p><p>Press next: a combo asks you which strategy to use. </p><p>A basic method: all the elements from the profile or meta-model will be extracted, with no dependencies to other models. </p><p>Same CTX file: you are asked to choose which models you want to extract, and will be saved in the same file</p><p>Different CTX file(s): you are asked to choose which models you want to extract and they will be saved in different files, (each profile name will be the name of the generated ctx file)</p><p>Press next: a table with all the elements extracted from your profile or meta-model is displayed. This table contains four columns:</p><ul><li>Field: the name of the element or property</li><li>Display single: whether this property should be displayed when a single instance of this element is selected</li><li>Display multiple: whether this property should be displayed when more than one instance of this element is selected</li><li>Description: the description of the property (Most of the time, it will be N/A, as the default generators cannot extract the documentation from the source model).</li></ul><p>Press finish: two files or more files according to the chosen strategy and a folder are generated:</p><ul><li>The *.ctx file, corresponding to your property view configuration</li><li>The ui/ folder, containing a set of XWT files, which contain the graphical information of your property views</li><li>The *FieldSelection.xmi file, which reminds the choices you’ve made about displaying each property. This file is currently unused.</li></ul><p>You can now open the *.ctx file and customize your property view.</p><h2 id="DEPLOYING_A_PROPERTY_VIEW">DEPLOYING A PROPERTY VIEW</h2><p>Papyrus provides a simple tool to deploy a property view locally (Right click on a CTX file -> Deploy/Undeploy) </p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/properties-view.mediawiki b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/properties-view.mediawiki index f7eccaac750..e609186f061 100644 --- a/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/properties-view.mediawiki +++ b/plugins/doc/org.eclipse.papyrus.views.properties.doc/resource/properties-view.mediawiki @@ -1,19 +1,19 @@ == INTRODUCTION ==
-In UML, the main information is represented in graphical diagrams. However, it is not always possible to represent graphically the whole semantic of UML, not talking of all the cosmetic properties. For example, it is pretty easy to represent and to edit a Class name graphically. While we still can represent the is abstract property graphically (By using the italic font for the Class name), it is harder to edit this property directly from the diagram. Worse, the is leaf property doesnt even have a graphical representation. Thus, we often need a different view for representing all the properties of a UML Element, without polluting the graphical view.
+In UML, the main information is represented in graphical diagrams. However, it is not always possible to represent graphically the whole semantic of UML, not talking of all the cosmetic properties. For example, it is pretty easy to represent and to edit a Class' name graphically. While we still can represent the 'is abstract' property graphically (By using the italic font for the Class' name), it is harder to edit this property directly from the diagram. Worse, the 'is leaf' property doesn't even have a graphical representation. Thus, we often need a different view for representing all the properties of a UML Element, without polluting the graphical view.
-As UML is highly extensible, through the mean of Profiles, it is also important to be able to represent and edit the profiles properties, without managing everything from the diagram view.
+As UML is highly extensible, through the mean of Profiles, it is also important to be able to represent and edit the profile's properties, without managing everything from the diagram view.
-Eclipse provides a standard view for these properties: the Properties Page. This view is a table representing all the properties available for the selected Element, including the ones that cannot be represented or edited graphically. This view is pretty useful, but is neither really user-friendly nor optimal, as it may require up to four clicks to simply edit a comments body. Moreover, it can only be extended via Java code, which requires some technical skills and prevents a dynamic modification of the view, as the Java code needs to be recompiled after each modification.
+Eclipse provides a standard view for these properties: the Properties Page. This view is a table representing all the properties available for the selected Element, including the ones that cannot be represented or edited graphically. This view is pretty useful, but is neither really user-friendly nor optimal, as it may require up to four clicks to simply edit a comment's body. Moreover, it can only be extended via Java code, which requires some technical skills and prevents a dynamic modification of the view, as the Java code needs to be recompiled after each modification.
-There is an extension of the base Property View framework, still in the standard Eclipse implementation, which fixes some of these problems. It is called the Eclipse Tabbed Properties View framework. It provides a better look and feel for the property view, with more flexibility, and a better usability. However, it keeps being difficult to customize, as it still hard-coded in Java.
+There is an extension of the base Property View framework, still in the standard Eclipse implementation, which fixes some of these problems. It is called the 'Eclipse Tabbed Properties View' framework. It provides a better look and feel for the property view, with more flexibility, and a better usability. However, it keeps being difficult to customize, as it still hard-coded in Java.
Papyrus provides its own Property View framework, based on the Tabbed Property View framework. The Papyrus Property View can be extended in two ways:
-* Dynamically, for the layout of the property view: show/hide a property, reorder the properties, add/remove a tab
-* Statically, through Java code, for advanced operations: create a new widget for editing the properties, add a custom Content Provider for selecting a reference value
+* Dynamically, for the layout of the property view: show/hide a property, reorder the properties, add/remove a tab'
+* Statically, through Java code, for advanced operations: create a new widget for editing the properties, add a custom Content Provider for selecting a reference value'
This document aims at detailing all the features related to the property view customization, both dynamically and statically.
== THE CUSTOMIZATION TOOL ==
@@ -22,16 +22,16 @@ Most customizations can be done through the Property view customization Editor. === Edit a configuration ===
-Each property view configuration is defined in a different set of files. Each configuration can contain elements from different contexts, but we typically have one configuration per Ecore Metamodel or UML Profile (i.e. one configuration for UML, one for the Diagram Appearance tab, another one for the SysML profile)
+Each property view configuration is defined in a different set of files. Each configuration can contain elements from different contexts, but we typically have one configuration per Ecore Metamodel or UML Profile (i.e. one configuration for UML, one for the Diagram Appearance tab, another one for the SysML profile')
-To see the list of available configurations, open the properties view (Window -> Show View -> Other -> General/Properties). Click on the white arrow in the upper right corner of the Properties view, and select Customize property view. You should see a dialog with the list of all available configurations.
+To see the list of available configurations, open the properties view (Window -> Show View -> Other' -> General/Properties). Click on the white arrow in the upper right corner of the Properties view, and select 'Customize property view'. You should see a dialog with the list of all available configurations.
-[[File:fig1.png|Open the property view customization menu]]
+[[File:images/fig1.png|Open the property view customization menu]]
As the standard configurations are read-only, you cannot edit them directly. You will first need to make a copy of the configuration. You will then be able to edit the copy.
-[[File:fig2.png|Copy an existing configuration to edit it]]
+[[File:images/fig2.png|Copy an existing configuration to edit it]]
The Property View Editor has three panes:
@@ -40,7 +40,7 @@ The Property View Editor has three panes: * The Properties part
The Editor presents the elements defined by this configuration. The Preview displays an overview of the selected View, as it will be displayed in the property view at runtime. The properties view displays the properties of the selected element
-[[File:fig3.png|The property view Editor]]
+[[File:images/fig3.png|The property view Editor]]
=== The property view elements ===
@@ -50,28 +50,28 @@ The editor contains a Tree, containing the following elements : * Tab: describes a tab in the property view. A tab has a label, an (optional) image, and can be indented. It also has a priority.
* View: describes a property view associated to a selection. The view has a name, a constraint, a multiplicity and a list of sections. The constraint is used to determine for what kind of object the view should be displayed.
* Constraint: a query that inputs a selection, and outputs a boolean (true if the constraint matches the input object, false otherwise). It is possible to implement your own constraint type (In Java).
-* Section: a section is a sub-part of a view. A view generally needs only one section, but there are cases where you need more than one section. A section is associated to a single tab, so, if you want to display more than one tab in a single view (For example, UML and Profile in the UML property view), you will need at least two sections in that view (One for each tab). Another (advanced) case is described in Dynamic sections . A section has a name, a tab, and a Composite.
+* Section: a section is a sub-part of a view. A view generally needs only one section, but there are cases where you need more than one section. A section is associated to a single tab, so, if you want to display more than one tab in a single view (For example, ' UML ' and ' Profile ' in the UML property view), you will need at least two sections in that view (One for each tab). Another (advanced) case is described in ' Dynamic sections '. A section has a name, a tab, and a Composite.
* Composite: this is the actual presentation element. The composite is a widget which can contain other widgets. A composite has a type, and a list of widgets.
-* Layout: all composites need a layout. The default is PropertiesLayout , which is a variant of the SWT standard GridLayout. A PropertiesLayout has a number of columns. The default is one column.
+* Layout: all composites need a layout. The default is ' PropertiesLayout ', which is a variant of the SWT standard GridLayout. A PropertiesLayout has a number of columns. The default is one column.
* Property Editor: a property editor is a widget which is used to edit a single property of the selected object. You will typically have one Property editor for each property that you want to edit in the property view. The property editor has a property, and a widget to edit that property.
* Standard Widget: a widget from the standard SWT Library. Few of them are currently available, because they are rarely needed.
The Tree allows reordering or removing easily the elements (Through drag & drop, delete). The editor also supports the Undo/Redo commands.
==== Preview ====
-The preview displays a real-time overview of the selected View. However, some widgets can only be computed at runtime, which prevents a pertinent preview. This is the case of the Enum Radio widget, for example, as the enumerated values are only known at runtime.
+The preview displays a real-time overview of the selected View. However, some widgets can only be computed at runtime, which prevents a pertinent preview. This is the case of the 'Enum Radio' widget, for example, as the enumerated values are only known at runtime.
==== Property view ====
The property view is used to edit the properties of the element selected in the tree. The property view uses the Papyrus Property View framework, thus can be customized just the same way you would customize any other property view.
-[[File:fig4.png| the three panes of the Property view editor]]
+[[File:images/fig4.png| the three panes of the Property view editor]]
=== Priorities between views ===
-When more than one view match a selection, a priority mechanism will determine which one(s) should be displayed. The priorities are defined at the level of the views constraints, i.e. if the constraint for a View A overrides a constraint for the View B, the View B wont be displayed. For example, a UML Class from a Class Diagram will match many views (The list is not exhaustive):
+When more than one view match a selection, a priority mechanism will determine which one(s) should be displayed. The priorities are defined at the level of the view's constraints, i.e. if the constraint for a View A overrides a constraint for the View B, the View B won't be displayed. For example, a UML Class from a Class Diagram will match many views (The list is not exhaustive):
* SingleClass (From UML)
-* MultipleClass (As the -1 multiplicity actually means any number of elements)
+* MultipleClass (As the -1 multiplicity actually means 'any number of elements')
* SingleElement (And MultipleElement)
* SingleClassifier (And MultipleClassifier)
* *Style (From GMF Notation model)
@@ -82,22 +82,22 @@ The priorities are computed in two ways: * Automatic, according to the Java constraints implementations
* Statically, according to the property view configuration
-When the isOverrideable property is set to false for a Constraint (In the property view model), only the static rules will be taken into account.
+When the 'isOverrideable' property is set to false for a Constraint (In the property view model), only the static rules will be taken into account.
-[[File:fig5.png|The constraint cannot be dynamically overridden]]
+[[File:images/fig5.png|The constraint cannot be dynamically overridden]]
The automatic rules are the following:
-* A constraint with a multiplicity of 1 always overrides the same constraint with a multiplicity of -1 (Or >1). Thus, MultipleClass wont be displayed, because SingleClass also matches our selection.
-* An EMF (Or UML) Instance of constraint always overrides a constraint matching a supertype. Thus, SingleClassifier wont be displayed, because a Class is more specific than a Classifier. However, SingleElement *will be* displayed, because it is not overrideable (isOverrideable=false).
-* A stereotype constraint (HasStereotype) will *not* override its UML Instance of constraint. However, a specific implementation of this constraint has been provided for Scade, which *will* override the UML metaclass (i.e., a Block will override a Class property view, hiding the UML tab).
-* For CompositeConstraints: if a composite constraint is a superset of another constraint, it will override it (It is more specific). For example, a Composite Constraint isA and isB will override a constraint isB, but will not override a constraint isB and isC.
+* A constraint with a multiplicity of 1 always overrides the same constraint with a multiplicity of -1 (Or >1). Thus, 'MultipleClass' won't be displayed, because 'SingleClass' also matches our selection.
+* An EMF (Or UML) 'Instance of' constraint always overrides a constraint matching a supertype. Thus, 'SingleClassifier' won't be displayed, because a Class is more specific than a Classifier. However, 'SingleElement' *will be* displayed, because it is not overrideable (isOverrideable=false).
+* A stereotype constraint (HasStereotype) will *not* override its UML 'Instance of' constraint. However, a specific implementation of this constraint has been provided for Scade, which *will* override the UML metaclass (i.e., a Block will override a Class' property view, hiding the UML tab).
+* For CompositeConstraints: if a composite constraint is a superset of another constraint, it will override it (It is more specific). For example, a Composite Constraint 'isA and isB' will override a constraint 'isB', but will not override a constraint 'isB and isC'.
Please note that each constraint has its own implementation of the overrides() method. See the advanced chapter for more information
-The static rule is simple: when a Constraint explicitly overrides another constraint, it will always override it. This is especially useful when youve marked a constraint as overrideable=false, but still want to override it in a specific case (Remember that overrideable=false only applies to *automatic* constraint resolution).
+The static rule is simple: when a Constraint explicitly overrides another constraint, it will always override it. This is especially useful when you've marked a constraint as 'overrideable=false', but still want to override it in a specific case (Remember that overrideable=false only applies to *automatic* constraint resolution).
-[[File:fig6.png|Force this constraint to override another constraint]]
+[[File:images/fig6.png|Force this constraint to override another constraint]]
Finally, in the previous example, the following views will be displayed:
@@ -111,7 +111,7 @@ Finally, in the previous example, the following views will be displayed: When you make a copy of a property view, it is not automatically activated. Thus, the modifications brought to the copy are not immediately visible on your property view. To activate a property view, you need to open the Papyrus preferences, from Window > Preferences.
-[[File:fig7.png|Preferences]]
+[[File:images/fig7.png|Preferences]]
When making a copy of an existing configuration, you should uncheck the default one, and check the new one.
@@ -123,9 +123,9 @@ The property view framework is much more powerful, but this requires some Java d === The Environment model ===
-To associate Java implementations with the property view model, you need to declare an Environment model. You can create a new Environment model with the Environment Model wizard in Example EMF Model Creation Wizards category. Select Environment as the Model Object.
+To associate Java implementations with the property view model, you need to declare an Environment model. You can create a new Environment model with the 'Environment Model' wizard in 'Example EMF Model Creation Wizards' category. Select 'Environment' as the Model Object.
-Once youve added your Java class declarations, you should register the environment model so that the property view knows about it. Add an extension to org.eclipse.papyrus.properties.environment, and select your model file.
+Once you've added your Java class declarations, you should register the environment model so that the property view knows about it. Add an extension to org.eclipse.papyrus.properties.environment, and select your model file.
=== Create a new widget ===
@@ -153,7 +153,7 @@ Adding a Constraint is similar to creating a new Widget. You have two options to * Implement the Constraint interface (From org.eclipse.papyrus.properties.constraints)
* Extend the AbstractConstraint class (From org.eclipse.papyrus.properties.constraints)
-The important methods are the following (depending on whether youre implement Constraint or extending AbstractConstraint):
+The important methods are the following (depending on whether you're implement Constraint or extending AbstractConstraint):
* setDescriptor/setConstraintDescriptor:
** Configures the constraint.
@@ -165,7 +165,7 @@ The important methods are the following (depending on whether youre implement C ** This is only used by AbstractConstraint. Two constraints are equivalent if they have the same parameters (ConstraintDescriptor). Two equivalent constraints can have different multiplicities.
The equivalent() and overrides() methods are used to automatically resolve constraints conflicts (Two different constraints matching the same element).
-Once the Constraint is implemented, dont forget to register it in your environment model.
+Once the Constraint is implemented, don't forget to register it in your environment model.
===ModelElement===
@@ -179,15 +179,15 @@ This method returns an IObservable which will be used to read and write a single * getContentProvider(String) :
-This method is only used for reference and enumerated properties. It should return a list of values which can be set to the edited property. Unlike IStructuredContentProvider, this provider will not rely on a StructuredViewer to retrieve an input object: the method getElement() will be called without any parameter, so the implementation should be able to retrieve its own typically. This will typically be achieved by passing a context object in the providers constructor.
+This method is only used for reference and enumerated properties. It should return a list of values which can be set to the edited property. Unlike IStructuredContentProvider, this provider will not rely on a StructuredViewer to retrieve an input object: the method getElement() will be called without any parameter, so the implementation should be able to retrieve its own typically. This will typically be achieved by passing a context object in the provider's constructor.
* getLabelProvider(String) :
-This method is used to display an elements label for a few widgets. Note that the same instance of label provider can be used by more than one Viewer for a given property. For example, the MultiReference widget will display three viewers, each using the same label provider. Each viewer will try to dispose the LabelProvider as soon as they are themselves disposed (For example, when closing the selection dialog from MultiReference). Thus, you should probably not implement the dispose() method, to avoid inconsistent providers.
+This method is used to display an element's label for a few widgets. Note that the same instance of label provider can be used by more than one Viewer for a given property. For example, the MultiReference widget will display three viewers, each using the same label provider. Each viewer will try to dispose the LabelProvider as soon as they are themselves disposed (For example, when closing the selection dialog from MultiReference). Thus, you should probably not implement the dispose() method, to avoid inconsistent providers.
* getValidator(String) :
-This method returns an IValidator, if theres one which is set up for the current property.
+This method returns an IValidator, if there's one which is set up for the current property.
=== ModelElement Factory ===
@@ -195,29 +195,29 @@ The ModelElements are associated to DataContextElements through a ModelElementFa To add a new ModelElement, you should also create a new ModelElementFactory, and register it in your Environment model. Then, you can set this factory to your DataContextRoot.
-Note: to display the Data contexts, you need to check the toggle button on top of the editor: [[File:fig8.png]]
+Note: to display the Data contexts, you need to check the toggle button on top of the editor: [[File:images/fig8.png]]
-[[File:fig9.png|The UML DataContextRoots, with their own factories]]
+[[File:images/fig9.png|The UML DataContextRoots, with their own factories]]
=== Content Providers and Widgets ===
Note: The ContentProviders have been refactored in Papyrus 0.9, to be simplified. However, most of this chapter should remain true.
-The ContentProvider is a complex features, which often evolves in the Papyrus property view. The ModelElement has been designed to be compatible with many kinds of different widgets (Combo-box, Tree-based dialogs). The problem is that these widgets typically use different kinds of JFace ContentProvider (IStructuredContentProvider for flat display, ITreeContentProvider for Tree display). In the Property view, we needed to unify these providers.
+The ContentProvider is a complex features, which often evolves in the Papyrus property view. The ModelElement has been designed to be compatible with many kinds of different widgets (Combo-box, Tree-based dialogs'). The problem is that these widgets typically use different kinds of JFace ContentProvider (IStructuredContentProvider for flat display, ITreeContentProvider for Tree display). In the Property view, we needed to unify these providers.
Thus, it is recommended to use a IHierarchicContentProvider, which extends ITreeContentProvider, with an additional method: isValidValue(Object). In a Tree, we typically have two kinds of elements: the elements which can potentially be selected, and their containers, which often cannot. The isValidValue() method is used to distinguish between these values.
-When a flat widget (e.g. ReferenceCombo) is used, only the valid values will be displayed. When a tree-based widget (e.g. ReferenceDialog) is used, a sub-tree will be displayed, excluding the sub-trees which dont contain any valid value. Moreover, the invalid values wont be selectable (For example, in the ReferenceDialog, the ok button will be grayed).
+When a flat widget (e.g. ReferenceCombo) is used, only the valid values will be displayed. When a tree-based widget (e.g. ReferenceDialog) is used, a sub-tree will be displayed, excluding the sub-trees which don't contain any valid value. Moreover, the invalid values won't be selectable (For example, in the ReferenceDialog, the 'ok' button will be grayed).
-[[File:fig10.png|IHierarchicContentProvider at runtime]]
+[[File:images/fig10.png|IHierarchicContentProvider at runtime]]
=== Dynamic sections ===
Sometimes, the property view should not depend on a selection, but on a specific property of the selected element. In such a case, it is frequent that this specific property might be edited by the property view itself. However, the property view is only refreshed when the selection changes.
-To overcome this problem, Papyrus offers a Dynamic section feature, which allows refreshing dynamically one or more sections of the property view. For example, when youre editing a Views constraint in the Property view Editor, the constraints properties directly depend on the constraints type. When you select an UML constraint, the constraints parameter is the name of a UML Metaclass. When you select an EMF constraint, the constraint has two parameters: Namespace URI of the Metamodel, and the name of the Metaclass. Changing the constraint type should also change the constraints parameters editors.
+To overcome this problem, Papyrus offers a 'Dynamic section' feature, which allows refreshing dynamically one or more sections of the property view. For example, when you're editing a View's constraint in the Property view Editor, the constraint's properties directly depend on the constraint's type. When you select an UML constraint, the constraint's parameter is the name of a UML Metaclass. When you select an EMF constraint, the constraint has two parameters: Namespace URI of the Metamodel, and the name of the Metaclass. Changing the constraint type should also change the constraint's parameters editors.
-[[File:fig11.png|A view with a static and a dynamic section]]
+[[File:images/fig11.png|A view with a static and a dynamic section]]
This can be achieved with dynamic sections, i.e. a section with a constraint. The constraint will be executed once at the beginning, and once again each time a property from the property view changes. If the constraint is matched, the section will be displayed. Otherwise, it will be hidden.
A view with dynamic sections will typically look like the following:
@@ -225,17 +225,17 @@ A view with dynamic sections will typically look like the following: * A single unconstrained section containing the common parameters
* One dynamic (i.e. constrained) section for each specific case
-[[File:fig12.png|Dynamic sections configuration]]
+[[File:images/fig12.png|Dynamic sections configuration]]
-Please note that tabs cannot be added nor removed dynamically. For example, when you apply a stereotype on a UML Element, the tab associated to the stereotypes property view cannot be displayed until you select the element again.
+Please note that tabs cannot be added nor removed dynamically. For example, when you apply a stereotype on a UML Element, the tab associated to the stereotype's property view cannot be displayed until you select the element again.
=== Property view Header ===
-The Eclipse Tabbed Property View offers an extension point to define the label provider for the property view header. However, this label provider will be specific to the editor. For generic editors, it is not always possible to provide a pertinent label provider: they will always be too generic, and wont be able to handle specific elements. For example, a generic EMF Model Editor with the customizable property view will only be able to display standard EMF labels and icons. To overcome this problem, Papyrus offers a configurable label provider for the header: org.eclipse.papyrus.properties.provider.SelectionLabelProvider
+The Eclipse Tabbed Property View offers an extension point to define the label provider for the property view header. However, this label provider will be specific to the editor. For generic editors, it is not always possible to provide a pertinent label provider: they will always be too generic, and won't be able to handle specific elements. For example, a generic EMF Model Editor with the customizable property view will only be able to display standard EMF labels and icons. To overcome this problem, Papyrus offers a configurable label provider for the header: org.eclipse.papyrus.properties.provider.SelectionLabelProvider
This label provider uses the selected element to find the most appropriate label provider, then dispatches the getText and getIcon calls to it. This label provider can be configured through an extension point: org.eclipse.papyrus.properties.labelprovider
This extension point takes an implementation of IFilteredLabelProvider and a priority. The IFilteredLabelProvider is a label provider with an additional method: boolean accept(IStructuredSelection). For each selection, the label provider accepting the selection, and having the highest priority will be used to display a header for it. It will then be possible to define a generic label provider for all java objects, with the lowest priority; another generic label provider for all EMF Objects, and a really specific label provider for a given metamodel (with the highest priority).
-In Papyrus, we have such an example for UML. The Papyrus UML Diagrams use the GMF model, which doesnt have icons. We wanted to have a different icon for each type of Diagram: this is not possible with a standard EMF label provider, which associates an icon to an EClass, independently of its instances attributes.
+In Papyrus, we have such an example for UML. The Papyrus UML Diagrams use the GMF model, which doesn't have icons. We wanted to have a different icon for each type of Diagram: this is not possible with a standard EMF label provider, which associates an icon to an EClass, independently of its instances' attributes.
So, we registered the standard EMF Label Provider with a medium priority, which can handle any kind of EObject, and a UML Label Provider, which can only handle UML Elements and GMF Diagrams, with a higher priority.
@@ -258,18 +258,18 @@ View Properties support JFace Databinding, which connects our UI to our model. F If there are errors during the binding a control decoration is shown next to the widget. It also supports three level of severity (Ok, Warning, Error).
-[[File:fig13.png|Example of binding with a model validator and warning severity result]]
+[[File:images/fig13.png|Example of binding with a model validator and warning severity result]]
=== Field coloration ===
-Properties views have fields coloration. If you modify a value the background of the field will be orange, when you validate a change the background will turn green for couple of seconds if the synchronization was successful, it will turn red otherwise.
+Properties views have fields' coloration. If you modify a value the background of the field will be orange, when you validate a change the background will turn green for couple of seconds if the synchronization was successful, it will turn red otherwise.
-[[File:fig14.png|Example of a field being modified]]
+[[File:images/fig14.png|Example of a field being modified]]
== GENERATION TOOL ==
-Editing an existing property view can be useful, but most of the time, youll want a brand new configuration for your own profile or meta-model. Thus, the framework provides a tool to automatically generate the initial property view, which you can then customize using the customization tool.
-The generator can create a property view configuration from either a UML Profile or an Ecore Meta-model. The wizard is available in the Papyrus category: File -> New -> Other -> Papyrus/Property view configuration.
+Editing an existing property view can be useful, but most of the time, you'll want a brand new configuration for your own profile or meta-model. Thus, the framework provides a tool to automatically generate the initial property view, which you can then customize using the customization tool.
+The generator can create a property view configuration from either a UML Profile or an Ecore Meta-model. The wizard is available in the Papyrus category: File -> New -> Other' -> Papyrus/Property view configuration.
The wizard provides two default generators:
@@ -297,7 +297,7 @@ Press finish: two files or more files according to the chosen strategy and a fol * The *.ctx file, corresponding to your property view configuration
* The ui/ folder, containing a set of XWT files, which contain the graphical information of your property views
-* The *FieldSelection.xmi file, which reminds the choices youve made about displaying each property. This file is currently unused.
+* The *FieldSelection.xmi file, which reminds the choices you've made about displaying each property. This file is currently unused.
You can now open the *.ctx file and customize your property view.
diff --git a/plugins/doc/pom.xml b/plugins/doc/pom.xml new file mode 100644 index 00000000000..ce1cdda668b --- /dev/null +++ b/plugins/doc/pom.xml @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="UTF-8"?> +<project> + <modelVersion>4.0.0</modelVersion> + <parent> + <artifactId>org.eclipse.papyrus</artifactId> + <groupId>org.eclipse.papyrus</groupId> + <version>1.1.0-SNAPSHOT</version> + <relativePath>../../releng/top-pom-main.xml</relativePath> + </parent> + <artifactId>org.eclipse.papyrus.plugins.doc</artifactId> + <packaging>pom</packaging> + <modules> + <module>org.eclipse.papyrus.cdo.ui.doc</module> + <module>org.eclipse.papyrus.copypaste.ui.doc</module> + <module>org.eclipse.papyrus.dsml.validation.doc</module> + <module>org.eclipse.papyrus.infra.doc</module> + <module>org.eclipse.papyrus.infra.gmfdiag.common.doc</module> + <module>org.eclipse.papyrus.infra.gmfdiag.css.doc</module> + <module>org.eclipse.papyrus.infra.nattable.doc</module> + <module>org.eclipse.papyrus.infra.newchild.doc</module> + <module>org.eclipse.papyrus.infra.services.controlmode.doc</module> + <module>org.eclipse.papyrus.infra.viewpoints.doc</module> + <module>org.eclipse.papyrus.layers.documentation</module> + <module>org.eclipse.papyrus.moka.doc</module> + <module>org.eclipse.papyrus.req.reqif.doc</module> + <module>org.eclipse.papyrus.uml.decoratormodel.doc</module> + <module>org.eclipse.papyrus.uml.diagram.common.doc</module> + <module>org.eclipse.papyrus.uml.diagram.profile.doc</module> + <module>org.eclipse.papyrus.uml.doc</module> + <module>org.eclipse.papyrus.uml.modelrepair.doc</module> + <module>org.eclipse.papyrus.uml.profile.assistants.doc</module> + <module>org.eclipse.papyrus.uml.search.ui.doc</module> + <module>org.eclipse.papyrus.views.properties.doc</module> + </modules> + +</project>
\ No newline at end of file |
