wiki:WikiEditorForEclipsePlugin

Version 11 (modified by ivangsa, 6 years ago) (diff)

--

Trac Wiki Editor 4 Eclipse

  1. Description
  2. Installation
    1. Server
    2. Client
  3. Screenshots
  4. Bugs/Feature Requests
  5. Source
    1. Building from Source
  6. Runing Tests
  7. Recent Changes
  8. Author/Contributors

Description

!WikiEditor4Eclipse is a new plug-in providing Trac Wiki editing capabilities to Eclipse IDE.

Features:

  • Trac Wiki Servers explorer
  • Eclipse Wiki Editor: currently, it borrows the editor from the original EclipseTracPlugin plugin.
  • Wiki Page management: Creation, edition and page deletion.
  • Concurrent edition management:
    • Prevents overwriting other users changes when a concurrent edit happens.
    • Helps merge contents when a concurrent edit happens.

Installation

!WikiEditor4Eclipse features a Wiki Editor as an Eclipse plugin that communicates with Trac wiki server through the XmlRpcPlugin. It requires the following software to be installed:

Server

  • TracRpcExt (optional): !WikiEditor4Eclipse reuses TracRpcExt plugin from EclipseTracPlugin to provide a page history view. This dependency is optional as the editor can work without it, but if its not installed and enabled you will miss page history functionality.

Client

Screenshots

  • Wiki Editor Perspective:

source:/wikieditorforeclipseplugin/trunk/docs/screenshots/wikieditor-prespective.png

  • Merging conflicting changes

source:/wikieditorforeclipseplugin/trunk/docs/screenshots/merge-editor.png

Bugs/Feature Requests

You can help improving the wiki editor. If you find something annoying, something wrong or something missing you may want to file a new ticket.

You can also search for existing bugs and feature requests in !WikiEditor4Eclipse are here.

Source

This plugin is composed by:

  • Java Wiki RPC Client Library: this library features a WikiClient high level API to access
  • Set of Eclipse plugins: Eclipse wiki source editor and management capabilities.

source:/wikieditorforeclipseplugin/trunk/docs/screenshots/source-layout.png

You can check out !WikiEditor4Eclipse from here using Subversion, or browse the source with Trac.

Building from Source

In order to build !WikiEditor4Eclipse you will need the following software:

  • Subversion client
  • Java JDK >= 1.5
  • Tycho maven plugin (tested with version 0.3.0-DEV-1819)
  • Eclipse SDK >= 3.2 (tested with version 3.4.2)

svn co http://trac-hacks.org/svn/wikieditorforeclipseplugin/trunk/source/ WikiEditor4Eclipse
cd WikiEditor4Eclipse
/opt/tycho-distribution-0.3.0-DEV-1819/bin/mvn \
 -Dtycho.targetPlatform=/opt/eclipse/eclipse-SDK-3.4.2 \
 clean install -Dmaven.test.skip

...

[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO] ------------------------------------------------------------------------
[INFO] Trac WikiEditor 4 Eclipse ............................. SUCCESS [26.222s]
[INFO] Trac WikiEditor 4 Eclipse ~ Core ...................... SUCCESS [23.628s]
[INFO] Trac WikiEditor 4 Eclipse ~ Eclipse Modules ........... SUCCESS [1.014s]
[INFO] Trac WikiEditor 4 Eclipse ~ org.trachacks.wikieditor.eclipse.core  SUCCESS [51.335s]
[INFO] Trac WikiEditor 4 Eclipse ~ org.trachacks.wikieditor.eclipse.plugin  SUCCESS [12.982s]
[INFO] Trac WikiEditor 4 Eclipse ~ org.trachacks.wikieditor.eclipse.feature  SUCCESS [3.986s]
[INFO] Trac WikiEditor 4 Eclipse ~ org.trachacks.wikieditor.eclipse.site  SUCCESS [9.239s]
[INFO] ------------------------------------------------------------------------
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2 minutes 25 seconds
[INFO] Finished at: Sun May 17 20:11:30 CEST 2009
[INFO] Final Memory: 27M/50M
[INFO] ------------------------------------------------------------------------

This will create a local eclipse update site at !WikiEditor4Eclipse/source/eclipse/org.trachacks.wikieditor.eclipse.site/target/site you can point Eclipse Update Manager to.

Runing Tests

In order to run automated tests against a Trac server you will need to setup a local server

TODO: how to set up tests prerequisites

Recent Changes

[11197] by ivangsa on 2012-01-26 09:14:32
Current update-site is v_0.1.0.201201260900
[11196] by ivangsa on 2012-01-26 09:14:28
Removing previous update-site release
[11195] by ivangsa on 2012-01-26 09:14:25
Release v_0.1.0.201201260900

Author/Contributors

Author: ivangsa
Contributors: EclipseTracPlugin