Please NOTE that this documentation will not be updated anymore. Please see our new Developer Documentation Site for the latest updates! The content of this page can be found here.
|
In this section, we will explain how to create a layer on the publishing site.
After signing up to be a developer successfully, you should be given the right to access the publishing site. Once this is done, we can follow the 5 steps shown below to create a layer on the publishing site:
- Log in with layar account (https://www.layar.com/accounts/login). This layar account should be verified and with developer role enabled.
- Click on "My layers" button shown next to the user name on top right part of the page.
screenshot - after logged in
3. Get access to the publishing site environment and "layers" tab is shown by default.
screenshot - "layers" tab
4. Click on "Create a layer" button to open the layer creation form (see screenshot below)
screenshot - create a layer form
This form is used to define and create a layer on the publishing site. All these fields are mandatory. Except that layer name could not be renamed, other fields can be modified in layer editing afterwords.
The following table provides detailed explanation for these fields:
| Fields |
Required/
DefaultValue
|
Definition |
Tooltips |
Layer name
|
Mandatory
(could not be renamed)
|
• The name of the layer. Not publicized to the end-user of the Layar app.
• This is the key that is used for fetching information within the layer.
• And this is the name developers can use in their communication with Layar staff to identify their layer.
|
• The name must be lowercase alphanumeric, starting with a character
• Names must be unique
• Names can’t be edited once the layer is created
NOTE: The layername will appear in the URL to the layer under the "Layers" section. For instance, http://www.layar.com/layers/layername.
|
| Title |
Mandatory
|
The text to be displayed in the banner on the right and the title of the layer to be displayed in the layer list on the phone.
|
maximum 18 characters. |
| Publisher name |
Mandatory
|
Name of the publisher of the layer, is shown in the lists in the Layer Gallery.
|
By default, layer developer is also the publisher of this layer. Developer first name under account profile is pre-filled here. |
| Layer type |
Mandatory / 1
|
The type of layer, determining how the client should display the POIs: 1 = generic; 2= 2d and 3d objects in 3d space.
This will be used in the future to distinguish different types of layers.
|
• Generic 2D: Use this if you only use default POI icons or you have uploaded customized icon sets under Look & feel tab.
• 2D and 3D objects in 3D space: If you want to use 2D images or 3d models in 3D space.
|
| API endpoint URL |
Mandatory
|
• The URL for your web service that provides Spots.
NOTE that only ports 80 (http) and 443 (https) are supported, so URLs with additional port info won't work.
|
The URL should be of the form http://example.com/path/to/service
Please make sure that you are not using reserved parameters for Layar in API endpoint URL. (please see GetPOIs-Request ).
|
| Short description |
Mandatory
|
The short description of a layer, shown in the lists in the Layer Gallery on the phone.
|
A very short summary of your layer content with max. 60 characters including spaces. |
| Layar Vision |
Mandatory / disabled |
Enabling this option will allow you to create a layer with Layar Vision. please check out Layar Vision index page for more information. |
Please NOTE that Layar Vision is only available in Layar client v6.0 and above (on Android and iPhone) .
|
To get an idea on how they look like on the phone, please check the following screenshot:
5. After filling in all the information, click on "create layer" button. Layer is created and the layer editing page is shown. If Layar Vision is enabled, a "Layar Vision" tab will be added to the page.
screenshot - layer editing page
Click on "back to all layers", the new layer is shown in the layer list.
This is the end of this section. In next section - Edit a layer, we will further discuss how to customize your layer.
Comments (1)
Bruce said
at 1:54 am on Mar 14, 2011
how are the icons setup?
You don't have permission to comment on this page.