Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

wml::des::imgbg(3) [debian man page]

wml::des::imgbg(3)						     EN Tools							wml::des::imgbg(3)

NAME

       wml::des::imgbg - Background Images

SYNOPSIS

	#use wml::des::imgbg

	<: $file = &imgbg($base, $direction, $content, $pixels, $format); :>

	<body ... background=<imgbg [attributes]> ...>

DESCRIPTION

       The usual purpose of this tag is to create a PNG or GIF image containing a background image and to expand to its filename. Its contents is
       specified via the "content" attribute by use of size/color pairs.

ATTRIBUTES

       "base"
	   Usually the created images are named imgbg-xxxxxx.png where "xxxxxx" is the content id of the image.  When you use a "base=foo"
	   attribute, then the resulting files are named foo.imgbg-xxxxxx.png.	Actually you can even use a complete filename including a
	   directory prefix, i.e. when you use "base=../../common/foo" attribute, then the images are created as
	   ../../common/foo.imgbg-xxxxxx.png.

	   And for most flexibility when no base is specified and the variable "BGIMG_BASE" is defined (usually from within a .wmlrc file via
	   "-DBGIMG_BASE~path/to/imgbg/dir/base") it is used.  Use this feature to redirect the created images to a particular directory.

	   You may also use the variable "IMAGE_BASE" which defines in a single line all base names for images generated by WML.

       "format"
	   By default, GIF images are generated. This attribute lets you use an alternate image format (actually only PNG and GIF are recognized).
	   You may also change the default format with the variable "IMAGE_FORMAT".

       "direction"
	   Specifies the color change direction of the image: ``"h"'' for horizontal (default) or ``"v"'' for vertical.

       "pixels"
	   Size of the image in the other direction, 1 by default.

       "content"
	   This is a comma-separated list of size/color specifications ``pixels":#"rrggbb":#"rrggbb":"slices''

	   The last two arguments are optional, only present for gradient images.  In this case, a linear gradient line is drawn from color 1 to
	   color 2, with slices different colors.

	   To get a background with two columns, a black one with 150 point in size and a white one which fills the rest of the page use
	   ``"150:#000000,1200:#ffffff"''.

AUTHORS

	Ralf S. Engelschall
	rse@engelschall.com
	www.engelschall.com

	Denis Barbier
	barbier@engelschall.com

REQUIRES

	Internal: P1, P2, P3

SEE ALSO

       HTML <"body"> tag.

EN Tools							    2014-04-16							wml::des::imgbg(3)

Check Out this Related Man Page

wml::std::box(3)						     EN Tools							  wml::std::box(3)

NAME

       wml::std::box - Easily Create Rectangular Box

SYNOPSIS

	#use wml::std::box

	<box [attributes]>
	...
	</box>

DESCRIPTION

       The "<box>" container tag puts its body into a nice rectangular box which itself is build via a HTML "<table>" construct.

ATTRIBUTES

       "header"
	   This attribute switches between two totally different box variants.	When it is present, a headlined box is created by the use of one
	   single table but with space GIFs. When this attribute is missing a standard box is created by the use of two nested tables but without
	   any space GIFs.

       "bgcolor"
	   This sets the background color of the box.

       "fgcolor"
	   This sets the foreground (text) color of the box.

       "bdcolor"
	   This sets the color for the border of the box. The effect of this attribute is the automatic generation of a nested table construct to
	   achieve the optical effect.

       "bdspace"
	   This sets the space between the border and the body of the box in pixels.  Default is 4 pixel.

       "bdwidth"
	   This sets the border width in pixels. Default is 1 pixel.

       "width"
	   This sets the total table width in pixels. Default is no specific width for the standard box and 300 pixels for the headlined box
	   (because the headlined variant needs to know a fixed size to create the GIFs accordingly).

       "summary"
	   Add a description of this table.  This attribute is recommended in HTML 4.0.

EXAMPLE

	<box bdcolor="#000000" bdwidth=1 bdspace=10
	     bgcolor="#ffffff" fgcolor="#000000">
	Foo Bar Quux
	</box>

	<box header="Foo Bar Quux Header"
	     bdcolor="#000000" bdwidth=1 bdspace=10
	     bgcolor="#ffffff" fgcolor="#000000">
	Foo Bar Quux
	</box>

AUTHOR

	Ralf S. Engelschall
	rse@engelschall.com
	www.engelschall.com

REQUIRES

	Internal: P1, P2

SEE ALSO

       HTML "<table>" tag.

EN Tools							    2014-04-16							  wml::std::box(3)
Man Page