View source for Help:Installation/Using Composer with MediaWiki 1.19 - 1.21

{{Installation
 |Description=This pages describes the installation using non-native Composer support for MediaWiki 1.19.x to 1.21.x.
 |Installation type=new
 |Installation method=Composer
 |Installation document status=valid
}}

{{Note}} MediaWiki 1.19.x, 1.20.x and 1.21.x are no longer supported branches. Users are advised to upgrade to a supported branch of MediaWiki.

== Install ==
Use these instructions for a new SMW installation (MediaWiki 1.19.x to 1.21.x, non-native Composer support).

# Install the "Extension Installer" extension - see [https://github.com/JeroenDeDauw/ExtensionInstaller/blob/master/README.md installing "Extension Installer"] for how to do this.
# Check your MediaWiki version on special page "Special:Version" to ensure compatibility. See also [[mws:Manual:Upgrading|Update to the appropriate version of MediaWiki]].
# Add the following line to the "require" section of the "composer.json" file in the <code>…/extensions/ExtensionInstaller/</code> directory.<ref>See also the example [[Help:Installation/Example "composer.json" file#Semantic MediaWiki|"composer.json" file]], which already contains the line to be added here.</ref>
#: <syntaxhighlight lang="text">"mediawiki/semantic-media-wiki": "~2.1"</syntaxhighlight>
# Run the installation script from the <code>…/extensions/ExtensionInstaller/</code> directory:<ref name="comglob">In case you installed Composer "globally" on your server, you will have to drop the <code>php</code> and <code>.phar</code> particles from the command.</ref>
#: <syntaxhighlight lang="text">php composer.phar install</syntaxhighlight>
# Run the setup script from the base directory<ref name="base">This is the directory which contains the "LocalSettings.php" file.</ref> of your MediaWiki installation:
#: <syntaxhighlight lang="text">php maintenance/update.php</syntaxhighlight>
# Add a call to <code>enableSemantics()</code> to the end of the "LocalSettings.php" file. <code>enableSemantics()</code> takes in the domain name of the wiki; a wiki located at "example.org", for instance, should have the following call:
#: <syntaxhighlight lang="php">enableSemantics( 'example.org' );</syntaxhighlight>
#: The calls <code>require_once …</code> must neither be added for Semantic MediaWiki nor for Validator since Composer loads the extensions automatically.
# Add optional settings<ref name="config">See the help page on [[Help:Configuration|configuring SMW]]. Usually only a few configuration parameters have to be changed if there is a need to do so at all.</ref> apart from one exception<ref name="index">If you manually set [[Help:$smwgNamespaceIndex|<code>$smwgNamespaceIndex</code>]] to something other than the default value of <code>100</code>, you must do this ''above'' the enableSemantics() line instead. Make sure that the value set is ≥ <code>100</code> as well as an even number.</ref> to the "LocalSettings.php" file as desired below the <code>enableSemantics()</code> call.
# In case you want to use additional [[Help:SMW extensions|semantic extensions]] which are '''not''' installed via Composer like e.g. [[Semantic Drilldown]] you still have to invoke them by adding the respective line <code>require_once …</code> to you "LocalSettings.php" file ''below'' the <code>enableSemantics()</code> call.
# See the page "Special:Version" on your wiki to verify that the extension is successfully installed.
# Test your installation as described on the help page about [[Help:Testing|testing SMW]].
# Done!

== Update ==
Use these instructions to update an existing SMW installation (MediaWiki 1.19.x to 1.21.x, non-native Composer support).

# Backup your database and installation.
# Run the update script from the <code>…/extensions/ExtensionInstaller/</code> directory:<ref name="comglob" />
#: <syntaxhighlight lang="text">php composer.phar update</syntaxhighlight>
# See the page "Special:Version" on your wiki to verify that the extension was successfully updated.
# Run the setup script from the base directory<ref name="base" /> of your MediaWiki installation:
#: <syntaxhighlight lang="text">php maintenance/update.php</syntaxhighlight>
# Run the refresh database script from the base directory<ref name="base" />:<ref name="refresh">This is an optional step to take to assure that the semantic store is valid and up to date.</ref>
#: <syntaxhighlight lang="text">php extensions/SemanticMediaWiki/maintenance/SMW_refreshData.php -d 50 -v</syntaxhighlight>
# Done!

== References ==
<references/>
[[Docinfo_language::en]]
[[Category:Installation]]