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

ECF/DocShare Plugin

ECF version 2.0.0 includes a plugin called DocShare (org.eclipse.ecf.docshare) that implements real-time shared editing.

How to Use

  • Get ECF 2.0.0.
  • Connect via a provider that supports the ECF Datashare API. Supporting IM providers are: XMPP/Google Talk, Skype (found here). Instructions for connecting are here.
  • Open a TextEditor on a text 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 not see a notification. In the near future, only the users that support/are running docshare also will appear in this liest.

Once the receiver accepts the docshare, both participants may edit the document and the other will immediately see the output.

How to Stop

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

Screen Shots

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

Docshareslewis1.png

'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 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

Back to the top