Skip to content

Commit

Permalink
Closes #258, Closes #249 (#319)
Browse files Browse the repository at this point in the history
* Closes #258
Closes #249

Signed-off-by: Guenther Michael (INST/BSV2-TD) <[email protected]>

* Closes #258
Closes #249

Signed-off-by: Guenther Michael (INST/BSV2-TD) <[email protected]>

* Closes #258
Closes #249

Signed-off-by: Guenther Michael (INST/BSV2-TD) <[email protected]>
  • Loading branch information
Michael Günther authored and aedelmann committed Jun 30, 2016
1 parent 7866bf8 commit 9916dd6
Show file tree
Hide file tree
Showing 21 changed files with 98 additions and 55 deletions.
6 changes: 2 additions & 4 deletions website/_data/doclinks.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,10 @@
- title: "Installation"
href: ""
sub:
- title: "Getting"
href: "/documentation/installation/installation.html"
- title: "Installing"
href: "/documentation/installation/installation.html#installing-the-vorto-plug-ins"
href: "/documentation/installation/installation.html#installing-the-vorto-toolset"
- title: "Upgrading"
href: "/documentation/installation/installation.html#upgrading-the-vorto-plug-ins"
href: "/documentation/installation/installation.html#upgrading-the-vorto-toolset"
- title: "Model Editors"
href: ""
sub:
Expand Down
2 changes: 1 addition & 1 deletion website/documentation/appendix/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This section details the following topics:

##### I Get an Error During the Installation That it Cannot Perform the Operation and is Trying for Alternative Solutions

