Skip to content

Commit

Permalink
Edited some anchor names
Browse files Browse the repository at this point in the history
  • Loading branch information
jsmorley committed Feb 6, 2025
1 parent ece2ac7 commit b7d1720
Show file tree
Hide file tree
Showing 28 changed files with 48 additions and 42 deletions.
2 changes: 1 addition & 1 deletion source/manual/bangs.html
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,7 @@ <h2 class="alert-heading h5" id="Redraw"><i class="fa-solid fa-thumbtack"></i> N
<dd>
<p>Delays execution for a defined number of milliseconds when embedded in an <a href="!skins/option-types/#Action">action option</a>. The lowest possible value is 16 milliseconds.</p><br>
<div class="alert alert-warning alert-tight" role="alert">
<h2 class="alert-heading h5" id="SomeAlert"><i class="fa-solid fa-bomb"></i> Alert:</h2><p>This is a very limited form of what is offered by the <a href="!plugins/actiontimer/">ActionTimer plugin</a>. There is no way to interrupt or cancel this short of a <code>!Refresh</code> of the skin, and nothing in the action itself can be dynamically changed during the execution of the action. It is simply a brute-force way to delay part of an action that has multiple components. This is not "threaded", and will in effect delay all processing of the entire skin while it is running.</p>
<h2 class="alert-heading h5" id="DelayAlert"><i class="fa-solid fa-bomb"></i> Alert:</h2><p>This is a very limited form of what is offered by the <a href="!plugins/actiontimer/">ActionTimer plugin</a>. There is no way to interrupt or cancel this short of a <code>!Refresh</code> of the skin, and nothing in the action itself can be dynamically changed during the execution of the action. It is simply a brute-force way to delay part of an action that has multiple components. This is not "threaded", and will in effect delay all processing of the entire skin while it is running.</p>
</div>
<p><b>Example:</b> <code>[!ShowMeter SomeMeter][!Delay 5000][!HideMeter SomeMeter]</code></p>
</dd>
Expand Down
2 changes: 1 addition & 1 deletion source/manual/formulas.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<p>Mathematical formulas must be entirely enclosed in (parentheses) to alert Rainmeter that it is a formula, unless they are being used in the <a href="!measures/calc/#Formula">Formula</a> option of a <a href="!measures/calc/">Calc</a> measure or in a <a href="!measures/general-options/ifconditions/">IfCondition</a> option, where the function is always assumed to be a formula, and the enclosing parentheses are optional.</p>

<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="SomeNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<h2 class="alert-heading h5" id="NumericNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<p>While [Measures], [SectionVariables:] and #Variables# can be used in a formula, all the components of a formula must be numeric, using only numbers, operators, functions and constants. Using .5 or .25 in a formula will cause an error. It must be 0.5 or 0.25.</p>
</div>

Expand Down
2 changes: 1 addition & 1 deletion source/manual/installing-skins.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ <h2 id="InstallAutomatically">Installing Automatically</h2>
<p>Click <b>Install</b> to complete the installation of the package.</p>

<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<h2 class="alert-heading h5" id="Portable"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<p>If Rainmeter is being run as a <a href="!installing-rainmeter/#PortableInstallation">portable</a> installation, start <b>SkinInstaller.exe</b> from the Rainmeter program folder, and browse to the .rmskin file to install it.</p>
</div>

