From a0c9babf118e92f15ea397da64e0aadc8335ad6b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martin=20R=C3=BCegg?= items create a single menu entry. Either a Properties
-title or a image property is
- mandatory (set to a non-null value). For further details, please refer to the Either a title or a image
+ property is mandatory (set to a non-null value). For further details, please refer to the properties section below.Syntax
@@ -82,9 +83,10 @@
and sub-entries.
Either a title or a image property is
- mandatory (set to a non-null value). For further details, please refer to the Either a title or a image
+ property is mandatory (set to a non-null value). For further details, please refer to the properties section below.
separators do not have any mandatory properties. Please refer to the properties section below for further + href="properties.html" style="border-bottom: 1px solid currentColor;">properties section below for further details.
separator
separator( property = value [property = value [...] ])
-The Applies column shows, whether the property applies to menus, items - and/or separators. - If set in bold, then the property is mandatory for the given type.
- -| Property | -Applies | -Summary | -||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Where | -M | -- | - | Display menuitem if true is returned. Allows the evaluation of arbitrary
- expressions, e.g.
- if- Default = true - |
- ||||||||||||||||||||||||||||||||
| Title | -M | -I | -- | Sets the caption of the menuitem. - It is mandatory for menu and item entries, unless a |
- ||||||||||||||||||||||||||||||||
| Mode | -M | -I | -S | -Display menuitem by type of selection. The value has one of the following parameters
- (of type string):
-
|
- ||||||||||||||||||||||||||||||||
| Type | -M | -I | -S | -Specifies the types of objects for which the menuitem will be displayed. - Possible values are shown below. Separate multiple types with the pipe character ( |), in
- which case the menuitem is displayed if any of the given types is matched.- To exclude a given type, prefix its value with the tilde character ( ~).
- Expressions are not supported with this property. -
|
- ||||||||||||||||||||||||||||||||
| Visibility (vis) | -M | -I | -S | -Sets the visibility of a menuitem. Can have one of the following parameters:
-
|
- ||||||||||||||||||||||||||||||||
| Find | -M | -I | -S | -
- Display menuitem when the specified path name or path extension matches the current
- find property. - 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) | -M | -I | -- | Add a separator to the menuitem:
-
|
- ||||||||||||||||||||||||||||||||
| Position (pos) | -M | -I | -S | -The position at which a menuitem should be inserted into the menu. - Position can have one of the following parameters: -
|
- ||||||||||||||||||||||||||||||||
| Image, Icon | -M | -I | -- | 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
-
|
- ||||||||||||||||||||||||||||||||
| Parent, Menu | -M | -I | -S | -Move current menuitem to another menu. - Default = null |
- ||||||||||||||||||||||||||||||||
| Command (cmd) | -- | I | -- | 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 - |
- ||||||||||||||||||||||||||||||||
| Arguments (arg, args) | -- | I | -- | The command line parameters to pass to the command - property of a menuitem. - Default = null - |
- ||||||||||||||||||||||||||||||||
| Invoke | -- | I | -- | Set execution type
-
|
- ||||||||||||||||||||||||||||||||
| Window | -- | I | -- | Controls how the window of the executed command
- is to be shown. Can be one of the following parameters:
-
|
- ||||||||||||||||||||||||||||||||
| Directory (dir) | -- | I | -- | Specifies the working directory to execute - the command in. - Default = null - |
- ||||||||||||||||||||||||||||||||
| Admin | -- | I | -- | Execute the command with administrative permissions. - Default = false - |
- ||||||||||||||||||||||||||||||||
| Verb | -- | I | -- | Specifies the default operation for the selected file. Value type string
- and can have one of the following parameters: -
|
- ||||||||||||||||||||||||||||||||
| Wait | -- | I | -- |
- Wait for the command - to complete. - Default = false - |
- ||||||||||||||||||||||||||||||||
| Checked | -- | I | -- | Type of select option:
-
|
- ||||||||||||||||||||||||||||||||
| Default | -M | -I | -- |
- Specifies that the item is the default. A menu - can contain only one default menuitem, which is displayed in bold. - Default = false - |
- ||||||||||||||||||||||||||||||||
| Expanded | -M | -- | - |
- Move all immediate menuitems to the parent menu. - Default = false - |
- ||||||||||||||||||||||||||||||||
| Column(col) | -M | -I | -- | Create a new column. - Default = true - | ||||||||||||||||||||||||||||||||
| Keys | -M | -I | -- | Show keyboard shortcuts. - Default = null |
- ||||||||||||||||||||||||||||||||
| Tip | -M | -I | -- |
- Show a tooltip for the current menu - or item. - - Default = null- Syntax -
- |
- ||||||||||||||||||||||||||||||||
The Applies column shows, whether the property applies to menus, items + and/or separators. + If set in bold, then the property is mandatory for the given type.
+ +| Property | +Applies | +Summary | +||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Where | +M | ++ | + | Display menuitem if true is returned. Allows the evaluation of arbitrary
+ expressions, e.g.
+ if+ Default = true + |
+ ||||||||||||||||||||||||||||||||
| Title | +M | +I | ++ | Sets the caption of the menuitem. + It is mandatory for menu and item entries, unless a |
+ ||||||||||||||||||||||||||||||||
| Mode | +M | +I | +S | +Display menuitem by type of selection. The value has one of the following parameters
+ (of type string):
+
|
+ ||||||||||||||||||||||||||||||||
| Type | +M | +I | +S | +Specifies the types of objects for which the menuitem will be displayed. + Possible values are shown below. Separate multiple types with the pipe character ( |), in
+ which case the menuitem is displayed if any of the given types is matched.+ To exclude a given type, prefix its value with the tilde character ( ~).
+ Expressions are not supported with this property. +
|
+ ||||||||||||||||||||||||||||||||
| Visibility (vis) | +M | +I | +S | +Sets the visibility of a menuitem. Can have one of the following parameters:
+
|
+ ||||||||||||||||||||||||||||||||
| Find | +M | +I | +S | +
+ Display menuitem when the specified path name or path extension matches the current
+ find property. + 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) | +M | +I | ++ | Add a separator to the menuitem:
+
|
+ ||||||||||||||||||||||||||||||||
| Position (pos) | +M | +I | +S | +The position at which a menuitem should be inserted into the menu. + Position can have one of the following parameters: +
|
+ ||||||||||||||||||||||||||||||||
| Image, Icon | +M | +I | ++ | 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
+
|
+ ||||||||||||||||||||||||||||||||
| Parent, Menu | +M | +I | +S | +Move current menuitem to another menu. + Default = null |
+ ||||||||||||||||||||||||||||||||
| Command (cmd) | ++ | I | ++ | 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 + |
+ ||||||||||||||||||||||||||||||||
| Arguments (arg, args) | ++ | I | ++ | The command line parameters to pass to the command + property of a menuitem. + Default = null + |
+ ||||||||||||||||||||||||||||||||
| Invoke | ++ | I | ++ | Set execution type
+
|
+ ||||||||||||||||||||||||||||||||
| Window | ++ | I | ++ | Controls how the window of the executed command
+ is to be shown. Can be one of the following parameters:
+
|
+ ||||||||||||||||||||||||||||||||
| Directory (dir) | ++ | I | ++ | Specifies the working directory to execute + the command in. + Default = null + |
+ ||||||||||||||||||||||||||||||||
| Admin | ++ | I | ++ | Execute the command with administrative permissions. + Default = false + |
+ ||||||||||||||||||||||||||||||||
| Verb | ++ | I | ++ | Specifies the default operation for the selected file. Value type string
+ and can have one of the following parameters: +
|
+ ||||||||||||||||||||||||||||||||
| Wait | ++ | I | ++ |
+ Wait for the command + to complete. + Default = false + |
+ ||||||||||||||||||||||||||||||||
| Checked | ++ | I | ++ | Type of select option:
+
|
+ ||||||||||||||||||||||||||||||||
| Default | +M | +I | ++ |
+ Specifies that the item is the default. A menu + can contain only one default menuitem, which is displayed in bold. + Default = false + |
+ ||||||||||||||||||||||||||||||||
| Expanded | +M | ++ | + |
+ Move all immediate menuitems to the parent menu. + + Default = false + |
+ ||||||||||||||||||||||||||||||||
| Column(col) | +M | +I | ++ | Create a new column. + Default = true + | ||||||||||||||||||||||||||||||||
| Keys | +M | +I | ++ | Show keyboard shortcuts. + Default = null |
+ ||||||||||||||||||||||||||||||||
| Tip | +M | +I | ++ |
+ Show a tooltip for the current menuor + item. + + Default = null+ Syntax +
+ |
+ ||||||||||||||||||||||||||||||||
Returns the path of the Returns the path of the configuration file shell.nss (or shell.shl
in older installations).
Reload the Reload the configuration file.
Syntax
app.reload // usage in section context
@@ -81,7 +81,7 @@
app.unload
- Unload the Unload the configuration file.
Syntax
app.unload // usage in section context
diff --git a/docs/installation.html b/docs/installation.html
index 61c165d..1fe033d 100644
--- a/docs/installation.html
+++ b/docs/installation.html
@@ -1,199 +1,199 @@
-Installation
-
-
- Info: Administrative permissions are required for installation.
-
-
-Shell can be installed in the following ways:
-
- - Installer
- - Portable
- - Windows Package Manager
- - Scoop
- - Chocolatey
-
-Please also note the following reference sections:
-
-
-
-
-
- Installer version
-
- Install
- Download the
- installation file (Installer/Portable),
- run setup.exe,
- follow the installation steps,
- and agree to restart Windows File Explorer.
- The program will be installed to C:\Program Files\Nilesoft Shell\, unless you have chosen
- a different installation path during the installation steps.
-
-
-
- Uninstall
- Inside the Shell program folder (C:\Program Files\Nilesoft Shell\ by default), run the unst000.exe or unstall.exe file, then follow the steps, and then agree to restart Windows File Explorer.
-
-
-
-
-
-
- Portable version
-
- Install
- Download the
- installation file (Installer/Portable),
- run setup.exe,
- click Next, chose the folder you want the program to be extracted to,
- Check the option Portable Mode, and click
- Extract.
- Open an elevated command prompt (or use gsudo),
- change to the directory you have extracted the program to,
- and run
- shell -register -restart
- For further details see the chapter Command-Line Help below.
-
-
-
- Uninstall
- Open an elevated command prompt (or use gsudo),
- change to the directory you have extracted the program to,
- and run
- shell -unregister -restart
-
-
- Tip: Close all instances of Windows File Explorer before uninstalling to avoid needing a reboot after it (Shell) has been uninstalled.
-
-
- For further details see the chapter Command-Line Help below.
-
-
-
-
-
-
- Windows Package Manager
- Windows Package Manager is available from Windows 10 version 1809.
-
- Install
- Open a command prompt, and run
- winget install Nilesoft.Shell
- The program will be installed to C:\Program Files\Nilesoft Shell\.
-
-
-
- Uninstall
- Open a command prompt, and run
- winget uninstall Nilesoft.Shell
-
-
-
-
-
-
- Scoop
- Scoop can be installed following the instructions at scoop.sh.
-
- Install
- Open a command prompt, and run
- scoop install nilesoft-shell
- The program will be installed to %USERPROFILE%\scoop\apps\nilesoft-shell\current\.
-
-
- Tip: If you get the error Couldn't find manifest for 'nilesoft-shell', please run
- scoop bucket add extras first.
-
-
- Open an elevated command prompt (or use gsudo),
- and run
- shell -register -restart
- For further details see the chapter Command-Line Help below.
-
-
-
- Uninstall
- Open an elevated command prompt (or use gsudo),
- and run
- shell -unregister -restart
- Then run
- scoop uninstall nilesoft-shell
-
-
-
-
-
-
- Chocolatey
- Chocolatey can be installed following the instructions at chocolatey.org.
-
- Install
-
- Notice: Until the package has been moderated, you need to add the specific version string to the installer,
- adding e.g.
- choco install nilesoft.shell --version=1.8.1
- Please find the latest published version at
- Chocolatey's Version History and use the latest version number (replacing 1.8.1).
-
-
- Open an elevated command prompt (or use gsudo),
- and run
- choco install nilesoft.shell
- The program will be installed to C:\Program Files\Nilesoft Shell\.
-
-
-
- Uninstall
- Open an elevated command prompt (or use gsudo),
- and run
- choco uninstall nilesoft.shell
-
-
-
-
-
-
- Command-Line Help
- shell -[options]
-
- Options
-
-
- -register (-r)
- Registering.
-
-
- -unregister (-u)
- Unregistering.
-
-
- -restart (-re)
- Restart Windows Explorer.
-
-
- -treat
- Disable Windows 11 context menu.
-
-
- -silent (-s)
- Prevents displaying messages.
-
-
- -?
- Display this help message.
-
-
-
-
-
-
- Use the following keys to enable/disable
- These keys are used when you press right-click or press Shift+F10 keys
- CTRL To enable and reload the configuration file shell.nss
- WIN To make priority to the modern context menu for Windows 11
- CTRL+WIN To disable Shell and Enable Classic Context Menu
- RIGHT-CLICK + LEFT-CLICK To reload the configuration file shell.nss
-
+Installation
+
+
+ Info: Administrative permissions are required for installation.
+
+
+Shell can be installed in the following ways:
+
+ - Installer
+ - Portable
+ - Windows Package Manager
+ - Scoop
+ - Chocolatey
+
+Please also note the following reference sections:
+
+
+
+
+
+ Installer version
+
+ Install
+ Download the
+ installation file (Installer/Portable),
+ run setup.exe,
+ follow the installation steps,
+ and agree to restart Windows File Explorer.
+ The program will be installed to C:\Program Files\Nilesoft Shell\, unless you have chosen
+ a different installation path during the installation steps.
+
+
+
+ Uninstall
+ Inside the Shell program folder (C:\Program Files\Nilesoft Shell\ by default), run the unst000.exe or unstall.exe file, then follow the steps, and then agree to restart Windows File Explorer.
+
+
+
+
+
+
+ Portable version
+
+ Install
+ Download the
+ installation file (Installer/Portable),
+ run setup.exe,
+ click Next, chose the folder you want the program to be extracted to,
+ Check the option Portable Mode, and click
+ Extract.
+ Open an elevated command prompt (or use gsudo),
+ change to the directory you have extracted the program to,
+ and run
+ shell -register -restart
+ For further details see the chapter Command-Line Help below.
+
+
+
+ Uninstall
+ Open an elevated command prompt (or use gsudo),
+ change to the directory you have extracted the program to,
+ and run
+ shell -unregister -restart
+
+
+ Tip: Close all instances of Windows File Explorer before uninstalling to avoid needing a reboot after it (Shell) has been uninstalled.
+
+
+ For further details see the chapter Command-Line Help below.
+
+
+
+
+
+
+ Windows Package Manager
+ Windows Package Manager is available from Windows 10 version 1809.
+
+ Install
+ Open a command prompt, and run
+ winget install Nilesoft.Shell
+ The program will be installed to C:\Program Files\Nilesoft Shell\.
+
+
+
+ Uninstall
+ Open a command prompt, and run
+ winget uninstall Nilesoft.Shell
+
+
+
+
+
+
+ Scoop
+ Scoop can be installed following the instructions at scoop.sh.
+
+ Install
+ Open a command prompt, and run
+ scoop install nilesoft-shell
+ The program will be installed to %USERPROFILE%\scoop\apps\nilesoft-shell\current\.
+
+
+ Tip: If you get the error Couldn't find manifest for 'nilesoft-shell', please run
+ scoop bucket add extras first.
+
+
+ Open an elevated command prompt (or use gsudo),
+ and run
+ shell -register -restart
+ For further details see the chapter Command-Line Help below.
+
+
+
+ Uninstall
+ Open an elevated command prompt (or use gsudo),
+ and run
+ shell -unregister -restart
+ Then run
+ scoop uninstall nilesoft-shell
+
+
+
+
+
+
+ Chocolatey
+ Chocolatey can be installed following the instructions at chocolatey.org.
+
+ Install
+
+ Notice: Until the package has been moderated, you need to add the specific version string to the installer,
+ adding e.g.
+ choco install nilesoft.shell --version=1.8.1
+ Please find the latest published version at
+ Chocolatey's Version History and use the latest version number (replacing 1.8.1).
+
+
+ Open an elevated command prompt (or use gsudo),
+ and run
+ choco install nilesoft.shell
+ The program will be installed to C:\Program Files\Nilesoft Shell\.
+
+
+
+ Uninstall
+ Open an elevated command prompt (or use gsudo),
+ and run
+ choco uninstall nilesoft.shell
+
+
+
+
+
+
+ Command-Line Help
+ shell -[options]
+
+ Options
+
+
+ -register (-r)
+ Registering.
+
+
+ -unregister (-u)
+ Unregistering.
+
+
+ -restart (-re)
+ Restart Windows Explorer.
+
+
+ -treat
+ Disable Windows 11 context menu.
+
+
+ -silent (-s)
+ Prevents displaying messages.
+
+
+ -?
+ Display this help message.
+
+
+
+
+
+
+ Use the following keys to enable/disable
+ These keys are used when you press right-click or press Shift+F10 keys
+ CTRL To enable and reload the configuration file shell.nss
+ WIN To make priority to the modern context menu for Windows 11
+ CTRL+WIN To disable Shell and Enable Classic Context Menu
+ RIGHT-CLICK + LEFT-CLICK To reload the configuration file shell.nss
+
diff --git a/docs/syntax/index.html b/docs/syntax/index.html
index 1deb871..c3add9e 100644
--- a/docs/syntax/index.html
+++ b/docs/syntax/index.html
@@ -4,7 +4,7 @@
The main configuration file shell.nss (or shell.shl in older
installations) is located in the installation directory of
- Shell, depending on your Shell, depending on your installation method.
General rules
@@ -25,7 +25,7 @@
Tip: When there is an error, it is recorded in the log file (shell.log, which is also located in
- your installation directory.).
@@ -173,11 +173,11 @@
The section name is written literally, without any quotes (or the percent signs).
- %path% is a %path% is a string literal,
that returns the path to the config file that shall be imported. This can be a relative path to the location of
the file where the import tag is used, or it can be an absolute path.
- Expressions are supported when using single quotes.
From 625e22358dccee8b0ec422fa700afae4191ba9da Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martin=20R=C3=BCegg?=
Date: Mon, 6 Mar 2023 20:07:33 +0100
Subject: [PATCH 3/9] Replace `a` style with `uline` class
---
docs/functions/app.html | 11 ++-
docs/installation.html | 80 +++++++++---------
docs/syntax/dynamic.html | 66 ++++++---------
docs/syntax/index.html | 78 ++++++++---------
docs/syntax/properties.html | 163 ++++++++++++++++--------------------
5 files changed, 177 insertions(+), 221 deletions(-)
diff --git a/docs/functions/app.html b/docs/functions/app.html
index 8d0a769..21f165e 100644
--- a/docs/functions/app.html
+++ b/docs/functions/app.html
@@ -13,8 +13,7 @@
app.cfg
- Returns the path of the Returns the path of the configuration file shell.nss (or shell.shl
in older installations).
Syntax
@@ -72,8 +71,8 @@
app.reload
- Reload the configuration file.
+ Reload the configuration file.
+
Syntax
app.reload // usage in section context
'@app.reload' // usage inside quoted-string literals
@@ -81,8 +80,8 @@
app.unload
- Unload the configuration file.
+ Unload the configuration file.
+
Syntax
app.unload // usage in section context
'@app.unload' // usage inside quoted-string literals
diff --git a/docs/installation.html b/docs/installation.html
index 1fe033d..d0aa825 100644
--- a/docs/installation.html
+++ b/docs/installation.html
@@ -6,16 +6,16 @@
Shell can be installed in the following ways:
- - Installer
- - Portable
- - Windows Package Manager
- - Scoop
- - Chocolatey
+ - Installer
+ - Portable
+ - Windows Package Manager
+ - Scoop
+ - Chocolatey
Please also note the following reference sections:
- - Command-Line Help
- - Keys to enable/disable Shell functionalities
+ - Command-Line Help
+ - Keys to enable/disable Shell functionalities
@@ -24,18 +24,17 @@
Installer version
Install
- Download the
- installation file (Installer/Portable),
- run setup.exe,
- follow the installation steps,
- and agree to restart Windows File Explorer.
+ Download the installation file (Installer/Portable),
+ run setup.exe, follow the installation steps, and agree to restart Windows File Explorer.
The program will be installed to C:\Program Files\Nilesoft Shell\, unless you have chosen
- a different installation path during the installation steps.
+ a different installation path during the installation steps.
Uninstall
- Inside the Shell program folder (C:\Program Files\Nilesoft Shell\ by default), run the unst000.exe or unstall.exe file, then follow the steps, and then agree to restart Windows File Explorer.
+ Inside the Shell program folder (C:\Program Files\Nilesoft Shell\ by default), run the unst000.exe
+ or unstall.exe file, then follow the steps, and then agree to restart Windows File Explorer.
+
@@ -45,31 +44,30 @@
Portable version
Install
- Download the
+
Download the
installation file (Installer/Portable),
run setup.exe,
- click Next, chose the folder you want the program to be extracted to,
- Check the option Portable Mode, and click
+ click Next, chose the folder you want the program to be extracted
+ to, Check the option Portable Mode, and click
Extract.
- Open an elevated command prompt (or use gsudo),
- change to the directory you have extracted the program to,
- and run
+ Open an elevated command prompt (or use gsudo), change to the directory you have extracted the program to, and run
shell -register -restart
- For further details see the chapter Command-Line Help below.
+ For further details see the chapter Command-Line Help below.
Uninstall
- Open an elevated command prompt (or use gsudo),
- change to the directory you have extracted the program to,
- and run
+ Open an elevated command prompt (or use gsudo), change to the directory you have extracted the program to, and run
shell -unregister -restart
- Tip: Close all instances of Windows File Explorer before uninstalling to avoid needing a reboot after it (Shell) has been uninstalled.
+ Tip: Close all instances of Windows File Explorer before uninstalling to avoid needing a reboot after
+ it (Shell) has been uninstalled.
- For further details see the chapter Command-Line Help below.
+ For further details see the chapter Command-Line Help below.
@@ -96,7 +94,7 @@
Scoop
- Scoop can be installed following the instructions at scoop.sh.
+ Scoop can be installed following the instructions at scoop.sh.
Install
Open a command prompt, and run
@@ -108,16 +106,16 @@
scoop bucket add extras first.
- Open an elevated command prompt (or use gsudo),
- and run
+ Open an elevated command prompt (or use gsudo), and run
shell -register -restart
- For further details see the chapter Command-Line Help below.
+ For further details see the chapter Command-Line Help below.
Uninstall
- Open an elevated command prompt (or use gsudo),
- and run
+ Open an elevated command prompt (or use gsudo), and run
shell -unregister -restart
Then run
scoop uninstall nilesoft-shell
@@ -128,27 +126,29 @@
Chocolatey
- Chocolatey can be installed following the instructions at chocolatey.org.
+ Chocolatey can be installed following the instructions at chocolatey.org.
Install
- Notice: Until the package has been moderated, you need to add the specific version string to the installer,
- adding e.g.
+ Notice: Until the package has been moderated, you need to add the specific version string to the
+ installer, adding e.g.
choco install nilesoft.shell --version=1.8.1
- Please find the latest published version at
+ Please find the latest published version at
Chocolatey's Version History and use the latest version number (replacing 1.8.1).
- Open an elevated command prompt (or use gsudo),
- and run
+ Open an elevated command prompt (or use gsudo), and run
choco install nilesoft.shell
The program will be installed to C:\Program Files\Nilesoft Shell\.
diff --git a/docs/syntax/dynamic.html b/docs/syntax/dynamic.html
index 6396b27..9205fd2 100644
--- a/docs/syntax/dynamic.html
+++ b/docs/syntax/dynamic.html
@@ -5,36 +5,33 @@
Sub-items
The section can have the following entry types, all of which are optional:
- - One
var block to
- define "local" variables.
+ - One
var block to define "local" variables.
- Menuitems, i.e. one or more of the following:
- - One or more
item entries.
+ - One or more
item entries.
These appear as top-level items in a context menu.
- - One or more
menu entries.
+ - One or more
menu entries.
These appear as top-level sub-menus in a context menu.
- - One or more
separator
- entries. These create a horizontal line between the given entries.
+ - One or more
separator entries. These create a
+ horizontal line between the given entries.
- One or more
imports. The content of the
- given file will be placed in the position of the import.
+ class="uline">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.
Example
-In the following example, one top-level item is created, that is separated with a horizontal line from an adjacent sub-menu,
- which in turn has one sub-item
+
In the following example, one top-level item is created, that is
+ separated with a horizontal line from an adjacent sub-menu, which in turn has one sub-item
on its own:
shell
{
@@ -55,9 +52,9 @@
menuitem is an umbrella term for those entry types, that may appear in a
menu. These simply include the following:
@@ -67,11 +64,9 @@
items create a single menu entry.
Properties
-Either a title or a image
- property is mandatory (set to a non-null value). For further details, please refer to the properties section below.
+Either a title or a image property is mandatory (set to a non-null value). For further details,
+ please refer to the properties section below.
Syntax
item( title = value [property = value [...] ])
@@ -83,32 +78,26 @@
and sub-entries.
Properties
-Either a title or a image
- property is mandatory (set to a non-null value). For further details, please refer to the properties section below.
+Either a title or a image property is mandatory (set to a non-null value). For further details,
+ please refer to the properties section below.
Sub-items
menus can have the following entry types, all of which are
optional:
- - One
var block to
- define "local" variables.
+ - One
var block to define "local" variables.
- Menuitems, i.e. one or more of the following:
- - One or more
item entries.
-
- - One or more sub-
menu entries.
-
- - One or more
separator
- entries. These create a horizontal line between the given entries.
+ - One or more
item entries.
+ - One or more sub-
menu entries.
+ - One or more
separator entries. These create a
+ horizontal line between the given entries.
- - One or more
imports. The content of the
+ - One or more
imports. The content of the
given file will be placed in the position of the import.
@@ -129,8 +118,7 @@
Properties
separators do not have any mandatory properties. Please refer to the properties section below for further
- details.
+ href="properties.html" class="uline">properties section below for further details.
Syntax
separator
diff --git a/docs/syntax/index.html b/docs/syntax/index.html
index c3add9e..35f3e16 100644
--- a/docs/syntax/index.html
+++ b/docs/syntax/index.html
@@ -1,70 +1,61 @@
Syntax Rules for Configuration Files
This chapter describes the syntax rules for the configuration files.
-The main configuration file shell.nss (or shell.shl in older
- installations) is located in the installation directory of
- Shell, depending on your installation method.
+The main configuration file shell.nss (or shell.shl
+ in older installations) is located in the installation directory of
+ Shell, depending on your installation method.
+
General rules
- Syntax is case-insensitive.
- 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
( ).
+ - The properties of static and dynamic items are separated
+ by blank spaces or on a separate line and must be placed in
+ parentheses
( ).
- - Other configuration files can be imported using the import tag.
+
- Other configuration files can be imported using the import tag.
Tip: When there is an error, it is recorded in the log file (shell.log, which is also located in
- your installation directory.).
+ your installation directory.).
shell.nss structure
The global section shell{} may have the following subsections:
- - Section var{} for global variables. Optional.
+
- Section var{} for global
+ variables. Optional.
- - Section set{} for settings. Optional.
+
- Section set{} for settings.
+ Optional.
- - Section static{} with instructions on how to change existing
- menuitems. Optional.
+
- Section static{} with
+ instructions on how to change existing menuitems. Optional.
- Static items are only of one type: item.
- - Section dynamic{} with definitions for new menuitems. Optional.
+
- Section dynamic{} with
+ definitions for new menuitems.
+ Optional.
- - Dynamic menuitems may have one of three types: menu, item,
- or separator (sep).
+
- Dynamic menuitems
+ may have one of three types: menu, item, or separator (sep).
@@ -174,11 +165,10 @@
The section name is written literally, without any quotes (or the percent signs).
%path% is a string literal,
- that returns the path to the config file that shall be imported. This can be a relative path to the location of
- the file where the import tag is used, or it can be an absolute path.
- Expressions are supported when using string literal, that returns the path to the
+ config file that shall be imported. This can be a relative path to the location of the file where the import tag is used, or it can be an absolute path. Expressions are
+ supported when using single quotes.
@@ -283,6 +273,6 @@ The result would then look like so:
This syntax may be used nearly anywhere:
diff --git a/docs/syntax/properties.html b/docs/syntax/properties.html
index c6b7b4a..83d95d3 100644
--- a/docs/syntax/properties.html
+++ b/docs/syntax/properties.html
@@ -3,76 +3,73 @@
Index
-
- Admin
- arg
- args
- Arguments
+ Admin
+ arg
+ args
+ Arguments
-
- Checked
- cmd
- col
- Column
- Command
+ Checked
+ cmd
+ col
+ Column
+ Command
-
- Default
- dir
- Directory
+ Default
+ dir
+ Directory
-
- Expanded
+ Expanded
-
- Find
+ Find
-
- Icon
- Image
- Invoke
+ Icon
+ Image
+ Invoke
-
- Keys
+ Keys
-
- Mode
- Menu
+ Mode
+ Menu
-
- Parent
- pos
- Position
+ Parent
+ pos
+ Position
-
- sep
- Separator
+ sep
+ Separator
-
- Tip
- Title
- Type
+ Tip
+ Title
+ Type
-
- Verb
- vis
- Visibility
+ Verb
+ vis
+ Visibility
-
- Wait
- Where
- Window
+ Wait
+ Where
+ Window
Entry types
The Applies column shows, whether the property applies to menus, items
- and/or separators.
- If set in bold, then the property is mandatory for the given type.
+ href="dynamic.html#menu" class="uline">menus, items and/or separators. If set in
+ bold, then the property is mandatory for the given type.
Syntax
@@ -92,9 +89,8 @@
Display menuitem if true is returned. Allows the evaluation of arbitrary
- expressions, e.g.
- if
+ expressions, e.g. if
Default = true
@@ -105,12 +101,10 @@
I
Sets the caption of the menuitem.
- It is mandatory for menu and It is mandatory for menu and item entries, unless a image property is defined.
+ class="uline">image property is defined.
Default = null
@@ -122,7 +116,7 @@
S
Display menuitem by type of selection. The value has one of the following parameters
(of type string):
@@ -135,8 +129,7 @@
multi_unique
- Display menuitem when multiple objects of the same Display menuitem when multiple objects of the same type are selected.
@@ -291,7 +284,7 @@
Static
Display menuitem as label, with or without an image
+ class="uline">image
Label
@@ -364,9 +357,7 @@
I
S
The position at which a menuitem should be inserted into the menu.
+ href="dynamic.html#menu" class="uline">menu.
Position can have one of the following parameters:
@@ -375,22 +366,19 @@
Middle
- Insert the menuitem to the middle of the Insert the menuitem to the middle of the menu.
Top
- Insert the menuitem to the top of the Insert the menuitem to the top of the menu.
Bottom
- Insert the menuitem to the bottom of the Insert the menuitem to the bottom of the menu.
@@ -448,8 +436,7 @@
M
I
S
- Move current menuitem to another Move current menuitem to another menu.
Default = null
@@ -470,9 +457,8 @@
I
- The command line parameters to pass to the command
- property of a menuitem.
+ The command line parameters to pass to the command property of a menuitem.
Default = null
@@ -486,13 +472,13 @@
0, single
- execute the execute the command for each selected object
1, multiple
- execute the execute the command in one process
@@ -506,9 +492,9 @@
I
- Controls how the window of the executed command
- is to be shown. Can be one of the following parameters:
+ Controls how the window of the executed command is to be shown. Can be one of the following
+ parameters:
Hidden, Show, Visible,
Minimized, Maximized
Default = show
@@ -521,9 +507,7 @@
I
Specifies the working directory to execute
- the command in.
+ the command in.
Default = null
@@ -533,8 +517,8 @@
I
- Execute the command with administrative permissions.
+ Execute the command
+ with administrative permissions.
Default = false
@@ -545,8 +529,7 @@
I
Specifies the default operation for the selected file. Value type string
+ href="/docs/syntax/static.html" class="uline">string
and can have one of the following parameters:
@@ -596,8 +579,7 @@
I
- Wait for the command
+
Wait for the command
to complete.
Default = false
@@ -633,10 +615,10 @@
I
- Specifies that the Specifies that the item is the default. A menu
- can contain only one default menuitem, which is displayed in bold.
+ class="uline">menu can contain only one default
+ menuitem, which is displayed in bold.
Default = false
@@ -647,9 +629,8 @@
- Move all immediate menuitems to the parent menu.
-
+ Move all immediate menuitems to the parent menu.
Default = false
@@ -678,11 +659,9 @@
I
- Show a tooltip for the current menuor
- item.
-
+ Show a tooltip for the current menuor item.
Default = null
Syntax
From 89854aaf0b9981b392dd98ce4e75183dfb39f0f2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martin=20R=C3=BCegg?=
Date: Mon, 6 Mar 2023 20:25:28 +0100
Subject: [PATCH 4/9] Cleanup whitespace
---
docs/syntax/static.html | 481 +++++++++++++++++++++-------------------
1 file changed, 249 insertions(+), 232 deletions(-)
diff --git a/docs/syntax/static.html b/docs/syntax/static.html
index 7b885c3..133c1ab 100644
--- a/docs/syntax/static.html
+++ b/docs/syntax/static.html
@@ -1,6 +1,9 @@
Static Items
-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.
+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:
shell
{
@@ -16,12 +19,12 @@
-
- Property
- Summary
-
-
-
+
+ Property
+ Summary
+
+
+
Where
Allow menu item to be passed if a true value is returned
@@ -30,241 +33,254 @@
Find
- Accept menuitem when the specific menuitem title is contains or equal to the current find property.
Use this delimiter | to separate patterns.
- This property must be included with another property at least if where property is not defined.
+ Accept menuitem when the specific menuitem title is contains or equal to the current find property.
Use
+ this delimiter | to separate patterns.
+ This property must be included with another property at least if where
+ property is not defined.
Default = null
-
-
Syntax
-find = 'undo' Find any word contains "undo"
-find = '"undo"' Match whole word only
-find = '*undo' Find a word that ends with
-find = 'undo*' Find a word that starts with
-
-find = '!undo' Find any word not contains "undo"
-find = '!"undo"' Search for any word not equal to "undo"
-find = '!*undo' Find a word that not ends with
-find = 'undo*!' Find a word that starts with
-
-find = 'undo delete|undo copy' Find an equal title for "undo delete" or "undo copy"
+
+
Syntax
+ find = 'undo' Find any word contains "undo"
+ find = '"undo"' Match whole word only
+ find = '*undo' Find a word that ends with
+ find = 'undo*' Find a word that starts with
+
+ find = '!undo' Find any word not contains "undo"
+ find = '!"undo"' Search for any word not equal to "undo"
+ find = '!*undo' Find a word that not ends with
+ find = 'undo*!' Find a word that starts with
+
+ find = 'undo delete|undo copy' Find an equal title for "undo delete" or "undo copy"
- In
-
- Determine the path of the menu being searched.
- Default = null
-
+ In
+
+ Determine the path of the menu being searched.
+ Default = null
+
- Title
-
- Change value indicating the caption of the menuitem.
- Default = null
-
+ Title
+
+ Change value indicating the caption of the menuitem.
+ Default = null
+
- 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 = multiple
-
+ 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 = multiple
+
- 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.
-
-
- Dirctory(Dir)
- Accept menuitem when Dirctory 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.
+
+
+ Dirctory(Dir)
+ Accept menuitem when Dirctory 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
- Hide the menuitem.
-
-
- Normal
- Enabled the menuitem.
-
-
- Disable
- Disabled the menuitem.
-
-
- Default = normal
-
+ Visibility (vis)
+ Visibility of menuitem and can have one of the following parameters:.
+
+
+ Hidden
+ Hide the menuitem.
+
+
+ Normal
+ Enabled the menuitem.
+
+
+ Disable
+ Disabled the menuitem.
+
+
+ Default = normal
+
- 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
-
+ 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
+
- 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
-
+ 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
+
- 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
-
-
- Null
- Show menuitem without icon.
-
-
- Inherit
- Inheriting the image from the parent.
-
-
- Glyph
- Assign image as Glyph.
-
-
- Color
- Assign image as color.
-
-
- Path
- Assign image from location path or resource icon.
-
-
- Default = null
-
+ 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
+
+
+ Null
+ Show menuitem without icon.
+
+
+ Inherit
+ Inheriting the image from the parent.
+
+
+ Glyph
+ Assign image as Glyph.
+
+
+ Color
+ Assign image as color.
+
+
+ Path
+ Assign image from location path or resource icon.
+
+
+ Default = null
+
Checked
@@ -290,20 +306,20 @@ find = 'undo delete|undo copy' Find an equal title for "undo delete" or "undo co
Parent, Menu
Move current menu item(s) to another menu.
- Default = null
+ Default = null
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]
@@ -313,10 +329,11 @@ tip = ["Lorem Ipsum is simply dummy text.", tip.info, 1.2]
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
-
+
From aca92962f4f2b33e66280415e592f6ef0de6b339 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Martin=20R=C3=BCegg?=
Date: Mon, 13 Mar 2023 08:09:00 +0100
Subject: [PATCH 5/9] Move static `properties` section to properties.html
---
docs/syntax/dynamic.html | 14 +-
docs/syntax/properties.html | 399 +++++++++++++++++++++++++-----------
docs/syntax/static.html | 354 ++------------------------------
3 files changed, 302 insertions(+), 465 deletions(-)
diff --git a/docs/syntax/dynamic.html b/docs/syntax/dynamic.html
index 9205fd2..f01dfbc 100644
--- a/docs/syntax/dynamic.html
+++ b/docs/syntax/dynamic.html
@@ -1,8 +1,8 @@
-Dynamic Items
+Dynamic Items
-The dynamic section adds new menu items to the context menu.
+The optional dynamic section adds new menu items to the context menu.
-Sub-items
+Sub-items
The section can have the following entry types, all of which are optional:
- One
var block to define "local" variables.
@@ -27,7 +27,7 @@
While the var block should be at the top of the section, the other entries can appear in any order.
-Example
+Example
In the following example, one top-level item is created, that is
separated with a horizontal line from an adjacent sub-menu, which in turn has one sub-Properties
Either a title or a image property is mandatory (set to a non-null value). For further details,
- please refer to the properties section below.
+ please refer to the properties page.
Syntax
item( title = value [property = value [...] ])
@@ -80,7 +80,7 @@
Properties
Either a title or a image property is mandatory (set to a non-null value). For further details,
- please refer to the properties section below.
+ please refer to the properties page.
Sub-items
menus can have the following entry types, all of which are
@@ -118,7 +118,7 @@
Properties
separators do not have any mandatory properties. Please refer to the properties section below for further details.
+ href="properties.html" class="uline">properties page for further details.
Syntax
separator
diff --git a/docs/syntax/properties.html b/docs/syntax/properties.html
index 83d95d3..5c0f215 100644
--- a/docs/syntax/properties.html
+++ b/docs/syntax/properties.html
@@ -65,11 +65,28 @@
Entry types
-The Applies column shows, whether the property applies to menus, items and/or separators. If set in
- bold, then the property is mandatory for the given type.
+The Types column shows to which entry types the property applies to,
+ where the following abbreviations are used. If set in bold, then the property is mandatory for the given type.
+
+
+ - se
+ - static entry, i.e. the
+ item
+ entry itself. Is basically required to evaluate if the process instructions are applied to any given target.
+
+ - st
+ - static target, i.e.
+ the menuitem of the existing menu to which the process instructions are applied
+
+ - dm
+ - dynamic menu
+ - di
+ - dynamic item
+ - ds
+ - dynamic separator.
+
+
Syntax
@@ -77,7 +94,7 @@
Property
- Applies
+ Types
Summary
@@ -85,36 +102,230 @@
Where
- M
-
-
- Display menuitem if true is returned. Allows the evaluation of arbitrary
+ si, dm, di, ds
+ Process given menuitem if true is returned. Allows the evaluation of arbitrary
expressions, e.g. if
+ href="/docs/functions/index.html#if" class="uline">if().
Default = true
+
+
+ Find
+ dm, di, ds
+
+
+ - For static items (required)
+ - Apply the current item's process instructions to any existing menuitem if their
title property matches the
+ pattern of the current item's find property.
+
+ - For dynamic items (optional)
+ Display the current menuitem if the pattern of its find property matches the
+ path name or path extension
+ of the selected files.
+ Default = null, which means any string is "matched".
+
+
+
+ - Syntax
+ -
+
find = '%pattern%'
+find = '%pattern%|%pattern%[...]'
+ where %pattern% can be one or
+ more
+ matching instructions (see Examples below). The
+ following characters do have special meaning:
+
+ | Use to separate patterns. If any one pattern
+ matches,
+ the property yields
+ true.
+
+ * Matches any number of characters. Is used as a
+ wildcard
+ to
+ match only the beginning or the end of the entire string (or word, if used in
+ combination with the exclamation mark !).
+
+ ! Negates the match of the current pattern, or
+ limits
+ the wildcard (*) to one word only.
+
+ "" the enclosed string is treated as a word.
+
+
+ A word is a sequence of
+ alphanumerical characters that is confined to the left and to the right by either a
+ space
+ , a non-word character (e.g. / or -), or the
+ beginning or the end of the entire string, respectively.
+ - Examples
+ -
+
+
+
+
+ Pattern
+ Matches any string that ...
+ Would match
+ Would not match
+
+
+
+
+ 'foo'
+ contains the literal string foo anywhere.
+ foo, foobar, afoobar
+ fo, f oo, bar
+
+
+ '"foo"'
+ contains the literal string foo as a whole word
+ only.
+
+ foo, foo/bar, some foo bar
+ foobar, foofoo, bar
+
+
+
+
+ '*foo'
+ ends with the literal string foo.
+ foo, barfoo, bar/foo
+ foobar, fooo, foo
+
+
+ 'foo*'
+ starts with the literal string foo.
+
+ foo, foobar, foo/bar
+ foobar, fo, yeti
+
+
+
+
+ '!foo'
+ does not contain the literal string foo anywhere.
+
+ fobar, fo, kung-fu
+ foo, foobar, barfoo/bar
+
+
+ '!"foo"'
+ does not contain the word
+ foo
+ fobar, kung fu bar, foobar
+ foo, kung foo bar, bar/foo/bar
+
+
+ '!*foo'
+ does not contain a word ending on
+ foo
+ foobar, fooo-fo
+ foo, foo bar, bar/foo
+
+
+ 'foo*!'
+ does not contain a word stharting
+ wit
+ foo
+ myFooBar, barFoo
+ foo, foobar, fo-fooo
+
+
+
+
+
+
For dynamic items the following syntax allows to match against file
+ extensions:
+
+
+
+
+
+ Pattern
+ Matches any file extension ...
+ Would match
+ Would not match
+
+
+
+
+ '.exe'
+ equal to .exe
+ setup.exe, notepad.exe
+ install.bat, shell.nss, shell.ex_,
+ file
+ without an extension.
+
+
+
+ '!.exe'
+ not equal to .exe
+ setup.exe.zip, video.mp4, shell.ex_,
+ file
+ without an extension.
+
+ setup.exe, shell.exe
+
+
+
+
+ '.exe|.dll'
+ equal to either .exe or .dll
+ shell.exe, shell.dll
+
+ shell.zip, shell.nss, file
+ without an extension.
+
+
+
+
+
+
+
+
+
+
+
Title
- M
- I
-
- Sets the caption of the menuitem.
- It is mandatory for menu and item entries, unless a image property is defined.
- Default = null
+ st, dm, di
+
+ Sets the caption of the menuitem.
+
Mode
- M
- I
- S
- Display menuitem by type of selection. The value has one of the following parameters
+ si, dm, di, ds
+ Display menuitem by type of selection. The value has one of the following
+ parameters
(of type string):
@@ -148,11 +359,11 @@
Type
- M
- I
- S
+ si, dm, di, ds
Specifies the types of objects for which the menuitem will be displayed.
- Possible values are shown below. Separate multiple types with the pipe character (|), in
+ Possible values are shown below. Separate multiple types with the pipe character (|),
+ in
which case the menuitem is displayed if any of the given types is matched.
To exclude a given type, prefix its value with the tilde character (~).
Expressions are not supported with this property.
@@ -264,22 +475,21 @@
Visibility (vis)
- M
- I
- S
+ st, dm, di, ds
Sets the visibility of a menuitem. Can have one of the following parameters:
Normal
- Enabled the menuitem.
+ Enable the menuitem.
Disable
- Disabled the menuitem.
+ Disable the menuitem.
Static
@@ -291,43 +501,17 @@
Display menuitem as label without an image
+
+ Note:The values Static and Label are not available for static targets.
+
Default = Normal
-
-
- Find
- M
- I
- S
-
- Display menuitem when the specified path name or path extension matches the current
- find property.
- Separate patterns by the pipe delimiter (|).
- 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"
-
-
-
Separator (sep)
- M
- I
-
+ st, dm, di
Add a separator to the menuitem:
@@ -353,9 +537,8 @@
Position (pos)
- M
- I
- S
+ st, dm, di, ds
The position at which a menuitem should be inserted into the menu.
Position can have one of the following parameters:
@@ -393,9 +576,8 @@
Image, Icon
- M
- I
-
+ st, dm, di
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
@@ -427,15 +609,18 @@
Assign image from location path or resource icon.
+
+ Note:The value Cmd is not available for static
+ targets.
+
Default = null
Parent, Menu
- M
- I
- S
+ st, dm, di, ds
Move current menuitem to another menu.
Default = null
@@ -443,9 +628,7 @@
Command (cmd)
-
- I
-
+ di
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
@@ -454,10 +637,9 @@
Arguments (arg, args)
-
- I
-
- The command line parameters to pass to the di
+ The command line parameters to pass to the command property of a menuitem.
Default = null
@@ -465,9 +647,7 @@
Invoke
-
- I
-
+ di
Set execution type