diff --git a/docs/functions/app.html b/docs/functions/app.html
index a21c63a..21f165e 100644
--- a/docs/functions/app.html
+++ b/docs/functions/app.html
@@ -13,8 +13,7 @@
Returns the path of the Returns the path of the configuration file Syntax Reload the configuration file. Reload the configuration file.
+ Syntax Unload the configuration file. Unload the configuration file.
+ Syntax Shell can be installed in the following ways: Please also note the following reference sections: Download the
- installation file (Installer/Portable),
- run The program will be installed to Inside the Shell program folder ( Download the
- installation file (Installer/Portable),
- run Open an elevated command prompt (or use gsudo),
- change to the directory you have extracted the program to,
- and run For further details see the chapter Command-Line Help below. Open an elevated command prompt (or use gsudo),
- change to the directory you have extracted the program to,
- and run For further details see the chapter Command-Line Help below. Windows Package Manager is available from Windows 10 version 1809. Open a command prompt, and run The program will be installed to Open a command prompt, and run Scoop can be installed following the instructions at scoop.sh. Open a command prompt, and run The program will be installed to Open an elevated command prompt (or use gsudo),
- and run For further details see the chapter Command-Line Help below. Open an elevated command prompt (or use gsudo),
- and run Then run Chocolatey can be installed following the instructions at chocolatey.org. Open an elevated command prompt (or use gsudo),
- and run The program will be installed to Open an elevated command prompt (or use gsudo),
- and run These keys are used when you press Shell can be installed in the following ways: Please also note the following reference sections: Download the installation file (Installer/Portable),
+ run The program will be installed to Inside the Shell program folder ( Download the
+ installation file (Installer/Portable),
+ run Open an elevated command prompt (or use gsudo), change to the directory you have extracted the program to, and run For further details see the chapter Command-Line Help below. Open an elevated command prompt (or use gsudo), change to the directory you have extracted the program to, and run For further details see the chapter Command-Line Help below. Windows Package Manager is available from Windows 10 version 1809. Open a command prompt, and run The program will be installed to Open a command prompt, and run Scoop can be installed following the instructions at scoop.sh. Open a command prompt, and run The program will be installed to Open an elevated command prompt (or use gsudo), and run For further details see the chapter Command-Line Help below. Open an elevated command prompt (or use gsudo), and run Then run Chocolatey can be installed following the instructions at chocolatey.org. Open an elevated command prompt (or use gsudo), and run The program will be installed to Open an elevated command prompt (or use gsudo), and run These keys are used when you press The The optional The section can have the following entry types, all of which are optional: While the In the following example, one top-level In the following example, one top-level menuitem is an umbrella term for those entry types, that may appear in a
menu. These simply include the following: items create a single menu entry. Either a Either a app.cfg
- shell.nss (or shell.shl
in older installations).app.reload
-
@@ -81,8 +80,8 @@
app.reload // usage in section context
'@app.reload' // usage inside quoted-string literalsapp.unload
-
diff --git a/docs/installation.html b/docs/installation.html
index 61c165d..d0aa825 100644
--- a/docs/installation.html
+++ b/docs/installation.html
@@ -1,199 +1,199 @@
-app.unload // usage in section context
'@app.unload' // usage inside quoted-string literalsInstallation
-
-
-
-
-
-
-Installer version
- Install
- setup.exe,
- follow the installation steps,
- and agree to restart Windows File Explorer.C:\Program Files\Nilesoft Shell\, unless you have chosen
- a different installation path during the installation steps.
- Uninstall
- 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
- setup.exe,
- click Next, chose the folder you want the program to be extracted to,
- Check the option Portable Mode, and click
- Extract.shell -register -restart
-
- Uninstall
- shell -unregister -restart
-
-
-
-
-Windows Package Manager
- Install
- winget install Nilesoft.Shell
- C:\Program Files\Nilesoft Shell\.
- Uninstall
- winget uninstall Nilesoft.Shell
-
-
-Scoop
- Install
- scoop install nilesoft-shell
- %USERPROFILE%\scoop\apps\nilesoft-shell\current\.
- Couldn't find manifest for 'nilesoft-shell', please run
- scoop bucket add extras first.
-
- shell -register -restart
-
- Uninstall
- shell -unregister -restart
- scoop uninstall nilesoft-shell
-
-
-Chocolatey
- Install
-
- 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).
-
- choco install nilesoft.shell
- C:\Program Files\Nilesoft Shell\.
- Uninstall
- 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
- right-click or press Shift+F10 keysCTRL 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
+
+
+
+
+
+
+Installer version
+ Install
+ setup.exe, follow the installation steps, and agree to restart Windows File Explorer.C:\Program Files\Nilesoft Shell\, unless you have chosen
+ a different installation path during the installation steps.
+ Uninstall
+ 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
+ setup.exe,
+ click Next, chose the folder you want the program to be extracted
+ to, Check the option Portable Mode, and click
+ Extract.shell -register -restart
+
+ Uninstall
+ shell -unregister -restart
+
+
+
+
+Windows Package Manager
+ Install
+ winget install Nilesoft.Shell
+ C:\Program Files\Nilesoft Shell\.
+ Uninstall
+ winget uninstall Nilesoft.Shell
+
+
+Scoop
+ Install
+ scoop install nilesoft-shell
+ %USERPROFILE%\scoop\apps\nilesoft-shell\current\.
+ Couldn't find manifest for 'nilesoft-shell', please run
+ scoop bucket add extras first.
+
+ shell -register -restart
+
+ Uninstall
+ shell -unregister -restart
+ scoop uninstall nilesoft-shell
+
+
+Chocolatey
+ Install
+
+ 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).
+
+ choco install nilesoft.shell
+ C:\Program Files\Nilesoft Shell\.
+ Uninstall
+ 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
+ right-click or press Shift+F10 keysCTRL 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
+Dynamic Items
+Dynamic Items
-dynamic section adds new menu items to the context menu.dynamic section adds new menu items to the context menu.Sub-items
+Sub-items
-
var block to
- define "local" variables.
+ var block to define "local" variables.
-
item entries.
+ item entries.
These appear as top-level items in a context menu.
menu entries.
+ menu entries.
These appear as top-level sub-menus in a context menu.
separator
- entries. These create a horizontal line between the given entries.
+ separator entries. These create a
+ horizontal line between the given entries.
. 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.
importsvar block should be at the top of the section, the other entries can appear in any order.Example
-item is created, that is separated with a horizontal line from an adjacent sub-menu,
- which in turn has one sub-item
+Example
+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 @@
@@ -67,10 +64,9 @@
Properties
-title or a image property is
- mandatory (set to a non-null value). For further details, please refer to the properties section below.title or a image property is mandatory (set to a non-null value). For further details,
+ please refer to the properties page.Syntax
@@ -82,31 +78,26 @@
and sub-entries.item( title = value [property = value [...] ])
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 page.
menus can have the following entry types, all of which are optional:
var block to
- define "local" variables.
+ var block to define "local" variables.
item entries.
- menu entries.
- separator
- entries. These create a horizontal line between the given entries.
+ item entries.menu entries.separator entries. These create a
+ horizontal line between the given entries.
imports. The content of the
+ imports. The content of the
given file will be placed in the position of the import.
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.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 -
- |
- ||||||||||||||||||||||||||||||||
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.
+
=) sign are optional and are ignored.( ).
+ ( ).
shell.log, which is also located in
- your installation directory.).
+ your installation directory.).
The global section shell{} may have the following subsections:
%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 %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.
This syntax may be used nearly anywhere:
diff --git a/docs/syntax/properties.html b/docs/syntax/properties.html new file mode 100644 index 0000000..c3ce195 --- /dev/null +++ b/docs/syntax/properties.html @@ -0,0 +1,1037 @@ +Please also see the full index of available properties below.
+ +In the following tables, the Types column shows to which entry types the + property applies to.
+The following abbreviations are used (if set in bold, then the property is mandatory for the given type): +
+Determine if a given static + or dynamic entry should be + processed when a context menu is displayed.
+ + + +| Property | +Types(*) | +Summary | +||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Where | +si, dm, di, ds | +Process given menuitem if true is returned. Allows the evaluation of arbitrary
+ expressions, e.g. if().+ Default = true + |
+ ||||||||||||||||||||||||||||||||
| Mode | +si, dm, di, ds | +Display menuitem by type of selection. The value has one of the following
+ parameters
+ (of type string):
+
|
+ ||||||||||||||||||||||||||||||||
| Type | +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
+ 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. +
|
+
For static entries only, + filter properties determine if a given menuitem is a valid target for the process instructions
+ +| Property | +Types(*) | +Summary | +||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Find | +dm, di, ds | +
+
|
+ ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
This set of properties describe the appearance and location of a given menuitem. For static entries, this is + the + target menuitem. For dynamic entries, this is the newly created menuitem.
+ +This set of properties describe how a command is executed. Only available for dynamic items.
+ + + +| Property | +Types(*) | +Summary | +||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Command (cmd) | +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 + |
+ ||||||||||||||||||
| Arguments (arg, args) | +di | +The command line parameters to pass to the command property of a menuitem. + Default = null + |
+ ||||||||||||||||||
| Invoke | +di | +Set execution type
+
|
+ ||||||||||||||||||
| Window | +di | +Controls how the window of the executed command is to be shown. Can be one of the following
+ parameters:
+
|
+ ||||||||||||||||||
| Directory (dir) | +di | +Specifies the working directory to + execute + the command in. + Default = null + |
+ ||||||||||||||||||
| Admin | +di | +Execute the command + with administrative permissions. + Default = false + |
+ ||||||||||||||||||
| Verb | +di | +Specifies the default operation for the selected file. Value type string
+ and can have one of the following parameters: +
|
+ ||||||||||||||||||
| Wait | +di | +
+ Wait for the command + to complete. + Default = false + |
+
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
-{
- static
- {
- item(find = 'copy'image = #00ff00)
- item(find = 'paste' image = #0000ff)
- }
-}
-| Property | -Summary | -||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Where | -Allow menu item to be passed if a true value is returned - Default = true - |
- ||||||||||||||||||||||||||||||||
| 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. - 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" - |
- ||||||||||||||||||||||||||||||||
| In | -
- Determine the path of the menu being searched. - 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:
-
|
- ||||||||||||||||||||||||||||||||
| 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. -
Required for menu, item, separator. - |
- ||||||||||||||||||||||||||||||||
| Visibility (vis) | -Visibility of menuitem and can have one of the following parameters:.
-
|
- ||||||||||||||||||||||||||||||||
| Position (pos) | -The position at which a menuitem should be inserted into the menu. Position can have one of the following parameters: -
|
- ||||||||||||||||||||||||||||||||
| Separator (sep) | -Add separator with menuitem position by parameters:
-
|
- ||||||||||||||||||||||||||||||||
| 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
-
|
- ||||||||||||||||||||||||||||||||
| Checked | -Value that indicates whether the menuitem checked type:
-
Required for item. - |
- ||||||||||||||||||||||||||||||||
| Parent, Menu | -Move current menu item(s) to another menu. - Default = null |
- ||||||||||||||||||||||||||||||||
| Keys | -Show keyboard shortcuts. - Default = null |
- ||||||||||||||||||||||||||||||||
| Tip | -
- Show a tip for the current item - Default = null- Syntax -
- |
- ||||||||||||||||||||||||||||||||
| Default | -
- Specifies that the menuitem is the default. A menu can contain only one default menuitem, which is displayed in bold. - Default = false - |
-
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 = '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.