Changes between Version 2 and Version 3 of WikiEditorForEclipsePlugin


Ignore:
Timestamp:
May 17, 2009, 7:22:21 PM (6 years ago)
Author:
ivangsa
Comment:

Initial description

Legend:

Unmodified
Added
Removed
Modified
  • WikiEditorForEclipsePlugin

    v2 v3  
    11= Trac Wiki Editor 4 Eclipse =
     2
     3[[PageOutline(1-3, , inline)]]
    24
    35== Description ==
    46
    5 A new plug-in providing Trac Wiki editing capabilities to Eclipse IDE
     7!WikiEditor4Eclipse is a new plug-in providing Trac Wiki editing capabilities to Eclipse IDE.
    68
    7 TODO
     9Features:
    810
    9 == Bugs/Feature Requests ==
     11        * Trac Wiki Servers explorer
     12        * Eclipse Wiki Editor: currently, it borrows the editor from the original EclipseTracPlugin plugin.
     13        * Wiki Page managment: Creation, edition and page deletion.
     14        * Concurrent edition management:
     15                - Prevents overwriting other users changes when a concurrent edit happens.
     16                - Helps merge contents when a concurrent edit happens.
    1017
    11 Existing bugs and feature requests for WikiEditorForEclipsePlugin are
     18== Instalation ==
     19
     20!WikiEditor4Eclipse comprises a Wiki Editor as an [http://eclipse.org Eclipse] plugin that comunicates with Trac wiki server through the XmlRpcPlugin. It requires the following software to be installed:
     21
     22=== Server ===
     23
     24        * XmlRpcPlugin: !WikiEditor4Eclipse requires XmlRpcPlugin to be installed and enabled on the server
     25
     26        * [download:eclipsetracplugin/tracrpcext/0.10 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. 
     27
     28=== Client ===
     29
     30        * Add  [http://trac-hacks.org/svn/wikieditorforeclipseplugin/trunk/releases/update-site] to Eclipse Update Manager (Help -> Software Upates -> Available Software -> Add Site). This plugin requires Java Runtime version 1.5 or higher and Eclipse SDK 3.2 or higher (it was tested successfully on Eclipse SDK 3.4.2).
     31
     32
     33== Bugs/Feature Requests ==
     34
     35You can help improving the wiki editor. If you find something anoying, something wrong or something missing you may want to file a
     36[http://trac-hacks.org/newticket?component=WikiEditorForEclipsePlugin&owner=ivangsa new ticket].
     37
     38You can also search for existing bugs and feature requests in !WikiEditor4Eclipse are
    1239[report:9?COMPONENT=WikiEditorForEclipsePlugin here].
    1340
    14 If you have any issues, create a
    15 [http://trac-hacks.org/newticket?component=WikiEditorForEclipsePlugin&owner=ivangsa new ticket].
    1641
    17 == Download ==
     42== Screenshots ==
    1843
    19 Download the zipped source from [download:wikieditorforeclipseplugin here].
     44        * Wiki Editor Prespective:
     45[[Image(source:/wikieditorforeclipseplugin/trunk/docs/screenshots/wikieditor-prespective.png)]]
     46
     47        * Merging conflicting changes
     48[[Image(source:/wikieditorforeclipseplugin/trunk/docs/screenshots/merge-editor.png)]]
    2049
    2150== Source ==
    2251
    23 You can check out WikiEditorForEclipsePlugin from [http://trac-hacks.org/svn/wikieditorforeclipseplugin here] using Subversion, or [source:wikieditorforeclipseplugin browse the source] with Trac.
     52This plugin is composed by:
    2453
    25 == Example ==
     54        * Java Wiki RPC Client Library: this library features a !WikiClient high level API to access
    2655
    27 TODO
     56        * Set of Eclipse plugins: Eclipse wiki source editor and management capabilities.
     57
     58[[Image(source:/wikieditorforeclipseplugin/trunk/docs/screenshots/source-layout.png)]]
     59
     60You can check out !WikiEditor4Eclipse from [http://trac-hacks.org/svn/wikieditorforeclipseplugin here] using Subversion, or [source:wikieditorforeclipseplugin browse the source] with Trac.
     61
     62=== Building from Source ===
     63
     64In order to build !WikiEditor4Eclipse you will need the following software:
     65
     66        * Subversion client
     67        * Java JDK >= 1.5
     68        * [http://docs.codehaus.org/display/M2ECLIPSE/Tycho+builds Tycho] maven plugin (tested with version 0.3.0-DEV-1819)
     69        * Eclipse SDK >= 3.2 (tested with version 3.4.2)
     70       
     71{{{
     72#!sh
     73svn co http://trac-hacks.org/svn/wikieditorforeclipseplugin/trunk/source/ WikiEditor4Eclipse
     74cd WikiEditor4Eclipse
     75/opt/tycho-distribution-0.3.0-DEV-1819/bin/mvn \
     76 -Dtycho.targetPlatform=/opt/eclipse/eclipse-SDK-3.4.2 \
     77 clean install -Dmaven.test.skip
     78}}}
     79
     80This will create a local eclipse update site at ''!TracWikiEditor?4Eclipse/source/eclipse/org.trachacks.wikieditor.eclipse.site/target/site'' you can point Eclipse Update Manager to.
     81
     82== Runing Tests ==
     83
     84In order to run automated tests against a Trac server you will need to setup a local server
     85
     86TODO: how to set up tests prerequisites
     87
    2888
    2989== Recent Changes ==
     
    3494
    3595'''Author:''' [wiki:ivangsa] [[BR]]
    36 '''Contributors:'''
     96'''Contributors:''' [[wiki:merlimat]]
    3797
    3898{{{