1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
# TypedXML
TyXML allows you to build XML trees whose validity is ensured by the typechecker.
It's based on a traduction of XML types into polymorphic variants, originally written by Thorsten Ohl.
Currently, the transcription has been done for XHTML 1.0 and 1.1, HTML5 and SVG (partial).
TyXML also provides a generic printer and some low-level (and untyped) iterators over XML trees.
The printer has options for printing XHTML in more browser-friendly way when served as `"text/html"` (instead of `"text/xml"`).
HTML5 is always printed with those options.
All modules provided by TyXML are also provided in functorial interface, where every module is parameterised by the underlying XML representation.
A camlp4 extension, named `Pa_tyxml`, allows to write HTML pages or HTML fragments with the usual syntax.
For creating HTML5-, XHTML-, or SVG-nodes, the syntax extension relies on the presence of a module called Html5, Xhtml, or Svg which keeps the actual implementation, e.g.
```ocaml
let module Html5 = Eliom_content.Html5.F in
<:html5< <div>xyz</div> >>
```
You can find the documentation [on the TyXML website](http://ocsigen.org/tyxml/api/).
## How to
### Installation
TyXML is available in [opam](http://opam.ocamlpro.com) : `opam install tyxml`
You can also use the ocsigen opam repository for the dev version :
`opam repository add ocsigen-dev http://ocsigen.org/opam`
### Manual build
#### Requirements:
* ocaml and camlp4
* findlib
#### Build instructions:
```
./configure
make
make install
```
#### API documentation:
```
make doc
${BROWSER} _build/tyxml-api.docdir/index.html
```
|
