Difference between revisions of "Help:Installation"

From Mapping on MediaWiki
Jump to: navigation, search
Line 5: Line 5:
== [[Maps]] ==
== [[Maps]] ==
{{Maps installation}}
{{template:Maps installation}}
=== Example usage ===
=== Example usage ===
Line 14: Line 14:
== [[Semantic Maps]] ==
== [[Semantic Maps]] ==
{{Semantic Maps installation}}
{{template:Semantic Maps installation}}
== See also ==
== See also ==

Latest revision as of 17:57, November 28, 2011

Admin manual





User manual

This page contains installation instructions for the mapping extensions.


In order to use Maps, you need to have Extension:Validator installed.

But if you get a distribution from this page, you do not need to bother with this, since Validator comes bundled with every release, and will automatically be loaded by Maps. If you get Maps from SVN trunk, or a tag, you must make sure you also install Validator.

Once you have downloaded the code, place the 'Maps' directory within your MediaWiki 'extensions' directory. Then add the following code to your LocalSettings.php file:

require_once( "$IP/extensions/Validator/Validator.php" ); # Validator must be included *before* Maps.
require_once( "$IP/extensions/Maps/Maps.php" ); # Maps

Once you have successfully installed Maps, please add your wiki to the Sites that use Maps section.

Example usage

{{#display_map:New York City}}

For usage, see Help:Maps.

Semantic Maps

Make sure you have Semantic MediaWiki, Maps and Validator successfully installed before proceeding with the installation. Once you have downloaded the code, place the 'SemanticMaps' directory within your MediaWiki 'extensions' directory. Then add the following code to your LocalSettings.php file after the lines that install Maps:

require_once( "$IP/extensions/SemanticMaps/SemanticMaps.php" );

The placement of the inclusion of Maps and Semantic Maps needs to be at a certain position. Hold the following rules into account:

  • Maps needs to be included before Semantic Maps.
  • Semantic MediaWiki needs to be included before Maps.
  • Semantic Forms (if used) needs to be included before Maps (after SMW).

An example of a typical inclusion order: ..., SMW, ..., SF, ..., Maps, SM, ...

Once you have successfully installed Semantic Maps, please add your wiki to the sites that use Semantic Maps section on mediawiki.org.

Installing 0.7.x

This applies only to people installing version 0.7.x. It does not apply for those installing 1.0 or later.

Once You installed Semantic Maps, go to Special:SMWAdmin and run "database installation and upgrade". Skipping this step will result in database errors on pages with geographical coordinates and other functionality that interacts with the storage of geographical coordinates.

Upgrading from 0.5.x or older

Make sure you have the latest version of Semantic MediaWiki when installing Semantic Maps 1.0 or later. If you are installing Semantic Maps 0.7.x, get Semantic MediaWiki 1.5.6.

When upgrading from any of these versions, you need to run the "database installation and upgrade" script in Special:SMWAdmin. Not doing this will result into fatal PHP errors. You will also need to run the "data repair and upgrade" script on the same page, which is required in order to store all coordinates so that Semantic Maps recognizes them. Not doing this will result into queries not returning any coordinates.

Upgrading from Semantic Google Maps

If you have Semantic Google Maps installed, and want to upgrade to Semantic Maps, these are the steps you need to follow:

  • Remove the SemanticGoogleMaps directory from your extension directory.
  • Remove (when you use it) Google Geocoder in a similar fashion.
  • Upload both Maps and Semantic Maps to your extension directory.
  • Make sure your API keys are in the right place (the variable $wgGoogleMapsKey will need to be renamed, or copied, to $egGoogleMapsKey).
  • Change all #semantic_google_map parser functions with #display_point.
  • Add parameter names to the value of the #display_point calls.

After doing all these steps, you should be done. Maps and Semantic Maps are designed to be backward compatible with SGM, so all SGM code should work on Semantic Maps. If you encounter some problem though, please let the extension developers know.

See also

This documentation page applies to all (Semantic) Maps versions from 0.1 to the most current version.

Help:Installation en 0.1