Editing XMBML Coding

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
== Basic XMBML Structure ==
[[Category:Software]]
This page outlines the logic behind [[XMB]] XML configuration files. For some practise usage see: [[XMBML Coding Examples]]
This page will outline the logic behind [[XMB]] .xml configuration files.  


This is a reduced version of [[XMB-Network | category_network.xml]] with only one icon (tex_browser) that launches the webbrowser (type:x-xmb/xmlwebbrowser). The .xml is loaded starting from <View id="root">, then inside the <Items> table there is a <Query> linking to #seg_browser (the character "#" links to a <View id> in the same file, so is linked to <View id="seg_browser">). When <View id="seg_browser"> is loaded first starts reading the table of <Items> that contains an <Item> that is linked using attr="browser" to a table of attributes <Table key="browser"
== Basic Structure ==
This is a reduced version of [[XMB-Network | category_network.xml]] with only one icon (tex_browser) that launches the webbrowser (type:x-xmb/xmlwebbrowser). The .xml is loaded starting from <View id="root">, then inside the <Items> table there is a <Query> linking to #seg_browser (the character "#" links to a <View id> in the same file, so is linked to <View id="seg_browser">). When <View id="seg_browser"> is loaded first starts reading the table of <Items> that contains an <Item> that is linked using attr="browser" to a table of attributes <Table key="browser"


{{Boxcode|code=<syntaxhighlight lang="xml">
{{Boxcode|content=<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>


Line 10: Line 11:
<View id="root">
<View id="root">
<Items>
<Items>
<Query class="type:x-xmb/folder-pixmap" key="seg_browser" src="#seg_browser"/>
<Query class="type:x-xmb/folder-pixmap" key="seg_browser" src="#seg_browser" />
</Items>
</Items>
</View>
</View>
Line 22: Line 23:
</Attributes>
</Attributes>
<Items>
<Items>
<Item class="type:x-xmb/xmlwebbrowser" key="browser" attr="browser"/>
<Item class="type:x-xmb/xmlwebbrowser" key="browser" attr="browser" />
</Items>
</Items>
</View>
</View>
Line 28: Line 29:
</syntaxhighlight>}}
</syntaxhighlight>}}


*The contents of the .xml file can be identifyed by the &lt;View id&gt; and &lt;key&gt; this way:
*The whole contents of the .xml file can be identifyed by the <View id> and <key> this way:
**&lt;View id="root"&gt; contains 1 &lt;Items&gt; with the key="seg_browser"
**<View id="root"> contains 1 <Items> with the key="seg_browser"
**&lt;View id="seg_browser"&gt; contains 1 &lt;Items&gt; with the key="browser"
**<View id="seg_browser"> contains 1 <Items> with the key="browser"


{{Boxcode|code=<syntaxhighlight lang="xml">
=== View id ===
<View id="root">
Must consist of UTF-8 characters and have no spaces. There must be no other entries with the same '''<View id>'''.
<Items>
<Query key="seg_browser"/>
</Items>
</View>
<View id="seg_browser">
<Attributes>
<Table key="browser">
</Table>
</Attributes>
<Items>
<Item key="browser"/>
</Items>
</View>
</syntaxhighlight>}}
*Note the "Pair key"'s inside "attributes tables" are not considered identifyers of the xml tag


=== View ID's (Enviroment ID's, and Segment ID's) ===
*There are some specific '''<View id>''' names that are placed at the top of the .xml and can be considered the "XMB enviroments" that can be loaded by [[VSH]]
Identifyers made of UTF-8 characters and without spaces. There are two types: Enviroments, and Segments
**'''"root", "root_for_dex", " tool_root", "shop_root", "shop_guest_root", "shop_staff_root", and "root_arcade"'''
**Are used to be able to load specific items for every [[Target ID]] or for loading items in specific conditions (e.g: is shop firmware "locked" or "unlocked" modes)


