projects.mako.cc - wikiq/blob - README

   1 wikiq: a WikiMedia XML data dump to .tsv parser
   2
   3 author: Erik Garrison <erik@hypervolu.me>
   4
   5
   6 overview:
   7
   8 wikiq is written in C using expat.  It is designed to enable researchers to
   9 rapidly extract revision histories (minus text and comments) from impossibly
  10 large XML datasets.
  11
  12
  13 use:
  14
  15 To use, first make sure you have libexpat and libpcrecpp installed, then:
  16
  17     % make
  18     % ./wikiq -h  # prints usage
  19     % 7za e -so hugewikidatadump.xml | ./wikiq >hugewikidatadump.tsv
  20
  21
  22 features:
  23
  24 In addition to parsing WikiMedia XML data dumps into a tab-separated tabular
  25 format, wikiq extracts article diffs and can execute arbitrary Perl-compatible
  26 regular expressions against the additions and deletions which differentiate any
  27 revision from the previous.  Any number of regular expressions may be supplied
  28 on the command line, and may be tagged using the '-n' option.
  29
  30 MD5 checksums are used at runtime for precise detection of reversions.
  31
  32
  33 output:
  34
  35 wikiq generates these fields for each revision:
  36
  37 title, articleid, revid, timestamp, anon, editor, editorid, minor,
  38 text_length, text_entropy, text_md5, reversion, additions_size, deletions_size
  39 .... and additional fields for each regex executed against add/delete diffs
  40
  41 Boolean fields are TRUE/FALSE except in the case of reversion, which is blank
  42 unless the article is a revert to a previous revision, in which case, it
  43 contains the revision ID of the revision which was reverted to.
  44
  45
  46 author: Erik Garrison <erik@hypervolu.me>