Home

We encourage everyone to participate in this wiki. To edit it, you need to create an account (top right corner). Just fill in your name and password and that's it (no email confirmation, or other annoying things). Please join us in the projects discussions.

The Java Wikipedia API (Bliki engine) is a parser library for converting Wikipedia wikitext notation to HTML.

Features

• renders Mediawiki/Wikipedia wiki syntax to HTML. It supports:
  • wiki tags for bold, italic, headers, nowiki, source, table of content,...
  • wiki tables, lists, categories, footnotes (references)
  • Image:... tag support
  • wiki tag for syntax highlighting of source code fragments: java, php, python, html/xml, javascript,...
  • templates (includeonly, noinclude,...) The following template parser functions are implemented: Expr, If, Ifeq, Iferror, Ifexist, Ifexpr, LC, LCFirst, Padleft, Padright, Subst, Switch, Tag, UC, UCFirst, URLEncode only partial support is available for: Fullurl, Localurl, NS, Time
  • Lua / Scribunto extension
• extendable through a model interface (IWikiModel.java)
• converts HTML to Wikipedia (available as Appengine, GWT application)
• helper classes for the Wikimedia api.php for downloading wiki texts...
• Example HTMLCreatorExample.java which shows how to download a complete wiki page with templates and images and render it to HTML. The templates are cached in a Derby database.
• helper classes to work with MediaWiki XML dump files.
• BlikiConverter - A converter tool for using the Wiki2HTML, Plain2Wiki and HTML2Wiki conversion methods in a Java Swing GUI

Installation from source

$ mvn install -DskipTests

Using releases

Add the following to your pom.xml.

<dependencies>
  <dependency>
    <groupId>info.bliki.wiki</groupId>
    <artifactId>bliki-core</artifactId>
    <version>3.1.0</version>
  </dependency>
</dependencies>

Using snapshots

Snapshots get updated with every successful build of the project.

<dependencies>
  <dependency>
    <groupId>info.bliki.wiki</groupId>
    <artifactId>bliki-core</artifactId>
    <version>3.1.1-SNAPSHOT</version>
  </dependency>
</dependencies>

<repositories>
  <repository>
    <id>sonatype-snapshots</id>
    <url>https://oss.sonatype.org/content/repositories/snapshots</url>
  </repository>
</repositories>

Links

• Javadocs
• Continuous Integration:

Wikipages

• How to convert Mediawiki text to HTML

• How to use the WikiModel

• Helper classes to work with MediaWiki XML dump files

• Sourcecode to syntax highlighted HTML converter

• How to convert HTML to Mediawiki text

• Helper classes for the MediaWiki api.php

• How to convert Mediawiki text to plain text

• user stories:

  • Wiktionary dumps Processing