mirror of
https://github.com/taigrr/wtf
synced 2025-01-18 04:03:14 -08:00
Add the Todo module to the documentation
This commit is contained in:
@@ -30,6 +30,6 @@ Available modules:
|
||||
<li><a href="/posts/modules/opsgenie">OpsGenie</a>
|
||||
<li><a href="/posts/modules/security">Security</a>
|
||||
<li><a href="/posts/modules/textfile">Text File</a>
|
||||
<li><a href="/posts/modules/todo" class="disabled">Todo</a>
|
||||
<li><a href="/posts/modules/todo">Todo</a>
|
||||
<li><a href="/posts/modules/weather">Weather</a>
|
||||
</ul>
|
||||
|
||||
@@ -57,14 +57,12 @@ gcal:
|
||||
### Attributes
|
||||
|
||||
`colors.title` <br />
|
||||
Specifies the default colour for calendar event titles. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color</a> name.
|
||||
The default colour for calendar event titles. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`colors.description` <br />
|
||||
Specifies the default color for calendar event descriptions. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color</a> name.
|
||||
The default color for calendar event descriptions. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`colors.highlights` <br />
|
||||
A list of arrays that define a regular expression pattern and a color.
|
||||
@@ -73,9 +71,8 @@ be drawn in that colour. Over-rides the default title colour. <br />
|
||||
Values: [a valid regular expression, any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.]
|
||||
|
||||
`colors.past` <br />
|
||||
Specifies the color for calendar events that have passed. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11
|
||||
color</a> name.
|
||||
The color for calendar events that have passed. <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`conflictIcon` <br />
|
||||
The icon displayed beside calendar events that have conflicting times
|
||||
@@ -87,7 +84,7 @@ The icon displayed beside the current calendar event. <br />
|
||||
Values: Any displayable unicode character.
|
||||
|
||||
`enabled` <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: `true`, `false`.
|
||||
|
||||
`eventCount` <br />
|
||||
@@ -95,7 +92,7 @@ The number of calendar events to display. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
|
||||
`position` <br />
|
||||
Defines where in the grid this module's widget will be displayed. <br />
|
||||
Where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
|
||||
75
_site/content/posts/modules/todo.md
Normal file
75
_site/content/posts/modules/todo.md
Normal file
@@ -0,0 +1,75 @@
|
||||
---
|
||||
title: "Todo"
|
||||
date: 2018-05-10T12:41:50-07:00
|
||||
draft: false
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
<img src="/imgs/modules/todo.png" width="320" height="388" alt="todo screenshot" />
|
||||
|
||||
## Source Code
|
||||
|
||||
```bash
|
||||
wtf/todo/
|
||||
```
|
||||
|
||||
## Required ENV Variables
|
||||
|
||||
None.
|
||||
|
||||
## Keyboard Commands
|
||||
|
||||
A basic, interactive todo list.
|
||||
|
||||
## Configuration
|
||||
|
||||
```yaml
|
||||
todo:
|
||||
checkedIcon: "X"
|
||||
colors:
|
||||
checked: gray
|
||||
highlight:
|
||||
fore: "black"
|
||||
back: "orange"
|
||||
enabled: true
|
||||
filename: "todo.yml"
|
||||
position:
|
||||
top: 2
|
||||
left: 2
|
||||
height: 2
|
||||
width: 1
|
||||
refreshInterval: 3600
|
||||
```
|
||||
|
||||
### Attributes
|
||||
|
||||
`checkedIcon` <br />
|
||||
The icon used to denote a "checked" todo item. <br />
|
||||
Values: Any displayable unicode character.
|
||||
|
||||
`colors.checked` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`colors.highlight.fore` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`colors.highlight.back` <br />
|
||||
Values: Any <a href="https://en.wikipedia.org/wiki/X11_color_names">X11 color</a> name.
|
||||
|
||||
`enabled` <br />
|
||||
Whether or not this module is executed and if its data displayed onscreen. <br />
|
||||
Values: `true`, `false`.
|
||||
|
||||
`filename` <br />
|
||||
The name for the todo file. <br />
|
||||
*Note:* Currently this file *must* reside in the `~/.wtf/` directory.
|
||||
This is a <a href="https://github.com/senorprogrammer/wtf/issues/35">known bug</a>. <br />
|
||||
Values: Any valid filename, ideally ending in `yml`.
|
||||
|
||||
`position` <br />
|
||||
Where in the grid this module's widget will be displayed. <br />
|
||||
|
||||
`refreshInterval` <br />
|
||||
How often, in seconds, this module will update its data. <br />
|
||||
Values: A positive integer, `0..n`.
|
||||
BIN
_site/static/imgs/modules/todo.png
Normal file
BIN
_site/static/imgs/modules/todo.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
@@ -29,7 +29,7 @@
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/opsgenie/">OpsGenie</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/security/">Security</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/textfile/">Text File</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/" class="disabled">Todo</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/todo/">Todo</a></li>
|
||||
<li class="sidebar-list-item-2"><a href="/posts/modules/weather/">Weather</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
Reference in New Issue
Block a user