taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

More documentation for Clocks, GCal, and Jira.

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/posts/modules/clocks/index.html
View File

@@ -147,13 +147,13 @@
</span><span class="w"> </span>sort<span class="p">:</span><span class="w"> </span><span class="s2">&#34;alphabetical&#34;</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>colors.even</code> <br />
Define the text color for even-numbered rows (2, 4, 6&hellip;). <br />
<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>colors.odd</code> <br />
Define the text color for the odd-numbered rows (1, 3, 5&hellip;). <br />
<p><code>colors.rows.odd</code> <br />
Define 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>

19
docs/posts/modules/gcal/index.html
View File

@@ -139,6 +139,8 @@
</span><span class="w"> </span>past<span class="p">:</span><span class="w"> </span><span class="s2">&#34;gray&#34;</span><span class="w">
</span><span class="w"> </span>conflictIcon<span class="p">:</span><span class="w"> </span><span class="s2">&#34;🚨&#34;</span><span class="w">
</span><span class="w"> </span>currentIcon<span class="p">:</span><span class="w"> </span><span class="s2">&#34;💥&#34;</span><span class="w">
</span><span class="w"> </span>displayResponseStatus<span class="p">:</span><span class="w"> </span><span class="kc">true</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">
</span><span class="w"> </span>eventCount<span class="p">:</span><span class="w"> </span><span class="m">12</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
@@ -147,7 +149,8 @@
</span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">4</span><span class="w">
</span><span class="w"> </span>width<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>refreshInterval<span class="p">:</span><span class="w"> </span><span class="m">300</span><span class="w">
</span><span class="w"> </span>secretFile<span class="p">:</span><span class="w"> </span><span class="s2">&#34;~/.wtf/gcal/client_secret.json&#34;</span></code></pre></div>
</span><span class="w"> </span>secretFile<span class="p">:</span><span class="w"> </span><span class="s2">&#34;~/.wtf/gcal/client_secret.json&#34;</span><span class="w">
</span><span class="w"> </span>withLocation<span class="p">:</span><span class="w"> </span><span class="kc">true</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>colors.title</code> <br />
@@ -177,6 +180,20 @@ Values: Any displayable unicode character.</p>
The icon displayed beside the current calendar event. <br />
Values: Any displayable unicode character.</p>
<p><code>displayLocation</code> <br />
Whether or not to display the location of the calendar event. <br />
Values: <code>true</code>, <code>false</code>.</p>
<p><code>displayResponseStatus</code> <br />
Whether or not to display your response status to the calendar event.
<br />
Values: <code>true</code>, <code>false</code>.</p>
<p><code>email</code> <br />
The email address associated with your Google account. Necessary for
determining <code>responseStatus</code>. <br />
Values: A valid email address string.</p>
<p><code>enabled</code> <br />
Whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p>

28
docs/posts/modules/jira/index.html
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">

8
docs/posts/modules/textfile/index.html
View File

@@ -129,7 +129,7 @@
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">textfile<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>filename<span class="p">:</span><span class="w"> </span><span class="s2">&#34;notes.md&#34;</span><span class="w">
</span><span class="w"> </span>filePath<span class="p">:</span><span class="w"> </span><span class="s2">&#34;~/Desktop/notes.md&#34;</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">5</span><span class="w">
</span><span class="w"> </span>left<span class="p">:</span><span class="w"> </span><span class="m">4</span><span class="w">
@@ -142,10 +142,8 @@
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p>
<p><code>filename</code> <br />
The name of the file to be displayed in the widget. <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>.</p>
<p><code>filePath</code> <br />
The path to the file to be displayed in the widget. <br /></p>
<p><code>position</code> <br />
Defines where in the grid this module&rsquo;s widget will be displayed. <br /></p>

46
docs/posts/modules/todo/index.html
View File

@@ -100,7 +100,7 @@
<br/>
<i class="fas fa-clock"></i> 1 min read
<i class="fas fa-clock"></i> 2 min read
</span>
</div>
@@ -108,6 +108,8 @@
<h2 id="description">Description</h2>
<p>An interactive todo list.</p>
<p><img src="/imgs/modules/todo.png" width="320" height="388" alt="todo screenshot" /></p>
<h2 id="source-code">Source Code</h2>
@@ -118,7 +120,47 @@
<h2 id="keyboard-commands">Keyboard Commands</h2>
<p>A basic, interactive todo list.</p>
<p><span class="caption">Key:</span> <code>[return]</code> <br />
<span class="caption">Action:</span> Edit the selected item. <br />
<span class="caption">Action:</span> Close the modal item dialog and save changes. <br /></p>
<p><span class="caption">Key:</span> <code>[esc]</code> <br />
<span class="caption">Action:</span> Remove focus from the selected item. <br />
<span class="caption">Action:</span> Close the modal item dialog without saving changes.</p>
<p><span class="caption">Key:</span> <code>[space]</code> <br />
<span class="caption">Action:</span> Check/uncheck the selected item.</p>
<p><span class="caption">Key:</span> <code>/</code> <br />
<span class="caption">Action:</span> Open/close the widget&rsquo;s help window.</p>
<p><span class="caption">Key:</span> <code>j</code> <br />
<span class="caption">Action:</span> Select the next item in the list.</p>
<p><span class="caption">Key:</span> <code>k</code> <br />
<span class="caption">Action:</span> Select the previous item in the list.</p>
<p><span class="caption">Key:</span> <code>n</code> <br />
<span class="caption">Action:</span> Create a new list item.</p>
<p><span class="caption">Key:</span> <code>o</code> <br />
<span class="caption">Action:</span> Opens the todo list file in
whichever text editor is associated with that file type.</p>
<p><span class="caption">Key:</span> <code>↓</code> <br />
<span class="caption">Action:</span> Select the next item in the list.</p>
<p><span class="caption">Key:</span> <code>↑</code> <br />
<span class="caption">Action:</span> Select the previous item in the list.</p>
<p><span class="caption">Key:</span> <code>Ctrl-d</code> <br />
<span class="caption">Action:</span> Delete the selected item.</p>
<p><span class="caption">Key:</span> <code>Ctrl-J</code> <br />
<span class="caption">Action:</span> Move the selected item down the list.</p>
<p><span class="caption">Key:</span> <code>Ctrl-K</code> <br />
<span class="caption">Action:</span> Move the selected item up the list.</p>
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">todo<span class="p">:</span><span class="w">