TaskMonad: A collection of tools which can be used to access taskwarrior from xmonad.

[ bsd3, library, xmonad ] [ Propose Tags ]

TaskMonad is a collection of tools which can be used to access taskwarrior from xmonad.


[Skip to Readme]
Versions [faq] 1.0.0, 1.0.1
Change log ChangeLog.md
Dependencies base (>=4.5 && <5), containers (>=0.5 && <0.7), mtl (>=1 && <3), process (>=1.6.3 && <1.7), random (==1.1.*), unix (>=2.7.2 && <2.8), X11 (>=1.6.1 && <1.10), X11-xft (>=0.2 && <0.4), xmonad (>=0.14.2 && <=0.15), xmonad-contrib (>=0.14 && <=0.15) [details]
License BSD-3-Clause
Author Max Magorsch
Maintainer max@magorsch.de
Revised Revision 1 made by mmagorsc at Sat Mar 30 15:57:36 UTC 2019
Category XMonad
Home page https://taskmonad.magorsch.de
Bug tracker https://github.com/mmagorsc/taskmonad/issues
Source repo head: git clone https://github.com/mmagorsc/taskmonad
Uploaded by mmagorsc at Sat Mar 30 15:48:16 UTC 2019
Distributions NixOS:1.0.1
Downloads 116 total (22 in the last 30 days)
Rating (no votes yet) [estimated by rule of succession]
Your Rating
  • λ
  • λ
  • λ
Status Hackage Matrix CI
Docs not available [build log]
All reported builds failed as of 2019-03-31 [all 4 reports]

Modules

  • GridSelect
    • GridSelect.Extras
  • TaskMonad
    • TaskMonad.GridSelect
    • TaskMonad.Prompt
    • TaskMonad.ScratchPad
    • TaskMonad.Utils

Downloads

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

For package maintainers and hackage trustees


Readme for TaskMonad-1.0.1

[back to package description]

TaskMonad

GHC Version Build Hackage CodeClimate Contributing License

Table Of Contents

Basic Overview

Basically, TaskMonad provides a collection of tools which can be used to access taskwarrior from xmonad.

Screencast

Installation

Using cabal

To install TaskMonad from hackage just execute:

$ cabal update
$ cabal install TaskMonad

Afterwards import TaskMonad in your xmonad.hs

import TaskMonad

Without cabal

To install Taskmonad without using cabal just download and copy the source code into your ~/.xmonad/lib/ folder. The folder structure should afterwards look like this:

.xmonad 
|-- lib
|   |-- Taskmonad.hs
|   |-- Taskmonad
|   |   |-- GridSelect.hs
|   |   |-- Prompt.hs
|   |   |-- ScratchPad.hs
|   |   `-- Utils.hs
|   |-- GridSelect
|   |   `-- Extras.hs
|   `-- ...
|-- xmonad.hs

Afterwards import TaskMonad in your xmonad.hs

import TaskMonad

Usage

To get started, add a manage hook for the taskwarrior scratchpad:

-- ...

... , manageHook = namedScratchpadManageHook taskwarriorScratchpads

After that you can bind the taskwarrior prompt to a key to get started:

... , ("M-p",     taskwarriorPrompt [(\x -> x == "processInbox", processInbox)])

You can also bind any other TaskMonad action to a key. For example:

... , ("M-S-p",   taskwarriorScratchpad)       -- Opens the taskwarrior scratchpad

... , ("M-C-p",   taskSelect "status:pending") -- Displays all pending tasks

... , ("M-C-S-p", tagSelect)                   -- Displays all tags using a gridselect

In general you can customize the tools ad libitum. A good way to get started is to implement custom actions for the taskwarrior prompt. Please refer to taskwarriorPrompt for further information.

Features

Basically TaskMonad implements a few methods which can be used to follow the GTD principles. However you can customize these methods or even implement completely different workflows. Please refer to the documentation and Customizing for further details.

Step 1: Capture

You can easily capture tasks, ideas or notes using the taskwarriorPrompt like this:

Capture

Step 2 & 3: Clarify & Organize

You can clarify and organize your tasks using processInbox. It implements the typical Getting Things Done workflow using GridSelects:

Clarify and Organize

Step 4: Reflect

You can implement your own custom daily- and weeklyreview routines. For example you can use togglePriority to adjust the priority of tasks during the daily- / weeklyreview like this:

Reflect

Step 5: Engage

To decide which task to do next, you can use a collection of gridselects. You can use tagSelect, projectSelect, dueSelect to display a gridselect to filter the tasks by tag, project or due date. However you can also display all pending tasks using taskSelect like this:

Engage

Scratchpad

The taskwarrior scratchpad is used to display taskwarrior reports that have been invoked using the taskwarrior prompt. However, you can use the scratchpad at your convenience. After you have added a manage hook as described in Installation, you can bind a key to taskwarriorScratchpad. The Scratchpad will look like this

Scratchpad

Customizing

TaskMonad.hs implements a few methods which are useful to use GTD. However you don't have to use any of these methods if you don't use GTD or just don't like to use them.

TaskMonad exposes four modules which can be used to implement your own custom workflow:

  • TaskMonad.Prompt -- provides wrappers around XMonad.Prompt.Input for usage with taskwarrior
  • TaskMonad.ScratchPad -- TaskMonad.ScratchPad provides a wrapper around XMonad.Util.NamedScratchpad that can be used to display taskwarrior commands
  • TaskMonad.GridSelect -- uses GridSelect.Extras to display various information from taskwarrior.
  • TaskMonad.Utils -- is used to communicate with taskwarrior from haskell.

You can use these modules at your convenience. However, in case please consider creating an issue or submitting a pull request so that others can also benefit from your changes.

Documentation

The documentation of TaskMonad is generated using haddock. You can find the latest version here.

Contributing

Contributions are welcome. You have an idea, suggestion for improvement or have found a bug? Just create an issue or send a pull request.