ARML 1.0 Specification for Wikitude

Developer Specification for ARML 1.0 Support of the Wikitude World Browser.


Index


Versioning

This document describes the proprietary ARML 1.0 file format currently used in the Wikitude World Browser. If you are looking for the official OGC Candidate Standard ARML 2.0, please click here.

Introduction

ARML 1.0 is built on a subset of KML. The ARML 1.0 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 <, >, ...

Wikitude ARML 1.0 Example

When you create an ARML 1.0 for Wikitude you can use the example below 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:logo>http://www.mountain-tours-I-love.com/wikitude-logo.png </wikitude:logo>
        </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:info>
            <Point>
                <coordinates>13.11,47.81,1158</coordinates>
            </Point>
        </Placemark>
    </Document>
</kml>
        

Tags

Document Structure

An ARML 1.0 document starts with a kml tag, which is the root tag as described by the KML standard. Additionally to the standard KML namespace the ARML 1.0 namespace and Wikitude specific namespaces need to be added.

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 1.0 namespace
xmlns:wikitude no http://www.openarml.org/wikitude/1.0: Public Wikitude namespace

The kml tag contains only one Document tag, which contains the entire ARML 1.0 information.
An ARML 1.0 document consists of 2 main parts, which are described below:

ar:provider

Identifies a World. 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.

Attributes

Name Required Description
id yes Identifies the content provider or content channel. Must be unique across all providers

Elements

Name Description Required
ar:provider Reference to the content provider definition. yes
ar:name Name of the content provider. This name will be used to display the content provider in the settings and bookmarks menu of the browser. yes
ar:description Description of a content provider that provides additional information about the content displayed. no
wikitude:providerUrl 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. no
wikitude:logo Logo displayed on the left bottom corner on Wikitude when an icon is selected.
Format: We suggest a resolution of at least 256x256 pixel, transparent PNG
yes

Placemark

Placemark describes one point of interest (POI) in Wikitude.

Attributes

Name Required Description
id yes Identifies a point of interest. Is used to update POIs when uploaded via Wikitude.me

Elements

Name Description Required
ar:provider Reference to the content provider definition. yes
name Name of the POI. Displayed as POI title. yes
description Description of the POI. Currently no HTML formatting is allowed. no
wikitude:info Additional information about a POI that is displayed in the bubble no
Point Coordinates wrapped in coordinate tag (see example above) entered in the format longitude, latitude, altitude. Altitude is optional. Altitude must be given in meters. yes.

Elements for wikitude:info

Name Description Required
wikitude:thumbnail Specific POI image that is displayed in the bubble. This could be for instance a hotel picture for a hotel booking content provider. no
wikitude:phone 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. no
wikitude:url Link to a web page that contains additional information about the POI. no
wikitude:email Write the person/organization an email directly from Wikitude. no
wikitude:address Address of the POI. Also used to route to the location of the POI. no

Last Update, 20th May 2014, 15:09 CET