Changes between Version 51 and Version 52 of WikiEditorForEclipsePlugin


Ignore:
Timestamp:
Jul 23, 2015, 8:35:55 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • WikiEditorForEclipsePlugin

    v51 v52  
    1 = Trac Wiki Editor 4 Eclipse =
    2  
    3 
    4 [[PageOutline(2-3, , inline)]]
    5 
    6 == Description ==
    7 
    8 !WikiEditor4Eclipse is a new plug-in providing Trac Wiki editing capabilities to Eclipse IDE.
    9 
    10 A new version of this plugin was released on August 2011.
    11 
    12 You can visit its Eclipse Market Place page at http://marketplace.eclipse.org/content/trac-wiki-editor-4-eclipse-0
    13 
    14 === Implemented Features ===
    15 
    16 Current version is 0.1.0 provides the following features:
    17 
    18         * Trac Wiki Servers explorer
    19                 - New hierachical tree view among other fixes
    20         * Eclipse Wiki Editor:
    21            * Upgraded from the original EclipseTracPlugin plugin to use Mylyn [http://wiki.eclipse.org/Mylyn/WikiText Mylyn WikiText].
    22            * Spellcheck
    23         * Wiki Page management: Creation, edition and page deletion.
    24         * Concurrent edition management:
    25                 - Prevents overwriting other users changes when a concurrent edit happens.
    26                 - Helps merge contents when a concurrent edit happens.
    27                
    28                
    29 === Development Plan ===
    30 
    31 ==== 0.0.x series (old stable) : ====
    32        
     1[[PageOutline(2-5,Contents,pullout)]]
     2
     3= Trac Wiki Editor for Eclipse
     4
     5== Description
     6
     7This plugin provides Trac with editing capabilities to Eclipse IDE. A new version of this plugin was released on August 2011. You can visit its Eclipse Market Place page at http://marketplace.eclipse.org/content/trac-wiki-editor-4-eclipse-0
     8
     9Key features:
     10 * Trac Wiki Servers explorer: new hierachical tree view among other fixes
     11 * Eclipse Wiki Editor:
     12   * Upgraded from the original EclipseTracPlugin plugin to use Mylyn [http://wiki.eclipse.org/Mylyn/WikiText Mylyn WikiText].
     13   * Spellcheck
     14 * Wiki Page management: creation, editing and page deletion.
     15 * Concurrent edition management:
     16   - Prevents overwriting other users changes when a concurrent edit happens.
     17   - Helps merge contents when a concurrent edit happens.
     18                               
     19=== Development Plan
     20
     21==== 0.0.x series (old stable)
     22
    3323        * Trac Wiki Server explorer with hierarchical tree.
    3424        * Eclipse Wiki Editor with syntax highligting and autocompletion borrowed from EclipseTracPlugin.
    … …  
    3828                - Opens a Compare/Merge Editor when a concurrent edit happens.
    3929       
    40 ==== 0.1.0 series (current release): ====
     30==== 0.1.0 series (current release)
    4131       
    4232        * Replace EclipseTracPlugin wiki source editor:
    … …  
    4535        * Enable spellcheck in wiki source editor.
    4636
    47 ==== 0.1.1 series: ====
     37==== 0.1.1 series
    4838
    4939  * Context Menu improvements
    … …  
    5444  * Add autocompletion templates for common trac macros.
    5545 
    56 
    57 ==== 0.2.x series: ====
     46==== 0.2.x series
    5847       
    5948        * Export wiki pages to different formats provided by !WikiText (html, docbook, pdf)
    6049
    61 == Installation ==
     50== Installation
    6251
    6352!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:
    6453
    65 === Server ===
     54=== Server
    6655
    6756        * XmlRpcPlugin: !WikiEditor4Eclipse requires XmlRpcPlugin to be installed and enabled on the server
    … …  
    6958        * [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. 
    7059
    71 === Client ===
    72 
    73 !Install de Editor plugin using one of the following update sites:
     60=== Client
     61
     62Install the plugin using one of the following sites:
    7463
    7564  * '''0.0.6''' http://trac-hacks.org/svn/wikieditorforeclipseplugin/update-site/v_0.0.x
    7665  * '''0.1.0''' http://trac-hacks.org/svn/wikieditorforeclipseplugin/update-site/v_0.1.0.x
    7766
    78 
    79 == Screenshots ==
     67== Screenshots
    8068
    8169        * Wiki Editor Perspective:
    … …  
    8573[[Image(source:/wikieditorforeclipseplugin/branches/docs/screenshots/merge-editor.png)]]
    8674
    87 == Frequently Asked Questions ==
     75== Frequently Asked Questions
    8876
    8977[wiki:WikiEditorForEclipsePlugin/FAQ Here] you can find answers to common situations.
    9078
    91 == Bugs/Feature Requests ==
     79== Bugs/Feature Requests
    9280
    9381You can help improving the wiki editor. If you find something annoying, something wrong or something missing you may want to file a
    94 [http://trac-hacks.org/newticket?component=WikiEditorForEclipsePlugin&owner=ivangsa new ticket].
    95 
    96 ==== Before filing a a new bug: ====
     82[/newticket?component=WikiEditorForEclipsePlugin new ticket].
     83
     84==== Before filing a a new bug
    9785
    9886        * Read the [wiki:WikiEditorForEclipsePlugin/FAQ Frequently Asked Questions] page. There you can find answers to common situations.
    99         * Search [report:9?COMPONENT=WikiEditorForEclipsePlugin existing bugs] and feature requests in !WikiEditor4Eclipse to see if it was already reported or there is a workaround available.
    100 
    101 ==== Reporting a bug ====
     87        * Search [report:9?COMPONENT=WikiEditorForEclipsePlugin existing bugs] and feature requests to see if it was already reported or there is a workaround available.
     88
     89==== Reporting a bug
    10290
    10391When reporting a new bug please include all relevant information and steps to reproduce the bug:
    10492
    105          * Plugin version       
     93         * Plugin version.       
    10694         * Stack trace  details found in Eclipse Error Log (Window -> Show View -> Error Log) or in '''<eclipse_workspace>/.metadata/.log'''.
    10795         * If you think they may be relevant, Include Trac and XmlRpcPlugin versions.
    108          * And don't forget to detail steps necesary to reproduce the bug.
    109          
    110          
     96         * And don't forget to detail steps necessary to reproduce the bug.
    11197
    11298If you find this plugin useful you can rate it or leave some feedback at [http://eclipseplugincentral.com/Web_Links-index-req-viewlink-cid-1521.html Eclipse Plugin Central].
    11399
    114 == Building from Source ==
     100[[TicketQuery(component=WikiEditorForEclipsePlugin&group=type,format=progress)]]
     101
     102== Building from Source
    115103
    116104You can check out !WikiEditor4Eclipse from [http://trac-hacks.org/svn/wikieditorforeclipseplugin here] using Subversion, or [source:wikieditorforeclipseplugin browse the source] with Trac.
    117105
    118 
    119106This plugin is composed by:
    120107
    121         * 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).
     108        * 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.
    122109
    123110        * Set of Eclipse plugins: Eclipse wiki source editor and management capabilities.
    … …  
    133120You can build the plugin running the following commands on the command line:
    134121       
    135 {{{
    136 #!sh
     122{{{#!sh
    137123svn co http://trac-hacks.org/svn/wikieditorforeclipseplugin/trunk WikiEditor4Eclipse
    138124cd WikiEditor4Eclipse
    … …  
    164150This 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.
    165151
    166 (For instructions on how to build versions 0.0.x (0.0.6 and older) see [/wiki/WikiEditorForEclipsePlugin?version=37#BuildingfromSource])
    167 
    168 == Running Tests ==
     152For instructions on how to build versions 0.0.x (0.0.6 and older) see [/wiki/WikiEditorForEclipsePlugin?version=37#BuildingfromSource].
     153
     154== Running Tests
    169155
    170156In 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:
    171157
    172         * 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.
     158        * 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.
    173159       
    174160        * Set up an user for that project with (at least) the following permissions:
    … …  
    191177        *  !http://localhost/trac/test
    192178
    193 
    194 If you need to override settings configured at [source:wikieditorforeclipseplugin/trunk/source/core/pom.xml#L111 core/pom.xml], probably the best way is creating a new ''profile'' on the standard maven $HOME/.m2/settings.xml file. You can use the following snippet as base:
    195 
    196 {{{
    197 #!text/xml
     179If 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:
     180
     181{{{#!text/xml
    198182<settings>
    199183        <profiles>
    … …  
    215199}}}
    216200
    217 NOTE: some TestSuites need to be run in particular order but this is not guaranteed by unit testing technology used. This is something I would like to address at some point, as it is a potential test failure cause in some particular environments.
     201'''Note''': some TestSuites need to be run in a particular order, but this is not guaranteed by unit testing technology used. This is something I would like to address, as it is a potential cause for test failures in some particular environments.
    218202
    219203If after setting up testing prerequisites as mentioned in this guide, automated tests still fail to run in your particular environment you can open a [http://trac-hacks.org/newticket?component=WikiEditorForEclipsePlugin&owner=ivangsa ticket] for support.
    220204
    221 Happy Hacking!!
    222 
    223 == Comments ==
    224 
    225 If you find this plugin useful you can rate it or leave some feedback at [http://marketplace.eclipse.org/content/trac-wiki-editor-4-eclipse-0 Eclipse Market Place].
    226 
    227 == Recent Changes ==
     205== Comments
     206
     207If you find this plugin useful, you can rate it or leave some feedback at [http://marketplace.eclipse.org/content/trac-wiki-editor-4-eclipse-0 Eclipse Market Place].
     208
     209== Recent Changes
    228210
    229211[[ChangeLog(wikieditorforeclipseplugin, 3)]]
    230212
    231 == Author/Contributors ==
     213== Author/Contributors
    232214
    233215'''Author:''' [wiki:ivangsa] [[BR]]
    234 '''Maintainer:''' [wiki:ivangsa] [[BR]]
     216'''Maintainer:''' [[Maintainer]] [[BR]]
    235217'''Contributors:''' [wiki:EclipseTracPlugin]