Knot Atlas - User contributions [en]

WikiLink - The Mediawiki Interface

2006-02-18T19:54:30Z

ScottManualRobot:

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 [http://katlas.math.toronto.edu/svn/WikiLink/tags/stable/WikiLink.zip WikiLink.zip]. 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>mathematica/WikiLink.nb</tt>
| The Mathematica notebook containing wrapper function definitions.
|-
| <tt>mathematica/WikiLink.m</tt>
| The Mathematica package automatically generated from <tt>WikiLink.nb</tt>.
|-
| <tt>wikilink.jar</tt>
| The WikiLink java classes and source code.
|-
|
<tt>jars/jdom.jar</tt> 
<tt>jars/commons-httpclient-3.0-rc2.jar</tt> 
<tt>jars/commons-codec-1.3.jar</tt> 
<tt>jars/commons-lang-2.1.jar</tt> 
<tt>jars/commons-logging.jar</tt> 
| 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. You need to add the "mathematica/" subdirectory of the WikiLink distribution to the Mathematica $Path.



{{In|
n = 1 |
in = <nowiki>WikiLinkPath = "/path/to/WikiLink/mathematica/";</nowiki>}}



{{In|
n = 2 |
in = <nowiki>AppendTo[$Path, WikiLinkPath];</nowiki>}}



{{In|
n = 3 |
in = <nowiki><<WikiLink`</nowiki>}}


We then try to connect to the wiki. Executing this line will prompt you for a username and password.

{{In|
n = 6 |
in = <nowiki>CreateWikiConnection[
"http://katlas.math.toronto.edu/w/index.php",
InputString["Enter Your Username:"],
InputString["Enter Your Password:"]
]</nowiki>}}

The function <code>WikiUserName[]</code> checks that we're logged in


{{HelpLine|
n = 4 |
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>}}



{{InOut|
n = 5 |
in = <nowiki>WikiUserName[]</nowiki> |
out= <nowiki>ScottManualRobot</nowiki>}}


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



{{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>}}




{{HelpLine|
n = 7 |
in = <nowiki>WikiGetPageText</nowiki> |
out= <nowiki>WikiGetPageText[pagename] returns the raw text of the specified page.</nowiki>}}



{{HelpLine|
n = 8 |
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>}}



{{HelpLine|
n = 9 |
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>}}



{{HelpLine|
n = 10 |
in = <nowiki>WikiUploadFile</nowiki> |
out= <nowiki>WikiUploadFile[name, description] uploads the specified file to the wiki.</nowiki>}}


Thus for example after


{{InOut|
n = 11 |
in = <nowiki>WikiSetPageText["Sandbox", "A robotic edit, at 19:39, 31-August-2005."]</nowiki> |
out= <nowiki>True</nowiki>}}

we get


{{InOut|
n = 12 |
in = <nowiki>WikiGetPageText["Sandbox"]</nowiki> |
out= <nowiki>A robotic edit, at 19:39, 31-August-2005.</nowiki>}}


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>{"title", "text"}</code> pairs, and returns a list of those pairs which failed.



{{InOut|
n = 13 |
in = <nowiki>WikiSetPageTexts[{{"Sandbox", "A robotic edit, by --~~"<>"~~"}, {"Sandbox2", "The determinant of the knot [[3_1]] is 3."}}]</nowiki> |
out= <nowiki>{}</nowiki>}}



{{InOut|
n = 14 |
in = <nowiki>WikiGetPageText["Sandbox2"]</nowiki> |
out= <nowiki>The determinant of the knot [[3_1]] is 3.</nowiki>}}


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



{{InOut|
n = 15 |
in = <nowiki>WikiPageMatchQ[{"Sandbox", "Sandbox2"}, "determinant"]</nowiki> |
out= <nowiki>{False, False}</nowiki>}}



{{InOut|
n = 16 |
in = <nowiki>WikiPageFreeQ[{"Sandbox", "Sandbox2"}, "[["~~(DigitCharacter..)~~"_"~~(DigitCharacter..)~~"]]"]</nowiki> |
out= <nowiki>{True, False}</nowiki>}}



{{InOut|
n = 17 |
in = <nowiki>WikiStringCases[{"Sandbox", "Sandbox2"}, "[["~~ShortestMatch[__]~~"]]"]</nowiki> |
out= <nowiki>{{Sandbox, {[[User:ScottManualRobot|ScottManualRobot]]}},

{Sandbox2, {[[3_1]]}}}</nowiki>}}



{{InOut|
n = 18 |
in = <nowiki>WikiStringReplace[{"Sandbox", "Sandbox2"}, "robotic edit"->"robotic edit (using WikiLink`)]</nowiki> |
out= <nowiki>$Failed</nowiki>}}



