Xml_print.Make_typed_fmt · tyxml 4.2.0 · OCaml Packages

tyxml

TyXML is a library for building statically correct HTML5 and SVG documents

pa_tyxml
- Pa_tyxml
tymlx_p
- Simplexmlparser
tyxml
- Tyxml
- Tyxml_html
  - Info
  - Make_printer
    
    1-O
  - Unsafe
  - Xml
- Tyxml_svg
  - Info
  - Make_printer
    
    1-O
  - Unsafe
  - Xml
- Tyxml_xml
tyxml_f
- Html_f
  - Make
    
    1-Xml
    
    W
    
    2-Svg
    
    Info
    
    Unsafe
    
    Info
    
    Unsafe
    
    Xml
    
    W
  - Make_with_wrapped_functions
    
    1-Xml
    
    W
    
    2-C
    
    3-Svg
    
    Info
    
    Unsafe
    
    Info
    
    Unsafe
    
    Xml
    
    W
  - Wrapped_functions
    
    1-Xml
    
    W
- Svg_f
  - Make
    
    1-Xml
    
    W
    
    Info
    
    Unsafe
    
    Xml
    
    W
  - Make_with_wrapped_functions
    
    1-Xml
    
    W
    
    2-C
    
    Info
    
    Unsafe
    
    Xml
    
    W
  - Wrapped_functions
    
    1-Xml
    
    W
- Xml_iter
  - Make
    
    1-Xml
- Xml_print
  - Make
    
    1-Xml
    
    2-I
    
    3-O
  - Make_fmt
    
    1-Xml
    
    2-I
  - Make_simple
    
    1-Xml
    
    2-I
  - Make_typed
    
    1-Xml
    
    2-Typed_xml
    
    Info
    
    3-O
  - Make_typed_fmt
    
    1-Xml
    
    2-Typed_xml
    
    Info
  - Make_typed_simple
    
    1-Xml
    
    2-Typed_xml
    
    Info
  - TagList
  - Utf8
- Xml_wrap
  - NoWrap
  - T
tyxml_tools
- Tyxml_name
tyxml_top
- Tyxml_top

Legend:
Library
Module
Module type
Parameter
Class
Class type

Library tyxml_f

Module Xml_print . Make_typed_fmt

Parameters

module Xml : Xml_sigs.Iterable

module Typed_xml : Xml_sigs.Typed_xml with module Xml := Xml

Signature

val pp_elt : 
  ?encode:( string -> string ) ->
  unit ->
  Format.formatter ->
  'a Typed_xml.elt ->
  unit

pp_elt () is a Format printer for individual elements.

A custom encoding function can be provided with the ~encode argument. Various implementations of encode are available in Xml_print.

val pp : 
  ?encode:( string -> string ) ->
  ?advert:string ->
  unit ->
  Format.formatter ->
  Typed_xml.doc ->
  unit

pp () is a Format printer for complete documents.

It can be used in combination with "%a". For example, to get a string:

let s = Format.asprintf "%a" (pp ()) my_document

A custom encoding function can be provided with the ~encode argument. Various implementations of encode are available in Xml_print.