HOWTO: Shared Code Plugin

From Eclipsepedia

Jump to: navigation, search

Contents

Installation and Running of the Shared Code Plugin (SCP)

This is a description of how to install and run the Shared Code plugin (SCP). It should guide you to having a working SCP demo in minutes.

Steps

Step 0

Prerequisites:

  • Eclipse 3.1 or higher
  • [ECF] 0.8 or higher
  • Download and install the plug-in from ECF's CVS repository. Verify that they are all available in your Eclipse environment.

Host: dev.eclipse.org
Repository Path: /cvsroot/technology
Module: org.eclipse.ecf/examples/plugins/org.eclipse.ecf.example.sharecode Connection Type: pserver
User name: anonymous

Step 1

Starting ECF Local Server.

  1. Start a shell.
  2. CD to the Eclipse features directory.
  3. CD to org.eclipse.ecf.serverfeature_X.X.X\bin directory (X.X.X is the ecf version number).
  4. Run startserver.sh for OS X/Linux (.bat for windows)
  5. The default settings are fine for now.

Shell.png

Step 2

Config Project on workspace

  • Config general information

GeneralInformation.jpg


  • Config Itacare instace Projects

ConfigItacare.png


  • Config Trancoso instance Projects

ConfigTrancoso.png


  • Config preferences (It doesn't work yet)

PreferencesEx.png

Step 3

  1. For this demo, it's necessary to use two or more Eclipse instances. I will use only two Eclipse instance(Itacare and Trancoso).
  2. Make sure to use different workspaces, because this demo is on the same machine.
  • Click on the Run->Run, change the launcher name to "Itacare"

Itacare.png


  • Click on the Run->Run, change the launcher name to "Trancoso"

Trancoso.png


  • Adjust workspace data as necessary. You need to setup different "Location" to each Eclipse instance, and each instance needs to point to the same ECF server.

Step 4

Connect SCP to ECF Local Server

  • In the Itacare launched workbench, click on the IconeTransp.gif in toolbar

ConnectingSCP.png

  • In the Trancoso launched workbench, click on the IconeTransp.gif in toolbar
  • After this actions, you are able to search for remote source code.

Step 5

Searching for Java files on Itacare

  • Click on Eclipse search EclipseSearch.png in the Trancoso instance
  • Type yours criterias

File:SearchMeta.png


  • SCP will search for Java files in the Itacare instance.

InstanceItacare.png


  • If it matches on the search term, it sends the match to Trancoso instance and shows the result in the Share Code view.

ShareCodeView.png


  • Now you need to make a double click on any row to see the Java file on the Eclipse Java Editor, or if you prefer, you can drag a table row to the editor area will open the associated Java file in the editor.

ScpJavaEditor.png

Step 6

Putting Shared Code metadata to Java files

A Shared Code metadata is like a yellow sticky note stuck to a Java file. On the Shared Code metadata you can record information about a Java file(See Candidate_Metadata).

Users can use Shared Code metadata to search Java files. These Shared Code metadata can also be shown as items in Shared Code metadata view.

ScreenShots

PopupSCP.png


DataEntrySCP.png