Changed all property & signal names to lowerCamelCase
[platform/core/uifw/dali-toolkit.git] / docs / content / shared-javascript-and-cpp-documentation / script-json-specification.md
index 002eac7..f6887cb 100644 (file)
@@ -1,12 +1,13 @@
-/**
- *
+<!--
+/**-->
+
 [TOC]
 
 # DALi JSON Specification  {#script-json-specification}
 
 ## Overview {#overview}
 
-This document describes the Dali JSON specification.
+This document describes the DALi JSON specification.
 The format is not yet formally versioned within the JSON.
 
 # General format {#format}
@@ -26,10 +27,10 @@ The JSON format supports
 
 
 Concrete Actors and Controls can be created from types registered in the
-Dali Type Registry.
+DALi Type Registry.
 
 Template, style and scene sections all configure Actors and Controls via
-the Dali property system.
+the DALi property system.
 
 The JSON format deviates from the formal JSON specification and allows C style comments.
 
@@ -70,7 +71,7 @@ The JSON format deviates from the formal JSON specification and allows C style c
       "stage":                               // Stage section
       [                                      //
        {                                     // Actors|Controls to create on JSON file load
-       "type": "basic-text",                 // A Dali Control or a template name
+       "type": "basic-text",                 // A DALi Control or a template name
        "styles":["base-theme","light-theme"] // Style list to apply to this instance
        }                                     //
       ]                                      //
@@ -120,7 +121,7 @@ The constants section supports sub-string and full property replacement.
     },                                  //
     ...                                 //
     {                                   //
-      "type":"ImageActor"               // An Dali type or a template name
+      "type":"ImageActor"               // An DALi type or a template name
       "image":                          //
       {                                 //
         "filename":"{IMAGES}b.jpg"      // Image filename substring replacement
@@ -170,14 +171,14 @@ an optional actor sub hierarchy.
    {                                    //
    "basic-text":                        //  The template name
    {                                    //
-     "type":"ImageActor",               //  Concrete Dali Type/Class to create
+     "type":"ImageActor",               //  Concrete DALi Type/Class to create
      "styles":["base-style"],           //  Style list to apply
      "name":"image",                    //  }
      "image":                           //  } property name : value
      {                                  //  }
      "filename":"{IMAGES}/b.jpg"        //
      },                                 //
-     "parent-origin": "CENTER"          //
+     "parentOrigin": "CENTER"           //
      ...                                //
      "actors":                          //  A tree of sub actors
      [                                  //
@@ -185,7 +186,7 @@ an optional actor sub hierarchy.
      "type":"TextView"                  //
      "name":"text",                     //
      "text":"Hello World",              //
-     "parent-origin": "CENTER",         //
+     "parentOrigin": "CENTER",          //
      }                                  //
      ]                                  //
    }                                    //
@@ -193,7 +194,7 @@ an optional actor sub hierarchy.
 ~~~
 
 A template has a special 'type' property which must contain a concrete
-Dali Actor or Control type name.
+DALi Actor or Control type name.
 
 A template has a special 'styles' property which contains a list of
 styles to apply when creating using the template.
@@ -256,7 +257,7 @@ Builder.AnimateTo("light-theme", myActor, TimePeriod(0, 10));
 When applied to an actor tree the actors are referenced by name. Names
 are not unique in Dali.
 
-When a style is applied in code Dali will perform a depth first search
+When a style is applied in code DALi will perform a depth first search
 stopping with the first matching name.
 
 Typically an application developer will apply the style to the template
@@ -279,9 +280,9 @@ They can also be created automatically from JSON in an actor signal.
      {                                   //
      "duration": 10,                     // Duration in seconds
      "loop": false,                      // Whether to loop.
-     "end-action": "Bake",               // Whether to set final value(bake) or
+     "endAction": "Bake",                // Whether to set final value(bake) or
                                          // reset
-     "disconnect-aciton": "Discard",     // Whether 'Bake' or 'Discard' when disconnected
+     "disconnectAction": "Discard",      // Whether 'Bake' or 'Discard' when disconnected
      "properties":
      [
                                          // Properties changed in this animation
@@ -289,9 +290,9 @@ They can also be created automatically from JSON in an actor signal.
      "actor":"image",                    // Actor found by name from the stage
      "property":"rotation",              // Property to change
      "value":[0, 0.1, 0, 0],             // Value to set
-     "alpha-function": "EASE\_IN\_OUT",  // Interpolation function
+     "alphaFunction": "EASE\_IN\_OUT",   // Interpolation function
                                          //
-     "time-period":                      // Time period for change
+     "timePeriod":                       // Time period for change
      {"delay": 0,
       "duration": 3
       }
@@ -322,15 +323,15 @@ animation property.
        [190.0,-150.0,0.0]
       ],
                                          // curvature automatically creates
-     "curvature":0.35,                   // control-points
+     "curvature":0.35,                   // controlPoints
                                          //
-     "control-points": [...]             // Otherwise control-points can be
+     "controlPoints": [...]              // Otherwise controlPoints can be
                                          // directly specified.
      }                                   //
      },                                  //
     "animations":                        //
     {                                    //
-     "path-animation":
+     "pathAnimation":
      {
      "duration": 3.0,
      "properties":
@@ -341,8 +342,8 @@ animation property.
      "path":"path0",                     // animation.
      "forward":[1,0,0],                  // Forward vector specifies orientation
                                          // whilst travelling along the path
-     "alpha-function": "EASE\_IN\_OUT",  // (optional)
-     "time-period":
+     "alphaFunction": "EASE\_IN\_OUT",   // (optional)
+     "timePeriod":
      {
      "delay": 0,
      "duration": 3
@@ -372,7 +373,7 @@ be animated by one animation.
 
 ~~~
     {                                             //
-    "shader-effects":                             // Shader Effect section
+    "shaderEffects":                              // Shader Effect section
     {                                             //
       "myshader1":                                // Shader  instance  name
       {                                           //
@@ -382,10 +383,10 @@ be animated by one animation.
          "vertex":"",                             // Glsl vertex program
          "fragmentPrefix": "",
          "fragment": "",                          // Glsl fragment program.
-         "geometry-type": "GEOMETRY_TYPE_IMAGE",  // Geometry type(see DALi documentation)
+         "geometryType": "GEOMETRY_TYPE_IMAGE",   // Geometry type(see DALi documentation)
        },
-       "geometry-hints": "HINT_NONE":             // Geometry hints (see DALi documentation)
-       "grid-density": 0,                         // Grid density(see DALi documentation)
+       "geometryHints": "HINT_NONE":              // Geometry hints (see DALi documentation)
+       "gridDensity": 0,                          // Grid density(see DALi documentation)
        "image":
        {
          "filename": ""                           // Effect image available as a second texture unit.
@@ -439,7 +440,7 @@ uniforms with 'u'.
      ...
      ]
      },
-     "shader-effects":
+     "shaderEffects":
      {
      "myshader1":
      {
@@ -493,7 +494,7 @@ builder.addActors( dali.stage.getRootLayer() );
      {
      "type": "TextView",
                                          \\  The Type to create; this can be a
-     ...                                 \\ concrete Dali type (actor/control)
+     ...                                 \\ concrete DALi type (actor/control)
                                          \\ or a template name.
      "styles": ["base-style"]
                                          \\  A list of styles to apply to the