What is it?
It is a library and a tool for parsing Wikipedia XML dumps and converting them into plain text for other tools to use.
Why use it?
Subjectivly generates good results and is reasonably fast, on my laptop (4 physical cores, 8 logical threads, 2.3 Ghz Haswell Core i7) it achieves an average of 6000 pages/sec or 10 minutes for a 2014-08-18 Swedish Wikipedia dump. Your results may of course vary.
How to use?
Download a multistreamed wikipedia bzip2 dump. It consists of two files: one index and one with the pages.
For a Swedish Wikipedia dump 2014-08-18 it has the following file names:
Make sure their names are intact because otherwise the automatic language resolving does not work. The default language is English and it does affect the parsing quality.
Both compressed files must be placed in the directory for the command below to work properly.
To run it all: go to the dist/ directory in your terminal and run
java -jar wikiforia-1.0-SNAPSHOT.jar -pages [path to the file ending with multistream.xml.bz2] -output [output xml path]
This will run with default settings i.e. the number of cores you have and a batch size of 100. These settings can be overriden, for a full listing just run:
java -jar wikiforia-1.0-SNAPSHOT.jar
The output from the tool is an XML with the following structure (example data)
<?xml version="1.0" encoding="utf-8"?> <pages> <page id="4" title="Alfred" revision="1386155063000" type="text/x-wiki" ns-id="0" ns-name="">Alfred, with a new line</page> <page id="10" title="Template:Infobox" revision="1386155040000" type="text/x-wiki" ns-id="10" ns-name="Template">Template stuff</page> </pages>
- Wikipedia Page id
- The title of the Wikipedia page
- The revision as given by the dump, but in milliseconds since UNIX epoch time
- the format, will always be text/x-wiki in this version of the tool
- The namespace id, 0 is the principal namespace which contains all articles, take a look at Namespaces at [Wikipedia for more information](http://en.wikipedia.org/wiki/Wikipedia:Namespace)
- Localized name for the namspace, for 0 it is usually just an empty string
Contributed by @smhumayun, support for Plain Text output format on top of existing XML format. Use Case: extract text only from the Wikipedia e.g in order to use it as a Corpus for different Machine Learning experiments.
To run it: Download wikiforia-x.y.z.jar from dist/ directory, open your terminal, go/cd to download location and run
java -jar wikiforia-x.y.z.jar -pages [path to the file ending with multistream.xml.bz2] -output [output xml path] -outputformat plain-text
Empty articles, for which no text could be found is not included. This includes redirects and most of the templates and categories, because they have no useful text. If you use the API you can extract this bit of information.
270 language specific configurations have been generated from the Wikimedia source tree that is publicly available. The quality of these autogenerations are uncertain as they are not tested. Kindly confirm or report if your language does not work so that I could possibly mitigate the issue.
The English language is used as fallback when parsing.
The code can also be used directly to extract more information.
More information about this will be added, but for now take a look at se.lth.cs.nlp.wikiforia.App and the convert method to get an idea of how to use the code.
Peter Exner, the author of KOSHIK. The Sweble code is partially based on the KOSHIK version.
Sweble, developed by the Open Source Research Group at the Friedrich-Alexander-University of Erlangen-Nuremberg. This library is used to parse the Wikimarkup.
Woodstox, Quick XML parser, used to parse the XML and write XML output.
Apache Commons, a collection of useful and excellent libraries. Used CLI for the options.
The licence is GPLv2.