Basic integration of Skin Shortcuts is designed to be relatively easy, though how you go about it depends on what level of integration you want with the script.
In this scenario, you are using Skin Shortcuts to manage the whole menu system.
In this scenario, you are still managing the main menu, but are using Skin Shortcuts to provide submenus to the main menus
In this scenario, you are managing the whole menu, but are using Skin Shortcuts to allow the user to select which shortcuts they want.
Advanced Usage - 'Just Select' method
The Management Dialog is the name given to the window users use to choose what shortcuts they want in their menus. It's also where lots of additional functionality of the script is exposed to the user.
Shortcuts provided by Skin Shortcuts provide lots of properties you can make use of. Feel free to look in script-skinshortcuts-includes.xml for a complete list, but some of the more important ones:-
| Property | Description |
|---|---|
| Label | Label of the item (localized where possible) |
| Label2 | Type of shortcut |
| Icon | Icon image |
| Thumbnail | Thumbnail image |
| property(labelID) | Unlocalized string used for sub-menu and for displaying more controls depending on the main menu item |
| property(defaultID) | Permanent form of the labelID |
| property(action) | The action that will be run when the shortcut is selected |
| property(list) | The action of the shortcut, without any 'ActivateWindow' elements |
| property(group) | The [groupname] that this shortcut is listed from |
Various other properties will be returned if you are using Skin Shortcuts to manage widgets or backgrounds, and in other situations. See the relevant documentation for details.
One of the features of Skin Shortcuts is that the users custom menu is shared between all skins that use Skin Shortcuts to manage the whole menu. There are some users who prefer not to have this feature, so it is worth being aware that this can be switched off in the skins settings.
Additionally, sometimes a skin uses Skin Shortcuts in a very unusual way which means that it is preferable for its menu's not to be shared with other skins as they wouldn't display properly. In this case, you can add the following to your overrides.xml:-
<doNotShareMenu />
However, it is expected that this will only be used in rare circumstances, and it is preferable if there are issues with your skin using the shared menu, for you to work with us to improve the script.
It is possible to use the additional sub-menu's in a way that means that they shouldn't be shared with other skins - for example, using them to manage a list of widgets rather than a list of shortcuts.
In this case you can indicate that the additional submenu's shouldn't be shared with other skins by adding the following to your :-
However, it is expected that this will only be used when you are using the additional menu's in an unusual way, and it is preferable if there are issues with your skin using the shared additional submenu's for you to work with us to improve the script.
It's important to note that using Skin Shortcuts means the script will write an extra file to your skins directory.
Skin Shortcuts automatically adds visibility conditions to shortcuts when they are built. Read here for more details.
One side-effect of using Skin Shortcuts to manage the whole menu is that the user has the possibility to delete any shortcut, including those that they may later decide they do want. In general, this is no issue as they can also add any shortcut, but if they delete a shortcut to settings it can lead to them being unable to edit the menu to add it back.
There are a few methods you can use to prevent (or at least warn) the user deleted settings (see Advanced Usage) but it's also worth considering adding alternative access to settings - such as on the shutdown menu - and be prepared to offer support to users who have deleted the link.
By default, along with the main and submenu's, skin shortcuts will build skinshortcuts-group-[groupname]and skinshortcuts-group-alt-[groupname] (to be used depending on whether you want visibility conditions.
If you don't want these groups, you can tell Skin Shortcuts not to build them by including &options=noGroups in your build command.
Multiple options can be separated with a pipe - | - symbol.
Quick links - Readme - Getting Started - Advanced Usage