Changes between Version 54 and Version 55 of WikiEditorForEclipsePlugin


Ignore:
Timestamp:
Mar 25, 2016, 6:42:59 AM (8 years ago)
Author:
figaro
Comment:

Rearranged paragraphs to maintain consistency

Legend:

Unmodified
Added
Removed
Modified
  • WikiEditorForEclipsePlugin

    v54 v55  
    88
    99Key features:
    10  * Trac Wiki Servers explorer: new hierachical tree view among other fixes.
     10 * Trac Wiki Servers explorer: new hierarchical tree view.
    1111 * Eclipse Wiki Editor:
    1212   * Upgraded from the original EclipseTracPlugin plugin to use [http://wiki.eclipse.org/Mylyn/WikiText Mylyn WikiText].
     
    4848        * Export wiki pages to different formats provided by !WikiText (html, docbook, pdf)
    4949
    50 == Installation
    51 
    52 !WikiEditor4Eclipse features a Wiki Editor as an [http://eclipse.org Eclipse] plugin that communicates with Trac wiki server through the XmlRpcPlugin. It requires the following software to be installed:
    53 
    54 === Server
    55 
    56  * XmlRpcPlugin: !WikiEditor4Eclipse requires XmlRpcPlugin to be installed and enabled on the server
    57  * [export: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. 
    58 
    59 === Client
    60 
    61 Install the plugin using one of the following sites:
    62 
    63   * '''0.0.6''' /svn/wikieditorforeclipseplugin/update-site/v_0.0.x
    64   * '''0.1.0''' /svn/wikieditorforeclipseplugin/update-site/v_0.1.0.x
    65 
    66 == Screenshots
    67 
    68  * Wiki Editor Perspective:
    69 [[Image(source:/wikieditorforeclipseplugin/branches/docs/screenshots/wikieditor-prespective.png)]]
    70 
    71  * Merging conflicting changes
    72 [[Image(source:/wikieditorforeclipseplugin/branches/docs/screenshots/merge-editor.png)]]
    73 
    74 == Frequently Asked Questions
    75 
    76 [wiki:WikiEditorForEclipsePlugin/FAQ Here] you can find answers to common situations.
    77 
    7850== Bugs/Feature Requests
    7951
     
    8658[[TicketQuery(component=WikiEditorForEclipsePlugin&group=type,format=progress)]]
    8759
    88 ==== Reporting a bug
     60=== Reporting a bug
    8961
    9062When reporting a new bug please include all relevant information and steps to reproduce the bug:
     
    9971== Source
    10072
    101 You can check out !WikiEditor4Eclipse from [/svn/wikieditorforeclipseplugin here] using Subversion, or [source:wikieditorforeclipseplugin browse the source] with Trac.
     73You can check out WikiEditor4Eclipse from [/svn/wikieditorforeclipseplugin here] using Subversion, or [source:wikieditorforeclipseplugin browse the source] with Trac.
    10274
    10375This plugin consists of:
    104 
    105         * Java !WikiRPC client library: including a high level API to access this [http://www.jspwiki.org/wiki/WikiRPCInterface WikiRPCInterface] and a batch of automated tests to test default implementation against a Trac server. See [#RunningTests Running Tests] below.
    106 
    107         * Set of Eclipse plugins: Eclipse wiki source editor and management capabilities.
     76 * Java !WikiRPC client library: including a high level API to access this [http://www.jspwiki.org/wiki/WikiRPCInterface WikiRPCInterface] and a batch of automated tests to test default implementation against a Trac server. See [#RunningTests Running Tests] below.
     77 * Set of Eclipse plugins: Eclipse wiki source editor and management capabilities.
    10878
    10979[[Image(source:/wikieditorforeclipseplugin/branches/docs/screenshots/source-layout.png)]]
    11080
    111 In order to build !WikiEditor4Eclipse you will need the following software:
    112 
    113         * Subversion client
    114         * Java JDK >= 1.5
    115         * Maven 3
     81To build WikiEditor4Eclipse you will need the following software:
     82 * Subversion client
     83 * Java JDK >= 1.5
     84 * Maven 3
    11685
    11786You can build the plugin running the following commands on the command line:
    11887       
    11988{{{#!sh
    120 svn co http://trac-hacks.org/svn/wikieditorforeclipseplugin/trunk WikiEditor4Eclipse
     89svn co https://trac-hacks.org/svn/wikieditorforeclipseplugin/trunk WikiEditor4Eclipse
    12190cd WikiEditor4Eclipse
    12291mvn clean install -DskipTests
     
    149118For instructions on how to build versions 0.0.x (0.0.6 and older) see [/wiki/WikiEditorForEclipsePlugin?version=37#BuildingfromSource].
    150119
     120== Installation
     121
     122!WikiEditor4Eclipse features a Wiki Editor as an [http://eclipse.org Eclipse] plugin that communicates with Trac wiki server through the XmlRpcPlugin. It requires the following software to be installed:
     123
     124=== Server
     125
     126 * XmlRpcPlugin: !WikiEditor4Eclipse requires XmlRpcPlugin to be installed and enabled on the server.
     127 * [export: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. 
     128
     129=== Client
     130
     131Install the plugin using one of the following sites:
     132  * '''0.0.6''' /svn/wikieditorforeclipseplugin/update-site/v_0.0.x
     133  * '''0.1.0''' /svn/wikieditorforeclipseplugin/update-site/v_0.1.0.x
     134
     135== Screenshots
     136
     137'''Wiki Editor Perspective''':
     138
     139[[Image(source:/wikieditorforeclipseplugin/branches/docs/screenshots/wikieditor-prespective.png)]]
     140
     141'''Merging conflicting changes''':
     142
     143[[Image(source:/wikieditorforeclipseplugin/branches/docs/screenshots/merge-editor.png)]]
     144
     145== Frequently Asked Questions
     146
     147[wiki:WikiEditorForEclipsePlugin/FAQ Here] you can find answers to common situations.
     148
    151149== Running Tests
    152150
    153 In order to run automated tests against a Trac server you will need to setup a local server. These are the prerequisites in order to run the test suit included in the ''core'' library:
    154 
    155         * 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.
    156        
    157         * Set up an user for that project with (at least) the following permissions:
    158                         - WIKI_VIEW
    159                         - WIKI_CREATE
    160                         - WIKI_MODIFY
    161                         - XML_RPC
    162                
    163         * Set up another user with also the following permission:
    164                         - WIKI_DELETE
     151To 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:
     152 * 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.
     153 * Set up an user for that project with (at least) the following permissions:
     154   - WIKI_VIEW
     155   - WIKI_CREATE
     156   - WIKI_MODIFY
     157   - XML_RPC   
     158 * Set up another user with also the following permission:
     159   - WIKI_DELETE
    165160
    166161Default username/password for these users are:
    167 
    168         * user/user
    169        
    170         * admin/admin
     162 * user/user
     163 * admin/admin
    171164       
    172165Default url for local Trac test project is:
    173 
    174         *  !http://localhost/trac/test
     166 * !http://localhost/trac/test
    175167
    176168If you need to override settings configured at [source:wikieditorforeclipseplugin/trunk/source/core/pom.xml#L111 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:
     
    198190'''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.
    199191
    200 If after setting up testing prerequisites as mentioned in this guide, automated tests still fail to run in your particular environment you can open a [/newticket?component=WikiEditorForEclipsePlugin&owner=ivangsa ticket] for support.
     192If 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 [/newticket?component=WikiEditorForEclipsePlugin ticket] for support.
    201193
    202194== Feedback