mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Add documentatin for IPInfo colors
This commit is contained in:
parent
3f92a2f7ee
commit
c7e0eaa3be
@ -26,6 +26,9 @@ None.
|
||||
|
||||
```yaml
|
||||
ipinfo:
|
||||
colors:
|
||||
name: red
|
||||
value: white
|
||||
enabled: true
|
||||
position:
|
||||
top: 1
|
||||
@ -37,6 +40,14 @@ ipinfo:
|
||||
|
||||
### Attributes
|
||||
|
||||
`colors.name` <br />
|
||||
The default colour for the row names. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`colors.value` <br />
|
||||
The default colour for the row values. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`enabled` <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
@ -36,8 +36,10 @@ position Defines where in the grid this module&rsquo;s widget will be displa
|
||||
<description>Displays your current IP address information, from ipinfo.io.
|
||||
Source Code wtf/ipinfo/ Required ENV Variables None.
|
||||
Keyboard Commands None.
|
||||
Configuration ipinfo:enabled:trueposition:top:1left:2height:1width:1refreshInterval:15 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
|
||||
position Defines where in the grid this module&rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.</description>
|
||||
Configuration ipinfo:colors:name:redvalue:whiteenabled:trueposition:top:1left:2height:1width:1refreshInterval:15 Attributes colors.name The default colour for the row names. Values: Any X11 color name.
|
||||
colors.value The default colour for the row values. Values: Any X11 color name.
|
||||
enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
|
||||
position Defines where in the grid this module&rsquo;s widget will be displayed.</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
|
@ -36,8 +36,10 @@ position Defines where in the grid this module&rsquo;s widget will be displa
|
||||
<description>Displays your current IP address information, from ipinfo.io.
|
||||
Source Code wtf/ipinfo/ Required ENV Variables None.
|
||||
Keyboard Commands None.
|
||||
Configuration ipinfo:enabled:trueposition:top:1left:2height:1width:1refreshInterval:15 Attributes enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
|
||||
position Defines where in the grid this module&rsquo;s widget will be displayed. refreshInterval How often, in seconds, this module will update its data. Values: A positive integer, 0..n.</description>
|
||||
Configuration ipinfo:colors:name:redvalue:whiteenabled:trueposition:top:1left:2height:1width:1refreshInterval:15 Attributes colors.name The default colour for the row names. Values: Any X11 color name.
|
||||
colors.value The default colour for the row values. Values: Any X11 color name.
|
||||
enabled Determines whether or not this module is executed and if its data displayed onscreen. Values: true, false.
|
||||
position Defines where in the grid this module&rsquo;s widget will be displayed.</description>
|
||||
</item>
|
||||
|
||||
<item>
|
||||
|
@ -127,10 +127,10 @@
|
||||
|
||||
<h2 id="configuration">Configuration</h2>
|
||||
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">ipinfo<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||||
</span><span class="w"> </span>colors<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>name<span class="p">:</span> red<span class="w">
|
||||
</span><span class="w"> </span>value<span class="p">:</span> white<span class="w">
|
||||
</span><span class="w"> </span>name<span class="p">:</span><span class="w"> </span>red<span class="w">
|
||||
</span><span class="w"> </span>value<span class="p">:</span><span class="w"> </span>white<span class="w">
|
||||
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
|
||||
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
|
||||
</span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
|
||||
</span><span class="w"> </span>left<span class="p">:</span><span class="w"> </span><span class="m">2</span><span class="w">
|
||||
@ -139,6 +139,14 @@
|
||||
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">15</span></code></pre></div>
|
||||
<h3 id="attributes">Attributes</h3>
|
||||
|
||||
<p><code>colors.name</code> <br />
|
||||
The default colour for the row names. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.</p>
|
||||
|
||||
<p><code>colors.value</code> <br />
|
||||
The default colour for the row values. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.</p>
|
||||
|
||||
<p><code>enabled</code> <br />
|
||||
Determines whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: <code>true</code>, <code>false</code>.</p>
|
||||
|
Loading…
x
Reference in New Issue
Block a user