diff --git a/docs/syntax/static.html b/docs/syntax/static.html index 8ee87c9..6507b05 100644 --- a/docs/syntax/static.html +++ b/docs/syntax/static.html @@ -1,15 +1,101 @@ -
This section modifies context menu items added by the system or by a third party. more than one item can be added
- with some properties to customize the context menu. explained below in more details.
The items must have the
- property find. to search in the titles of the menu items to catches them and customize by other
- properties such as changing the title, icon, visibility, or moving it to another location.
In the following example, it shows how to write add an items to static:
+The optional static section contains entries to modify existing context menu items,
+ added by the system or by a third party.
The section can have the following entry types, all of which are optional:
+var block to define "local" variables.
+ item entries.
+ These contain the instructions on which and how to change existing menuitems.
+ imports. The content of the
+ given file will be placed in the position of the import.
+ While the var block should be at the top of the section, the other entries can appear in any order.
In the following example, two instructions are defined:
shell
{
static
{
- item(find = 'copy'image = #00ff00)
+ item(find = 'copy' image = #00ff00)
item(find = 'paste' image = #0000ff)
}
}
+item entries contain the instructions on how to identify existing menuitems (also referred to as Target), and when and what changes should be applied
+ to them.
This is done by matching an existing menuitem's title property against the static item's mandatory find property. If a match is found, the other properties of the static
+ item are applied to the appropriate menuitem, such as changing their properties (e.g. title, icon, visibility), or moving them to another location.
item( title = value [property = value [...] ])
+item entries can define three different sets of properties:
item entry should be processed when a context menu is displayed. Optional.
+ For a complete overview and further details regarding applicable properties, please refer to the properties page.
+ +Item targets are menuitems of an existing context menu. Their properties or location can
+ be changed by applying the process instructions defined in a static item.
Instructions that should be applied to the Target. Basically they consist of properties from the two property + classes menuitem properties and command properties.
+Once a item is validated and a target identified, then these values are applied to the targeted
+ menuitem.