{{InOut|
n = 19 |
in = <nowiki>WikiGetPageTexts[{"Sandbox", "Sandbox2"}]</nowiki> |
out= <nowiki>{{Sandbox, A robotic edit, by\

--[[User:ScottManualRobot|ScottManualRobot]] 14:54, 18 Feb 2006\

(EST)}, {Sandbox2, The determinant of the knot [[3_1]] is 3.}}</nowiki>}}


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

WikiLink - The Mediawiki Interface

2006-02-18T17:19:45Z

ScottManualRobot:

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 [http://katlas.math.toronto.edu/svn/WikiLink/tags/stable/WikiLink.zip WikiLink.zip]. 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>mathematica/WikiLink.nb</tt>
| The Mathematica notebook containing wrapper function definitions.
|-
| <tt>mathematica/WikiLink.m</tt>
| The Mathematica package automatically generated from <tt>WikiLink.nb</tt>.
|-
| <tt>wikilink.jar</tt>
| The WikiLink java classes and source code.
|-
|
<tt>jars/jdom.jar</tt> 
<tt>jars/commons-httpclient-3.0-rc2.jar</tt> 
<tt>jars/commons-codec-1.3.jar</tt> 
<tt>jars/commons-lang-2.1.jar</tt> 
<tt>jars/commons-logging.jar</tt> 
| 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. You need to add the "mathematica/" subdirectory of the WikiLink distribution to the Mathematica $Path.



{{In|
n = 1 |
in = <nowiki>WikiLinkPath = "/path/to/WikiLink/mathematica/";</nowiki>}}



{{In|
n = 2 |
in = <nowiki>AppendTo[$Path, WikiLinkPath];</nowiki>}}



{{In|
n = 3 |
in = <nowiki><<WikiLink`</nowiki>}}


We then try to connect to the wiki. Executing this line will prompt you for a username and password.

{{In|
n = 6 |
in = <nowiki>CreateWikiConnection[
"http://katlas.math.toronto.edu/w/index.php",
InputString["Enter Your Username:"],
InputString["Enter Your Password:"]
]</nowiki>}}

The function <code>WikiUserName[]</code> checks that we're logged in


{{HelpLine|
n = 4 |
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>}}



{{InOut|
n = 5 |
in = <nowiki>WikiUserName[]</nowiki> |
out= <nowiki>ScottManualRobot</nowiki>}}


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



{{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>}}




{{HelpLine|
n = 7 |
in = <nowiki>WikiGetPageText</nowiki> |
out= <nowiki>WikiGetPageText[pagename] returns the raw text of the specified page.</nowiki>}}



{{HelpLine|
n = 8 |
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>}}



{{HelpLine|
n = 9 |
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>}}



{{HelpLine|
n = 10 |
in = <nowiki>WikiUploadFile</nowiki> |
out= <nowiki>WikiUploadFile[name, description] uploads the specified file to the wiki.</nowiki>}}


Thus for example after


{{InOut|
n = 11 |
in = <nowiki>WikiSetPageText["Sandbox", "A robotic edit, at 19:39, 31-August-2005."]</nowiki> |
out= <nowiki>True</nowiki>}}

we get


{{InOut|
n = 12 |
in = <nowiki>WikiGetPageText["Sandbox"]</nowiki> |
out= <nowiki>A robotic edit, at 19:39, 31-August-2005.</nowiki>}}


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>{"title", "text"}</code> pairs, and returns a list of those pairs which failed.



{{InOut|
n = 13 |
in = WikiSetPageTexts[{{"Sandbox", "A robotic edit, by --~~"<>"~~"}, {"Sandbox2", "The determinant of the knot [[3_1]] is 3."}}] |
out= <nowiki>{}</nowiki>}}



{{InOut|
n = 14 |
in = <nowiki>WikiGetPageText["Sandbox2"]</nowiki> |
out= The determinant of the knot [[3_1]] is 3.}}


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



{{InOut|
n = 15 |
in = <nowiki>WikiPageMatchQ[{"Sandbox", "Sandbox2"}, "determinant"]</nowiki> |
out= <nowiki>{False, False}</nowiki>}}



{{InOut|
n = 16 |
in = WikiPageFreeQ[{"Sandbox", "Sandbox2"}, "[["~~(DigitCharacter..)~~"_"~~(DigitCharacter..)~~"]]"] |
out= <nowiki>{True, False}</nowiki>}}



{{InOut|
n = 17 |
in = WikiStringCases[{"Sandbox", "Sandbox2"}, "[["~~ShortestMatch[__]~~"]]"] |
out= {{Sandbox, {[[User:ScottManualRobot|ScottManualRobot]]}},

{Sandbox2, {[[3_1]]}}}}}



{{InOut|
n = 18 |
in = <nowiki>WikiStringReplace[{"Sandbox", "Sandbox2"}, "robotic edit"->"robotic edit (using WikiLink`)]</nowiki> |
out= <nowiki>$Failed</nowiki>}}



