docs/reference/glib/tmpl/markup.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Simple XML Subset Parser
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6 Parses a subset of XML
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10 The "GMarkup" parser is intended to parse a simple markup format
  11 that's a subset of XML format. This is a small, efficient, easy-to-use
  12 parser. It should not be used if you expect to interoperate with other
  13 applications generating full-scale XML. However, it's very useful for
  14 application data files, config files, etc. where you know your
  15 application will be the only one writing the file. Full-scale XML
  16 parsers should be able to parse the subset used by GMarkup, so you can
  17 easily migrate to full-scale XML at a later time if the need arises.
  18 </para>
  19
  20 <para>
  21 GMarkup is not guaranteed to signal an error on all invalid XML; the
  22 parser may accept documents that an XML parser would not, e.g. the
  23 sequence <literal>&lt;[[</literal> has special meaning in XML and not
  24 in GMarkup. However, invalid XML documents are not considered valid
  25 GMarkup documents.
  26 </para>
  27
  28 <para>
  29 Simplifications to XML include:
  30 <itemizedlist>
  31 <listitem>
  32 <para>
  33 Only UTF-8 encoding is allowed.
  34 </para>
  35 </listitem>
  36 <listitem>
  37 <para>
  38 No CDATA, no user-defined entities.
  39 </para>
  40 </listitem>
  41 <listitem>
  42 <para>
  43 Processing instructions and comments are "passed through" but are not
  44 interpreted in any way.
  45 </para>
  46 </listitem>
  47 <listitem>
  48 <para>
  49 No DTD or validation.
  50 </para>
  51 </listitem>
  52 <listitem>
  53 <para>
  54 </para>
  55 </listitem>
  56 </itemizedlist>
  57 </para>
  58
  59 <para>
  60 The markup format does support:
  61 <itemizedlist>
  62 <listitem>
  63 <para>
  64 Elements
  65 </para>
  66 </listitem>
  67 <listitem>
  68 <para>
  69 Attributes
  70 </para>
  71 </listitem>
  72 <listitem>
  73 <para>
  74 5 standard entities: <literal>&amp;amp; &amp;lt; &amp;gt; &amp;quot; &amp;apos;</literal>
  75 </para>
  76 </listitem>
  77 <listitem>
  78 <para>
  79 Character references
  80 </para>
  81 </listitem>
  82 </itemizedlist>
  83 </para>
  84
  85 <!-- ##### SECTION See_Also ##### -->
  86 <para>
  87
  88 </para>
  89