smallcaps-0.6.0.2: Flatten camel case text in LaTeX files

Copyright(c) Stefan Berthold 2014-2015
LicenseBSD3-style (see LICENSE)
Maintainerstefan.berthold@gmx.net
Stabilityunstable
PortabilityGHC
Safe HaskellNone
LanguageHaskell2010

Text.SmallCaps.Config

Contents

Description

This module specifies the default configuration values for SmallCaps.

Synopsis

Parser user state

data ParserState Source

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

defaultProfile :: Map Text Config Source

Configuration data type

data Config Source

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

defaultPeriodChars :: [Char] Source

defaultSearch :: LaTeXElement -> Bool Source

defaultIsolate :: LaTeXElement -> Maybe Text Source

defaultSkip :: LaTeXElement -> Bool Source

defaultUnskip :: LaTeXElement -> Bool Source

defaultEos :: LaTeXElement -> Bool Source

defaultReplace :: StopState -> Text -> Text Source

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

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

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

defaultReplaceFilter :: Text -> Bool Source

defaultExceptions :: [PatternReplace] Source

Configuration presets

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

combinator for plugin construction

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

clean :: Config Source

clean configuration, all substitutions off

conservative :: Config Source

conservative configuration

busy :: Config Source

busy configuration

small :: Config Source

abstract/small font configuration

footnote :: Config Source

footnote font configuration

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

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

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

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

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

Profile data type

type Profile = Map Text Config Source

Subparser data type

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

Stop state

data StopState Source

Constructors

None

within a sentence

NewLine

one newline read

Stop

stop character read

NewSentence

begin of a new sentence

Instances

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

Pattern search and replace (exceptions from processing)

data PatternReplace Source

Constructors

PatternReplace 

Fields

pattern :: Text
 
replacement :: Text