diff --git a/docs/syntax/dynamic.html b/docs/syntax/dynamic.html index 6c7767b..3e7a38b 100644 --- a/docs/syntax/dynamic.html +++ b/docs/syntax/dynamic.html @@ -1,7 +1,10 @@
This section adds new menu items to the context menu.
-Dynamic items have three types (menu, item, and separator). with properties to add new items with customization explained below in more details.
The types (menu and item) must contain the property title at least and their value cannot be null.
A separator-type item can be added without any properties.
Dynamic items have three types (menu, item, and separator). with properties to add new items with customization
+ explained below in more details.
The types (menu and item) must contain the property title at least and their
+ value cannot be null.
A separator-type item can be added without any
+ properties.
In the following example, it shows how to write add an items to dynamic:
shell
{
@@ -21,239 +24,261 @@
-
- Property
- Summary
-
-
+
+ Property
+ Summary
+
+
+
Where
Allow menu item to be passed if a true value is returned
Default = true
+
- Title
- Sets a value indicating the caption of the menuitem.
- This property must be included with menu and item if image propery is not defined, not required for separator.
- Default = null
- Required for menu, item.
-
+ Title
+ Sets a value indicating the caption of the menuitem.
+ This property must be included with menu and item if image propery is not
+ defined, not required for separator.
+ Default = null
+ Required for menu, item.
+
+
- Mode
- Accept item by selections behavior. Value have one of the following parameters:
-
-
- none
- Accept item when there are no selections.
-
-
- single
- Accept menuitem when there are single selection.
-
-
- multi_unique
- Accept when multiple selections are single type.
-
-
- multi_single
- Accept when multiple selections are single file extension.
-
-
- multiple
- Accept all types.
-
-
- Default = single
- Required for menu, item, separator.
-
+ Mode
+ Accept item by selections behavior. Value have one of the following parameters:
+
+
+ none
+ Accept item when there are no selections.
+
+
+ single
+ Accept menuitem when there are single selection.
+
+
+ multi_unique
+ Accept when multiple selections are single type.
+
+
+ multi_single
+ Accept when multiple selections are single file extension.
+
+
+ multiple
+ Accept all types.
+
+
+ Default = single
+ Required for menu, item, separator.
+
+
- Type
- Specify the types of object files allowed for the menu item to appear. The property is assigned to one or more of these parameters and this character | is used to separate types.
- Add a character ~ before single type to exclude.
- The property not supported syntax expressions.
-
-
- *
- Accept menuitem when any type are selected.
-
-
- File
- Accept menuitem when file are selected.
-
-
- Directory(Dir)
- Accept menuitem when Directory are selected.
-
-
- Drive
- Drive objects
-
-
- USB
- Accept menuitem when USB flash drive are selected.
-
-
- DVD
- The drive is a DVD-ROM drive
-
-
- Fixed
- Accept menuitem when Fixed drive are selected. The drive has fixed media; for example, a hard disk drive or flash drive.
-
-
- VHD
- Accept menuitem when Virtual Hard Disk are selected.
-
-
- Removable
- The drive has removable media; for example, a floppy drive, thumb drive, or flash card reader.
-
-
- Remote
- The drive is a remote (network) drive.
-
-
- Back
- Accept menu item when the background of all types are selected or can specify of this types for the background (back.directory, back.drive[back.fixed, back.usb, back.dvd, back.vhd, back.Removable], back.namespace[back.computer, back.recyclebin])
-
-
-
- Desktop
- Accept menuitem when the Desktop are selected.
-
-
- Namespace
- Accept menuitem when Namespace are selected. Can be virtual objects such as the My Network Places and Recycle Bin.
-
-
- Computer
- Accept menuitem when the My Computer are selected.
-
-
- Recyclebin
- Accept menuitem when the Recycle bin are selected.
-
-
- Taskbar
- Accept menuitem when the Taskbar are selected.
-
-
- Default = Accepts all types except for the taskbar.
- Required for menu, item, separator.
-
+ Type
+ Specify the types of object files allowed for the menu item to appear. The property is assigned to one
+ or more of these parameters and this character | is used to separate types.
+ Add a character ~ before single type to exclude.
+ The property not supported syntax expressions.
+
+
+ *
+ Accept menuitem when any type are selected.
+
+
+ File
+ Accept menuitem when file are selected.
+
+
+ Directory(Dir)
+ Accept menuitem when Directory are selected.
+
+
+ Drive
+ Drive objects
+
+
+ USB
+ Accept menuitem when USB flash drive are selected.
+
+
+ DVD
+ The drive is a DVD-ROM drive
+
+
+ Fixed
+ Accept menuitem when Fixed drive are selected. The drive has fixed media; for example, a
+ hard disk drive or flash drive.
+
+
+
+ VHD
+ Accept menuitem when Virtual Hard Disk are selected.
+
+
+ Removable
+ The drive has removable media; for example, a floppy drive, thumb drive, or flash card
+ reader.
+
+
+
+ Remote
+ The drive is a remote (network) drive.
+
+
+ Back
+ Accept menu item when the background of all types are selected or can specify of this types
+ for the background (back.directory, back.drive[back.fixed, back.usb, back.dvd, back.vhd,
+ back.Removable], back.namespace[back.computer, back.recyclebin])
+
+
+
+ Desktop
+ Accept menuitem when the Desktop are selected.
+
+
+ Namespace
+ Accept menuitem when Namespace are selected. Can be virtual objects such as the My Network
+ Places and Recycle Bin.
+
+
+
+ Computer
+ Accept menuitem when the My Computer are selected.
+
+
+ Recyclebin
+ Accept menuitem when the Recycle bin are selected.
+
+
+ Taskbar
+ Accept menuitem when the Taskbar are selected.
+
+
+ Default = Accepts all types except for the taskbar.
+ Required for menu, item, separator.
+
+
Visibility (vis)
Visibility of menuitem and can have one of the following parameters:
-
-
- Hidden
- Them menuitem will not be displayed.
-
-
- Normal
- Enabled the menuitem.
-
-
- Disable
- Disabled the menuitem.
-
-
- Static
- Display item as label with/out an image
-
-
- Label
- Display item as label without an image
-
-
- Default = Noraml
- Required for menu, item, separator.
-
+
+
+ Hidden
+ Them menuitem will not be displayed.
+
+
+ Normal
+ Enabled the menuitem.
+
+
+ Disable
+ Disabled the menuitem.
+
+
+ Static
+ Display item as label with/out an image
+
+
+ Label
+ Display item as label without an image
+
+
+ Default = Noraml
+ Required for menu, item, separator.
+
+
Find
- Accept menuitem when the specified path name or path extension is contains or equal to the current find property.
Use this delimiter | to separate patterns.
+ Accept menuitem when the specified path name or path extension is contains or equal to the current
+ find property.
Use this delimiter | to separate patterns.
Default = null
-Syntax
-find = 'exe' Find any word contains "exe"
-find = '"exe"' Match whole word only
-find = '*exe' Find a word that ends with
-find = 'exe*' Find a word that starts with
-
-find = '!exe' Find any word not contains "exe"
-find = '!"exe"' Search for any word not equal to "exe"
-find = '!*exe' Find a word that not ends with
-find = 'exe*!' Find a word that starts with
-
-find = '.exe' Find an equal extension for ".exe"
-find = '!.exe' Find an not equal extension for ".exe"
-
-find = '.exe|.dll' Find an equal extension for ".exe" or ".dll"
+ Syntax
+ find = 'exe' Find any word contains "exe"
+ find = '"exe"' Match whole word only
+ find = '*exe' Find a word that ends with
+ find = 'exe*' Find a word that starts with
+
+ find = '!exe' Find any word not contains "exe"
+ find = '!"exe"' Search for any word not equal to "exe"
+ find = '!*exe' Find a word that not ends with
+ find = 'exe*!' Find a word that starts with
+
+ find = '.exe' Find an equal extension for ".exe"
+ find = '!.exe' Find an not equal extension for ".exe"
+
+ find = '.exe|.dll' Find an equal extension for ".exe" or ".dll"
+
- Separator (sep)
- Add separator with menuitem position by parameters:
-
-
- None
- Not adding a separator with the menuitem.
-
-
- Before, Top
- Add a separator before the menuitem.
-
-
- After, Bottom
- Add a separator after the menuitem.
-
-
- Both
- Add a separator before and after the menuitem.
-
-
- Default = none
- Required for menu, item.
-
+ Separator (sep)
+ Add separator with menuitem position by parameters:
+
+
+ None
+ Not adding a separator with the menuitem.
+
+
+ Before, Top
+ Add a separator before the menuitem.
+
+
+ After, Bottom
+ Add a separator after the menuitem.
+
+
+ Both
+ Add a separator before and after the menuitem.
+
+
+ Default = none
+ Required for menu, item.
+
+
- Position (pos)
- The position at which a menuitem should be inserted into the menu.
Position can have one of the following parameters:
-
-
- Auto
- Insert the menuitem to the current position.
-
-
- Middle
- Insert the menuitem to the middle of the menu.
-
-
- Top
- Insert the menuitem to the top of the menu.
-
-
- Bottom
- Insert the menuitem to the bottom of the menu.
-
-
- Number sets
- Insert the menuitem to a specified position with integer numbers.
-
-
- Default = auto
- Required for menu, item, separator.
-
+ Position (pos)
+ The position at which a menuitem should be inserted into the menu.
Position can have one of the
+ following parameters:
+
+
+ Auto
+ Insert the menuitem to the current position.
+
+
+ Middle
+ Insert the menuitem to the middle of the menu.
+
+
+ Top
+ Insert the menuitem to the top of the menu.
+
+
+ Bottom
+ Insert the menuitem to the bottom of the menu.
+
+
+ Number sets
+ Insert the menuitem to a specified position with integer numbers.
+
+
+ Default = auto
+ Required for menu, item, separator.
+
+
Image, Icon
- The icon that appears in a menuitem, This property can be assigned as image files, resource icons, glyph or color. With one of the following parameters
+ The icon that appears in a menuitem, This property can be assigned as image files, resource icons, glyph
+ or color. With one of the following parameters
null
@@ -262,7 +287,8 @@ find = '.exe|.dll' Find an equal extension for ".exe" or ".dll"
Inherit
@*Inheriting the image from the parent.*@
- Inherits this property from its parent element.
+ Inherits this property from its parent element.
+
Cmd
@@ -285,18 +311,22 @@ find = '.exe|.dll' Find an equal extension for ".exe" or ".dll"
Required for menu, item.
+
Parent, Menu
Move current item to another menu.
- Default = null
+ Default = null
+
Command (cmd)
- The command associated with the menuitem. Occurs when the menuitem is clicked or selected using a shortcut key or access key defined for the menuitem.
- Default = null
- Required for item.
+ The command associated with the menuitem. Occurs when the menuitem is clicked or selected using a
+ shortcut key or access key defined for the menuitem.
+ Default = null
+ Required for item.
+
Arguments (arg, args)
The parameter to pass to the Command property of a menuitem.
@@ -304,6 +334,7 @@ find = '.exe|.dll' Find an equal extension for ".exe" or ".dll"
Required for item.
+
Invoke
Set execution type
@@ -321,21 +352,23 @@ find = '.exe|.dll' Find an equal extension for ".exe" or ".dll"
Required for item.
-
+
Window
Controls how the window is to be shown. can be one of the following parameters:
- Hidden, Show, Visible, Minimized, Maximized
- Default = show
- Required for item.
+ Hidden, Show, Visible, Minimized, Maximized
+ Default = show
+ Required for item.
+
Directory (dir)
Specify the work directory to execute the command.
- Default = null
- Required for item.
+ Default = null
+ Required for item.
+
Admin
Execute the command with administrative permissions.
@@ -343,51 +376,54 @@ find = '.exe|.dll' Find an equal extension for ".exe" or ".dll"
Required for item.
+
Verb
- Specifies that the operation is the default for the selected file. value type string and can have one of the following parameters:
+ Specifies that the operation is the default for the selected file. value type string and can have one of
+ the following parameters:
- null
- Specifies that the operation is the default for the selected file type.
+ null
+ Specifies that the operation is the default for the selected file type.
- Open
- Opens a file or a application.
+ Open
+ Opens a file or a application.
- OpenAs
- Opener dialog when no program is associated to the extension.
+ OpenAs
+ Opener dialog when no program is associated to the extension.
- RunAs
- In Windows 7 and Vista, opens the UAC dialog andin others, open the Run as... Dialog.
+ RunAs
+ In Windows 7 and Vista, opens the UAC dialog andin others, open the Run as... Dialog.
- Edit
- Opens the default text editor for the file.
+ Edit
+ Opens the default text editor for the file.
- Explore
- Opens the Windows Explorer in the folder specified in Directory.
+ Explore
+ Opens the Windows Explorer in the folder specified in Directory.
- Properties
- Opens the properties window of the file.
+ Properties
+ Opens the properties window of the file.
- Print
- Start printing the file with the default application.
+ Print
+ Start printing the file with the default application.
- Find
- Start a search.
+ Find
+ Start a search.
Default = open
Required for item.
+
Wait
@@ -396,6 +432,7 @@ find = '.exe|.dll' Find an equal extension for ".exe" or ".dll"
Required for item.
+
Checked
Value that indicates whether the menuitem checked type:
@@ -417,14 +454,17 @@ find = '.exe|.dll' Find an equal extension for ".exe" or ".dll"
Required for item.
+
Default
- Specifies that the menuitem is the default. A menu can contain only one default menuitem, which is displayed in bold.
+ Specifies that the menuitem is the default. A menu can contain only one default menuitem, which is
+ displayed in bold.
Default = false
Required for item.
+
Expanded
@@ -433,24 +473,27 @@ find = '.exe|.dll' Find an equal extension for ".exe" or ".dll"
Required for menu.
+
Column(col)
Create a new column.
- Default = true
- Required for item, menu.
+ Default = true
+ Required for item, menu.
+
Keys
Show keyboard shortcuts.
- Default = null
+ Default = null
+
Tip
- Show a tip for the current item
- Default = null
- Syntax
-
+ Show a tip for the current item
+ Default = null
+ Syntax
+
tip = "Lorem Ipsum is simply dummy text."
tip = ["Lorem Ipsum is simply dummy text.", tip.info]
tip = ["Lorem Ipsum is simply dummy text.", tip.info, 1.2]
diff --git a/docs/syntax/index.html b/docs/syntax/index.html
index 10f1a84..ea78e12 100644
--- a/docs/syntax/index.html
+++ b/docs/syntax/index.html
@@ -1,93 +1,96 @@
-Syntax Rules for Configuration Files
-
-This chapter describes the syntax rules for configuration file.
-
- - Syntax are not case sensitive.
- - Spaces around the equal (
=) sign are optional and are ignored.
- - The properties of static and dynamic items are separated by blank spaces or on a separate line and must be placed in parentheses
( ).
- - variable are optional.
- - default are optional.
- - Static items are optional.
- - Static items have one type: item.
- - Dynamic items are optional.
- - Dynamic items have three types: menu, item, and separator(sep).
-
-
-
- Tip: When there is an error, it is recorded in the log file (shell.log).
-
-
-The following rules apply to the syntax of configuration file (shell.nss):
-shell.nss structure
-shell
-{
- // global variables
- var // variables
- {
- // variables content
- variable-name = variable-value
- ...
- }
-
- set // settings
- {
- theme
- {
- set-name = set-value
- ...
- }
-
- set-name = set-value
- set-name = [set-value, set-value, ...]
- ...
- }
-
- images
- {
- id = value
- "item 1" = value
- id1,id2, id3, "item 2" = value
- ....
- }
-
- // static items
- static
- {
- // static items content
- item ( property-name = property-value ... )
- ...
- }
-
- // dynamic items
- dynamic
- {
- // dynamic items content
- item ( property-name = property-value ... )
-
- separator [( property-name = property-value ... )]
-
- menu ( property-name = property-value ... )
- {
- var // local variables
- {
- variable-name = variable-value
- ...
- }
-
- item ( property-name = property-value ... )
- ...
- }
- ...
- }
-}
-
-
-Breaking Long Lines
For best readability, users often like to avoid lines longer than 80 characters. single quotes also allow break up a line.
-shell
-{
- dynamic
- {
- item(title='Command prompt'
- cmd='cmd.exe')
- }
-}
+Syntax Rules for Configuration Files
+
+This chapter describes the syntax rules for configuration file.
+
+ - Syntax are not case sensitive.
+ - Spaces around the equal (
=) sign are optional and are ignored.
+ - The properties of static and dynamic items are separated by blank spaces or on a separate line and must be
+ placed in parentheses
( ).
+
+ - variable are optional.
+ - default are optional.
+ - Static items are optional.
+ - Static items have one type: item.
+ - Dynamic items are optional.
+ - Dynamic items have three types: menu, item, and separator(sep).
+
+
+
+ Tip: When there is an error, it is recorded in the log file (shell.log).
+
+
+The following rules apply to the syntax of configuration file (shell.nss):
+shell.nss structure
+shell
+{
+ // global variables
+ var // variables
+ {
+ // variables content
+ variable-name = variable-value
+ ...
+ }
+
+ set // settings
+ {
+ theme
+ {
+ set-name = set-value
+ ...
+ }
+
+ set-name = set-value
+ set-name = [set-value, set-value, ...]
+ ...
+ }
+
+ images
+ {
+ id = value
+ "item 1" = value
+ id1,id2, id3, "item 2" = value
+ ....
+ }
+
+ // static items
+ static
+ {
+ // static items content
+ item ( property-name = property-value ... )
+ ...
+ }
+
+ // dynamic items
+ dynamic
+ {
+ // dynamic items content
+ item ( property-name = property-value ... )
+
+ separator [( property-name = property-value ... )]
+
+ menu ( property-name = property-value ... )
+ {
+ var // local variables
+ {
+ variable-name = variable-value
+ ...
+ }
+
+ item ( property-name = property-value ... )
+ ...
+ }
+ ...
+ }
+}
+
+
+Breaking Long Lines
For best readability, users often like to avoid lines longer than 80 characters. single
+ quotes also allow break up a line.
+shell
+{
+ dynamic
+ {
+ item(title='Command prompt'
+ cmd='cmd.exe')
+ }
+}
diff --git a/docs/syntax/set.html b/docs/syntax/set.html
index c5fb072..d26ada4 100644
--- a/docs/syntax/set.html
+++ b/docs/syntax/set.html
@@ -4,59 +4,59 @@
shell
{
- set // settings
- {
+ set // settings
+ {
theme
{
// theme.name = auto, classic, white, black, or modern
name = "modern"
-
+
// view = auto, compact, small, medium, large, wide
view = view.compact
-
+
dark = true or false
-
+
background
{
color = color value
opacity = value from 0 to 100
-
- // effect value 0 = disable, 1 = transparent, 2 = blur, 3 = acrylic
- effect = auto
-
- // for acrylic
- effect = [3, tint color, opacity]
-
- gradient
- {
- enabled = boolean value
-
- // linear = [x1, x2, y1, y2]
- linear = [0, 100, 0, 0]
-
- // or radial = [cx, cy, r, fx, fy]
- radial =[ 100, 100, 150, 100, 100]
-
- // stop = [offset, stop-color]
- stop = [0.5, color.accent, 20]
- // or add more stop
- stop = [
+ // effect value 0 = disable, 1 = transparent, 2 = blur, 3 = acrylic
+ effect = auto
+
+ // for acrylic
+ effect = [3, tint color, opacity]
+
+ gradient
+ {
+ enabled = boolean value
+
+ // linear = [x1, x2, y1, y2]
+ linear = [0, 100, 0, 0]
+
+ // or radial = [cx, cy, r, fx, fy]
+ radial =[ 100, 100, 150, 100, 100]
+
+ // stop = [offset, stop-color]
+ stop = [0.5, color.accent, 20]
+
+ // or add more stop
+ stop = [
[offset, stop-color],
[offset, stop-color],
[offset, stop-color]
- ]
- }
+ ]
+ }
}
-
+
item
{
opacity = value from 0 to 100
radius = value from 0 to 3
-
+
// prefix value [auto, 0 = dont display, 1 = display, 2 = ignore]
prefix = 1
-
+
text
{
normal = color
@@ -64,7 +64,7 @@
normal_disabled = color
select_disabled = color
}
-
+
back
{
normal = color
@@ -72,7 +72,7 @@
normal_disabled = color
select_disabled = color
}
-
+
border
{
normal = color
@@ -97,7 +97,7 @@
bottom = value
}
}
-
+
border
{
enabled = boolean value
@@ -105,7 +105,7 @@
color = = value
opacity = value
radius = value
-
+
padding
{
left = value
@@ -114,7 +114,7 @@
bottom = value
}
}
-
+
shadow
{
enabled = boolean value
@@ -123,23 +123,23 @@
opacity = value from 0 to 100
offset = value from 0 to 30
}
-
+
font
{
size = value start from 6
name = "tahoma"
weight = value from 1 to 9
-
+
italic = 0
}
-
+
separator
{
size = value form 0 to 40
color = value
opacity = value
-
+
margin
{
left = value
@@ -148,14 +148,14 @@
bottom = value
}
}
-
+
symbol
{
normal = color
select = color
normal_disabled = color
select_disabled = color
-
+
// or
chevron
{
@@ -164,7 +164,7 @@
normal_disabled = color
select_disabled = color
}
-
+
checkmark
{
normal = color
@@ -172,7 +172,7 @@
normal_disabled = color
select_disabled = color
}
-
+
bullet
{
normal = color
@@ -181,107 +181,107 @@
select_disabled = color
}
}
-
+
image
{
enabled = boolean value
-
+
color = [color1, color2, color3]
// or
color.color1 = color
color.color2 = color
color.color3 = color
-
+
gap = value
glyph = "font name" // font name for default glyph
scale = boolean value
align = value [0 = Display only the check mark, 1 = Display the image and check mark together]
}
-
+
layout
{
// Right-to-left layout display for Middle Eastern languages
rtl = boolean value
-
+
// Align submenus
popup = value from -20 to 20
}
}
- tip = true
- // or
- tip
- {
- enabled = true
+ tip = true
+ // or
+ tip
+ {
+ enabled = true
- // normal = [background, text]
- normal = [default, default]
+ // normal = [background, text]
+ normal = [default, default]
- // normal = [background, text]
- primary = [#000, #fff]
+ // normal = [background, text]
+ primary = [#000, #fff]
- // info = [background, text]
- info = [#88f, #fff]
+ // info = [background, text]
+ info = [#88f, #fff]
- // success = [background, text]
- success = [#8f8, #fff]
+ // success = [background, text]
+ success = [#8f8, #fff]
- // warning = [background, text]
- warning = [#ff8, #fff]
+ // warning = [background, text]
+ warning = [#ff8, #fff]
- // danger = [background, text]
- danger = [#f88, #fff]
+ // danger = [background, text]
+ danger = [#f88, #fff]
- // max width value from 200 to 2000
- width = 400
+ // max width value from 200 to 2000
+ width = 400
- // opacity value from 0 to 100
- opacity = 100
+ // opacity value from 0 to 100
+ opacity = 100
- // radius size value from 0 to 3
- radius = 1
+ // radius size value from 0 to 3
+ radius = 1
- time = 1.5
+ time = 1.5
- padding = [8, 4]
- }
-
- // show menu delay value from 0 to 4000
- showdelay = 200
-
- // Prevent interaction with these windows or processes
- exclude
- {
+ padding = [8, 4]
+ }
+
+ // show menu delay value from 0 to 4000
+ showdelay = 200
+
+ // Prevent interaction with these windows or processes
+ exclude
+ {
where = boolean value
window = window name
process = process name
}
-
+
// Disable/Enable static items processing
static
{
enabled = boolean value
- image = [0 = disable, 1 = enable, 2 = auto reimage]
-
+ image = [0 = disable, 1 = enable, 2 = auto reimage]
+
// Allow/disallow modification of title
title = boolean value
-
+
// Allow/disallow modification of visibility
visibility = boolean value
-
+
// Allow/disallow modification of parent
parent = boolean value
-
+
// Allow/disallow modification of position
position = boolean value
// Allow/disallow to add separator
separator = boolean value
-
+
// auto set image and group
auto = boolean value
}
-
+
// Disable/Enable dynamic items processing
dynamic
{
@@ -289,7 +289,7 @@
// disable/enable image
image = boolean value
}
- }
+ }
}
Padding and Margin value syntax