Text.XML

Contents

Description

DOM-based parsing and rendering.

This module requires that all entities be resolved at parsing. If you need to interact with unresolved entities, please use Text.XML.Unresolved. This is the recommended module for most uses cases.

While many of the datatypes in this module are simply re-exported from Data.XML.Types, Document, Node and Element are all redefined here to disallow the possibility of unresolved entities. Conversion functions are provided to switch between the two sets of datatypes.

For simpler, bidirectional traversal of the DOM tree, see the Text.XML.Cursor module.

Synopsis

Data types

data Document Source

Constructors

Document
Fields documentPrologue :: Prologue documentRoot :: Element documentEpilogue :: [Miscellaneous]

Instances

Eq Document
Show Document
Typeable Document

data Prologue

Constructors

Prologue
Fields prologueBefore :: [Miscellaneous] prologueDoctype :: Maybe Doctype prologueAfter :: [Miscellaneous]

Instances

Eq Prologue
Show Prologue
Typeable Prologue

data Instruction

Constructors

Instruction
Fields instructionTarget :: Text instructionData :: Text

Instances

Eq Instruction
Ord Instruction
Show Instruction
Typeable Instruction

data Miscellaneous

Constructors

MiscInstruction Instruction
MiscComment Text

Instances

Eq Miscellaneous
Show Miscellaneous
Typeable Miscellaneous

data Node Source

Constructors

NodeElement Element
NodeInstruction Instruction
NodeContent Text
NodeComment Text

Instances

Eq Node
Show Node
Typeable Node

data Element Source

Constructors

Element
Fields elementName :: Name elementAttributes :: [(Name, Text)] elementNodes :: [Node]

Instances

Eq Element
Show Element
Typeable Element

data Name

A fully qualified name.

Prefixes are not semantically important; they are included only to simplify pass-through parsing. When comparing names with Eq or Ord methods, prefixes are ignored.

The IsString instance supports Clark notation; see http://www.jclark.com/xml/xmlns.htm and http://infohost.nmt.edu/tcc/help/pubs/pylxml/etree-QName.html. Use the OverloadedStrings language extension for very simple Name construction:

 myname :: Name
 myname = "{http://example.com/ns/my-namespace}my-name"

Constructors

Name
Fields nameLocalName :: Text nameNamespace :: Maybe Text namePrefix :: Maybe Text

Instances

Eq Name
Ord Name
Show Name
Typeable Name
IsString Name

data Doctype

Note: due to the incredible complexity of DTDs, this type only supports external subsets. I've tried adding internal subset types, but they quickly gain more code than the rest of this module put together.

It is possible that some future version of this library might support internal subsets, but I am no longer actively working on adding them.

Constructors