====== mapillary Plugin ======

---- plugin ----
description: Allows adding a Mapillary widget to a page
author     : Mark Prins
email      : mprins@users.sf.net
type       : syntax
lastupdate : 2017-08-17
compatible : !Hogfather, !Greebo
depends    : 
conflicts  : 
similar    : 
tags       : media maps embed geo spatial gallery streetview !broken, !up_for_adoption, !discontinued

downloadurl: 
bugtracker : 
sourcerepo : https://github.com/mprins/dokuwiki-plugin-mapillary
donationurl: https://github.com/sponsors/mprins

screenshot_img : 
----


FIXME **This plugin is currently broken as Mapillary discontinued their embedding widget and the underlying API. The new API relies on WebGL and requires considerable hardware resources.**
Please use the [[plugin:iframe]] plugin with [[http://blog.mapillary.com/update/2016/11/30/embed-mapillary.html|embedding options that Mapillary provides]]

=====Description=====
A plugin to add a Mapillary map/photo sequence to a page.  
This plugin uses a third party service by Mapillary, please read up on their
[[http://www.mapillary.com/terms.html|usage terms]] and [[http://www.mapillary.com/business.html|business plans]].

Mapillary use, including the APIs and widget, are free for non-commercial use. Non-commercial use is any free service operated by a non-profit organization.
Commercial use is any use where you are charging someone for using your service or in any other way operating a business.


===== Installation =====
Search and install the plugin using the [[plugin:extension|Extension Manager]] or manually with the download from the [[http://sourceforge.net/projects/dokuwikispatial/files/mapillary/mapillary.zip/download|SourceForge Mirror]]. Refer to [[:Plugins]] on how to install plugins manually. 

All versions of the plugin: http://sourceforge.net/projects/dokuwikispatial/files/mapillary/

===== Examples/Usage =====

See the plugin in action [[http://dokuwikispatial.sourceforge.net/dokuwiki/mapillary:start|here]]. The sample page shows all the styles available with the plugin.

===== Syntax =====
To add a [[http://www.mapillary.com/|Mapillary]] sequence (photo and map) widget use the following syntax.

  {{mappillary>hashcode&width}}

The hashcode (required) for a sequence can be obtained through the Mapillary website, the width (optional) is in pixels. Optionally sequences and legs can be specified"

  {{mapillary>kc0319pHuZxfM9si0dStow&1050&&leg1_Höör|kc0319pHuZxfM9si0dStow:luKxatzSyVfXtAi80K1ktQ$leg2_Burlöv-Malmö}}
  
Parameters may be skipped, but the ampersand may not be skipped. You can right of left float the widget by adding a space after the first pair of brackets of before the last pair. eg. 

  {{ mapillary>kc0319pHuZxfM9si0dStow}}

will make the widget float right.

==== Changes ====
=== version 0.5 ===
  * fix display (heigth) of the widget

=== version 0.4 ===
  * support for Dokuwiki (left/right/none) media alignment convention

=== version 0.3 ===
  * add support for sequences and legs
  * add editor toolbar button

=== version 0.2 ===
  * use serverside rendering of the iframe to enhance the speed of page rendering
  * use sass for stylesheet
  * render metadata 
  * render odt
  * make it possible to have more than one image embedded
  * add print styling

=== version 0.1 ===
  * initial version