View source for Help:Installation/Quick guide

{{DISPLAYTITLE:Installation – Quick Guide}}
== Composer ==

Composer needs to be installed and available first. See [[Help:Installation/Using Composer with MediaWiki 1.25+|Using Composer with MediaWiki]] and [https://www.mediawiki.org/wiki/Composer#Installing_Composer Installing Composer] if unsure.

== Compatibility ==

Please check the [[Help:Compatibility|compatibility]] requirements.

== Prepare and obtain ==

If you do not have a "composer.local.json" file yet, create one in the base directory[[CiteRef::install:base:dir]] of your MediaWiki installation.

Since you should already have composer installed, you can do this by running composer in the top-level MediaWiki directory.  Assuming you have <tt>composer.phar</tt> in that directory, the following command will work:

  COMPOSER=composer.local.json php composer.phar require --no-update mediawiki/semantic-media-wiki

Alternatively, if the above fails, you can add the following content to your composer.local.json file:

<syntaxhighlight lang="json">
{
	"require": {
                  "mediawiki/semantic-media-wiki": "~4.0"
        }
}
</syntaxhighlight>

See also an [[Help:Installation/Example "composer.local.json" file|example "composer.local.json" file]] if unsure how to proceed.

{{Callout
 |The version stated in the line above is provided as an example. See the [https://github.com/SemanticMediaWiki/SemanticMediaWiki/releases Releases page on GitHub] for newer releases. If there is e.g. a release called "SMW {{SMW release main page}}" you will have to replace <code>"~3.2"</code> with {{LatestAvailableStableReleaseForComposer}} to get the latest stable release. Please always omit the bugfix release number, i.e. the third number with additional information about the <code>~</code> usage can be found [[Help:Composer#.7E.2F.5E_usage_and_meaning|here]].  (Of course, if you used the command line to create composer.local.json instead of editing it by hand, composer has already selected the latest stable version.)
 |info
}}

Now run the following command from the base directory[[CiteRef::install:base:dir]] of your MediaWiki installation:
<syntaxhighlight lang="text">
composer update --no-dev
</syntaxhighlight>

== Enable ==
{{Callout
 |'''BREAKING:''' As of {{Release|4.0.0}} you need to add <code>wfLoadExtension( 'SemanticMediaWiki' );</code> to LocalSettings.php !<br>
Until SMW 3.2.x only <code>enableSemantics( 'example.org' );</code> was used to invoke SMW. 
 |error
}}
Add a call to <code>wfLoadExtension()</code> as well as [[Help:enableSemantics|<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">
wfLoadExtension( 'SemanticMediaWiki' );
enableSemantics( 'example.org' );
</syntaxhighlight>

== Setup and update ==

Run MediaWiki'S "update.php" script from the base directory[[CiteRef::install:base:dir]] of your MediaWiki installation:
<syntaxhighlight lang="bash">
php maintenance/update.php
</syntaxhighlight>

{{Callout
 |Add <code>--skip-external-dependencies</code> to the call of the setup script if you get an error message similar to the following one:
<syntaxhighlight lang="bash">mediawiki/semantic-media-wiki: 2.5.0 installed, ~2.5 required.</syntaxhighlight>
}}

== Verify ==

Check the "Special:Version" page on your wiki and verify that the extension has been successfully installed and enabled.

Test your installation as described on the help page about [[Help:Testing|testing Semantic MediaWiki]].

__NOTOC__
{{doc.info
 |master page=Help:Installation/Quick guide
 |status=effective
 |progress=100
 |priority=1
 |minversion=3.1.0
}}