From 2529d847a140a62f8091d0c6eb43a1c0bbfd02ff Mon Sep 17 00:00:00 2001
From: Andrea Rossato <andrea.rossato@unibz.it>
Date: Fri, 23 Nov 2007 15:13:04 +0100
Subject: Maximize: haddock fixes

darcs-hash:20071123141304-32816-2c42769b2fb37a285f770c637ef3e527121fbec6.gz
---
 XMonad/Layout/Maximize.hs | 25 ++++++++++++++++---------
 1 file changed, 16 insertions(+), 9 deletions(-)

(limited to 'XMonad/Layout/Maximize.hs')

diff --git a/XMonad/Layout/Maximize.hs b/XMonad/Layout/Maximize.hs
index cf1e938..a968a3a 100644
--- a/XMonad/Layout/Maximize.hs
+++ b/XMonad/Layout/Maximize.hs
@@ -29,20 +29,27 @@ import XMonad.Layout.LayoutModifier
 import Data.List ( partition )
 
 -- $usage
--- You can use this module with the following in your Config.hs file:
+-- You can use this module with the following in your @~\/.xmonad\/xmonad.hs@:
 --
 -- > import XMonad.Layout.Maximize
 --
--- > layouts = ...
--- >                  , Layout $ maximize $ tiled ...
--- >                  ...
+-- Then edit your @layoutHook@ by adding the Maximize layout modifier:
 --
--- > keys = ...
--- >        , ((modMask, xK_backslash), withFocused (sendMessage . maximizeRestore))
+-- > myLayouts = maximize (Tall 1 (3/100) (1/2)) ||| Full ||| etc..
+-- > main = xmonad dafaultConfig { layoutHook = myLayouts }
+--
+-- For more detailed instructions on editing the layoutHook see:
+--
+-- "XMonad.Doc.Extending#Editing_the_layout_hook"
+--
+-- In the key-bindings, do something like:
+--
+-- >        , ((modMask x, xK_backslash), withFocused (sendMessage . maximizeRestore))
 -- >        ...
-
--- %import XMonad.Layout.Maximize
--- %layout , Layout $ maximize $ tiled
+--
+-- For detailed instruction on editing the key binding see:
+--
+-- "XMonad.Doc.Extending#Editing_key_bindings".
 
 data Maximize a = Maximize (Maybe Window) deriving ( Read, Show )
 maximize :: LayoutClass l Window => l Window -> ModifiedLayout Maximize l Window
-- 
cgit v1.2.3