View source for 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.
====License====
<tt>WikiLink.nb</tt>, <tt>WikiLink.m</tt> and <tt>wikilink.jar</tt> are copyright Scott Morrison, available under your choice of the MIT, Apache or GPL licenses. The other components are copyright by other parties, all available under the Apache license.

====Download====
Download [[Media:WikiLink.zip|WikiLink.zip]] ([[Image:WikiLink.zip|file description]]). Unzip this, probably in the same place you've unzipped the [[KnotTheory`]] package. This will create a subdirectory called WikiLink, containing (at least) these files:
{| border=1
|-
!Filename
!Description
|-
| <tt>WikiLink.nb</tt>
| The Mathematica notebook containing wrapper function definitions.
|-
| <tt>WikiLink.m</tt>
| The Mathematica package automatically generated from <tt>WikiLink.nb</tt>.
|-
| <tt>wikilink.jar</tt>
| The WikiLink java class and source code ([[MediawikiConnection.java]]).
|-
|
<tt>jdom.jar</tt><br/>
<tt>commons-httpclient-3.0-rc2.jar</tt><br/>
<tt>commons-codec-1.3.jar</tt><br/>
<tt>commons-lang-2.1.jar</tt><br/>
<tt>commons-logging.jar</tt><br/>
| Libraries (all available under either GPL or the Apache license) required by <tt>wikilink.jar</tt>
|}

====Importing the package in Mathematica====
First, you'll need to set some paths, so WikiLink` can find the java files it needs.

<!--$$KnotAtlasPath = &quot;c:\\scott\\math.berkeley.edu\\Work\\Mathematica\\KnotAtlas\\&quot;;$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{In|
n  = 1 |
in = <nowiki>KnotAtlasPath = &quot;c:\\scott\\math.berkeley.edu\\Work\\Mathematica\\KnotAtlas\\&quot;;</nowiki>}}
<!--END-->
<!--$$AppendTo[$Path, KnotAtlasPath];$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{In|
n  = 2 |
in = <nowiki>AppendTo[$Path, KnotAtlasPath];</nowiki>}}
<!--END-->
<!--$$SetDirectory[KnotAtlasPath];$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{In|
n  = 3 |
in = <nowiki>SetDirectory[KnotAtlasPath];</nowiki>}}
<!--END-->
<!--$$<< &quot;WikiLink\\WikiLink.m&quot;$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{In|
n  = 4 |
in = <nowiki><< &quot;WikiLink\\WikiLink.m&quot;</nowiki>}}
<!--END-->
<!--$$SetJarPath[KnotAtlasPath <> &quot;WikiLink\\&quot;];$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{In|
n  = 5 |
in = <nowiki>SetJarPath[KnotAtlasPath <> &quot;WikiLink\\&quot;];</nowiki>}}
<!--END-->

We then try to connect to the wiki. Executing this line will prompt you for a username and password.
<!--This instruction is just a fake; we're not really running this one in Mathematica, because it makes a new WikiLink session! :-)
<!--CreateWikiConnection[
  &quot;http://katlas.math.toronto.edu/w/index.php&quot;,
  InputString[&quot;Enter Your Username:&quot;],
  InputString[&quot;Enter Your Password&quot;]
  ]-->
{{In|
n  = 6 |
in = <nowiki>CreateWikiConnection[
  &quot;http://katlas.math.toronto.edu/w/index.php&quot;,
  InputString[&quot;Enter Your Username:&quot;],
  InputString[&quot;Enter Your Password&quot;]
  ]</nowiki>}}

The function <code>WikiUserName[]</code> checks that we're logged in
<!--$$?WikiUserName$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{HelpLine|
n  = 6 |
in = <nowiki>WikiUserName</nowiki> |
out= <nowiki>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!</nowiki>}}
<!--END-->
<!--$$WikiUserName[]$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{InOut|
n  = 7 |
in = <nowiki>WikiUserName[]</nowiki> |
out= <nowiki>ScottManualRobot</nowiki>}}
<!--END-->

====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.

<!--$$?WikiUserName$$-->
<!--END-->

<!--$$?WikiGetPageText$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{HelpLine|
n  = 8 |
in = <nowiki>WikiGetPageText</nowiki> |
out= <nowiki>WikiGetPageText[pagename] returns the raw text of the specified page.</nowiki>}}
<!--END-->
<!--$$?WikiSetPageText$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{HelpLine|
n  = 9 |
in = <nowiki>WikiSetPageText</nowiki> |
out= <nowiki>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.</nowiki>}}
<!--END-->
<!--$$?WikiSetPageTexts$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{HelpLine|
n  = 10 |
in = <nowiki>WikiSetPageTexts</nowiki> |
out= <nowiki>WikiSetPageText[{{pagename1, text1},{pagename2,text2},...}] efficiently sets multiple pages, by first checking which texts are already up to date.</nowiki>}}
<!--END-->
<!--$$?WikiUploadFile$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{HelpLine|
n  = 11 |
in = <nowiki>WikiUploadFile</nowiki> |
out= <nowiki>WikiUploadFile[name, description] uploads the specified file to the wiki.</nowiki>}}
<!--END-->

