Difference between revisions of "Start Object"

From MSX - Wiki
Jump to navigation Jump to search
 
(9 intermediate revisions by the same user not shown)
Line 4: Line 4:
 
     "version": "1.0.0",
 
     "version": "1.0.0",
 
     "parameter": "menu:http://link.to.menu",
 
     "parameter": "menu:http://link.to.menu",
−
     "welcome": "none"
+
     "welcome": "none",
 +
    "launcher": {
 +
        "icon": "play-circle-outline",
 +
        "image": "none",
 +
        "color": "msx-black-soft"
 +
    }
 
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
Line 22: Line 27:
 
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 replace it with the entered server.
+
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 <code>{PREFIX}</code> (e.g. <code>menu:{PREFIX}link.to.menu</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 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>) 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> 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).'''
+
'''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 38: Line 43:
 
* <code>"start"</code>: Set welcome pages start action.
 
* <code>"start"</code>: Set welcome pages start action.
 
* <code>"content"</code>: Set welcome pages content.
 
* <code>"content"</code>: Set welcome pages content.
 +
|-
 +
| <code>launcher</code> || <code>object</code> || <code>null</code> || No || data-sort-value=164|'''0.1.164''' ||
 +
It is possible to add a <code>launcher</code> object (that can contain an <code>icon</code>, <code>image</code>, and/or <code>color</code> property) to change the appearance of the start parameter in the settings and setup completion panel. This object is compatible with the <code>launcher</code> object defined by the '''Launcher MSX''' service. For more information, please see [[Tips_%26_Tricks#Launcher_MSX]].
 
|}
 
|}
  

Latest revision as of 13:49, 25 March 2026

{    
    "name": "Start Parameter Name",
    "version": "1.0.0",
    "parameter": "menu:http://link.to.menu",
    "welcome": "none",
    "launcher": {
        "icon": "play-circle-outline",
        "image": "none",
        "color": "msx-black-soft"
    }
}
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 the string {SERVER} (e.g. menu:http://{SERVER}/msx/menu.json) to automatically replace it with the entered server.

Since version 0.1.97, you can also set a start parameter that contains the string {PREFIX} (e.g. menu:{PREFIX}link.to.menu or menu:{PREFIX}{SERVER}) to automatically replace it with 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 or redirect:{PREFIX}link.to.start.object or redirect:{PREFIX}{SERVER}/msx/start.php) 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. "menu:request:interaction:{DATA_ID}@{URL}").

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.
launcher object null No 0.1.164

It is possible to add a launcher object (that can contain an icon, image, and/or color property) to change the appearance of the start parameter in the settings and setup completion panel. This object is compatible with the launcher object defined by the Launcher MSX service. For more information, please see Tips_&_Tricks#Launcher_MSX.

See also[edit]

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