docs/TaskMonad-Scratchpad.html
<!doctype html>
<html lang="en">
<head>
<!-- Required meta tags -->
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="shortcut icon" type="image/x-icon" href="images/taskmonad.ico">
<link href="css/ocean.css" rel="stylesheet" type="text/css" title="new-ocean" />
<!-- Bootstrap CSS -->
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css" integrity="sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T" crossorigin="anonymous">
<link href="css/lightbox.min.css" rel="stylesheet">
<link href="css/custom.css" rel="stylesheet">
<title>TaskMonad: xmonad + taskwarrior</title>
</head>
<body>
<a href="https://github.com/mmagorsc/taskmonad" style="position: absolute;top: 0;right: 0;border: 0;"><img width="149" height="149" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_darkblue_121621.png?resize=149%2C149" class="attachment-full size-full" alt="Fork me on GitHub" data-recalc-dims="1"></a>
<div class="container" style="padding-left:66px;padding-right:110px;padding-top:30px;">
<div class="row">
<div class="col-sm-3" style="width:100%;padding-right:40px;padding-left: 10px;padding-top:10px;">
<img src="./images/taskmonad.png" style="width:100%;margin-bottom:10px;">
<!-- Place this tag where you want the button to render. -->
<div style="margin-top:10px;margin-bottom:10px;"><a class="github-button" href="https://github.com/mmagorsc/taskmonad/" data-size="large" aria-label="Star ntkme/github-buttons on GitHub">Star</a>
<a class="github-button" href="https://github.com/mmagorsc/taskmonad/releases" data-icon="octicon-cloud-download" data-size="large" aria-label="Download ntkme/github-buttons on GitHub">Download</a></div>
<p style="overflow-wrap: break-word; font-family: Georgia, serif; font-size: 14px; line-height: 1.5;color: #555;">
Taskmonad is a collection of tools which can be used to access
taskwarrior from xmonad.
</p>
<h3 style="font-family: Georgia, serif;color: #444;font-size: 24px;font-weight: normal;">Page Content</h3>
<ul style="list-style: none;margin: 10px 0;">
<li><a class="dotted-link" href="#g:1">Usage</a></li>
<li><a class="dotted-link" href="#g:2">Screenshots</a></li>
</ul>
<h3 style="margin-top:30px;font-family: Georgia, serif;color: #444;font-size: 24px;font-weight: normal;">Modules</h3>
<ul style="list-style: none;margin: 10px 0;">
<li><a class="dotted-link" href="index.html">TaskMonad</a></li>
<li><a style="margin-left:20px;" class="dotted-link" href="TaskMonad-Prompt.html">TaskMonad.Prompt</a></li>
<li><a style="margin-left:20px;" class="dotted-link" href="TaskMonad-GridSelect.html">TaskMonad.GridSelect</a></li>
<li><a style="margin-left:20px;" class="dotted-link" href="TaskMonad-Scratchpad.html">TaskMonad.Scratchpad</a></li>
<li><a style="margin-left:20px;" class="dotted-link" href="TaskMonad-Utils.html">TaskMonad.Utils</a></li>
<li><a class="dotted-link" href="GridSelect-Extras.html">GridSelect.Extras</a></li>
</ul>
<h3 style="margin-top:30px;font-family: Georgia, serif;color: #444;font-size: 24px;font-weight: normal;">Information</h3>
<ul style="list-style: none;margin: 10px 0;">
<li><a class="copyright-link"><strong>Copyright</strong></a></li>
<li><a style="margin-left:20px;" class="copyright-link">Max Magorsch</a></li>
<li><a style="margin-left:20px;" class="copyright-link"><max@magorsch.de></a></li>
<li><a class="copyright-link"><strong>License</strong></a></li>
<li><a style="margin-left:20px;" class="copyright-link">BSD-style</a></li>
<li><a style="margin-left:20px;" class="copyright-link">(see License)</a></li>
<li><a class="copyright-link"><strong>Maintainer</strong></a></li>
<li><a style="margin-left:20px;" class="copyright-link">Max Magorsch</a></li>
<li><a style="margin-left:20px;" class="copyright-link"><max@magorsch.de></a></li>
</ul>
</div>
<div class="col-sm-9"> <!-- style="background-color:#C8C8C8;"> -->
<h1>TaskMonad.ScratchPad</h1>
<p style="font-family: Georgia, serif; font-size: 17px;margin-top:17px;">Release v1.0.1 (<a class="reference internal" href="src/TaskMonad.ScratchPad.html"><span class=" std std-ref">Source</span></a>)</p>
<a href="https://www.haskell.org/ghc/" ><img src="https://img.shields.io/badge/ghc-8.4.1%2B-blue.svg"></a>
<a href="https://travis-ci.org/mmagorsc/taskmonad"> <img src="https://api.travis-ci.org/mmagorsc/taskmonad.svg?branch=master"></a>
<a href="http://hackage.haskell.org/package/TaskMonad-1.0.1"> <img src="https://img.shields.io/badge/hackage-1.0.1-brightgreen.svg"></a>
<a href="https://codeclimate.com/github/mmagorsc/taskmonad"> <img src="https://api.codeclimate.com/v1/badges/e4de6996bf5bb710d0e7/maintainability"></a>
<a href="https://opensource.org/licenses/BSD-3-Clause"><img src="https://img.shields.io/badge/license-BSD-blue.svg"></a>
<p style="margin-top:30px; margin-bottom:17px; font-family: Georgia, serif;font-size: 17px;color: #3E4349;"><b>TaskMonad.ScratchPad</b> provides a wrapper around <a href="hackage.haskell.org/package/xmonad-contrib/docs/XMonad-Util-NamedScratchpad.html">XMonad.Util.NamedScratchpad</a>
that can be used to display taskwarrior commands</p>
<div id="content"><div id="synopsis"><details id="syn"><summary>Synopsis</summary><ul class="details-toggle" data-details-id="syn"><li class="src short"><a href="#v:taskwarriorScratchpad">taskwarriorScratchpad</a> :: X ()</li><li class="src short"><a href="#v:taskwarriorScratchpads">taskwarriorScratchpads</a> :: [NamedScratchpad]</li><li class="src short"><a href="#v:hideScratchpadAction">hideScratchpadAction</a> :: NamedScratchpads -> String -> X ()</li><li class="src short"><a href="#v:twscratchpad">twscratchpad</a> :: String -> X ()</li><li class="src short"><a href="#v:runTmuxCommand">runTmuxCommand</a> :: MonadIO m => String -> m ()</li></ul></details></div><div id="interface"><a href="#g:1" id="g:1"><h1>Usage</h1></a><div class="doc"><p>Just add a manage hook:</p><pre>, manageHook = namedScratchpadManageHook taskwarriorScratchpads</pre></div><a href="#g:2" id="g:2"><h1>Screenshots</h1></a><div class="doc"><p>TaskMonad.Scratchpad in action:</p><p>
<a href="images/taskmonad-scratchpad.png" data-lightbox="example-1">
<img style="width:100%" src="images/taskmonad-scratchpad.png" alt="Capture">
</a>
</p></div><div class="top"><p class="src"><a id="v:taskwarriorScratchpad" class="def">taskwarriorScratchpad</a> :: X () <a href="src/TaskMonad.ScratchPad.html#taskwarriorScratchpad" class="link">Source</a> <a href="#v:taskwarriorScratchpad" class="selflink">#</a></p><div class="doc"><p>Open the TaskWarrior-ScratchPad</p></div></div><div class="top"><p class="src"><a id="v:taskwarriorScratchpads" class="def">taskwarriorScratchpads</a> :: [NamedScratchpad] <a href="src/TaskMonad.ScratchPad.html#taskwarriorScratchpads" class="link">Source</a> <a href="#v:taskwarriorScratchpads" class="selflink">#</a></p><div class="doc"><p>The TaskWarrior-Scratchpad which contains a tmux session</p></div></div><div class="top"><p class="src"><a id="v:hideScratchpadAction" class="def">hideScratchpadAction</a> <a href="src/TaskMonad.ScratchPad.html#hideScratchpadAction" class="link">Source</a> <a href="#v:hideScratchpadAction" class="selflink">#</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tbody><tr><td class="src">:: NamedScratchpads</td><td class="doc"><p>Named scratchpads configuration</p></td></tr><tr><td class="src">-> String</td><td class="doc"><p>Scratchpad name</p></td></tr><tr><td class="src">-> X ()</td><td class="doc empty"> </td></tr></tbody></table></div><div class="doc"><p>Modified version of XMonad.Util.NamedScratchpad.hideScratchpadAction
which can be used to just show a scratchpad and don't hide it
in case it is already shown</p></div></div><div class="top"><p class="src"><a id="v:twscratchpad" class="def">twscratchpad</a> :: String -> X () <a href="src/TaskMonad.ScratchPad.html#twscratchpad" class="link">Source</a> <a href="#v:twscratchpad" class="selflink">#</a></p><div class="doc"><p>Send a taskwarrior command to the taskwarrior tmux session and open the taskwarrior scratchpad</p></div></div><div class="top"><p class="src"><a id="v:runTmuxCommand" class="def">runTmuxCommand</a> :: MonadIO m => String -> m () <a href="src/TaskMonad.ScratchPad.html#runTmuxCommand" class="link">Source</a> <a href="#v:runTmuxCommand" class="selflink">#</a></p><div class="doc"><p>Send a command to the taskwarrior tmux session</p></div></div></div></div>
</div>
</div>
</div>
<!-- Optional JavaScript -->
<!-- jQuery first, then Popper.js, then Bootstrap JS -->
<script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js" integrity="sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1" crossorigin="anonymous"></script>
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js" integrity="sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM" crossorigin="anonymous"></script>
<!-- GitHub Buttons -->
<script async defer src="https://buttons.github.io/buttons.js"></script>
<script src="js/lightbox-plus-jquery.min.js"></script>
</body>
</html>