gitit-0.13.0.0: Wiki using happstack, git or darcs, and pandoc.
Safe HaskellNone
LanguageHaskell2010

Network.Gitit.Types

Description

Types for Gitit modules.

Synopsis

Documentation

data PageType Source #

Instances

Instances details
Eq PageType Source # 
Instance details

Defined in Network.Gitit.Types

Methods

(==) :: PageType -> PageType -> Bool

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

Read PageType Source # 
Instance details

Defined in Network.Gitit.Types

Methods

readsPrec :: Int -> ReadS PageType

readList :: ReadS [PageType]

readPrec :: ReadPrec PageType

readListPrec :: ReadPrec [PageType]

Show PageType Source # 
Instance details

Defined in Network.Gitit.Types

Methods

showsPrec :: Int -> PageType -> ShowS

show :: PageType -> String

showList :: [PageType] -> ShowS

data FileStoreType Source #

Constructors

Git 
Darcs 
Mercurial 

Instances

Instances details
Show FileStoreType Source # 
Instance details

Defined in Network.Gitit.Types

Methods

showsPrec :: Int -> FileStoreType -> ShowS

show :: FileStoreType -> String

showList :: [FileStoreType] -> ShowS

data MathMethod Source #

Constructors

MathML 
WebTeX String 
RawTeX 
MathJax String 

Instances

Instances details
Eq MathMethod Source # 
Instance details

Defined in Network.Gitit.Types

Methods

(==) :: MathMethod -> MathMethod -> Bool

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

Read MathMethod Source # 
Instance details

Defined in Network.Gitit.Types

Methods

readsPrec :: Int -> ReadS MathMethod

readList :: ReadS [MathMethod]

readPrec :: ReadPrec MathMethod

readListPrec :: ReadPrec [MathMethod]

Show MathMethod Source # 
Instance details

Defined in Network.Gitit.Types

Methods

showsPrec :: Int -> MathMethod -> ShowS

show :: MathMethod -> String

showList :: [MathMethod] -> ShowS

data Config Source #

Data structure for information read from config file.

Constructors

Config 

Fields

data Page Source #

Data for rendering a wiki page.

Constructors

Page 

Fields

Instances

Instances details
Read Page Source # 
Instance details

Defined in Network.Gitit.Types

Methods

readsPrec :: Int -> ReadS Page

readList :: ReadS [Page]

readPrec :: ReadPrec Page

readListPrec :: ReadPrec [Page]

Show Page Source # 
Instance details

Defined in Network.Gitit.Types

Methods

showsPrec :: Int -> Page -> ShowS

show :: Page -> String

showList :: [Page] -> ShowS

type SessionKey = Integer Source #

data SessionData Source #

Instances

Instances details
Eq SessionData Source # 
Instance details

Defined in Network.Gitit.Types

Methods

(==) :: SessionData -> SessionData -> Bool

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

Read SessionData Source # 
Instance details

Defined in Network.Gitit.Types

Methods

readsPrec :: Int -> ReadS SessionData

readList :: ReadS [SessionData]

readPrec :: ReadPrec SessionData

readListPrec :: ReadPrec [SessionData]

Show SessionData Source # 
Instance details

Defined in Network.Gitit.Types

Methods

showsPrec :: Int -> SessionData -> ShowS

show :: SessionData -> String

showList :: [SessionData] -> ShowS

data SessionGithubData Source #

Instances

Instances details
Eq SessionGithubData Source # 
Instance details

Defined in Network.Gitit.Types

Read SessionGithubData Source # 
Instance details

Defined in Network.Gitit.Types

Show SessionGithubData Source # 
Instance details

Defined in Network.Gitit.Types

Methods

showsPrec :: Int -> SessionGithubData -> ShowS

show :: SessionGithubData -> String

showList :: [SessionGithubData] -> ShowS

sessionUser :: SessionData -> Maybe String Source #

data User Source #

Constructors

User 

Fields

Instances

Instances details
Read User Source # 
Instance details

Defined in Network.Gitit.Types

Methods

readsPrec :: Int -> ReadS User

readList :: ReadS [User]

readPrec :: ReadPrec User

readListPrec :: ReadPrec [User]

Show User Source # 
Instance details

Defined in Network.Gitit.Types

Methods

showsPrec :: Int -> User -> ShowS

show :: User -> String

showList :: [User] -> ShowS

data Sessions a Source #

Constructors

Sessions 

Fields

Instances

Instances details
Eq a => Eq (Sessions a) Source # 
Instance details

