git.sur5r.net Git - glabels/blob - docs/libglabels/xml/xml-template.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
   4
   5 <refentry id="libglabels-xml-template">
   6 <refmeta>
   7 <refentrytitle role="top_of_page" id="libglabels-xml-template.top_of_page">XML Template Functions</refentrytitle>
   8 <manvolnum>3</manvolnum>
   9 <refmiscinfo>LIBGLABELS Library</refmiscinfo>
  10 </refmeta>
  11
  12 <refnamediv>
  13 <refname>XML Template Functions</refname>
  14 <refpurpose>Functions to create and parse glabels XML template nodes and files</refpurpose>
  15 </refnamediv>
  16
  17 <refsynopsisdiv id="libglabels-xml-template.synopsis" role="synopsis">
  18 <title role="synopsis.title">Synopsis</title>
  19
  20 <synopsis>
  21
  22 #include &lt;libglabels/xml-templates.h&gt;
  23
  24 <link linkend="GList">GList</link> *             <link linkend="lgl-xml-template-read-templates-from-file">lgl_xml_template_read_templates_from_file</link>
  25                                                         (const <link linkend="gchar">gchar</link> *utf8_filename);
  26 <link linkend="GList">GList</link> *             <link linkend="lgl-xml-template-parse-templates-doc">lgl_xml_template_parse_templates_doc</link>
  27                                                         (const <link linkend="xmlDocPtr">xmlDocPtr</link> templates_doc);
  28 <link linkend="lglTemplate">lglTemplate</link> *       <link linkend="lgl-xml-template-parse-template-node">lgl_xml_template_parse_template_node</link>
  29                                                         (const <link linkend="xmlNodePtr">xmlNodePtr</link> template_node);
  30 <link linkend="gint">gint</link>                <link linkend="lgl-xml-template-write-templates-to-file">lgl_xml_template_write_templates_to_file</link>
  31                                                         (<link linkend="GList">GList</link> *templates,
  32                                                          const <link linkend="gchar">gchar</link> *utf8_filename);
  33 <link linkend="gint">gint</link>                <link linkend="lgl-xml-template-write-template-to-file">lgl_xml_template_write_template_to_file</link>
  34                                                         (const <link linkend="lglTemplate">lglTemplate</link> *template,
  35                                                          const <link linkend="gchar">gchar</link> *utf8_filename);
  36 <link linkend="void">void</link>                <link linkend="lgl-xml-template-create-template-node">lgl_xml_template_create_template_node</link>
  37                                                         (const <link linkend="lglTemplate">lglTemplate</link> *template,
  38                                                          <link linkend="xmlNodePtr">xmlNodePtr</link> root,
  39                                                          const <link linkend="xmlNsPtr">xmlNsPtr</link> ns);
  40 </synopsis>
  41 </refsynopsisdiv>
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51 <refsect1 id="libglabels-xml-template.description" role="desc">
  52 <title role="desc.title">Description</title>
  53 <para>
  54 This section describes a number of functions for creating and parsing
  55 glabels XML template nodes and files.  Template nodes are used in both
  56 template files and document files.
  57 </para>
  58 </refsect1>
  59
  60 <refsect1 id="libglabels-xml-template.details" role="details">
  61 <title role="details.title">Details</title>
  62 <refsect2 id="lgl-xml-template-read-templates-from-file" role="function">
  63 <title>lgl_xml_template_read_templates_from_file ()</title>
  64 <indexterm zone="lgl-xml-template-read-templates-from-file"><primary sortas="lgl_xml_template_read_templates_from_file">lgl_xml_template_read_templates_from_file</primary></indexterm><programlisting><link linkend="GList">GList</link> *             lgl_xml_template_read_templates_from_file
  65                                                         (const <link linkend="gchar">gchar</link> *utf8_filename);</programlisting>
  66 <para>
  67 Read glabels templates from template file.</para>
  68 <para>
  69 </para><variablelist role="params">
  70 <varlistentry><term><parameter>utf8_filename</parameter>&#160;:</term>
  71 <listitem><simpara>       Filename of papers file (name encoded as UTF-8)
  72 </simpara></listitem></varlistentry>
  73 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a list of <link linkend="lglTemplate"><type>lglTemplate</type></link> structures.
  74
  75 </simpara></listitem></varlistentry>
  76 </variablelist></refsect2>
  77 <refsect2 id="lgl-xml-template-parse-templates-doc" role="function">
  78 <title>lgl_xml_template_parse_templates_doc ()</title>
  79 <indexterm zone="lgl-xml-template-parse-templates-doc"><primary sortas="lgl_xml_template_parse_templates_doc">lgl_xml_template_parse_templates_doc</primary></indexterm><programlisting><link linkend="GList">GList</link> *             lgl_xml_template_parse_templates_doc
  80                                                         (const <link linkend="xmlDocPtr">xmlDocPtr</link> templates_doc);</programlisting>
  81 <para>
  82 Read glabels templates from a libxml <link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> tree.</para>
  83 <para>
  84 </para><variablelist role="params">
  85 <varlistentry><term><parameter>templates_doc</parameter>&#160;:</term>
  86 <listitem><simpara>  libxml <link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> tree, representing template file.
  87 </simpara></listitem></varlistentry>
  88 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a list of <link linkend="lglTemplate"><type>lglTemplate</type></link> structures.
  89
  90 </simpara></listitem></varlistentry>
  91 </variablelist></refsect2>
  92 <refsect2 id="lgl-xml-template-parse-template-node" role="function">
  93 <title>lgl_xml_template_parse_template_node ()</title>
  94 <indexterm zone="lgl-xml-template-parse-template-node"><primary sortas="lgl_xml_template_parse_template_node">lgl_xml_template_parse_template_node</primary></indexterm><programlisting><link linkend="lglTemplate">lglTemplate</link> *       lgl_xml_template_parse_template_node
  95                                                         (const <link linkend="xmlNodePtr">xmlNodePtr</link> template_node);</programlisting>
  96 <para>
  97 Read a single glabels template from a libxml <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> node.</para>
  98 <para>
  99 </para><variablelist role="params">
 100 <varlistentry><term><parameter>template_node</parameter>&#160;:</term>
 101 <listitem><simpara>  libxml <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> template node from a <link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> tree.
 102 </simpara></listitem></varlistentry>
 103 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a pointer to a newly created <link linkend="lglTemplate"><type>lglTemplate</type></link> structure.
 104
 105 </simpara></listitem></varlistentry>
 106 </variablelist></refsect2>
 107 <refsect2 id="lgl-xml-template-write-templates-to-file" role="function">
 108 <title>lgl_xml_template_write_templates_to_file ()</title>
 109 <indexterm zone="lgl-xml-template-write-templates-to-file"><primary sortas="lgl_xml_template_write_templates_to_file">lgl_xml_template_write_templates_to_file</primary></indexterm><programlisting><link linkend="gint">gint</link>                lgl_xml_template_write_templates_to_file
 110                                                         (<link linkend="GList">GList</link> *templates,
 111                                                          const <link linkend="gchar">gchar</link> *utf8_filename);</programlisting>
 112 <para>
 113 Write a list of <link linkend="lglTemplate"><type>lglTemplate</type></link> structures to a glabels XML template file.</para>
 114 <para>
 115 </para><variablelist role="params">
 116 <varlistentry><term><parameter>templates</parameter>&#160;:</term>
 117 <listitem><simpara>      List of <link linkend="lglTemplate"><type>lglTemplate</type></link> structures
 118 </simpara></listitem></varlistentry>
 119 <varlistentry><term><parameter>utf8_filename</parameter>&#160;:</term>
 120 <listitem><simpara>  Filename of templates file (name encoded as UTF-8)
 121 </simpara></listitem></varlistentry>
 122 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the number of bytes written or -1 in case of failure
 123
 124 </simpara></listitem></varlistentry>
 125 </variablelist></refsect2>
 126 <refsect2 id="lgl-xml-template-write-template-to-file" role="function">
 127 <title>lgl_xml_template_write_template_to_file ()</title>
 128 <indexterm zone="lgl-xml-template-write-template-to-file"><primary sortas="lgl_xml_template_write_template_to_file">lgl_xml_template_write_template_to_file</primary></indexterm><programlisting><link linkend="gint">gint</link>                lgl_xml_template_write_template_to_file
 129                                                         (const <link linkend="lglTemplate">lglTemplate</link> *template,
 130                                                          const <link linkend="gchar">gchar</link> *utf8_filename);</programlisting>
 131 <para>
 132 Write a single <link linkend="lglTemplate"><type>lglTemplate</type></link> structures to a glabels XML template file.</para>
 133 <para>
 134 </para><variablelist role="params">
 135 <varlistentry><term><parameter>template</parameter>&#160;:</term>
 136 <listitem><simpara>       <link linkend="lglTemplate"><type>lglTemplate</type></link> structure to be written
 137 </simpara></listitem></varlistentry>
 138 <varlistentry><term><parameter>utf8_filename</parameter>&#160;:</term>
 139 <listitem><simpara>  Filename of templates file (name encoded as UTF-8)
 140 </simpara></listitem></varlistentry>
 141 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the number of bytes written or -1 in case of failure
 142
 143 </simpara></listitem></varlistentry>
 144 </variablelist></refsect2>
 145 <refsect2 id="lgl-xml-template-create-template-node" role="function">
 146 <title>lgl_xml_template_create_template_node ()</title>
 147 <indexterm zone="lgl-xml-template-create-template-node"><primary sortas="lgl_xml_template_create_template_node">lgl_xml_template_create_template_node</primary></indexterm><programlisting><link linkend="void">void</link>                lgl_xml_template_create_template_node
 148                                                         (const <link linkend="lglTemplate">lglTemplate</link> *template,
 149                                                          <link linkend="xmlNodePtr">xmlNodePtr</link> root,
 150                                                          const <link linkend="xmlNsPtr">xmlNsPtr</link> ns);</programlisting>
 151 <para>
 152 Add a single <link linkend="lglTemplate"><type>lglTemplate</type></link> child node to given <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link>.</para>
 153 <para>
 154 </para><variablelist role="params">
 155 <varlistentry><term><parameter>template</parameter>&#160;:</term>
 156 <listitem><simpara>       <link linkend="lglTemplate"><type>lglTemplate</type></link> structure to be written
 157 </simpara></listitem></varlistentry>
 158 <varlistentry><term><parameter>root</parameter>&#160;:</term>
 159 <listitem><simpara>           parent node to receive new child node
 160 </simpara></listitem></varlistentry>
 161 <varlistentry><term><parameter>ns</parameter>&#160;:</term>
 162 <listitem><simpara>             a libxml <link linkend="xmlNsPtr"><type>xmlNsPtr</type></link>
 163 </simpara></listitem></varlistentry>
 164 </variablelist></refsect2>
 165
 166 </refsect1>
 167
 168
 169
 170
 171 </refentry>