Expand Down
2 changes: 1 addition & 1 deletion source/manual/lua-scripting/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ <h2 id="Initialize">Initialize</h2>
```

<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="SomeNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<h2 class="alert-heading h5" id="DoFileNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<p>While a dofile you call can be anywhere on your system, be aware that if you do not put the dofile .lua file somewhere in the path to the current config, you won't be able to distribute it with your skin as a .rmskin package. A .rmskin package can only distribute the contents of a single root config folder.</p>
</div>

Expand Down
4 changes: 2 additions & 2 deletions source/manual/measures/calc.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ <h2>Options</h2>
If set to <code>1</code>, any measure using the <a href="#Functions">Random</a> function and <a href="#UpdateRandom">UpdateRandom</a> will not repeat until all values between and including <a href="#LowBound">LowBound</a> and <a href="#HighBound">HighBound</a> have been used.<br/><br/>
Any dynamic change to <a href="#LowBound">LowBound</a> or <a href="#HighBound">HighBound</a> will reset the unique tracking of values.<br/><br/>
<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="SomeNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<h2 class="alert-heading h5" id="UniqueRandomNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<p>UniqueRandom will only function if the difference between <code>LowBound</code> and <code>HighBound</code> is at most a 16bit unsigned integer, or 65535.</p>
</div>

Expand All @@ -42,7 +42,7 @@ <h2 class="alert-heading h5" id="SomeNote"><i class="fa-solid fa-thumbtack"></i>
<dd>
Upper bound of the <a href="#Functions">Random</a> function.<br/><br/>
<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="SomeNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<h2 class="alert-heading h5" id="RandomNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<p>The maximum value of <code>HighBound</code> is a 32bit signed integer, or 2147483647.</p>
</dd>
</dl>
Expand Down
2 changes: 1 addition & 1 deletion source/manual/measures/freediskspace.html
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ <h2>Options</h2>
<tr><td>Ram</td><td>&nbsp;</td><td>7</td></tr>
</table><br>
<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="SomeNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<h2 class="alert-heading h5" id="CDDVDNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<p>FreeDiskSpace does not support CD or DVD drives other than with <code>Type</code> and <code>Label</code>.</p>
</div>
</dd>
Expand Down
4 changes: 2 additions & 2 deletions source/manual/measures/general-options/ifmatchactions.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<p>Reserved characters in regular expression, which are <code>.</code><code>^</code><code>$</code><code>*</code><code>+</code><code>?</code><code>(</code><code>)</code><code>[</code><code>{</code><code>\</code><code>|</code> must be escaped with the <code>\</code> character when used as a literal in the <code>IfMatch</code> option. If using a measure value as a section variable in the IfMatch option, the <a href="!variables/section-variables/#EscapeRegExp">:EscapeRegExp</a> modifier can be used to properly escape reserved characters in the measure.</p>

<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="SomeNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<h2 class="alert-heading h5" id="CaptureGroupNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<p><em>Capture groups <code>()</code> should not be used in the regular expression, as nothing is being captured and no indexes are being created. The function is simply used to test if the string measure matches some regular expression pattern, and will either be "true" (IfMatchAction) or "false" (IfNotMatchAction).</em></p>
</div>

Expand Down Expand Up @@ -48,7 +48,7 @@ <h2>Options</h2>
<p>This option changes the behavior from "becomes true or false" to "is true or false".</p><br>

<div class="alert alert-warning alert-tight" role="alert">
<h2 class="alert-heading h5" id="SomeAlert"><i class="fa-solid fa-bomb"></i> Alert:</h2>
<h2 class="alert-heading h5" id="InfiniteLoopAlert"><i class="fa-solid fa-bomb"></i> Alert:</h2>
<p>Care should be taken not to create an infinite loop in the actions. In particular, <code>!Refresh</code>, <code>!Update</code> and <code>!UpdateMeasure #CURRENTSECTION#</code> should generally be avoided when <code>IfMatchMode=1</code>.</p>
</div>
</dd>
Expand Down
2 changes: 1 addition & 1 deletion source/manual/measures/general-options/substitute.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ <h2>Options</h2>
<p>If captures are used in the pattern, (e.g. <code>(.+)</code>) they can be referenced in the <code>replacement</code> part using <code>\1</code>, (first capture) <code>\2</code>, (second capture) etc. The entire match can also be referenced with <code>\0</code>.</p><br>

<div class="alert alert-warning alert-tight" role="alert">
<h2 class="alert-heading h5" id="SomeAlert"><i class="fa-solid fa-bomb"></i> Alert:</h2>
<h2 class="alert-heading h5" id="EmptyStringAlert"><i class="fa-solid fa-bomb"></i> Alert:</h2>
<p>With RegExpSubstitute, a (capture) may not return an empty string. Care should be taken when using <code>*</code> (zero or more) quantifiers or <code>(?(?=</code> (If/Then) lookahead tests, as a capture must either cause the entire regular expression to "fail", or return a value of some kind.</p>
</div>
</dd>
Expand Down
6 changes: 3 additions & 3 deletions source/manual/measures/loop.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
<p>Any dynamic change to any of the four measure options, or dynamically changing <a href="!measures/general-options/#InvertMeasure">InvertMeasure</a> on the measure, will cause the loop to be reset and start over with the new values.</p>

<div class="alert alert-warning alert-tight" role="alert">
<h2 class="alert-heading h5" id="Alert"><i class="fa-solid fa-bomb"></i> Alert:</h2>
<h2 class="alert-heading h5" id="WholeNumberAlert"><i class="fa-solid fa-bomb"></i> Alert:</h2>
<p>All options must be positive or negative whole numbers, or formulas that resolve to whole numbers. Fractional values will be truncated.</p>
</div>

Expand Down Expand Up @@ -57,7 +57,7 @@ <h2 id="MeasureCommands">Measure Commands</h2>
<p>Example: <code>[!CommandMeasure MeasureName "Reset"]</code></p><br>

<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="SomeNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<h2 class="alert-heading h5" id="DynamicChangeNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<p>Any dynamic change to any of the four measure options, or dynamically changing <a href="!measures/general-options/#InvertMeasure">InvertMeasure</a> on the measure, will automatically perform a reset of the loop. In that case, this command would not be required.</p>
</div>
</dd>
Expand Down Expand Up @@ -116,7 +116,7 @@ <h2>Examples</h2>
MiddleMouseUpAction=[!CommandMeasure MeasureLoop2 "Reset"]
```
<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="NotAPlugin"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<h2 class="alert-heading h5" id="InvertNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<p>If <a href="!measures/general-options/#InvertMeasure">InvertMeasure</a> is set to <code>1</code>, the opposite of the value generated by the loop will be returned. This can have the effect of reversing the direction of the loop. Toggling <code>InvertMeasure</code> with <a href="!bangs/#SetOption">!SetOption</a> can create a "ping-pong" effect with the measure.</p>
</div>

