Help:Configuration: Difference between revisions

From PBTWiki
Jump to navigation Jump to search
(Undo revision 25 by SimonJolly (talk))
No edit summary
Line 1: Line 1:
Configuration is largely carried out by editing the [http://www.mediawiki.org/wiki/Manual:LocalSettings.php LocalSettings.php] file in the MediaWiki directory: information on the general structure and how to edit it are available from the [http://www.mediawiki.org/wiki/Manual:LocalSettings.php LocalSettings.php MediaWiki Manual page].
== Short URL ==
The default page address for a MediaWiki installation looks something like this:
: <code>http://www.hep.ucl.ac.uk/pbt/pbtWiki/index.php/Software/Geant4</code>
However, what we would prefer is something like this:
: <code>http://www.hep.ucl.ac.uk/pbt/wiki/Software/Geant4</code>
In order to do this, we have to modify the configuration to make use of [http://www.mediawiki.org/wiki/Manual:Short_URL Short URL's]: details can be found on the [http://www.mediawiki.org/wiki/Manual:Short_URL MediaWiki Short URL Manual page].
Specifically, the configuration on the HEP www server makes use of [http://www.mediawiki.org/wiki/Manual:Short_URL/Apache Apache Rewrite Rules]: a guide on setting up these short links is available from the [http://www.mediawiki.org/wiki/Manual:Short_URL/Apache MediaWiki Short URL/Apache Guide page].
Since it is not possible for individual users to edit the rules for the entire HEP website, the guidelines for setting up and individual <code>.htaccess</code> file were followed.
A <code>.htaccess</code> file was created in the <code>/unix/www/html/pbt/</code> directory: note that this is '''not''' the specific <code>pbtWiki</code> directory but one level above. 
This is simply a text file with the following lines:
<pre>
## http://www.mediawiki.org/wiki/Manual:Short_URL/Apache
# Enable the rewrite engine
RewriteEngine On
# Short url for wiki pages
RewriteRule ^/?wiki(/.*)?$ %{DOCUMENT_ROOT}/pbt/pbtWiki/index.php [PT,L]
</pre>
In addition, the <code>$wgArticlePath</code> variable needs to be set in <code>LocalSettings.php</code>. 
The relevant part of the file looks like this:
<pre>
## The URL base path to the directory containing the wiki;
## defaults for all runtime URL paths are based off of this.
## For more information on customizing the URLs please see:
## http://www.mediawiki.org/wiki/Manual:Short_URL
$wgScriptPath      = "/pbt/pbtWiki";
$wgArticlePath      = "/pbt/wiki/$1";
$wgScriptExtension  = ".php";
</pre>
This enables the [[Main Page|PBTWiki]] to be accessed from the short URL.
== CSS ==
== CSS ==



Revision as of 13:47, 31 March 2016

Configuration is largely carried out by editing the LocalSettings.php file in the MediaWiki directory: information on the general structure and how to edit it are available from the LocalSettings.php MediaWiki Manual page.

Short URL

The default page address for a MediaWiki installation looks something like this:

http://www.hep.ucl.ac.uk/pbt/pbtWiki/index.php/Software/Geant4

However, what we would prefer is something like this:

http://www.hep.ucl.ac.uk/pbt/wiki/Software/Geant4

In order to do this, we have to modify the configuration to make use of Short URL's: details can be found on the MediaWiki Short URL Manual page.

Specifically, the configuration on the HEP www server makes use of Apache Rewrite Rules: a guide on setting up these short links is available from the MediaWiki Short URL/Apache Guide page.

Since it is not possible for individual users to edit the rules for the entire HEP website, the guidelines for setting up and individual .htaccess file were followed. A .htaccess file was created in the /unix/www/html/pbt/ directory: note that this is not the specific pbtWiki directory but one level above. This is simply a text file with the following lines:

## http://www.mediawiki.org/wiki/Manual:Short_URL/Apache

# Enable the rewrite engine
RewriteEngine On
 
# Short url for wiki pages
RewriteRule ^/?wiki(/.*)?$ %{DOCUMENT_ROOT}/pbt/pbtWiki/index.php [PT,L]

In addition, the $wgArticlePath variable needs to be set in LocalSettings.php. The relevant part of the file looks like this:

## The URL base path to the directory containing the wiki;
## defaults for all runtime URL paths are based off of this.
## For more information on customizing the URLs please see:
## http://www.mediawiki.org/wiki/Manual:Short_URL
$wgScriptPath       = "/pbt/pbtWiki";
$wgArticlePath      = "/pbt/wiki/$1";
$wgScriptExtension  = ".php";

This enables the PBTWiki to be accessed from the short URL.

CSS

Customised CSS rules can be used for pages within the PBT Wiki. To add or edit these rules, edit the MediaWiki:Common.css page.

More information on using CSS in a MediaWiki can be found at http://www.mediawiki.org/wiki/Manual:CSS