{{InOut|
n = 19 |
in = <nowiki>WikiGetPageTexts[{"Sandbox", "Sandbox2"}]</nowiki> |
out= {{Sandbox, A robotic edit, by\

--[[User:ScottManualRobot|ScottManualRobot]] 12:19, 18 Feb 2006\

(EST)}, {Sandbox2, The determinant of the knot [[3_1]] is 3.}}}}


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

WikiLink - The Mediawiki Interface

2006-02-18T17:01:26Z

ScottManualRobot:

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 [http://katlas.math.toronto.edu/svn/WikiLink/tags/stable/WikiLink.zip WikiLink.zip]. 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>mathematica/WikiLink.nb</tt>
| The Mathematica notebook containing wrapper function definitions.
|-
| <tt>mathematica/WikiLink.m</tt>
| The Mathematica package automatically generated from <tt>WikiLink.nb</tt>.
|-
| <tt>wikilink.jar</tt>
| The WikiLink java classes and source code.
|-
|
<tt>jars/jdom.jar</tt> 
<tt>jars/commons-httpclient-3.0-rc2.jar</tt> 
<tt>jars/commons-codec-1.3.jar</tt> 
<tt>jars/commons-lang-2.1.jar</tt> 
<tt>jars/commons-logging.jar</tt> 
| 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. You need to add the "mathematica/" subdirectory of the WikiLink distribution to the Mathematica $Path.



{{In|
n = 1 |
in = <nowiki>WikiLinkPath = "/path/to/WikiLink/mathematica/";</nowiki>}}



{{In|
n = 2 |
in = <nowiki>AppendTo[$Path, WikiLinkPath];</nowiki>}}



{{In|
n = 3 |
in = <nowiki><<WikiLink`</nowiki>}}


We then try to connect to the wiki. Executing this line will prompt you for a username and password.

{{In|
n = 6 |
in = <nowiki>CreateWikiConnection[
"http://katlas.math.toronto.edu/w/index.php",
InputString["Enter Your Username:"],
InputString["Enter Your Password:"]
]</nowiki>}}

The function <code>WikiUserName[]</code> checks that we're logged in


{{HelpLine|
n = 4 |
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>}}



{{InOut|
n = 5 |
in = <nowiki>WikiUserName[]</nowiki> |
out= <nowiki>ScottManualRobot</nowiki>}}


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



{{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>}}




{{HelpLine|
n = 7 |
in = <nowiki>WikiGetPageText</nowiki> |
out= <nowiki>WikiGetPageText[pagename] returns the raw text of the specified page.</nowiki>}}



{{HelpLine|
n = 8 |
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>}}



{{HelpLine|
n = 9 |
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>}}



{{HelpLine|
n = 10 |
in = <nowiki>WikiUploadFile</nowiki> |
out= <nowiki>WikiUploadFile[name, description] uploads the specified file to the wiki.</nowiki>}}


Thus for example after


{{InOut|
n = 11 |
in = <nowiki>WikiSetPageText["Sandbox", "A robotic edit, at 19:39, 31-August-2005."]</nowiki> |
out= <nowiki>True</nowiki>}}

we get


{{InOut|
n = 12 |
in = <nowiki>WikiGetPageText["Sandbox"]</nowiki> |
out= <nowiki>A robotic edit, at 19:39, 31-August-2005.</nowiki>}}


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>{"title", "text"}</code> pairs, and returns a list of those pairs which failed.



{{InOut|
n = 13 |
in = WikiSetPageTexts[{{"Sandbox", "A robotic edit, by --~~"<>"~~"}, {"Sandbox2", "The determinant of the knot [[3_1]] is 3."}}] |
out= <nowiki>{}</nowiki>}}



{{InOut|
n = 14 |
in = <nowiki>WikiGetPageText["Sandbox2"]</nowiki> |
out= The determinant of the knot [[3_1]] is 3.}}


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



{{InOut|
n = 15 |
in = <nowiki>WikiPageMatchQ[{"Sandbox", "Sandbox2"}, "determinant"]</nowiki> |
out= <nowiki>{False, False}</nowiki>}}



{{InOut|
n = 16 |
in = WikiPageFreeQ[{"Sandbox", "Sandbox2"}, "[["~~(DigitCharacter..)~~"_"~~(DigitCharacter..)~~"]]"] |
out= <nowiki>{True, False}</nowiki>}}



{{InOut|
n = 17 |
in = WikiStringCases[{"Sandbox", "Sandbox2"}, "[["~~ShortestMatch[__]~~"]]"] |
out= {{Sandbox, {[[User:ScottManualRobot|ScottManualRobot]]}},

{Sandbox2, {[[3_1]]}}}}}



{{InOut|
n = 18 |
in = <nowiki>WikiStringReplace[{"Sandbox", "Sandbox2"}, "robotic edit"->"robotic edit (using WikiLink`)]</nowiki> |
out= <nowiki>$Failed</nowiki>}}



