ps_begin_template(3) [debian man page]

PS_BEGIN_TEMPLATE(3)					     Library Functions Manual					      PS_BEGIN_TEMPLATE(3)

NAME

       PS_begin_template -- Starts a new template

SYNOPSIS

       #include <pslib.h>

       int PS_begin_template(PSDoc *psdoc, float width, float height)

DESCRIPTION

       Starts a new template which must be ended by PS_end_template(3). Templates are similar to macros which can be placed on a page like images.
       Within a template one can call any drawing function. Once a template has been ended by PS_end_template(3) it can be placed  on  a  page	by
       PS_place_image(3). Templates are commonly used for repeating objects like page headers in order to minimize the document size.

       If  image  reuse  is not turned off (since version 0.4.5 of pslib it is always turned on), PS_place_image(3)		may also be called
       within a template in order to include eps or raster images.

RETURN VALUE

       Returns an id for referencing the template.

SEE ALSO

       PS_end_template(3), PS_place_image(3)

AUTHOR

       This manual page was written by Uwe Steinmann uwe@steinmann.cx.

															      PS_BEGIN_TEMPLATE(3)

PS_BEGIN_TEMPLATE(3)							 1						      PS_BEGIN_TEMPLATE(3)

ps_begin_template - Start a new template

SYNOPSIS

       int ps_begin_template (resource	$psdoc, float  $width, float  $height)

DESCRIPTION

	Starts	a new template. A template is called a form in the postscript language. It is created similar to a pattern but used like an image.
       Templates are often used for drawings which are placed several times through out the document, e.g. like a company logo. All drawing  func-
       tions may be used within a template. The template will not be drawn until it is placed by ps_place_image(3).

PARAMETERS

	      o $psdoc
		- Resource identifier of the postscript file as returned by ps_new(3).

	      o $width
		- The width of the template in pixel.

	      o $height
		- The height of the template in pixel.

RETURN VALUES

	Returns TRUE on success or FALSE on failure.

EXAMPLES

       Example #1

	      Creating and using a template

	      <?php
	      $ps = ps_new();

	      if (!ps_open_file($ps, "template.ps")) {
		print "Cannot open PostScript file
";
		exit;
	      }

	      ps_set_parameter($ps, "warning", "true");
	      ps_set_info($ps, "Creator", "template.php");
	      ps_set_info($ps, "Author", "Uwe Steinmann");
	      ps_set_info($ps, "Title", "Template example");

	      $pstemplate = ps_begin_template($ps, 30.0, 30.0);
	      ps_moveto($ps, 0, 0);
	      ps_lineto($ps, 30, 30);
	      ps_moveto($ps, 0, 30);
	      ps_lineto($ps, 30, 0);
	      ps_stroke($ps);
	      ps_end_template($ps);

	      ps_begin_page($ps, 596, 842);
	      ps_place_image($ps, $pstemplate, 20.0, 20.0, 1.0);
	      ps_place_image($ps, $pstemplate, 50.0, 30.0, 0.5);
	      ps_place_image($ps, $pstemplate, 70.0, 70.0, 0.6);
	      ps_place_image($ps, $pstemplate, 30.0, 50.0, 1.3);
	      ps_end_page($ps);

	      ps_close($ps);
	      ps_delete($ps);
	      ?>

SEE ALSO

       ps_end_template(3).

PHP Documentation Group 												      PS_BEGIN_TEMPLATE(3)