doc/tips/convert_mediawiki_to_ikiwiki.mdwn

   1 [[!toc levels=2]]
   2
   3 Mediawiki is a dynamically-generated wiki which stores it's data in a
   4 relational database. Pages are marked up using a proprietary markup. It is
   5 possible to import the contents of a Mediawiki site into an ikiwiki,
   6 converting some of the Mediawiki conventions into Ikiwiki ones.
   7
   8 The following instructions describe ways of obtaining the current version of
   9 the wiki. We do not yet cover importing the history of edits.
  10
  11 Another set of instructions and conversion tools (which imports the full history)
  12 can be found at <http://github.com/mithro/media2iki>
  13
  14 ## Step 1: Getting a list of pages
  15
  16 The first bit of information you require is a list of pages in the Mediawiki.
  17 There are several different ways of obtaining these.
  18
  19 ### Parsing the output of `Special:Allpages`
  20
  21 Mediawikis have a special page called `Special:Allpages` which list all the
  22 pages for a given namespace on the wiki.
  23
  24 If you fetch the output of this page to a local file with something like
  25
  26     wget -q -O tmpfile 'http://your-mediawiki/wiki/Special:Allpages'
  27
  28 You can extract the list of page names using the following python script. Note
  29 that this script is sensitive to the specific markup used on the page, so if
  30 you have tweaked your mediawiki theme a lot from the original, you will need
  31 to adjust this script too:
  32
  33     import sys
  34     from xml.dom.minidom import parse, parseString
  35
  36     dom = parse(sys.argv[1])
  37     tables = dom.getElementsByTagName("table")
  38     pagetable = tables[-1]
  39     anchors = pagetable.getElementsByTagName("a")
  40     for a in anchors:
  41         print a.firstChild.toxml().\
  42             replace('&amp;','&').\
  43             replace('&lt;','<').\
  44             replace('&gt;','>')
  45
  46 Also, if you have pages with titles that need to be encoded to be represented
  47 in HTML, you may need to add further processing to the last line.
  48
  49 Note that by default, `Special:Allpages` will only list pages in the main
  50 namespace. You need to add a `&namespace=XX` argument to get pages in a
  51 different namespace. The following numbers correspond to common namespaces:
  52
  53  * 10 - templates (`Template:foo`)
  54  * 14 - categories (`Category:bar`)
  55
  56 Note that the page names obtained this way will not include any namespace
  57 specific prefix: e.g. `Category:` will be stripped off.
  58
  59 ### Querying the database
  60
  61 If you have access to the relational database in which your mediawiki data is
  62 stored, it is possible to derive a list of page names from this.
  63
  64 ## Step 2: fetching the page data
  65
  66 Once you have a list of page names, you can fetch the data for each page.
  67
  68 ### Method 1: via HTTP and `action=raw`
  69
  70 You need to create two derived strings from the page titles: the
  71 destination path for the page and the source URL. Assuming `$pagename`
  72 contains a pagename obtained above, and `$wiki` contains the URL to your
  73 mediawiki's `index.php` file:
  74
  75     src=`echo "$pagename" | tr ' ' _ | sed 's,&,&amp;,g'`
  76     dest=`"$pagename" | tr ' ' _ | sed 's,&,__38__,g'`
  77
  78     mkdir -p `dirname "$dest"`
  79     wget -q "$wiki?title=$src&action=raw" -O "$dest"
  80
  81 You may need to add more conversions here depending on the precise page titles
  82 used in your wiki.
  83
  84 If you are trying to fetch pages from a different namespace to the default,
  85 you will need to prefix the page title with the relevant prefix, e.g.
  86 `Category:` for category pages. You probably don't want to prefix it to the
  87 output page, but you may want to vary the destination path (i.e. insert an
  88 extra directory component corresponding to your ikiwiki's `tagbase`).
  89
  90 ### Method 2: via HTTP and `Special:Export`
  91
  92 Mediawiki also has a special page `Special:Export` which can be used to obtain
  93 the source of the page and other metadata such as the last contributor, or the
  94 full history, etc.
  95
  96 You need to send a `POST` request to the `Special:Export` page. See the source
  97 of the page fetched via `GET` to determine the correct arguments.
  98
  99 You will then need to write an XML parser to extract the data you need from
 100 the result.
 101
 102 ### Method 3: via the database
 103
 104 It is possible to extract the page data from the database with some
 105 well-crafted queries.
 106
 107 ## Step 3: format conversion
 108
 109 The next step is to convert Mediawiki conventions into Ikiwiki ones.
 110
 111 ### categories
 112
 113 Mediawiki uses a special page name prefix to define "Categories", which
 114 otherwise behave like ikiwiki tags. You can convert every Mediawiki category
 115 into an ikiwiki tag name using a script such as
 116
 117     import sys, re
 118     pattern =  r'\[\[Category:([^\]]+)\]\]'
 119
 120     def manglecat(mo):
 121             return '\[[!tag %s]]' % mo.group(1).strip().replace(' ','_')
 122
 123     for line in sys.stdin.readlines():
 124             res = re.match(pattern, line)
 125             if res:
 126                     sys.stdout.write(re.sub(pattern, manglecat, line))
 127             else: sys.stdout.write(line)
 128
 129 ## Step 4: Mediawiki plugin
 130
 131 The [[plugins/contrib/mediawiki]] plugin can be used by ikiwiki to interpret
 132 most of the Mediawiki syntax.
 133
 134 ## External links
 135
 136 [[sabr]] used to explain how to [import MediaWiki content into
 137 git](http://u32.net/Mediawiki_Conversion/index.html?updated), including full
 138 edit history, but as of 2009/10/16 that site is not available. A copy of the
 139 information found on this website is stored at <http://github.com/mithro/media2iki>
 140
 141