Swarm.Doc.Wiki.Cheatsheet

Auto-generation of cheat sheets for the wiki.

Documentation

data PageAddress

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

Show PageAddress

Defined in Swarm.Doc.Wiki.Cheatsheet

Methods

showsPrec :: Int -> PageAddress -> ShowS

show :: PageAddress -> String

showList :: [PageAddress] -> ShowS

Eq PageAddress

Defined in Swarm.Doc.Wiki.Cheatsheet

Methods

(==) :: PageAddress -> PageAddress -> Bool

(/=) :: PageAddress -> PageAddress -> Bool

data SheetType

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

Constructors

Entities

Terrain

Commands

CommandMatrix

Capabilities

Recipes

Scenario

Instances

Bounded SheetType

Defined in Swarm.Doc.Wiki.Cheatsheet

Methods

minBound :: SheetType

maxBound :: SheetType

Enum SheetType

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

Defined in Swarm.Doc.Wiki.Cheatsheet

Methods

showsPrec :: Int -> SheetType -> ShowS

show :: SheetType -> String

showList :: [SheetType] -> ShowS

Eq SheetType

Defined in Swarm.Doc.Wiki.Cheatsheet

Methods

(==) :: SheetType -> SheetType -> Bool

(/=) :: SheetType -> SheetType -> Bool

makeWikiPage :: PageAddress -> SheetType -> IO ()