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:


Please also note the following reference sections:


@@ -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\.


Uninstall
-

Open an elevated command prompt (or use gsudo), - and run

+

Open an elevated command prompt (or use gsudo), and run

choco uninstall 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 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.

-

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.

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 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.
    • As of version 1.8.0, set{} has replaced the - section default{} for default values, which is now deprecated. - Please use set{} for new installations. + section default{} for + default values, which is now deprecated. Please use set{} for new installations.
  • -
  • 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.
  • @@ -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
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 @@ - @@ -291,7 +284,7 @@ + class="uline">image @@ -364,9 +357,7 @@
multi_uniqueDisplay menuitem when multiple objects of the same Display menuitem when multiple objects of the same type are selected.
Static Display menuitem as label, with or without an image
LabelI 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 @@ - - - @@ -448,8 +436,7 @@ - @@ -470,9 +457,8 @@ - @@ -486,13 +472,13 @@
MiddleInsert the menuitem to the middle of the Insert the menuitem to the middle of the menu.
TopInsert the menuitem to the top of the Insert the menuitem to the top of the menu.
BottomInsert the menuitem to the bottom of the Insert the menuitem to the bottom of the menu.
M I S

Move current menuitem to another

Move current menuitem to another menu.

Default = null
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
- - @@ -506,9 +492,9 @@ - @@ -533,8 +517,8 @@ - @@ -545,8 +529,7 @@
0, singleexecute the execute the command for each selected object
1, multipleexecute the execute the command in one process
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
I

Execute the command with administrative permissions.

+

Execute the command + with administrative permissions.

Default = false
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 @@ @@ -633,10 +615,10 @@ @@ -647,9 +629,8 @@ @@ -678,11 +659,9 @@
I -

Wait for the command +

Wait for the command to complete.

Default = false
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
-

Move all immediate menuitems to the parent menu. -

+

Move all immediate menuitems to the parent menu.

Default = false
I -

Show a tooltip for the current menuor - item. -

+

Show a tooltip for the current menuor item.

Default = null
Syntax