Eclipse Wikipedia Editor/Configuration

<<Back

Contents

Configuration

Wiki Project Settings

The Wikipedia texts input and output folders and the text files character encoding can be changed with a right mouse click on a project node in the Navigator view and selecting the menu Properties.

  • in the left area of the dialog select Info and change the Text file encoding to Other: UTF-8.
  • in the left area of the dialog select Wiki Project Settings:

Weblog API Configurations

In the menu Window->Preferences... select the Weblog API Configurations in the left area to configure your XML-RPC blog.

Here is a screenshot for a Roller Weblogger based configuration:

Global Wiki Preferences

In the menu Window->Preferences select the Wikipedia Editor Configurations in the left area to configure your actions:

Download configuration

For downloading a Wikipedia article you have to define the Load... type settings. The configuration's URL should point to the special export page of the wiki. The export page doesn't need a user login (at least on almost all Mediawiki installations I know), so you don't have to specify a user and password for downloading. The link to the special export page can be found, if you open the "Special pages" link in the left "toolbox" menu area of the Mediawiki installation, and search for the word "export".

Examples for special export URL's: http://de.wikibooks.org/wiki/Spezial:Export http://es.wikipedia.org/wiki/Especial:Export

Upload configuration

For uploading a modified Wikipedia article you have to define

  • your Wikipedia user and password for the Store (language) type type settings.
    Please use a username which ends with postfix "...bot" to indicate that you didn't upload the page through the normal Wikipedia web interface.
    With a "...bot" user you have the advantage to get an     extra watchlist, where you can follow the edits you've done with Eclipse.
  • the configuration's URL should point to the base URL of the wiki.
    You can derive the base URL from the URL in an online Mediawiki editor before the question mark.

Example upload URL's: http://en.wikipedia.org/w/index.php http://www.plog4u.org/index.php

Define Templates for the Wikipedia Editor

In the menu Window->Preferences select the Wikipedia Editor Configurations->Templates in the left area to configure which templates you use in the editor:

Global Default Project Properties

In the menu Window->Preferences select the Wikipedia Editor Configurations->Wiki Project Defaults in the left area to configure some default settings.
Note:: the defaults can be overwritten in the Wiki Project Settings (see above)

Customizable Wiki properties

There are predefined properties files in your: eclipse/plugins/org.plog4u.wiki_2.X.X\wikis directory for some of the Wikipedia sites.

If you like to add your own file (i.e. something like MyWikiORG.properties ) you can define a new one in this directory. Copy an existing file and modify it for your prefered MediaWiki server installation.

Additionally you must add the name of your new configuration into the file: eclipse/plugins/org.plog4u.wiki_2.X.X\plugin.xml

In the extension point with the id net.sourceforge.phpeclipse.wiki.favorites add something similar like the snippet below for your wiki name: 

      <favorite 
      id="org.plog4u.wiki.favorite.eclipse"
      name="MyWikiORG"/>

Don't forget to restart eclipse once with the -clean option after changing the plugin.xml file.

If you now select the menu Window->Preferences and open a configuration in the section Wikipedia Editor Configurations there should be two new options: Load MyWikiORG and Store MyWikiORG which you have to configure with user, password and url for downloading and uploading from the server.

Initial default Values

There are platform dependent files in your: eclipse/plugins/org.plog4u.wiki_2.X.X\prefs directory.

These files are: default_win32.properties default_linux.properties default_macosx.properties

For every operating system you would like to install the plugin you can set the following default values:

Throttle Values
The throttle values specify the minimum delay between every download (get) and upload (put) of a Wikipedia article. .get.throttle=1 .put.throttle=5

HTTP Timeout .timeout=30

Proxy Configuration .proxyHost= .proxyPort= .proxyUserName= .proxyPassword=

Default Values for older versions

Before version 2.0.5 of the plugin you can enable Editor wrap mode through the option: editor.wrap.words=false

Note: if you set the wrap mode to true in versions before Eclipse 3.2.x the code folding doesn't work correct.

Since version 2.0.5 (and Eclipse 3.2.x) the editors wrap mode is always activated and this option doesn't exist anymore.