Developer Specification for ARML Support of Wikitude World Browser.
ARML (augmented reality markup language) is a specification that allows content developers create content that is displayed on various mobile AR browsers. Wikitude 4 is the first browser that natively supports ARML. ARML is built on a subset of KML, a set of common tags supported across all browsers and some browser (e.g. Wikitude) specific extensions. This specification describes the full set of tags supported by Wikitude 4.
The ARML document must be a valid XML in UTF-8 encoding. The text of the tags may be enclosed by a CDATA section to prevent un-escaped characters like <, >, ...
When you create an ARML for Wikitude you can use the example blow as a starting point.
wikitude-arml.xml:
<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://www.opengis.net/kml/2.2"
xmlns:ar="http://www.openarml.org/arml/1.0"
xmlns:wikitude="http://www.openarml.org/wikitude/1.0">
<Document>
<ar:provider id="mountain-tours-I-love.com">
<ar:name>Mountain Tours I Love</ar:name>
<ar:description>My preferred mountain tours in the alps. Summer and Winter.</ar:description>
<wikitude:providerUrl>http://www.providerhomepage.com </wikitude:providerUrl>
<wikitude:tags>travel, hiking, skiing, mountains</wikitude:tags>
<wikitude:logo>http://www.mountain-tours-I-love.com/wikitude-logo.png </wikitude:logo>
<wikitude:icon>http://www.mountain-tours-I-love.com/wikitude-icon.png </wikitude:icon>
</ar:provider>
<Placemark id="123">
<ar:provider>mountain-tours-I-love.com</ar:provider>
<name>Gaisberg</name>
<description>Gaisberg is a mountain to the east of Salzburg, Austria</description>
<wikitude:info>
<wikitude:thumbnail>http://www.mountain-tours-I-love.com/gaisberg-thumb.png </wikitude:thumbnail>
<wikitude:phone>555-9943</wikitude:phone>
<wikitude:url>http://en.wikipedia.org/wiki/Gaisberg </wikitude:url>
<wikitude:email>info@mountain-tours-I-love.com</wikitude:email>
<wikitude:address>Jakob-Haringer-Str. 5a, 5020 Salzburg, Austria</wikitude:address>
<wikitude:attachment>http://www.mountain-tours-I-love.com/gaisberg-map-to-print.pdf </wikitude:attachment>
</wikitude:info>
<Point>
<coordinates>13.11,47.81,1158</coordinates>
</Point>
</Placemark>
<Placemark id="534">
<ar:provider>mountain-tours-I-love.com</ar:provider>
<name>Untersberg</name>
<description>The Untersberg is a mountain massif of the Berchtesgaden Alps, between Berchtesgaden, Germany and Salzburg, Austria.</description>
<wikitude:info>
<wikitude:thumbnail>http://www.mountain-tours-I-love.com/untersberg-thumb.png </wikitude:thumbnail>
<wikitude:phone>555-9945</wikitude:phone>
<wikitude:url name="Untersberg Wikipedia Article">http://en.wikipedia.org/wiki/Untersberg </wikitude:url>
<wikitude:email>info@mountain-tours-I-love.com</wikitude:email>
<wikitude:address>Jakob-Haringer-Str. 5a, 5020 Salzburg, Austria</wikitude:address>
<wikitude:attachment name="Untersberg Tour" type="application/pdf">http://www.mountain-tours-I-love.com/untersberg-map-to-print.pdf </wikitude:attachment>
</wikitude:info>
<Point>
<coordinates>12.62,47.52,1852</coordinates>
</Point>
</Placemark>
</Document>
</kml>
Root tag as described by the KML standard. Additionally to the standard KML namespace you should add the ARML namespace and Wikitude specific namespaces.
| Name | Required | Description |
|---|---|---|
| xmlns | no | http://www.opengis.net/kml/2.2: Standard KML namespace |
| xmlns:ar | no | http://www.openarml.org/arml/1.0: Standard ARML namespace |
| xmlns:wikitude | no | http://www.openarml.org/wikitude/1.0: Public Wikitude namespace |
| xmlns:wikitudeInternal | no | http://www.openarml.org/wikitudeInternal/1.0: Internal Wikitude namespace for statistical information returned to the mobile client |
Identifies a content provider or content channel. Wikipedia, Youtube or Twitter are popular separate providers. Each provider must have an unique identifier.
You can add more than one provider, each provider will show up as a seperate entry in the provider list.
| Name | Required | Description |
|---|---|---|
| id | yes | Identifies the content provider or content channel. Must be unique across all providers |
Name of the content provider. This name will be used to display the content provider in the settings and bookmarks menu of the browser.
Description of a content provider that provides additional information about the content displayed.
Link to the content provider. If the content provider adds an own logo the user will be redirected to the providerUrl when clicking on the logo.
Comma separated list of keywords that characterize the content provider. When users search for content in Wikitude the tags will be searched as well. A match in the tags is higher ranked than in the description.
Logo displayed on the left bottom corner on Wikitude when an icon is selected.
Format: 96x96 pixel, transparent PNG
The icons are displayed in the cam view of Wikitude to indicate a point of interest (POI).
Format: 32x32 pixel, transparent PNG
Placemark describes one point of interest (POI) in Wikitude.
| Name | Required | Description |
|---|---|---|
| id | yes | Identifies a point of interest. Is used to update POIs when uploaded via Wikitude.me |
Reference to the content provider definition.
Name of the POI. Displayed as POI title.
Description of the POI. Currently no HTML formatting is allowed.
Additional information about a POI that is displayed in the bubble.
Specific POI image that is displayed in the bubble. This could be for instance a hotel picture for a hotel booking content provider.
Format: 64x64 pixel, PNG
When a phone number is given, Wikitude displays a "call me" button in the bubble. You can directly call the person/organization behind the POI. E.g. call a restaurant to reserve a table for dinner.
Link to a web page that contains additional information about the POI.
| Name | Required | Description |
|---|---|---|
| name | no | Used to display the name of the link |
Write the person/organization an email directly from Wikitude.
Address of the POI. Also used to route to the location of the POI.
Can be a link to a resource (image, PDF file, ...). You could use this to issue coupons or vouchers for potential clients that found you via Wikitude.
| Name | Required | Description |
|---|---|---|
| name | no | Used to display the name of an attachment link |
| type | no | Mime type of the attachment. If it is a known type it can automatically trigger an application start (e.g. audio/mpeg can start the attachment in the phones media player) |
The coordinates are entered in the format longitude, latitude, altitude. Altitude is optional. Altitude must be given in meters.