WikiLink - The Mediawiki Interface

WikiLink is actually two separate things; firstly, a java class for interfacing with a mediawiki server, and secondly, a Mathematica package providing a wrapper around this. This page documents the Mathematica package, while the java class, and its addition functionality, will be documented elsewhere.

WikiLink is available as a standalone package, suitable for use with any Mediawiki installation, and is included in the KnotTheory` package.

Download

If you already have KnotTheory` installed, there's no need to install anything. The functionality of WikiLink is available as soon as you open KnotTheory`.

Otherwise, download WikiLink.zip. Unzip this anywhere you like. This will create a subdirectory called WikiLink, containing (at least) these files:

Filename	Description
`mathematica/WikiLink.nb`	The Mathematica notebook containing wrapper function definitions.
`mathematica/WikiLink.m`	The Mathematica package automatically generated from `WikiLink.nb`.
`wikilink.jar`	The WikiLink java classes and source code.
`jars/jdom.jar` `jars/commons-httpclient-3.0-rc2.jar` `jars/commons-codec-1.3.jar` `jars/commons-lang-2.1.jar` `jars/commons-logging.jar`	Libraries (all available under either GPL or the Apache license) required by `wikilink.jar`

Usage

WikiLink` provides functions for checking your login status, getting and setting pages, as well as transparently extending some of Mathematica's string manipulation functions to wiki pages.

In[6]:=	?WikiUserName
WikiUserName[] returns either the name of the user you are logged in as, your IP address if you're not logged in, or $Failed if something more complicated has happened!

In[7]:=	?WikiGetPageText
WikiGetPageText[pagename] returns the raw text of the specified page.

In[8]:=	?WikiSetPageText
WikiSetPageText[pagename, text] overwrites the contents of the specificied page with the given text. WikiSetPageText[pagename, text, summary] overwrites the contents of the specificied page with the given text and notes summary in the change log.

In[9]:=	?WikiSetPageTexts
WikiSetPageText[{{pagename1, text1},{pagename2,text2},...}] efficiently sets multiple pages, by first checking which texts are already up to date.

In[10]:=	?WikiUploadFile
WikiUploadFile[name, description] uploads the specified file to the wiki.

Thus for example after

`In[11]:=`	`WikiSetPageText["Sandbox", "A robotic edit, at 19:39, 31-August-2005."]`
`Out[11]=`	`True`

we get

`In[12]:=`	`WikiGetPageText["Sandbox"]`
`Out[12]=`	`A robotic edit, at 19:39, 31-August-2005.`

The function WikiSetPageTexts is most useful for batch uploads, as it does considerably more error checking, and filters out edits which won't change the page text. It takes as argument a list of {"title", "text"} pairs, and returns a list of those pairs which failed.

`In[13]:=`	`WikiSetPageTexts[{{"Sandbox", "A robotic edit, by --~~"<>"~~"}, {"Sandbox2", "The determinant of the knot [[3_1]] is 3."}}]`
`Out[13]=`	`{}`

`In[14]:=`	`WikiGetPageText["Sandbox2"]`
`Out[14]=`	`The determinant of the knot [[3_1]] is 3.`

String manipulation functions

WikiLink` provides functions WikiPageMatchQ, WikiPageFreeQ, WikiStringReplace and WikiStringCases. Each function works likes its usual Mathematica partner, StringMatchQ, StringFreeQ, StringReplace or StringCases. Instead of providing a string, or list of strings, as the first argument, you should give the name of a page, or a list of names.

You can use these to perform all sorts of editing tricks.

`In[15]:=`	`WikiPageMatchQ[{"Sandbox", "Sandbox2"}, "determinant"]`
`Out[15]=`	`{False, False}`

`In[16]:=`	`WikiPageFreeQ[{"Sandbox", "Sandbox2"}, "[["~~(DigitCharacter..)~~"_"~~(DigitCharacter..)~~"]]"]`
`Out[16]=`	`{True, False}`

`In[17]:=`	`WikiStringCases[{"Sandbox", "Sandbox2"}, "[["~~ShortestMatch[__]~~"]]"]`
`Out[17]=`	`{{Sandbox, {[[User:ScottManualRobot\|ScottManualRobot]]}}, {Sandbox2, {[[3_1]]}}}`

`In[18]:=`	WikiStringReplace[{"Sandbox", "Sandbox2"}, "robotic edit"->"robotic edit (using WikiLink`)]
`Out[18]=`	`$Failed`

`In[19]:=`	`WikiGetPageTexts[{"Sandbox", "Sandbox2"}]`
`Out[19]=`	`{{Sandbox, A robotic edit, by\ --[[User:ScottManualRobot\|ScottManualRobot]] 14:54, 18 Feb 2006\ (EST)}, {Sandbox2, The determinant of the knot [[3_1]] is 3.}}`

Todo

I'd love to create an Ant task which allows uploading a file to a wiki. We could then use this in build scripts for KnotTheory, etc. --Scott 04:07, 17 Sep 2005 (EDT)

WikiLink - The Mediawiki Interface

Contents

Download

Usage

String manipulation functions

Todo

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools