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 @@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 @@
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:
Please also note the following reference sections:
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.
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.
+
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.
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
For further details see the chapter Command-Line Help below.
+For further details see the chapter Command-Line Help below.
Scoop can be installed following the instructions at scoop.sh.
+Scoop can be installed following the instructions at scoop.sh.
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.
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 can be installed following the instructions at chocolatey.org.
+Chocolatey can be installed following the instructions at chocolatey.org.
choco install nilesoft.shell --version=1.8.11.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\.
The section 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.
+ 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.
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.
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