Overview

Module xmlrat_generate

• Description
• Data Types
• Function Index
• Function Details

Description

Serialise XML documents from parsed structures.

This module is used to serialise an XML document (in the same form which xmlrat_parse would produce) back to binaries.

Data Types

options()

options() = #{normalise_whitespace => boolean(), indent => boolean(), indentation_unit => binary(), comments => boolean(), doctypes => boolean(), single_quotes => boolean(), self_closing_tags => boolean(), trim_attributes => boolean()}

• normalise_whitespace: if true, run xmlrat_parse:clean_whitespace/1 on the document before serialising it
• indent: if true, pretty-print / re-indent the document before serialising
• indentation_unit: the unit of whitespace used for indentation when indent is true. Defaults to <<" ">> (2 spaces).
• comments: if false, elide comments from the output
• doctypes: if false, elide DTDs from the output
• single_quotes: if false, disable the use of single-quotes around attribute values (by default single quotes are used for values which include double-quote characters)
• self_closing_tags: if false, disable the use of self-closing tags (<foobar/>): instead always generate a separate open and close tag
• trim_atttributes: if true, trim whitespace from the start and end of all attribute values

Function Index

Function Details

string/1

Serialises a document to a binary string.

string/2

Serialises a document to a binary string, with options.

Overview

Generated by EDoc