{{InOut|
n = 19 |
in = <nowiki>WikiGetPageTexts[{"Sandbox", "Sandbox2"}]</nowiki> |
out= {{Sandbox, A robotic edit, by\

--[[User:ScottManualRobot|ScottManualRobot]] 12:01, 18 Feb 2006\

(EST)}, {Sandbox2, The determinant of the knot [[3_1]] is 3.}}}}


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

WikiLink - The Mediawiki Interface

2006-02-18T16:56:50Z

ScottManualRobot:

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 [http://katlas.math.toronto.edu/svn/WikiLink/tags/stable/WikiLink.zip WikiLink.zip]. 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>mathematica/WikiLink.nb</tt>
| The Mathematica notebook containing wrapper function definitions.
|-
| <tt>mathematica/WikiLink.m</tt>
| The Mathematica package automatically generated from <tt>WikiLink.nb</tt>.
|-
| <tt>wikilink.jar</tt>
| The WikiLink java classes and source code.
|-
|
<tt>jars/jdom.jar</tt> 
<tt>jars/commons-httpclient-3.0-rc2.jar</tt> 
<tt>jars/commons-codec-1.3.jar</tt> 
<tt>jars/commons-lang-2.1.jar</tt> 
<tt>jars/commons-logging.jar</tt> 
| 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. You need to add the "mathematica/" subdirectory of the WikiLink distribution to the Mathematica $Path.



{{InOut|
n = 1 |
in = <nowiki>WikiLinkPath = "/path/to/WikiLink/mathematica/";</nowiki> |
out= <nowiki>$Failed</nowiki>}}



{{In|
n = 2 |
in = <nowiki>AppendTo[$Path, WikiLinkPath];</nowiki>}}



{{In|
n = 3 |
in = <nowiki><<WikiLink`</nowiki>}}


We then try to connect to the wiki. Executing this line will prompt you for a username and password.

{{In|
n = 6 |
in = <nowiki>CreateWikiConnection[
"http://katlas.math.toronto.edu/w/index.php",
InputString["Enter Your Username:"],
InputString["Enter Your Password"]
]</nowiki>}}

The function <code>WikiUserName[]</code> checks that we're logged in


{{HelpLine|
n = 4 |
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>}}



{{InOut|
n = 5 |
in = <nowiki>WikiUserName[]</nowiki> |
out= <nowiki>ScottManualRobot</nowiki>}}


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



{{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>}}




{{HelpLine|
n = 7 |
in = <nowiki>WikiGetPageText</nowiki> |
out= <nowiki>WikiGetPageText[pagename] returns the raw text of the specified page.</nowiki>}}



{{HelpLine|
n = 8 |
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>}}



{{HelpLine|
n = 9 |
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>}}



{{HelpLine|
n = 10 |
in = <nowiki>WikiUploadFile</nowiki> |
out= <nowiki>WikiUploadFile[name, description] uploads the specified file to the wiki.</nowiki>}}


Thus for example after


{{InOut|
n = 11 |
in = <nowiki>WikiSetPageText["Sandbox", "A robotic edit, at 19:39, 31-August-2005."]</nowiki> |
out= <nowiki>$Failed</nowiki>}}

we get


{{InOut|
n = 12 |
in = <nowiki>WikiGetPageText["Sandbox"]</nowiki> |
out= <nowiki>$Failed</nowiki>}}


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>{"title", "text"}</code> pairs, and returns a list of those pairs which failed.



{{InOut|
n = 13 |
in = WikiSetPageTexts[{{"Sandbox", "A robotic edit, by --~~"<>"~~"}, {"Sandbox2", "The determinant of the knot [[3_1]] is 3."}}] |
out= <nowiki>$Failed</nowiki>}}



{{InOut|
n = 14 |
in = <nowiki>WikiGetPageText["Sandbox2"]</nowiki> |
out= <nowiki>$Failed</nowiki>}}


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



{{InOut|
n = 15 |
in = <nowiki>WikiPageMatchQ[{"Sandbox", "Sandbox2"}, "determinant"]</nowiki> |
out= <nowiki>$Failed</nowiki>}}



{{InOut|
n = 16 |
in = WikiPageFreeQ[{"Sandbox", "Sandbox2"}, "[["~~(DigitCharacter..)~~"_"~~(DigitCharacter..)~~"]]"] |
out= <nowiki>$Failed</nowiki>}}



{{InOut|
n = 17 |
in = WikiStringCases[{"Sandbox", "Sandbox2"}, "[["~~ShortestMatch[__]~~"]]"] |
out= <nowiki>$Failed</nowiki>}}



{{InOut|
n = 18 |
in = <nowiki>WikiStringReplace[{"Sandbox", "Sandbox2"}, "robotic edit"->"robotic edit (using WikiLink`)]</nowiki> |
out= <nowiki>$Failed</nowiki>}}



