From: Jim Evins Date: Mon, 1 Mar 2010 03:22:48 +0000 (-0500) Subject: Updated libglabels documentation to support parallel installation X-Git-Tag: glabels-2_3_0~73 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=12f3f040b340c30188e4953b9f6a51263206f8ab;p=glabels Updated libglabels documentation to support parallel installation --- diff --git a/.gitignore b/.gitignore index ea213aec..a08b931f 100644 --- a/.gitignore +++ b/.gitignore @@ -69,16 +69,16 @@ glabels-*.tar.gz /docs/libglabels/*.stamp /docs/libglabels/xml/ /docs/libglabels/html/ -/docs/libglabels/libglabels-decl.txt -/docs/libglabels/libglabels-decl-list.txt -/docs/libglabels/libglabels-undeclared.txt -/docs/libglabels/libglabels-unused.txt -/docs/libglabels/libglabels-undocumented.txt -/docs/libglabels/libglabels.args -/docs/libglabels/libglabels.hierarchy -/docs/libglabels/libglabels.interfaces -/docs/libglabels/libglabels.prerequisites -/docs/libglabels/libglabels.signals +/docs/libglabels/libglabels*-decl.txt +/docs/libglabels/libglabels*-decl-list.txt +/docs/libglabels/libglabels*-undeclared.txt +/docs/libglabels/libglabels*-unused.txt +/docs/libglabels/libglabels*-undocumented.txt +/docs/libglabels/libglabels*.args +/docs/libglabels/libglabels*.hierarchy +/docs/libglabels/libglabels*.interfaces +/docs/libglabels/libglabels*.prerequisites +/docs/libglabels/libglabels*.signals # # Ignore artifacts from editors, patching, etc. diff --git a/docs/libglabels/Makefile.am b/docs/libglabels/Makefile.am index 28e56fdb..8d5cb87f 100644 --- a/docs/libglabels/Makefile.am +++ b/docs/libglabels/Makefile.am @@ -9,7 +9,7 @@ AUTOMAKE_OPTIONS = 1.6 # of using the various options. # The name of the module, e.g. 'glib'. -DOC_MODULE=libglabels +DOC_MODULE=libglabels-3.0 # The top-level SGML file. You can change this if you want to. DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml @@ -43,7 +43,7 @@ CFILE_GLOB= # Header files to ignore when scanning. # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h -IGNORE_HFILES=libglabels-private.h +IGNORE_HFILES=libglabels-3.0-private.h # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png diff --git a/docs/libglabels/libglabels-3.0-docs.sgml b/docs/libglabels/libglabels-3.0-docs.sgml new file mode 100644 index 00000000..9473f36c --- /dev/null +++ b/docs/libglabels/libglabels-3.0-docs.sgml @@ -0,0 +1,33 @@ + + + + + + + LibGlabels 3.0 Reference Manual + + + + Basic LibGlabels Usage + + + + + + + + Working Directly With LibGlabels XML + + + + + + + + Miscellaneous + + + + + diff --git a/docs/libglabels/libglabels-3.0-overrides.txt b/docs/libglabels/libglabels-3.0-overrides.txt new file mode 100644 index 00000000..e69de29b diff --git a/docs/libglabels/libglabels-3.0-sections.txt b/docs/libglabels/libglabels-3.0-sections.txt new file mode 100644 index 00000000..e6fb32f0 --- /dev/null +++ b/docs/libglabels/libglabels-3.0-sections.txt @@ -0,0 +1,201 @@ +
+db +libglabels/db.h +lglDbRegStatus + +lgl_db_init + +lgl_db_get_paper_id_list +lgl_db_free_paper_id_list +lgl_db_get_paper_name_list +lgl_db_free_paper_name_list +lgl_db_lookup_paper_from_id +lgl_db_lookup_paper_from_name +lgl_db_lookup_paper_id_from_name +lgl_db_lookup_paper_name_from_id +lgl_db_is_paper_id_known +lgl_db_is_paper_id_other + +lgl_db_get_category_id_list +lgl_db_free_category_id_list +lgl_db_get_category_name_list +lgl_db_free_category_name_list +lgl_db_lookup_category_from_id +lgl_db_lookup_category_from_name +lgl_db_lookup_category_id_from_name +lgl_db_lookup_category_name_from_id +lgl_db_is_category_id_known + +lgl_db_get_brand_list +lgl_db_free_brand_list + +lgl_db_register_template +lgl_db_does_template_exist +lgl_db_does_template_name_exist +lgl_db_get_template_name_list_unique +lgl_db_get_template_name_list_all +lgl_db_free_template_name_list +lgl_db_lookup_template_from_name + +lgl_db_print_known_papers +lgl_db_print_known_categories +lgl_db_print_known_templates +lgl_db_print_aliases +
+ +
+template +libglabels/template.h +lglTemplate + +lglTemplateAlias + +lglTemplateFrameShape +lglTemplateFrame +lglTemplateFrameAll +lglTemplateFrameRect +lglTemplateFrameEllipse +lglTemplateFrameRound +lglTemplateFrameCD + +lglTemplateLayout + +lglTemplateMarkupType +lglTemplateMarkup +lglTemplateMarkupMargin +lglTemplateMarkupLine +lglTemplateMarkupCircle +lglTemplateMarkupRect + +lglTemplateOrigin + +lgl_template_new +lgl_template_dup +lgl_template_free +lgl_template_add_category +lgl_template_add_frame +lgl_template_add_alias + +lgl_template_get_name +lgl_template_do_templates_match +lgl_template_does_brand_match +lgl_template_does_page_size_match +lgl_template_does_category_match + +lgl_template_alias_new +lgl_template_alias_dup +lgl_template_alias_free + +lgl_template_frame_rect_new +lgl_template_frame_round_new +lgl_template_frame_cd_new +lgl_template_frame_dup +lgl_template_frame_free +lgl_template_frame_add_layout +lgl_template_frame_add_markup + +lgl_template_frame_get_size +lgl_template_frame_get_n_labels +lgl_template_frame_get_origins + +lgl_template_layout_new +lgl_template_layout_dup +lgl_template_layout_free + +lgl_template_markup_margin_new +lgl_template_markup_line_new +lgl_template_markup_circle_new +lgl_template_markup_rect_new +lgl_template_markup_dup +lgl_template_markup_free +
+ +
+paper +libglabels/paper.h +lglPaper +lgl_paper_new +lgl_paper_dup +lgl_paper_free +
+ +
+category +libglabels/category.h +lglCategory +lgl_category_new +lgl_category_dup +lgl_category_free +
+ +
+xml-paper +libglabels/xml-paper.h +lgl_xml_paper_read_papers_from_file +lgl_xml_paper_parse_papers_doc +lgl_xml_paper_parse_paper_node +
+ +
+xml-category +libglabels/xml-category.h +lgl_xml_category_read_categories_from_file +lgl_xml_category_parse_categories_doc +lgl_xml_category_parse_category_node +
+ +
+xml-template +libglabels/xml-templates.h +lgl_xml_template_read_templates_from_file +lgl_xml_template_parse_templates_doc +lgl_xml_template_parse_template_node +lgl_xml_template_write_templates_to_file +lgl_xml_template_write_template_to_file +lgl_xml_template_create_template_node +
+ +
+xml +libglabels/xml.h +LGL_XML_NAME_SPACE + +lgl_xml_get_prop_string +lgl_xml_get_prop_i18n_string +lgl_xml_get_prop_double +lgl_xml_get_prop_boolean +lgl_xml_get_prop_int +lgl_xml_get_prop_uint +lgl_xml_get_prop_length + +lgl_xml_set_prop_string +lgl_xml_set_prop_double +lgl_xml_set_prop_boolean +lgl_xml_set_prop_int +lgl_xml_set_prop_uint_hex +lgl_xml_set_prop_length + +lgl_xml_is_node +lgl_xml_get_node_content + +lgl_xml_set_default_units +
+ +
+units +libglabels/units.h +lglUnits +lgl_units_get_id +lgl_units_from_id +lgl_units_get_name +lgl_units_from_name +lgl_units_get_points_per_unit +lgl_units_get_units_per_point +
+ +
+str +libglabels/str.h +lgl_str_utf8_casecmp +
+ diff --git a/docs/libglabels/libglabels-3.0.types b/docs/libglabels/libglabels-3.0.types new file mode 100644 index 00000000..e69de29b diff --git a/docs/libglabels/libglabels-docs.sgml b/docs/libglabels/libglabels-docs.sgml deleted file mode 100644 index a246139f..00000000 --- a/docs/libglabels/libglabels-docs.sgml +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - - LibGlabels Reference Manual - - - - Basic LibGlabels Usage - - - - - - - - Working Directly With LibGlabels XML - - - - - - - - Miscellaneous - - - - - diff --git a/docs/libglabels/libglabels-overrides.txt b/docs/libglabels/libglabels-overrides.txt deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/libglabels/libglabels-sections.txt b/docs/libglabels/libglabels-sections.txt deleted file mode 100644 index 3039050c..00000000 --- a/docs/libglabels/libglabels-sections.txt +++ /dev/null @@ -1,200 +0,0 @@ -
-db -libglabels/db.h -lglDbRegStatus - -lgl_db_init - -lgl_db_get_paper_id_list -lgl_db_free_paper_id_list -lgl_db_get_paper_name_list -lgl_db_free_paper_name_list -lgl_db_lookup_paper_from_id -lgl_db_lookup_paper_from_name -lgl_db_lookup_paper_id_from_name -lgl_db_lookup_paper_name_from_id -lgl_db_is_paper_id_known -lgl_db_is_paper_id_other - -lgl_db_get_category_id_list -lgl_db_free_category_id_list -lgl_db_get_category_name_list -lgl_db_free_category_name_list -lgl_db_lookup_category_from_id -lgl_db_lookup_category_from_name -lgl_db_lookup_category_id_from_name -lgl_db_lookup_category_name_from_id -lgl_db_is_category_id_known - -lgl_db_get_brand_list -lgl_db_free_brand_list - -lgl_db_register_template -lgl_db_does_template_exist -lgl_db_does_template_name_exist -lgl_db_get_template_name_list_unique -lgl_db_get_template_name_list_all -lgl_db_free_template_name_list -lgl_db_lookup_template_from_name - -lgl_db_print_known_papers -lgl_db_print_known_categories -lgl_db_print_known_templates -lgl_db_print_aliases -
- -
-template -libglabels/template.h -lglTemplate - -lglTemplateAlias - -lglTemplateFrameShape -lglTemplateFrame -lglTemplateFrameAll -lglTemplateFrameRect -lglTemplateFrameRound -lglTemplateFrameCD - -lglTemplateLayout - -lglTemplateMarkupType -lglTemplateMarkup -lglTemplateMarkupMargin -lglTemplateMarkupLine -lglTemplateMarkupCircle -lglTemplateMarkupRect - -lglTemplateOrigin - -lgl_template_new -lgl_template_dup -lgl_template_free -lgl_template_add_category -lgl_template_add_frame -lgl_template_add_alias - -lgl_template_get_name -lgl_template_do_templates_match -lgl_template_does_brand_match -lgl_template_does_page_size_match -lgl_template_does_category_match - -lgl_template_alias_new -lgl_template_alias_dup -lgl_template_alias_free - -lgl_template_frame_rect_new -lgl_template_frame_round_new -lgl_template_frame_cd_new -lgl_template_frame_dup -lgl_template_frame_free -lgl_template_frame_add_layout -lgl_template_frame_add_markup - -lgl_template_frame_get_size -lgl_template_frame_get_n_labels -lgl_template_frame_get_origins - -lgl_template_layout_new -lgl_template_layout_dup -lgl_template_layout_free - -lgl_template_markup_margin_new -lgl_template_markup_line_new -lgl_template_markup_circle_new -lgl_template_markup_rect_new -lgl_template_markup_dup -lgl_template_markup_free -
- -
-paper -libglabels/paper.h -lglPaper -lgl_paper_new -lgl_paper_dup -lgl_paper_free -
- -
-category -libglabels/category.h -lglCategory -lgl_category_new -lgl_category_dup -lgl_category_free -
- -
-xml-paper -libglabels/xml-paper.h -lgl_xml_paper_read_papers_from_file -lgl_xml_paper_parse_papers_doc -lgl_xml_paper_parse_paper_node -
- -
-xml-category -libglabels/xml-category.h -lgl_xml_category_read_categories_from_file -lgl_xml_category_parse_categories_doc -lgl_xml_category_parse_category_node -
- -
-xml-template -libglabels/xml-templates.h -lgl_xml_template_read_templates_from_file -lgl_xml_template_parse_templates_doc -lgl_xml_template_parse_template_node -lgl_xml_template_write_templates_to_file -lgl_xml_template_write_template_to_file -lgl_xml_template_create_template_node -
- -
-xml -libglabels/xml.h -LGL_XML_NAME_SPACE - -lgl_xml_get_prop_string -lgl_xml_get_prop_i18n_string -lgl_xml_get_prop_double -lgl_xml_get_prop_boolean -lgl_xml_get_prop_int -lgl_xml_get_prop_uint -lgl_xml_get_prop_length - -lgl_xml_set_prop_string -lgl_xml_set_prop_double -lgl_xml_set_prop_boolean -lgl_xml_set_prop_int -lgl_xml_set_prop_uint_hex -lgl_xml_set_prop_length - -lgl_xml_is_node -lgl_xml_get_node_content - -lgl_xml_set_default_units -
- -
-units -libglabels/units.h -lglUnits -lgl_units_get_id -lgl_units_from_id -lgl_units_get_name -lgl_units_from_name -lgl_units_get_points_per_unit -lgl_units_get_units_per_point -
- -
-str -libglabels/str.h -lgl_str_utf8_casecmp -
- diff --git a/docs/libglabels/libglabels.types b/docs/libglabels/libglabels.types deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/libglabels/tmpl/libglabels-3.0-unused.sgml b/docs/libglabels/tmpl/libglabels-3.0-unused.sgml new file mode 100644 index 00000000..628b4aee --- /dev/null +++ b/docs/libglabels/tmpl/libglabels-3.0-unused.sgml @@ -0,0 +1,1557 @@ + + +This section defines enumerations used to interact with libglabels. + + + + + + + + + + +Common enumerations used by libglabels + + + + + + + +Enumerations + + + + + + + + + + + + + + + + + + + + + + + +init + + + + + + + + + + + + + + + + + + + + + + + +libglabels + + + + +This section describes a set of functions for constructing new template structures. + + + + + + + + + + +Functions to help create new templates + + + + + + + +Construction Functions + + + + +This section describes a set of functions to locate pre-defined templates and add templates +to the LibGlabels template database. + + + + + + + + + + +Database of pre-defined templates + + + + + + + +Database + + + + +This section describes miscellaneous template functions. + + + + + + + + + + +Miscellaneous template functions + + + + + + + +Miscellaneous Functions + + + + + + + + + + + + + + + + + + + + + + + +template2 + + + + + + + + + + + + + + + + + + + + + + + +template3 + + + + + + + + + + + + + +@id: +@name: + + + + + + +@id: +@name: +@width: +@height: + + + + + + +@name: +@description: +@page_size: +@page_width: +@page_height: +@categories: +@frames: +@aliases: + + + + + + + + + + + + +@shape: +@id: +@layouts: +@markups: + + + + + + +@shape: +@id: +@layouts: +@markups: +@r1: +@r2: +@w: +@h: +@waste: + + + + + + +@shape: +@id: +@layouts: +@markups: +@w: +@h: +@r: +@x_waste: +@y_waste: + + + + + + +@shape: +@id: +@layouts: +@markups: +@r: +@waste: + + + + + + +@GL_TEMPLATE_FRAME_SHAPE_RECT: +@GL_TEMPLATE_FRAME_SHAPE_ROUND: +@GL_TEMPLATE_FRAME_SHAPE_CD: + + + + + + +@GL_TEMPLATE_SHAPE_RECT: +@GL_TEMPLATE_SHAPE_ROUND: +@GL_TEMPLATE_SHAPE_CD: + + + + + + +@id: +@layouts: +@markups: +@shape: + + + + + + +@nx: +@ny: +@x0: +@y0: +@dx: +@dy: + + + + + + + + + + + + +@type: +@x0: +@y0: +@r: + + + + + + +@type: +@x1: +@y1: +@x2: +@y2: + + + + + + +@type: +@size: + + + + + + +@type: +@x1: +@y1: +@w: +@h: +@r: + + + + + + +@GL_TEMPLATE_MARKUP_MARGIN: +@GL_TEMPLATE_MARKUP_LINE: +@GL_TEMPLATE_MARKUP_CIRCLE: +@GL_TEMPLATE_MARKUP_RECT: + + + + + + +@x: +@y: + + + +Enumerations for the units of length supported by libglabels. Internally +all lengths are in points. Externally libglabels supports points ("pt"), +inches ("in"), millimeters ("mm"), centimeters ("cm"), and picas ("pc"). +These units are identical to the absolute length units supported in +the CSS2 Specification (Section 4.3.2). + + +@GL_UNITS_POINT: +@GL_UNITS_INCH: +@GL_UNITS_MM: +@GL_UNITS_CM: +@GL_UNITS_PICA: +@GL_UNITS_FIRST: +@GL_UNITS_LAST: + + + + + + +@orig: +@Returns: + + + + + + +@category: + + + + + + +@names: + + + + + + +@id: +@Returns: + + + + + + +@name: +@Returns: + + + + + + +@Returns: + + + + + + + + + + + + +@name: +@Returns: + + + + + + +@id: +@Returns: + + + + + + +@id: +@name: +@Returns: + + + + + + +@orig: +@Returns: + + + + + + +@paper: + + + + + + +@ids: + + + + + + +@names: + + + + + + +@id: +@Returns: + + + + + + +@name: +@Returns: + + + + + + +@Returns: + + + + + + +@Returns: + + + + + + + + + + + + +@id: +@Returns: + + + + + + +@id: +@Returns: + + + + + + +@name: +@Returns: + + + + + + +@id: +@Returns: + + + + + + +@id: +@name: +@width: +@height: +@Returns: + + + + + + + + + + + + +@template: +@alias: + + + + + + +@template: +@category: + + + + + + +@template: +@frame: + + + + + + +@template: +@label_type: + + + + + + +@frame: +@layout: + + + + + + +@frame: +@markup: + + + + + + +@id: +@r1: +@r2: +@w: +@h: +@waste: +@Returns: + + + + + + +@template: +@category: +@Returns: + + + + + + +@template: +@page_size: +@Returns: + + + + + + +@orig: +@Returns: + + + + + + +@id: +@r1: +@r2: +@w: +@h: +@waste: +@Returns: + + + + + + +@orig_frame: +@Returns: + + + + + + +@frame: + + + + + + +@frame: +@Returns: + + + + + + +@frame: +@Returns: + + + + + + +@frame: +@w: +@h: + + + + + + +@id: +@w: +@h: +@r: +@x_waste: +@y_waste: +@Returns: + + + + + + +@id: +@r: +@waste: +@Returns: + + + + + + +@template: + + + + + + +@names: + + + + + + +@name: +@Returns: + + + + + + +@template: +@Returns: + + + + + + +@template: +@Returns: + + + + + + +@label_type: +@w: +@h: + + + + + + +@label_type: +@Returns: + + + + + + +@page_size: +@Returns: + + + + + + +@page_size: +@category: +@Returns: + + + + + + +@page_size: +@category: +@Returns: + + + + + + +@template: +@Returns: + + + + + + +@label_type: +@Returns: + + + + + + + + + + + + +@orig_ltype: +@Returns: + + + + + + +@ltype: + + + + + + +@orig_layout: +@Returns: + + + + + + +@layout: + + + + + + +@nx: +@ny: +@x0: +@y0: +@dx: +@dy: +@Returns: + + + + + + +@x0: +@y0: +@r: +@Returns: + + + + + + +@orig_markup: +@Returns: + + + + + + +@markup: + + + + + + +@x1: +@y1: +@x2: +@y2: +@Returns: + + + + + + +@size: +@Returns: + + + + + + +@x1: +@y1: +@w: +@h: +@r: +@Returns: + + + + + + +@name: +@description: +@page_size: +@page_width: +@page_height: +@Returns: + + + + + + +@template: + + + + + + + + + + + + +@id: +@w: +@h: +@r: +@x_waste: +@y_waste: +@Returns: + + + + + + +@template: + + + + + + +@id: +@r: +@waste: +@Returns: + + + + + + +@categories_doc: +@Returns: + + + + + + +@category_node: +@Returns: + + + + + + +@utf8_filename: +@Returns: + + + + + + +@node: +@Returns: + + + + + + +@node: +@property: +@default_val: +@Returns: + + + + + + +@node: +@property: +@default_val: +@Returns: + + + + + + +@node: +@property: +@default_val: +@Returns: + + + + + + +@node: +@property: +@default_val: +@Returns: + + + + + + +@node: +@property: +@default_val: +@Returns: + + + + + + +@node: +@property: +@default_val: +@Returns: + + + + + + +@node: +@property: +@default_val: +@Returns: + + + + + + +@node: +@name: +@Returns: + + + + + + +@paper_node: +@Returns: + + + + + + +@papers_doc: +@Returns: + + + + + + +@utf8_filename: +@Returns: + + + + + + +@units: + + + + + + +@node: +@property: +@val: + + + + + + +@node: +@property: +@val: + + + + + + +@node: +@property: +@val: + + + + + + +@node: +@property: +@val: + + + + + + +@node: +@property: +@val: + + + + + + +@node: +@property: +@val: + + + + + + +@template: +@root: +@ns: + + + + + + +@templates: +@Returns: + + + + + + +@template_node: +@Returns: + + + + + + +@templates_doc: +@Returns: + + + + + + +@utf8_filename: +@Returns: + + + + + + +@template: +@utf8_filename: + + + + + + +@templates: +@utf8_filename: + + + +This enumeration defines a set of units of distance supported by the libglabels XML distance +attributes. + + +@LGL_UNITS_POINT: Points. Encoded as "pt" in XML distance attributes. +@LGL_UNITS_INCH: Inches. Encoded as "in" in XML distance attributes. +@LGL_UNITS_MM: Millmeters. Encoded as "mm" in XML distance attributes. +@LGL_UNITS_CM: Centimeters. Encoded as "cm" in XML distance attributes. +@LGL_UNITS_PICA: Picas. Encoded as "pc" in XML distance attributes. +@LGL_UNITS_FIRST: First enumeration. Used for generic iteration through supported units.. +@LGL_UNITS_LAST: Last enumeration. Used for generic iteration through supported units. + + + + + + +@ids: + + + + + + +@names: + + + + + + +@id: +@Returns: + + + + + + +@name: +@Returns: + + + + + + +@Returns: + + + + + + +@Returns: + + + + + + + + + + + + +@name: +@Returns: + + + + + + +@id: +@Returns: + + + + + + + + + + + + +@ids: + + + + + + +@names: + + + + + + +@id: +@Returns: + + + + + + +@name: +@Returns: + + + + + + +@Returns: + + + + + + +@Returns: + + + + + + + + + + + + +@id: +@Returns: + + + + + + +@id: +@Returns: + + + + + + +@name: +@Returns: + + + + + + +@id: +@Returns: + + + + + + + + + + + + +@frame: +@layout: + + + + + + +@frame: +@markup: + + + + + + +@brands: + + + + + + +@names: + + + + + + +@name: +@Returns: + + + + + + +@page_size: +@category: +@Returns: + + + + + + +@template: +@Returns: + + + + + + +@brand: +@page_size: +@category: +@Returns: + + + + + + +@brand: +@page_size: +@category: +@Returns: + + + + + + + + + + + + +@template: + + + + + + + + + + + + +@template: + + + + + + +@templates: +@Returns: + diff --git a/docs/libglabels/tmpl/libglabels-unused.sgml b/docs/libglabels/tmpl/libglabels-unused.sgml deleted file mode 100644 index 628b4aee..00000000 --- a/docs/libglabels/tmpl/libglabels-unused.sgml +++ /dev/null @@ -1,1557 +0,0 @@ - - -This section defines enumerations used to interact with libglabels. - - - - - - - - - - -Common enumerations used by libglabels - - - - - - - -Enumerations - - - - - - - - - - - - - - - - - - - - - - - -init - - - - - - - - - - - - - - - - - - - - - - - -libglabels - - - - -This section describes a set of functions for constructing new template structures. - - - - - - - - - - -Functions to help create new templates - - - - - - - -Construction Functions - - - - -This section describes a set of functions to locate pre-defined templates and add templates -to the LibGlabels template database. - - - - - - - - - - -Database of pre-defined templates - - - - - - - -Database - - - - -This section describes miscellaneous template functions. - - - - - - - - - - -Miscellaneous template functions - - - - - - - -Miscellaneous Functions - - - - - - - - - - - - - - - - - - - - - - - -template2 - - - - - - - - - - - - - - - - - - - - - - - -template3 - - - - - - - - - - - - - -@id: -@name: - - - - - - -@id: -@name: -@width: -@height: - - - - - - -@name: -@description: -@page_size: -@page_width: -@page_height: -@categories: -@frames: -@aliases: - - - - - - - - - - - - -@shape: -@id: -@layouts: -@markups: - - - - - - -@shape: -@id: -@layouts: -@markups: -@r1: -@r2: -@w: -@h: -@waste: - - - - - - -@shape: -@id: -@layouts: -@markups: -@w: -@h: -@r: -@x_waste: -@y_waste: - - - - - - -@shape: -@id: -@layouts: -@markups: -@r: -@waste: - - - - - - -@GL_TEMPLATE_FRAME_SHAPE_RECT: -@GL_TEMPLATE_FRAME_SHAPE_ROUND: -@GL_TEMPLATE_FRAME_SHAPE_CD: - - - - - - -@GL_TEMPLATE_SHAPE_RECT: -@GL_TEMPLATE_SHAPE_ROUND: -@GL_TEMPLATE_SHAPE_CD: - - - - - - -@id: -@layouts: -@markups: -@shape: - - - - - - -@nx: -@ny: -@x0: -@y0: -@dx: -@dy: - - - - - - - - - - - - -@type: -@x0: -@y0: -@r: - - - - - - -@type: -@x1: -@y1: -@x2: -@y2: - - - - - - -@type: -@size: - - - - - - -@type: -@x1: -@y1: -@w: -@h: -@r: - - - - - - -@GL_TEMPLATE_MARKUP_MARGIN: -@GL_TEMPLATE_MARKUP_LINE: -@GL_TEMPLATE_MARKUP_CIRCLE: -@GL_TEMPLATE_MARKUP_RECT: - - - - - - -@x: -@y: - - - -Enumerations for the units of length supported by libglabels. Internally -all lengths are in points. Externally libglabels supports points ("pt"), -inches ("in"), millimeters ("mm"), centimeters ("cm"), and picas ("pc"). -These units are identical to the absolute length units supported in -the CSS2 Specification (Section 4.3.2). - - -@GL_UNITS_POINT: -@GL_UNITS_INCH: -@GL_UNITS_MM: -@GL_UNITS_CM: -@GL_UNITS_PICA: -@GL_UNITS_FIRST: -@GL_UNITS_LAST: - - - - - - -@orig: -@Returns: - - - - - - -@category: - - - - - - -@names: - - - - - - -@id: -@Returns: - - - - - - -@name: -@Returns: - - - - - - -@Returns: - - - - - - - - - - - - -@name: -@Returns: - - - - - - -@id: -@Returns: - - - - - - -@id: -@name: -@Returns: - - - - - - -@orig: -@Returns: - - - - - - -@paper: - - - - - - -@ids: - - - - - - -@names: - - - - - - -@id: -@Returns: - - - - - - -@name: -@Returns: - - - - - - -@Returns: - - - - - - -@Returns: - - - - - - - - - - - - -@id: -@Returns: - - - - - - -@id: -@Returns: - - - - - - -@name: -@Returns: - - - - - - -@id: -@Returns: - - - - - - -@id: -@name: -@width: -@height: -@Returns: - - - - - - - - - - - - -@template: -@alias: - - - - - - -@template: -@category: - - - - - - -@template: -@frame: - - - - - - -@template: -@label_type: - - - - - - -@frame: -@layout: - - - - - - -@frame: -@markup: - - - - - - -@id: -@r1: -@r2: -@w: -@h: -@waste: -@Returns: - - - - - - -@template: -@category: -@Returns: - - - - - - -@template: -@page_size: -@Returns: - - - - - - -@orig: -@Returns: - - - - - - -@id: -@r1: -@r2: -@w: -@h: -@waste: -@Returns: - - - - - - -@orig_frame: -@Returns: - - - - - - -@frame: - - - - - - -@frame: -@Returns: - - - - - - -@frame: -@Returns: - - - - - - -@frame: -@w: -@h: - - - - - - -@id: -@w: -@h: -@r: -@x_waste: -@y_waste: -@Returns: - - - - - - -@id: -@r: -@waste: -@Returns: - - - - - - -@template: - - - - - - -@names: - - - - - - -@name: -@Returns: - - - - - - -@template: -@Returns: - - - - - - -@template: -@Returns: - - - - - - -@label_type: -@w: -@h: - - - - - - -@label_type: -@Returns: - - - - - - -@page_size: -@Returns: - - - - - - -@page_size: -@category: -@Returns: - - - - - - -@page_size: -@category: -@Returns: - - - - - - -@template: -@Returns: - - - - - - -@label_type: -@Returns: - - - - - - - - - - - - -@orig_ltype: -@Returns: - - - - - - -@ltype: - - - - - - -@orig_layout: -@Returns: - - - - - - -@layout: - - - - - - -@nx: -@ny: -@x0: -@y0: -@dx: -@dy: -@Returns: - - - - - - -@x0: -@y0: -@r: -@Returns: - - - - - - -@orig_markup: -@Returns: - - - - - - -@markup: - - - - - - -@x1: -@y1: -@x2: -@y2: -@Returns: - - - - - - -@size: -@Returns: - - - - - - -@x1: -@y1: -@w: -@h: -@r: -@Returns: - - - - - - -@name: -@description: -@page_size: -@page_width: -@page_height: -@Returns: - - - - - - -@template: - - - - - - - - - - - - -@id: -@w: -@h: -@r: -@x_waste: -@y_waste: -@Returns: - - - - - - -@template: - - - - - - -@id: -@r: -@waste: -@Returns: - - - - - - -@categories_doc: -@Returns: - - - - - - -@category_node: -@Returns: - - - - - - -@utf8_filename: -@Returns: - - - - - - -@node: -@Returns: - - - - - - -@node: -@property: -@default_val: -@Returns: - - - - - - -@node: -@property: -@default_val: -@Returns: - - - - - - -@node: -@property: -@default_val: -@Returns: - - - - - - -@node: -@property: -@default_val: -@Returns: - - - - - - -@node: -@property: -@default_val: -@Returns: - - - - - - -@node: -@property: -@default_val: -@Returns: - - - - - - -@node: -@property: -@default_val: -@Returns: - - - - - - -@node: -@name: -@Returns: - - - - - - -@paper_node: -@Returns: - - - - - - -@papers_doc: -@Returns: - - - - - - -@utf8_filename: -@Returns: - - - - - - -@units: - - - - - - -@node: -@property: -@val: - - - - - - -@node: -@property: -@val: - - - - - - -@node: -@property: -@val: - - - - - - -@node: -@property: -@val: - - - - - - -@node: -@property: -@val: - - - - - - -@node: -@property: -@val: - - - - - - -@template: -@root: -@ns: - - - - - - -@templates: -@Returns: - - - - - - -@template_node: -@Returns: - - - - - - -@templates_doc: -@Returns: - - - - - - -@utf8_filename: -@Returns: - - - - - - -@template: -@utf8_filename: - - - - - - -@templates: -@utf8_filename: - - - -This enumeration defines a set of units of distance supported by the libglabels XML distance -attributes. - - -@LGL_UNITS_POINT: Points. Encoded as "pt" in XML distance attributes. -@LGL_UNITS_INCH: Inches. Encoded as "in" in XML distance attributes. -@LGL_UNITS_MM: Millmeters. Encoded as "mm" in XML distance attributes. -@LGL_UNITS_CM: Centimeters. Encoded as "cm" in XML distance attributes. -@LGL_UNITS_PICA: Picas. Encoded as "pc" in XML distance attributes. -@LGL_UNITS_FIRST: First enumeration. Used for generic iteration through supported units.. -@LGL_UNITS_LAST: Last enumeration. Used for generic iteration through supported units. - - - - - - -@ids: - - - - - - -@names: - - - - - - -@id: -@Returns: - - - - - - -@name: -@Returns: - - - - - - -@Returns: - - - - - - -@Returns: - - - - - - - - - - - - -@name: -@Returns: - - - - - - -@id: -@Returns: - - - - - - - - - - - - -@ids: - - - - - - -@names: - - - - - - -@id: -@Returns: - - - - - - -@name: -@Returns: - - - - - - -@Returns: - - - - - - -@Returns: - - - - - - - - - - - - -@id: -@Returns: - - - - - - -@id: -@Returns: - - - - - - -@name: -@Returns: - - - - - - -@id: -@Returns: - - - - - - - - - - - - -@frame: -@layout: - - - - - - -@frame: -@markup: - - - - - - -@brands: - - - - - - -@names: - - - - - - -@name: -@Returns: - - - - - - -@page_size: -@category: -@Returns: - - - - - - -@template: -@Returns: - - - - - - -@brand: -@page_size: -@category: -@Returns: - - - - - - -@brand: -@page_size: -@category: -@Returns: - - - - - - - - - - - - -@template: - - - - - - - - - - - - -@template: - - - - - - -@templates: -@Returns: - diff --git a/docs/libglabels/tmpl/template.sgml b/docs/libglabels/tmpl/template.sgml index 2b8ef732..ae363e42 100644 --- a/docs/libglabels/tmpl/template.sgml +++ b/docs/libglabels/tmpl/template.sgml @@ -24,14 +24,14 @@ This is the main structure of a libglabels template. A template represents a si of peel-off labels or cards. -@brand: Brand name of label or card. E.g. "Avery." +@brand: Vendor or brand name of label or card. E.g. "Avery." @part: Part name or number of label or card. E.g. "8160." -@equiv_part: +@equiv_part: Part name or number of a part with identical layout. Must be from same vendor. @description: A description of the template. E.g. "Mailing labels." @paper_id: A paper ID. E.g. "A4" or "US-Letter." @page_width: Page width in points. Used only if paper_id is "Other." @page_height: Page height in points. Used only if paper_id is "Other." -@product_url: +@product_url: URL to a webpage describing product. @category_ids: A list of category IDs that this template belongs to. @frames: A list of (#lglTemplateFrame *) structures. GLabels currently only supports one frame per template -- future versions may support multiple frames per template. @@ -53,6 +53,7 @@ This enumeration defines frame types that are supported by libglabels @LGL_TEMPLATE_FRAME_SHAPE_RECT: A rectangular frame. (May have rounded corners.) +@LGL_TEMPLATE_FRAME_SHAPE_ELLIPSE: An elliptical frame. @LGL_TEMPLATE_FRAME_SHAPE_ROUND: A round frame. @LGL_TEMPLATE_FRAME_SHAPE_CD: A CD or DVD frame. (Includes credit-card style CDs.) @@ -91,6 +92,19 @@ This structure defines the frame for a rectangular label or card. @x_waste: Amount of horizontal over-print to allow in points. @y_waste: Amount of vertical over-print to allow in points. + + +This structure defines the frame for an elliptical label or card. + + +@shape: Common field. Always #LGL_TEMPLATE_FRAME_SHAPE_ELLIPSE for #lglTemplateFrameEllipse. +@id: Common field. See #lglTemplateFrameAll. +@layouts: Common field. See #lglTemplateFrameAll. +@markups: Common field. See #lglTemplateFrameAll. +@w: Width of label or card in points. +@h: Height of label or card in points. +@waste: Amount of over-print to allow in points. + This structure defines the frame for a round label or card. @@ -144,6 +158,7 @@ This enumeration defines markup types that are supported by libglabels @LGL_TEMPLATE_MARKUP_LINE: A simple line segment. @LGL_TEMPLATE_MARKUP_CIRCLE: A circle. @LGL_TEMPLATE_MARKUP_RECT: A rectangle. Possibly with rounded corners. +@LGL_TEMPLATE_MARKUP_ELLIPSE: An ellipse. diff --git a/docs/libglabels/tmpl/units.sgml b/docs/libglabels/tmpl/units.sgml index bcb7b292..e87eb840 100644 --- a/docs/libglabels/tmpl/units.sgml +++ b/docs/libglabels/tmpl/units.sgml @@ -6,7 +6,7 @@ Type to represent units of distance supported by libglabels -This section defines a type to represent the varios units of distance +This section defines a type to represent the various units of distance supported by libglabels. It also defines a set of related functions.