1
0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00

More documentation for Clocks, OpsGenie, and Todo.

This commit is contained in:
Chris Cummer
2018-05-16 19:42:23 -07:00
parent 40ca748b8d
commit 694490b0ca
8 changed files with 32 additions and 20 deletions

View File

@@ -148,12 +148,12 @@
<h3 id="attributes">Attributes</h3>
<p><code>colors.rows.even</code> <br />
Define the foreground color for even-numbered rows. <br />
The foreground color for even-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.</p>
<p><code>colors.rows.odd</code> <br />
Define the foreground color for the odd-numbered rows. <br />
The foreground color for the odd-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.</p>

View File

@@ -127,6 +127,7 @@ API</a> token.</p>
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">opsgenie<span class="p">:</span><span class="w">
</span><span class="w"> </span>displayEmpty<span class="p">:</span><span class="w"> </span><span class="kc">false</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>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">2</span><span class="w">
@@ -136,12 +137,16 @@ API</a> token.</p>
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">21600</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>displayEmpty</code> <br />
Whether schedules with no assigned person on-call should be displayed. <br />
Values: <code>true</code>, <code>false</code>.</p>
<p><code>enabled</code> <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p>
<p><code>position</code> <br />
Defines where in the grid this module&rsquo;s widget will be displayed. <br /></p>
Where in the grid this module&rsquo;s widget will be displayed. <br /></p>
<p><code>refreshInterval</code> <br />
How often, in seconds, this module will update its data. <br />

View File

@@ -188,9 +188,11 @@ Values: Any displayable unicode character.</p>
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.</p>
<p><code>colors.highlight.fore</code> <br />
The foreground color for the currently-selected row. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.</p>
<p><code>colors.highlight.back</code> <br />
The background color for the currently-selected row. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.</p>
<p><code>enabled</code> <br />
@@ -199,8 +201,6 @@ Values: <code>true</code>, <code>false</code>.</p>
<p><code>filename</code> <br />
The name for the todo file. <br />
<em>Note:</em> Currently this file <em>must</em> reside in the <code>~/.wtf/</code> directory.
This is a <a href="https://github.com/senorprogrammer/wtf/issues/35">known bug</a>. <br />
Values: Any valid filename, ideally ending in <code>yml</code>.</p>
<p><code>position</code> <br />