Safe Haskell	Safe-Inferred
Language	Haskell2010

Org.Parser.Objects

Contents

Sets of markup
Marked parsers
General purpose parsers
Objects
Auxiliary

Description

Parsers for Org objects.

Synopsis

minimalSet :: Marked OrgParser OrgObjects
standardSet :: Marked OrgParser OrgObjects
data Marked m a = Marked {
- getMarks :: String
- getParser :: m a
}
markupContext :: Monoid k => (Text -> k) -> Marked OrgParser k -> OrgParser k
plainMarkupContext :: Marked OrgParser OrgObjects -> OrgParser OrgObjects
markup :: (OrgObjects -> OrgObjects) -> Char -> Marked OrgParser OrgObjects
rawMarkup :: (Text -> OrgObjects) -> Char -> Marked OrgParser OrgObjects
code :: Marked OrgParser OrgObjects
verbatim :: Marked OrgParser OrgObjects
italic :: Marked OrgParser OrgObjects
underline :: Marked OrgParser OrgObjects
bold :: Marked OrgParser OrgObjects
strikethrough :: Marked OrgParser OrgObjects
singleQuoted :: Marked OrgParser OrgObjects
doubleQuoted :: Marked OrgParser OrgObjects
entity :: Marked OrgParser OrgObjects
latexFragment :: Marked OrgParser OrgObjects
texMathFragment :: Marked OrgParser OrgObjects
exportSnippet :: Marked OrgParser OrgObjects
citation :: Marked OrgParser OrgObjects
inlBabel :: Marked OrgParser OrgObjects
inlSrc :: Marked OrgParser OrgObjects
linebreak :: Marked OrgParser OrgObjects
angleLink :: Marked OrgParser OrgObjects
regularLink :: Marked OrgParser OrgObjects
target :: Marked OrgParser OrgObjects
suscript :: Marked OrgParser OrgObjects
macro :: Marked OrgParser OrgObjects
footnoteReference :: Marked OrgParser OrgObjects
timestamp :: Marked OrgParser OrgObjects
statisticCookie :: Marked OrgParser OrgObjects
linkToTarget :: Text -> LinkTarget
parseTimestamp :: OrgParser TimestampData

Sets of markup

minimalSet :: Marked OrgParser OrgObjects Source #

standardSet :: Marked OrgParser OrgObjects Source #

Marked parsers

data Marked m a Source #

Constructors

Marked
Fields getMarks :: String getParser :: m a

Instances

Instances details

Functor m => Functor (Marked m) Source #
Instance details Defined in Org.Parser.Definitions Methods fmap :: (a -> b) -> Marked m a -> Marked m b Source # (<$) :: a -> Marked m b -> Marked m a Source #
Alternative m => Monoid (Marked m a) Source #
Instance details Defined in Org.Parser.Definitions Methods mempty :: Marked m a Source # mappend :: Marked m a -> Marked m a -> Marked m a Source # mconcat :: [Marked m a] -> Marked m a Source #
Alternative m => Semigroup (Marked m a) Source #
Instance details Defined in Org.Parser.Definitions Methods (<>) :: Marked m a -> Marked m a -> Marked m a Source # sconcat :: NonEmpty (Marked m a) -> Marked m a Source # stimes :: Integral b => b -> Marked m a -> Marked m a Source #

markupContext :: Monoid k => (Text -> k) -> Marked OrgParser k -> OrgParser k Source #

Parse inside a "context": text that is not captured by the parser elems gets converted to the type k via the function f.

plainMarkupContext :: Marked OrgParser OrgObjects -> OrgParser OrgObjects Source #

Parse inside a "plain context", i.e., plain text not matched by any parsers gets converted to Plain objects.

plainMarkupContext = markupContext plain

General purpose parsers

markup :: (OrgObjects -> OrgObjects) -> Char -> Marked OrgParser OrgObjects Source #

rawMarkup :: (Text -> OrgObjects) -> Char -> Marked OrgParser OrgObjects Source #

Objects

code :: Marked OrgParser OrgObjects Source #

Parse a code object.

verbatim :: Marked OrgParser OrgObjects Source #

Parse a verbatim object.

italic :: Marked OrgParser OrgObjects Source #

Parse an italic object.

underline :: Marked OrgParser OrgObjects Source #

Parse an underline object.

bold :: Marked OrgParser OrgObjects Source #

Parse a bold object.

strikethrough :: Marked OrgParser OrgObjects Source #

Parse a strikethrough object.

singleQuoted :: Marked OrgParser OrgObjects Source #

Parse a single-quoted object.

doubleQuoted :: Marked OrgParser OrgObjects Source #

Parse a double-quoted object.

entity :: Marked OrgParser OrgObjects Source #

Parse an entity object.

latexFragment :: Marked OrgParser OrgObjects Source #

Parse a LaTeX fragment object.

texMathFragment :: Marked OrgParser OrgObjects Source #

Parse a TeX math fragment object.

exportSnippet :: Marked OrgParser OrgObjects Source #

Parse an export snippet object.

citation :: Marked OrgParser OrgObjects Source #

Parse a citation object.

inlBabel :: Marked OrgParser OrgObjects Source #

Parse an inline babel call object.

inlSrc :: Marked OrgParser OrgObjects Source #

Parse an inline source object.

linebreak :: Marked OrgParser OrgObjects Source #

Parse a linebreak object.

angleLink :: Marked OrgParser OrgObjects Source #

Parse a angle link object.

regularLink :: Marked OrgParser OrgObjects Source #

Parse a regular link object.

target :: Marked OrgParser OrgObjects Source #

Parse a target object.

suscript :: Marked OrgParser OrgObjects Source #

Parse a subscript or a superscript object.

macro :: Marked OrgParser OrgObjects Source #

Parse a macro object.

footnoteReference :: Marked OrgParser OrgObjects Source #

Parse a footnote reference object.

timestamp :: Marked OrgParser OrgObjects Source #

Parse a timestamp object.

statisticCookie :: Marked OrgParser OrgObjects Source #

Parse a statistic cookie object.

Auxiliary

linkToTarget :: Text -> LinkTarget Source #

Transform the link text into a link target.

parseTimestamp :: OrgParser TimestampData Source #

Parse a timestamp.