wtf/_site/content/posts/modules/textfile.md

title, date, draft

title	date	draft
Textfile	2018-05-09T11:13:11-07:00	false

Description

Displays the contents of the specified text file in the widget.

Source Code

wtf/textfile/

Required ENV Variables

None.

Keyboard Commands

Key: h
Action: Open/close the widget's help window.

Key: o
Action: Opens the text file in whichever text editor is associated with that file type.

Configuration

textfile:
  enabled: true
  filename: "notes.md"
  position:
    top: 5
    left: 4
    height: 2
    width: 1
  refreshInterval: 15

Attributes

enabled
Determines whether or not this module is executed and if its data displayed onscreen.
Values: true, false.

filename
The name of the file to be displayed in the widget.
Note: Currently this file must reside in the ~/.wtf/ directory. This is a known bug.

position
Defines where in the grid this module's widget will be displayed.

refreshInterval
How often, in seconds, this module will update its data.
Values: A positive integer, 0...n.