Expand Down
2 changes: 1 addition & 1 deletion source/manual/measures/mediakey.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<p>Windows will briefly display a small volume UI element in the upper-left corner of the screen when the volume is changed or the sound is muted.</p>

<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="Note"><i class="fa-solid fa-thumbtack"></i> Note: MediaKey was previously a <em>plugin</em> measure.</h2>
<h2 class="alert-heading h5" id="PreviouslyPlugin"><i class="fa-solid fa-thumbtack"></i> Note: MediaKey was previously a <em>plugin</em> measure.</h2>
<p>In many existing skins you might see the syntax:</p>
``` ini
[MeasureMedia]
Expand Down
2 changes: 1 addition & 1 deletion source/manual/measures/nowplaying.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<p><code>Measure=NowPlaying</code> retrieves information about the currently playing track from a number of media players.</p>

<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="Note"><i class="fa-solid fa-thumbtack"></i> Note: NowPlaying was previously a <em>plugin</em> measure.</h2>
<h2 class="alert-heading h5" id="PreviouslyPlugin"><i class="fa-solid fa-thumbtack"></i> Note: NowPlaying was previously a <em>plugin</em> measure.</h2>
<p>In many existing skins you might see the syntax:</p>
``` ini
[MeasureParent]
Expand Down
2 changes: 1 addition & 1 deletion source/manual/measures/process.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
</p>

<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="Note"><i class="fa-solid fa-thumbtack"></i> Note: Process was previously a <em>plugin</em> measure.</h2>
<h2 class="alert-heading h5" id="PreviouslyPlugin"><i class="fa-solid fa-thumbtack"></i> Note: Process was previously a <em>plugin</em> measure.</h2>
<p>In many existing skins you might see the syntax:</p>
``` ini
[MeasureParent]
Expand Down
2 changes: 1 addition & 1 deletion source/manual/measures/recyclemanager.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<p><code>Measure=RecycleManager</code> monitors the state of the recycle bin.</p>

<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="Note"><i class="fa-solid fa-thumbtack"></i> Note: RecycleManager was previously a <em>plugin</em> measure.</h2>
<h2 class="alert-heading h5" id="PreviouslyPlugin"><i class="fa-solid fa-thumbtack"></i> Note: RecycleManager was previously a <em>plugin</em> measure.</h2>
<p>In many existing skins you might see the syntax:</p>
``` ini
[MeasureRecycle]
Expand Down
2 changes: 1 addition & 1 deletion source/manual/measures/sysinfo.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<p><code>Measure=SysInfo</code> measures various information about your system.</p>

<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="Note"><i class="fa-solid fa-thumbtack"></i> Note: SysInfo was previously a <em>plugin</em> measure.</h2>
<h2 class="alert-heading h5" id="PreviouslyPlugin"><i class="fa-solid fa-thumbtack"></i> Note: SysInfo was previously a <em>plugin</em> measure.</h2>
<p>In many existing skins you might see the syntax:</p>
``` ini
[MeasureSysInfo]
Expand Down
4 changes: 2 additions & 2 deletions source/manual/measures/webparser.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h2>Usage</h2>
<p>More information and examples for WebParser can be found at <a href="/tips/webparser-tutorial/">WebParser Tutorial</a> and <a href="/tips/rss-feed-tutorial/">RSS/Atom Feed Tutorial</a>.</p>

<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="Note"><i class="fa-solid fa-thumbtack"></i> Note: WebParser was previously a <em>plugin</em> measure.</h2>
<h2 class="alert-heading h5" id="PreviouslyPlugin"><i class="fa-solid fa-thumbtack"></i> Note: WebParser was previously a <em>plugin</em> measure.</h2>
<p>In many existing skins you might see the syntax:</p>
``` ini
[MeasureParent]
Expand Down Expand Up @@ -359,7 +359,7 @@ <h2 id="ActionOptions">Action Options</h2>
</dd>