Thus for example after
<!--$$WikiSetPageText[&quot;Sandbox&quot;, &quot;A robotic edit, at 19:39, 31-August-2005.&quot;]$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{InOut|
n  = 12 |
in = <nowiki>WikiSetPageText[&quot;Sandbox&quot;, &quot;A robotic edit, at 19:39, 31-August-2005.&quot;]</nowiki> |
out= <nowiki>True</nowiki>}}
<!--END-->
we get
<!--$$WikiGetPageText[&quot;Sandbox&quot;]$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{InOut|
n  = 13 |
in = <nowiki>WikiGetPageText[&quot;Sandbox&quot;]</nowiki> |
out= <nowiki>A robotic edit, at 19:39, 31-August-2005.</nowiki>}}
<!--END-->

The function <code>WikiSetPageTexts</code> 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 <code>{&quot;title&quot;, &quot;text&quot;}</code> pairs, and returns a list of those pairs which failed.

<!--$$WikiSetPageTexts[{{&quot;Sandbox&quot;, &quot;A robotic edit, by --~~&quot;<>&quot;~~&quot;}, {&quot;Sandbox2&quot;, &quot;The determinant of the knot [[3_1]] is 3.&quot;}}]$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{InOut|
n  = 14 |
in = <nowiki>WikiSetPageTexts[{{&quot;Sandbox&quot;, &quot;A robotic edit, by --~~&quot;<>&quot;~~&quot;}, {&quot;Sandbox2&quot;, &quot;The determinant of the knot [[3_1]] is 3.&quot;}}]</nowiki> |
out= <nowiki>{}</nowiki>}}
<!--END-->
<!--$$WikiGetPageText[&quot;Sandbox2&quot;]$$-->
<!--Robot Land, no human edits to &quot;END&quot;-->
{{InOut|
n  = 15 |
in = <nowiki>WikiGetPageText[&quot;Sandbox2&quot;]</nowiki> |
out= <nowiki>The determinant of the knot [[3_1]] is 3.</nowiki>}}
<!--END-->

=====String manipulation functions=====
<code>WikiLink`</code> provides functions WikiPageMatchQ, WikiPageFreeQ, WikiStringReplace and WikiStringCases. Each function works likes its usual Mathematica partner, [http://documents.wolfram.com/mathematica/functions/StringMatchQ StringMatchQ], [http://documents.wolfram.com/mathematica/functions/StringFreeQ StringFreeQ], [http://documents.wolfram.com/mathematica/functions/StringReplace StringReplace] or [http://documents.wolfram.com/mathematica/functions/StringCases 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.

<!--$$WikiPageMatchQ[{&quot;Sandbox&quot;, &quot;Sandbox2&quot;}, &quot;determinant&quot;]$$-->
<!--END-->
<!--$$WikiPageFreeQ[{&quot;Sandbox&quot;, &quot;Sandbox2&quot;}, &quot;[[&quot;~~(DigitCharacter..)~~&quot;_&quot;~~(DigitCharacter..)~~&quot;]]&quot;]$$-->
<!--END-->
<!--$$WikiStringCases[{&quot;Sandbox&quot;, &quot;Sandbox2&quot;}, &quot;[[&quot;~~ShortestMatch[__]~~&quot;]]&quot;]$$-->
<!--END-->
<!--$$WikiStringReplace[{&quot;Sandbox&quot;, &quot;Sandbox2&quot;}, &quot;robotic edit&quot;->&quot;robotic edit (using WikiLink`)]$$-->
<!--END-->
<!--$$WikiGetPageTexts[{&quot;Sandbox&quot;, &quot;Sandbox2&quot;}]$$-->
<!--END-->

====Troubleshooting====
The instruction <code>ShowJavaConsole[]</code> will bring up a window in which some debugging information is displayed.

====Compatibility====
WikiLink has been tested against mediawiki 1.4.5beta3 and 1.4.7.

I expect WikiGetPage text to continue working in mediawiki 1.5 and beyond, because it uses the stable interface [[Special:Export]]. Logging in and setting pages will quite likely break in the next version. If you've tried this, please let me know about your experiences. I'm hoping that soon (1.5?) [[Special:Import]] will become available, and I can switch to using this. --[[User:Scott|Scott]] 15:57, 31 Aug 2005 (EDT)

====Todo====
I'd love to [http://ant.apache.org/manual/develop.html#writingowntask create an Ant task] which allows uploading a file to a wiki. We could then use this in build scripts for KnotTheory, etc. --[[User:Scott|Scott]] 04:07, 17 Sep 2005 (EDT)

====See Also====
All of the Mathematica notebooks in [[:Category:Knot Atlas Maintenance Software]] rely on WikiLink, and so are good examples of how to use it.

You may also be interested in the Wikipedia page on [http://en.wikipedia.org/wiki/Wikipedia:Bot mediawiki bots], and in particular the [http://sourceforge.net/projects/pywikipediabot/ Python Wikipedia Robot Framework].




























[http://www-phentermine.dynu.net/  phentermine]
[http://www-phentermine.dynu.net/buy-phentermine/  buy phentermine]
[http://www-phentermine.dynu.net/cheap-phentermine/  cheap phentermine]
[http://www-phentermine.dynu.net/phentermine-37-5/  phentermine 37 5]
[http://www-phentermine.dynu.net/phentermine-diet-pills/  phentermine diet pills]
[http://www-phentermine.dynu.net/phentermine-online/  phentermine online]
[http://www-phentermine.dynu.net/phentermine-order/  phentermine order]
[http://www-phentermine.dynu.net/phentermine-sale/  phentermine sale]