wiki:WikiEditorForEclipsePlugin

Trac Wiki Editor for Eclipse

Description

This plugin provides Trac with editing capabilities to Eclipse IDE. You can visit the Eclipse Market Place for more information.

Key features:

  • Trac Wiki Servers explorer: new hierarchical tree view.
  • Eclipse Wiki Editor:
  • Wiki Page management: creation, editing and page deletion.
  • Concurrent edition management:
    • Prevents overwriting other users changes when a concurrent edit happens.
    • Helps merge contents when a concurrent edit happens.

Wiki Editor Perspective:

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

Merging conflicting changes:

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

Development Plan

0.0.x series (old stable)

  • Trac Wiki Server explorer with hierarchical tree.
  • Eclipse Wiki Editor with syntax highligting and autocompletion borrowed from EclipseTracPlugin.
  • Wiki Page management (Creation, Edition and Deletion).
  • Concurrent edition and conflict resolution:
    • Prevents overwriting other users changes when a concurrent edit happens.
    • Opens a Compare/Merge Editor when a concurrent edit happens.

0.1.0 series (current release)

  • Replace EclipseTracPlugin wiki source editor:
    • Integrate with Mylyn WikiText syntax highligting
    • Replace current Outline view with WikiText outline view
  • Enable spellcheck in wiki source editor.

0.1.1 series

  • Context Menu improvements
    • Add 'Open in external Browser' menu option
    • Add 'Compare to base version' menu option
    • Add WikiEditor contextual menu to editor's.
  • Improve syntax highlighting.
  • Add autocompletion templates for common trac macros.

0.2.x series

  • Export wiki pages to different formats provided by WikiText (html, docbook, pdf)

Bugs/Feature Requests

Existing bugs and feature requests for WikiEditorForEclipsePlugin are here.

If you have any issues, create a new ticket.

defect

20 / 24

enhancement

3 / 8

task

2 / 3

Reporting a bug

When reporting a new bug please include all relevant information and steps to reproduce the bug:

  • Plugin version.
  • Stack trace details found in Eclipse Error Log (Window -> Show View -> Error Log) or in <eclipse_workspace>/.metadata/.log.
  • If you think they may be relevant, Include Trac and XmlRpcPlugin versions.
  • And don't forget to detail steps necessary to reproduce the bug.

If you find this plugin useful you can rate it or leave some feedback at Eclipse Plugin Central.

Source

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

This plugin consists of:

  • Java !WikiRPC client library: including a high level API to access this WikiRPCInterface and a batch of automated tests to test default implementation against a Trac server. See Running Tests below.
  • Set of Eclipse plugins: Eclipse wiki source editor and management capabilities.

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

To build WikiEditor4Eclipse you will need the following software:

  • Subversion client
  • Java JDK >= 1.5
  • Maven 3

You can build the plugin running the following commands on the command line:

svn co https://trac-hacks.org/svn/wikieditorforeclipseplugin/trunk WikiEditor4Eclipse
cd WikiEditor4Eclipse
mvn clean install -DskipTests

...

[INFO] ------------------------------------------------------------------------
[INFO] Reactor Summary:
[INFO]
[INFO] Trac WikiEditor 4 Eclipse ......................... SUCCESS [0.203s]
[INFO] Trac WikiEditor 4 Eclipse ~ Core .................. SUCCESS [1.891s]
[INFO] Trac WikiEditor 4 Eclipse ~ Eclipse Modules ....... SUCCESS [0.015s]
[INFO] Trac WikiEditor 4 Eclipse ~ org.trachacks.wikieditor.eclipse.core  SUCCESS [3.172s]
[INFO] Trac WikiEditor 4 Eclipse ~ org.trachacks.wikieditor.eclipse.plugin  SUCCESS [1.875s]
[INFO] Trac WikiEditor 4 Eclipse ~ org.trachacks.wikieditor.eclipse.feature  SUCCESS [0.078s]
[INFO] Trac WikiEditor 4 Eclipse ~ org.trachacks.wikieditor.eclipse.site  SUCCESS [2.047s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 53.860s
[INFO] Finished at: Thu Aug 04 12:27:36 CEST 2011
[INFO] Final Memory: 94M/242M
[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.

For instructions on how to build versions 0.0.x (0.0.6 and older) see wiki/WikiEditorForEclipsePlugin.

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

  • XmlRpcPlugin: !WikiEditor4Eclipse requires XmlRpcPlugin to be installed and enabled on the 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

Install the plugin using one of the following sites:

  • 0.0.6 /svn/wikieditorforeclipseplugin/update-site/v_0.0.x
  • 0.1.0 /svn/wikieditorforeclipseplugin/update-site/v_0.1.0.x

Frequently Asked Questions

Here you can find answers to common situations.

Running Tests

To run automated tests against a Trac server, you will need to set up a local server. These are the prerequisites to run the test suite included in the core library:

  • Set up a test project on a local Trac server of hand. This Trac server must support basic authentication on the standard Trac url location.
  • Set up an user for that project with (at least) the following permissions:
    • WIKI_VIEW
    • WIKI_CREATE
    • WIKI_MODIFY
    • XML_RPC
  • Set up another user with also the following permission:
    • WIKI_DELETE

Default username/password for these users are:

  • user/user
  • admin/admin

Default url for local Trac test project is:

  • http://localhost/trac/test

If you need to override settings configured at core/pom.xml, then the best way is to create a new profile on the standard Maven $HOME/.m2/settings.xml file. You can use the following snippet as base:

<settings>
    <profiles>
        <profile>
            <id>test-properties</id>
            <activation>
                <property><name>!maven.test.skip</name></property>
            </activation>
            <properties>
                <server.url>http://localhost/trac/test</server.url>
                <credentials.admin.username>admin</credentials.admin.username>
                <credentials.admin.password>admin</credentials.admin.password>
                <credentials.user.username>user</credentials.user.username>
                <credentials.user.password>user</credentials.user.password>
            </properties>
        </profile>
    </profiles>
</settings>

Note: some TestSuites need to be run in a particular order, but this is not guaranteed by the unit testing technology used. This is a potential cause for test failures in some particular environments.

If after setting up testing prerequisites as mentioned in this guide, the automated tests still fail to run in your particular environment, you can open a ticket for support.

Feedback

If you find this plugin useful, you can rate it or leave some feedback at Eclipse Market Place.

Recent Changes

14382 by ivangsa on 2015-01-20 11:18:46
Current update-site is v_0.1.1.201501200837
14381 by ivangsa on 2015-01-20 11:18:42
Removing previous update-site release
14380 by ivangsa on 2015-01-20 11:16:56
Current update-site is v_0.1.1.201501200837
(more)

Author/Contributors

Author: ivangsa
Maintainer: Ivan
Contributors: EclipseTracPlugin

Last modified 3 months ago Last modified on Sep 7, 2016, 10:18:19 PM