Skip to content

Commit

Permalink
eclipse-capella#135 OpenSource CDO and XML Metadata TA plugins
Browse files Browse the repository at this point in the history
- Add the CDO and XML Metadata plugins
- Add the feature
- Add it in the product and update site
- Add documentation

- Include new TA in CapellaStudio product

- Fix some branding and copyright issues on existing plugins/features
- Fix typos in documentation

Change-Id: I3f560b4a75e92b64caa87d0c5343cf446ddb20d0
  • Loading branch information
arnauddieumegard committed Sep 27, 2021
1 parent 31caada commit bbd723a
Show file tree
Hide file tree
Showing 118 changed files with 4,394 additions and 11 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?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"/><title>cdoxml</title><link type="text/css" rel="stylesheet" href="PLUGINS_ROOT/org.polarsys.capella.studio.doc/html/style/style.css"/></head><body><h1 id="Generate_viewpoints_for_CDO_platforms_including_metadata_descriptions_as_XML_content">Generate viewpoints for CDO platforms including metadata descriptions as XML content</h1><p>The support for CDO platform is the same as the one provided by the CDO generation.<br/>
It adds the generation of a [viewpoint_name].connector plugin containing XXX.data.vptext data content description using XML format. </p><ul><li><a href="#Prerequisite">Prerequisite</a></li><li><a href="#Setup_new_viewpoint">Setup new viewpoint</a></li><li><a href="#Setup_existing_viewpoint">Setup existing viewpoint</a></li></ul><h2 id="Prerequisite">Prerequisite</h2><p><hr/>
One of the generated bundles is specific to the CDO platforms. Thus, it requires the bundle org.eclipse.emf.cdo which is not available into Capella Studio.
A new target platform is needed. To configure it:</p><ol><li>Open the preference page <code>Menu Window &gt; Plug-in development &gt; Target platform</code>.</li><li>Click on the <i>Add...</i> button. Then on the wizard press the <i>Next</i> button.</li><li>Click on the <i>Add</i> button and select the <i>installation</i> item and press the <i>Next</i> button.</li><li>Provide the path of your CDO platform and click on <i>Finish</i> button.</li></ol><h2 id="Setup_new_viewpoint">Setup new viewpoint</h2><p><hr/>
To enable it into a new project, select the <b>target application</b> labeled <i>CDO and XML Metadata for Capella</i>.<br/><br/>
<img border="0" src="img/newVPDSLprojectCDOXML.png"/><br/><br/></p><h2 id="Setup_existing_viewpoint">Setup existing viewpoint</h2><p><hr/>
To enable it into an existing project, open the XXX.conf.vptext file and use the content assistant to select the <b>target application</b> labeled <i>CDO and XML Metadata for Capella</i>.<br/><br/>
<img border="0" src="img/existingVPDSLprojectCDOXML.png"/><br/><br/></p></body></html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@

= Generate viewpoints for CDO platforms including metadata descriptions as XML content =

The support for CDO platform is the same as the one provided by the CDO generation.</br>
It adds the generation of a [viewpoint_name].connector plugin containing XXX.data.vptext data content description using XML format.

