twin/xmonad-contrib
1
0
Fork 0
mirror of https://github.com/xmonad/xmonad-contrib.git synced 2025-05-19 03:20:21 -07:00
Code Issues Packages Projects Releases Wiki Activity

Split A.TopicSpace documentation into sections

Browse Source
This commit is contained in:
Adam Vogt 2009-10-12 00:47:30 +00:00
parent 19b55d74a7
commit a8677c001a
1 changed files with 52 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

94
XMonad/Actions/TopicSpace.hs
View File

@ -9,7 +9,56 @@
-- Portability : unportable -- Portability : unportable
-- --
-- Turns your workspaces into a more topic oriented system. -- Turns your workspaces into a more topic oriented system.
-- -----------------------------------------------------------------------------
module XMonad.Actions.TopicSpace
(
-- * Overview
-- $overview
-- * Usage
-- $usage
Topic
, Dir
, TopicConfig(..)
, getLastFocusedTopics
, setLastFocusedTopic
, pprWindowSet
, topicActionWithPrompt
, topicAction
, currentTopicAction
, switchTopic
, switchNthLastFocused
, shiftNthLastFocused
, currentTopicDir
, checkTopicConfig
, (>*>)
)
where
import XMonad
import Data.List
import Data.Maybe (fromMaybe, isNothing, listToMaybe)
import Data.Ord
import qualified Data.Map as M
import Control.Monad ((=<<),liftM2,when,unless,replicateM_)
import System.IO
import XMonad.Operations
import qualified XMonad.StackSet as W
import XMonad.Prompt
import XMonad.Prompt.Workspace
import XMonad.Hooks.UrgencyHook
import XMonad.Hooks.DynamicLog (PP(..))
import qualified XMonad.Hooks.DynamicLog as DL
import XMonad.Util.Run (spawnPipe)
import XMonad.Util.StringProp(getStringListProp,setStringListProp)
-- $overview
-- This module allows to organize your workspaces on a precise topic basis. So -- This module allows to organize your workspaces on a precise topic basis. So
-- instead of having a workspace called `work' you can setup one workspace per -- instead of having a workspace called `work' you can setup one workspace per
-- task. Here we call these workspaces, topics. The great thing with -- task. Here we call these workspaces, topics. The great thing with
@ -21,7 +70,8 @@
-- display your topics in an historical way using a custom `pprWindowSet' -- display your topics in an historical way using a custom `pprWindowSet'
-- function. You can also easily switch to recent topics using this history -- function. You can also easily switch to recent topics using this history
-- of last focused topics. -- of last focused topics.
--
-- $usage
-- Here is an example of configuration using TopicSpace: -- Here is an example of configuration using TopicSpace:
-- --
-- @ -- @
@ -147,46 +197,6 @@
-- main :: IO () -- main :: IO ()
-- main = xmonad =<< myConfig -- main = xmonad =<< myConfig
-- @ -- @
module XMonad.Actions.TopicSpace
( Topic
, Dir
, TopicConfig(..)
, getLastFocusedTopics
, setLastFocusedTopic
, pprWindowSet
, topicActionWithPrompt
, topicAction
, currentTopicAction
, switchTopic
, switchNthLastFocused
, shiftNthLastFocused
, currentTopicDir
, checkTopicConfig
, (>*>)
)
where
import XMonad
import Data.List
import Data.Maybe (fromMaybe, isNothing, listToMaybe)
import Data.Ord
import qualified Data.Map as M
import Control.Monad ((=<<),liftM2,when,unless,replicateM_)
import System.IO
import XMonad.Operations
import qualified XMonad.StackSet as W
import XMonad.Prompt
import XMonad.Prompt.Workspace
import XMonad.Hooks.UrgencyHook
import XMonad.Hooks.DynamicLog (PP(..))
import qualified XMonad.Hooks.DynamicLog as DL
import XMonad.Util.Run (spawnPipe)
import XMonad.Util.StringProp(getStringListProp,setStringListProp)
-- | An alias for @flip replicateM_@ -- | An alias for @flip replicateM_@
(>*>) :: Monad m => m a -> Int -> m () (>*>) :: Monad m => m a -> Int -> m ()