Defined in Network.Gitit.Types

Methods

(==) :: Sessions a -> Sessions a -> Bool

(/=) :: Sessions a -> Sessions a -> Bool

Read a => Read (Sessions a) Source # 
Instance details

Defined in Network.Gitit.Types

Methods

readsPrec :: Int -> ReadS (Sessions a)

readList :: ReadS [Sessions a]

readPrec :: ReadPrec (Sessions a)

readListPrec :: ReadPrec [Sessions a]

Show a => Show (Sessions a) Source # 
Instance details

Defined in Network.Gitit.Types

Methods

showsPrec :: Int -> Sessions a -> ShowS

show :: Sessions a -> String

showList :: [Sessions a] -> ShowS

data Password Source #

Constructors

Password 

Fields

Instances

Instances details
Eq Password Source # 
Instance details

Defined in Network.Gitit.Types

Methods

(==) :: Password -> Password -> Bool

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

Read Password Source # 
Instance details

Defined in Network.Gitit.Types

Methods

readsPrec :: Int -> ReadS Password

readList :: ReadS [Password]

readPrec :: ReadPrec Password

readListPrec :: ReadPrec [Password]

Show Password Source # 
Instance details

Defined in Network.Gitit.Types

Methods

showsPrec :: Int -> Password -> ShowS

show :: Password -> String

showList :: [Password] -> ShowS

data GititState Source #

Common state for all gitit wikis in an application.

Constructors

GititState 

Fields

class Monad m => HasContext m Source #

Minimal complete definition

getContext, modifyContext

data Plugin Source #

Constructors

PageTransform (Pandoc -> PluginM Pandoc) 
PreParseTransform (String -> PluginM String) 
PreCommitTransform (String -> PluginM String) 

data PluginData Source #

Constructors

PluginData 

Fields

Instances

Instances details
HasContext PluginM Source # 
Instance details

Defined in Network.Gitit.Types

type PluginM = ReaderT PluginData (StateT Context IO) Source #

data Context Source #

Constructors

Context 

Fields

data PageLayout Source #

Abstract representation of page layout (tabs, scripts, etc.)

Constructors

PageLayout 

Fields

data Tab Source #

Instances

Instances details
Eq Tab Source # 
Instance details

Defined in Network.Gitit.Types

Methods

(==) :: Tab -> Tab -> Bool

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

Show Tab Source # 
Instance details

Defined in Network.Gitit.Types

Methods

showsPrec :: Int -> Tab -> ShowS

show :: Tab -> String

showList :: [Tab] -> ShowS

data Recaptcha Source #

Constructors

Recaptcha 

Fields

Instances

Instances details
Read Recaptcha Source # 
Instance details

Defined in Network.Gitit.Types

Methods

readsPrec :: Int -> ReadS Recaptcha

readList :: ReadS [Recaptcha]

readPrec :: ReadPrec Recaptcha

readListPrec :: ReadPrec [Recaptcha]

Show Recaptcha Source # 
Instance details

Defined in Network.Gitit.Types

Methods

showsPrec :: Int -> Recaptcha -> ShowS

show :: Recaptcha -> String

showList :: [Recaptcha] -> ShowS

data Params Source #

Constructors

Params 

Fields

Instances

Instances details
Show Params Source # 
Instance details

Defined in Network.Gitit.Types

Methods

showsPrec :: Int -> Params -> ShowS

show :: Params -> String

showList :: [Params] -> ShowS

FromData Params Source # 
Instance details

Defined in Network.Gitit.Types

Methods

fromData :: RqData Params

data Command Source #

Constructors

Command (Maybe String) 

Instances

Instances details
Show Command Source # 
Instance details

Defined in Network.Gitit.Types

Methods

showsPrec :: Int -> Command -> ShowS

show :: Command -> String

showList :: [Command] -> ShowS

FromData Command Source # 
Instance details

Defined in Network.Gitit.Types

Methods

fromData :: RqData Command

data WikiState Source #

State for a single wiki.

Constructors

WikiState 

Fields

type GititServerPart = ServerPartT (ReaderT WikiState IO) Source #

fromEntities :: String -> String Source #

org :: GithubConfig -> Maybe Text Source #

githubConfig :: OAuth2 -> Maybe Text -> GithubConfig Source #

Orphan instances

FromData SessionKey Source # 
Instance details

Methods

fromData :: RqData SessionKey

FromReqURI [String] Source # 
Instance details

Methods

fromReqURI :: String -> Maybe [String]