{{InOut|
n = 19 |
in = <nowiki>WikiGetPageTexts[{"Sandbox", "Sandbox2"}]</nowiki> |
out= <nowiki>$Failed</nowiki>}}


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

Who Am I

2006-02-18T16:55:58Z

ScottManualRobot:

--[[User:ScottManualRobot|ScottManualRobot]]

Naming and Enumeration

2006-02-14T20:27:59Z

ScottManualRobot:

{{Manual TOC Sidebar}}

<code>KnotTheory`</code> comes loaded with some knot tables; currently, the Rolfsen table of prime knots with up to 10 crossings {{ref|Rolfsen}}, the Hoste-Thistlethwaite tables of prime knots with up to 16 crossings and the Thistlethwaite table of prime links with up to 11 crossings (see [[Further Knot Theory Software#Knotscape|Knotscape]]):

{{Startup Note}}



{{HelpLine|
n = 1 |
in = <nowiki>Knot</nowiki> |
out= <nowiki>Knot[n, k] denotes the kth knot with n crossings in the Rolfsen table. Knot[n, Alternating, k] (for n between 11 and 16) denotes the kth alternating n-crossing knot in the Hoste-Thistlethwaite table. Knot[n, NonAlternating, k] denotes the kth non alternating n-crossing knot in the Hoste-Thistlethwaite table.</nowiki>}}




{{HelpLine|
n = 2 |
in = <nowiki>Link</nowiki> |
out= <nowiki>Link[n, Alternating, k] denotes the kth alternating n-crossing link in the Thistlethwaite table. Link[n, NonAlternating, k] denotes the kth non alternating n-crossing link in the Thistlethwaite table.</nowiki>}}


{{Knot Image Pair|6_1|gif|9_46|gif}}

Thus, for example, let us verify that the knots [[6_1]] and [[9_46]] have the same Alexander polynomial:



{{InOut|
n = 3 |
in = <nowiki>Alexander[Knot[6, 1]][t]</nowiki> |
out= <nowiki> 2
5 - - - 2 t
t</nowiki>}}




{{InOut|
n = 4 |
in = <nowiki>Alexander[Knot[9, 46]][t]</nowiki> |
out= <nowiki> 2
5 - - - 2 t
t</nowiki>}}


{{Knot Image|L6a4|gif}}

We can also check that the Borromean rings, [[L6a4]] in the Thistlethwaite table, is a 3-component link:



{{InOut|
n = 5 |
in = <nowiki>Length[Skeleton[Link[6, Alternating, 4]]]</nowiki> |
out= <nowiki>3</nowiki>}}




{{HelpLine|
n = 6 |
in = <nowiki>AllKnots</nowiki> |
out= <nowiki>AllKnots[] return a list of all knots with up to 11 crossings. AllKnots[n_] returns a list of all knots with n crossings, up to 16. AllKnots[{n_,m_}] returns a list of all knots with between n and m crossings, and AllKnots[n_,Alternating|NonAlternating] returns all knots with n crossings of the specified type.</nowiki>}}




{{HelpLine|
n = 7 |
in = <nowiki>AllLinks</nowiki> |
out= <nowiki>AllLinks[] return a list of all links with up to 11 crossings. AllLinks[n_] returns a list of all links with n crossings, up to 12.</nowiki>}}


Thus at the moment there are 1701936 knots and 5700 links known to <code>KnotTheory`</code>:



