Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "ECF/DocShare Plugin"

< ECF
Line 4: Line 4:
  
 
*Get [http://www.eclipse.org/ecf/downloads.php ECF 2.0.0M4 or later]).
 
*Get [http://www.eclipse.org/ecf/downloads.php ECF 2.0.0M4 or later]).
*Connect vua a provider that supports the [[ECF_API_Docs#Datashare_API | ECF Datashare API]]. Supporting IM providers are:  XMPP/Google Talk (comes with ECF 2.0.0M4), Skype (found [http://ecf1.osuosl.org here]).  [http://help.eclipse.org/help33/index.jsp?topic=/org.eclipse.ecf.doc/html/gettingstarted/quickStart.html  Here] are instructions for connecting.
+
*Connect vua a provider that supports the [[ECF_API_Docs#Datashare_API | ECF Datashare API]]. Supporting IM providers are:  XMPP/Google Talk (comes with ECF 2.0.0M4), Skype (found [http://ecf1.osuosl.org here]).  Instructions for connecting are [http://help.eclipse.org/help33/index.jsp?topic=/org.eclipse.ecf.doc/html/gettingstarted/quickStart.html  here].
 
*Open a TextEditor on a resource from your workspace (e.g. a java file, or .txt file).
 
*Open a TextEditor on a resource from your workspace (e.g. a java file, or .txt file).
 
*Open the Context Menu (right click) on the editor, and you should see a context menu like this
 
*Open the Context Menu (right click) on the editor, and you should see a context menu like this

Revision as of 20:35, 17 December 2007

How to Use

To use the real-time documentation sharing

  • Get ECF 2.0.0M4 or later).
  • Connect vua a provider that supports the ECF Datashare API. Supporting IM providers are: XMPP/Google Talk (comes with ECF 2.0.0M4), Skype (found here). Instructions for connecting are here.
  • Open a TextEditor on a resource from your workspace (e.g. a java file, or .txt file).
  • Open the Context Menu (right click) on the editor, and you should see a context menu like this

Docshareslewis2.png

  • Select the target user to share your editor session with. Note that if you select a target user

that is not running ECF it will have no effect and the target user will see nothing. In M5 we will be filtering users in the context menu to show only the ones actually able to engage in ECF editor sharing.

How to Stop

  • Open the context menu for the editor being shared.
  • Select "Stop Sharing Editor with ..."

Screen Shots

There is now a plugin org.eclipse.ecf.docshare to provides some support for the ongoing work on RT Shared Editing. What this plugin does is expose an ECF Roster Menus in the context menu of all Eclipse-based text editors (e.g. java editor and text editor) so that shared editing can be initiated directly from within the existing editor UI.

Here is the 'slewis' client (the initiator), before starting editor sharing

Docshareslewis1.png

Here is the 'fliwatuet' client (the receiver), before starting editor sharing

File:Docsharefliwatuet1.png

Slewis initiates the real-time shared editing by opening the context menu in the editor, and choosing Share Editor With -> slewis@ecf.eclipse.org ->ECF -> fliwatuet@ecf.eclipse.org

Docshareslewis2.png

Fliwatuet receives a notice (to be replaced with a new notification system soon) and can accept or reject the shared editing session

Docsharefliwatuet2.png

If fliwatuet accepts, the editor is opened with slewis current editor content on fliwatuet's workbench

Docsharefliwatuet3.png

At this point, both participants can edit the text and updates will be immediately distributed and shown on the other's corresponding editor.

So, for example, here fliwatuet enters a new method (baz)

Docsharefliwatuet4.png

These same updates appear immediately on slewis' workbench. Slewis can also make changes and these are reflected on fliwatuet's workbench

Docshareslewis3.png

Note that currently this editor does not do conflict resolution, and so the editors can get get out of synch. But this will soon be remedied by adding the resolution code from Mustafa's work on the real-time shared editing, aka Cola.

This new plugin source is available via the project set file. For committers, get the project set file with extssh access here

Copyright © Eclipse Foundation, Inc. All Rights Reserved.