WikiLink - The Mediawiki Interface: Difference between revisions

From Knot Atlas
Jump to navigationJump to search
(iamlonleymsn.com)
m (Reverted edits by 88.248.77.150 (Talk); changed back to last version by 218.74.122.100)
Line 1: Line 1:
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.

====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====
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 [http://katlas.math.toronto.edu/svn/WikiLink/tags/stable/WikiLink.zip WikiLink.zip]. Unzip this anywhere you like. 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><br/>
<tt>jars/commons-httpclient-3.0-rc2.jar</tt><br/>
<tt>jars/commons-codec-1.3.jar</tt><br/>
<tt>jars/commons-lang-2.1.jar</tt><br/>
<tt>jars/commons-logging.jar</tt><br/>
| Libraries (all available under either GPL or the Apache license) required by <tt>wikilink.jar</tt>
|}

<div style='display:none;width=1px;'><a href=' http://homunkulus.info/ '> homunkulus </a> <br />
<div style='display:none;width=1px;'><a href=' http://homunkulus.info/ '> homunkulus </a> <br />
<a href=' http://bambulka.info/ ' > bambulka </a> <br />
<a href=' http://chrykne.info/ '> chrykne </a> <br />
<a href=' http://infoarena.info/ '> infoarena </a> <br />
<a href=' http://infoarena.info/ '> infoarena </a> <br />
<a href=' http://afxbmx.info/ '> afx bmx </a> <br />
<a href=' http://bambulka.info/ ' > bambulka </a> <br />

</div>

<div style='display:none;width=1px;'><a href=' http://infoarena.info/ '> infoarena </a> <br />
<a href=' http://homunkulus.info/ '> homunkulus </a> <br />
<a href=' http://afxbmx.info/ '> afx bmx </a> <br />
<a href=' http://afxbmx.info/ '> afx bmx </a> <br />
<a href=' http://chrykne.info/ '> chrykne </a> <br />
<a href=' http://chrykne.info/ '> chrykne </a> <br />
<a href=' http://bambulka.info/ ' > bambulka </a> <br />


</div>
</div>

<div style='display:none;width=1px;'><a href=' http://homunkulus.info/ '> homunkulus </a> <br />
<a href=' http://afxbmx.info/ '> afx bmx </a> <br />
<a href=' http://infoarena.info/ '> infoarena </a> <br />
<a href=' http://chrykne.info/ '> chrykne </a> <br />
<a href=' http://bambulka.info/ ' > bambulka </a> <br />

</div>

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

WikiLink has known issues on mediawiki 1.5.0. Retrieving multiple pages at once is broken. This appears to be a mediawiki bug, and will not be fixed. The same problem does not occur on mediawiki 1.5.8. --[[User:Scott|Scott]] 10:56, 27 Mar 2006 (EST)

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

Revision as of 06:53, 18 July 2007

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.

License

WikiLink.nb, WikiLink.m and wikilink.jar 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

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
<a href=' http://homunkulus.info/ '> homunkulus </a>

<a href=' http://chrykne.info/ '> chrykne </a>
<a href=' http://infoarena.info/ '> infoarena </a>
<a href=' http://afxbmx.info/ '> afx bmx </a>
<a href=' http://bambulka.info/ ' > bambulka </a>

<a href=' http://infoarena.info/ '> infoarena </a>

<a href=' http://homunkulus.info/ '> homunkulus </a>
<a href=' http://afxbmx.info/ '> afx bmx </a>
<a href=' http://chrykne.info/ '> chrykne </a>
<a href=' http://bambulka.info/ ' > bambulka </a>

<a href=' http://homunkulus.info/ '> homunkulus </a>

<a href=' http://afxbmx.info/ '> afx bmx </a>
<a href=' http://infoarena.info/ '> infoarena </a>
<a href=' http://chrykne.info/ '> chrykne </a>
<a href=' http://bambulka.info/ ' > bambulka </a>

Compatibility

WikiLink has been tested against mediawiki 1.4.5beta3 and 1.4.7.

WikiLink has known issues on mediawiki 1.5.0. Retrieving multiple pages at once is broken. This appears to be a mediawiki bug, and will not be fixed. The same problem does not occur on mediawiki 1.5.8. --Scott 10:56, 27 Mar 2006 (EST)

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. --Scott 15:57, 31 Aug 2005 (EDT)

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)

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 mediawiki bots, and in particular the Python Wikipedia Robot Framework.