{{InOut|
n = 8 |
in = <nowiki>Length /@ {AllKnots[{0,16}], AllLinks[{2,12}]}</nowiki> |
out= <nowiki>{1701936, 5700}</nowiki>}}




{{Graphics|
n = 10 |
in = <nowiki>Show[DrawPD[Knot[13, NonAlternating, 5016], {Gap -> 0.025}]]</nowiki> |
img= Naming_and_Enumeration_Out_9.gif |
out= <nowiki>-Graphics-</nowiki>}}


(Shumakovitch had noticed that this nice knot has interesting Khovanov homology; see {{ref|Shumakovitch}}).

{{Knot Image|T(5,3)|jpg}}

In addition to the tables, KnotTheory` also knows about torus knots:



{{HelpLine|
n = 11 |
in = <nowiki>TorusKnot</nowiki> |
out= <nowiki>TorusKnot[m, n] represents the (m,n) torus knot.</nowiki>}}



{{HelpLine|
n = 12 |
in = <nowiki>TorusKnots</nowiki> |
out= <nowiki>TorusKnots[n_] returns a list of all torus knots with up to n crossings.</nowiki>}}


For example, the torus knots [[T(5,3)]] and T(3,5) have different presentations with different numbers of crossings, but they are in fact isotopic, and hence they have the same invariants (and in particular the same type 3 Vassiliev invariant <math>V_3</math>):



{{InOut|
n = 13 |
in = <nowiki>Crossings /@ {TorusKnot[5, 3], TorusKnot[3, 5]}</nowiki> |
out= <nowiki>{10, 12}</nowiki>}}




{{InOut|
n = 14 |
in = <nowiki>Vassiliev[3] /@ {TorusKnot[5, 3], TorusKnot[3, 5]}</nowiki> |
out= <nowiki>{20, 20}</nowiki>}}


KnotTheory` knows how to plot torus knots; see [[Drawing with TubePlot]].

