Eclipse Wikipedia Editor/Getting Started

<<Back

Contents

Features

The Wikipedia Plugin contains a Wikipedia Syntax Editor with the following features:

  • parallel offline editing for multiple articles
  • syntax highlighting for code snippets (sourround the code in tags like: <java>...</java>, <php>...</php>, <javascript>...</javascript>, <xml>...</xml>, <abap>...</abap>
  • source folding
  • source outline view for article headers
  • integrated HTML preview rendering (Windows, Linux, MacOS)
  • Editor templates (Ctrl+SPACE content assist) (pre- and selfdefined in menu Windows->Preferences)
  • configurable MySQL JDBC interface to a Wikipedia page table (for example for a locally installed Wikipedia engine)
    • titles from the database are suggested for content assist (type 3 characters of the title and press Ctrl+SPACE) (column-name page_titile)
  • Updates (i.e. HTML GET) from Wikipedia sites (right mouse click on the source filenames in the Navigator View)
  • HTTP GET Queries from selected editor texts (search Google, Koders.com,...) (right mouse click in the editor)
  • export wizard for generating HTML files
  • export wizard for generating PDF files
  • open another Wikipedia article with right mouse click on a Wikipedia link and selecting "Open Wiki link"
  • HTML pages can be configured with velocity templates (preview and export)

Forum

There is a Bliki Wikipedia Engine Forum for discussing this plugins.

Installation

  • Download and install the Java 2 Standard Edition (J2SE) (version >= 1.4) from
Java.com
  • Download and unzip Eclipse version 3.2.x from
eclipse.org
Note: if you don't want to develop programs in Java you don't have to download the full Eclipse SDK (approx. 120MB) (which includes the Java Development Tools). Wikipedia Plugin requires only the Platform Runtime Binary (approx. 34MB) download.
  • Download the newest Wikipedia Editor plugin:
org.plog4u.core_2.0.6.zip
Unzip it into the corresponding /plugins and /features Eclipse subdirectories.
Please restart Eclipse once with the -clean option to ensure that the plugin.xml cache is refreshed.

Creating a Wikipedia Project

Creating a new Wikipedia Project

  • open the project wizard in the menu File->New->Project...
  • select Wikipedia->Wikipedia Project in the wizards dialog box
  • press the Next button
  • insert a name for your new Wikipedia project (for example plo4u_org)
  • press the Finish button

Add a Wikipedia project to an existing project node

If you want to use an already existing eclipse project for storing addittional wiki articles, you can do a right mouse click in the Navigator or Package Explorer view on that existing project node and select the menu Add Wiki Builder.

Note: At the moment it's not possible to do this with an Eclipse Plug-in Project (PDE) node.

Generated project files and directories

Creating a Wikipedia project will add the following Eclipse builder string: 

org.plog4u.wiki.wikibuilder

to the .project meta file in the current project and create the default subfolders:

  • /plog4u_org/wpsrc
  • /plog4u_org/wpbin

The /plog4u_org/wpsrc subfolder should contain all your Wikipedia text files. Wikipedia text files have the extension *.wp.

Additionally two velocity template files and a css file are generated in the /plog4u_org/wpsrc subfolder:

  • main.css - a predefined CSS style for the pages
  • main.vm - a velocity template file to configure the previewed Wikipedia editor pages
  • export.vm - a velocity template file to configure the exported Wikipedia to HTML pages

Note: To view the .project (and other) meta files select menu Window->Open Perspective->Resource. In the Navigator view the .project file is stored directly under your project's node.

The Wiki browser view

To preview a wiki article in an embedded HTML browser you can use the Wiki Browser view. You can open the view by selecting menu Window->Show View->Other.... In the appearing dialog box choose the node Wiki Web Development->Wiki Browser.

Downloading pages

Once a project has been created, pages can be downloaded by following these steps: Eclipse Wikipedia Editor/Download a Wikipedia Article.