+2005-03-23 Jim Evins <evins@snaught.com>
+
+ * INSTALL:
+ Automatically updated.
+ * Makefile.am:
+ * autogen.sh:
+ * configure.in:
+ * docs/Makefile.am:
+ * docs/libglabels/Makefile.am:
+ * docs/libglabels/libglabels-docs.sgml:
+ * docs/libglabels/libglabels-sections.txt:
+ * docs/libglabels/libglabels-undocumented.txt:
+ * docs/libglabels/tmpl/enums.sgml:
+ * docs/libglabels/tmpl/libglabels-unused.sgml:
+ * docs/libglabels/tmpl/libglabels.sgml:
+ * docs/libglabels/tmpl/paper.sgml:
+ * docs/libglabels/tmpl/template.sgml:
+ * docs/libglabels/tmpl/xml-paper.sgml:
+ * docs/libglabels/tmpl/xml-template.sgml:
+ * docs/libglabels/tmpl/xml.sgml:
+ Added basic gtk-doc stuff to support documenting libglabels
+ API.
+ * libglabels/xml.c:
+ Updated function comments with gtk-doc markup.
+ * missing:
+ Removed.
+
2005-03-22 Jim Evins <evins@snaught.com>
Since the development version now requires gtk-2.6/gnome-2.10, I
+Copyright 1994, 1995, 1996, 1999, 2000, 2001, 2002 Free Software
+Foundation, Inc.
+
+ This file is free documentation; the Free Software Foundation gives
+unlimited permission to copy, distribute and modify it.
+
Basic Installation
==================
those values to create a `Makefile' in each directory of the package.
It may also create one or more `.h' files containing system-dependent
definitions. Finally, it creates a shell script `config.status' that
-you can run in the future to recreate the current configuration, a file
-`config.cache' that saves the results of its tests to speed up
-reconfiguring, and a file `config.log' containing compiler output
-(useful mainly for debugging `configure').
+you can run in the future to recreate the current configuration, and a
+file `config.log' containing compiler output (useful mainly for
+debugging `configure').
+
+ It can also use an optional file (typically called `config.cache'
+and enabled with `--cache-file=config.cache' or simply `-C') that saves
+the results of its tests to speed up reconfiguring. (Caching is
+disabled by default to prevent problems with accidental use of stale
+cache files.)
If you need to do unusual things to compile the package, please try
to figure out how `configure' could check whether to do them, and mail
diffs or instructions to the address given in the `README' so they can
-be considered for the next release. If at some point `config.cache'
-contains results you don't want to keep, you may remove or edit it.
+be considered for the next release. If you are using the cache, and at
+some point `config.cache' contains results you don't want to keep, you
+may remove or edit it.
- The file `configure.in' is used to create `configure' by a program
-called `autoconf'. You only need `configure.in' if you want to change
-it or regenerate `configure' using a newer version of `autoconf'.
+ The file `configure.ac' (or `configure.in') is used to create
+`configure' by a program called `autoconf'. You only need
+`configure.ac' if you want to change it or regenerate `configure' using
+a newer version of `autoconf'.
The simplest way to compile this package is:
=====================
Some systems require unusual options for compilation or linking that
-the `configure' script does not know about. You can give `configure'
-initial values for variables by setting them in the environment. Using
-a Bourne-compatible shell, you can do that on the command line like
-this:
- CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
+the `configure' script does not know about. Run `./configure --help'
+for details on some of the pertinent environment variables.
+
+ You can give `configure' initial values for configuration parameters
+by setting variables in the command line or in the environment. Here
+is an example:
-Or on systems that have the `env' program, you can do it like this:
- env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
+ ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
+
+ *Note Defining Variables::, for more details.
Compiling For Multiple Architectures
====================================
the `configure' script. `configure' automatically checks for the
source code in the directory that `configure' is in and in `..'.
- If you have to use a `make' that does not supports the `VPATH'
-variable, you have to compile the package for one architecture at a time
-in the source code directory. After you have installed the package for
-one architecture, use `make distclean' before reconfiguring for another
-architecture.
+ If you have to use a `make' that does not support the `VPATH'
+variable, you have to compile the package for one architecture at a
+time in the source code directory. After you have installed the
+package for one architecture, use `make distclean' before reconfiguring
+for another architecture.
Installation Names
==================
Specifying the System Type
==========================
- There may be some features `configure' can not figure out
-automatically, but needs to determine by the type of host the package
-will run on. Usually `configure' can figure that out, but if it prints
-a message saying it can not guess the host type, give it the
-`--host=TYPE' option. TYPE can either be a short name for the system
-type, such as `sun4', or a canonical name with three fields:
+ There may be some features `configure' cannot figure out
+automatically, but needs to determine by the type of machine the package
+will run on. Usually, assuming the package is built to be run on the
+_same_ architectures, `configure' can figure that out, but if it prints
+a message saying it cannot guess the machine type, give it the
+`--build=TYPE' option. TYPE can either be a short name for the system
+type, such as `sun4', or a canonical name which has the form:
+
CPU-COMPANY-SYSTEM
-See the file `config.sub' for the possible values of each field. If
+where SYSTEM can have one of these forms:
+
+ OS KERNEL-OS
+
+ See the file `config.sub' for the possible values of each field. If
`config.sub' isn't included in this package, then this package doesn't
-need to know the host type.
+need to know the machine type.
- If you are building compiler tools for cross-compiling, you can also
+ If you are _building_ compiler tools for cross-compiling, you should
use the `--target=TYPE' option to select the type of system they will
-produce code for and the `--build=TYPE' option to select the type of
-system on which you are compiling the package.
+produce code for.
+
+ If you want to _use_ a cross compiler, that generates code for a
+platform different from the build platform, you should specify the
+"host" platform (i.e., that on which the generated programs will
+eventually be run) with `--host=TYPE'.
Sharing Defaults
================
`CONFIG_SITE' environment variable to the location of the site script.
A warning: not all `configure' scripts look for a site script.
-Operation Controls
+Defining Variables
==================
+ Variables not defined in a site shell script can be set in the
+environment passed to `configure'. However, some packages may run
+configure again during the build, and the customized values of these
+variables may be lost. In order to avoid this problem, you should set
+them in the `configure' command line, using `VAR=value'. For example:
+
+ ./configure CC=/usr/local2/bin/gcc
+
+will cause the specified gcc to be used as the C compiler (unless it is
+overridden in the site shell script).
+
+`configure' Invocation
+======================
+
`configure' recognizes the following options to control how it
operates.
-`--cache-file=FILE'
- Use and save the results of the tests in FILE instead of
- `./config.cache'. Set FILE to `/dev/null' to disable caching, for
- debugging `configure'.
-
`--help'
+`-h'
Print a summary of the options to `configure', and exit.
+`--version'
+`-V'
+ Print the version of Autoconf used to generate the `configure'
+ script, and exit.
+
+`--cache-file=FILE'
+ Enable the cache: use and save the results of the tests in FILE,
+ traditionally `config.cache'. FILE defaults to `/dev/null' to
+ disable caching.
+
+`--config-cache'
+`-C'
+ Alias for `--cache-file=config.cache'.
+
`--quiet'
`--silent'
`-q'
Look for the package's source code in directory DIR. Usually
`configure' can determine that directory automatically.
-`--version'
- Print the version of Autoconf used to generate the `configure'
- script, and exit.
+`configure' also accepts some other, not widely useful, options. Run
+`configure --help' for more details.
-`configure' also accepts some other, not widely useful, options.
LIB_BARCODE_DIR = barcode-0.98
-SUBDIRS = po $(LIB_BARCODE_DIR) libglabels src data help
+SUBDIRS = po $(LIB_BARCODE_DIR) libglabels src data help docs
EXTRA_DIST = \
README \
test -z "$srcdir" && srcdir=.
PKG_NAME="glabels"
+REQUIRED_AUTOMAKE_VERSION=1.6
(test -f $srcdir/configure.in \
&& test -f $srcdir/autogen.sh) || {
AC_PATH_PROG(GLIB_GENMARSHAL, glib-genmarshal)
+GTK_DOC_CHECK(1.0)
dnl ---------------------------------------------------------------------------
dnl - LIBGLABELS API versioning
po/Makefile.in
help/Makefile
help/C/Makefile
+docs/Makefile
+docs/libglabels/Makefile
glabels.spec
])
--- /dev/null
+## Process this file with automake to produce Makefile.in.
+
+SUBDIRS = libglabels
--- /dev/null
+## Process this file with automake to produce Makefile.in
+
+# We require automake 1.6 at least.
+AUTOMAKE_OPTIONS = 1.6
+
+# This is a blank Makefile.am for using gtk-doc.
+# Copy this to your project's API docs directory and modify the variables to
+# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
+# of using the various options.
+
+# The name of the module, e.g. 'glib'.
+DOC_MODULE=libglabels
+
+# The top-level SGML file. You can change this if you want to.
+DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml
+
+# The directory containing the source code. Relative to $(srcdir).
+# gtk-doc will search all .c & .h files beneath here for inline comments
+# documenting the functions and macros.
+# e.g. DOC_SOURCE_DIR=../../../gtk
+DOC_SOURCE_DIR=../../libglabels
+
+# Extra options to pass to gtkdoc-scangobj. Not normally needed.
+SCANGOBJ_OPTIONS=
+
+# Extra options to supply to gtkdoc-scan.
+# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
+SCAN_OPTIONS=
+
+# Extra options to supply to gtkdoc-mkdb.
+# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml
+MKDB_OPTIONS=--sgml-mode --output-format=xml
+
+# Extra options to supply to gtkdoc-fixref. Not normally needed.
+# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
+FIXXREF_OPTIONS=
+
+# Used for dependencies. The docs will be rebuilt if any of these change.
+# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
+# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
+HFILE_GLOB=
+CFILE_GLOB=
+
+# Header files to ignore when scanning.
+# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
+IGNORE_HFILES=libglabels-private.h
+
+# Images to copy into HTML directory.
+# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
+HTML_IMAGES=
+
+# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
+# e.g. content_files=running.sgml building.sgml changes-2.0.sgml
+content_files=
+
+# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
+# Only needed if you are using gtkdoc-scangobj to dynamically query widget
+# signals and properties.
+# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
+# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
+INCLUDES=
+GTKDOC_LIBS=
+
+# This includes the standard gtk-doc make rules, copied by gtkdocize.
+include $(top_srcdir)/gtk-doc.make
+
+# Other files to distribute
+# e.g. EXTRA_DIST += version.xml.in
+EXTRA_DIST +=
--- /dev/null
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+ "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
+ <bookinfo>
+ <title>LibGlabels Reference Manual</title>
+ </bookinfo>
+
+ <chapter>
+ <title>LibGlabels</title>
+ <xi:include href="xml/enums.xml"/>
+ <xi:include href="xml/paper.xml"/>
+ <xi:include href="xml/template.xml"/>
+ <xi:include href="xml/xml-paper.xml"/>
+ <xi:include href="xml/xml-template.xml"/>
+ <xi:include href="xml/xml.xml"/>
+ </chapter>
+</book>
--- /dev/null
+<SECTION>
+<FILE>enums</FILE>
+glUnitsType
+</SECTION>
+
+<SECTION>
+<FILE>libglabels</FILE>
+</SECTION>
+
+<SECTION>
+<FILE>paper</FILE>
+glPaper
+gl_paper_init
+gl_paper_new
+gl_paper_dup
+gl_paper_free
+gl_paper_get_id_list
+gl_paper_free_id_list
+gl_paper_get_name_list
+gl_paper_free_name_list
+gl_paper_is_id_known
+gl_paper_is_id_other
+gl_paper_from_id
+gl_paper_from_name
+gl_paper_lookup_id_from_name
+gl_paper_lookup_name_from_id
+gl_paper_print_known_papers
+</SECTION>
+
+<SECTION>
+<FILE>template</FILE>
+glTemplate
+glTemplateLabelType
+glTemplateLayout
+glTemplateMarkup
+glTemplateOrigin
+glTemplateLabelShape
+glTemplateMarkupType
+gl_template_init
+gl_template_register
+gl_template_get_name_list
+gl_template_free_name_list
+gl_template_from_name
+gl_template_get_name_with_desc
+gl_template_get_first_label_type
+gl_template_get_label_size
+gl_template_get_n_labels
+gl_template_get_origins
+gl_template_new
+gl_template_add_label_type
+gl_template_add_alias
+gl_template_rect_label_type_new
+gl_template_round_label_type_new
+gl_template_cd_label_type_new
+gl_template_add_layout
+gl_template_add_markup
+gl_template_layout_new
+gl_template_markup_margin_new
+gl_template_markup_line_new
+gl_template_markup_circle_new
+gl_template_dup
+gl_template_free
+gl_template_label_type_dup
+gl_template_label_type_free
+gl_template_layout_dup
+gl_template_layout_free
+gl_template_markup_dup
+gl_template_markup_free
+gl_template_print_known_templates
+gl_template_print_aliases
+</SECTION>
+
+<SECTION>
+<FILE>xml-paper</FILE>
+gl_xml_paper_read_papers_from_file
+gl_xml_paper_parse_papers_doc
+gl_xml_paper_parse_paper_node
+</SECTION>
+
+<SECTION>
+<FILE>xml-template</FILE>
+gl_xml_template_read_templates_from_file
+gl_xml_template_parse_templates_doc
+gl_xml_template_parse_template_node
+gl_xml_template_write_templates_to_file
+gl_xml_template_write_template_to_file
+gl_xml_template_create_templates_doc
+gl_xml_template_create_template_node
+</SECTION>
+
+<SECTION>
+<FILE>xml</FILE>
+gl_xml_get_prop_double
+gl_xml_get_prop_boolean
+gl_xml_get_prop_int
+gl_xml_get_prop_uint
+gl_xml_get_prop_length
+gl_xml_set_prop_double
+gl_xml_set_prop_boolean
+gl_xml_set_prop_int
+gl_xml_set_prop_uint_hex
+gl_xml_set_prop_length
+gl_xml_set_default_units
+</SECTION>
+
--- /dev/null
+14% symbol docs coverage.
+11 symbols documented.
+66 not documented.
+
+
+glPaper
+glTemplate
+glTemplateLabelShape
+glTemplateLabelType
+glTemplateLayout
+glTemplateMarkup
+glTemplateMarkupType
+glTemplateOrigin
+glUnitsType
+gl_paper_dup
+gl_paper_free
+gl_paper_free_id_list
+gl_paper_free_name_list
+gl_paper_from_id
+gl_paper_from_name
+gl_paper_get_id_list
+gl_paper_get_name_list
+gl_paper_init
+gl_paper_is_id_known
+gl_paper_is_id_other
+gl_paper_lookup_id_from_name
+gl_paper_lookup_name_from_id
+gl_paper_new
+gl_paper_print_known_papers
+gl_template_add_alias
+gl_template_add_label_type
+gl_template_add_layout
+gl_template_add_markup
+gl_template_cd_label_type_new
+gl_template_dup
+gl_template_free
+gl_template_free_name_list
+gl_template_from_name
+gl_template_get_first_label_type
+gl_template_get_label_size
+gl_template_get_n_labels
+gl_template_get_name_list
+gl_template_get_name_with_desc
+gl_template_get_origins
+gl_template_init
+gl_template_label_type_dup
+gl_template_label_type_free
+gl_template_layout_dup
+gl_template_layout_free
+gl_template_layout_new
+gl_template_markup_circle_new
+gl_template_markup_dup
+gl_template_markup_free
+gl_template_markup_line_new
+gl_template_markup_margin_new
+gl_template_new
+gl_template_print_aliases
+gl_template_print_known_templates
+gl_template_rect_label_type_new
+gl_template_register
+gl_template_round_label_type_new
+gl_xml_paper_parse_paper_node
+gl_xml_paper_parse_papers_doc
+gl_xml_paper_read_papers_from_file
+gl_xml_template_create_template_node
+gl_xml_template_create_templates_doc
+gl_xml_template_parse_template_node
+gl_xml_template_parse_templates_doc
+gl_xml_template_read_templates_from_file
+gl_xml_template_write_template_to_file
+gl_xml_template_write_templates_to_file
+
--- /dev/null
+<!-- ##### SECTION Title ##### -->
+enums
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### ENUM glUnitsType ##### -->
+<para>
+
+</para>
+
+@GL_UNITS_POINT:
+@GL_UNITS_INCH:
+@GL_UNITS_MM:
+@GL_UNITS_CM:
+@GL_UNITS_PICA:
+@GL_UNITS_FIRST:
+@GL_UNITS_LAST:
+
--- /dev/null
+<!-- ##### MACRO GL_XML_NAME_SPACE ##### -->
+<para>
+
+</para>
+
+
--- /dev/null
+<!-- ##### SECTION Title ##### -->
+libglabels
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
--- /dev/null
+<!-- ##### SECTION Title ##### -->
+paper
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT glPaper ##### -->
+<para>
+
+</para>
+
+@id:
+@name:
+@width:
+@height:
+
+<!-- ##### FUNCTION gl_paper_init ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION gl_paper_new ##### -->
+<para>
+
+</para>
+
+@id:
+@name:
+@width:
+@height:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_paper_dup ##### -->
+<para>
+
+</para>
+
+@orig:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_paper_free ##### -->
+<para>
+
+</para>
+
+@paper:
+
+
+<!-- ##### FUNCTION gl_paper_get_id_list ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION gl_paper_free_id_list ##### -->
+<para>
+
+</para>
+
+@ids:
+
+
+<!-- ##### FUNCTION gl_paper_get_name_list ##### -->
+<para>
+
+</para>
+
+@Returns:
+
+
+<!-- ##### FUNCTION gl_paper_free_name_list ##### -->
+<para>
+
+</para>
+
+@names:
+
+
+<!-- ##### FUNCTION gl_paper_is_id_known ##### -->
+<para>
+
+</para>
+
+@id:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_paper_is_id_other ##### -->
+<para>
+
+</para>
+
+@id:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_paper_from_id ##### -->
+<para>
+
+</para>
+
+@id:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_paper_from_name ##### -->
+<para>
+
+</para>
+
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_paper_lookup_id_from_name ##### -->
+<para>
+
+</para>
+
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_paper_lookup_name_from_id ##### -->
+<para>
+
+</para>
+
+@id:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_paper_print_known_papers ##### -->
+<para>
+
+</para>
+
+
+
--- /dev/null
+<!-- ##### SECTION Title ##### -->
+template
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT glTemplate ##### -->
+<para>
+
+</para>
+
+@name:
+@description:
+@page_size:
+@page_width:
+@page_height:
+@label_types:
+@aliases:
+
+<!-- ##### STRUCT glTemplateLabelType ##### -->
+<para>
+
+</para>
+
+@id:
+@layouts:
+@markups:
+@shape:
+
+<!-- ##### STRUCT glTemplateLayout ##### -->
+<para>
+
+</para>
+
+@nx:
+@ny:
+@x0:
+@y0:
+@dx:
+@dy:
+
+<!-- ##### STRUCT glTemplateMarkup ##### -->
+<para>
+
+</para>
+
+@type:
+
+<!-- ##### STRUCT glTemplateOrigin ##### -->
+<para>
+
+</para>
+
+@x:
+@y:
+
+<!-- ##### ENUM glTemplateLabelShape ##### -->
+<para>
+
+</para>
+
+@GL_TEMPLATE_SHAPE_RECT:
+@GL_TEMPLATE_SHAPE_ROUND:
+@GL_TEMPLATE_SHAPE_CD:
+
+<!-- ##### ENUM glTemplateMarkupType ##### -->
+<para>
+
+</para>
+
+@GL_TEMPLATE_MARKUP_MARGIN:
+@GL_TEMPLATE_MARKUP_LINE:
+@GL_TEMPLATE_MARKUP_CIRCLE:
+
+<!-- ##### FUNCTION gl_template_init ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION gl_template_register ##### -->
+<para>
+
+</para>
+
+@template:
+
+
+<!-- ##### FUNCTION gl_template_get_name_list ##### -->
+<para>
+
+</para>
+
+@page_size:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_free_name_list ##### -->
+<para>
+
+</para>
+
+@names:
+
+
+<!-- ##### FUNCTION gl_template_from_name ##### -->
+<para>
+
+</para>
+
+@name:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_get_name_with_desc ##### -->
+<para>
+
+</para>
+
+@template:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_get_first_label_type ##### -->
+<para>
+
+</para>
+
+@template:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_get_label_size ##### -->
+<para>
+
+</para>
+
+@label_type:
+@w:
+@h:
+
+
+<!-- ##### FUNCTION gl_template_get_n_labels ##### -->
+<para>
+
+</para>
+
+@label_type:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_get_origins ##### -->
+<para>
+
+</para>
+
+@label_type:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_new ##### -->
+<para>
+
+</para>
+
+@name:
+@description:
+@page_size:
+@page_width:
+@page_height:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_add_label_type ##### -->
+<para>
+
+</para>
+
+@template:
+@label_type:
+
+
+<!-- ##### FUNCTION gl_template_add_alias ##### -->
+<para>
+
+</para>
+
+@template:
+@alias:
+
+
+<!-- ##### FUNCTION gl_template_rect_label_type_new ##### -->
+<para>
+
+</para>
+
+@id:
+@w:
+@h:
+@r:
+@x_waste:
+@y_waste:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_round_label_type_new ##### -->
+<para>
+
+</para>
+
+@id:
+@r:
+@waste:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_cd_label_type_new ##### -->
+<para>
+
+</para>
+
+@id:
+@r1:
+@r2:
+@w:
+@h:
+@waste:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_add_layout ##### -->
+<para>
+
+</para>
+
+@label_type:
+@layout:
+
+
+<!-- ##### FUNCTION gl_template_add_markup ##### -->
+<para>
+
+</para>
+
+@label_type:
+@markup:
+
+
+<!-- ##### FUNCTION gl_template_layout_new ##### -->
+<para>
+
+</para>
+
+@nx:
+@ny:
+@x0:
+@y0:
+@dx:
+@dy:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_markup_margin_new ##### -->
+<para>
+
+</para>
+
+@size:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_markup_line_new ##### -->
+<para>
+
+</para>
+
+@x1:
+@y1:
+@x2:
+@y2:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_markup_circle_new ##### -->
+<para>
+
+</para>
+
+@x0:
+@y0:
+@r:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_dup ##### -->
+<para>
+
+</para>
+
+@orig:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_free ##### -->
+<para>
+
+</para>
+
+@template:
+
+
+<!-- ##### FUNCTION gl_template_label_type_dup ##### -->
+<para>
+
+</para>
+
+@orig_ltype:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_label_type_free ##### -->
+<para>
+
+</para>
+
+@ltype:
+
+
+<!-- ##### FUNCTION gl_template_layout_dup ##### -->
+<para>
+
+</para>
+
+@orig_layout:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_layout_free ##### -->
+<para>
+
+</para>
+
+@layout:
+
+
+<!-- ##### FUNCTION gl_template_markup_dup ##### -->
+<para>
+
+</para>
+
+@orig_markup:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_template_markup_free ##### -->
+<para>
+
+</para>
+
+@markup:
+
+
+<!-- ##### FUNCTION gl_template_print_known_templates ##### -->
+<para>
+
+</para>
+
+
+
+<!-- ##### FUNCTION gl_template_print_aliases ##### -->
+<para>
+
+</para>
+
+@template:
+
+
--- /dev/null
+<!-- ##### SECTION Title ##### -->
+xml-paper
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION gl_xml_paper_read_papers_from_file ##### -->
+<para>
+
+</para>
+
+@utf8_filename:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_xml_paper_parse_papers_doc ##### -->
+<para>
+
+</para>
+
+@papers_doc:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_xml_paper_parse_paper_node ##### -->
+<para>
+
+</para>
+
+@paper_node:
+@Returns:
+
+
--- /dev/null
+<!-- ##### SECTION Title ##### -->
+xml-template
+
+<!-- ##### SECTION Short_Description ##### -->
+
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION gl_xml_template_read_templates_from_file ##### -->
+<para>
+
+</para>
+
+@utf8_filename:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_xml_template_parse_templates_doc ##### -->
+<para>
+
+</para>
+
+@templates_doc:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_xml_template_parse_template_node ##### -->
+<para>
+
+</para>
+
+@template_node:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_xml_template_write_templates_to_file ##### -->
+<para>
+
+</para>
+
+@templates:
+@utf8_filename:
+
+
+<!-- ##### FUNCTION gl_xml_template_write_template_to_file ##### -->
+<para>
+
+</para>
+
+@template:
+@utf8_filename:
+
+
+<!-- ##### FUNCTION gl_xml_template_create_templates_doc ##### -->
+<para>
+
+</para>
+
+@templates:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_xml_template_create_template_node ##### -->
+<para>
+
+</para>
+
+@template:
+@root:
+@ns:
+
+
--- /dev/null
+<!-- ##### SECTION Title ##### -->
+XML Helper Functions
+
+<!-- ##### SECTION Short_Description ##### -->
+Functions to help format and parse glabels XML properties
+
+<!-- ##### SECTION Long_Description ##### -->
+<para>
+This section describes a number of "helper" functions for formatting and
+parsing various types of properties for tags in glabels XML file formats.
+</para>
+<para>
+These functions are basically wrappers to functions from libxml2.
+</para>
+
+<!-- ##### SECTION See_Also ##### -->
+<para>
+
+</para>
+
+<!-- ##### FUNCTION gl_xml_get_prop_double ##### -->
+<para>
+
+</para>
+
+@node:
+@property:
+@default_val:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_xml_get_prop_boolean ##### -->
+<para>
+
+</para>
+
+@node:
+@property:
+@default_val:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_xml_get_prop_int ##### -->
+<para>
+
+</para>
+
+@node:
+@property:
+@default_val:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_xml_get_prop_uint ##### -->
+<para>
+
+</para>
+
+@node:
+@property:
+@default_val:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_xml_get_prop_length ##### -->
+<para>
+
+</para>
+
+@node:
+@property:
+@default_val:
+@Returns:
+
+
+<!-- ##### FUNCTION gl_xml_set_prop_double ##### -->
+<para>
+
+</para>
+
+@node:
+@property:
+@val:
+
+
+<!-- ##### FUNCTION gl_xml_set_prop_boolean ##### -->
+<para>
+
+</para>
+
+@node:
+@property:
+@val:
+
+
+<!-- ##### FUNCTION gl_xml_set_prop_int ##### -->
+<para>
+
+</para>
+
+@node:
+@property:
+@val:
+
+
+<!-- ##### FUNCTION gl_xml_set_prop_uint_hex ##### -->
+<para>
+
+</para>
+
+@node:
+@property:
+@val:
+
+
+<!-- ##### FUNCTION gl_xml_set_prop_length ##### -->
+<para>
+
+</para>
+
+@node:
+@property:
+@val:
+
+
+<!-- ##### FUNCTION gl_xml_set_default_units ##### -->
+<para>
+
+</para>
+
+@units:
+
+
static glUnitsType default_units = GL_UNITS_POINT;
-/*========================================================*/
-/* Private function prototypes. */
-/*========================================================*/
-\f
-/****************************************************************************/
-/* Return value of property as a double. */
/****************************************************************************/
+
+/**
+ * gl_xml_get_prop_double:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @default_val: a default value to return if property not found
+ *
+ * Return value of property as a double.
+ *
+ * Returns: the property as a double.
+ *
+ */
gdouble
gl_xml_get_prop_double (xmlNodePtr node,
const gchar *property,
return default_val;
}
-/****************************************************************************/
-/* Return value of property as a boolean. */
-/****************************************************************************/
+
+/**
+ * gl_xml_get_prop_boolean:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @default_val: a default value to return if property not found
+ *
+ * Return value of property as a boolean.
+ *
+ * Returns: the property as a boolean.
+ *
+ */
gboolean
gl_xml_get_prop_boolean (xmlNodePtr node,
const gchar *property,
}
-/****************************************************************************/
-/* Return value of property as an int. . */
-/****************************************************************************/
+/**
+ * gl_xml_get_prop_int:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @default_val: a default value to return if property not found
+ *
+ * Return value of property as an integer.
+ *
+ * Returns: the property as an integer.
+ *
+ */
gint
gl_xml_get_prop_int (xmlNodePtr node,
const gchar *property,
}
-/****************************************************************************/
-/* Return value of hex property as an unsigned int. */
-/****************************************************************************/
+/**
+ * gl_xml_get_prop_uint:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @default_val: a default value to return if property not found
+ *
+ * Return value of property (usually formatted in hex) as an unsigned integer.
+ *
+ * Returns: the property as an unsigned integer.
+ *
+ */
guint
gl_xml_get_prop_uint (xmlNodePtr node,
const gchar *property,
}
-/****************************************************************************/
-/* Return value of length property as a double, converting to internal units*/
-/****************************************************************************/
+/**
+ * gl_xml_get_prop_length:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @default_val: a default value to return if property not found
+ *
+ * Return value of a length property as a double, converting to internal
+ * units (points). The property is expected to be formatted as a number
+ * followed by a units string. If there is no units string, the length
+ * is assumed to be in points. Valid units strings are "pt" for points,
+ * "in" for inches, "mm" for millimeters, "cm" for centimeters, and
+ * "pc" for picas.
+ *
+ * Returns: the length in points.
+ *
+ */
gdouble
gl_xml_get_prop_length (xmlNodePtr node,
const gchar *property,
return default_val;
}
-/****************************************************************************/
-/* Set property from double. */
-/****************************************************************************/
+
+/**
+ * gl_xml_set_prop_double:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @val: the value to set
+ *
+ * Set a property from a double.
+ *
+ */
void
gl_xml_set_prop_double (xmlNodePtr node,
const gchar *property,
xmlSetProp (node, property, string);
}
-/****************************************************************************/
-/* Set property from boolean. */
-/****************************************************************************/
+
+/**
+ * gl_xml_set_prop_boolean:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @val: the value to set
+ *
+ * Set a property from a boolean.
+ *
+ */
void
gl_xml_set_prop_boolean (xmlNodePtr node,
const gchar *property,
xmlSetProp (node, property, (val ? "True" : "False"));
}
-/****************************************************************************/
-/* Set property from int. */
-/****************************************************************************/
+/**
+ * gl_xml_set_prop_int:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @val: the value to set
+ *
+ * Set a property from an integer.
+ *
+ */
void
gl_xml_set_prop_int (xmlNodePtr node,
const gchar *property,
g_free (string);
}
-/****************************************************************************/
-/* Set property from uint in hex. */
-/****************************************************************************/
+/**
+ * gl_xml_set_prop_uint_hex:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @val: the value to set
+ *
+ * Set a property from an unsigned integer and format in hex.
+ *
+ */
void
gl_xml_set_prop_uint_hex (xmlNodePtr node,
const gchar *property,
g_free (string);
}
-/****************************************************************************/
-/* Set property from length. */
-/****************************************************************************/
+/**
+ * gl_xml_set_prop_length:
+ * @node: the libxml2 #xmlNodePtr of the node
+ * @property: the property name
+ * @val: the length to set in internal units (points)
+ *
+ * Set a property from a length, performing any necessary conversion.
+ * Length properties are formatted as a number followed by a units string.
+ * The units of the formatted property is determined by the most recent call to
+ * gl_xml_set_default_units().
+ *
+ */
void
gl_xml_set_prop_length (xmlNodePtr node,
const gchar *property,
g_free (string_unit);
}
-/****************************************************************************/
-/* Set default length units. */
-/****************************************************************************/
+/**
+ * gl_xml_set_default_units:
+ * @units: default units selection (#glUnitsType)
+ *
+ * Set the default units when formatting lengths. See
+ * gl_xml_set_prop_length().
+ *
+ */
void
gl_xml_set_default_units (glUnitsType units)
{
+++ /dev/null
-#! /bin/sh
-# Common stub for a few missing GNU programs while installing.
-# Copyright (C) 1996, 1997 Free Software Foundation, Inc.
-# Franc,ois Pinard <pinard@iro.umontreal.ca>, 1996.
-
-# This program is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2, or (at your option)
-# any later version.
-
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-
-# You should have received a copy of the GNU General Public License
-# along with this program; if not, write to the Free Software
-# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
-# 02111-1307, USA.
-
-if test $# -eq 0; then
- echo 1>&2 "Try \`$0 --help' for more information"
- exit 1
-fi
-
-case "$1" in
-
- -h|--h|--he|--hel|--help)
- echo "\
-$0 [OPTION]... PROGRAM [ARGUMENT]...
-
-Handle \`PROGRAM [ARGUMENT]...' for when PROGRAM is missing, or return an
-error status if there is no known handling for PROGRAM.
-
-Options:
- -h, --help display this help and exit
- -v, --version output version information and exit
-
-Supported PROGRAM values:
- aclocal touch file \`aclocal.m4'
- autoconf touch file \`configure'
- autoheader touch file \`config.h.in'
- automake touch all \`Makefile.in' files
- bison create \`y.tab.[ch]', if possible, from existing .[ch]
- flex create \`lex.yy.c', if possible, from existing .c
- lex create \`lex.yy.c', if possible, from existing .c
- makeinfo touch the output file
- yacc create \`y.tab.[ch]', if possible, from existing .[ch]"
- ;;
-
- -v|--v|--ve|--ver|--vers|--versi|--versio|--version)
- echo "missing - GNU libit 0.0"
- ;;
-
- -*)
- echo 1>&2 "$0: Unknown \`$1' option"
- echo 1>&2 "Try \`$0 --help' for more information"
- exit 1
- ;;
-
- aclocal)
- echo 1>&2 "\
-WARNING: \`$1' is missing on your system. You should only need it if
- you modified \`acinclude.m4' or \`configure.in'. You might want
- to install the \`Automake' and \`Perl' packages. Grab them from
- any GNU archive site."
- touch aclocal.m4
- ;;
-
- autoconf)
- echo 1>&2 "\
-WARNING: \`$1' is missing on your system. You should only need it if
- you modified \`configure.in'. You might want to install the
- \`Autoconf' and \`GNU m4' packages. Grab them from any GNU
- archive site."
- touch configure
- ;;
-
- autoheader)
- echo 1>&2 "\
-WARNING: \`$1' is missing on your system. You should only need it if
- you modified \`acconfig.h' or \`configure.in'. You might want
- to install the \`Autoconf' and \`GNU m4' packages. Grab them
- from any GNU archive site."
- files=`sed -n 's/^[ ]*A[CM]_CONFIG_HEADER(\([^)]*\)).*/\1/p' configure.in`
- test -z "$files" && files="config.h"
- touch_files=
- for f in $files; do
- case "$f" in
- *:*) touch_files="$touch_files "`echo "$f" |
- sed -e 's/^[^:]*://' -e 's/:.*//'`;;
- *) touch_files="$touch_files $f.in";;
- esac
- done
- touch $touch_files
- ;;
-
- automake)
- echo 1>&2 "\
-WARNING: \`$1' is missing on your system. You should only need it if
- you modified \`Makefile.am', \`acinclude.m4' or \`configure.in'.
- You might want to install the \`Automake' and \`Perl' packages.
- Grab them from any GNU archive site."
- find . -type f -name Makefile.am -print |
- sed 's/\.am$/.in/' |
- while read f; do touch "$f"; done
- ;;
-
- bison|yacc)
- echo 1>&2 "\
-WARNING: \`$1' is missing on your system. You should only need it if
- you modified a \`.y' file. You may need the \`Bison' package
- in order for those modifications to take effect. You can get
- \`Bison' from any GNU archive site."
- rm -f y.tab.c y.tab.h
- if [ $# -ne 1 ]; then
- eval LASTARG="\${$#}"
- case "$LASTARG" in
- *.y)
- SRCFILE=`echo "$LASTARG" | sed 's/y$/c/'`
- if [ -f "$SRCFILE" ]; then
- cp "$SRCFILE" y.tab.c
- fi
- SRCFILE=`echo "$LASTARG" | sed 's/y$/h/'`
- if [ -f "$SRCFILE" ]; then
- cp "$SRCFILE" y.tab.h
- fi
- ;;
- esac
- fi
- if [ ! -f y.tab.h ]; then
- echo >y.tab.h
- fi
- if [ ! -f y.tab.c ]; then
- echo 'main() { return 0; }' >y.tab.c
- fi
- ;;
-
- lex|flex)
- echo 1>&2 "\
-WARNING: \`$1' is missing on your system. You should only need it if
- you modified a \`.l' file. You may need the \`Flex' package
- in order for those modifications to take effect. You can get
- \`Flex' from any GNU archive site."
- rm -f lex.yy.c
- if [ $# -ne 1 ]; then
- eval LASTARG="\${$#}"
- case "$LASTARG" in
- *.l)
- SRCFILE=`echo "$LASTARG" | sed 's/l$/c/'`
- if [ -f "$SRCFILE" ]; then
- cp "$SRCFILE" lex.yy.c
- fi
- ;;
- esac
- fi
- if [ ! -f lex.yy.c ]; then
- echo 'main() { return 0; }' >lex.yy.c
- fi
- ;;
-
- makeinfo)
- echo 1>&2 "\
-WARNING: \`$1' is missing on your system. You should only need it if
- you modified a \`.texi' or \`.texinfo' file, or any other file
- indirectly affecting the aspect of the manual. The spurious
- call might also be the consequence of using a buggy \`make' (AIX,
- DU, IRIX). You might want to install the \`Texinfo' package or
- the \`GNU make' package. Grab either from any GNU archive site."
- file=`echo "$*" | sed -n 's/.*-o \([^ ]*\).*/\1/p'`
- if test -z "$file"; then
- file=`echo "$*" | sed 's/.* \([^ ]*\) *$/\1/'`
- file=`sed -n '/^@setfilename/ { s/.* \([^ ]*\) *$/\1/; p; q; }' $file`
- fi
- touch $file
- ;;
-
- *)
- echo 1>&2 "\
-WARNING: \`$1' is needed, and you do not seem to have it handy on your
- system. You might have modified some files without having the
- proper tools for further handling them. Check the \`README' file,
- it often tells you about the needed prerequirements for installing
- this package. You may also peek at any GNU archive site, in case
- some other package would contain this missing \`$1' program."
- exit 1
- ;;
-esac
-
-exit 0
projects / glabels / commitdiff