From 12f3f040b340c30188e4953b9f6a51263206f8ab Mon Sep 17 00:00:00 2001 From: Jim Evins Date: Sun, 28 Feb 2010 22:22:48 -0500 Subject: [PATCH] Updated libglabels documentation to support parallel installation --- .gitignore | 20 +++++++++--------- docs/libglabels/Makefile.am | 4 ++-- ...els-docs.sgml => libglabels-3.0-docs.sgml} | 2 +- ...rides.txt => libglabels-3.0-overrides.txt} | 0 ...ctions.txt => libglabels-3.0-sections.txt} | 1 + ...{libglabels.types => libglabels-3.0.types} | 0 ...unused.sgml => libglabels-3.0-unused.sgml} | 0 docs/libglabels/tmpl/template.sgml | 21 ++++++++++++++++--- docs/libglabels/tmpl/units.sgml | 2 +- 9 files changed, 33 insertions(+), 17 deletions(-) rename docs/libglabels/{libglabels-docs.sgml => libglabels-3.0-docs.sgml} (94%) rename docs/libglabels/{libglabels-overrides.txt => libglabels-3.0-overrides.txt} (100%) rename docs/libglabels/{libglabels-sections.txt => libglabels-3.0-sections.txt} (99%) rename docs/libglabels/{libglabels.types => libglabels-3.0.types} (100%) rename docs/libglabels/tmpl/{libglabels-unused.sgml => libglabels-3.0-unused.sgml} (100%) 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-docs.sgml b/docs/libglabels/libglabels-3.0-docs.sgml similarity index 94% rename from docs/libglabels/libglabels-docs.sgml rename to docs/libglabels/libglabels-3.0-docs.sgml index a246139f..9473f36c 100644 --- a/docs/libglabels/libglabels-docs.sgml +++ b/docs/libglabels/libglabels-3.0-docs.sgml @@ -5,7 +5,7 @@ - LibGlabels Reference Manual + LibGlabels 3.0 Reference Manual diff --git a/docs/libglabels/libglabels-overrides.txt b/docs/libglabels/libglabels-3.0-overrides.txt similarity index 100% rename from docs/libglabels/libglabels-overrides.txt rename to docs/libglabels/libglabels-3.0-overrides.txt diff --git a/docs/libglabels/libglabels-sections.txt b/docs/libglabels/libglabels-3.0-sections.txt similarity index 99% rename from docs/libglabels/libglabels-sections.txt rename to docs/libglabels/libglabels-3.0-sections.txt index 3039050c..e6fb32f0 100644 --- a/docs/libglabels/libglabels-sections.txt +++ b/docs/libglabels/libglabels-3.0-sections.txt @@ -54,6 +54,7 @@ lglTemplateFrameShape lglTemplateFrame lglTemplateFrameAll lglTemplateFrameRect +lglTemplateFrameEllipse lglTemplateFrameRound lglTemplateFrameCD diff --git a/docs/libglabels/libglabels.types b/docs/libglabels/libglabels-3.0.types similarity index 100% rename from docs/libglabels/libglabels.types rename to docs/libglabels/libglabels-3.0.types diff --git a/docs/libglabels/tmpl/libglabels-unused.sgml b/docs/libglabels/tmpl/libglabels-3.0-unused.sgml similarity index 100% rename from docs/libglabels/tmpl/libglabels-unused.sgml rename to docs/libglabels/tmpl/libglabels-3.0-unused.sgml 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. -- 2.39.5