
The UCSC login extensions to MediaWiki must be installed with
a corresponding version of MediaWiki.  These files are for
the mediawiki-1.16.3. version:

Fetch MediaWiki version 1.16.3 from:
http://download.wikimedia.org/mediawiki/1.16/mediawiki-1.16.3.tar.gz

Install it and set it up according to their instructions.  Make
sure it is working before modifying the mediawiki code.

=========================================================================
Additional files to the MediaWiki installation
=========================================================================

Drop these UCSC additional files into the MediaWiki hierarchy:

includes.specials.SpecialUserloginUCSC.php into:
	./includes/specials/SpecialUserloginUCSC.php
includes.specials.SpecialUserlogoutUCSC.php into:
	./includes/specials/SpecialUserlogoutUCSC.php

includes.templates.UserloginUCSC.php into ./includes/templates/UserloginUCSC.php

extensions.SpecialUserloginUCSC.php into ./extensions/SpecialUserloginUCSC.php
extensions.SpecialUserlogoutUCSC.php into ./extensions/SpecialUserlogoutUCSC.php

=========================================================================
Patches to MediaWiki files:
=========================================================================

One file in the MediaWiki installation needs to be changed:
	includes/AutoLoader.php

Add a single line to that file:
	'UserloginUCSCTemplate' => 'includes/templates/UserloginUCSC.php',

you can place it directly after this line in the file:
	'UserloginTemplate' => 'includes/templates/Userlogin.php',
	'UserloginUCSCTemplate' => 'includes/templates/UserloginUCSC.php',

=========================================================================
LocalSettings.php additions
=========================================================================

This business is used in the wiki by adding the lines
to the LocalSettings.php:

require_once( "$IP/extensions/SpecialUserloginUCSC.php" );
require_once( "$IP/extensions/SpecialUserlogoutUCSC.php" );

=========================================================================
genome browser cgi-bin/hg.conf settings
=========================================================================

In your genome browser cgi-bin/hg.conf file, the configuration item:
wiki.host=wiki.myhost.edu

Should be the URL to your wiki host where the wiki is running.

It can include a port number, and sub-directory if your wiki is
not at the top level of that WEB server:
wiki.host=wiki.myhost.edu:8080/specialWiki

The cookie identifiers need to mirror settings you have
in your LocalSettings.php configuration.  The $wgDBname
and $wgDBprefix strings are used in the cookie names:

wiki.userNameCookie=wgDBName_wgDBprefix_UserName
wiki.loggedInCookie=wgDBName_wgDBprefix_UserID

Replace the wgDBName and wgDBprefix with the strings from
your LocalSettings.php with _UserName and _UserID following.

The following items are required if you want to reproduce the
wiki track function.  These are not important if you are only
using your wiki as a login authentication system.

The cgi-bin/hg.conf item
wikiTrack.URL=
should be the complete URL to the main page of the wiki,
eg:
wikiTrack.URL=wiki.myhost.edu:8080/localWiki

Where your wiki is in the sub-directory localWiki in
your MediaWiki installation.

The wikiTrack.browser should be the host name of your genome browser:
wikiTrack.browser=your.browser.edu

This is used to construct URL references from the wiki articles
back to your genome browser.
