Replace a style with uline class

This commit is contained in:
Martin Rüegg committed 2023-03-09 12:40:03 +01:00
1 parent 9069c76d0b
commit 625e22358d
5 files changed
+177 -221

No files matched your search

+27 -39
View File
@@ -5,36 +5,33 @@
<h5 id="dynamic-sub-items">Sub-items</h5>
<p>The section can have the following entry types, all of which are <strong>optional</strong>:</p>
<ul>
<li>One <a href="variables.html" style="border-bottom: 1px solid currentColor;"> <code>var</code> block</a> to
define "local" variables.
<li>One <a href="variables.html" class="uline"> <code>var</code> block</a> to define "local" variables.
</li>
<li><span class="is-family-monospace">Menuitems</span>, i.e. one or more of the following:
<ul>
<li>One or more <a href="#item" style="border-bottom: 1px solid currentColor;"><code>item</code> entries</a>.
<li>One or more <a href="#item" class="uline"><code>item</code> entries</a>.
These appear as top-level items in a context menu.
</li>
<li>One or more <a href="#menu" style="border-bottom: 1px solid currentColor;"><code>menu</code> entries</a>.
<li>One or more <a href="#menu" class="uline"><code>menu</code> entries</a>.
These appear as top-level sub-menus in a context menu.
</li>
<li>One or more <a href="#separator" style="border-bottom: 1px solid currentColor;"><code>separator</code>
entries</a>. These create a horizontal line between the given entries.
<li>One or more <a href="#separator" class="uline"><code>separator</code> entries</a>. These create a
horizontal line between the given entries.
</li>
</ul>
</li>
<li>One or more <a href="index.html#import"
style="border-bottom: 1px solid currentColor;"><code><code>imports</code></code></a>. The content of the
given file will be placed in the position of the import.
class="uline"><code><code>imports</code></code></a>. The content of the given file will be placed in the
position of the import.
</li>
</ul>
<p>While the <code>var</code> block should be at the top of the section, the other entries can appear in any order.</p>
<h5 id="dynamic-items-examples">Example</h5>
<p>In the following example, one top-level <a href="#item"
style="border-bottom: 1px solid currentColor;"><code>item</code></a> is created, that is separated with a <a
href="#separator" style="border-bottom: 1px solid currentColor;">horizontal line</a> from an adjacent sub-<a
href="#menu" style="border-bottom: 1px solid currentColor;"><span class="is-family-monospace">menu</span></a>,
which in turn has one sub-<a href="#item" style="border-bottom: 1px solid currentColor;"><span
class="is-family-monospace">item</span></a>
<p>In the following example, one top-level <a href="#item" class="uline"><code>item</code></a> is created, that is
separated with a <a href="#separator" class="uline">horizontal line</a> from an adjacent sub-<a href="#menu"
class="uline"><span class="is-family-monospace">menu</span></a>, which in turn has one sub-<a href="#item"
class="uline"><span class="is-family-monospace">item</span></a>
on its own:</p>
<pre><code class="lang-shell">shell
{
@@ -55,9 +52,9 @@
<p><span class="is-family-monospace">menuitem</span> is an umbrella term for those entry types, that may appear in a
menu. These simply include the following:</p>
<ul>
<li><a href="#item" style="border-bottom: 1px solid currentColor;"><code>item</code></a></li>
<li><a href="#menu" style="border-bottom: 1px solid currentColor;"><code>menu</code></a></li>
<li><a href="#separator" style="border-bottom: 1px solid currentColor;"><code>separator</code></a></li>
<li><a href="#item" class="uline"><code>item</code></a></li>
<li><a href="#menu" class="uline"><code>menu</code></a></li>
<li><a href="#separator" class="uline"><code>separator</code></a></li>
</ul>
<br/>
@@ -67,11 +64,9 @@
<p><span class="is-family-monospace">item</span>s create a single menu entry.</p>
<h5 id="item-properties">Properties</h5>
<p>Either a <a href="properties.html#title"
style="border-bottom: 1px solid currentColor;"><code>title</code></a> or a <a
href="properties.html#image" style="border-bottom: 1px solid currentColor;"><code>image</code></a>
property is mandatory (set to a non-null value). For further details, please refer to the <a href="properties.html"
style="border-bottom: 1px solid currentColor;">properties section</a> below.</p>
<p>Either a <a href="properties.html#title" class="uline"><code>title</code></a> or a <a href="properties.html#image"
class="uline"><code>image</code></a> property is mandatory (set to a non-null value). For further details,
please refer to the <a href="properties.html" class="uline">properties section</a> below.</p>
<h5 id="item-syntax">Syntax</h5>
<pre><code class="lang-shell">item( title = value [property = value [...] ])</code></pre>
@@ -83,32 +78,26 @@
and sub-entries.</p>
<h5 id="menu-properties">Properties</h5>
<p>Either a <a href="properties.html#title"
style="border-bottom: 1px solid currentColor;"><code>title</code></a> or a <a
href="properties.html#image" style="border-bottom: 1px solid currentColor;"><code>image</code></a>
property is mandatory (set to a non-null value). For further details, please refer to the <a href="properties.html"
style="border-bottom: 1px solid currentColor;">properties section</a> below.</p>
<p>Either a <a href="properties.html#title" class="uline"><code>title</code></a> or a <a href="properties.html#image"
class="uline"><code>image</code></a> property is mandatory (set to a non-null value). For further details,
please refer to the <a href="properties.html" class="uline">properties section</a> below.</p>
<h5 id="menu-sub-items">Sub-items</h5>
<p><span class="is-family-monospace">menu</span>s can have the following entry types, all of which are
<strong>optional</strong>:</p>
<ul>
<li>One <a href="variables.html" style="border-bottom: 1px solid currentColor;"><code>var</code> block</a> to
define "local" variables.
<li>One <a href="variables.html" class="uline"><code>var</code> block</a> to define "local" variables.
</li>
<li><span class="is-family-monospace">Menuitems</span>, i.e. one or more of the following:
<ul>
<li>One or more <a href="#item" style="border-bottom: 1px solid currentColor;"><code>item</code> entries</a>.
</li>
<li>One or more sub-<a href="#menu" style="border-bottom: 1px solid currentColor;"><code>menu</code> entries</a>.
</li>
<li>One or more <a href="#separator" style="border-bottom: 1px solid currentColor;"><code>separator</code>
entries</a>. These create a horizontal line between the given entries.
<li>One or more <a href="#item" class="uline"><code>item</code> entries</a>.</li>
<li>One or more sub-<a href="#menu" class="uline"><code>menu</code> entries</a>.</li>
<li>One or more <a href="#separator" class="uline"><code>separator</code> entries</a>. These create a
horizontal line between the given entries.
</li>
</ul>
</li>
<li>One or more <a href="index.html#import"
style="border-bottom: 1px solid currentColor;"><code><code>imports</code></code></a>. The content of the
<li>One or more <a href="index.html#import" class="uline"><code><code>imports</code></code></a>. The content of the
given file will be placed in the position of the import.
</li>
</ul>
@@ -129,8 +118,7 @@
<h5 id="separator-properties">Properties</h5>
<p><span class="is-family-monospace">separator</span>s do not have any mandatory properties. Please refer to the <a
href="properties.html" style="border-bottom: 1px solid currentColor;">properties section</a> below for further
details.</p>
href="properties.html" class="uline">properties section</a> below for further details.</p>
<h5 id="separator-syntax">Syntax</h5>
<pre><code class="lang-shell">separator
+34 -44
View File
@@ -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="/docs/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="/docs/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>
@@ -174,11 +165,10 @@
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="/docs/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="/docs/expressions/string.html#single-quotes"
style="border-bottom: 1px solid currentColor;"><span
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