M lib/XMonad/Config/LaNinpre.hs → lib/XMonad/Config/LaNinpre.hs

@@ -44,17 +44,19 @@ import XMonad.Util.NamedScratchpad
 import XMonad.Util.SpawnOnce
 
 -- * fonts
+-- 
+-- $fonts
 --
 -- default font and helper for fonts.
 
--- | default lato font
+-- | default font
 fontDef :: String
 fontDef = fontXft "Lato" "regular" 14
 
 -- | font constructor
 --
---   it is just a helper function to simplify the process of specifying font
---   with xft.
+-- it is just a helper function to simplify the process of specifying font
+-- with xft.
 fontXft :: String   -- ^ font family
         -> String   -- ^ font style
         -> Int      -- ^ font size
@@ -68,10 +70,12 @@ , "hinting=true"
                                 ]
 
 -- * colors
+--
+-- $colors
 --
 -- color theme and stuff
 
--- | default color scheme
+-- | default color theme
 colorTheme :: ColorTheme
 colorTheme = ColorTheme "#111111" "#ccbbcc" "#223333" "#ffaaaa"
 
@@ -91,6 +95,8 @@
 
 -- * software
 --
+-- $software
+--
 -- these are just contstants
 
 -- | set terminal emulator
@@ -111,8 +117,8 @@ fileManager = "thunar"
 
 -- | music on console
 --
---   this is to avoid spamming strings everywhere. @moc@ doesn't comply with
---   XDG_CONFIG_HOME, so we force it to do so.
+-- this is to avoid spamming strings everywhere. @moc@ doesn't comply with
+-- XDG_CONFIG_HOME, so we force it to do so.
 mocpString :: String
 mocpString = "mocp -M '~/.config/moc'"
 
@@ -120,16 +126,11 @@ -- | set editor
 editor :: String
 editor = terminalEmulator ++ " -e vi"
 
--- * hooks
+-- * manage hook
 --
--- hooks for xmonad config
-
--- ** manage hook
+-- $managehook
 --
--- @doFloat@ forces a window to float. useful for dialog boxes and such.
--- using @doShift (myWorkspaces !! 7)@ sends program to workspace 8
--- i'm doing it this way because otherwise i would have to write out the full
--- name of my workspaces and the names would be very long if using clickable workspaces.
+-- send some windows here and there.
 
 -- | manage hook
 localManageHook :: ManageHook
@@ -171,6 +172,8 @@ , isFullscreen -->  doFullFloat
      ] <+> namedScratchpadManageHook scratchPads
 
 -- * scratchpads
+--
+-- $scratchpads
 --
 -- currently i have:
 --
@@ -235,6 +238,8 @@ ph = ceiling (1080 * h)
 
 -- * workspaces
 --
+-- $workspaces
+--
 -- i've got two ways of specifying them. first one is pretty close to the
 -- original dt's config and second one is using linja pona font by jan same
 -- (check it out [here](http://musilili.net/linja-pona/)).
@@ -269,6 +274,8 @@ ]
 
 -- * grid select
 --
+-- $gridselect
+--
 -- stuff for 'GridSelect'
 
 -- | app grid for 'GridSelect' layout
@@ -303,6 +310,8 @@ spawnSelected' :: GSConfig String -> [(String, String)] -> X ()
 spawnSelected' conf lst = gridselect conf lst >>= flip whenJust spawn
 
 -- * keybindings
+--
+-- $keybindings
 --
 -- list of keybindings. it supposed to override the default keybindings.
 
@@ -368,6 +377,8 @@ ]
 
 -- * xmobar
 --
+-- $xmobar
+--
 -- stuff for xmobar
 
 -- | xmobar pretty printer
@@ -388,6 +399,8 @@ $ clickablePP $ filterOutWsPP [scratchpadWorkspaceTag] localXmobarPP
 
 -- * layouts 
 --
+-- $layouts
+--
 -- stuff for layouts
 
 -- | theme for 'Tabbed' layout
@@ -404,6 +417,8 @@ , urgentTextColor     = col_bg_alt def
            , urgentColor         = col_fg_alt def
            , urgentBorderWidth   = 0
            }
+
+-- * misc
 
 -- | layout hook 
 --
@@ -435,8 +450,10 @@ -- | main config
 --
 -- you can override things like that:
 --
--- > myConfig = laNinpreConfig { workspaces = workspacesNorm }
--- > main = xmonad myConfig
+-- @
+--     myConfig = laNinpreConfig { workspaces = 'workspacesNorm' }
+--     main = xmonad myConfig
+-- @
 laNinpreConfig = def
          { terminal           = terminalEmulator
          , modMask            = mod4Mask