| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Text.XML.Generator
Description
This module provides combinators for generating XML documents.
As an example, suppose you want to generate the following XML document:
<?xml version="1.0"?> <people> <person age="32">Stefan</person> <person age="4">Judith</person> </people>
Then you could use the following Haskell code:
let people = [("Stefan", "32"), ("Judith", "4")]
in doc defaultDocInfo $
xelem "people" $
xelems $ map ((name, age) -> xelem "person" (xattr "age" age <#> xtext name)) people
- data Xml t
- data Doc
- data DocInfo = DocInfo {}
- doc :: DocInfo -> Xml Elem -> Xml Doc
- defaultDocInfo :: DocInfo
- data Namespace
- type Prefix = Text
- type Uri = Text
- type Name = Text
- namespace :: Prefix -> Uri -> Namespace
- noNamespace :: Namespace
- defaultNamespace :: Namespace
- data Elem
- xelem :: AddChildren c => Name -> c -> Xml Elem
- xelemQ :: AddChildren c => Namespace -> Name -> c -> Xml Elem
- xelemEmpty :: Name -> Xml Elem
- xelemQEmpty :: Namespace -> Name -> Xml Elem
- class AddChildren c
- xelems :: [Xml Elem] -> Xml Elem
- noElems :: Xml Elem
- xelemWithText :: Name -> TextContent -> Xml Elem
- (<>) :: Semigroup a => a -> a -> a
- (<#>) :: a -> b -> (a, b)
- data Attr
- xattr :: Name -> TextContent -> Xml Attr
- xattrQ :: Namespace -> Name -> TextContent -> Xml Attr
- xattrQRaw :: Namespace -> Name -> Builder -> Xml Attr
- xattrs :: [Xml Attr] -> Xml Attr
- noAttrs :: Xml Attr
- type TextContent = Text
- xtext :: TextContent -> Xml Elem
- xtextRaw :: Builder -> Xml Elem
- xentityRef :: Name -> Xml Elem
- xempty :: Renderable t => Xml t
- class Renderable t => Misc t where
- xrender :: (Renderable r, XmlOutput t) => Xml r -> t
- class XmlOutput t where
- class Renderable t
- xhtmlFramesetDocInfo :: DocInfo
- xhtmlStrictDocInfo :: DocInfo
- xhtmlTransitionalDocInfo :: DocInfo
- xhtmlRootElem :: Text -> Xml Elem -> Xml Elem
General
Documents
A piece of XML at the document level.
The DocInfo type contains all information of an XML document except the root element.
Constructors
| DocInfo | |
Fields
| |
doc :: DocInfo -> Xml Elem -> Xml Doc Source #
Constructs an XML document from a DocInfo value and the root element.
defaultDocInfo :: DocInfo Source #
The default document info (standalone, without document type, without content before/after the root element).
Namespaces
Type for representing presence or absence of an XML namespace.
namespace :: Prefix -> Uri -> Namespace Source #
Constructs a qualified XML namespace. The given URI must not be the empty string.
noNamespace :: Namespace Source #
A Namespace value denoting the absence of any XML namespace information.
defaultNamespace :: Namespace Source #
A Namespace value denoting the default namespace.
- For elements, this is the namespace currently mapped to the empty prefix.
- For attributes, the default namespace does not carry any namespace information.
Elements
A piece of XML at the element level.
xelem :: AddChildren c => Name -> c -> Xml Elem Source #
Construct a simple-named element with the given children.
xelemQ :: AddChildren c => Namespace -> Name -> c -> Xml Elem Source #
Construct an element with the given children.
class AddChildren c Source #
Class for adding children to an element.
The various instances of this class allow the addition of different kinds of children.
Minimal complete definition
addChildren
Instances
| AddChildren () Source # | |
| AddChildren String Source # | |
| AddChildren TextContent Source # | |
| AddChildren (Xml Attr) Source # | |
| AddChildren (Xml Elem) Source # | |
| AddChildren (Xml Attr, [Xml Elem]) Source # | |
| AddChildren (Xml Attr, Xml Elem) Source # | |
xelems :: [Xml Elem] -> Xml Elem Source #
Merges a list of elements into a single piece of XML at the element level.
xelemWithText :: Name -> TextContent -> Xml Elem Source #
The expression xelemWithText n t constructs an XML element with name n and text content t.
(<#>) :: a -> b -> (a, b) infixl 5 Source #
Shortcut for constructing pairs. Used in combination with xelem for separating child-attributes
from child-elements.
Attributes
A piece of XML at the attribute level.
xattr :: Name -> TextContent -> Xml Attr Source #
Construct a simple-named attribute by escaping its value.
xattrQ :: Namespace -> Name -> TextContent -> Xml Attr Source #
Construct an attribute by escaping its value.
xattrQRaw :: Namespace -> Name -> Builder -> Xml Attr Source #
Construct an attribute without escaping its value. Note: attribute values are quoted with double quotes.
xattrs :: [Xml Attr] -> Xml Attr Source #
Merge a list of attributes into a single piece of XML at the attribute level.
Text
type TextContent = Text Source #
Text content subject to escaping.
xentityRef :: Name -> Xml Elem Source #
Constructs a reference to the named entity. Note: no escaping is performed on the name of the entity
Other
xempty :: Renderable t => Xml t Source #
An empty, polymorphic piece of XML.
class Renderable t => Misc t where Source #
Class providing methods for adding processing instructions and comments.
Methods
xprocessingInstruction :: String -> String -> Xml t Source #
Constructs a processing instruction with the given target and content. Note: Rendering does not perform escaping on the target and the content.
xcomment :: String -> Xml t Source #
Constructs an XML comment. Note: No escaping is performed on the text of the comment.
Rendering
class XmlOutput t where Source #
Instances of the XmlOutput class may serve as target of serializing an XML document.
Minimal complete definition
class Renderable t Source #
Any type subject to rendering must implement this type class.
Minimal complete definition
builder, mkRenderable
Instances
XHTML documents
xhtmlFramesetDocInfo :: DocInfo Source #
Document info for XHTML 1.0 frameset.
xhtmlStrictDocInfo :: DocInfo Source #
Document info for XHTML 1.0 strict.
xhtmlTransitionalDocInfo :: DocInfo Source #
Document info for XHTML 1.0 transitional.