Maps for MediaWiki: Difference between revisions

From Maps for MediaWiki
m (Jeroen De Dauw moved page Main Page to Maps for MediaWiki)
No edit summary
Line 1: Line 1:
<strong>MediaWiki has been installed.</strong>


Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.
The '''Maps''' extension provides the ability to visualize geographic data with dynamic, JavaScript based, mapping API's such as Google Maps and OpenLayers in your wiki pages. It has built-in support for geocoding, displaying maps, displaying markers, adding pop-ups, and more. Maps allows extensive customization of your maps, either per map, or via a general setting affecting all maps on your wiki. Moreover it provides [[#Semantic MediaWiki integration|close integration]] with {{Extend|Semantic MediaWiki}}.


== Getting started ==
== Features ==
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]
<strong>MediaWiki has been installed.</strong>


Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.
=== Displaying Maps ===


== Getting started ==
{{Displaying maps}}
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]
<strong>MediaWiki has been installed.</strong>


Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.
: <big>''see &rarr; [[Maps/Displaying maps]] for details.''</big>


== Getting started ==
=== Geocoding ===
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]
<strong>MediaWiki has been installed.</strong>


Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.
You can turn human readable location names into coordinates, a process called geocoding, using the <code>#geocode</code> parser function.


== Getting started ==
<pre><nowiki>
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
{{#geocode:Brandenburg Gate, Berlin, Germany}}
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
</nowiki></pre>
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]
<strong>MediaWiki has been installed.</strong>


Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.
results in:
{{#geocode:Brandenburg Gate, Berlin, Germany}}


== Getting started ==
: ''see &rarr; [[Maps/Geocoding]] for details.''
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]
<strong>MediaWiki has been installed.</strong>


Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.
=== Semantic MediaWiki integration ===


== Getting started ==
If you have [[Semantic MediaWiki]] installed, Maps adds {{DataType|Geographic coordinates}}. This allows you to store, [[Help:Semantic_search|query]], aggregate and export your geographical data, and combine it with other information you have stored in your wiki.  
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]
<strong>MediaWiki has been installed.</strong>


Consult the [https://www.mediawiki.org/wiki/Special:MyLanguage/Help:Contents User's Guide] for information on using the wiki software.
'''Map Result Formats'''


== Getting started ==
Maps adds several [[Help:Result_formats|result formats]]. These allow you to query geographical data, and information associated with it, onto dynamic maps embedded in your wiki.
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Configuration_settings Configuration settings list]
 
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:FAQ MediaWiki FAQ]
Maps adds the [[Help:Google Maps format|Google Maps format]] and [[Help:Leaflet format|Leaflet format]]. It also adds the [[Help:Map format|Map format]], which is an alias for your wikis default mapping service.
* [https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce MediaWiki release mailing list]
 
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Localisation#Translation_resources Localise MediaWiki for your language]
'''KML export'''
* [https://www.mediawiki.org/wiki/Special:MyLanguage/Manual:Combating_spam Learn how to combat spam on your wiki]
 
You can export your data as KML, giving you interoperability with many services and tools that use this standard format.
 
: ''see &rarr; [[Help:KML_format|the KML format documentation]] for details.''
 
'''SMW distance queries'''
 
You can restrict your SMW query results to those within a radius of a certain point.
 
: ''see &rarr; [[Semantic_Maps_examples/Distance_query|this example]] for details.''
 
=== Coordinate and distance formatting ===
 
You can format coordinates from any of the supported formats to any other with the <code>#coordinates</code> parser function.
 
: ''see &rarr; [[Maps/Coordinates]] for details.''
 
Similarly you can convert distances using the <code>#distance</code> parser function.
 
: ''see &rarr; [[Maps/Distance]] for details.''
 
=== Geospatial operations ===
 
You can calculate the distance between two points using the <code>#geodistance</code> parser function.
 
: ''see &rarr; [[Maps/Geodistance]] for details.''
 
It is also possible to find a destination given a starting point, bearing and distance with the <code>#finddestination</code> parser function.
 
: ''see &rarr; [[Maps/Finddestination]] for details.''
 
=== Visual Map Editor ===
 
If you have Google Maps enabled, Maps provides a special page, <code>Special:MapEditor</code>, that allows you to construct the <code>#display_map</code> via a visual editor.
 
: ''see &rarr; [[Special:MapEditor]] for an example.''
 
== Examples ==
 
Many examples of how to use Maps can be found on the '''[[Maps examples]]''' and [[Semantic Maps examples]] pages.
 
== Release Notes and version history ==
 
The RELEASE NOTES are provided at [https://github.com/JeroenDeDauw/Maps/blob/master/RELEASE-NOTES.md this location].
 
== Installation ==
 
Installation instructions can be found in the [https://github.com/JeroenDeDauw/Maps/blob/master/INSTALL.md INSTALL.md file].
 
=== Upgrading from Semantic Maps ===
 
Since its 4.0 release on November 16, 2016 the functionality formerly provided by the [[Extension:Semantic Maps|Semantic Maps]] extension was merged into this extension. Moreover the "googlemaps" and "openlayers" input types were removed and are now part of the [[Extension:Page Forms|Page Forms]] extension.
 
{{Callout
|Make sure that you update all references to the "Semantic Maps" extension to the "Maps" extension in your "LocalSettings.php" file and remove all of them from your "composer.json" file (MW ≀ 1.24) or "composer.local.json" file (MW ≥ 1.25) when upgrading to version 4.0 of Maps. Note also the [https://github.com/JeroenDeDauw/Maps/blob/master/RELEASE-NOTES.md#breaking-changes breaking changes] and the [https://www.entropywins.wtf/blog/2016/11/09/maps-4-0-0-rc1-released/ blog post] on the 4.0 release.
|error
}}
{{Callout
|The examples documented at [[Semantic Maps examples]] are now also making reference to the Maps extension. The documentation will be updated and moved as soon as a community member using the Maps extension has the mercy to help with this task.
}}
 
== Support ==
 
If you have problems with the usage of any mapping related features, you should provide the community or developers with the information needed to help you out. Reporting simply that you have a problem without describing it properly wastes people's time. Also look at the documentation before asking for help. All support requests should answer at least the following questions:
 
* Can the problem be viewed online in a public wiki? (If yes, provide its URL.)
* Which versions of the relevant extension(s) was/were used?
* Which version of MediaWiki was used?
 
=== Where ===
 
General mapping questions are welcome on the [[Mailing list|mapping mailing list]].
 
If you have any Maps related questions, you can add them to [[Talk:Maps|the Maps talk page]]. You can alternatively also place any questions on the MediaWiki tech mailing list, [http://lists.wikimedia.org/pipermail/wikitech-l/ wikitech-l.] If possible, add "[Maps]" at the beginning of the subject line, to clarify the subject matter. Please contact the extensions authors only directly for urgent matters. Placing your questions on the talk page will create useful references for other people with similar problems.
 
You can also get paid professional support via [https://professional.wiki/ Professional Wiki], which is run by the extension author.
 
=== Reporting bugs ===
 
'''Bugs and feature requests''' for should be filed at the [https://github.com/JeroenDeDauw/Maps/issues Maps bugtracker]. As usual, all bug reports should answer at least the following questions:
 
* Can the problem be viewed online in a public wiki? (If yes, provide its URL.)
* Which versions of the relevant extension(s) was/were used?
* Which version of MediaWiki was used?
* Which server setup was used (PHP, MySQL, OS)?
* Can the problem be reproduced on another wiki (like this one)? (If yes, provide its URL.)
 
Improvements and patches can also be discussed on the [[mailing list]]. You can also view the [https://github.com/JeroenDeDauw/Maps/issues current bug list for Maps] online. It might contain hotfixes, patches, or workarounds even for unsolved issues.
 
=== How to get more information on your problem ===
 
Here are some tips to get more information on a problem, which will help us to solve it faster:
* In general, it may also be useful to [[Help:Identifying bugs|'''turn on debugging in MediaWiki''']]. This should provide you with more instructive error messages in your log file.
* If '''some page will not display correctly''' or causes critical errors, directly access the page in edit mode. To do that, edit any other page on your wiki and replace the page's name in the URL with the name of the broken page. Then try to remove parts of the page to find out what causes the problem, and include this in your bug report.
 
[[Category: Maps]]
<div style="display: none">
{{doc.info
|master page=Extension:Maps
|status=effective
|progress=100
|priority=3
|minversion=0.1
}}
 
{{Extension
|lang=en
|Name=Maps
|Homepage=https://github.com/JeroenDeDauw/Maps/blob/master/README.md
|Description=Allows embedding of dynamic maps, geocoding and geospatial operations
|Maintainer=Jeroen De Dauw
|First released month=July
|First released year=2009
|Release status=stable
|Development status=active
|Area of usage=Displaying data
|Associated with=MW, SB
|Wikidata=Q21677553
}}
</div>

Revision as of 12:36, 5 May 2020

The Maps extension provides the ability to visualize geographic data with dynamic, JavaScript based, mapping API's such as Google Maps and OpenLayers in your wiki pages. It has built-in support for geocoding, displaying maps, displaying markers, adding pop-ups, and more. Maps allows extensive customization of your maps, either per map, or via a general setting affecting all maps on your wiki. Moreover it provides close integration with Template:Extend.

Features

Displaying Maps

Template:Displaying maps

see → Maps/Displaying maps for details.

Geocoding

You can turn human readable location names into coordinates, a process called geocoding, using the #geocode parser function.

{{#geocode:Brandenburg Gate, Berlin, Germany}}

results in: 52° 30' 58.57" N, 13° 22' 39.73" E

see → Maps/Geocoding for details.

Semantic MediaWiki integration

If you have Semantic MediaWiki installed, Maps adds Template:DataType. This allows you to store, query, aggregate and export your geographical data, and combine it with other information you have stored in your wiki.

Map Result Formats

Maps adds several result formats. These allow you to query geographical data, and information associated with it, onto dynamic maps embedded in your wiki.

Maps adds the Google Maps format and Leaflet format. It also adds the Map format, which is an alias for your wikis default mapping service.

KML export

You can export your data as KML, giving you interoperability with many services and tools that use this standard format.

see → the KML format documentation for details.

SMW distance queries

You can restrict your SMW query results to those within a radius of a certain point.

see → this example for details.

Coordinate and distance formatting

You can format coordinates from any of the supported formats to any other with the #coordinates parser function.

see → Maps/Coordinates for details.

Similarly you can convert distances using the #distance parser function.

see → Maps/Distance for details.

Geospatial operations

You can calculate the distance between two points using the #geodistance parser function.

see → Maps/Geodistance for details.

It is also possible to find a destination given a starting point, bearing and distance with the #finddestination parser function.

see → Maps/Finddestination for details.

Visual Map Editor

If you have Google Maps enabled, Maps provides a special page, Special:MapEditor, that allows you to construct the #display_map via a visual editor.

see → Special:MapEditor for an example.

Examples

Many examples of how to use Maps can be found on the Maps examples and Semantic Maps examples pages.

Release Notes and version history

The RELEASE NOTES are provided at this location.

Installation

Installation instructions can be found in the INSTALL.md file.

Upgrading from Semantic Maps

Since its 4.0 release on November 16, 2016 the functionality formerly provided by the Semantic Maps extension was merged into this extension. Moreover the "googlemaps" and "openlayers" input types were removed and are now part of the Page Forms extension.

Make sure that you update all references to the "Semantic Maps" extension to the "Maps" extension in your "LocalSettings.php" file and remove all of them from your "composer.json" file (MW ≀ 1.24) or "composer.local.json" file (MW ≥ 1.25) when upgrading to version 4.0 of Maps. Note also the breaking changes and the blog post on the 4.0 release.
The examples documented at Semantic Maps examples are now also making reference to the Maps extension. The documentation will be updated and moved as soon as a community member using the Maps extension has the mercy to help with this task.

Support

If you have problems with the usage of any mapping related features, you should provide the community or developers with the information needed to help you out. Reporting simply that you have a problem without describing it properly wastes people's time. Also look at the documentation before asking for help. All support requests should answer at least the following questions:

  • Can the problem be viewed online in a public wiki? (If yes, provide its URL.)
  • Which versions of the relevant extension(s) was/were used?
  • Which version of MediaWiki was used?

Where

General mapping questions are welcome on the mapping mailing list.

If you have any Maps related questions, you can add them to the Maps talk page. You can alternatively also place any questions on the MediaWiki tech mailing list, wikitech-l. If possible, add "[Maps]" at the beginning of the subject line, to clarify the subject matter. Please contact the extensions authors only directly for urgent matters. Placing your questions on the talk page will create useful references for other people with similar problems.

You can also get paid professional support via Professional Wiki, which is run by the extension author.

Reporting bugs

Bugs and feature requests for should be filed at the Maps bugtracker. As usual, all bug reports should answer at least the following questions:

  • Can the problem be viewed online in a public wiki? (If yes, provide its URL.)
  • Which versions of the relevant extension(s) was/were used?
  • Which version of MediaWiki was used?
  • Which server setup was used (PHP, MySQL, OS)?
  • Can the problem be reproduced on another wiki (like this one)? (If yes, provide its URL.)

Improvements and patches can also be discussed on the mailing list. You can also view the current bug list for Maps online. It might contain hotfixes, patches, or workarounds even for unsolved issues.

How to get more information on your problem

Here are some tips to get more information on a problem, which will help us to solve it faster:

  • In general, it may also be useful to turn on debugging in MediaWiki. This should provide you with more instructive error messages in your log file.
  • If some page will not display correctly or causes critical errors, directly access the page in edit mode. To do that, edit any other page on your wiki and replace the page's name in the URL with the name of the broken page. Then try to remove parts of the page to find out what causes the problem, and include this in your bug report.