.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "wml::des::imgbg 3"
.TH wml::des::imgbg 3 "2021-05-25" "EN Tools" "EN Tools"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
wml::des::imgbg \- Background Images
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& #use wml::des::imgbg
\&
\& <: $file = &imgbg($base, $direction, $content, $pixels, $format); :>
\&
\& <body ... background=<imgbg [attributes]> ...>
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The usual purpose of this tag is to create a \s-1PNG\s0 or \s-1GIF\s0 image containing
a background image and to expand to its filename. Its contents is
specified via the \f(CW\*(C`content\*(C'\fR attribute by use of size/color pairs.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.ie n .IP """base""" 4
.el .IP "\f(CWbase\fR" 4
.IX Item "base"
Usually the created images are named
\&\fIimgbg\-xxxxxx.png\fR where \f(CW\*(C`xxxxxx\*(C'\fR is the content id of the image.
When you use a
\&\f(CW\*(C`base=foo\*(C'\fR attribute, then the resulting files are named
\&\fIfoo.imgbg\-xxxxxx.png\fR.  Actually you can even use a complete filename
including a directory prefix, i.e. when you use \f(CW\*(C`base=../../common/foo\*(C'\fR
attribute, then the images are created as
\&\fI../../common/foo.imgbg\-xxxxxx.png\fR.
.Sp
And for most flexibility when no base is specified and the variable
\&\f(CW\*(C`BGIMG_BASE\*(C'\fR is defined (usually from within a \fI.wmlrc\fR file via
\&\f(CW\*(C`\-DBGIMG_BASE~path/to/imgbg/dir/base\*(C'\fR) it is used.  Use this feature to
redirect the created images to a particular directory.
.Sp
You may also use the variable \f(CW\*(C`IMAGE_BASE\*(C'\fR which defines in a single line
all base names for images generated by \s-1WML.\s0
.ie n .IP """format""" 4
.el .IP "\f(CWformat\fR" 4
.IX Item "format"
By default, \s-1GIF\s0 images are generated. This attribute lets you use an
alternate image format (actually only \s-1PNG\s0 and \s-1GIF\s0 are recognized).
You may also change the default format with the variable \f(CW\*(C`IMAGE_FORMAT\*(C'\fR.
.ie n .IP """direction""" 4
.el .IP "\f(CWdirection\fR" 4
.IX Item "direction"
Specifies the color change direction of the image: ``\f(CW\*(C`h\*(C'\fR'' for horizontal
(default) or ``\f(CW\*(C`v\*(C'\fR'' for vertical.
.ie n .IP """pixels""" 4
.el .IP "\f(CWpixels\fR" 4
.IX Item "pixels"
Size of the image in the other direction, 1 by default.
.ie n .IP """content""" 4
.el .IP "\f(CWcontent\fR" 4
.IX Item "content"
This is a comma-separated list of size/color specifications
``\fIpixels\fR\f(CW\*(C`:#\*(C'\fR\fIrrggbb\fR\f(CW\*(C`:#\*(C'\fR\fIrrggbb\fR\f(CW\*(C`:\*(C'\fR\fIslices\fR''
.Sp
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 \fIslices\fR different colors.
.Sp
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
``\f(CW\*(C`150:#000000,1200:#ffffff\*(C'\fR''.
.SH "AUTHORS"
.IX Header "AUTHORS"
.Vb 3
\& Ralf S. Engelschall
\& rse@engelschall.com
\& www.engelschall.com
\&
\& Denis Barbier
\& barbier@engelschall.com
.Ve
.SH "REQUIRES"
.IX Header "REQUIRES"
.Vb 1
\& Internal: P1, P2, P3
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1HTML\s0 <\f(CW\*(C`body\*(C'\fR> tag.