package xmlm

  1. Overview
  2. Docs
Streaming XML codec for OCaml

Install

Dune Dependency

erratique.ch Readme Changelog ISC License Edit opam file Versions (5)

Authors

  1. T
    The xmlm programmers

Maintainers

  1. Daniel Bünzli

Sources

xmlm-1.4.0.tbz
sha512=69f6112e6466952256d670fe1751fe4ae79e20d50f018ece1709eb2240cb1b00968ac7cee110771e0617a38ebc1cdb43e9d146471ce66ac1b176e4a1660531eb

Description

Xmlm is a streaming codec to decode and encode the XML data format. It can process XML documents without a complete in-memory representation of the data.

Xmlm is made of a single independent module and distributed under the ISC license.

Home page: http://erratique.ch/software/xmlm

Tags

xml codec org:erratique

Published: 09 Feb 2022

README

Xmlm — Streaming XML codec for OCaml

v1.4.0

Xmlm is a streaming codec to decode and encode the XML data format. It can process XML documents without a complete in-memory representation of the data.

Xmlm is made of a single independent module and distributed under the ISC license.

Home page: http://erratique.ch/software/xmlm

Installation

Xmlm can be installed with opam:

opam install xmlm

If you don't use opam consult the opam file for build instructions.

Documentation

The documentation and API reference is automatically generated from the source interfaces. It can be consulted online or via odig doc xmlm.

Sample programs

If you installed xmlm with opam sample programs are located in the directory opam config var xmlm:doc.

In the distribution sample programs and tests are located in the test directory of the distribution. They can be built and run with:

topkg build --tests true && topkg test

The xmltrip tool reads XML files with Xmlm and outputs them back in various ways. It is useful to understand how Xmlm handles documents. xmltrip -help has more information.

If you need to parse XHTML, the file xhtml.ml in the test directory has an OCaml list coupling each XHTML character entity with its corresponding UTF-8 encoded character string. You can use it to program a suitable entity callback.

Dependencies (4)

  1. topkg build & >= "1.0.3"
  2. ocamlbuild build
  3. ocamlfind build
  4. ocaml >= "4.05.0"

Dev Dependencies

None

Conflicts

None

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct