git.sur5r.net Git - glabels/blob - docs/libglabels/xml/xml-paper.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-paper">
   6 <refmeta>
   7 <refentrytitle role="top_of_page" id="libglabels-xml-paper.top_of_page">XML Paper Functions</refentrytitle>
   8 <manvolnum>3</manvolnum>
   9 <refmiscinfo>LIBGLABELS Library</refmiscinfo>
  10 </refmeta>
  11
  12 <refnamediv>
  13 <refname>XML Paper Functions</refname>
  14 <refpurpose>Functions to parse glabels XML paper definition files</refpurpose>
  15 </refnamediv>
  16
  17 <refsynopsisdiv id="libglabels-xml-paper.synopsis" role="synopsis">
  18 <title role="synopsis.title">Synopsis</title>
  19
  20 <synopsis>
  21
  22 #include &lt;libglabels/xml-paper.h&gt;
  23
  24 <link linkend="GList">GList</link> *             <link linkend="lgl-xml-paper-read-papers-from-file">lgl_xml_paper_read_papers_from_file</link> (<link linkend="gchar">gchar</link> *utf8_filename);
  25 <link linkend="GList">GList</link> *             <link linkend="lgl-xml-paper-parse-papers-doc">lgl_xml_paper_parse_papers_doc</link>      (<link linkend="xmlDocPtr">xmlDocPtr</link> papers_doc);
  26 <link linkend="lglPaper">lglPaper</link> *          <link linkend="lgl-xml-paper-parse-paper-node">lgl_xml_paper_parse_paper_node</link>      (<link linkend="xmlNodePtr">xmlNodePtr</link> paper_node);
  27 </synopsis>
  28 </refsynopsisdiv>
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38 <refsect1 id="libglabels-xml-paper.description" role="desc">
  39 <title role="desc.title">Description</title>
  40 <para>
  41 This section describes a number of functions for parsing glabels
  42 XML paper definition files.
  43 </para>
  44 </refsect1>
  45
  46 <refsect1 id="libglabels-xml-paper.details" role="details">
  47 <title role="details.title">Details</title>
  48 <refsect2 id="lgl-xml-paper-read-papers-from-file" role="function">
  49 <title>lgl_xml_paper_read_papers_from_file ()</title>
  50 <indexterm zone="lgl-xml-paper-read-papers-from-file"><primary sortas="lgl_xml_paper_read_papers_from_file">lgl_xml_paper_read_papers_from_file</primary></indexterm><programlisting><link linkend="GList">GList</link> *             lgl_xml_paper_read_papers_from_file (<link linkend="gchar">gchar</link> *utf8_filename);</programlisting>
  51 <para>
  52 Read paper definitions from a file.</para>
  53 <para>
  54 </para><variablelist role="params">
  55 <varlistentry><term><parameter>utf8_filename</parameter>&#160;:</term>
  56 <listitem><simpara>       Filename of papers file (name encoded as UTF-8)
  57 </simpara></listitem></varlistentry>
  58 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a list of <link linkend="lglPaper"><type>lglPaper</type></link> structures.
  59
  60 </simpara></listitem></varlistentry>
  61 </variablelist></refsect2>
  62 <refsect2 id="lgl-xml-paper-parse-papers-doc" role="function">
  63 <title>lgl_xml_paper_parse_papers_doc ()</title>
  64 <indexterm zone="lgl-xml-paper-parse-papers-doc"><primary sortas="lgl_xml_paper_parse_papers_doc">lgl_xml_paper_parse_papers_doc</primary></indexterm><programlisting><link linkend="GList">GList</link> *             lgl_xml_paper_parse_papers_doc      (<link linkend="xmlDocPtr">xmlDocPtr</link> papers_doc);</programlisting>
  65 <para>
  66 Read paper definitions from a libxml <link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> tree.</para>
  67 <para>
  68 </para><variablelist role="params">
  69 <varlistentry><term><parameter>papers_doc</parameter>&#160;:</term>
  70 <listitem><simpara>  libxml <link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> tree, representing a papers definition file.
  71 </simpara></listitem></varlistentry>
  72 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a list of <link linkend="lglPaper"><type>lglPaper</type></link> structures.
  73
  74 </simpara></listitem></varlistentry>
  75 </variablelist></refsect2>
  76 <refsect2 id="lgl-xml-paper-parse-paper-node" role="function">
  77 <title>lgl_xml_paper_parse_paper_node ()</title>
  78 <indexterm zone="lgl-xml-paper-parse-paper-node"><primary sortas="lgl_xml_paper_parse_paper_node">lgl_xml_paper_parse_paper_node</primary></indexterm><programlisting><link linkend="lglPaper">lglPaper</link> *          lgl_xml_paper_parse_paper_node      (<link linkend="xmlNodePtr">xmlNodePtr</link> paper_node);</programlisting>
  79 <para>
  80 Read a single paper definition from a libxml <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> node.</para>
  81 <para>
  82 </para><variablelist role="params">
  83 <varlistentry><term><parameter>paper_node</parameter>&#160;:</term>
  84 <listitem><simpara>  libxml <link linkend="xmlNodePtr"><type>xmlNodePtr</type></link> paper node from a <link linkend="xmlDocPtr"><type>xmlDocPtr</type></link> tree.
  85 </simpara></listitem></varlistentry>
  86 <varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a pointer to a newly created <link linkend="lglPaper"><type>lglPaper</type></link> structure.
  87
  88 </simpara></listitem></varlistentry>
  89 </variablelist></refsect2>
  90
  91 </refsect1>
  92
  93
  94
  95
  96 </refentry>