package tyxml
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=bfeb673c6b4e120a4eca4c48448add47dc3f8d02c2b40f63ffdccc4e91c902dd
sha512=69750eeaf467014282087bf9628f3278f3e5f00f4c7400358750d208664cfc3f79a5cba16767d2935e53477d1a6862fe08c5b801b69052ec12e09d1a93a5e9b4
doc/tyxml.functor/Xml_print/index.html
Module Xml_print
Source
Printing utilities.
This module contains various encoding functions that can be used with Tyxml.Html.pp
and Tyxml.Svg.pp
.
It also contains functors to create printers for your own XML data structure.
Encoding functions
The encoder maps strings to HTML and must encode the unsafe characters '<'
, '>'
, '"'
, '&'
and the control characters 0-8, 11-12, 14-31, 127 to HTML entities. encode_unsafe_char
is the default for ?encode
in output
and pretty_print
below. Other implementations are provided by the module Netencoding
in the OcamlNet library, e.g.:
let encode = Netencoding.Html.encode ~in_enc:`Enc_iso88591 ~out_enc:`Enc_usascii ()
Where national characters are replaced by HTML entities. The user is of course free to write her own implementation.
In addition, encode "@"
as "@"
in the hope that this will fool simple minded email address harvesters.
Utilities
encoding
is the name of the character encoding, e.g. "US-ASCII"
or "UTF-8"
Convert a float to a string using a compact representation compatible with the Javascript norm.
See string_of_number
.
Formatter functors
module Make_typed_fmt
(Xml : Xml_sigs.Iterable)
(Typed_xml : Xml_sigs.Typed_xml with module Xml := Xml) :
Xml_sigs.Typed_pp
with type 'a elt := 'a Typed_xml.elt
and type doc := Typed_xml.doc
module Make_fmt
(Xml : Xml_sigs.Iterable)
(I : TagList) :
Xml_sigs.Pp with type elt := Xml.elt
Printers for raw XML modules.
Deprecated functors
Use Make_fmt
and Make_typed_fmt
instead.
module Make
(Xml : Xml_sigs.Iterable)
(I : TagList)
(O : Xml_sigs.Output) :
Xml_sigs.Printer with type out := O.out and type xml_elt := Xml.elt
module Make_typed
(Xml : Xml_sigs.Iterable)
(Typed_xml : Xml_sigs.Typed_xml with module Xml := Xml)
(O : Xml_sigs.Output) :
Xml_sigs.Typed_printer
with type out := O.out
and type 'a elt := 'a Typed_xml.elt
and type doc := Typed_xml.doc
module Make_simple
(Xml : Xml_sigs.Iterable)
(I : TagList) :
Xml_sigs.Simple_printer with type xml_elt := Xml.elt
module Make_typed_simple
(Xml : Xml_sigs.Iterable)
(Typed_xml : Xml_sigs.Typed_xml with module Xml := Xml) :
Xml_sigs.Typed_simple_printer
with type 'a elt := 'a Typed_xml.elt
and type doc := Typed_xml.doc