* [[#Prerequisite|Prerequisite]]
* [[#Setup_new_viewpoint|Setup new viewpoint]]
* [[#Setup_existing_viewpoint|Setup existing viewpoint]]
==Prerequisite==
----
One of the generated bundles is specific to the CDO platforms. Thus, it requires the bundle org.eclipse.emf.cdo which is not available into Capella Studio.
A new target platform is needed. To configure it:
#Open the preference page <code>Menu Window > Preferences > Plug-in development > Target platform</code>.
#Click on the ''Add...'' button. Then on the wizard press the ''Next'' button.
#Click on the ''Add'' button and select the ''installation'' item and press the ''Next'' button.
#Provide the path of your CDO platform and click on ''Finish'' button.
#Select the newly created target platform and click on ''Apply and Close'' button.
==Setup new viewpoint==
----
To enable it into a new project, select the '''target application''' labeled ''CDO and XML Metadata for Capella''.<br/><br/>
[[File:img/newVPDSLprojectCDOXML.png]]<br/><br/>

==Setup existing viewpoint==
----
To enable it into an existing project, open the XXX.conf.vptext file and use the content assistant to select the '''target application''' labeled ''CDO and XML Metadata for Capella''.<br/><br/>
[[File:img/existingVPDSLprojectCDOXML.png]]<br/><br/>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
= Introduction =


Capella Studio provides a full-integrated development environment whitch aims at facilitating the development of extensions for Capella MBSE.
Capella Studio provides a full-integrated development environment which aims at facilitating the development of extensions for Capella MBSE.

It provides developers with a platform containing both:

Expand Down
2 changes: 2 additions & 0 deletions doc/plugins/org.polarsys.capella.studio.doc/studio.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Contributors:
<topic href="html/extension/cdo.html" label="Vewpoint Creation">
<topic href="html/extension/cdo.html" label="Generate viewpoints for CDO platforms">
</topic>
<topic href="html/extension/cdoxml.html" label="Generate viewpoints for CDO platforms and XML metadata">
</topic>
</topic>
<anchor id="gendocAnchor"/>
<anchor id="vpdslAnchor"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,4 +84,12 @@
id="org.polarsys.capella.docgen.feature"
version="0.0.0"/>

<includes
id="org.polarsys.capella.cdoxml.ta.definition.feature"
version="0.0.0"/>

<includes
id="org.polarsys.capella.cdoxml.ta.definition.feature.source"
version="0.0.0"/>

</feature>
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,19 @@
<module>../../../vpdsl/plugins/org.polarsys.capella.ta.viewpoint.dsl.extension</module>
<module>../../../vpdsl/plugins/org.polarsys.capella.cdo.ta.definition</module>
<module>../../../vpdsl/plugins/org.polarsys.capella.cdo.ta.ext</module>
<module>../../../vpdsl/plugins/org.polarsys.capella.cdoxml.ta</module>
<module>../../../vpdsl/plugins/org.polarsys.capella.cdoxml.ta.genchain</module>
<module>../../../vpdsl/plugins/org.polarsys.capella.cdoxml.ta.genchain.model</module>
<module>../../../vpdsl/plugins/org.polarsys.capella.cdoxml.ta.genchain.model.edit</module>
<module>../../../vpdsl/plugins/org.polarsys.capella.cdoxml.ta.portfolio</module>
<module>../../../doc/plugins/org.polarsys.capella.studio.doc</module>

<!-- Features -->
<module>../../../extension/features/org.polarsys.capella.extension.sdk.feature</module>
<module>../../../product/features/org.polarsys.capella.studio.product.feature</module>
<module>../../../vpdsl/features/org.polarsys.capella.ta.viewpoint.dsl.feature</module>
<module>../../../vpdsl/features/org.polarsys.capella.cdo.ta.definition.feature</module>
<module>../../../vpdsl/features/org.polarsys.capella.cdoxml.ta.definition.feature</module>
<module>../../../releng/features/org.polarsys.capella.studio.releng.eclipse.feature</module>
<module>../../../releng/features/org.polarsys.capella.studio.releng.capella.feature</module>
<module>../../../releng/features/org.polarsys.capella.studio.releng.kitalpha.feature</module>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,11 @@
<feature id="org.polarsys.capella.cdo.ta.definition.feature.source" version="0.0.0">
<category name="CapellaStudio"/>
</feature>
<feature id="org.polarsys.capella.cdoxml.ta.definition.feature" version="0.0.0">
<category name="CapellaStudio"/>
</feature>
<feature id="org.polarsys.capella.cdoxml.ta.definition.feature.source" version="0.0.0">
<category name="CapellaStudio"/>
</feature>
<category-def name="CapellaStudio" label="Capella Studio"/>
</site>
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@

# "providerName" property - name of the company that provides the feature
providerName=www.polarsys.org
featureName=CDO for Capella Target Application Definition Feature

# "description" property - description of the feature
description=CDO for Capella Target Application Definition Feature
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
-->
<feature
id="org.polarsys.capella.cdo.ta.definition.feature"
label="Kitalpha vpDSL Target Application Definition Feature"
label="%featureName"
version="5.1.0.qualifier"
provider-name="%providerName">

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<?xml version="1.0" encoding="UTF-8"?>
<projectDescription>
<name>org.polarsys.capella.cdoxml.ta.definition.feature</name>
<comment></comment>
<projects>
</projects>
<buildSpec>
<buildCommand>
<name>org.eclipse.pde.FeatureBuilder</name>
<arguments>
</arguments>
</buildCommand>
</buildSpec>
<natures>
<nature>org.eclipse.pde.FeatureNature</nature>
</natures>
</projectDescription>
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# =============================================================================
# Copyright (c) 2021 THALES GLOBAL SERVICES.
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License 2.0 which is available at
# http://www.eclipse.org/legal/epl-2.0
#
# SPDX-License-Identifier: EPL-2.0
#
# Contributors:
# Thales Global Services S.A.S - initial API and implementation
# =============================================================================
bin.includes = feature.xml,\
epl-2.0.html,\
license.html,\
feature.properties
Loading

0 comments on commit bbd723a

Please sign in to comment.