You need to uninstall the Vorto plug-ins as well as its dependent Xbase & Xtext plug-ins (refer to [Uninstalling the Vorto Plug-ins]({{base}}/documentation/appendix/uninstallation.html#uninstalling-the-vorto-plug-ins)).
You need to uninstall the Vorto Toolset as well as its dependent Xbase & Xtext plug-ins (refer to [Uninstalling the Vorto Toolset]({{base}}/documentation/appendix/uninstallation.html#uninstalling-the-vorto-plug-ins)).

##### Should I Upgrade the Xtext Plug-in?

Expand Down
8 changes: 4 additions & 4 deletions website/documentation/appendix/uninstallation.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
layout: documentation
title: Uninstalling the Vorto Plug-ins
title: Uninstalling the Vorto Toolset
---
{% include base.html %}
## Uninstalling the Vorto Plug-ins
## Uninstalling the Vorto Toolset

**Prerequisites**

Expand All @@ -18,9 +18,9 @@ You have started your IDE.

![Installed software]({{base}}/img/documentation/m2m_tc_installed_software_1.png)
3. If necessary, click the **Installed Software** tab.
4. Select the Software belonging to the Vorto plug-ins (refer to [Installing the Vorto Plug-ins]({{base}}/documentation/installation/installation.html#installing-the-vorto-plug-ins)) and click the **Uninstall...** button.
4. Select the Software belonging to the Vorto Toolset (refer to [Installing the Vorto Toolset]({{base}}/documentation/installation/installation.html#installing-the-vorto-plug-ins)) and click the **Uninstall...** button.
The **Uninstall** dialog opens.
5. Click **Finish** to uninstall the Vorto plug-ins.
5. Click **Finish** to uninstall the Vorto Toolset.
After the uninstallation is complete, the **Software Updates** dialog opens.
![Restart VR Modeler after software update]({{base}}/img/documentation/m2m_tc_vrm_software_updates_restart.png)
6. Click **Yes** to restart your IDE.
Expand Down
110 changes: 76 additions & 34 deletions website/documentation/installation/installation.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,78 @@
---
layout: documentation
title: Installing the Plugins
title: Installing the Vorto Toolset
---
{% include base.html %}
## Installing the Plug-ins

This section details the following topics:

[Getting the Vorto Plug-ins](#getting-the-vorto-plug-ins)
[Installing the Vorto Toolset](#installing-the-vorto-toolset)

[Installing the Vorto Plug-ins](#installing-the-vorto-plug-ins)
[Upgrading the Vorto Toolset](#upgrading-the-vorto-toolset)

[Upgrading the Vorto Plug-ins](#upgrading-the-vorto-plug-ins)
##Installing the Vorto Toolset

## Getting the Vorto Plug-ins
This section lists the steps required to install the Vorto Toolset.

The Vorto plug-ins are available on the Eclipse update site server. The URL to the server is [http://download.eclipse.org/vorto/update/milestones](http://download.eclipse.org/vorto/update/milestones "http://download.eclipse.org/vorto/update/milestones"). You must add this repository to your IDE or, alternatively, import the Vorto plug-in zip archive to get the Vorto plug-ins.
Install the Eclipse Vorto Toolset in one of the following three ways:

* [Installing from the Eclipse Vorto download page](#installing-from-the-eclipse-vorto-download-page)
* [Installing from the Eclipse Marketplace](#installing-from-the-eclipse-marketplace)
* [Installing from the Vorto Toolset Upadte Site](#installing-from-the-vorto-toolset-upadte-site)

### Installing from the Eclipse Vorto Download Page

**Proceed as follows**

1. Start Eclipse.
2. With your browser, go to the [Eclipse Vorto Daownload Page](https://eclipse.org/vorto/downloads).
The Eclipse Vorto download page opens.
![Eclipse Vorto Download Page]({{base}}/img/documentation/vorto_eclipse_vorto_download_page.png)
2. Do one of the following:
* Drag and drop the Install button ![Install Button]({{base}}/img/documentation/vorto_eclipse_vorto_download_install_button.png) into your running Eclipse application.
The **Confirm Selected Features dialog** of the **Eclipse Marketplace** opens.
![Eclipse Marketplace Confirm Selected Features Dialog]({{base}}/img/documentation/vorto_eclipse_vorto_download_marketplace_confirm_selected_features_dialog.png)
Click the **Confirm >** button and proceed accepting the license (step 6 in [Installing](#installing)).
* Click the **Vorto Update Site** button (**(Stable)** or **(Nightly)** according to your needs).
An Eclipse standard page opens showing instructions how to use the download links in Eclipse.
![Eclipse Standard Download Info Page]({{base}}/img/documentation/vorto_eclipse_vorto_download_info_page.png)
Follow the instructions.
* Click the **Vorto zip** button (**(Stable)** or **(Nightly)** according to your needs).
The download dialog of your browser opens.
Download the zip file containing the Vorto Toolset archive to a location of your choice and install the archive in the standard way.

### Installing from the Eclipse Marketplace.

**Proceed as follows**

1. Start your IDE (Eclipse Luna or later).
1. Start Eclipse.
2. In the main menu, click **Help > Eclipse Marketplace...**.
The **Eclipse Marketplace** dialog opens.
2. In the **Find** entry field enter `Vorto` and click the **Go** button.
The Vorto Toolset is displayed.
![Eclipse Marketplace Install Vorto]({{base}}/img/documentation/vorto_eclipse_vorto_download_marketplace_install_dialog.png)
3. Click the **Install** button.
The Vorto Toolset is installed.

### Installing from the Vorto Toolset Upadte Site

The Vorto Toolset is available on the Eclipse Vorto update site server. The URL to the server is `http://download.eclipse.org/vorto/update/milestones` (*Vorto Toolset update site*). You must add this repository to Eclipse or, alternatively, import the Vorto Toolset zip archive to install the Vorto Toolset.

#### Setting the Vorto Toolset Update Site

**Proceed as follows**

1. Start Eclipse.
2. In the main menu, click **Help > Install new Software...**.
The **Install** dialog opens displaying the **Available Software**.
3. Click the selection button of the **Work with** selection list field to check if the *Vorto plug-ins repository* is already present.
3. Click the selection button of the **Work with** selection list field to check if the *Vorto Toolset update site* is already present.
![Software update repository]({{base}}/img/documentation/m2m_tc_vrm_software_updates_install_vorto_repository_present.png)
If the *Vorto plug-ins repository* URL is displayed in the expanding list, you can end the procedure here.
If the *Vorto Toolset update site* URL is displayed in the expanding list, you can end the procedure here.
Otherwise proceed with the next step.
4. Add the *Vorto plug-ins repository* URL:
4. Add the *Vorto Toolset update site* URL:
a. Click the **Add...** button beside the **Work with** field. The **Add Repository** dialog opens.
b. Enter a Name (optionally, e.g., *Vorto*).
c. Enter the *Vorto plug-ins repository* URL [http://download.eclipse.org/vorto/update/milestones](http://download.eclipse.org/vorto/update/milestones "http://download.eclipse.org/vorto/update/milestones") into the **Location** field.
c. Enter the *Vorto Toolset update site* URL `http://download.eclipse.org/vorto/update/milestones` into the **Location** field.
d. Click **OK**.

In the **Install** dialog, the available software list is updated and now contains the software found in the added repository and in the installed archive, respectively.
Expand All @@ -44,24 +86,24 @@ In the **Install** dialog, the available software list is updated and now contai
</tbody>
</table>

## Installing the Vorto Plug-ins
#### Installing

**Prerequisites**

- You have started your IDE.
- You have added the *Vorto plug-ins repository* to your IDE (refer to [Getting the Vorto Plug-ins](#getting-the-vorto-plug-ins)).
- You have started Eclipse.
- You have set the *Vorto Toolset update site* in Eclipse (refer to [Setting the Vorto Toolset Update Site](#setting-the-vorto-toolset-update-site)).

**Proceed as follows**

1. If not yet done click **Help > Install new Software...** in the main menu.
The **Install** dialog opens displaying the **Available Software**.
2. In the **Work with** selection list, select the entry with the *Vorto plug-ins* URL.
2. In the **Work with** selection list, select the entry with the *Vorto Toolset* URL.
![Software update repository]({{base}}/img/documentation/m2m_tc_vrm_software_updates_install_vorto_repository_present.png)
The **Available Software** list is updated.
3. In the **Available Software** list, select Vorto.
All containing software parts (features) are checked.
3. In the **Available Software** list, select **Vorto**.
All containing software parts are checked.
![Software updates selected]({{base}}/img/documentation/m2m_tc_vrm_software_updates_selected_m2m_plugin_1.png)
4. Click **Next** to verify the installation of *Vorto plug-ins* and its dependencies.
4. Click **Next** to verify the installation of the Vorto Toolset and its dependencies.
The **Install** dialog now displays the **Install Details**.
![Software update install details]({{base}}/img/documentation/m2m_tc_vrm_software_updates_install_m2m_details_1.png)
5. Click **Next**.
Expand All @@ -72,45 +114,45 @@ In the **Install** dialog, the available software list is updated and now contai
7. If the **Security Warning** dialog opens click **OK**.
After the installation is complete the **Software Updates** dialog opens.
![Restart VR Modeler]({{base}}/img/documentation/m2m_tc_vrm_software_updates_restart.png)
8. Click **Yes** to restart the your IDE.
After the restart the IDE contains the **Vorto** project group with several new project wizard items (**File > New > Project...**).
8. Click **Yes** to restart Eclipse.
After the restart, Eclipse contains the **Vorto** project group with several new project wizard items (**File > New > Project...**).

![New function block model project]({{base}}/img/documentation/m2m_tc_new_vorto_function_block_model_wizard.png)

<table class="table table-bordered">
<tbody>
<tr>
<td><i class="fa fa-info-circle info-note"></i></td>
<td>In case the installation is unsuccessful, uninstall the previous version of the Vorto and install it again.</td>
<td>In case the installation is unsuccessful, uninstall the previous version of the Vorto Toolset and install it again.</td>
</tr>
</tbody>
</table>

## Upgrading the Vorto Plug-ins
## Upgrading the Vorto Toolset

This section lists the steps required to upgrade the Vorto plug-ins.
This section lists the steps required to upgrade the Vorto Toolset.

**Prerequisites**

- You have a working installation of the previous version of the Vorto plug-ins.
- This assumes that your IDE version is in the Vorto supported versions, and stable releases of *Xtext* and *M2E* have been installed (for more information refer to [System Requirements]({{base}}/documentation/overview/introduction.html#system-requirements)).
- You have started your IDE.
- You have a working installation of the previous version of the Vorto Toolset.
- This assumes that your Eclipse version is in the Vorto supported versions, and stable releases of *Xtext* has been installed (for more information refer to [System Requirements]({{base}}/documentation/overview/introduction.html#system-requirements)).

**Proceed as follows**

1. Click **Help > Install new Software...** in the main menu.
1. Start Eclipse.
2. In the main menu, click **Help > Install new Software...**.
The **Install** dialog opens displaying the **Available Software**.
2. In the **Work with** selection list, select the entry with the *Vorto plug-ins* URL.
2. In the **Work with** selection list, select the entry with the *Vorto Toolset update site* URL.
The **Available Software** list is updated.
3. In the **Available Software** list, select `Vorto`.
All containing software parts (features) are checked.
4. Click **Next** to verify the installation of *Vorto plug-ins* and its dependencies.
3. In the **Available Software** list, select **Vorto**.
All containing software parts are checked.
4. Click **Next** to verify the installation of *Vorto Toolset* and its dependencies.
The **Install** dialog now displays the **Install Details**.
5. If the plug-ins are up-to date the **Finish** button remains inactive. End here by clicking **Cancel**.
5. If the toolset are up-to date the **Finish** button remains inactive. End here by clicking **Cancel**.
5. Otherwise, click **Next**.
The **Install** dialog now displays the **Review Licenses**.
6. Select **I accept the terms of the license agreements** and click **Finish**.
The software is being installed.
7. If the **Security Warning** dialog opens click **OK**.
After the installation is complete the **Software Updates** dialog opens.
8. Click **Yes** to restart the your IDE.
8. Click **Yes** to restart the Eclipse.
13 changes: 8 additions & 5 deletions website/documentation/overview/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,14 @@ The Vorto project considers the following contributions as significant contribut

## System Requirements

For the use of the Vorto plug-ins the following software requirements must be met:

- IDE
- Eclipse Mars for DSL Developers
- [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/)
For the use of the Vorto Toolset the following software requirements must be met:

- Eclipse
- [Eclipse IDE for Java and DSL Developers](http://www.eclipse.org/downloads/packages/eclipse-ide-java-and-dsl-developers/mars2) (Mars or higher)
or
- [Eclipse IDE](http://www.eclipse.org/downloads/packages/release/Mars/2) (Mars or higher)
- [Xtext](http://download.eclipse.org/modeling/tmf/xtext/updates/composite/releases/) 2.9.x (or higher)
- [Java 8](http://www.oracle.com/technetwork/java/javase/downloads/)

<table class="table table-bordered">
<tbody>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ You can generate code from shared information models in the Vorto Repository. Th

###Generating Code from Your Local Workspace

You can generate code from information models in your local workspace. The code generation is carried out locally on your computer. You can choose one of the code generators which have been installed along with the Eclipse Vorto plug-ins.
You can generate code from information models in your local workspace. The code generation is carried out locally on your computer. You can choose one of the code generators which have been installed along with the Eclipse Vorto Toolset.

**Prerequisites**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Searching Models
---
{% include base.html %}

## Searching Models Using the Eclipse Vorto Plug-ins
## Searching Models Using the Eclipse Vorto Toolset

This section details the following topics:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ You must perform some settings in the Eclipse preferences so Eclipse is able to

**Prerequisites**

* You have installed the Eclipse Vorto plug-ins (refer to [Installing the Plug-ins]({{base}}/documentation/installation/installation.html)).
* You have installed the Eclipse Vorto Toolset (refer to [Installing the Toolset]({{base}}/documentation/installation/installation.html)).
* You have started Eclipse.

**Proceed as follows**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
layout: documentation
title: Sharing Models Using the Eclipse Vorto Plug-in
title: Sharing Models Using the Eclipse Vorto Toolset
---
{% include base.html %}

#Sharing Using the Eclipse Vorto Plug-in
#Sharing Using the Eclipse Vorto Toolset

You can share models (information models, function block models or data type models) by uploading them to the Model Repository out of the Eclipse Vorto plug-in.
You can share models (information models, function block models or data type models) by uploading them to the Model Repository out of the Eclipse Vorto Toolset.

For sharing models using the Web Interface, refer to [Sharing Models Using the Web Interface](../web-interface/share-web.html).
For sharing models using the Vorto CLI tool, refer to [Vorto CLI Tool]({{base}}/documentation/cli-tool/cli-tool.html).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ title: Sharing Models Using the Web Interface

You can share models (information models, function block models or data type models) by uploading them to the Vorto Repository within the Vorto Repository Web interface.

For sharing models using the Eclipse Vorto plug-in, refer to [Sharing Models Using the Eclipse Vorto Plug-in](../eclipse-vorto-integration/share-eclipse.html).
For sharing models using the Eclipse Vorto Toolset, refer to [Sharing Models Using the Eclipse Vorto Toolset](../eclipse-vorto-integration/share-eclipse.html).
For sharing models using the Vorto CLI tool, refer to [Vorto CLI Tool]({{base}}/documentation/cli-tool/cli-tool.html).

**Prerequisites**
Expand Down
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.
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.
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.
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.
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.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9916dd6

Please sign in to comment.