TIVI-153: Add as dependency for iputils
[profile/ivi/opensp.git] / doc / xml.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML Strict//EN">
2 <HTML>
3 <HEAD>
4 <TITLE>OpenSP - XML support</TITLE>
5 </HEAD>
6 <BODY>
7 <H1>XML support</H1>
8 <H2>Using OpenSP to parse XML</H2>
9 <P>
10 To enable OpenSP's support for <A
11 HREF="http://www.w3.org/TR/1998/REC-xml-19980210">XML 1.0</A>:
12 <UL>
13 <LI>
14 Set the <SAMP>SP_CHARSET_FIXED</SAMP> environment variable to <SAMP>YES</SAMP>.
15 <LI>
16 Set the <SAMP>SP_ENCODING</SAMP> environment variable to <SAMP>XML</SAMP>.
17 <LI>
18 Set the <SAMP>SGML_CATALOG_FILES</SAMP> environment variable to
19 point to the file <SAMP>pubtext/xml.soc</SAMP>.
20 <LI>
21 Use the <SAMP>-wxml</SAMP> option.
22 <LI>
23 If the document is not supposed to be valid, use <SAMP>-wno-valid</SAMP>
24 option.
25 </UL>
26
27 <H2>Limitations</H2>
28 <P>
29 OpenSP does not enforce the following XML constraints:
30 <UL>
31 <LI>
32 XML constrains processing instructions
33 with a target matching <CODE>[Xx][Mm][Ll]</CODE>,
34 both in terms of where they can occur and their content.
35 <LI>
36 XML does not allow a parameter separator that is adjacent to a
37 delimiter to be omitted.
38 <LI>
39 XML has constraints on the use of <CODE>&amp;</CODE> in parameter
40 literals.  In SGML terms, XML says that the <b>ero</b> delimiter is
41 recognized in a parameter literal, and that it must be followed by an
42 entity reference, but the entity reference is not expanded.
43 </UL>
44 <P>
45 Line ends are normalized using SGML conventions to a CR/LF character
46 pair rather than using the XML convention of a single LF character.
47 <P>
48 OpenSP does not enforce XML's rules on not continuing normal processing
49 after an error.  Applications can enforce these if they choose.
50
51 <H2>Web SGML Adaptations Annex</H2>
52 <P>
53 OpenSP's support for XML is based on <A
54 HREF="http://www.ornl.gov/sgml/sc34/document/0029.htm">Annex K of ISO
55 8879</A> (the Web SGML Adaptations Annex).
56 The following features of Annex K are not yet implemented:
57 <UL>
58 <LI>
59 <SAMP>#IMPLIED</SAMP> document type name
60 <LI>
61 <SAMP>#ALL</SAMP> and <SAMP>#IMPLICIT</SAMP> in model groups and exceptions
62 </UL>
63 </BODY>
64 </HTML>