Andrej Pančur, Inštitut za novejšo zgodovino, Ljubljana Datum: 2013-10-10 Moja lastna shema za Layar. Vsebuje tako elemente, katerih vrednost se lahko vstavi samo preko admina, kot elemente s podatki za točke interesa (POI). Layar augmented reality V1.0 XML Schema Version: 1.0 Date: 2013-10-10 Based on Layar documentations https://www.layar.com/documentation/browser/ This software is dual-licensed: 1. Distributed under a Creative Commons Attribution-ShareAlike 3.0 Unported License http://creativecommons.org/licenses/by-sa/3.0/ 2. http://www.opensource.org/licenses/BSD-2-Clause All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. This software is provided by the copyright holders and contributors "as is" and any express or implied warranties, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the copyright holder or contributors be liable for any direct, indirect, incidental, special, exemplary, or consequential damages (including, but not limited to, procurement of substitute goods or services; loss of use, data, or profits; or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this software, even if advised of the possibility of such damage. Andrej Pančur, Inštitut za novejšo zgodovino, Ljubljana (Institute of contemporary history, Ljubljana) slovenski Slovenian angleški English nemški German hrvaški Croatian srbski Serbian bosanski Bosnian makedonski Macedonian francoski French španski Spanish italijanski Italian madžarski Hungarian ruski Russian poljski Polish češki Czech slovaški Slovak danski Danish nizozemski Dutch Use it for "tel:", "mailto:", "sms:", "layar://", "layarshare://" and other custom URL schemes. This tells the Layar client to fetch a plain text document that will be shown as a pop-up to the user as a result of activating the action. This is the same pop-up as the one used for the "showMessage" param in the getPOIs response. This tells the client that the action is a REST call to the content provider. Only http:// is supported. The response should be a HTTP 302 redirect to a layar:// intent. The layar:// intent tells the client to perform a new getPOI request. The body of the HTTP 302 response (plain text) will be displayed as a pop-up to the user before performing the new getPOI request. Info Audio Video Phone/Call Email/Message Position/Map/Navigation Add Remove Edit Collect Play (e. g. a song) Play (e. g. make the movie in a game) Share/Post/Publish Pin/Mark (on map) Check in/Check out Log in/Log out Lock/Unlock List/Scores Money/Pay/Buy Open Close Search Update Layer (switch to another layer) Yes Increase/Decrease View/Examine/Details Add to favorites Kill/Hit/Attack Heal Defend Repair Use/Interact/Switch Animate Scoreboard Generic action No The unique layer name registered on the publishing site. It is used by layar server to identify POI service provider. It is passed through in the getPOIs request sent by the Layar client. Zapiše se ga takoj na začetku. Brez presledkov, samo male črke in številke. Ima vlogo identifikacijske oznake. Identifikacijska številka Layer (layerID). Za vsak nov Layer (z drugim jezikom) daj drugo številko - od 1 naprej. The title that will be visible once it is published. Glavni naslov aplikacije. Mora bi ti kratek (največ 18 znakov). A very short summary of your layer content with max. 60 characters including spaces. Daljši opis, s katerim razložimo delovanje aplikacije. Lahko razdeljeno na odstavke. Poskusi z uporabo notranjih tagov... URL datoteke index.php Name of the publisher of the layer. By default, layer developer is also the publisher of this layer. Kategorije, s pomočjo katerih lahko uporabnik najde aplikacijo. Največ 15 besed, med seboj ločenih z vejico ali za praznim prostorom. Uporabljene kot ključne besede pri iskanju. The type of layer, determining how the client should display the POIs: 1 = generic; 2= 2d and 3d objects in 3d space. Generic 2D: Use this if you only use default POI icons or you have uploaded customized icon sets under Look and feel tab. 2D and 3D objects in 3D space: If you want to use 2D images or 3d models in 3D space. Največja ikona (logo) 128×128. Zapisana pot na računalniku in/ali serverju, kjer je ta ikona shranjena, preden se jo naloži preko layar administracije. Srednja ikona (logo) 96×96. Zapisana pot na računalniku in/ali serverju, kjer je ta ikona shranjena, preden se jo naloži preko layar administracije. Če je ne naložimo, se zgenerira iz icon_128. Najmanjša ikona (logo) 64×64. Zapisana pot na računalniku in/ali serverju, kjer je ta ikona shranjena, preden se jo naloži preko layar administracije. Če je ne naložimo, se zgenerira iz icon_128. Posnetek zaslona, ki se ga na spletni strani Layer prikazuje kot reklama za to aplikacijo. Velikost 480×320. Zapisana pot na računalniku in/ali serverju, kjer je ta posnetek zaslona shranjen, preden se ga naloži preko layar administracije. Podolgovata ikona. Resolucija 120×52 Podolgovata ikona. Resolucija 90×39. Če je ne naložimo, se zgenerira iz bannerIcon_128. Podolgovata ikona. Resolucija 60×26. Če je ne naložimo, se zgenerira iz bannerIcon_128. If an error condition occurs, this will be notified using the error code. The error codes that can be used by developers are 0 and 20-30. NOTE that in this case, the server is actually responding, this is different than a HTTP 500 Error situation (server error). 0 = "ok". No error, data available in the other fields. 20-29, can be used to send back an message.The string of the error will be displayed as a message in the screen of the user. NOTE that this will only be displayed if this is the first page in the response, errors sent in any successive page will be ignored. 30, can be used to indicate that this layer requires authentication. When this error code is returned in getPOI response, the client should open the webview at the 'URL for layer settings page' defined by the layer. The error message associated with the error code above. For each error code, developers can return custom messages which will be shown to the user in the AR view. This message can help improve user experience especially when something went wrong or you expect users to perform other actions. For instance when you expect users to change filter settings in order to see more POIs. NOTE that the maximum length is 80 Characters. The key to the page being returned. Default value: null. The key to the page being returned in the following getPOIs request. Pass this key to the page parameter in the request if the next page is requested. Indicates whether more pages need to be retrieved. Default value: false. This parameter can be used to tell the service provider whether more pages need to be retrieved. Specifies the search radius when no radius value is present in the getPOIs request. Default value: NULL Instead of providing a fixed search range, developers can also return a radius value in the response to assure that certain POIs are presented to the user. This can be done by emptying the default value of the search range filter on the publishing site. NOTE that this parameter must be returned if the GetPOIs request doesn't contain a requested radius. It cannot be used to overrule a value of radius if that was provided in the request. the unit is meter. Indicates how many seconds to wait until the next getPOIs request is made. Default value: 300. This tells the layar client how many seconds to wait until the next getPOIs request is made. By default, it is 300s. The minimum value is 10s. The unique id which identifies a POI in the getPOIs response. This is used to track the POIs when refreshing the layer. Geografska širina. Geografska dolžina. Nadmorska višina. This is the first line in the BIW dialog on the client. It has larger font and uses the Banner text color defined under the "Look and feel" tab of the publishing site. The recommended maximum string length is 60 characters and it will be wrapped over 2 lines. Some text can be used to explain the POI. It has normal font and uses the BIW Text Color defined under the "Look and feel" tab of the publishing site. The recommended maximum string length is 140 characters and it will be wrapped over 3 lines. Samo 45 znakov dolg napis pod trivrstičnim opisom POI. V okviru providerINFO/layar/xml se lahko vpiše layar:footnote, ki bo veljal za vse POIs. Posameznem POI prilagojen individualni footnote se vpiše v POIs/poi layar:footnote The location of the image to be displayed inside the BIW. If the image is too large, it will be resized to fit within a bounding box of 100x75 pixels, preserving aspect ratio. NOTE: the image file size should be smaller than 100kb, otherwise, the image will not be loaded. The URL to send the request to. The possible URIs are "tel:", "sms:", "mailto:", "http://", "https://", "layar://" , "layarshare://" and custom app schemes. Regarding custom app schemes, on Android, we firstly detect whether the user has the corresponding app installed, if not, the action will not be shown. On iPhone, the action will be shown all the time. If the corresponding app is not installed, nothing will happen when clicking on the action. Therefore, it is not recommended to implement actions linking to custom app schemes if you are not sure that target user groups have already installed the app. Note that "rtsp://" is NOT supported. The following HTTP headers will always be sent: - Cookie (if a cookie has been set for the domain) - User-Agent: The Layar app User-Agent is sent if the request is from within the AR view (text/plain, audio/mpeg, audio/mp4, video/3gpp, video/mp4, application/vnd.layar.async). The web browser's User-Agent is sent if the request is from within a web view (text/html or application/vnd.layar.internal in combination with http:// or https:// protocols). The text displayed in the action button. The text will be displayed in the button corresponding to the action. The type of document that is being fetched. The request type, GET or POST. A list parameters can be added to the request. Comma-separated list of parameters to be added to the request: - For a GET request, the params will be added in the URL E.g. "lat=45.462&lon=2.42346&alt=560" - For a POST request, the params will be passed as URL-encoded parameters in the body of the response. Possible values: lat, lon, alt, lang, countryCode, localCountryCode, version. NOTE: countryCode is the home country of the user while localCountryCode is the country where the user is located at the moment. This determines which icon should be used if the action is displayed in a button. Layar provides a predefined set of icons that content authors can use. The icon will give the user good hint on the meaning of an action. Indicates whether to show the background activity. This tells the layar client whether or not to show the user that there is background activity to fetch the action result. This is useful mostly for autoTriggered actions where it may not always be good user experience to show something suddenly. The message shown while waiting for the activity response. Default value: NULL. This is shown to the user while waiting for the response, instead of the spinning wheel. Empty by default (spinning wheel shown by default). NOTE: this is only shown for actions that run in the background. The contentType should be text/plain or application/vnd.layar.async. Geo Layer Only: specifies whether BIW should be closed after clicking the action button. Default value: false. If true, the layar client will close the BIW after the user clicked the button of the action. This way, after the action has opened/played, the user returns in the POI view (AR, map, list) rather than in the BIW. he presence of this parameter indicates whether of not this action can be autotriggered by reaching the POI. Note that only one action can be auto-triggered, the layar client will use the first one in the array having this parameter. The parameter itself is the distance in m within which the user must be of the POI position in order for the auto-trigger to launch. NOTE: not included in the layer level Actions object defined in the JSON response. Indicates whether or not this action can be invoked manually. Default value: false. This indicates whether of not this action can also be invoked manually by the user outside of the range specified for a Geo POI or when a Vision POI is recognized. If true, the action will not be shown when pressing the button to display all possible actions, unless the user is within the give range of a Geo POI or a Vision POI is recognized. Placement of the POI. Can either be a geolocation or the key of a reference image in Layar Vision. For geolocation, alt is optional but lat and lon are mandatory. The geo location coordinates of a POI, alt is optional but lat and lon are mandatory. This enables actions on the POI level. Each POI can have its own actions. They will appear on the expanded BIW dialog.