*'''Enviroments''' are reserved names (hardcoded in VSH?): '''"root", "root_info", "root_for_dex", "root_dex", "root_for_BDU", "root_power_only", "root_hide_friend", "tool_root", "shop_root", "shop_guest_root", "shop_staff_root", "root_arcade"''' and obsolete: '''"stage_demo_root", "xai_test_root", "store_root"'''
*A '''<View id>''' can load another '''<View id>''' from the same or other .xml file by making one of his '''<items>''' to point to the other '''<View id>'''
**Used to load specific XMB items for different PS3 types (retail, debug, etc...), or to load items in specific boot modes (e.g: in shop PS3's "locked" or "unlocked" modes), can be considered the [[XMB]] enviroments used by the [[XMB#XMB_Configuration_Files|XMB Configuration Files]]
**Links to a '''<View id>''' in the same .xml file can be considered "direct links" and uses the character "'''#'''" followed by the '''<View id>''' of the linked item (e.g: '''src="#seg_poweroff"''')
**Usually inside the .XML files there are several '''&lt;View id&gt;''' of this type starting with '''"root"''' (retail XMB) at the top, only one of them is loaded by [[VSH]] when the PS3 boots
**Links to a '''<View id>''' in another .xml file uses the '''localhost''' functions with the full path of the file followed by the character "'''#'''" and the '''<View id>''' of the linked item (e.g: '''src="xmb://localhost/dev_flash/vsh/resource/explore/xmb/category_user.xml#seg_poweroff"''')


*'''Segments''' are all the others with names starting with '''"seg_"''' (e.g: '''seg_'''gamedata, '''seg_'''gameexit, '''seg'''_manual, etc...). There must be no other segments with the same name in the same .XML file, but some segments used for common functions are repeated in different .XML files and uses the same segment name and key identifyer (e.g. the segment "seg_gameexit" containing an item with the key "gamexit" is repeated in 8 .XML files)
==== Items ====
**Segments are loaded by some '''query classes''' (inside '''&lt;items&gt;''' tables)  by making his '''"src"''' to point to the target segment. When the segment is in the same .XML file it works simply by "jumping" to another line of the same file. When the segment is in another .XML file first is needed to locate the target .XML file, and then the "jump" to the target segment
The contents of this sub group dictates what exists on the XMB when this entry is used. There can be more than one entry.
***Links to a segment in the same .XML file uses the character "'''#'''", and the name of the target segment (e.g: '''src="#seg_poweroff"''')
***Links to a segment in another .XML file uses the '''xmb://localhost/''' function with the path of the target file, the character "'''#'''", and the name of the target segment (e.g: '''src="xmb://localhost/dev_flash/vsh/resource/explore/xmb/category_user.xml#seg_poweroff"'''), or alternativelly the short path form replacing '''"dev_flash/vsh/resource/explore/"''' by '''"%flash/"''' (e.g: '''src="xmb://localhost/%flash/xmb/category_user.xml#seg_poweroff"''')
**Is posible to load the "root" view IDs of other file (e.g: '''src="xmb://localhost/%flash/xmb/category_user.xml#root"''')


=== Items (Query classes, and Item classes) ===
When creating a XMB entry, you must tell vsh.self and its modules what you want to do. And the first part of a <Items> sub-entry does just this by telling the PS3 the "class" of the entry in the form of either  "''<Item class=""''" or "''<Query class=""''" (in the case of "''<Query class=""''" can be used several times under the same <items> to perform group of actions). There are many acceptable values possible, here are some examples:
The contents of this sub group dictates what exists on the XMB when this entry is used. There can be more than one.
 
When creating a XMB entry, you must tell vsh.self and its modules what you want to do. And the first part of a &lt;Items&gt; sub-entry does just this by telling the PS3 the "class" of the entry in the form of either  "''&lt;Item class=""''" or "''&lt;Query class=""''" (in the case of "''&lt;Query class=""''" can be used several times under the same &lt;items&gt; to perform group of actions). There are many acceptable values possible, here are some examples:
 
{| class="wikitable"
|+Tags used by class/subclass
! Query classes x-xmb !! <key> !! <attr> !! <src> !! Remarks
|-
| <Query class="type:x-xmb/'''category'''" || {{Yes}} || {{Yes}} || {{Yes}} || Main/Root XMB
|-
| <Query class="type:x-xmb/'''folder-pixmap'''" || {{Yes}} || {{Yes}} || {{Yes}} || Has many uses see [[XMBML Functions|here]]
|-
| <Query class="type:x-xmb/'''xmlmcutility'''" || {{Yes}} || {{Yes}} || {{Yes}} || PS1 and PS2 virtual memory card utility
|-
| <Query class="type:x-xmb/'''xmlnpsignup'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Query class="type:x-xmb/'''xmlpackagefolder'''" || {{Yes}} || {{Yes}} || {{Yes}} || Used for installing package files
|-
| <Query class="type:x-xmb/'''xmlpsp2appdata'''" || {{Yes}} || {{Yes}} || {{No}} || PSVita application utility
|-
| <Query class="type:x-xmb/'''xmlsavedata-plus'''" || {{Yes}} || {{Yes}} || {{No}} || Online storage
|-
| <Query class="type:x-xmb/'''xmlsavedata-ps2'''" || {{Yes}} || {{Yes}} || {{No}} || Savedata utility PS2
|-
| <Query class="type:x-xmb/'''xmlsavedata-ps3'''" || {{Yes}} || {{Yes}} || {{No}} || Savedata utility PS3
|-
| <Query class="type:x-xmb/'''xmlsavedata-psp'''" || {{Yes}} || {{Yes}} || {{No}} || Savedata utility PSP
|-
! Query classes x-xcb !! <key> !! <attr> !! <src> !! Remarks
|-
| <Query class="type:x-xcb/'''game-debug'''" || {{Yes}} || {{Yes}} || {{No}} || /app_home/PS3_GAME/ link
|-
| <Query class="type:x-xcb/'''savedata-ps3'''" || {{Yes}} || {{Yes}} || {{No}} || PS3 new savedata
|-
| <Query class="type:x-xcb/'''savedata-psp'''" || {{Yes}} || {{Yes}} || {{No}} || PSP new savedata
|-
! Item classes x-xmb !! <key> !! <attr> !! <src> !! Remarks
|-
| <Item class="type:x-xmb/'''module-action'''" || {{Yes}} || {{Yes}} || {{No}} || Uses a particular module to support the XMB item. See [[XMBML module-action]] page
|-
| <Item class="type:x-xmb/'''vmc-new'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlbddatamgmt'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmleditingvideo'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlflashplayer'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlgameexit'''" || {{Yes}} || {{No}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlhakoniwa'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmliboard'''" || {{Yes}} || {{Yes}} || {{No}} || [[Widgets]] control (class not used over firmware 3.00)
|-
| <Item class="type:x-xmb/'''xmlmessagelist'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlnowplaying'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlnpsignup'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlplaylist'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlplus'''" || {{Yes}} || {{No}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlpoweroff'''" || {{Yes}} || {{No}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlpremo'''" || {{Yes}} || {{No}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlpsp2appdata-cont'''" || {{Yes}} || {{Yes}} || {{No}} || PSVita Applications (PSVita, PSP, PS1, PSMobile)
|-
| <Item class="type:x-xmb/'''xmlscreenshot'''" || {{Yes}} || {{No}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlsysconf'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmltrophy'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlwebbrowser'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
| <Item class="type:x-xmb/'''xmlwelcome'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
! Item classes x-chat !! <key> !! <attr> !! <src> !! Remarks
|-
| <Item class="type:x-chat/'''xmlchatroom-manager'''" || {{Yes}} || {{Yes}} || {{No}} ||
|-
|}


<div style="height:200px; overflow:auto">
{| class="wikitable"
{| class="wikitable"
|+Unknown usage
|+A table with the types of <Items> sub-entries and what sections of a <Items> sub-entry they can/must use
! Unknown classes !! <key> !! <attr> !! <src> !! Remarks
! Class !! Entry Identification !! <key> !! <attr> !! <src> !! <Attributes> !! Remarks
|-
| x-xcb/'''achbase''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''achievtitle''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''achievgroup''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''achievflag''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''friendachievtitle''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''friendachievgroup''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''friendachievflag''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''blockedplayer''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''directory''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''directory-bddata''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''directory-generic''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''directory-photo''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''directory-music''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''directory-video''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''unknown''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-xcb/'''message''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''person''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''playedplayer''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''psv''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''savedata-ps1''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''savedata-ps2''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''savedata-ps3delegate''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''savedata-plus''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''savedata-pspdir''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''segment''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storage-media''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-xcb/'''storagemedia-cdda''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-sacd''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-psmc''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-psv''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-sdps3''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-sdpsp''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-sdpsp2''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-dlna''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-xcb/'''storagemedia-avchd''' || ? || ? || ? || found inside explore_plugin.sprx
|-
|-
| x-xcb/'''storagemedia-bdc''' || ? || ? || ? || found inside explore_plugin.sprx
! rowspan="5" | Query class
| <Query class="type:x-xmb/folder-pixmap" || {{Yes}} || {{Opt}} || {{Yes}} || {{Opt}} || Has many uses see [[XMB modding|here]]
|-
|-
| x-xcb/'''storagemedia-generic''' || ? || ? || ? || found inside explore_plugin.sprx
| <Query class="type:x-xmb/xmlpackagefolder" || {{Yes}} || {{Opt}} || {{Yes}} || {{Yes}} || Used for installing package files
|-
|-
| x-xcb/'''storagemedia-videodisc''' || ? || ? || ? || found inside explore_plugin.sprx
| <Query class="type:x-xmb/xmlmcutility" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''game-disc''' || ? || ? || ? || found inside explore_category_game.sprx
| <Query class="type:x-xmb/xmlsavedata-ps3" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''game''' || ? || ? || ? || found inside explore_category_game.sprx
| <Query class="type:x-xmb/xmlsavedata-psp" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''game-list''' || ? || ? || ? || found inside explore_category_game.sprx
! rowspan="18" | Item class
| <Item class="type:x-xmb/module-action" || {{Yes}} || {{Yes}} || {{No}} || {{Yes}} || Uses a particular module to support the XMB item, see the [[VSH:Module-Action|Module-Action list]]
|-
|-
| x-xcb/'''content-disc''' || ? || ? || ? || found inside explore_category_game.sprx
| <Item class="type:x-xmb/xmlpoweroff" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''music''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-xmb/xmlsysconf" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''music-list''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-xmb/xmlplaylist" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''photo''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-xmb/xmlhakoniwa" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''photo-list''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-xmb/xmlscreenshot" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''query-condition''' || ? || ? || ? || found inside explore_category_game.sprx
| <Item class="type:x-xmb/xmlgameexit" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''video''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-xmb/xmlnowplaying" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''video-content''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-xmb/xmlbddatamgmt" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''video-list''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-xmb/xmleditingvideo" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''video-file''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-xmb/xmlwelcome" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''video-disctitle''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-xmb/xmltrophy" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''vmc''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-xmb/vmc-new" || ? || ? || ? || ? ||  
|-
|-
| x-xcb/'''vmc-new''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-xmb/xmlpremo" || ? || ? || ? || ? ||  
|-
|-
| x-xmb/'''xmlchannel''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-xmb/xmlwebbrowser" || ? || ? || ? || ? ||  
|-
|-
| x-xmb/'''xmlpsp2appdata-cont''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-xmb/xmlnpsignup" || ? || ? || ? || ? ||  
|-
|-
| x-xmb/'''xmlscenefolder''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-chat/xmlchatroom-manager" || ? || ? || ? || ? ||  
|-
|-
| x-xmb/'''xmlvideodownloader''' || ? || ? || ? || found inside explore_plugin.sprx
| <Item class="type:x-xmb/xmlmessagelist" || ? || ? || ? || ? ||  
|-
| x-xmb/'''unknown''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-xil/'''xilitem''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-ese/'''task''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-ese/'''dlctl''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-sel/'''registory-accessor''' || ? || ? || ? || found inside explore_category_game.sprx
|-
| x-user/'''user''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-host/'''unknown''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-host/'''mount-info''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-host/'''directory''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-host/'''file''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-host/'''package''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-host/'''theme-content''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-host/'''ps2_newsavedata''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-chat/'''room''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-chat/'''player''' || ? || ? || ? || found inside explore_plugin.sprx
|-
| x-chat/'''xmlchatroom-manager''' || ? || ? || ? || found inside explore_plugin.sprx
|-
|-
|}
|}
</div>


*'''&lt;key&gt;'''
*'''<key>'''
**Used to identify the sub-entry inside '''&lt;Items&gt;''' tables (usually the same value as '''&lt;attr&gt;''' and the '''&lt;Table key&gt;''' associated if present)
**Used to identify the sub-entry which can also be used link attributes(see below)
**Example: '''key="my_icon"'''
**Example: '''key="gamedata"'''


*'''&lt;attr&gt;'''
*'''<attr>'''
**Used to link &lt;Items&gt; to a table of attributes with the same name '''&lt;Table key&gt;''' inside '''&lt;Attributes&gt;'''
**Used to ? (generally the same value as 'key')
**Example: '''attr="my_icon_metadata"'''
**Example: '''attr="gamedata"'''


*'''&lt;src&gt;'''
*'''<src>'''
**Used to link to other xml files or utilise a XMB database functions (see [[XMB database]])
**Used to link to other xml files or utilise a XMB database functions (see [[XMB database]])
**Refer to another XMB entry inside the current xml file. Example: '''src="#seg_package_files"'''
**Refer to another XMB entry inside the current xml file. Example: '''src="#seg_package_files"'''
Line 320: Line 117:
**Use a XMB database function. Example: '''src="xcb://localhost/query?table=MMS_MEDIA_TYPE_SYSTEM&genre=Music&sort=+StorageMedia:Common.titleForSort&cond=Ae+StorageMedia:StorageMedia.type %xCB_MEDIA_TYPE_DLNA"'''
**Use a XMB database function. Example: '''src="xcb://localhost/query?table=MMS_MEDIA_TYPE_SYSTEM&genre=Music&sort=+StorageMedia:Common.titleForSort&cond=Ae+StorageMedia:StorageMedia.type %xCB_MEDIA_TYPE_DLNA"'''


=== Attributes (Pairs) ===
==== Attributes ====
This provides additional information about '''&lt;Items&gt;''' sub-entries by linking them to a table with attributes associated (is optionall, not all &lt;Items&gt; requires attributes), this tables uses a '''&lt;Table key&gt;''' matching the '''&lt;attr&gt;''' sub-entry asociated and contains one or more attributes separated in lines starting with '''&lt;Pair key&gt;'''.
This provides additional information about the <Items> sub-entries. For each <Items> sub-entry there '''can'''(not all <Items> sub-entries requires attributes) be attributes assigned, each in its own table with an 'key' matching the <Items> sub-entry. The number of attribute sub-entries within a table varies depending on the <Items> sub-entry.


{| class="wikitable" style="font-size:x-small;"
A table of usable attributes and what <Items> sub-entries they '''can''' be used with:
|+Attributes used in official XMB, ordered by classes
! &lt;Attributes&gt; !! colspan="28" | &lt;Items&gt; !! rowspan="4" | Examples
|-
! &lt;Table !! colspan="12" | &lt;Query class="type: !! colspan="16" | &lt;Item class="type:
|-
! rowspan="2" | &lt;Pair key= !! colspan="9" | x-xmb/ !! colspan="3" | x-xcb/ !! colspan="15" | x-xmb/ !! x-chat/
|-
! <abbr title="folder-pixmap">folder<BR />pixmap</abbr> !! <abbr title="xmlmcutility">mc<BR />utility</abbr> !! <abbr title="xmlnpsignup">np<BR />signup</abbr> !! <abbr title="xmlpackagefolder">pkg<BR />folder</abbr> !! <abbr title="xmlpsp2appdata">vita<BR />apps</abbr> !! <abbr title="xmlsavedata-plus">save<BR />plus</abbr> !! <abbr title="xmlsavedata-ps2">save<BR />ps2</abbr> !! <abbr title="xmlsavedata-ps3">save<BR />ps3</abbr> !! <abbr title="xmlsavedata-psp">save<BR />psp</abbr> !! <abbr title="game-debug">game<BR />debug</abbr> !! <abbr title="savedata-ps3">save<BR />ps3</abbr> !! <abbr title="savedata-psp">save<BR />psp</abbr> !! <abbr title="module-action">module<BR />action</abbr> !! <abbr title="vmc-new">vmc<BR />new</abbr> !! <abbr title="xmlbddatamgmt">bddata<BR />mgmt</abbr> !! <abbr title="xmleditingvideo">edit<BR />video</abbr> !! <abbr title="xmlhakoniwa">hako<BR />niwa</abbr> !! <abbr title="xmliboard">info<BR />board</abbr> !! <abbr title="xmlmessagelist">msg<BR />list</abbr> !! <abbr title="xmlnowplaying">now<BR />playing</abbr> !! <abbr title="xmlnpsignup">np<BR />signup</abbr> !! <abbr title="xmlplaylist">play<BR />list</abbr> !! <abbr title="xmlpsp2appdata-cont">vita<BR />apps</abbr> !! <abbr title="xmlsysconf">sys<BR />conf</abbr> !! <abbr title="xmltrophy">trophy</abbr> !! <abbr title="xmlwebbrowser">browser</abbr> !! <abbr title="xmlwelcome">welcome</abbr> !! <abbr title="xmlchatroom-manager">chat<BR />room</abbr>
|-
| action
| {{Yes}} || {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}}
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "exec_game", etc... (see table below)
|-
| bar_action
| {{No}} || ? || ? || {{No}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || {{Yes}} || ? || ? || ?
| ?
| "none", "hide", "game_pspemu_viewmode", "game_pspemu_3d", "game_psemu_upcon", "game_psemu_smooth", "pad_assign", "pad_vibration", "bt_device_utility", "audio_setting", "voice_changer", "net_netlist"
|-
| connection
| ? || ? || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}}
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "xcb://localhost/query?..."
|-
| cf_connection
| ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "xcb://localhost/query?..."
|-
| ch_pos
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "1"
|-
| child
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{No}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "segment", "grid", "Video"
|-
| content_id
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ?
| ?
| "IP9100-NPIA00002_00-0000111122223333"
|-
| content_info_pict
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "/dev_flash/vsh/resource/explore/icon/pstex01.png"
|-
| content_info_pict_sd
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "/dev_flash/vsh/resource/explore/icon/pstex-sd.png"
|-
| content_info_tex
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "msg_ps3_portal"
|-
| content_info_title
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "msg_psstore_explanation_hd"
|-
| content_info_title_sd
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "msg_psstore_explanation_sd"
|-
| content_name
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ?
| ?
| "msg_title_lwp", "msg_information_board"
|-
| content_type
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}}
| ?
| "game", "video", "tv"
|-
| custom_priority
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "game=-80", "video=-80", "tv=-80"
|-
| data_connection
| ? || ? || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}}
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ?
| ?
| "xcb://localhost/query?..."
|-
| device_path
| {{yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "/dev_hdd0"
|-
| fo_lbl_alpha
| {{Yes}} || {{Yes}} || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "0" - float number
|-
| fo_lbl2_alpha
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "0" - float number
|-
| focus
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ?
| ?
| "last"
|-
| focus_detect
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "enable"
|-
| focus_priority
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "-5", "-4", "-3", "-2", "-1", "0", "1", "2", "3", "4", "5", "6". "-50", "-49", "-48", "-47", "-46". "-80"
|-
| fs_path
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "/dev_hdd0/widget/npdrm/informationboard"
|-
| genre
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || {{yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "BdData"
|-
| icon
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "/dev_hdd0/myicon.png"
|-
| icon_fixed_height
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "181"
|-
| icon_fixed_width
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "181"
|-
| icon_notation
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? || {{Yes}} || ?
| {{Yes}}
| "WNT_XmbItemAlbum", etc... (see table below)
|-
| icon_rsc
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}} || ? || ? || ? || ? || {{Yes}} || {{Yes}} || ?
| {{Yes}}
| "tex_album_icon"
|-
| id
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ?
| ?
|-
| info
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || {{Yes}} || ? || ? ||  ? || ? || ? || ?
| ?
| "This is a cool plain text info string"
|-
| info_rsc
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "item_tex_cam_icon"
|-
| ingame
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{No}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "enable", "disable"
|-
| instruction_rsc
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ?
| ?
| "msg_lwp_explanation"
|-
| item_type
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "systop"
|-
| lbl_half
| {{No}} || ? || ? || {{No}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "1"
|-
| logical_sceme
| {{yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "Music", "Photo", "Video"
|-
| mass_connection
| ? || ? || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}}
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "xcb://localhost/query?..."
|-
| mode
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || {{yes}} || {{yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ?
| "common", "mgmt", "playlistmgmt", "playlistmgmtpsp", "playlistempty"
|-
| module_action
| {{No}} || ? || ? || {{No}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "NotifyErrorNoExecute", "http://m.facebook.com", 0, 1
|-
| module_name
| {{No}} || ? || ? || {{No}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "explore_plugin", "webbrowser_plugin"
|-
| ms_connection
| ? || ? || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}}
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "xcb://localhost/query?..."
|-
| name
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "Flash Player[test.swf]"
|-
| path
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ?
| "flash0/vsh/resource/flash/test.swf"
|-
| pkg_src
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ?
| ?
| "http://dL-REGION01.ps3.download.playstation.net/.../lwp.pkg"
|-
| pkg_src_qa
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ?
| ?
| ?
|-
| prod_pic_path
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ?
| ?
| "/dev_flash/vsh/resource/explore/icon/fah-xmb.png"
|-
| sd_connection
| ? || ? || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}}
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "xcb://localhost/query?..."
|-
| start_factory_play
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "disable"
|-
| str_noitem
| {{Yes}} || ? || ? || {{No}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{No}} || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "msg_error_no_file", any message text from explore_plugin rco works
|-
| title
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || ? || ? || ? || ?
| ?
| "Debug Settings"
|-
| title_fo
| {{Yes}} || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "1"
|-
| title_rsc
| {{Yes}} || ? || ? || {{Yes}} || ? || ? || ? || ? || ?
| ? || ? || ?
| {{Yes}} || ? || ? || ? || ? || ? || {{Yes}} || ? || ? || ? || {{Yes}} || ? || {{Yes}} || {{Yes}} || ?
| {{Yes}}
| "msg_tool_app_home_ps3_game"
|-
| type
| ? || ? || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || {{yes}} || ? || ? || ? || ? || ? || {{Yes}} || {{Yes}} || ? || ? || ? || ?
| ?
| "photo", "music", "video"
|-
| vmc
| ? || {{Yes}} || ? || ? || ? || ? || ? || ? || ?
| ? || ? || ?
| ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ? || ?
| ?
| "promote"
|-
|}
 
*Official are marked as "Yes"
*Unnofficial and working are marked as "Opt"
*Unnofficial and not working are marked as "No"
 
----


'''action'''.
{| class="wikitable"
{| class="wikitable"
|+action
! action !! usage
|-
|-
| exec_game || ps3 gamedata
! rowspan="2" | Pair Key !! rowspan="2" | Use !! colspan="3" | Used by class type: !! Example(s)
|-
|-
| exec_vmcsavedata || ps1/ps2 savedata
! x-xmb/folder-pixmap !! x-xmb/module-action !! x-xmb/xmlpackagefolder
|-
|-
| exec_ps3savedata || ps3 savedata
| icon_rsc || displays a .rco referable image as XMB icon. Cannot be used at the same time as 'icon'. || {{Yes}} || {{Yes}} || {{Yes}} || "tex_album_icon"
|-
|-
| exec_pspsavedata || psp savedata
| icon || displays a .png image from an absolute path as XMB icon. Cannot be used at the same time as 'icon_rsc'. || {{Yes}} || {{Yes}} || {{Yes}} || "/dev_hdd0/game/XMBMANPLS/USRDIR/IMAGES/filemanager.png"
|-
|-
| exec_psp2appdata || psvita utility
| icon_notation || tells the XMB how to treat the icon (transparency etc.) by refering to the relevant .rco. Can in some cases override 'icon' or 'icon_rsc' || {{Yes}} || {{Yes}} || {{Yes}} || "WNT_XmbItemSavePS3"
|-
|-
| exec_sdps2 || ps2 savedata
| title_rsc || displays XMB main title text referred from relevant .rco. Cannot be used at the same time as 'title'. || {{Yes}} || {{Yes}} || {{Yes}} || "msg_tool_app_home_ps3_game"
|}
 
'''child'''. Tells the PS3 what action should be taken when the XMB item is selected.
 
'''focus_detect'''. Tells the PS3 to focus on the item if it is activated/used(like inserting a PS3 game disc). Of course the vsh.self has the final say on whether it is used (turning off auto boot)
 
'''focus_priority'''. Tells the PS3 the order in which the XMB items are loaded. This is used more by XMB items on the root of the XMB.
 
'''icon'''. Displays a .png image from an absolute path as XMB icon. Cannot be used at the same time as 'icon_rsc'
 
'''icon_notation'''. Tells the XMB how to display the icon layout (transparency etc). Can in some cases override 'icon' or 'icon_rsc'
 
{| class="wikitable"
|+icon_notation
! icon_notation !! Use !! Notes
|-
| WNT_XmbItemAlbum || || overrides 'icon_rsc'
|-
| WNT_XmbItemBrowser || || overrides 'icon_rsc'
|-
|-
| WNT_XmbItemChat || ||  
| title || displays XMB main title from plain text input. Cannot be used at the same time as 'title_rsc'. || {{Yes}} || {{Yes}} || {{Yes}} || "Debug Settings"
|-
|-
| WNT_XmbItemChatRoomText || ||  
| info_rsc || displays XMB title information from relevant .rco. This is shown below the 'title' or 'title_rsc' entry ins a smaller font. Cannot be used at the same time as 'info'. || {{Yes}} || {{Yes}} || {{Yes}} || "item_tex_cam_icon"
|-
|-
| WNT_XmbItemFriendAccountManagement || ||  
| info || displays XMB title information from plain text input. This is shown below the 'title' or 'title_rsc' entry ins a smaller font. Cannot be used at the same time as 'info_rsc'. || {{Yes}} || {{Yes}} || {{Yes}} || "This is a cool plain text info string"
|-
|-
| WNT_XmbItemFriendAdd || ||  
| child || tells the PS3 what action should be taken when the XMB item is selected. || {{Yes}} || {{No}} || {{Yes}} || "segment"
|-
|-
| WNT_XmbItemFriendBlock || ||  
| ingame || tells the PS3 if the item can be accessed ingame. || {{Yes}} || {{No}} || {{Yes}} || "enable"/"disable"
|-
|-
| WNT_XmbItemFriendMessageBox || ||  
| str_noitem || displays information from relevant .rco when no data/XMB items are found from then search function of the current XMB item. || {{Yes}} || {{No}} || {{No}} || "msg_error_no_gamedata"
|-
|-
| WNT_XmbItemFriendMessageBoxReceived || ||  
| module_name || the name of the module to be used from this [[VSH:Module-Action|list]] || {{No}} || {{Yes}} || {{No}} || "webbrowser_plugin"/"explore_plugin"
|-
|-
| WNT_XmbItemFriendMessageBoxSent || ||  
| module_action || what the module is commanded to use. The example commands are in respect the above modules || {{No}} || {{Yes}} || {{No}} || "http://m.facebook.com"/"NotifyErrorNoExecute"
|-
|-
| WNT_XmbItemFriendMessageCreate || ||  
| bar_action || ? || {{No}} || {{Yes}} || {{No}} || "none"
|-
|-
| WNT_XmbItemFriendPlayer || ||  
| lbl_half || ? || {{No}} || {{Yes}} || {{No}} || "1"
|-
|-
| WNT_XmbItemInetSearch || ||  
| focus_detect || tells the PS3 to focus on the item if it is activated/utilised (like inserting a PS3 game disc). Of course the vsh.self has the final say on whether it is used (turning off auto boot) || {{Yes}} || {{Yes}} || {{Yes}} || "enable"
|-
|-
| WNT_XmbItemMediaServerSearch || ||  
| focus_priority || tells the PS3 the order in which the XMB items are loaded. This is use more by XMB items on the root of the XMB. || {{Yes}} || {{Yes}} || {{Yes}} || any integer
|-
|-
| WNT_XmbItemOnlineManual || ||  
| fo_lbl2_alpha || ? || {{Yes}} || ? || ? || "0"
|-
|-
| WNT_XmbItemPRemo || ||  
| item_type || ? || {{Yes}} || ? || ? || "systop"
|-
|-
| WNT_XmbItemPlaylist || || overrides 'icon_rsc'
| ch_pos || ? || {{Yes}} || ? || ? || "1"
|-
| WNT_XmbItemPlaylistAdd || ||  
|-
| WNT_XmbItemPowerOff || ||
|-
| WNT_XmbItemSavePS12 || ||
|-
| WNT_XmbItemSavePS3 || ||
|-
| WNT_XmbItemSavedataMinis || ||
|-
| WNT_XmbItemTrophy || ||
|-
| WNT_XmbItemUser || ||
|-
| WNT_XmbItemVideoNew || ||
|-
| WNT_XmbListMusic || || overrides 'icon_rsc'
|-
| WNT_XmbListPhoto || || overrides 'icon_rsc'
|-
| WNT_XmbListVideo || || overrides 'icon_rsc'
|-
|-
|}
|}


'''icon_rsc'''. Displays an image from a .rco as XMB icon. Cannot be used at the same time as 'icon'
*Others not in the table:
**In category_photo.xml
***class="type:x-xmb/xmlplaylist" - <Pair key="mode"><String>playlistmgmt</String></Pair>
***class="type:x-xmb/xmlplaylist" - <Pair key="type"><String>photo</String></Pair>
***class="type:x-xmb/xmlplaylist" - <Pair key="id"><String></String></Pair>
***class="type:x-xmb/xmlplaylist" - <Pair key="path"><String></String></Pair>
**In category_music.xml
***class="type:x-xmb/xmlplaylist" - <Pair key="type"><String>music</String></Pair>
**In category_video.xml
***class="type:x-xmb/folder-pixmap" - <Pair key="custom_priority"><String>video=-80</String></Pair>
**In category_game.xml
***class="type:x-xmb/folder-pixmap" - <Pair key="custom_priority"><String>game=-80</String></Pair>
***class="type:x-xmb/folder-pixmap" - <Pair key="action"><String>exec_game</String></Pair>
***class="type:x-xmb/xmlmcutility" - <Pair key="action"><String>exec_vmcsavedata</String></Pair>
***class="type:x-xmb/xmlmcutility" - <Pair key="vmc"><String>promote</String></Pair>
***class="type:x-xmb/xmlsavedata-ps3" - <Pair key="action"><String>exec_ps3savedata</String></Pair>
***class="type:x-xmb/xmlsavedata-ps3" - <Pair key="ms_connection"><String>xcb://localhost/query?... (too long for wiki)
***class="type:x-xmb/xmlsavedata-ps3" - <Pair key="sd_connection"><String>xcb://localhost/query?... (too long for wiki)
***class="type:x-xmb/xmlsavedata-ps3" - <Pair key="cf_connection"><String>xcb://localhost/query?... (too long for wiki)
***class="type:x-xmb/xmlsavedata-ps3" - <Pair key="mass_connection"><String>xcb://localhost/query?... (too long for wiki)
***class="type:x-xmb/xmlsavedata-ps3" - <Pair key="data_connection"><String>xcb://localhost/query?... (too long for wiki)
***class="type:x-xmb/xmlsavedata-psp" - <Pair key="action"><String>exec_pspsavedata</String></Pair>
***class="type:x-xmb/xmlsavedata-psp" - (same xcb querys than above for: ms, sd, cf, mass, data)
***class="type:x-xmb/xmltrophy" - <Pair key="data_connection"><String>xcb://localhost/query?limit=2048</String></Pair>
***class="type:x-xmb/xmlwelcome" - <Pair key="content_type"><String>game</String></Pair>
***class="type:x-xmb/xmlnpsignup" - Pair key="info"><String>net_package_install_with_eula</String></Pair>
***class="type:x-xmb/xmlnpsignup" - <Pair key="pkg_src"><String>http://dL-REGION01.ps3.download.playstation.net/download/ps3/L-REGION/lwp/lwp.pkg</String></Pair>
***class="type:x-xmb/xmlnpsignup" - <Pair key="content_name"><String>msg_title_lwp</String></Pair>
***class="type:x-xmb/xmlnpsignup" - <Pair key="content_id"><String>IP9100-NPIA00002_00-0000111122223333</String></Pair>
***class="type:x-xmb/xmlnpsignup" - <Pair key="instruction_rsc"><String>msg_lwp_explanation</String></Pair>
***class="type:x-xmb/xmlnpsignup" - <Pair key="prod_pict_path"><String>/dev_flash/vsh/resource/explore/icon/fah-xmb.png</String></Pair>
***class="type:x-xmb/xmlnpsignup" - <Pair key="focus"><String>last</String></Pair>
**In category_psn.xml
***class="type:x-xmb/xmlnpsignup" - <Pair key="content_info_text"><String>msg_ps3_portal</String></Pair>
***class="type:x-xmb/xmlnpsignup" - <Pair key="content_info_title"><String>msg_psstore_explanation_hd</String></Pair>
***class="type:x-xmb/xmlnpsignup" - <Pair key="content_info_title_sd"><String>msg_psstore_explanation_sd</String></Pair>
***class="type:x-xmb/xmlnpsignup" - <Pair key="content_info_pict"><String>/dev_flash/vsh/resource/explore/icon/pstex01.png</String></Pair>
***class="type:x-xmb/xmlnpsignup" - <Pair key="content_info_pict_sd"><String>/dev_flash/vsh/resource/explore/icon/pstex-sd.png</String></Pair>
**In category_friend.xml
***class="type:x-xmb/folder-pixmap" - <Pair key="title_fo"><String>1</String></Pair>
***class="type:x-xmb/module-action" - <Pair key="start_factor_play"><String>disable</String></Pair>


'''info'''. Displays XMB title information from plain text input. This is shown below the 'title' or 'title_rsc' entry in a smaller font
== Examples ==


'''info_rsc'''. Displays XMB title information from relevant .rco. This is shown below the 'title' or 'title_rsc' entry in a smaller font
=== An XMB item tree ===
For this we will make a XMB item which will act as a folder opening up into 3 other XMB items.


'''ingame''' Use: tells the PS3 if the item can be accessed ingame
1/ First create the root XMB item which acts as a folder
 
{{Boxcode|content=<syntaxhighlight lang="xml">
'''mode'''.
<View id="XMB_Folder_1">
{| class="wikitable"
<Attributes>
|+mode
<Table key="xmb_folder">
! mode !! usage
<Pair key="icon_rsc"><String>tex_album_icon</String></Pair>
|-
<Pair key="title"><String>XMB Menu Item</String></Pair>
| common ||
<Pair key="info"><String>This will subdivide into 3 items :)</String></Pair>
|-
<Pair key="child"><String>segment</String></Pair>
| mgmt ||
</Table>
|-
</Attributes>
| playlistmgmt ||
<Items>
|-
<Query class="type:x-xmb/folder-pixmap"  key="xmb_folder" attr="xmb_folder" src="#XMB_Folder_1_container" />
| playlistmgmtpsp ||
</Items>
|-
</View>
| playlistempty ||
</syntaxhighlight>}}
|}
Important Notes:
* I've used "''<Query class="type:x-xmb/folder-pixmap"''" for <Items> sub-entry type as it is good for displaying menus.
* The 'key' in the <Items> sub-entry (xmb_folder) is the same as the table key in Attibutes, so those attributes are assigned to the xmb_folder <Items> sub-entry.
* the 'src' is pointing to 'XMB_Folder_1_container' - the another XMB .xml entry in the current .xml
* the icon is from a .rco file and is a basic folder icon, like what the 'Game Data' XMB item uses
* 'title' and 'info' are in plain text
* 'child' is set as 'segment' so the XMB knows this item will subdivide into other XMB items


'''module_action'''. Is the commanded to be used by the module
In order to create a working XMB sub menu the root xmb item (in this "XMB_Folder_1") must have its 'src' linking to a "container" (its the best way to think about it) and not directly linking to XMB items in the sub menu.( If you do not do this when you select your root XMB item to display a sub menu, the 'output' or 'action' of the XMB items of the sub menu will be shown rather than the actual XMB items):


'''module_name''' Use: the name of the module to be used from the [[XMBML module-action]] list
{{Boxcode|content=<syntaxhighlight lang="xml">
<View id="XMB_Folder_1_container">
<Items>
<Query class="type:x-xmb/folder-pixmap"  key="xmb_folder" attr="xmb_folder" src="#XMB_Folder_1_contents" />
</Items>
</View>
</syntaxhighlight>}}
Important Notes:
* This has no attributes as it simply acts as a contents container/linker


'''str_noitem'''. Displays information from relevant .rco when no data/XMB items are found
Now to create the XMB .xml entry which holds the sub menu items:


'''title'''. Displays XMB main title from plain text input. Cannot be used at the same time as 'title_rsc'
{{Boxcode|content=<syntaxhighlight lang="xml">
<View id="XMB_Folder_1_contents">
<Attributes>
<Table key="xmb_subitem_1">
<Pair key="icon_rsc"><String>tex_album_icon</String></Pair>
<Pair key="title"><String>XMB Sub Menu Item</String></Pair>
<Pair key="info"><String>Dummy Sub item 1</String></Pair>
<Pair key="str_noitem"><String>msg_error_no_gamedata</String></Pair>
</Table>
<Table key="xmb_subitem_2">
<Pair key="icon_rsc"><String>tex_album_icon</String></Pair>
<Pair key="title"><String>XMB Sub Menu Item</String></Pair>
<Pair key="info"><String>Dummy Sub item 2</String></Pair>
<Pair key="str_noitem"><String>msg_error_no_gamedata</String></Pair>
</Table>
<Table key="xmb_subitem_3">
<Pair key="icon_rsc"><String>tex_album_icon</String></Pair>
<Pair key="title"><String>XMB Sub Menu Item</String></Pair>
<Pair key="info"><String>Dummy Sub item 3</String></Pair>
<Pair key="str_noitem"><String>msg_error_no_gamedata</String></Pair>
</Table>
</Attributes>
<Items>
<Query class="type:x-xmb/folder-pixmap"  key="xmb_subitem_1" attr="xmb_subitem_1" />
<Query class="type:x-xmb/folder-pixmap"  key="xmb_subitem_2" attr="xmb_subitem_2" />
<Query class="type:x-xmb/folder-pixmap"  key="xmb_subitem_3" attr="xmb_subitem_3" />
</Items>
</View>
</syntaxhighlight>}}


'''title_rsc'''. Displays XMB main title text referred from relevant .rco. Cannot be used at the same time as 'title'
Important Notes:
* These are dummy items, they do not 'go anywhere' or perform any function. They will just print the str_noitem message when clicked because they have no function
* notice how the keys from the <Items> sub entries match the Table keys from the <Attributes> sub entries
* The <Attributes> and the <Items> sub entries do not have to be in the same order to work, they just have to have their 'key' in common


==Loading resource files from the associated .rco==
=== A Web-Site link ===
The attributes with names containing '''rsc''' (resource), '''str''' (string), or '''msg''' (message), as '''icon_rsc''', '''title_rsc''', '''info_rsc''', and '''instruction_rsc''' can load images or texts from the .rco associated with the XMB column (the variants of explore_category_****.rco, and explore_plugin_full.rco that is common for all XMB categories, also some others that are specific for a category as gamelib_plugin.rco or gamedata_plugin.rco)
This type of entry could be placed on the root of the XMB category, or in an XMB Item Tree. This is also an application of the '[[VSH:Module-Action|module-action]]' function. Example:
{{RCO TOC reference types}}


{{Boxcode|content=<syntaxhighlight lang="xml">
<View id="seg_xmb_weblink">
<Attributes>
<Table key="link_1">
<Pair key="icon_rsc"><String>dev_wiki_icon</String></Pair>
<Pair key="title"><String>PS3 Dev Wiki</String></Pair>
<Pair key="info"><String>Some info here</String></Pair>
<Pair key="module_name"><String>webbrowser_plugin</String></Pair>
<Pair key="module_action"><String>http://www.ps3devwiki.com/</String></Pair>
  </Table>
</Attributes>
<Items>
<Item class="type:x-xmb/module-action" key="link_1" attr="link_1"/>
</Items>
</View>
</syntaxhighlight>}}


{{File Formats}}<noinclude>[[Category:Main]]</noinclude>
*Important Notes:
**The 'Attributes' for this Web-Link follow, follows the Attribute rules for a 'module-action' entry. 
**The 'webbrowser_plugin' module has been used to handle the, request in the 'module_action' pair key, which is a web address
**The 'key' and 'attr' in the Items sub-entry are the same as the table key in the 'Attributes' sub-entry.
**Remember that the icon_rsc string will search the rco file(used by the module running the category which this web link is on) for the icon 'dev_wiki_icon'. Whereas the title and info strings will just print the contents of the string.
Please note that all contributions to PS3 Developer wiki are considered to be released under the GNU Free Documentation License 1.2 (see PS3 Developer wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To protect the wiki against automated edit spam, we kindly ask you to solve the following hCaptcha:

Cancel Editing help (opens in new window)

Templates used on this page:

Retrieved from "http://www.psdevwiki.com/ps3/XMBML_Coding"