Skip to content

Improve Layout Documentation, Add Screenshots #160

@pjones

Description

@pjones

Problem Description

We need to audit all of the layout modules and improve their documentation. Many don't even say what they do or are very confusing. It would also be nice to take a screenshot of each layout and include it in the xmonad wiki with a link to the screenshot in the module documentation.

What to do?

  1. Add a bullet item to the layouts wiki page
  2. List the name of the layout and its description
  3. Add the layout to your xmonad configuration (or to xmonad-testing), load up some impressive looking windows, and take a screenshot.
  4. Check the layout off the list in this issue

Module Checklist

  • Accordion.hs
  • AutoMaster.hs
  • AvoidFloats.hs
  • BinaryColumn.hs
  • BinarySpacePartition.hs
  • BorderResize.hs
  • BoringWindows.hs
  • ButtonDecoration.hs
  • CenteredMaster.hs
  • Circle.hs
  • Column.hs
  • Combo.hs
  • ComboP.hs
  • Cross.hs
  • Decoration.hs
  • DecorationAddons.hs
  • DecorationMadness.hs
  • Dishes.hs
  • MultiDishes.hs
  • DragPane.hs
  • DraggingVisualizer.hs
  • Drawer.hs
  • Dwindle.hs
  • DwmStyle.hs
  • FixedColumn.hs
  • Fullscreen.hs
  • Gaps.hs
  • Grid.hs
  • GridVariants.hs
  • Groups.hs
  • Groups.Examples.hs
  • Groups.Helpers.hs
  • Groups.Wmii.hs
  • Hidden.hs
  • HintedGrid.hs
  • HintedTile.hs
  • IM.hs
  • IfMax.hs
  • ImageButtonDecoration.hs
  • IndependentScreens.hs
  • LayoutBuilder.hs
  • LayoutBuilderP.hs
  • LayoutCombinators.hs
  • LayoutHints.hs
  • LayoutModifier.hs
  • LayoutScreens.hs
  • LimitWindows.hs
  • MagicFocus.hs
  • Magnifier.hs
  • Master.hs
  • Maximize.hs
  • MessageControl.hs
  • Minimize.hs
  • Monitor.hs
  • Mosaic.hs
  • MosaicAlt.hs
  • MouseResizableTile.hs
  • MultiColumns.hs
  • MultiToggle.hs
  • MultiToggle.Instances.hs
  • MultiToggle.TabBarDecoration.hs
  • Named.hs
  • NoBorders.hs
  • NoFrillsDecoration.hs
  • OnHost.hs
  • OneBig.hs
  • PerScreen.hs
  • PerWorkspace.hs
  • PositionStoreFloat.hs
  • Reflect.hs
  • Renamed.hs
  • ResizableTile.hs
  • ResizableThreeColumns.hs
  • ResizeScreen.hs
  • Roledex.hs
  • ShowWName.hs
  • SimpleDecoration.hs
  • SimpleFloat.hs
  • Simplest.hs
  • SimplestFloat.hs
  • SortedLayout.hs
  • Spacing.hs
  • Spiral.hs
  • Square.hs
  • StackTile.hs
  • StateFull.hs
  • Stoppable.hs
  • SubLayouts.hs
  • TabBarDecoration.hs
  • Tabbed.hs
  • TallMastersCombo.hs
  • ThreeColumns.hs
  • ToggleLayouts.hs
  • TrackFloating.hs
  • TwoPane.hs
  • TwoPanePersistent.hs
  • VoidBorders.hs
  • WindowArranger.hs
  • WindowNavigation.hs
  • WindowSwitcherDecoration.hs
  • WorkspaceDir.hs
  • ZoomRow.hs

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Todo

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions