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