Difference between revisions of "Start Object"
(16 intermediate revisions by the same user not shown) | |||
Line 9: | Line 9: | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
+ | |+ Property syntax of start object | ||
|- | |- | ||
! Property !! Type !! Default Value !! Mandatory !! Since Version !! class="unsortable" | Description | ! Property !! Type !! Default Value !! Mandatory !! Since Version !! class="unsortable" | Description | ||
Line 21: | Line 22: | ||
The start parameter. This property specifies which menu or content is loaded at startup. It must start with <code>menu:</code> or <code>content:</code> to specify the JSON type. This property is mandatory, because without it, no start menu or content can be loaded. | The start parameter. This property specifies which menu or content is loaded at startup. It must start with <code>menu:</code> or <code>content:</code> to specify the JSON type. This property is mandatory, because without it, no start menu or content can be loaded. | ||
− | Since version '''0.1.97''', you can also set a start parameter that starts with <code>redirect:</code> (e.g. <code>redirect:http://link.to.start.object</code>) to load a start object from another location. | + | Since version '''0.1.65''', you can also set a start parameter that contains the string <code>{SERVER}</code> (e.g. <code>menu:http://{SERVER}/msx/menu.json</code>) to automatically replace it with the entered server. |
+ | |||
+ | Since version '''0.1.97''', you can also set a start parameter that contains the string <code>{PREFIX}</code> (e.g. <code>menu:{PREFIX}link.to.menu</code> or <code>menu:{PREFIX}{SERVER}</code>) to automatically replace it with the used prefix (i.e. <code>http://</code> or <code>https://</code>). | ||
+ | |||
+ | Since version '''0.1.97''', you can also set a start parameter that starts with <code>redirect:</code> (e.g. <code>redirect:http://link.to.start.object</code> or <code>redirect:{PREFIX}link.to.start.object</code> or <code>redirect:{PREFIX}{SERVER}/msx/start.php</code>) to load a start object from another location. | ||
+ | |||
+ | '''Note: Please note that the auto-replacement feature only works for the start parameter file, for the other JSON files, you must always indicate full URLs (to avoid errors in cross-references). Additionally, please note that it is also possible to indicate request actions instead of URLs (e.g. <code>"menu:request:interaction:{DATA_ID}@{URL}"</code>).''' | ||
Please see [[Menu Root Object]] and [[Content Root Object]] for the data structures. | Please see [[Menu Root Object]] and [[Content Root Object]] for the data structures. | ||
Line 32: | Line 39: | ||
* <code>"content"</code>: Set welcome pages content. | * <code>"content"</code>: Set welcome pages content. | ||
|} | |} | ||
+ | |||
+ | == See also == | ||
+ | * [[Setup Precondition]] | ||
+ | * [[Setup Start Parameter]] |
Latest revision as of 14:31, 23 April 2021
{
"name": "Start Parameter Name",
"version": "1.0.0",
"parameter": "menu:http://link.to.menu",
"welcome": "none"
}
Property | Type | Default Value | Mandatory | Since Version | Description |
---|---|---|---|---|---|
name |
string |
null |
Yes | 0.1.0 |
The name of the start parameter. This property is displayed at start parameter setup and should be used to show a short information about the start parameter (e.g. |
version |
string |
null |
Yes | 0.1.0 |
The version of the start parameter. This property is displayed at start parameter setup and should be used to show the current version of the start parameter (e.g. |
parameter |
string |
null |
Yes | 0.1.0 |
The start parameter. This property specifies which menu or content is loaded at startup. It must start with Since version 0.1.65, you can also set a start parameter that contains the string Since version 0.1.97, you can also set a start parameter that contains the string Since version 0.1.97, you can also set a start parameter that starts with Note: Please note that the auto-replacement feature only works for the start parameter file, for the other JSON files, you must always indicate full URLs (to avoid errors in cross-references). Additionally, please note that it is also possible to indicate request actions instead of URLs (e.g. Please see Menu Root Object and Content Root Object for the data structures. |
welcome |
string |
"none" |
No | 0.1.117 |
The welcome type of the start parameter. If this property is set to
|