Text.Pandoc.XML

Functions for escaping and formatting XML.

Documentation

escapeCharForXML :: Char -> Text

Escape one character as needed for XML.

escapeStringForXML :: Text -> Text

Escape string as needed for XML. Entity references are not preserved.

escapeNCName :: Text -> Text

Converts a string into an NCName, i.e., an XML name without colons. Disallowed characters are escaped using ux%x, where %x is the hexadecimal unicode identifier of the escaped character.

inTags :: (HasChars a, IsString a) => Bool -> Text -> [(Text, Text)] -> Doc a -> Doc a

Put the supplied contents between start and end tags of tagType, with specified attributes and (if specified) indentation.

selfClosingTag :: (HasChars a, IsString a) => Text -> [(Text, Text)] -> Doc a

Return a self-closing tag of tagType with specified attributes

inTagsSimple :: (HasChars a, IsString a) => Text -> Doc a -> Doc a

Put the supplied contents between start and end tags of tagType.

inTagsIndented :: (HasChars a, IsString a) => Text -> Doc a -> Doc a

Put the supplied contents in indented block btw start and end tags.

toEntities :: Text -> Text

Escape all non-ascii characters using numerical entities.

toHtml5Entities :: Text -> Text

Escape all non-ascii characters using HTML5 entities, falling back to numerical entities.

fromEntities :: Text -> Text

Unescapes XML entities

lookupEntity :: Text -> Maybe Text

Lookup an entity, using lookupNumericEntity if it starts with # and lookupNamedEntity otherwise

html4Attributes :: Set Text

html5Attributes :: Set Text

rdfaAttributes :: Set Text