mirror of
https://github.com/moudey/Shell.git
synced 2026-11-16 09:04:25 +08:00
Merge pull request #200 from metaworx/update-documentation
Update documentation
This commit is contained in:
6 files changed
+1408
-1308
No files matched your search
@@ -13,8 +13,7 @@
|
||||
|
||||
<section id="app.cfg" class="my-5">
|
||||
<h5>app.cfg</h5>
|
||||
<p>Returns the path of the <a href="../syntax/index.html#shell.nss"
|
||||
style="border-bottom: 1px solid currentColor;"><span
|
||||
<p>Returns the path of the <a href="/docs/syntax/index.html#shell.nss" class="uline"><span
|
||||
class="is-family-monospace">configuration file</span></a> <code>shell.nss</code> (or <code>shell.shl</code>
|
||||
in older installations).</p>
|
||||
<p>Syntax</p>
|
||||
@@ -72,8 +71,8 @@
|
||||
|
||||
<section id="app.reload" class="my-5">
|
||||
<h5>app.reload</h5>
|
||||
<p>Reload the <a href="../syntax/index.html#shell.nss" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">configuration file</span></a>.</p>
|
||||
<p>Reload the <a href="/docs/syntax/index.html#shell.nss" class="uline"><span class="is-family-monospace">configuration file</span></a>.
|
||||
</p>
|
||||
<p>Syntax</p>
|
||||
<pre><code>app.reload // usage in section context
|
||||
'@app.reload' // usage inside quoted-string literals</code></pre>
|
||||
@@ -81,8 +80,8 @@
|
||||
|
||||
<section id="app.unload" class="my-5">
|
||||
<h5>app.unload</h5>
|
||||
<p>Unload the <a href="../syntax/index.html#shell.nss" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">configuration file</span></a>.</p>
|
||||
<p>Unload the <a href="/docs/syntax/index.html#shell.nss" class="uline"><span class="is-family-monospace">configuration file</span></a>.
|
||||
</p>
|
||||
<p>Syntax</p>
|
||||
<pre><code>app.unload // usage in section context
|
||||
'@app.unload' // usage inside quoted-string literals</code></pre>
|
||||
|
||||
+199
-199
File diff suppressed because it is too large.
Load diff
+31
-736
File diff suppressed because it is too large.
Load diff
+35
-45
@@ -1,70 +1,61 @@
|
||||
<h4>Syntax Rules for Configuration Files</h4>
|
||||
<br>
|
||||
<p>This chapter describes the syntax rules for the configuration files.</p>
|
||||
<p>The main configuration file <a href="#shell.nss"
|
||||
style="border-bottom: 1px solid currentColor;"><code>shell.nss</code></a> (or <code>shell.shl</code> in older
|
||||
installations) is located in the <span class="is-family-monospace">installation directory</span> of
|
||||
<strong>Shell</strong>, depending on your <a href="../installation.html"
|
||||
style="border-bottom: 1px solid currentColor;">installation method</a>.</p>
|
||||
<p>The main configuration file <a href="#shell.nss" class="uline"><code>shell.nss</code></a> (or <code>shell.shl</code>
|
||||
in older installations) is located in the <span class="is-family-monospace">installation directory</span> of
|
||||
<strong>Shell</strong>, depending on your <a href="/docs/installation.html" class="uline">installation method</a>.
|
||||
</p>
|
||||
|
||||
<h5 id="syntax-general">General rules</h5>
|
||||
<ul>
|
||||
<li>Syntax is case-insensitive.</li>
|
||||
<li>Spaces around the equal (<code>=</code>) sign are optional and are ignored.</li>
|
||||
<li>The properties of <a href="static.html" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">static</span></a> and <a href="dynamic.html"
|
||||
style="border-bottom: 1px solid currentColor;"><span class="is-family-monospace">dynamic</span></a> items
|
||||
are separated by blank spaces or on a <a href="#breaking-long-lines"
|
||||
style="border-bottom: 1px solid currentColor;">separate line</a> and must be
|
||||
placed in parentheses <code>( )</code>.
|
||||
<li>The properties of <a href="static.html" class="uline"><span class="is-family-monospace">static</span></a> and <a
|
||||
href="dynamic.html" class="uline"><span class="is-family-monospace">dynamic</span></a> items are separated
|
||||
by blank spaces or on a <a href="#breaking-long-lines" class="uline">separate line</a> and must be placed in
|
||||
parentheses <code>( )</code>.
|
||||
</li>
|
||||
<li>Other configuration files can be imported using the <a href="#import"
|
||||
style="border-bottom: 1px solid currentColor;"><span class="is-family-monospace">import</span> tag</a>.
|
||||
<li>Other configuration files can be imported using the <a href="#import" class="uline"><span
|
||||
class="is-family-monospace">import</span> tag</a>.
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="notification is-info is-light">
|
||||
<i>Tip:</i> When there is an error, it is recorded in the log file (<code>shell.log</code>, which is also located in
|
||||
your <a href="../installation.html" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">installation directory</span></a>.).
|
||||
your <a href="/docs/installation.html" class="uline"><span class="is-family-monospace">installation directory</span></a>.).
|
||||
</div>
|
||||
|
||||
<h5 id="shell.nss">shell.nss structure</h5>
|
||||
<p>The global section <code>shell{}</code> may have the following subsections:</p>
|
||||
<ul>
|
||||
<li>Section <a href="variables.html" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">var{}</span></a> for global variables. Optional.
|
||||
<li>Section <a href="variables.html" class="uline"><span class="is-family-monospace">var{}</span></a> for global
|
||||
variables. Optional.
|
||||
</li>
|
||||
<li>Section <a href="set.html" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">set{}</span></a> for settings. Optional.
|
||||
<li>Section <a href="set.html" class="uline"><span class="is-family-monospace">set{}</span></a> for settings.
|
||||
Optional.
|
||||
<ul>
|
||||
<li>As of version <code>1.8.0</code>, <span class="is-family-monospace">set{}</span> has replaced the
|
||||
section <a href="default.html" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">default{}</span></a> for default values, which is now <strong>deprecated</strong>.
|
||||
Please use <a href="set.html" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">set{}</span></a> for new installations.
|
||||
section <a href="default.html" class="uline"><span class="is-family-monospace">default{}</span></a> for
|
||||
default values, which is now <strong>deprecated</strong>. Please use <a href="set.html"
|
||||
class="uline"><span class="is-family-monospace">set{}</span></a> for new installations.
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Section <a href="static.html" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">static{}</span></a> with instructions on how to <strong>change existing
|
||||
menuitems</strong>. Optional.
|
||||
<li>Section <a href="static.html" class="uline"><span class="is-family-monospace">static{}</span></a> with
|
||||
instructions on how to <strong>change existing menuitems</strong>. Optional.
|
||||
<ul>
|
||||
<li>Static items are only of one type: item.</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>Section <a href="dynamic.html" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">dynamic{}</span></a> with definitions for <strong>new <a
|
||||
href="dynamic.html#menuitem" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">menuitems</span></a></strong>. Optional.
|
||||
<li>Section <a href="dynamic.html" class="uline"><span class="is-family-monospace">dynamic{}</span></a> with
|
||||
definitions for <strong>new <a href="dynamic.html#menuitem" class="uline"><span class="is-family-monospace">menuitems</span></a></strong>.
|
||||
Optional.
|
||||
<ul>
|
||||
<li>Dynamic <a href="dynamic.html#menuitem" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">menuitems</span></a> may have one of three types: <a
|
||||
href="dynamic.html#menu" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">menu</span></a>, <a href="dynamic.html#item"
|
||||
style="border-bottom: 1px solid currentColor;"><span class="is-family-monospace">item</span></a>,
|
||||
or <a href="dynamic.html#separator" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">separator (sep)</span></a>.
|
||||
<li>Dynamic <a href="dynamic.html#menuitem" class="uline"><span class="is-family-monospace">menuitems</span></a>
|
||||
may have one of three types: <a href="dynamic.html#menu" class="uline"><span
|
||||
class="is-family-monospace">menu</span></a>, <a href="dynamic.html#item" class="uline"><span
|
||||
class="is-family-monospace">item</span></a>, or <a href="dynamic.html#separator"
|
||||
class="uline"><span class="is-family-monospace">separator (sep)</span></a>.
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
@@ -173,12 +164,11 @@
|
||||
</ul>
|
||||
The section name is written literally, without any quotes (or the percent signs).
|
||||
</li>
|
||||
<li id="import-syntax-path"><code>%path%</code> is a <a href="../expressions/string.html"
|
||||
style="border-bottom: 1px solid currentColor;"><span class="is-family-monospace">string</span></a> 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 <span class="is-family-monospace">import</span> tag is used, or it can be an absolute path.
|
||||
Expressions are supported when using <a href="../expressions/string.html#single-quotes"
|
||||
style="border-bottom: 1px solid currentColor;"><span
|
||||
<li id="import-syntax-path"><code>%path%</code> is a <a href="/docs/expressions/string.html"
|
||||
class="uline"><span class="is-family-monospace">string</span></a> 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 <span
|
||||
class="is-family-monospace">import</span> tag is used, or it can be an absolute path. Expressions are
|
||||
supported when using <a href="/docs/expressions/string.html#single-quotes" class="uline"><span
|
||||
class="is-family-monospace">single quotes</span></a>.
|
||||
</li>
|
||||
</ul>
|
||||
@@ -283,6 +273,6 @@ The result would then look like so:
|
||||
<p>This syntax may be used nearly anywhere: </p>
|
||||
<ul>
|
||||
<li>in any section</li>
|
||||
<li>in the body of <a href="dynamic.html#menu" style="border-bottom: 1px solid currentColor;"><span
|
||||
class="is-family-monospace">menu</span> tags</a></li>
|
||||
<li>in the body of <a href="dynamic.html#menu" class="uline"><span class="is-family-monospace">menu</span> tags</a>
|
||||
</li>
|
||||
</ul>
|
||||
File diff suppressed because it is too large.
Load diff
+101
-322
File diff suppressed because it is too large.
Load diff
Reference in new issue
Block a user