<HTML>
<HEAD>
<TITLE>Portable Presenter; Decorations</TITLE>
<BODY BGCOLOR=#FFFFFF TEXT=#000000>
<TABLE WIDTH=100%>
<TR><TD WIDTH=15% VALIGN=top><IMG SRC=../images/ppresenter.png WIDTH=150 HEIGHT=170></TD>
<TD ALIGN=center><H1>Decorations</H1></TD></TR>
<TR><TD VALIGN=top>
<A HREF=../index.html>PPresenter</A><BR>
<A HREF=../manual.html>Manual</A><BR>
<B>Decoration</B><BR>
<UL>
<LI><A HREF=solid.html>Solid</A>
<LI><A HREF=lines1.html>Lines1</A>
</UL>
<P>
<A HREF=#options>Options</A><BR>
<A HREF=#function>Functions</A><BR>
<P>
</TD><TD VALIGN=top>
<A HREF=../../index.html>Portable Presenter</A> has a few modules
which descibe how to decorate a slide.
<P>
<I>Decoration</I> describes the background (colours and images) and
foreground-colours of the slide. The defaults are influenced by the
device-type of the <A HREF=../viewport/index.html>viewport</A>.
<P>
For the moment, there are only two different decorations defined:
<UL>
<LI><A HREF=solid.html>Solid</A>: no decoration at all.
<LI><A HREF=lines1.html>Lines1</A>: simple decoration with a place for
a (company-)logo.
</UL>
<H2><A NAME=options>General Decoration Options</A></H2>
A <I>percentage</I> is a value between <CODE>0</CODE> and <CODE>1</CODE>
or a string between <CODE>'0%'</CODE> and <CODE>'100%'</CODE>.
<P>
All decorations share these options, although the default may vary:
(the default-values described here are the defaults for the defaults. Does
that make sense?)
<DL>
<DT><B>-backgroundBounds => [ </B> <I>left, top, right, bottom</I> <B>]</B>
<DD>Limits the action-space of <A HREF=../template/default.html>templates</A>.
The values specify the <I>percentage</I> of the screen which should be
left empty.<BR>
A percentage can be specified as <CODE>'2.5%'</CODE> or <CODE>0.025</CODE>.
<P>
<DT><B>-backdrop =></B> <I>boolean</I>
<DD>Backdrop is a slidely shifted character behind the real character. The
use of backdrop improves the readability of text on poor displaying
hardware, as TV-screens.
<P>
You can set backdrop on for the whole slide (or show) with this option,
or use the <CODE>BD</CODE> tag in the
<A HREF=../formatter/markup.html>markup formatter</A>.
<P>
<DT><B>-fgcolor =></B> <I>color</I>
<DT><B>-bgcolor =></B> <I>color</I>
<DT><B>-bdcolor =></B> <I>color</I>
<DD>The <CODE>bgcolor</CODE> defines the solid color of the background.
<CODE>fgcolor</CODE> contains the default color of the foreground
--the color of the text. <CODE>bdcolor</CODE> is the backdrop color.
These values overrule the device dependent defaults.
<P>
<DT><B>-nestImages => [ </B> <I>geometry, image, ... </I> <B>]</B>
<DD>List of images to be used in unordered-lists
(as created by a <A HREF=../formatter/index.html>formatter</A>)
<P>
The color and shape of the images used may change with the images on the
background and the colors for the foreground, so are defined in
this style-element.
<P>
When you specify a geometry, you can specify a list of image-names,
filenames, or
<A HREF=../image/magick.html>PPresenter::<WBR>Image::Magick</A> objects.
<A HREF=../image/tkphoto.html>PPresenter::<WBR>Image::tkPhoto</A> objects
are not allowed, because they are already scaled on definition.
<P>
When the geometry is <CODE>undef</CODE> then the list can contain
image-names, filenames, and
<A HREF=../image/index.html>PPresenter::Image</A> objects. The images
will not be scaled.
<P>
See the examples on how to create and use
<A HREF=../image/index.html>images</A>.
<P>
<DT><B>-defaultBounds =></B> <I>area</I>
<DD>If one of the specific area-bounds is not specified, its region
is computed based on this value. The <I>area</I> specifies the
values the left-top and right-bottom coordinates of the screen
relative to the screen's width and height (percentages).<BR>
The default is: <CODE>[ qw/5% 5% 97% 97%/ ]</CODE>
<P>
<DT><B>-defaultTitlebarHeight =></B> <I>percentage</I>
<DD>When no <CODE>-titleBounds</CODE> is specified, and the selected template
requires an area for the title to be displayed, this value is used to
reserve a part of the <CODE>-defaultBounds</CODE> area for it.<BR>
The default value is <CODE>15%</CODE> (which is equivalent to
<CODE>0.15</CODE>).
<P>
<DT><B>-defaultFooterHeight =></B> <I>percentage</I>
<DD>When no <CODE>-footerBounds</CODE> are specified, this value is used
to reserve a part of the <CODE>-defaultBounds</CODE> area to show a
footer (if the user has specied a footer, otherwise this option will
have no effect).<BR>
The default value is <CODE>10%</CODE>.
<P>
<DT><B>-areaSeparation =></B> <I>percentage</I>
<DD>Blank space between template areas as well when the are stacked
horizontally as vertically. The default value is <CODE>3%</CODE>
<P>
<DT><B>-titleBounds =></B> <I>area</I><BR>
<B>-mainBounds =></B> <I>area</I><BR>
<B>-mainBoundsNoTitle=></B> <I>area</I><BR>
<B>-footerBounds =></B> <I>area</I>
<DD>These options specify the area of the screen where respectively the
title, main-part, main-part when the template does not show a title,
and the page's footer shall be displayed. If these values are
not supplied, convenient values are computed based on the
<CODE>-defaultBounds</CODE>.
<P>
<DT><B>-notesBounds =></B> <I>area</I>
<DD>The region used to show text which is created by the `notes' template.
The default is
<CODE>[ qw/2% 2% 98% 98%/ ]</CODE>
</DL>
<H2>Settings with <A NAME=function>Function</A>-calls</H2>
Decorations contain a few settings which can not be set simply by
option-flags with a slide, but only by calling a function.
<DL>
<DT><B>devices =></B> <I>hash-of-devs</I>,
where <I>devs</I> relate a name to a ref-array
with <B>[</B> <I>bgcolor, fgcolor, bdcolor, backdrop</I> <B>]</B>
<P>
<DD>This hash defines the default colors to be used per device.
Do not change device definitions, but add new devices with
<PRE>
$show->find(decoration => 'SELECTED')
->addDevice(<I>name, fg, bg, bd, backdrop</I>);
</PRE>
Devices are added in front of the list, so when you add a device
specification with an existing name, the original will not be
used anymore.
<P>
Predefined values are:
<CENTER>
<TABLE WIDTH=80% BORDER=1>
<TR><TH>device</TH>
<TH>background<BR>colour</TH>
<TH>foreground<BR>colour</TH>
<TH>backdrop<BR>colour</TH>
<TH>default<BR>backdrop</TH></TR>
<TR><TD>lcd</TD><TD>dark blue</TD><TD>yellow</TD><TD>black</TD><TD>1 (on)</TD></TR>
<TR><TD>beamer</TD><TD>white</TD><TD>black</TD><TD>gray</TD><TD>0 (off)</TD></TR>
<TR><TD>printer</TD><TD>white</TD><TD>black</TD><TD>gray</TD><TD>0 (off)</TD></TR>
</TABLE></CENTER>
<P>
Use `<CODE>-backdrop => <I>boolean</I></CODE>'
to overrule the backdrop for device. To change the default colours, you
can add a new device. Do not forget to select the new device (even when
it has the same name as the selected device):
<PRE>
$show->find('decoration')
->addDevice(qw/lcd black white yellow 0/);
$show->select(decoration => 'lcd');
</PRE>
<P>
</DL>
<HR NOSHADE>
Portable Presenter is written and maintained by
<A HREF=http://mark.overmeer.net>Mark Overmeer</A>.
Copyright (C) 2000-2002, Free Software Foundation FSF.
</TD></TR>
</TABLE>
</HTML>