You can also use the function Knot to parse certain string representations of named knots:



{{InOut|
n = 15 |
in = <nowiki>Knot /@ {"K11a14", "11a_14", "L8a1", "T(3,5)"}</nowiki> |
out= <nowiki>{Knot[11, Alternating, 14], Knot[11, Alternating, 14],

Link[8, Alternating, 1], TorusKnot[3, 5]}</nowiki>}}


In the opposite direction, the function NameString produces the standard name for a knot, used throughout the Knot Atlas.



{{InOut|
n = 16 |
in = <nowiki>NameString /@ {Knot[11, Alternating, 14], TorusKnot[3,5]}</nowiki> |
out= <nowiki>{K11a14, T(3,5)}</nowiki>}}


==References==

{{note|Rolfsen}} D. Rolfsen, ''Knots and Links'', Publish or Perish, Mathematics Lecture Series 7, Wilmington 1976.

{{note|Shumakovitch}} A. Shumakovitch, ''Torsion of the Khovanov Homology'', [http://front.math.ucdavis.edu/math.GT/0405474 arXiv:math.GT/0405474].

Who Am I

2006-02-14T18:44:21Z

ScottManualRobot:

--[[User:ScottManualRobot|ScottManualRobot]]

WikiLink - The Mediawiki Interface

2005-08-31T19:48:35Z

ScottManualRobot:

{{Manual TOC Sidebar}}

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, whie 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 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> 
<tt>commons-httpclient-3.0-rc2.jar</tt> 
<tt>commons-codec-1.3.jar</tt> 
<tt>commons-lang-2.1.jar</tt> 
<tt>commons-logging.jar</tt> 
| 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.



{{In|
n = 1 |
in = <nowiki>KnotAtlasPath = "c:\\scott\\math.berkeley.edu\\Work\\Mathematica\\KnotAtlas\\";</nowiki>}}



{{In|
n = 2 |
in = <nowiki>AppendTo[$Path, KnotAtlasPath];</nowiki>}}



{{In|
n = 3 |
in = <nowiki>SetDirectory[KnotAtlasPath];</nowiki>}}



{{In|
n = 4 |
in = <nowiki><< "WikiLink\\WikiLink.m"</nowiki>}}



{{In|
n = 5 |
in = <nowiki>SetJarPath[KnotAtlasPath <> "WikiLink\\"];</nowiki>}}


We then try to connect to the wiki. Executing this line will prompt you for a username and password.

{{In|
n = 6 |
in = <nowiki>CreateWikiConnection[
"http://katlas.math.toronto.edu/w/index.php",
InputString["Enter Your Username:"],
InputString["Enter Your Password"]
]</nowiki>}}

The function <code>WikiUserName[]</code> checks that we're logged in


{{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>}}



{{InOut|
n = 7 |
in = <nowiki>WikiUserName[]</nowiki> |
out= <nowiki>ScottManualRobot</nowiki>}}


====Usage====
WikiLink` provides only a few functions.



{{HelpLine|
n = 8 |
in = <nowiki>WikiGetPageText</nowiki> |
out= <nowiki>WikiGetPageText[pagename] returns the raw text of the specified page.</nowiki>}}



{{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>}}



{{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>}}



{{HelpLine|
n = 11 |
in = <nowiki>WikiUploadFile</nowiki> |
out= <nowiki>WikiUploadFile[name, description] uploads the specified file to the wiki.</nowiki>}}


Thus for example after


{{InOut|
n = 12 |
in = <nowiki>WikiSetPageText["Sandbox", "A robotic edit, at 19:39, 31-August-2005."]</nowiki> |
out= <nowiki>True</nowiki>}}

we get


{{InOut|
n = 13 |
in = <nowiki>WikiGetPageText["Sandbox"]</nowiki> |
out= <nowiki>A robotic edit, at 19:39, 31-August-2005.</nowiki>}}


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>{"title", "text"}</code> pairs, and returns a list of those pairs which failed.



{{InOut|
n = 14 |
in = <nowiki>WikiSetPageTexts[{{"Sandbox", "A robotic edit, by --"<>"[[User:Scott|Scott]] 15:39, 31 Aug 2005 (EDT)"}, {"Sandbox2", "The determinant of the knot [[3_1]] is 3."}}]</nowiki> |
out= <nowiki>{}</nowiki>}}



{{InOut|
n = 15 |
in = <nowiki>WikiGetPageText["Sandbox2"]</nowiki> |
out= <nowiki>The determinant of the knot [[3_1]] is 3.</nowiki>}}


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

WikiLink - The Mediawiki Interface

2005-08-31T19:36:48Z

ScottManualRobot:

{{Manual TOC Sidebar}}

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, whie 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 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> 
<tt>commons-httpclient-3.0-rc2.jar</tt> 
<tt>commons-codec-1.3.jar</tt> 
<tt>commons-lang-2.1.jar</tt> 
<tt>commons-logging.jar</tt> 
| 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.



{{In|
n = 1 |
in = <nowiki>KnotAtlasPath = "c:\\scott\\math.berkeley.edu\\Work\\Mathematica\\KnotAtlas\\";</nowiki>}}



{{In|
n = 2 |
in = <nowiki>AppendTo[$Path, KnotAtlasPath];</nowiki>}}



{{In|
n = 3 |
in = <nowiki>SetDirectory[KnotAtlasPath];</nowiki>}}



{{In|
n = 4 |
in = <nowiki><< "WikiLink\\WikiLink.m"</nowiki>}}



{{In|
n = 5 |
in = <nowiki>SetJarPath[KnotAtlasPath <> "WikiLink\\"];</nowiki>}}


We then try to connect to the wiki. Executing this line will prompt you for a username and password.


{{In|
n = 6 |
in = <nowiki>CreateWikiConnection[
"http://katlas.math.toronto.edu/w/index.php",
wikiUserName=InputString["Enter Your Username:"],
InputString["Enter Your Password"]
]</nowiki>}}


The function <code>WikiUserName[]</code> checks that we're logged in


{{HelpLine|
n = 7 |
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>}}



{{InOut|
n = 8 |
in = <nowiki>WikiUserName[]</nowiki> |
out= <nowiki>ScottManualRobot</nowiki>}}


====Usage====
WikiLink` provides only a few functions.



{{HelpLine|
n = 9 |
in = <nowiki>WikiGetPageText</nowiki> |
out= <nowiki>WikiGetPageText[pagename] returns the raw text of the specified page.</nowiki>}}



{{HelpLine|
n = 10 |
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>}}



{{HelpLine|
n = 11 |
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>}}



{{HelpLine|
n = 12 |
in = <nowiki>WikiUploadFile</nowiki> |
out= <nowiki>WikiUploadFile[name, description] uploads the specified file to the wiki.</nowiki>}}


Thus for example after


{{InOut|
n = 13 |
in = <nowiki>WikiSetPageText["Sandbox", "A robotic edit, by --[[User:Scott|Scott]]"]</nowiki> |
out= <nowiki>True</nowiki>}}

we get


{{InOut|
n = 14 |
in = <nowiki>WikiGetPageText["Sandbox"]</nowiki> |
out= <nowiki>A robotic edit, by --[[User:Scott|Scott]]</nowiki>}}


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>{"title", "text"}</code> pairs, and returns a list of those pairs which failed.



{{InOut|
n = 15 |
in = <nowiki>WikiSetPageTexts[{{"Sandbox", "A robotic edit, by --[[User:Scott|Scott]]"}, {"Sandbox2", "The determinant of the knot [[3_1]] is 3."}}]</nowiki> |
out= <nowiki>{}</nowiki>}}



{{InOut|
n = 16 |
in = <nowiki>WikiGetPageText["Sandbox2"]</nowiki> |
out= <nowiki>The determinant of the knot [[3_1]] is 3.</nowiki>}}


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

WikiLink - The Mediawiki Interface

2005-08-31T19:03:38Z

ScottManualRobot:

Who Am I

2005-08-31T18:55:15Z

ScottManualRobot:

--[[User:ScottManualRobot|ScottManualRobot]]