XML Template Functions

XML Template Functions — Functions to create and parse glabels XML template nodes and files

Synopsis


#include <libglabels/xml-templates.h>


GList*      gl_xml_template_read_templates_from_file
                                            (const gchar *utf8_filename);
GList*      gl_xml_template_parse_templates_doc
                                            (const xmlDocPtr templates_doc);
glTemplate* gl_xml_template_parse_template_node
                                            (const xmlNodePtr template_node);
void        gl_xml_template_write_templates_to_file
                                            (GList *templates,
                                             const gchar *utf8_filename);
void        gl_xml_template_write_template_to_file
                                            (const glTemplate *template,
                                             const gchar *utf8_filename);
xmlDocPtr   gl_xml_template_create_templates_doc
                                            (GList *templates);
void        gl_xml_template_create_template_node
                                            (const glTemplate *template,
                                             xmlNodePtr root,
                                             const xmlNsPtr ns);

Description

This section describes a number of functions for creating and parsing glabels XML template nodes and files. Template nodes are used in both template files and document files.

Details

gl_xml_template_read_templates_from_file ()

GList*      gl_xml_template_read_templates_from_file
                                            (const gchar *utf8_filename);

Read glabels templates from template file.

utf8_filename : Filename of papers file (name encoded as UTF-8)
Returns : a list of glTemplate structures.

gl_xml_template_parse_templates_doc ()

GList*      gl_xml_template_parse_templates_doc
                                            (const xmlDocPtr templates_doc);

Read glabels templates from a libxml xmlDocPtr tree.

templates_doc : libxml xmlDocPtr tree, representing template file.
Returns : a list of glTemplate structures.

gl_xml_template_parse_template_node ()

glTemplate* gl_xml_template_parse_template_node
                                            (const xmlNodePtr template_node);

Read a single glabels template from a libxml xmlNodePtr node.

template_node : libxml xmlNodePtr template node from a xmlDocPtr tree.
Returns : a pointer to a newly created glTemplate structure.

gl_xml_template_write_templates_to_file ()

void        gl_xml_template_write_templates_to_file
                                            (GList *templates,
                                             const gchar *utf8_filename);

Write a list of glTemplate structures to a glabels XML template file.

templates : List of glTemplate structures
utf8_filename : Filename of templates file (name encoded as UTF-8)

gl_xml_template_write_template_to_file ()

void        gl_xml_template_write_template_to_file
                                            (const glTemplate *template,
                                             const gchar *utf8_filename);

Write a single glTemplate structures to a glabels XML template file.

template : glTemplate structure to be written
utf8_filename : Filename of templates file (name encoded as UTF-8)

gl_xml_template_create_templates_doc ()

xmlDocPtr   gl_xml_template_create_templates_doc
                                            (GList *templates);

templates :
Returns :

gl_xml_template_create_template_node ()

void        gl_xml_template_create_template_node
                                            (const glTemplate *template,
                                             xmlNodePtr root,
                                             const xmlNsPtr ns);

Add a single glTemplate child node to given xmlNodePtr.

template : glTemplate structure to be written
root : parent node to receive new child node
ns : a libxml xmlNsPtr