Changes between Version 54 and Version 55 of WikiEditorForEclipsePlugin
- Timestamp:
- Mar 25, 2016, 6:42:59 AM (8 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
WikiEditorForEclipsePlugin
v54 v55 8 8 9 9 Key features: 10 * Trac Wiki Servers explorer: new hiera chical tree view among other fixes.10 * Trac Wiki Servers explorer: new hierarchical tree view. 11 11 * Eclipse Wiki Editor: 12 12 * Upgraded from the original EclipseTracPlugin plugin to use [http://wiki.eclipse.org/Mylyn/WikiText Mylyn WikiText]. … … 48 48 * Export wiki pages to different formats provided by !WikiText (html, docbook, pdf) 49 49 50 == Installation51 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 === Server55 56 * XmlRpcPlugin: !WikiEditor4Eclipse requires XmlRpcPlugin to be installed and enabled on the server57 * [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 === Client60 61 Install the plugin using one of the following sites:62 63 * '''0.0.6''' /svn/wikieditorforeclipseplugin/update-site/v_0.0.x64 * '''0.1.0''' /svn/wikieditorforeclipseplugin/update-site/v_0.1.0.x65 66 == Screenshots67 68 * Wiki Editor Perspective:69 [[Image(source:/wikieditorforeclipseplugin/branches/docs/screenshots/wikieditor-prespective.png)]]70 71 * Merging conflicting changes72 [[Image(source:/wikieditorforeclipseplugin/branches/docs/screenshots/merge-editor.png)]]73 74 == Frequently Asked Questions75 76 [wiki:WikiEditorForEclipsePlugin/FAQ Here] you can find answers to common situations.77 78 50 == Bugs/Feature Requests 79 51 … … 86 58 [[TicketQuery(component=WikiEditorForEclipsePlugin&group=type,format=progress)]] 87 59 88 === =Reporting a bug60 === Reporting a bug 89 61 90 62 When reporting a new bug please include all relevant information and steps to reproduce the bug: … … 99 71 == Source 100 72 101 You can check out !WikiEditor4Eclipse from [/svn/wikieditorforeclipseplugin here] using Subversion, or [source:wikieditorforeclipseplugin browse the source] with Trac.73 You can check out WikiEditor4Eclipse from [/svn/wikieditorforeclipseplugin here] using Subversion, or [source:wikieditorforeclipseplugin browse the source] with Trac. 102 74 103 75 This 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. 108 78 109 79 [[Image(source:/wikieditorforeclipseplugin/branches/docs/screenshots/source-layout.png)]] 110 80 111 In order to build !WikiEditor4Eclipse you will need the following software: 112 113 * Subversion client 114 * Java JDK >= 1.5 115 * Maven 3 81 To build WikiEditor4Eclipse you will need the following software: 82 * Subversion client 83 * Java JDK >= 1.5 84 * Maven 3 116 85 117 86 You can build the plugin running the following commands on the command line: 118 87 119 88 {{{#!sh 120 svn co http ://trac-hacks.org/svn/wikieditorforeclipseplugin/trunk WikiEditor4Eclipse89 svn co https://trac-hacks.org/svn/wikieditorforeclipseplugin/trunk WikiEditor4Eclipse 121 90 cd WikiEditor4Eclipse 122 91 mvn clean install -DskipTests … … 149 118 For instructions on how to build versions 0.0.x (0.0.6 and older) see [/wiki/WikiEditorForEclipsePlugin?version=37#BuildingfromSource]. 150 119 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 131 Install 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 151 149 == Running Tests 152 150 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 151 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: 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 165 160 166 161 Default username/password for these users are: 167 168 * user/user 169 170 * admin/admin 162 * user/user 163 * admin/admin 171 164 172 165 Default url for local Trac test project is: 173 174 * !http://localhost/trac/test 166 * !http://localhost/trac/test 175 167 176 168 If 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: … … 198 190 '''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. 199 191 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=ivangsaticket] for support.192 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 [/newticket?component=WikiEditorForEclipsePlugin ticket] for support. 201 193 202 194 == Feedback