pandoc-2.10.1: Conversion between markup formats

CopyrightCopyright (C) 2006-2020 John MacFarlane
LicenseGNU GPL, version 2 or above
MaintainerJohn MacFarlane <>
Safe HaskellNone




Utility functions and definitions used by the various Pandoc modules.


List processing

splitBy :: (a -> Bool) -> [a] -> [[a]] Source #

Split list by groups of one or more sep.

splitByIndices :: [Int] -> [a] -> [[a]] Source #

splitStringByIndices :: [Int] -> [Char] -> [[Char]] Source #

Split string into chunks divided at specified indices.

substitute :: Eq a => [a] -> [a] -> [a] -> [a] Source #

Replace each occurrence of one sublist in a list with another.

ordNub :: Ord a => [a] -> [a] Source #

findM :: forall m t a. (Monad m, Foldable t) => (a -> m Bool) -> t a -> m (Maybe a) Source #

Text processing

class ToString a where Source #


toString :: a -> String Source #

ToString String Source # 
Instance details

Defined in Text.Pandoc.Shared

ToString Text Source # 
Instance details

Defined in Text.Pandoc.Shared


toString :: Text -> String Source #

class ToText a where Source #


toText :: a -> Text Source #

ToText String Source # 
Instance details

Defined in Text.Pandoc.Shared


toText :: String -> Text Source #

ToText Text Source # 
Instance details

Defined in Text.Pandoc.Shared


toText :: Text -> Text Source #

tshow :: Show a => a -> Text Source #

backslashEscapes Source #


:: [Char]

list of special characters to escape

-> [(Char, Text)] 

Returns an association list of backslash escapes for the designated characters.

escapeStringUsing :: [(Char, Text)] -> Text -> Text Source #

Escape a string of characters, using an association list of characters and strings.

elemText :: Char -> Text -> Bool Source #

True exactly when the Char appears in the Text.

notElemText :: Char -> Text -> Bool Source #

True exactly when the Char does not appear in the Text.

stripTrailingNewlines :: Text -> Text Source #

Strip trailing newlines from string.

trim :: Text -> Text Source #

Remove leading and trailing space (including newlines) from string.

triml :: Text -> Text Source #

Remove leading space (including newlines) from string.

trimr :: Text -> Text Source #

Remove trailing space (including newlines) from string.

trimMath :: Text -> Text Source #

Trim leading space and trailing space unless after .

stripFirstAndLast :: Text -> Text Source #

Strip leading and trailing characters from string

camelCaseToHyphenated :: Text -> Text Source #

Change CamelCase word to hyphenated lowercase (e.g., camel-case).

toRomanNumeral :: Int -> Text Source #

Convert number < 4000 to uppercase roman numeral.

escapeURI :: Text -> Text Source #

Escape whitespace and some punctuation characters in URI.

tabFilter Source #


:: Int

Tab stop

-> Text


-> Text 

Convert tabs to spaces. Tabs will be preserved if tab stop is set to 0.

crFilter :: Text -> Text Source #

Strip out DOS line endings.


normalizeDate :: Text -> Maybe Text Source #

Parse a date and convert (if possible) to "YYYY-MM-DD" format. We limit years to the range 1601-9999 (ISO 8601 accepts greater than or equal to 1583, but MS Word only accepts dates starting 1601).

Pandoc block and inline list processing

orderedListMarkers :: (Int, ListNumberStyle, ListNumberDelim) -> [Text] Source #

Generate infinite lazy list of markers for an ordered list, depending on list attributes.

extractSpaces :: (Inlines -> Inlines) -> Inlines -> Inlines Source #

Extract the leading and trailing spaces from inside an inline element and place them outside the element. SoftBreaks count as Spaces for these purposes.

removeFormatting :: Walkable Inline a => a -> [Inline] Source #

Extract inlines, removing formatting.

stringify :: Walkable Inline a => a -> Text Source #

