view release on metacpan or  search on metacpan

doc_html/decoration/index.html  view on Meta::CPAN

<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 =&gt; [ </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 =&gt;</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 =&gt;</B> <I>color</I>
<DT><B>-bgcolor =&gt;</B> <I>color</I>
<DT><B>-bdcolor =&gt;</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 =&gt; [ </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         =&gt;</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 =&gt;</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   =&gt;</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        =&gt;</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      =&gt;</B> <I>area</I><BR>
    <B>-mainBounds       =&gt;</B> <I>area</I><BR>
    <B>-mainBoundsNoTitle=&gt;</B> <I>area</I><BR>
    <B>-footerBounds     =&gt;</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      =&gt;</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 =&gt;</B> <I>hash-of-devs</I>,
    where <I>devs</I> relate a name to a ref-array