Text.SmallCaps.Config

This module specifies the default configuration values for SmallCaps.

Parser user state

data ParserState

Constructors

ParserState

Fields

• config :: Config

  configuration

• inputs :: Map FilePath (FilePath, LaTeX)

  additional input files

• profile :: Profile

  configuration preset list

• stop :: StopState

  stop state

• ignore :: Bool

  skip on/off

Instances

Default ParserState

Defined in Text.SmallCaps.Config

Methods

def :: ParserState

defaultProfile :: Map Text Config

Configuration data type

data Config

Constructors

Config

Fields

• periodChars :: [Char]

  signs recognised as periods

• search :: LaTeXElement -> Bool

  search blockmacroenvironment for caps

• isolate :: LaTeXElement -> Maybe Text

  open an isolated state for a blockmacroenvironment; returns config name

• skip :: LaTeXElement -> Bool

  skip searching for the rest of the block etc.

• unskip :: LaTeXElement -> Bool

  undo skip, e.g., at normalsize when skipping small

• eos :: LaTeXElement -> Bool

  end of sentence, start with new one

• replace :: StopState -> Text -> Text

  formatting for small caps

• replaceFilter :: Text -> Bool

  filter for small caps candidates (e.g., for assuring a certain minimum length)

• exceptions :: [PatternReplace]

  search for patterns in printables and replace them (no further processing)

• inlineConfig :: Bool

  dynamic reconfiguration in LaTeX comments

Instances

Default Config

Defined in Text.SmallCaps.Config

Methods

def :: Config

defaultPeriodChars :: [Char]

defaultSearch :: LaTeXElement -> Bool

defaultIsolate :: LaTeXElement -> Maybe Text

defaultSkip :: LaTeXElement -> Bool

defaultUnskip :: LaTeXElement -> Bool

defaultEos :: LaTeXElement -> Bool

defaultReplace :: StopState -> Text -> Text

defaultReplaceTemplate :: Text -> StopState -> Text -> Text

defaultReplaceTemplate' :: Text -> StopState -> Text -> Text

defaultNewSentence :: (Text -> Text) -> StopState -> Text -> Text

defaultReplaceFilter :: Text -> Bool

defaultExceptions :: [PatternReplace]

Configuration presets

(&&&) :: (LaTeXElement -> Bool) -> (LaTeXElement -> Bool) -> LaTeXElement -> Bool

combinator for plugin construction

(|||) :: (LaTeXElement -> Bool) -> (LaTeXElement -> Bool) -> LaTeXElement -> Bool

clean :: Config

clean configuration, all substitutions off

conservative :: Config

conservative configuration

busy :: Config

busy configuration

small :: Config

abstract/small font configuration

footnote :: Config

footnote font configuration

whitelist :: [String] -> LaTeXElement -> Bool

blacklist :: [String] -> LaTeXElement -> Bool

after :: [String] -> LaTeXElement -> Bool

isolateWith :: [(String, String)] -> LaTeXElement -> Maybe Text

findConfigName :: Text -> [(String, String)] -> Maybe Text

Profile data type

type Profile = Map Text Config

Subparser data type

type SubParser a = ParserState -> a -> Either String (a, ParserState)

Stop state

data StopState

Constructors

None

within a sentence

NewLine

one newline read

Stop

stop character read

NewSentence

begin of a new sentence

Instances

Eq StopState

Defined in Text.SmallCaps.Config

Methods

(==) :: StopState -> StopState -> Bool

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

Show StopState

Defined in Text.SmallCaps.Config

Methods

showsPrec :: Int -> StopState -> ShowS

show :: StopState -> String

showList :: [StopState] -> ShowS

Default StopState

Defined in Text.SmallCaps.Config

Methods

def :: StopState

newSentence :: (Text -> Text) -> (Text -> Text) -> StopState -> Text -> Text

Pattern search and replace (exceptions from processing)

data PatternReplace

Constructors

PatternReplace

Fields

• pattern :: Text
• replacement :: Text