Difference between revisions of "Start Object"

From MSX - Wiki
Jump to navigation Jump to search
Line 21: Line 21:
 
| <code>parameter</code> || <code>string</code> || <code>null</code> || '''Yes''' || data-sort-value=0|0.1.0 ||  
 
| <code>parameter</code> || <code>string</code> || <code>null</code> || '''Yes''' || data-sort-value=0|0.1.0 ||  
 
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.65''', you can also set a start parameter that contains <code>{SERVER}</code> (e.g. <code>menu:http://{SERVER}/path/to/menu</code>) to automatically insert the entered server.
 +
 +
Since version '''0.1.97''', you can also set a start parameter that contains <code>{PREFIX}</code> (e.g. <code>menu:{PREFIX}link.to.menu</code>) to automatically insert 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>) to load a start object from another location.
 
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.

Revision as of 17:34, 13 January 2021

{    
    "name": "Start Parameter Name",
    "version": "1.0.0",
    "parameter": "menu:http://link.to.menu",
    "welcome": "none"
}
Property syntax of start object
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. "My Last Holiday Trip"). This property is mandatory.

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. "1.0.0"). This property is mandatory.

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 menu: or content: to specify the JSON type. This property is mandatory, because without it, no start menu or content can be loaded.

Since version 0.1.65, you can also set a start parameter that contains {SERVER} (e.g. menu:http://{SERVER}/path/to/menu) to automatically insert the entered server.

Since version 0.1.97, you can also set a start parameter that contains {PREFIX} (e.g. menu:{PREFIX}link.to.menu) to automatically insert the used prefix (i.e. http:// or https://)

Since version 0.1.97, you can also set a start parameter that starts with redirect: (e.g. redirect:http://link.to.start.object) to load a start object from another location.

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 "start" or "content", the start parameter is also set as welcome pages in the settings (either as start action or content). If you want to manage various start parameters with a portal page (i.e. by using the start action), you can use this feature to keep the portal page available via the settings.

  • "none": Set no welcome pages (the current welcome pages are retained).
  • "start": Set welcome pages start action.
  • "content": Set welcome pages content.

See also[edit]

Retrieved from "https://msx.benzac.de/wiki/index.php?title=Start_Object&oldid=355"