Convert pandoc structure to a string with formatting removed. Footnotes are skipped (since we don't want their contents in link labels).

capitalize :: Walkable Inline a => a -> a Source #

Bring all regular text in a pandoc structure to uppercase.

This function correctly handles cases where a lowercase character doesn't match to a single uppercase character – e.g. “Straße” would be converted to “STRASSE”, not “STRAßE”.

compactify Source #


:: [Blocks]

List of list items (each a list of blocks)

-> [Blocks] 

Change final list item from Para to Plain if the list contains no other Para blocks. Otherwise (if the list items contain Para blocks besides possibly at the end), turn any Plains into Paras (#5285).

compactifyDL :: [(Inlines, [Blocks])] -> [(Inlines, [Blocks])] Source #

Like compactify, but acts on items of definition lists.

linesToPara :: [[Inline]] -> Block Source #

Convert a list of lines into a paragraph with hard line breaks. This is useful e.g. for rudimentary support of LineBlock elements in writers.

makeSections :: Bool -> Maybe Int -> [Block] -> [Block] Source #

Put a list of Pandoc blocks into a hierarchical structure: a list of sections (each a Div with class "section" and first element a Header). If the numbering parameter is True, Header numbers are added via the number attribute on the header. If the baseLevel parameter is Just n, Header levels are adjusted to be gapless starting at level n.

uniqueIdent :: Extensions -> [Inline] -> Set Text -> Text Source #

Generate a unique identifier from a list of inlines. Second argument is a list of already used identifiers.

inlineListToIdentifier :: Extensions -> [Inline] -> Text Source #

Convert Pandoc inline list to plain text identifier. HTML identifiers must start with a letter, and may contain only letters, digits, and the characters _-.

isHeaderBlock :: Block -> Bool Source #

True if block is a Header block.

headerShift :: Int -> Pandoc -> Pandoc Source #

Shift header levels up or down.

stripEmptyParagraphs :: Pandoc -> Pandoc Source #

Remove empty paragraphs.

onlySimpleTableCells :: [[[Block]]] -> Bool Source #

Detect if table rows contain only cells consisting of a single paragraph that has no LineBreak.

isTightList :: [[Block]] -> Bool Source #

Detect if a list is tight.

taskListItemFromAscii :: Extensions -> [Block] -> [Block] Source #

Convert a list item containing tasklist syntax (e.g. [x]) to using U+2610 BALLOT BOX or U+2612 BALLOT BOX WITH X.

taskListItemToAscii :: Extensions -> [Block] -> [Block] Source #

Convert a list item containing text starting with U+2610 BALLOT BOX or U+2612 BALLOT BOX WITH X to tasklist syntax (e.g. [x]).

addMetaField :: ToMetaValue a => Text -> a -> Meta -> Meta Source #

Set a field of a Meta object. If the field already has a value, convert it into a list with the new value appended to the old value(s).

makeMeta :: [Inline] -> [[Inline]] -> [Inline] -> Meta Source #

Create Meta from old-style title, authors, date. This is provided to ease the transition from the old API.

eastAsianLineBreakFilter :: Pandoc -> Pandoc Source #

Remove soft breaks between East Asian characters.

underlineSpan :: Inlines -> Inlines Source #

Deprecated: Use Text.Pandoc.Builder.underline instead

Builder for underline (deprecated). This probably belongs in Builder.hs in pandoc-types. Will be replaced once Underline is an element.

htmlSpanLikeElements :: Set Text Source #

Set of HTML elements that are represented as Span with a class equal as the element tag itself.

splitSentences :: [Inline] -> [[Inline]] Source #

Split a list of inlines into sentences.

filterIpynbOutput :: Maybe Format -> Pandoc -> Pandoc Source #

Process ipynb output cells. If mode is Nothing, remove all output. If mode is Just format, select best output for the format. If format is not ipynb, strip out ANSI escape sequences from CodeBlocks (see #5633).

TagSoup HTML handling

renderTags' :: [Tag Text] -> Text Source #

Render HTML tags.

File handling

inDirectory :: FilePath -> IO a -> IO a Source #

Perform an IO action in a directory, returning to starting directory.

collapseFilePath :: FilePath -> FilePath Source #

Remove intermediate "." and ".." directories from a path.

collapseFilePath "./foo" == "foo"
collapseFilePath "/bar/../baz" == "/baz"
collapseFilePath "/../baz" == "/../baz"
collapseFilePath "parent/foo/baz/../bar" ==  "parent/foo/bar"
collapseFilePath "parent/foo/baz/../../bar" ==  "parent/bar"
collapseFilePath "parent/foo/.." ==  "parent"
collapseFilePath "/parent/foo/../../bar" ==  "/bar"

URI handling

schemes :: Set Text Source #

Schemes from plus the unofficial schemes doi, javascript, isbn, pmid.

isURI :: Text -> Bool Source #

Check if the string is a valid URL with a IANA or frequently used but unofficial scheme (see schemes).

Error handling

mapLeft :: (a -> b) -> Either a c -> Either b c Source #

for squashing blocks

defaultBlocksSeparator :: Inlines Source #

Inline elements used to separate blocks when squashing blocks into inlines.

Safe read

safeRead :: (MonadPlus m, Read a) => Text -> m a Source #

safeStrRead :: (MonadPlus m, Read a) => String -> m a Source #

User data directory

defaultUserDataDirs :: IO [FilePath] Source #

Return appropriate user data directory for platform. We use XDG_DATA_HOME (or its default value), but fall back to the legacy user data directory ($HOME/.pandoc on *nix) if this is missing.


pandocVersion :: Text Source #

Version number of pandoc library.