<languages/> Template:PD Help Page
Wiki pages can be exported in a special XML format to [[<tvar|import>Special:MyLanguage/Help:Import|upload import]] into another MediaWiki installation (if this function is enabled on the destination wiki, and the user is a sysop there) or use it elsewise for instance for analysing the content.
See also [[<tvar|meta>m:Syndication feeds|m:Syndication feeds]] for exporting other information but pages and <tvar|import>Help:Import on importing pages.
How to export
There are at least four ways to export pages:
- Paste the name of the articles in the box in [[<tvar|export>Special:Export|Special:Export]] or use <tvar|page>https://wiki.mattrude.com/Special:Export/FULLPAGENAME.
- The backup script <tvar|dumpBackup>dumpBackup.php dumps all the wiki pages into an XML file.
<tvar|dumpBackup>dumpBackup.php only works on MediaWiki 1.5 or newer. You need to have direct access to the server to run this script. Dumps of mediawiki projects are regularly made available at https://dumps.wikimedia.org/.
- Note: you might need to configure AdminSettings.php in order to run dumpBackup.php successfully.
See m:MediaWiki for more information.
- There is a OAI-PMH-interface to regularly fetch pages that have been modified since a specific time.
For Wikimedia projects this interface is not publicly available; see Wikimedia update feed service. OAI-PMH contains a wrapper format around the actual exported articles.
- Use the Python Wikipedia Robot Framework. This won't be explained here
By default only the current version of a page is included.
Optionally you can get all versions with date, time, user name and edit summary.
Optionally the latest version of all templates called directly or indirectly are also exported.
Additionally you can copy the SQL database.
This is how dumps of the database were made available before MediaWiki 1.5 and it won't be explained here further.
To export all pages of a namespace, for example.
1. Get the names of pages to export
I feel an example is better because the description below feels quite unclear.
- Go to [[<tvar|allpages>Special:Allpages|Special:Allpages]] and choose the desired article/file.
- Copy the list of page names to a text editor
- Put all page names on separate lines
- You can achieve that relatively quickly if you copy the part of the rendered page with the desired names, and paste this into say MS Word - use paste special as unformatted text - then open the replace function (CTRL+h), entering ^t in Find what, entering ^p in Replace with and then hitting Replace All button. (
This relies on tabs between the page names; these are typically the result of the fact that the page names are inside td-tags in the html-source.)
- The text editor Vim also allows for a quick way to fix line breaks: after pasting the whole list, run the command <tvar|code1>:1,$s/\t/\r/g to replace all tabs by carriage returns and then <tvar|code2>:1,$s/^\n//g to remove every line containing only a newline character.
- Another approach is to copy the formated text into any editor exposing the html.
Remove all <tvar|tr1><tr> and <tvar|tr2></tr> tags and replace all <tvar|td1><td> tags to <tvar|trtd><tr><td> and <tvar|td2></td> tags to <tvar|tdtr></td></tr> the html will then be parsed into the needed format.
- If you have shell and mysql access to your server, you can use this script:
# mysql -umike -pmikespassword -hlocalhost wikidbname select page_title from wiki_page where page_namespace=0 EOF
Note, replace mike and mikespassword with your own. Also, this example shows tables with the prefix wiki_
- Prefix the namespace to the page names (e.g. 'Help:Contents'), unless the selected namespace is the main namespace.
- Repeat the steps above for other namespaces (e.g. Category:, Template:, etc.)
A similar script for PostgreSQL databases looks like this:
$ psql -At -U wikiuser -h localhost wikidb -c "select page_title from mediawiki.page"
Note, replace wikiuser with your own, the database will prompt you for a password. This example shows tables without the prefix wiki_ and with the namespace specified as part of the table name.
Alternatively, a quick approach for those with access to a machine with Python installed:
- Go to [[<tvar|allpages>Special:Allpages|Special:Allpages]] and choose the desired namespace.
- Save the entire webpage as index.php.htm.
Some wikis may have more pages than will fit on one screen of AllPages; you will need to save each of those pages.
- Run <tvar|export>export_all_helper.py in the same directory as the saved file.
You may wish to pipe the output to a file; e.g. <tvar|code>
python export_all_helper.py > main to send it to a file named "main".
- Save the page names output by the script.
2. Perform the export
- Go to [[<tvar|export>Special:Export|Special:Export]] and paste all your page names into the textbox, making sure there are no empty lines.
- Click 'Submit query'
- Save the resulting XML to a file using your browser's save facility.
- Open the XML file in a text editor.
Scroll to the bottom to check for error messages.
Now you can use this XML file to [[<tvar|import>Special:MyLanguage/Help:Import|perform an import]].
Exporting the full history
A checkbox in the [[<tvar|export>Special:Export|Special:Export]] interface selects whether to export the full history (all versions of an article) or the most recent version of articles.
A maximum of 100 revisions are returned; other revisions can be requested as detailed in Parameters to Special:Export.
The format of the XML file you receive is the same in all ways.
This format is not intended for viewing in a web browser.
Some browsers show you pretty-printed XML with "+" and "-" links to view or hide selected parts.
Alternatively the XML-source can be viewed using the "view source" feature of the browser, or after saving the XML file locally, with a program of choice.
If you directly read the XML source it won't be difficult to find the actual wikitext.
If you don't use a special XML editor "<" and ">" appear as < and >, to avoid a conflict with XML tags; to avoid ambiguity, "&" is coded as "&".
In the current version the export format does not contain an XML replacement of wiki markup (see Wikipedia DTD for an older proposal).
You only get the wikitext as you get when editing the article.
<mediawiki xml:lang="en"> <page> <title>Page title</title> <restrictions>edit=sysop:move=sysop</restrictions> <revision> <timestamp>2001-01-15T13:15:00Z</timestamp> <contributor><username>Foobar</username></contributor> <comment>I have just one thing to say!</comment> <text>A bunch of [[Special:MyLanguage/text|text]] here.</text> <minor /> </revision> <revision> <timestamp>2001-01-15T13:10:27Z</timestamp> <contributor><ip>10.0.0.2</ip></contributor> <comment>new!</comment> <text>An earlier [[Special:MyLanguage/revision|revision]].</text> </revision> </page> <page> <title>Talk:Page title</title> <revision> <timestamp>2001-01-15T14:03:00Z</timestamp> <contributor><ip>10.0.0.2</ip></contributor> <comment>hey</comment> <text>WHYD YOU LOCK PAGE??!!! i was editing that jerk</text> </revision> </page> </mediawiki>
Here is an unofficial, short Document Type Definition version of the format.
If you don't know what a DTD is just ignore it.
<!ELEMENT mediawiki (siteinfo,page*)> <!-- version contains the version number of the format (currently 0.3) --> <!ATTLIST mediawiki version CDATA #REQUIRED xmlns CDATA #FIXED "http://www.mediawiki.org/xml/export-0.3/" xmlns:xsi CDATA #FIXED "http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation CDATA #FIXED "http://www.mediawiki.org/xml/export-0.3/ http://www.mediawiki.org/xml/export-0.3.xsd" xml:lang CDATA #IMPLIED > <!ELEMENT siteinfo (sitename,base,generator,case,namespaces)> <!ELEMENT sitename (#PCDATA)> <!-- name of the wiki --> <!ELEMENT base (#PCDATA)> <!-- url of the main page --> <!ELEMENT generator (#PCDATA)> <!-- MediaWiki version string --> <!ELEMENT case (#PCDATA)> <!-- how cases in page names are handled --> <!-- possible values: 'first-letter' | 'case-sensitive' 'case-insensitive' option is reserved for future --> <!ELEMENT namespaces (namespace+)> <!-- list of namespaces and prefixes --> <!ELEMENT namespace (#PCDATA)> <!-- contains namespace prefix --> <!ATTLIST namespace key CDATA #REQUIRED> <!-- internal namespace number --> <!ELEMENT page (title,id?,restrictions?,(revision|upload)*)> <!ELEMENT title (#PCDATA)> <!-- Title with namespace prefix --> <!ELEMENT id (#PCDATA)> <!ELEMENT restrictions (#PCDATA)> <!-- optional page restrictions --> <!ELEMENT revision (id?,timestamp,contributor,minor?,comment?,text)> <!ELEMENT timestamp (#PCDATA)> <!-- according to ISO8601 --> <!ELEMENT minor EMPTY> <!-- minor flag --> <!ELEMENT comment (#PCDATA)> <!ELEMENT text (#PCDATA)> <!-- Wikisyntax --> <!ATTLIST text xml:space CDATA #FIXED "preserve"> <!ELEMENT contributor ((username,id) | ip)> <!ELEMENT username (#PCDATA)> <!ELEMENT ip (#PCDATA)> <!ELEMENT upload (timestamp,contributor,comment?,filename,src,size)> <!ELEMENT filename (#PCDATA)> <!ELEMENT src (#PCDATA)> <!ELEMENT size (#PCDATA)>
Processing XML export
There are undoubtedly many tools which can process the exported XML.
If you process a large number of pages (for instance a whole dump) you probably won't be able to get the document in main memory so you will need a parser based on SAX or other event-driven methods.
You can also just use regular expressions to directly process parts of the XML code.
This may be faster than other methods but not recommended because it's difficult to maintain.
Please list methods and tools for processing XML export here:
- Parse::MediaWikiDump is a perl module for processing the XML dump file.
- [[<tvar|meta>m:Processing MediaWiki XML with STX|m:Processing MediaWiki XML with STX]] - Stream based XML transformation
- The [[<tvar|meta>m:IBM History flow project|m:IBM History flow project]] can read it after applying a small Python program, <tvar|py>export-historyflow-expand.py.
Details and practical advice
- To determine the namespace of a page you have to match its title to the prefixes defined in
- Possible restrictions are
- sysop (
Why to export
Why not just use a dynamic database download?
Suppose you are building a piece of software that at certain points displays information that came from wikipedia.
If you want your program to display the information in a different way than can be seen in the live version, you'll probably need the wikicode that is used to enter it, instead of the finished html.
Also if you want to get all of the data, you'll probably want to transfer it in the most efficient way that's possible.
The Wikimedia servers need to do quite a bit of work to convert the wikicode into html.
That's time consuming both for you and for the Wikimedia servers, so simply spidering all pages is not the way to go.
To access any article in xml, one at a time, link to: