gitit-0.12.0.1: Wiki using happstack, git or darcs, and pandoc.

Safe HaskellNone
LanguageHaskell98

Network.Gitit.Types

Description

Types for Gitit modules.

Synopsis

Documentation

data FileStoreType Source

Constructors

Git 
Darcs 
Mercurial 

Instances

data Config Source

Data structure for information read from config file.

Constructors

Config 

Fields

repositoryPath :: FilePath

Path of repository containing filestore

repositoryType :: FileStoreType

Type of repository

defaultPageType :: PageType

Default page markup type for this wiki

defaultExtension :: String

Default file extension for pages in this wiki

mathMethod :: MathMethod

How to handle LaTeX math in pages?

defaultLHS :: Bool

Treat as literate haskell by default?

showLHSBirdTracks :: Bool

Show Haskell code with bird tracks

withUser :: Handler -> Handler

Combinator to set REMOTE_USER request header

requireAuthentication :: AuthenticationLevel

Handler for login, logout, register, etc.

authHandler :: Handler

Specifies which actions require authentication.

userFile :: FilePath

Path of users database

sessionTimeout :: Int

Seconds of inactivity before session expires

templatesDir :: FilePath

Directory containing page templates

logFile :: FilePath

Path of server log file

logLevel :: Priority

Severity filter for log messages (DEBUG, INFO, NOTICE, WARNING, ERROR, CRITICAL, ALERT, EMERGENCY)

staticDir :: FilePath

Path of static directory

pluginModules :: [String]

Names of plugin modules to load

tableOfContents :: Bool

Show table of contents on each page?

maxUploadSize :: Integer

Max size of file uploads

maxPageSize :: Integer

Max size of page uploads

address :: String

IP address to bind to

portNumber :: Int

Port number to serve content on

debugMode :: Bool

Print debug info to the console?

frontPage :: String

The front page of the wiki

noEdit :: [String]

Pages that cannot be edited via web

noDelete :: [String]

Pages that cannot be deleted via web

defaultSummary :: String

Default summary if description left blank

accessQuestion :: Maybe (String, [String])

Nothing = anyone can register. Just (prompt, answers) = a user will be given the prompt and must give one of the answers to register.

useRecaptcha :: Bool

Use ReCAPTCHA for user registration.

recaptchaPublicKey :: String
 
recaptchaPrivateKey :: String
 
rpxDomain :: String

RPX domain and key

rpxKey :: String
 
compressResponses :: Bool

Should responses be compressed?

useCache :: Bool

Should responses be cached?

cacheDir :: FilePath

Directory to hold cached pages

mimeMap :: Map String String

Map associating mime types with file extensions

mailCommand :: String

Command to send notification emails

resetPasswordMessage :: String

Text of password reset email

markupHelp :: String

Markup syntax help for edit sidebar

useFeed :: Bool

Provide an atom feed?

baseUrl :: String

Base URL of wiki, for use in feed

useAbsoluteUrls :: Bool

Title of wiki, used in feed

wikiTitle :: String

Should WikiLinks be absolute w.r.t. the base URL?

feedDays :: Integer

Number of days history to be included in feed

feedRefreshTime :: Integer

Number of minutes to cache feeds before refreshing

pdfExport :: Bool

Allow PDF export?

pandocUserData :: Maybe FilePath

Directory to search for pandoc customizations

xssSanitize :: Bool

Filter HTML through xss-sanitize

recentActivityDays :: Int

The default number of days in the past to look for "recent" activity

githubAuth :: GithubConfig

Github client data for authentication (id, secret, callback, authorize endpoint, access token endpoint)

data Page Source

Data for rendering a wiki page.

Instances

data User Source

Constructors

User 

Instances

data Sessions a Source

Constructors

Sessions 

Fields

unsession :: Map SessionKey a
 

Instances

Eq a => Eq (Sessions a) 
Read a => Read (Sessions a) 
Show a => Show (Sessions a) 

data Password Source

Constructors

Password 

Fields

pSalt :: String
 
pHashed :: String
 

data GititState Source

Common state for all gitit wikis in an application.

data PageLayout Source

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

data Tab Source

Instances

data Command Source

Constructors

Command (Maybe String) 

data WikiState Source

State for a single wiki.

Constructors

WikiState