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

More documentation for Clocks, GCal, and Jira.

This commit is contained in:
Chris Cummer
2018-05-16 19:37:23 -07:00
parent 2ecd5e4b84
commit 40ca748b8d
11 changed files with 166 additions and 51 deletions

View File

@@ -125,6 +125,10 @@
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">jira<span class="p">:</span><span class="w">
</span><span class="w"> </span>colors<span class="p">:</span><span class="w">
</span><span class="w"> </span>rows<span class="p">:</span><span class="w">
</span><span class="w"> </span>even<span class="p">:</span><span class="w"> </span><span class="s2">&#34;lightblue&#34;</span><span class="w">
</span><span class="w"> </span>odd<span class="p">:</span><span class="w"> </span><span class="s2">&#34;white&#34;</span><span class="w">
</span><span class="w"> </span>domain<span class="p">:</span><span class="w"> </span><span class="s2">&#34;https://umbrellacorp.atlassian.net&#34;</span><span class="w">
</span><span class="w"> </span>email<span class="p">:</span><span class="w"> </span><span class="s2">&#34;chriscummer@me.com&#34;</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">
@@ -138,9 +142,23 @@
</span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span><span class="s2">&#34;chris.cummer&#34;</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>domain</code> <br /></p>
<p><code>colors.rows.even</code> <br />
Define 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>email</code> <br /></p>
<p><code>colors.rows.odd</code> <br />
Define the foreground color for odd-numbered rows. <br />
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
color name</a>.</p>
<p><code>domain</code> <br />
Your Jira corporate domain. <br />
Values: A valid URI.</p>
<p><code>email</code> <br />
The email address associated with your Jira account. <br />
Values: A valid email address string.</p>
<p><code>enabled</code> <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
@@ -149,13 +167,15 @@ 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>
<p><code>project</code> <br /></p>
<p><code>project</code> <br />
The Jira project to fetch information for. <br /></p>
<p><code>refreshInterval</code> <br />
How often, in seconds, this module will update its data. <br />
Values: A positive integer, <code>0..n</code>.</p>
<p><code>username</code> <br /></p>
<p><code>username</code> <br />
Your Jira username. <br /></p>
</div>
<div class="footer">