<div class="alert alert-warning alert-tight" role="alert">
<h2 class="alert-heading h5" id="Alert"><i class="fa-solid fa-bomb"></i> Alert:</h2>
<h2 class="alert-heading h5" id="EndlessLoopAlert"><i class="fa-solid fa-bomb"></i> Alert:</h2>
<p>If some condition causes any of the error actions above to be executed, care should be taken not to create an endless loop or cause the skin to repeatedly try to access a resource in a short period of time. For instance, it would not be wise to have these actions automatically update the measure they are on, or refresh the skin.</p>
</div>
</dl>
Expand Down
7 changes: 5 additions & 2 deletions source/manual/meters/button.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,11 @@ <h2>Options</h2>

<dt id="ButtonCommand"><code>ButtonCommand</code></dt>
<dd>
<a href="!skins/option-types/#Action">Action</a> to execute when the button is clicked.
<br><br><b>Note:</b> Similar to <code>LeftMouseUpAction</code>. The difference is that <code>ButtonCommand</code> ignores transparent pixels in the image at all times, where <code>LeftMouseUpAction</code> will only ignore clicks on transparent areas if there is not some other meter behind the image.
<p><a href="!skins/option-types/#Action">Action</a> to execute when the button is clicked.</p><br>
<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="ButtonCommandNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<p>Similar to <code>LeftMouseUpAction</code>. The difference is that <code>ButtonCommand</code> ignores transparent pixels in the image at all times, where <code>LeftMouseUpAction</code> will only ignore clicks on transparent areas if there is not some other meter behind the image.</p>
</div>
</dd>
</dl>

Expand Down
4 changes: 2 additions & 2 deletions source/manual/meters/histogram.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,8 @@ <h2>Options</h2>
</dl>

<div class="alert alert-warning alert-tight" role="alert">
<h2 class="alert-heading h5" id="Deprecated"><i class="fa-solid fa-bomb"></i> Alert: Deprecated Features</h2>
<p>The following options have been deprecated and should not be used. They are still supported, but may be removed in future versions.</p>
<h2 class="alert-heading h5" id="Deprecated"><i class="fa-solid fa-bomb"></i> Alert: Deprecated Feature</h2>
<p>The following option has been deprecated and should not be used. It is still supported, but may be removed in future versions.</p>
<ul>
<li><p><code>SecondaryMeasureName</code><br>
<a href="#MeasureName">MeasureName2</a> should be used to define an optional secondary measure for the meter.
Expand Down
4 changes: 2 additions & 2 deletions source/manual/meters/image.html
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ <h2>Options</h2>
```

<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="SomeNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<h2 class="alert-heading h5" id="ImageNameNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<p>When <code>ImageName</code> is hard-coded with an image file name, the image will be loaded and "cached", to avoid reloading the image from disk on every meter update. If there is an external process that is changing the image file, while leaving the name the same, use <code>DynamicVariables=1</code> on the meter to force the image to be reloaded from disk on every meter update.</p>
</div>

Expand Down Expand Up @@ -71,7 +71,7 @@ <h2 class="alert-heading h5" id="SomeNote"><i class="fa-solid fa-thumbtack"></i>
</dl>

<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="SomeNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<h2 class="alert-heading h5" id="SolidColorNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<p>Using the <a href="!meters/general-options/#SolidColor">SolidColor</a> option, along with <a href="!meters/general-options/#WH">W</a> and <a href="!meters/general-options/#WH">H</a> options, an image meter may be used to draw squares, rectangles or lines without needing any <code>ImageName</code> or <code>MeasureName</code>.</p>

<p>However, no manipulations can be done to the resulting square, rectangle or line with any <a href="!meters/general-options/image-options/">general image options</a>. Only actual images loaded from a file can be manipulated. (e.g. ImageRotate)</p>
Expand Down
2 changes: 1 addition & 1 deletion source/manual/meters/roundline.html
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ <h2>Options</h2>
</dl>

<div class="alert alert-info alert-tight" role="alert">
<h2 class="alert-heading h5" id="Note"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<h2 class="alert-heading h5" id="WHNote"><i class="fa-solid fa-thumbtack"></i> Note:</h2>
<p>If the width and height are not defined, the center point is at the X and Y position of the meter and any part of the meter that intersects with the edges of the skin window will be cut off. If width and height are specified, the center point will be in the middle of the bounding box and the skin window will include the meter.</p>
</div>

Expand Down
Loading

0 comments on commit b7d1720

Please sign in to comment.