diff --git a/XMonad/Actions/Commands.hs b/XMonad/Actions/Commands.hs index 263166e1..b957a01d 100644 --- a/XMonad/Actions/Commands.hs +++ b/XMonad/Actions/Commands.hs @@ -57,7 +57,7 @@ import XMonad.Prelude -- bindings!) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Create a 'Data.Map.Map' from @String@s to xmonad actions from a -- list of pairs. diff --git a/XMonad/Actions/CopyWindow.hs b/XMonad/Actions/CopyWindow.hs index f3f23bf0..b2f37b53 100644 --- a/XMonad/Actions/CopyWindow.hs +++ b/XMonad/Actions/CopyWindow.hs @@ -77,7 +77,7 @@ import qualified XMonad.StackSet as W -- > , ((modm .|. shiftMask, xK_v ), killAllOtherCopies) -- @@ Toggle window state back -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- $logHook -- diff --git a/XMonad/Actions/CycleRecentWS.hs b/XMonad/Actions/CycleRecentWS.hs index d4c1c4ad..ce8b0849 100644 --- a/XMonad/Actions/CycleRecentWS.hs +++ b/XMonad/Actions/CycleRecentWS.hs @@ -49,7 +49,7 @@ import Data.Function (on) -- > , ((modm, xK_Tab), cycleRecentWS [xK_Alt_L] xK_Tab xK_grave) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Cycle through most recent workspaces with repeated presses of a key, while -- a modifier key is held down. The recency of workspaces previewed while browsing diff --git a/XMonad/Actions/CycleWS.hs b/XMonad/Actions/CycleWS.hs index e58fdee7..bea471e9 100644 --- a/XMonad/Actions/CycleWS.hs +++ b/XMonad/Actions/CycleWS.hs @@ -122,7 +122,7 @@ import XMonad.Util.WorkspaceCompare -- > windows . view $ t ) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- -- When using the toggle functions, in order to ensure that the workspace -- to which you switch is the previously viewed workspace, use the diff --git a/XMonad/Actions/CycleWindows.hs b/XMonad/Actions/CycleWindows.hs index c00e3690..90be24a0 100644 --- a/XMonad/Actions/CycleWindows.hs +++ b/XMonad/Actions/CycleWindows.hs @@ -79,7 +79,7 @@ import Control.Arrow (second) -- -- Also, if you use focus follows mouse, you will want to read the section -- on updating the mouse pointer below. For detailed instructions on --- editing your key bindings, see "XMonad.Doc.Extending#Editing_key_bindings". +-- editing your key bindings, see . {- $pointer With FocusFollowsMouse == True, the focus is updated after binding actions, possibly focusing a window you didn't intend to focus. Most diff --git a/XMonad/Actions/DeManage.hs b/XMonad/Actions/DeManage.hs index 2082eaf4..c1cc4c8c 100644 --- a/XMonad/Actions/DeManage.hs +++ b/XMonad/Actions/DeManage.hs @@ -48,7 +48,7 @@ import XMonad -- > , ((modm, xK_d ), withFocused demanage) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Stop managing the currently focused window. demanage :: Window -> X () diff --git a/XMonad/Actions/DwmPromote.hs b/XMonad/Actions/DwmPromote.hs index a4cbf8f0..2193932b 100644 --- a/XMonad/Actions/DwmPromote.hs +++ b/XMonad/Actions/DwmPromote.hs @@ -40,7 +40,7 @@ import qualified Data.List.NonEmpty as NE -- > , ((modm, xK_Return), dwmpromote) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Swap the focused window with the master window. If focus is in -- the master, swap it with the next window in the stack. Focus diff --git a/XMonad/Actions/DynamicProjects.hs b/XMonad/Actions/DynamicProjects.hs index 032be52c..5907fed4 100644 --- a/XMonad/Actions/DynamicProjects.hs +++ b/XMonad/Actions/DynamicProjects.hs @@ -113,7 +113,7 @@ import qualified XMonad.Util.ExtensibleState as XS -- > , ((modm, xK_slash), shiftToProjectPrompt def) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -------------------------------------------------------------------------------- type ProjectName = String diff --git a/XMonad/Actions/DynamicWorkspaces.hs b/XMonad/Actions/DynamicWorkspaces.hs index 5992473b..46edcce2 100644 --- a/XMonad/Actions/DynamicWorkspaces.hs +++ b/XMonad/Actions/DynamicWorkspaces.hs @@ -75,7 +75,7 @@ import qualified XMonad.Util.ExtensibleState as XS -- > zip (zip (repeat (modm .|. controlMask)) [xK_1..xK_9]) (map (setWorkspaceIndex) [1..]) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". See also the documentation for +-- . See also the documentation for -- "XMonad.Actions.CopyWindow", 'windows', 'shift', and 'XPConfig'. type WorkspaceTag = String diff --git a/XMonad/Actions/FindEmptyWorkspace.hs b/XMonad/Actions/FindEmptyWorkspace.hs index ba5ed135..48806061 100644 --- a/XMonad/Actions/FindEmptyWorkspace.hs +++ b/XMonad/Actions/FindEmptyWorkspace.hs @@ -38,7 +38,7 @@ import XMonad.StackSet -- will tag the current window to an empty workspace and view it. -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Find the first hidden empty workspace in a StackSet. Returns -- Nothing if all workspaces are in use. Function searches currently diff --git a/XMonad/Actions/FloatKeys.hs b/XMonad/Actions/FloatKeys.hs index 698e790a..194300f1 100644 --- a/XMonad/Actions/FloatKeys.hs +++ b/XMonad/Actions/FloatKeys.hs @@ -39,7 +39,7 @@ import XMonad.Prelude (fi) -- > , ((modm, xK_a ), withFocused (keysMoveWindowTo (512,384) (1%2,1%2))) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | @keysMoveWindow (dx, dy)@ moves the window by @dx@ pixels to the -- right and @dy@ pixels down. diff --git a/XMonad/Actions/FloatSnap.hs b/XMonad/Actions/FloatSnap.hs index a43e6d02..ab77c377 100644 --- a/XMonad/Actions/FloatSnap.hs +++ b/XMonad/Actions/FloatSnap.hs @@ -53,7 +53,7 @@ import XMonad.Actions.AfterDrag -- > , ((modm .|. shiftMask, xK_Down), withFocused $ snapGrow D Nothing) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- -- And possibly add appropriate mouse bindings, for example: -- diff --git a/XMonad/Actions/FocusNth.hs b/XMonad/Actions/FocusNth.hs index ef24e143..d6511c32 100644 --- a/XMonad/Actions/FocusNth.hs +++ b/XMonad/Actions/FocusNth.hs @@ -36,7 +36,7 @@ import XMonad.StackSet -- > | (i, k) <- zip [0 .. 8] [xK_1 ..]] -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Give focus to the nth window of the current workspace. focusNth :: Int -> X () diff --git a/XMonad/Actions/LinkWorkspaces.hs b/XMonad/Actions/LinkWorkspaces.hs index 5d010040..a2aa8880 100644 --- a/XMonad/Actions/LinkWorkspaces.hs +++ b/XMonad/Actions/LinkWorkspaces.hs @@ -58,7 +58,7 @@ import qualified Data.Map as M -- > , (i, k) <- zip (XMonad.workspaces conf) [xK_1 .. xK_9]] -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . data MessageConfig = MessageConfig { messageFunction :: ScreenId -> [Char] -> [Char] -> [Char] -> X() , foreground :: [Char] diff --git a/XMonad/Actions/MouseResize.hs b/XMonad/Actions/MouseResize.hs index 9c4a09f1..c2261202 100644 --- a/XMonad/Actions/MouseResize.hs +++ b/XMonad/Actions/MouseResize.hs @@ -50,9 +50,9 @@ import XMonad.Util.XUtils -- -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". mouseResize :: l a -> ModifiedLayout MouseResize l a mouseResize = ModifiedLayout (MR []) diff --git a/XMonad/Actions/Navigation2D.hs b/XMonad/Actions/Navigation2D.hs index 1769204a..3b4afeb6 100644 --- a/XMonad/Actions/Navigation2D.hs +++ b/XMonad/Actions/Navigation2D.hs @@ -161,7 +161,7 @@ import XMonad.Util.Types -- -- For detailed instruction on editing the key binding see: -- --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- $finer_points -- #Finer_Points# diff --git a/XMonad/Actions/OnScreen.hs b/XMonad/Actions/OnScreen.hs index d5d616d5..dff88dba 100644 --- a/XMonad/Actions/OnScreen.hs +++ b/XMonad/Actions/OnScreen.hs @@ -183,4 +183,4 @@ toggleOrView' f i st = fromMaybe (f i st) $ do -- where 0 is the first screen and \"1\" the workspace with the tag \"1\". -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . diff --git a/XMonad/Actions/PerLayoutKeys.hs b/XMonad/Actions/PerLayoutKeys.hs index 87e2aab6..b4b267dd 100644 --- a/XMonad/Actions/PerLayoutKeys.hs +++ b/XMonad/Actions/PerLayoutKeys.hs @@ -32,7 +32,7 @@ import XMonad.StackSet as S -- > ,((0, xK_F2), bindByLayout [("Tall", spawn "rxvt"), ("Mirror Tall", spawn "xeyes"), ("", spawn "xmessage hello")]) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Uses supplied function to decide which action to run depending on current layout name. chooseActionByLayout :: (String->X()) -> X() diff --git a/XMonad/Actions/PerWindowKeys.hs b/XMonad/Actions/PerWindowKeys.hs index 26642f95..95128b64 100644 --- a/XMonad/Actions/PerWindowKeys.hs +++ b/XMonad/Actions/PerWindowKeys.hs @@ -41,7 +41,7 @@ import XMonad -- doThisIfTheOthersFail)]@. -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Run an action if a Query holds true. Doesn't stop at the first one that -- does, however, and could potentially run all actions. diff --git a/XMonad/Actions/PerWorkspaceKeys.hs b/XMonad/Actions/PerWorkspaceKeys.hs index c4095e6f..f3d95081 100644 --- a/XMonad/Actions/PerWorkspaceKeys.hs +++ b/XMonad/Actions/PerWorkspaceKeys.hs @@ -32,7 +32,7 @@ import XMonad.StackSet as S -- > ,((0, xK_F2), bindOn [("1", spawn "rxvt"), ("2", spawn "xeyes"), ("", spawn "xmessage hello")]) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Uses supplied function to decide which action to run depending on current workspace name. chooseAction :: (String->X()) -> X() diff --git a/XMonad/Actions/PhysicalScreens.hs b/XMonad/Actions/PhysicalScreens.hs index 86e3b29c..06a4792b 100644 --- a/XMonad/Actions/PhysicalScreens.hs +++ b/XMonad/Actions/PhysicalScreens.hs @@ -65,7 +65,7 @@ Example usage in your @~\/.xmonad\/xmonad.hs@ file: > , (f, mask) <- [(viewScreen def, 0), (sendToScreen def, shiftMask)]] For detailed instructions on editing your key bindings, see -"XMonad.Doc.Extending#Editing_key_bindings". +. -} -- | The type of the index of a screen by location diff --git a/XMonad/Actions/Plane.hs b/XMonad/Actions/Plane.hs index 4a3d1145..dd692d80 100644 --- a/XMonad/Actions/Plane.hs +++ b/XMonad/Actions/Plane.hs @@ -59,7 +59,7 @@ import XMonad.Util.Run -- > myNewKeys (XConfig {modMask = modm}) = planeKeys modm (Lines 3) Finite -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Direction to go in the plane. data Direction = ToLeft | ToUp | ToRight | ToDown deriving Enum diff --git a/XMonad/Actions/Promote.hs b/XMonad/Actions/Promote.hs index b580d095..64c6eb28 100644 --- a/XMonad/Actions/Promote.hs +++ b/XMonad/Actions/Promote.hs @@ -37,7 +37,7 @@ import XMonad.StackSet -- > , ((modm, xK_Return), promote) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Move the focused window to the master pane. All other windows -- retain their order. If focus is in the master, swap it with the diff --git a/XMonad/Actions/RotSlaves.hs b/XMonad/Actions/RotSlaves.hs index 5e0392d2..3fc45803 100644 --- a/XMonad/Actions/RotSlaves.hs +++ b/XMonad/Actions/RotSlaves.hs @@ -39,7 +39,7 @@ import XMonad.Prelude -- TwoPane layout (see "XMonad.Layout.TwoPane"). -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Rotate the windows in the current stack, excluding the first one -- (master). diff --git a/XMonad/Actions/SimpleDate.hs b/XMonad/Actions/SimpleDate.hs index 010fc8c2..d248d6cc 100644 --- a/XMonad/Actions/SimpleDate.hs +++ b/XMonad/Actions/SimpleDate.hs @@ -35,7 +35,7 @@ import XMonad.Util.Run -- In this example, a popup date menu will now be bound to @mod-d@. -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . date :: X () date = unsafeSpawn "(date; sleep 10) | dzen2" diff --git a/XMonad/Actions/SinkAll.hs b/XMonad/Actions/SinkAll.hs index e0453c3a..62a1fb02 100644 --- a/XMonad/Actions/SinkAll.hs +++ b/XMonad/Actions/SinkAll.hs @@ -32,4 +32,4 @@ import XMonad.Actions.WithAll (sinkAll) -- > , ((modm .|. shiftMask, xK_t), sinkAll) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . diff --git a/XMonad/Actions/SpawnOn.hs b/XMonad/Actions/SpawnOn.hs index 85d8e202..584fff4d 100644 --- a/XMonad/Actions/SpawnOn.hs +++ b/XMonad/Actions/SpawnOn.hs @@ -63,7 +63,7 @@ import XMonad.Util.Process (getPPIDChain) -- the spawned application(e.g. float or resize it). -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . newtype Spawner = Spawner {pidsRef :: [(ProcessID, ManageHook)]} diff --git a/XMonad/Actions/Submap.hs b/XMonad/Actions/Submap.hs index 7b03b2a1..7978eb18 100644 --- a/XMonad/Actions/Submap.hs +++ b/XMonad/Actions/Submap.hs @@ -56,7 +56,7 @@ because that is a special value passed to XGrabKey() and not an actual modifier. For detailed instructions on editing your key bindings, see -"XMonad.Doc.Extending#Editing_key_bindings". +. -} diff --git a/XMonad/Actions/SwapWorkspaces.hs b/XMonad/Actions/SwapWorkspaces.hs index cdc8d5a9..3fe5f135 100644 --- a/XMonad/Actions/SwapWorkspaces.hs +++ b/XMonad/Actions/SwapWorkspaces.hs @@ -44,7 +44,7 @@ import XMonad.Util.WorkspaceCompare -- will swap workspaces 1 and 5. -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Swaps the currently focused workspace with the given workspace tag, via -- @swapWorkspaces@. diff --git a/XMonad/Actions/TagWindows.hs b/XMonad/Actions/TagWindows.hs index 54f073e5..3be10a04 100644 --- a/XMonad/Actions/TagWindows.hs +++ b/XMonad/Actions/TagWindows.hs @@ -64,7 +64,7 @@ econst = const . return -- the tags \"a\" and \"b\" but not \"a b\". -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | set multiple tags for a window at once (overriding any previous tags) setTags :: [String] -> Window -> X () diff --git a/XMonad/Actions/Warp.hs b/XMonad/Actions/Warp.hs index bf74b167..8b96ef20 100644 --- a/XMonad/Actions/Warp.hs +++ b/XMonad/Actions/Warp.hs @@ -45,7 +45,7 @@ Note that warping to a particular screen may change the focus. -} -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . data Corner = UpperLeft | UpperRight | LowerLeft | LowerRight diff --git a/XMonad/Actions/WindowBringer.hs b/XMonad/Actions/WindowBringer.hs index 7f8b92f6..a46d0605 100644 --- a/XMonad/Actions/WindowBringer.hs +++ b/XMonad/Actions/WindowBringer.hs @@ -46,7 +46,7 @@ import XMonad.Util.NamedWindows (getName, getNameWMClass) -- > , ((modm .|. shiftMask, xK_b ), bringMenu) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . data WindowBringerConfig = WindowBringerConfig { menuCommand :: String -- ^ The shell command that will handle window selection diff --git a/XMonad/Actions/WindowGo.hs b/XMonad/Actions/WindowGo.hs index e05fc046..7a1b949d 100644 --- a/XMonad/Actions/WindowGo.hs +++ b/XMonad/Actions/WindowGo.hs @@ -66,7 +66,8 @@ appropriate one, or cover your bases by using instead something like: > (className =? "Firefox" <||> className =? "Firefox-bin") For detailed instructions on editing your key bindings, see -"XMonad.Doc.Extending#Editing_key_bindings". -} +. +-} -- | Get the list of workspaces sorted by their tag workspacesSorted :: Ord i => W.StackSet i l a s sd -> [W.Workspace i l a] diff --git a/XMonad/Actions/WithAll.hs b/XMonad/Actions/WithAll.hs index d58cd3d3..bb28613c 100644 --- a/XMonad/Actions/WithAll.hs +++ b/XMonad/Actions/WithAll.hs @@ -33,7 +33,7 @@ import XMonad.StackSet -- , ((modm .|. shiftMask, xK_t), sinkAll) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Un-float all floating windows on the current workspace. sinkAll :: X () diff --git a/XMonad/Actions/Workscreen.hs b/XMonad/Actions/Workscreen.hs index 4036b0ba..85e8912e 100644 --- a/XMonad/Actions/Workscreen.hs +++ b/XMonad/Actions/Workscreen.hs @@ -58,7 +58,7 @@ import XMonad.Actions.OnScreen -- > , (f, m) <- [(Workscreen.viewWorkscreen, 0), (Workscreen.shiftToWorkscreen, shiftMask)]] -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . data Workscreen = Workscreen{workscreenId::Int,workspaces::[WorkspaceId]} deriving (Show) diff --git a/XMonad/Actions/WorkspaceNames.hs b/XMonad/Actions/WorkspaceNames.hs index 13e5b280..2c2ac69f 100644 --- a/XMonad/Actions/WorkspaceNames.hs +++ b/XMonad/Actions/WorkspaceNames.hs @@ -88,7 +88,7 @@ import qualified Data.Map as M -- > | (i, k) <- zip workspaces [xK_1 ..]] -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . diff --git a/XMonad/Config/Desktop.hs b/XMonad/Config/Desktop.hs index 48e027b1..70f8eac3 100644 --- a/XMonad/Config/Desktop.hs +++ b/XMonad/Config/Desktop.hs @@ -91,7 +91,7 @@ import qualified Data.Map as M -- $customizing -- To customize a desktop config, modify its fields as is illustrated with --- the default configuration @def@ in "XMonad.Doc.Extending#Extending xmonad". +-- the default configuration @def@ in . -- $layouts -- See also "XMonad.Util.EZConfig" for more options for modifying key bindings. diff --git a/XMonad/Doc/Configuring.hs b/XMonad/Doc/Configuring.hs index 66d383f7..092f8fa9 100644 --- a/XMonad/Doc/Configuring.hs +++ b/XMonad/Doc/Configuring.hs @@ -14,7 +14,9 @@ -- . -- -- For more detailed instructions on extending xmonad with the --- xmonad-contrib library, see "XMonad.Doc.Extending". +-- xmonad-contrib library, see +-- +-- and "XMonad.Doc.Extending". -- ----------------------------------------------------------------------------- diff --git a/XMonad/Hooks/DebugKeyEvents.hs b/XMonad/Hooks/DebugKeyEvents.hs index 461777d3..3ab4e504 100644 --- a/XMonad/Hooks/DebugKeyEvents.hs +++ b/XMonad/Hooks/DebugKeyEvents.hs @@ -51,9 +51,8 @@ import System.IO (hPutStrLn -- the key; @mask@ is raw, and @clean@ is what @xmonad@ sees after -- sanitizing it (removing @numberLockMask@, etc.) -- --- For more detailed instructions on editing the logHook see: --- --- "XMonad.Doc.Extending#The_log_hook_and_external_status_bars" +-- For more detailed instructions on editing the logHook see +-- . -- | Print key events to stderr for debugging debugKeyEvents :: Event -> X All diff --git a/XMonad/Hooks/FadeInactive.hs b/XMonad/Hooks/FadeInactive.hs index 9c21aced..54726d83 100644 --- a/XMonad/Hooks/FadeInactive.hs +++ b/XMonad/Hooks/FadeInactive.hs @@ -47,13 +47,12 @@ import qualified XMonad.StackSet as W -- you will need to have xcompmgr -- or something similar for this to do anything -- --- For more detailed instructions on editing the logHook see: +-- For more detailed instructions on editing the logHook see +-- . -- --- "XMonad.Doc.Extending#The_log_hook_and_external_status_bars" --- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- | Converts a percentage to the format required for _NET_WM_WINDOW_OPACITY rationalToOpacity :: Integral a => Rational -> a diff --git a/XMonad/Hooks/FadeWindows.hs b/XMonad/Hooks/FadeWindows.hs index 43fa6710..407f055a 100644 --- a/XMonad/Hooks/FadeWindows.hs +++ b/XMonad/Hooks/FadeWindows.hs @@ -105,9 +105,8 @@ import Graphics.X11.Xlib.Extras (Event(..)) -- aren't running a compositing manager, the opacity will be recorded -- but won't take effect until a compositing manager is started. -- --- For more detailed instructions on editing the 'logHook' see: --- --- "XMonad.Doc.Extending#The_log_hook_and_external_status_bars" +-- For more detailed instructions on editing the 'logHook' see +-- . -- -- For more detailed instructions on editing the 'handleEventHook', -- see: diff --git a/XMonad/Hooks/ManageDocks.hs b/XMonad/Hooks/ManageDocks.hs index 3e654006..5ed0b72f 100644 --- a/XMonad/Hooks/ManageDocks.hs +++ b/XMonad/Hooks/ManageDocks.hs @@ -83,7 +83,7 @@ import qualified XMonad.StackSet as W -- > layoutHook = avoidStrutsOn [U,L] (tall ||| mirror tall ||| ...) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- -- | Add docks functionality to the given config. See above for an example. diff --git a/XMonad/Hooks/SetWMName.hs b/XMonad/Hooks/SetWMName.hs index e44e1402..9bb67955 100644 --- a/XMonad/Hooks/SetWMName.hs +++ b/XMonad/Hooks/SetWMName.hs @@ -33,7 +33,7 @@ -- fails miserably by guessing absolutely bogus values. -- -- For detailed instructions on editing your hooks, see --- "XMonad.Doc.Extending#4". +-- and "XMonad.Doc.Extending". ----------------------------------------------------------------------------- module XMonad.Hooks.SetWMName ( diff --git a/XMonad/Hooks/WindowSwallowing.hs b/XMonad/Hooks/WindowSwallowing.hs index 323dba0b..8f5dc9a1 100644 --- a/XMonad/Hooks/WindowSwallowing.hs +++ b/XMonad/Hooks/WindowSwallowing.hs @@ -66,7 +66,7 @@ import System.Posix.Types ( ProcessID ) -- instead of swallowing the window it will merge the child window with the parent. (this does not work with floating windows) -- -- For more information on editing your handleEventHook and key bindings, --- see "XMonad.Doc.Extending". +-- see and "XMonad.Doc.Extending". -- | Run @action@ iff both parent- and child queries match and the child -- is a child by PID. diff --git a/XMonad/Layout/Accordion.hs b/XMonad/Layout/Accordion.hs index fcdff529..76dfa33d 100644 --- a/XMonad/Layout/Accordion.hs +++ b/XMonad/Layout/Accordion.hs @@ -34,9 +34,9 @@ import Data.Ratio -- > myLayout = Accordion ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". data Accordion a = Accordion deriving ( Read, Show ) diff --git a/XMonad/Layout/AvoidFloats.hs b/XMonad/Layout/AvoidFloats.hs index 687fedfb..b9e88f12 100644 --- a/XMonad/Layout/AvoidFloats.hs +++ b/XMonad/Layout/AvoidFloats.hs @@ -44,8 +44,9 @@ import qualified Data.Set as S -- -- > layoutHook = ... ||| avoidFloats Full ||| ... -- --- For more detailed instructions on editing the layoutHook see: --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- Then add appropriate key bindings, for example: -- @@ -54,7 +55,7 @@ import qualified Data.Set as S -- > ,((modm .|. shiftMask .|. controlMask, xK_b), sendMessage (AvoidFloatSet False) >> sendMessage AvoidFloatClearItems) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- -- Note that this module is incompatible with an old way of configuring -- "XMonad.Actions.FloatSnap". If you are having problems, please update your diff --git a/XMonad/Layout/BoringWindows.hs b/XMonad/Layout/BoringWindows.hs index 844cca8c..3bbbe901 100644 --- a/XMonad/Layout/BoringWindows.hs +++ b/XMonad/Layout/BoringWindows.hs @@ -60,9 +60,9 @@ import qualified XMonad.StackSet as W -- > , ((modm, xK_k), focusDown) -- > , ((modm, xK_m), focusMaster) -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". data BoringMessage = FocusUp | FocusDown | FocusMaster | IsBoring Window | ClearBoring diff --git a/XMonad/Layout/CenteredIfSingle.hs b/XMonad/Layout/CenteredIfSingle.hs index 8a739895..07d24ee0 100644 --- a/XMonad/Layout/CenteredIfSingle.hs +++ b/XMonad/Layout/CenteredIfSingle.hs @@ -38,7 +38,9 @@ import XMonad.Prelude (fi) -- -- > myLayoutHook = centeredIfSingle 0.7 0.8 Grid ||| ... -- --- For more information on configuring your layouts see "XMonad.Doc.Extending". +-- For more information on configuring your layouts see +-- +-- and "XMonad.Doc.Extending". -- | Layout Modifier that places a window in the center of the screen, diff --git a/XMonad/Layout/Circle.hs b/XMonad/Layout/Circle.hs index 49a56117..29dfb1b7 100644 --- a/XMonad/Layout/Circle.hs +++ b/XMonad/Layout/Circle.hs @@ -35,9 +35,9 @@ import XMonad.StackSet (integrate, peek) -- > myLayout = Circle ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". data Circle a = Circle deriving ( Read, Show ) diff --git a/XMonad/Layout/Combo.hs b/XMonad/Layout/Combo.hs index 89fb42a2..e5e41c70 100644 --- a/XMonad/Layout/Combo.hs +++ b/XMonad/Layout/Combo.hs @@ -40,9 +40,9 @@ import qualified XMonad.StackSet as W ( differentiate ) -- -- to your layouts. -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- combineTwo is a new simple layout combinator. It allows the -- combination of two layouts using a third to split the screen @@ -57,7 +57,7 @@ import qualified XMonad.StackSet as W ( differentiate ) -- > , ((modm .|. controlMask .|. shiftMask, xK_Down ), sendMessage $ Move D) -- -- For detailed instruction on editing the key binding see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- -- These bindings will move a window into the sublayout that is -- up\/down\/left\/right of its current position. Note that there is some diff --git a/XMonad/Layout/ComboP.hs b/XMonad/Layout/ComboP.hs index 73bd0199..a1631cb3 100644 --- a/XMonad/Layout/ComboP.hs +++ b/XMonad/Layout/ComboP.hs @@ -44,9 +44,9 @@ import qualified XMonad.StackSet as W -- to your layouts. This way all windows with class = \"Firefox\" will always go -- to the left pane, all others - to the right. -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- 'combineTwoP' is a simple layout combinator based on 'combineTwo' from Combo, with -- addition of a 'Property' which tells where to put new windows. Windows mathing @@ -64,7 +64,7 @@ import qualified XMonad.StackSet as W -- > , ((modm .|. controlMask .|. shiftMask, xK_s ), sendMessage $ SwapWindow) -- -- For detailed instruction on editing the key binding see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . data SwapWindow = SwapWindow -- ^ Swap window between panes | SwapWindowN Int -- ^ Swap window between panes in the N-th nested ComboP. @SwapWindowN 0@ equals to SwapWindow diff --git a/XMonad/Layout/DecorationMadness.hs b/XMonad/Layout/DecorationMadness.hs index 883be11c..d17e621f 100644 --- a/XMonad/Layout/DecorationMadness.hs +++ b/XMonad/Layout/DecorationMadness.hs @@ -108,9 +108,9 @@ import XMonad.Layout.SimpleFloat -- -- > main = xmonad def { layoutHook = someMadLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- You can also edit the default theme: -- diff --git a/XMonad/Layout/Dishes.hs b/XMonad/Layout/Dishes.hs index fff34076..47d2c28d 100644 --- a/XMonad/Layout/Dishes.hs +++ b/XMonad/Layout/Dishes.hs @@ -36,9 +36,9 @@ import XMonad.Prelude (ap) -- > myLayout = Dishes 2 (1/6) ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". data Dishes a = Dishes Int Rational deriving (Show, Read) instance LayoutClass Dishes a where diff --git a/XMonad/Layout/DragPane.hs b/XMonad/Layout/DragPane.hs index 2c806bb3..9c8ec7b3 100644 --- a/XMonad/Layout/DragPane.hs +++ b/XMonad/Layout/DragPane.hs @@ -44,9 +44,9 @@ import XMonad.Util.XUtils -- > myLayout = dragPane Horizontal 0.1 0.5 ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". halfHandleWidth :: Integral a => a halfHandleWidth = 1 diff --git a/XMonad/Layout/Dwindle.hs b/XMonad/Layout/Dwindle.hs index 99547560..dadf8adf 100644 --- a/XMonad/Layout/Dwindle.hs +++ b/XMonad/Layout/Dwindle.hs @@ -68,9 +68,9 @@ import XMonad.Util.Types ( Direction2D(..) ) -- 1.1, is the factor by which the third parameter increases or decreases in -- response to Expand or Shrink messages. -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- | Layouts with geometrically decreasing window sizes. 'Spiral' and 'Dwindle' -- split the screen into a rectangle for the first window and a rectangle for diff --git a/XMonad/Layout/DwmStyle.hs b/XMonad/Layout/DwmStyle.hs index 79e6dc08..5c581eb2 100644 --- a/XMonad/Layout/DwmStyle.hs +++ b/XMonad/Layout/DwmStyle.hs @@ -40,9 +40,9 @@ import XMonad.Layout.Decoration -- > myL = dwmStyle shrinkText def (layoutHook def) -- > main = xmonad def { layoutHook = myL } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- You can also edit the default configuration options. -- diff --git a/XMonad/Layout/FixedAspectRatio.hs b/XMonad/Layout/FixedAspectRatio.hs index 19d983e7..2a2964a0 100644 --- a/XMonad/Layout/FixedAspectRatio.hs +++ b/XMonad/Layout/FixedAspectRatio.hs @@ -53,8 +53,8 @@ import XMonad.Layout.LayoutHints -- depending on the size hints (for example for programs like mpv), -- see "XMonad.Layout.LayoutHints" -- --- See "XMonad.Doc.Extending#Editing_the_layout_hook" for more info on --- the 'layoutHook'. +-- See and +-- "XMonad.Doc.Extending#Editing_the_layout_hook" for more info on the 'layoutHook'. -- -- You also want to add keybindings to set and clear the aspect ratio: -- @@ -73,7 +73,7 @@ import XMonad.Layout.LayoutHints -- -- > , ((modMask .|. shiftMask, xK_c), withFocused (sendMessage . ResetRatio) >> kill) -- --- See "XMonad.Doc.Extending#Editing_key_bindings" for more info +-- See for more info -- on customizing the keybindings. -- -- This layout also comes with a 'ManageHook' 'doFixAspect' to @@ -84,7 +84,8 @@ import XMonad.Layout.LayoutHints -- > ... -- > ] -- --- Check "XMonad.Doc.Extending#Editing_the_manage_hook" for more information on +-- Check and +-- "XMonad.Doc.Extending#Editing_the_manage_hook" for more information on -- customizing the manage hook. -- | Similar to 'layoutHintsWithReplacement', but relies on the user to diff --git a/XMonad/Layout/FixedColumn.hs b/XMonad/Layout/FixedColumn.hs index 52c80256..cd7973a1 100644 --- a/XMonad/Layout/FixedColumn.hs +++ b/XMonad/Layout/FixedColumn.hs @@ -37,9 +37,9 @@ import qualified XMonad.StackSet as W -- > myLayout = FixedColumn 1 20 80 10 ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- | A tiling mode based on preserving a nice fixed width -- window. Supports 'Shrink', 'Expand' and 'IncMasterN'. diff --git a/XMonad/Layout/Grid.hs b/XMonad/Layout/Grid.hs index 8bf9d885..3e5f44b7 100644 --- a/XMonad/Layout/Grid.hs +++ b/XMonad/Layout/Grid.hs @@ -40,9 +40,9 @@ import XMonad.StackSet -- -- > myLayout = GridRatio (4/3) ||| etc. -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". data Grid a = Grid | GridRatio Double deriving (Read, Show) diff --git a/XMonad/Layout/Groups/Examples.hs b/XMonad/Layout/Groups/Examples.hs index fb5e375d..6c21951d 100644 --- a/XMonad/Layout/Groups/Examples.hs +++ b/XMonad/Layout/Groups/Examples.hs @@ -84,8 +84,8 @@ import XMonad.Layout.Simplest -- the "XMonad.Layout.Groups.Helpers" module, which are all -- re-exported by this module. -- --- For more information on how to extend your layour hook and key bindings, see --- "XMonad.Doc.Extending". +-- For more information on how to extend your layoutHook and key bindings, see +-- and "XMonad.Doc.Extending". -- * Helper: ZoomRow of Group elements diff --git a/XMonad/Layout/Groups/Helpers.hs b/XMonad/Layout/Groups/Helpers.hs index 5d750d63..808d2c02 100644 --- a/XMonad/Layout/Groups/Helpers.hs +++ b/XMonad/Layout/Groups/Helpers.hs @@ -83,8 +83,8 @@ import qualified Data.Map as M -- -- > import qualified XMonad.Layout.Groups as G -- --- For more information on how to extend your layour hook and key bindings, see --- "XMonad.Doc.Extending". +-- For more information on how to extend your layoutHook and key bindings, see +-- and "XMonad.Doc.Extending". -- ** Layout-generic actions -- #Layout-generic actions# diff --git a/XMonad/Layout/Groups/Wmii.hs b/XMonad/Layout/Groups/Wmii.hs index 714cf4db..f4347771 100644 --- a/XMonad/Layout/Groups/Wmii.hs +++ b/XMonad/Layout/Groups/Wmii.hs @@ -79,8 +79,8 @@ import XMonad.Layout.Simplest -- -- and so on. -- --- For more information on how to extend your layout hook and key bindings, see --- "XMonad.Doc.Extending". +-- For more information on how to extend your layoutHook and key bindings, see +-- and "XMonad.Doc.Extending". -- -- Finally, you will probably want to be able to move focus and windows -- between groups in a consistent fashion. For this, you should take a look diff --git a/XMonad/Layout/Hidden.hs b/XMonad/Layout/Hidden.hs index 2d311095..778fb580 100644 --- a/XMonad/Layout/Hidden.hs +++ b/XMonad/Layout/Hidden.hs @@ -46,9 +46,9 @@ import qualified XMonad.StackSet as W -- > myLayout = hiddenWindows (Tall 1 (3/100) (1/2)) ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- In the key bindings, do something like: -- @@ -58,7 +58,7 @@ import qualified XMonad.StackSet as W -- -- For detailed instruction on editing the key bindings see: -- --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -------------------------------------------------------------------------------- newtype HiddenWindows a = HiddenWindows [Window] deriving (Show, Read) diff --git a/XMonad/Layout/HintedGrid.hs b/XMonad/Layout/HintedGrid.hs index 1e37fd05..bb84fb09 100644 --- a/XMonad/Layout/HintedGrid.hs +++ b/XMonad/Layout/HintedGrid.hs @@ -51,6 +51,7 @@ infixr 9 . -- > myLayout = GridRatio (4/3) False ||| etc. -- -- For more detailed instructions on editing the layoutHook see +-- and -- "XMonad.Doc.Extending#Editing_the_layout_hook". -- | Automatic mirroring of hinted layouts doesn't work very well, so this diff --git a/XMonad/Layout/HintedTile.hs b/XMonad/Layout/HintedTile.hs index 1c3c17c4..5214b283 100644 --- a/XMonad/Layout/HintedTile.hs +++ b/XMonad/Layout/HintedTile.hs @@ -46,9 +46,9 @@ import XMonad.Prelude -- built-in Tall with HintedTile, change @import Xmonad@ to -- @import Xmonad hiding (Tall)@. -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". data HintedTile a = HintedTile { nmaster :: !Int -- ^ number of windows in the master pane diff --git a/XMonad/Layout/IM.hs b/XMonad/Layout/IM.hs index c6559a75..7a907538 100644 --- a/XMonad/Layout/IM.hs +++ b/XMonad/Layout/IM.hs @@ -55,9 +55,9 @@ import Control.Arrow (first) -- -- Screenshot: -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- $hints -- diff --git a/XMonad/Layout/LayoutBuilder.hs b/XMonad/Layout/LayoutBuilder.hs index dd036a58..2e38e523 100644 --- a/XMonad/Layout/LayoutBuilder.hs +++ b/XMonad/Layout/LayoutBuilder.hs @@ -103,9 +103,9 @@ import XMonad.Util.WindowProperties -- -- These examples require "XMonad.Layout.Tabbed". -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- You may wish to add the following keybindings: -- @@ -114,7 +114,7 @@ import XMonad.Util.WindowProperties -- -- For detailed instruction on editing the key binding see: -- --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -------------------------------------------------------------------------------- -- $selectWin diff --git a/XMonad/Layout/LayoutCombinators.hs b/XMonad/Layout/LayoutCombinators.hs index 94346e49..3e1ab917 100644 --- a/XMonad/Layout/LayoutCombinators.hs +++ b/XMonad/Layout/LayoutCombinators.hs @@ -61,9 +61,9 @@ import XMonad.Layout.DragPane -- > myLayout = (Tall 1 (3/100) (1/2) *//* Full) ||| (Tall 1 (3/100) (1/2) ***||** Full) ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the @layoutHook@ see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the @layoutHook@ see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- $combine diff --git a/XMonad/Layout/LayoutHints.hs b/XMonad/Layout/LayoutHints.hs index 3f28bf9c..dbd4e775 100644 --- a/XMonad/Layout/LayoutHints.hs +++ b/XMonad/Layout/LayoutHints.hs @@ -66,9 +66,9 @@ import qualified Data.Set as Set -- -- > myLayout = layoutHintsToCenter (Tall 1 (3/100) (1/2)) -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- To make XMonad reflect changes in window hints immediately, add -- 'hintsEventHook' to your 'handleEventHook'. diff --git a/XMonad/Layout/LayoutScreens.hs b/XMonad/Layout/LayoutScreens.hs index f460a76c..b82356a0 100644 --- a/XMonad/Layout/LayoutScreens.hs +++ b/XMonad/Layout/LayoutScreens.hs @@ -57,7 +57,7 @@ import qualified XMonad.StackSet as W -- > , ((modm .|. controlMask .|. shiftMask, xK_space), rescreen) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Modify all screens. layoutScreens :: LayoutClass l Int => Int -> l Int -> X () diff --git a/XMonad/Layout/LimitWindows.hs b/XMonad/Layout/LimitWindows.hs index a22821ea..a8433ae4 100644 --- a/XMonad/Layout/LimitWindows.hs +++ b/XMonad/Layout/LimitWindows.hs @@ -56,7 +56,7 @@ import qualified XMonad.StackSet as W -- actions. -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- -- See also 'XMonad.Layout.BoringWindows.boringAuto' for keybindings that skip -- the hidden windows. diff --git a/XMonad/Layout/MagicFocus.hs b/XMonad/Layout/MagicFocus.hs index 70e7d77b..d1e2e5da 100644 --- a/XMonad/Layout/MagicFocus.hs +++ b/XMonad/Layout/MagicFocus.hs @@ -45,9 +45,9 @@ import qualified Data.Map as M -- > main = xmonad def { layoutHook = myLayout, -- > handleEventHook = promoteWarp } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- | Create a new layout which automagically puts the focused window -- in the master area. diff --git a/XMonad/Layout/Magnifier.hs b/XMonad/Layout/Magnifier.hs index 9048ab39..b8c27403 100644 --- a/XMonad/Layout/Magnifier.hs +++ b/XMonad/Layout/Magnifier.hs @@ -76,9 +76,9 @@ import XMonad.StackSet -- functions in this module are essentially just creative applications -- of it. -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- Magnifier supports some commands, see 'MagnifyMsg'. To use them add -- something like this to your key bindings: @@ -101,7 +101,7 @@ import XMonad.StackSet -- like @Mag.Toggle@, @Mag.magnifier@, and so on. -- -- For detailed instruction on editing the key binding see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Add magnification capabilities to a certain layout. -- diff --git a/XMonad/Layout/Master.hs b/XMonad/Layout/Master.hs index 598b9831..4eaabb8f 100644 --- a/XMonad/Layout/Master.hs +++ b/XMonad/Layout/Master.hs @@ -52,6 +52,7 @@ import Control.Arrow (first) -- Grid manage the right half. -- -- For more detailed instructions on editing the layoutHook see +-- and -- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- Like 'XMonad.Layout.Tall', 'withMaster' supports the diff --git a/XMonad/Layout/Maximize.hs b/XMonad/Layout/Maximize.hs index 65477ad3..1fcb6786 100644 --- a/XMonad/Layout/Maximize.hs +++ b/XMonad/Layout/Maximize.hs @@ -46,9 +46,9 @@ import XMonad.Prelude ( partition ) -- > myLayout = maximizeWithPadding 10 (Tall 1 (3/100) (1/2)) ||| Full ||| etc..) -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- In the key-bindings, do something like: -- @@ -57,7 +57,7 @@ import XMonad.Prelude ( partition ) -- -- For detailed instruction on editing the key binding see: -- --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . data Maximize a = Maximize Dimension (Maybe Window) deriving ( Read, Show ) maximize :: LayoutClass l Window => l Window -> ModifiedLayout Maximize l Window diff --git a/XMonad/Layout/Minimize.hs b/XMonad/Layout/Minimize.hs index ebffa8b3..b7a1d900 100644 --- a/XMonad/Layout/Minimize.hs +++ b/XMonad/Layout/Minimize.hs @@ -39,9 +39,9 @@ import qualified XMonad.Util.ExtensibleState as XS -- > myLayout = minimize (Tall 1 (3/100) (1/2)) ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- The module is designed to work together with "XMonad.Layout.BoringWindows" so -- that minimized windows will be skipped over when switching the focused window with diff --git a/XMonad/Layout/Mosaic.hs b/XMonad/Layout/Mosaic.hs index 8c291e04..548a02a4 100644 --- a/XMonad/Layout/Mosaic.hs +++ b/XMonad/Layout/Mosaic.hs @@ -58,9 +58,9 @@ import Control.Arrow(second, first) -- -- > , ((modm, xK_r), sendMessage Reset) -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". data Aspect = Taller diff --git a/XMonad/Layout/MosaicAlt.hs b/XMonad/Layout/MosaicAlt.hs index aebb2b55..542a33e0 100644 --- a/XMonad/Layout/MosaicAlt.hs +++ b/XMonad/Layout/MosaicAlt.hs @@ -48,9 +48,9 @@ import Data.Ratio -- > myLayout = MosaicAlt M.empty ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- In the key-bindings, do something like: -- @@ -63,7 +63,7 @@ import Data.Ratio -- -- For detailed instruction on editing the key binding see: -- --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . data HandleWindowAlt = ShrinkWindowAlt Window diff --git a/XMonad/Layout/MouseResizableTile.hs b/XMonad/Layout/MouseResizableTile.hs index 02993555..848facbc 100644 --- a/XMonad/Layout/MouseResizableTile.hs +++ b/XMonad/Layout/MouseResizableTile.hs @@ -53,9 +53,9 @@ import Graphics.X11 as X -- > main = xmonad def { layoutHook = myLayout } -- -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- You may also want to add the following key bindings: -- @@ -64,7 +64,7 @@ import Graphics.X11 as X -- -- For detailed instruction on editing the key binding see: -- --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- $mrtParameters -- The following functions are also labels for updating the @data@ (whose diff --git a/XMonad/Layout/MultiColumns.hs b/XMonad/Layout/MultiColumns.hs index 40b50615..b32642aa 100644 --- a/XMonad/Layout/MultiColumns.hs +++ b/XMonad/Layout/MultiColumns.hs @@ -56,9 +56,9 @@ import XMonad.Prelude -- columns, the screen is instead split equally among all columns. Therefore, -- if equal size among all columns are desired, set the size to -0.5. -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- | Layout constructor. multiCol diff --git a/XMonad/Layout/MultiDishes.hs b/XMonad/Layout/MultiDishes.hs index 5fc776a7..85043a36 100644 --- a/XMonad/Layout/MultiDishes.hs +++ b/XMonad/Layout/MultiDishes.hs @@ -53,9 +53,9 @@ import XMonad.Prelude (ap) -- > |_______| -- > |___|___| -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". data MultiDishes a = MultiDishes Int Int Rational deriving (Show, Read) instance LayoutClass MultiDishes a where diff --git a/XMonad/Layout/Named.hs b/XMonad/Layout/Named.hs index a8bca247..9ff20f07 100644 --- a/XMonad/Layout/Named.hs +++ b/XMonad/Layout/Named.hs @@ -37,9 +37,9 @@ import XMonad.Layout.Renamed -- > myLayout = named "real big" Full ||| (nameTail $ named "real big" $ Full) ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- Note that this module has been deprecated and may be removed in a future -- release, please use "XMonad.Layout.Renamed" instead. diff --git a/XMonad/Layout/NoBorders.hs b/XMonad/Layout/NoBorders.hs index 69c28ccb..e51b83c7 100644 --- a/XMonad/Layout/NoBorders.hs +++ b/XMonad/Layout/NoBorders.hs @@ -54,9 +54,9 @@ import qualified Data.Map as M -- -- > layoutHook = ... ||| noBorders Full ||| ... -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- todo, use an InvisibleList. data WithBorder a = WithBorder Dimension [a] deriving ( Read, Show ) diff --git a/XMonad/Layout/ResizableThreeColumns.hs b/XMonad/Layout/ResizableThreeColumns.hs index 7db17f91..ffb8cb28 100644 --- a/XMonad/Layout/ResizableThreeColumns.hs +++ b/XMonad/Layout/ResizableThreeColumns.hs @@ -55,9 +55,9 @@ import Data.Ratio -- -- The ResizableThreeColMid variant places the main window between the slave columns. -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- | Arguments are nmaster, delta, fraction diff --git a/XMonad/Layout/ResizableTile.hs b/XMonad/Layout/ResizableTile.hs index 4505f6b3..6b06100c 100644 --- a/XMonad/Layout/ResizableTile.hs +++ b/XMonad/Layout/ResizableTile.hs @@ -36,9 +36,9 @@ import qualified Data.Map as M -- > myLayout = ResizableTall 1 (3/100) (1/2) [] ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- You may also want to add the following key bindings: -- @@ -47,7 +47,7 @@ import qualified Data.Map as M -- -- For detailed instruction on editing the key binding see: -- --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . data MirrorResize = MirrorShrink | MirrorExpand instance Message MirrorResize diff --git a/XMonad/Layout/ResizeScreen.hs b/XMonad/Layout/ResizeScreen.hs index c92646c8..93e1e132 100644 --- a/XMonad/Layout/ResizeScreen.hs +++ b/XMonad/Layout/ResizeScreen.hs @@ -39,9 +39,9 @@ import XMonad.Layout.Decoration -- -- > layoutHook = resizeHorizontal 40 Full -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". resizeHorizontal :: Int -> l a -> ModifiedLayout ResizeScreen l a resizeHorizontal i = ModifiedLayout (ResizeScreen L i) diff --git a/XMonad/Layout/Roledex.hs b/XMonad/Layout/Roledex.hs index df830ea5..bb4b065f 100644 --- a/XMonad/Layout/Roledex.hs +++ b/XMonad/Layout/Roledex.hs @@ -36,9 +36,9 @@ import Data.Ratio -- > myLayout = Roledex ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- $screenshot -- <> diff --git a/XMonad/Layout/ShowWName.hs b/XMonad/Layout/ShowWName.hs index f7b2048a..2c456249 100644 --- a/XMonad/Layout/ShowWName.hs +++ b/XMonad/Layout/ShowWName.hs @@ -41,9 +41,9 @@ import XMonad.Util.XUtils -- > myLayout = layoutHook def -- > main = xmonad def { layoutHook = showWName myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- | A layout modifier to show the workspace name when switching showWName :: l a -> ModifiedLayout ShowWName l a diff --git a/XMonad/Layout/SimpleDecoration.hs b/XMonad/Layout/SimpleDecoration.hs index 5d88e02f..6f80ea25 100644 --- a/XMonad/Layout/SimpleDecoration.hs +++ b/XMonad/Layout/SimpleDecoration.hs @@ -42,9 +42,9 @@ import XMonad.Layout.Decoration -- > myL = simpleDeco shrinkText def (layoutHook def) -- > main = xmonad def { layoutHook = myL } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- You can also edit the default configuration options. -- diff --git a/XMonad/Layout/SimpleFloat.hs b/XMonad/Layout/SimpleFloat.hs index aff3b23a..004a7d7a 100644 --- a/XMonad/Layout/SimpleFloat.hs +++ b/XMonad/Layout/SimpleFloat.hs @@ -42,9 +42,9 @@ import XMonad.Layout.WindowArranger -- > myLayout = simpleFloat ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- | A simple floating layout where every window is placed according -- to the window's initial attributes. diff --git a/XMonad/Layout/Simplest.hs b/XMonad/Layout/Simplest.hs index 3aedbdb6..1e8c09b9 100644 --- a/XMonad/Layout/Simplest.hs +++ b/XMonad/Layout/Simplest.hs @@ -33,9 +33,9 @@ import qualified XMonad.StackSet as S -- > myLayout = Simplest ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". data Simplest a = Simplest deriving (Show, Read) instance LayoutClass Simplest a where diff --git a/XMonad/Layout/SimplestFloat.hs b/XMonad/Layout/SimplestFloat.hs index 70ba3b13..f9e8a15c 100644 --- a/XMonad/Layout/SimplestFloat.hs +++ b/XMonad/Layout/SimplestFloat.hs @@ -37,9 +37,9 @@ import XMonad.Layout.LayoutModifier -- > myLayout = simplestFloat ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- | A simple floating layout where every window is placed according -- to the window's initial attributes. diff --git a/XMonad/Layout/SortedLayout.hs b/XMonad/Layout/SortedLayout.hs index be144e8b..5e85c1d0 100644 --- a/XMonad/Layout/SortedLayout.hs +++ b/XMonad/Layout/SortedLayout.hs @@ -42,9 +42,9 @@ import XMonad.Util.WindowProperties -- > myLayout = sorted [ClassName "Firefox", ClassName "URxvt"] Grid -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- | Modify a layout using a list of properties to sort its windows. diff --git a/XMonad/Layout/Spiral.hs b/XMonad/Layout/Spiral.hs index 01c323c9..258b6b08 100644 --- a/XMonad/Layout/Spiral.hs +++ b/XMonad/Layout/Spiral.hs @@ -40,9 +40,9 @@ import XMonad.StackSet ( integrate ) -- > myLayout = spiral (6/7) ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". fibs :: [Integer] fibs = 1 : 1 : zipWith (+) fibs (tail fibs) diff --git a/XMonad/Layout/Square.hs b/XMonad/Layout/Square.hs index e63a34cd..cf10d730 100644 --- a/XMonad/Layout/Square.hs +++ b/XMonad/Layout/Square.hs @@ -41,7 +41,7 @@ import XMonad.StackSet ( integrate ) -- > [(tabbed,3),(tabbed,30),(tabbed,1),(tabbed,1)] -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . data Square a = Square deriving ( Read, Show ) diff --git a/XMonad/Layout/StackTile.hs b/XMonad/Layout/StackTile.hs index cfecc999..0bc18605 100644 --- a/XMonad/Layout/StackTile.hs +++ b/XMonad/Layout/StackTile.hs @@ -36,9 +36,9 @@ import XMonad.Prelude -- > myLayout = StackTile 1 (3/100) (1/2) ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- data StackTile a = StackTile !Int !Rational !Rational deriving (Show, Read) diff --git a/XMonad/Layout/Stoppable.hs b/XMonad/Layout/Stoppable.hs index fc0434b5..78d8e9a8 100644 --- a/XMonad/Layout/Stoppable.hs +++ b/XMonad/Layout/Stoppable.hs @@ -75,9 +75,9 @@ import System.Posix.Signals -- layoutHook you have to provide manageHook from -- "XMonad.Util.RemoteWindows" module. -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". signalWindow :: Signal -> Window -> X () signalWindow s w = do diff --git a/XMonad/Layout/SubLayouts.hs b/XMonad/Layout/SubLayouts.hs index f0a2f40a..1fc52163 100644 --- a/XMonad/Layout/SubLayouts.hs +++ b/XMonad/Layout/SubLayouts.hs @@ -163,10 +163,9 @@ import qualified Data.Set as S -- could not be used in the keybinding instead? It avoids having to explicitly -- pass the conf. -- --- For more detailed instructions, see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" --- "XMonad.Doc.Extending#Adding_key_bindings" +-- For more detailed instructions, see +-- +-- and "XMonad.Doc.Extending#Editing_the_layout_hook". -- | The main layout modifier arguments: -- diff --git a/XMonad/Layout/TabBarDecoration.hs b/XMonad/Layout/TabBarDecoration.hs index 5042db95..d94a3807 100644 --- a/XMonad/Layout/TabBarDecoration.hs +++ b/XMonad/Layout/TabBarDecoration.hs @@ -39,9 +39,9 @@ import XMonad.Prompt ( XPPosition (..) ) -- -- > main = xmonad def { layoutHook = simpleTabBar $ layoutHook def} -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- 'tabBar' will give you the possibility of setting a custom shrinker -- and a custom theme. diff --git a/XMonad/Layout/Tabbed.hs b/XMonad/Layout/Tabbed.hs index 01080d05..e9fd78d8 100644 --- a/XMonad/Layout/Tabbed.hs +++ b/XMonad/Layout/Tabbed.hs @@ -67,9 +67,9 @@ import XMonad.Util.Types (Direction2D(..)) -- on the workspace. To have it always shown, use one of the layouts or -- modifiers ending in @Always@. -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- You can also edit the default configuration options. -- diff --git a/XMonad/Layout/ThreeColumns.hs b/XMonad/Layout/ThreeColumns.hs index a86d23b1..075021ca 100644 --- a/XMonad/Layout/ThreeColumns.hs +++ b/XMonad/Layout/ThreeColumns.hs @@ -51,9 +51,9 @@ import Data.Ratio -- -- The ThreeColMid variant places the main window between the stack columns. -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- $screenshot diff --git a/XMonad/Layout/ToggleLayouts.hs b/XMonad/Layout/ToggleLayouts.hs index 0e2ed111..71417f37 100644 --- a/XMonad/Layout/ToggleLayouts.hs +++ b/XMonad/Layout/ToggleLayouts.hs @@ -34,9 +34,9 @@ import XMonad.StackSet (Workspace (..)) -- > myLayout = toggleLayouts Full (Tall 1 (3/100) (1/2)) ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- To toggle between layouts add a key binding like -- @@ -48,7 +48,7 @@ import XMonad.StackSet (Workspace (..)) -- -- For detailed instruction on editing the key binding see: -- --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . data ToggleLayouts lt lf a = ToggleLayouts Bool (lt a) (lf a) deriving (Read,Show) data ToggleLayout = ToggleLayout | Toggle String deriving (Read,Show) diff --git a/XMonad/Layout/TwoPane.hs b/XMonad/Layout/TwoPane.hs index 510f6448..67bf9028 100644 --- a/XMonad/Layout/TwoPane.hs +++ b/XMonad/Layout/TwoPane.hs @@ -36,9 +36,9 @@ import XMonad.StackSet ( focus, up, down) -- > myLayout = TwoPane (3/100) (1/2) ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". data TwoPane a = TwoPane Rational Rational diff --git a/XMonad/Layout/VoidBorders.hs b/XMonad/Layout/VoidBorders.hs index 680ad8ce..fa956834 100644 --- a/XMonad/Layout/VoidBorders.hs +++ b/XMonad/Layout/VoidBorders.hs @@ -46,9 +46,9 @@ import XMonad.StackSet (integrate) -- -- > layoutHook = ... ||| voidBorders Full ||| normalBorders Tall ... -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". data VoidBorders a = VoidBorders deriving (Read, Show) diff --git a/XMonad/Layout/WindowArranger.hs b/XMonad/Layout/WindowArranger.hs index 5dfaea5d..dc504c86 100644 --- a/XMonad/Layout/WindowArranger.hs +++ b/XMonad/Layout/WindowArranger.hs @@ -45,9 +45,9 @@ import Control.Arrow ((***), (>>>), (&&&), first) -- -- > main = xmonad def { layoutHook = windowArrangeAll myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- You may also want to define some key binding to move or resize -- windows. These are good defaults: @@ -68,7 +68,7 @@ import Control.Arrow ((***), (>>>), (&&&), first) -- > , ((modm .|. controlMask .|. shiftMask, xK_Up ), sendMessage (DecreaseUp 1)) -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | A layout modifier to float the windows in a workspace windowArrange :: l a -> ModifiedLayout WindowArranger l a diff --git a/XMonad/Layout/WindowNavigation.hs b/XMonad/Layout/WindowNavigation.hs index 10bd47d5..f2ada090 100644 --- a/XMonad/Layout/WindowNavigation.hs +++ b/XMonad/Layout/WindowNavigation.hs @@ -45,9 +45,9 @@ import XMonad.Util.XUtils -- > myLayout = windowNavigation (Tall 1 (3/100) (1/2)) ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the 'layoutHook' see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the 'layoutHook' see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- In keybindings: -- @@ -62,7 +62,7 @@ import XMonad.Util.XUtils -- -- For detailed instruction on editing the key binding see: -- --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . data MoveWindowToWindow a = MoveWindowToWindow a a deriving ( Read, Show) @@ -75,10 +75,10 @@ instance Message Navigate -- | Used with 'configurableNavigation' to specify how to show reachable windows' -- borders. You cannot create 'WNConfig' values directly; use 'def' or one of the following -- three functions to create one. --- +-- -- 'def', and 'windowNavigation', uses the focused border color at 40% brightness, as if -- you had specified --- +-- -- > configurableNavigation (navigateBrightness 0.4) data WNConfig = WNC { brightness :: Maybe Double -- Indicates a fraction of the focus color. diff --git a/XMonad/Layout/WorkspaceDir.hs b/XMonad/Layout/WorkspaceDir.hs index 3c862ae8..a3a0b9f7 100644 --- a/XMonad/Layout/WorkspaceDir.hs +++ b/XMonad/Layout/WorkspaceDir.hs @@ -51,9 +51,9 @@ import XMonad.StackSet ( tag, currentTag ) -- > myLayout = workspaceDir "~" (Tall 1 (3/100) (1/2)) ||| Full ||| etc.. -- > main = xmonad def { layoutHook = myLayout } -- --- For more detailed instructions on editing the layoutHook see: --- --- "XMonad.Doc.Extending#Editing_the_layout_hook" +-- For more detailed instructions on editing the layoutHook see +-- and +-- "XMonad.Doc.Extending#Editing_the_layout_hook". -- -- WorkspaceDir provides also a prompt. To use it you need to import -- "XMonad.Prompt" and add something like this to your key bindings: @@ -67,7 +67,7 @@ import XMonad.StackSet ( tag, currentTag ) -- -- For detailed instruction on editing the key binding see: -- --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . newtype Chdir = Chdir String instance Message Chdir diff --git a/XMonad/Layout/ZoomRow.hs b/XMonad/Layout/ZoomRow.hs index a1f34f8d..bc475acd 100644 --- a/XMonad/Layout/ZoomRow.hs +++ b/XMonad/Layout/ZoomRow.hs @@ -69,8 +69,9 @@ import Control.Arrow (second) -- > -- (Un)Maximize the focused window -- > , ((modMask , xK_f ), sendMessage ToggleZoomFull) -- --- For more information on editing your layout hook and key bindings, --- see "XMonad.Doc.Extending". +-- For more information on editing your layoutHook and key bindings, +-- see +-- and "XMonad.Doc.Extending". -- * Creation functions diff --git a/XMonad/Prompt/AppendFile.hs b/XMonad/Prompt/AppendFile.hs index f802d737..24fcabc4 100644 --- a/XMonad/Prompt/AppendFile.hs +++ b/XMonad/Prompt/AppendFile.hs @@ -69,7 +69,7 @@ import System.IO -- the file too. -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . newtype AppendFile = AppendFile FilePath diff --git a/XMonad/Prompt/DirExec.hs b/XMonad/Prompt/DirExec.hs index d409ba3e..5b77d439 100644 --- a/XMonad/Prompt/DirExec.hs +++ b/XMonad/Prompt/DirExec.hs @@ -63,7 +63,7 @@ econst = const . return -- terminal -- -- For detailed instruction on editing the key binding see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . newtype DirExec = DirExec String diff --git a/XMonad/Prompt/Email.hs b/XMonad/Prompt/Email.hs index a6ea82b8..9455c40c 100644 --- a/XMonad/Prompt/Email.hs +++ b/XMonad/Prompt/Email.hs @@ -50,7 +50,7 @@ import XMonad.Prompt.Input -- characters and then hit \'tab\'. -- -- For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Prompt the user for a recipient, subject, and body, and send an diff --git a/XMonad/Prompt/FuzzyMatch.hs b/XMonad/Prompt/FuzzyMatch.hs index d70e6b74..685623b6 100644 --- a/XMonad/Prompt/FuzzyMatch.hs +++ b/XMonad/Prompt/FuzzyMatch.hs @@ -63,7 +63,7 @@ import qualified Data.List.NonEmpty as NE -- > , ((modm .|. shiftMask, xK_g), windowPrompt myXPConfig Goto allWindows) -- -- For detailed instructions on editing the key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- | Returns True if the first argument is a subsequence of the second argument, -- that is, it can be obtained from the second sequence by deleting elements. diff --git a/XMonad/Prompt/Input.hs b/XMonad/Prompt/Input.hs index 6a34067c..95450357 100644 --- a/XMonad/Prompt/Input.hs +++ b/XMonad/Prompt/Input.hs @@ -70,7 +70,7 @@ import XMonad.Prompt -- invoked. -- -- (For detailed instructions on editing your key bindings, see --- "XMonad.Doc.Extending#Editing_key_bindings".) +-- .) -- -- "XMonad.Prompt.Input" is also intended to ease the process of -- developing other modules which require user input. For an example diff --git a/XMonad/Prompt/Layout.hs b/XMonad/Prompt/Layout.hs index 7c600891..79c12989 100644 --- a/XMonad/Prompt/Layout.hs +++ b/XMonad/Prompt/Layout.hs @@ -34,7 +34,7 @@ import XMonad.StackSet ( workspaces, layout ) -- > , ((modm .|. shiftMask, xK_m ), layoutPrompt def) -- -- For detailed instruction on editing the key binding see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- -- WARNING: This prompt won't display all possible layouts, because the -- code to enable this was rejected from xmonad core. It only displays diff --git a/XMonad/Prompt/Man.hs b/XMonad/Prompt/Man.hs index 6b832a23..9edce57a 100644 --- a/XMonad/Prompt/Man.hs +++ b/XMonad/Prompt/Man.hs @@ -49,7 +49,7 @@ import qualified Control.Exception as E -- > , ((modm, xK_F1), manPrompt def) -- -- For detailed instruction on editing the key binding see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . data Man = Man diff --git a/XMonad/Prompt/Pass.hs b/XMonad/Prompt/Pass.hs index e6dab2ae..0c4734cc 100644 --- a/XMonad/Prompt/Pass.hs +++ b/XMonad/Prompt/Pass.hs @@ -113,7 +113,7 @@ import XMonad.Util.Run (runProcessWithInput) -- -- For detailed instructions on: -- --- - editing your key bindings, see "XMonad.Doc.Extending#Editing_key_bindings". +-- - editing your key bindings, see . -- -- - how to setup the password store, see -- or @man 1 pass@. diff --git a/XMonad/Prompt/RunOrRaise.hs b/XMonad/Prompt/RunOrRaise.hs index f4c1e85a..9618d2b2 100644 --- a/XMonad/Prompt/RunOrRaise.hs +++ b/XMonad/Prompt/RunOrRaise.hs @@ -45,7 +45,8 @@ econst = const . return > , ((modm .|. controlMask, xK_x), runOrRaisePrompt def) For detailed instruction on editing the key binding see -"XMonad.Doc.Extending#Editing_key_bindings". -} +. +-} data RunOrRaisePrompt = RRP instance XPrompt RunOrRaisePrompt where diff --git a/XMonad/Prompt/Shell.hs b/XMonad/Prompt/Shell.hs index 39ce2d47..000babbf 100644 --- a/XMonad/Prompt/Shell.hs +++ b/XMonad/Prompt/Shell.hs @@ -62,7 +62,8 @@ econst = const . return > , ((modm .|. controlMask, xK_x), shellPrompt def) For detailed instruction on editing the key binding see -"XMonad.Doc.Extending#Editing_key_bindings". -} +. +-} data Shell = Shell type Predicate = String -> String -> Bool diff --git a/XMonad/Prompt/Ssh.hs b/XMonad/Prompt/Ssh.hs index d4bffdb5..291d60a6 100644 --- a/XMonad/Prompt/Ssh.hs +++ b/XMonad/Prompt/Ssh.hs @@ -46,7 +46,7 @@ econst = const . return -- disable the "HashKnownHosts" option in your ssh_config -- -- For detailed instruction on editing the key binding see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . data Ssh = Ssh diff --git a/XMonad/Prompt/Theme.hs b/XMonad/Prompt/Theme.hs index 2794eafd..92efacd0 100644 --- a/XMonad/Prompt/Theme.hs +++ b/XMonad/Prompt/Theme.hs @@ -39,7 +39,7 @@ import XMonad.Util.Themes -- > , ((modm .|. controlMask, xK_t), themePrompt def) -- -- For detailed instruction on editing the key binding see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . data ThemePrompt = ThemePrompt diff --git a/XMonad/Prompt/Window.hs b/XMonad/Prompt/Window.hs index 2d7d59d5..fa0678b6 100644 --- a/XMonad/Prompt/Window.hs +++ b/XMonad/Prompt/Window.hs @@ -65,7 +65,7 @@ import XMonad.Util.NamedWindows -- keystrokes to the selected client. -- -- For detailed instruction on editing the key binding see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . -- Describe actions that can applied on the selected window data WindowPrompt = Goto | Bring | BringCopy | BringToMaster | WithWindow String (Window -> X()) diff --git a/XMonad/Prompt/Workspace.hs b/XMonad/Prompt/Workspace.hs index 30fd92cd..3e03c6de 100644 --- a/XMonad/Prompt/Workspace.hs +++ b/XMonad/Prompt/Workspace.hs @@ -36,7 +36,7 @@ import XMonad.Util.WorkspaceCompare ( getSortByIndex ) -- > , ((modm .|. shiftMask, xK_m ), workspacePrompt def (windows . W.shift)) -- -- For detailed instruction on editing the key binding see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . newtype Wor = Wor String diff --git a/XMonad/Prompt/XMonad.hs b/XMonad/Prompt/XMonad.hs index dcccade6..7b0a907e 100644 --- a/XMonad/Prompt/XMonad.hs +++ b/XMonad/Prompt/XMonad.hs @@ -38,7 +38,7 @@ import XMonad.Prelude (fromMaybe) -- > , ((modm .|. controlMask, xK_x), xmonadPrompt def) -- -- For detailed instruction on editing the key binding see --- "XMonad.Doc.Extending#Editing_key_bindings". +-- . newtype XMonad = XMonad String diff --git a/XMonad/Prompt/Zsh.hs b/XMonad/Prompt/Zsh.hs index e7b0ce5c..5f65c0a0 100644 --- a/XMonad/Prompt/Zsh.hs +++ b/XMonad/Prompt/Zsh.hs @@ -38,7 +38,7 @@ import XMonad.Util.Run > , ((modm .|. controlMask, xK_x), zshPrompt def "/path/to/capture.zsh") For detailed instruction on editing the key binding see -"XMonad.Doc.Extending#Editing_key_bindings". -} +. -} data Zsh = Zsh diff --git a/XMonad/Util/ExclusiveScratchpads.hs b/XMonad/Util/ExclusiveScratchpads.hs index 7e91aa7b..d38c2cea 100644 --- a/XMonad/Util/ExclusiveScratchpads.hs +++ b/XMonad/Util/ExclusiveScratchpads.hs @@ -71,11 +71,12 @@ import qualified XMonad.StackSet as W -- -- > scratchpads = exclusiveSps ++ regularSps -- --- Add the hooks to your managehook (see "XMonad.Doc.Extending#Editing_the_manage_hook"), eg.: +-- Add the hooks to your managehook (see "XMonad.Doc.Extending#Editing_the_manage_hook" or +-- ); e.g., -- -- > manageHook = myManageHook <> xScratchpadsManageHook scratchpads -- --- And finally add some keybindings (see "XMonad.Doc.Extending#Editing_key_bindings"): +-- And finally add some keybindings (see ): -- -- > , ((modMask, xK_h), scratchpadAction scratchpads "htop") -- > , ((modMask, xK_c), scratchpadAction scratchpads "xclock") diff --git a/XMonad/Util/NamedScratchpad.hs b/XMonad/Util/NamedScratchpad.hs index b78ea9ea..dd1304fb 100644 --- a/XMonad/Util/NamedScratchpad.hs +++ b/XMonad/Util/NamedScratchpad.hs @@ -101,7 +101,7 @@ import qualified XMonad.Util.ExtensibleState as XS -- > , manageHook = namedScratchpadManageHook scratchpads -- -- For detailed instruction on editing the key binding see --- "XMonad.Doc.Extending#Editing_key_bindings" +-- -- -- For some applications (like displaying your workspaces in a status bar) it -- is convenient to filter out the @NSP@ workspace when looking at all