Swarm.Doc.Wiki.Cheatsheet

Description

Auto-generation of cheat sheets for the wiki.

Synopsis

Documentation

A configuration record holding the URLs of the various cheat sheets, to facilitate cross-linking.

Constructors

PageAddress
Fields entityAddress :: Text commandsAddress :: Text capabilityAddress :: Text recipesAddress :: Text

Instances details

Show PageAddress Source #
Instance details Defined in Swarm.Doc.Wiki.Cheatsheet Methods showsPrec :: Int -> PageAddress -> ShowS # show :: PageAddress -> String # showList :: [PageAddress] -> ShowS #
Eq PageAddress Source #
Instance details Defined in Swarm.Doc.Wiki.Cheatsheet Methods (==) :: PageAddress -> PageAddress -> Bool # (/=) :: PageAddress -> PageAddress -> Bool #

An enumeration of the kinds of cheat sheets we can produce.

Constructors

Instances details

Bounded SheetType Source #
Instance details Defined in Swarm.Doc.Wiki.Cheatsheet Methods minBound :: SheetType # maxBound :: SheetType #
Enum SheetType Source #
Instance details Defined in Swarm.Doc.Wiki.Cheatsheet Methods succ :: SheetType -> SheetType # pred :: SheetType -> SheetType # toEnum :: Int -> SheetType # fromEnum :: SheetType -> Int # enumFrom :: SheetType -> [SheetType] # enumFromThen :: SheetType -> SheetType -> [SheetType] # enumFromTo :: SheetType -> SheetType -> [SheetType] # enumFromThenTo :: SheetType -> SheetType -> SheetType -> [SheetType] #
Show SheetType Source #
Instance details Defined in Swarm.Doc.Wiki.Cheatsheet Methods showsPrec :: Int -> SheetType -> ShowS # show :: SheetType -> String # showList :: [SheetType] -> ShowS #
Eq SheetType Source #
Instance details Defined in Swarm.Doc.Wiki.Cheatsheet Methods (==) :: SheetType -> SheetType -> Bool # (/=) :: SheetType -> SheetType -> Bool #