view release on metacpan or  search on metacpan

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

</PRE>
The order of the options is not important.
<P>
When you have a presentation with multiple viewports involved, then you
should read the page on
<A HREF=../slideview/index.html>how to specify slide-views</A>.

<H2><A NAME=general>General</A> slide options</H2>
<DL>
<DT><B>-title =&gt;</B> <I>string</I>
<DT><B>-aliases =&gt; [</B> <I>string, ...</I> <B>]</B>
<DD>The <STRONG>only obligatory option</STRONG> of each slide is a
    unique title.  If you think the title is too long to refer to (for
    instance in the <CODE>-nextSlide</CODE> option), or the title is
    not unique, you can add a list of aliases.
    <P>
<DT><A NAME=timespan><B>-reqtime =&gt;</B> <I>timespan</I></A>
<DD>The estimation for the time required to present this slide.
    The default is 60 seconds, which is rather short.  If you specify
    even shorter timespans, than surely you will have problems keeping
    to it during your actual presentation.
    <P>
    There are various ways you can specify a timespan.  Examples say it
    all:
    <TABLE>
    <TR><TD><CODE>"1h30m"</CODE></TD><TD>=&nbsp;4800&nbsp;sec;&nbsp;</TD>
        <TD><CODE>"1h30"</CODE></TD><TD>=&nbsp;3630!&nbsp;sec;</TD>
        <TD><CODE>"30m"</CODE></TD><TD>=&nbsp;1800&nbsp;sec</TD></TR>
    <TR><TD><CODE>"1:30"</CODE></TD><TD>=&nbsp;90&nbsp;sec;&nbsp;</TD>
        <TD><CODE>"1:30:0"</CODE></TD><TD>=&nbsp;4800&nbsp;sec;</TD>
        <TD><CODE>"3:"</CODE></TD><TD>=&nbsp;180&nbsp;sec</TD></TR>
    <TR><TD><CODE>"2m30s"</CODE></TD><TD>=&nbsp;150&nbsp;sec;&nbsp;</TD>
        <TD><CODE>2000</CODE></TD><TD>=&nbsp;2000&nbsp;sec;</TD>
        <TD><CODE>30</CODE></TD><TD>=&nbsp;30&nbsp;sec</TD></TR>
    </TABLE>
    <P>
<DT><B>-proceed =&gt;</B> <CODE>STOP|TIME|NOW|PHASE</CODE>
<DD>Defines when to proceed to the next slide.  The values are:
    <UL>
    <LI><CODE>STOP</CODE>: default. Proceed on user's command only;
    <LI><CODE>TIME</CODE>: wait until the required time is over
        (<CODE>-reqtime</CODE>), and then proceed automatically to the next
        slide.  The user can force to proceed before the time has expired.
    <LI><CODE>NOW</CODE>: continue immediately.  Only useful when using
        multiple screens in one presentation.
    <LI><CODE>PHASE <I>number</I></CODE>: continue when the phase is
        reached.  This is useful when the show runs on multiple viewports,
        and you like the next slide to be loaded on a different viewport
        than this one.
    </UL>
    <P>
<DT><B>-nextSlide =&gt;</B> <I>string</I>
<DD>The slide to be shown after this one.  This may be a name (the
    <CODE>-title</CODE> of the slide), an alias name of a slide,
    a sequence number in the list of slides, or <CODE>'FIRST'</CODE> or
    <CODE>'LAST'</CODE>.
    <P>
<DT><B>-active =&gt;</B> <I>boolean</I>
<DD>Include the slide in the presentation yes (true, <CODE>1</CODE>
    --the default) or no (false, <CODE>0</CODE>).  You can also
    (de-)activate slides with tags and via the control-popup or
    <A HREF=../viewport/control.html>control window</A>.
    <P>
<DT><B>-tag =&gt;</B> <I>string</I>
<DT><B>-tags =&gt;</B> <B>[</B> <I>string, ...</I> <B>]</B>
<DD>Tags, used to select (activate) or unselect (deactive) groups of
    slides.  See the <A HREF../show/new.html>show's new() function</A>
    how to use the tags.
    <P>
<DT><B>-callback =&gt;</B> <I>code</I>
<DT><B>-callback =&gt; [</B> <I>dynamic, callback</I> <B>]</B>
<DT><B>-callback =&gt; [ [</B> <I>dynamic, callback</I> <B>], ... ]</B>
<DT><B>-callbacks</B> equivalent to -callback
<DD>A callback is a hook into the <A HREF=program.html>program</A> of the
    slide-display.  You can specify your own perl-code to executed when
    a certain phase of the slide is reached.
    <P>
    The <I>dynamic</I> is a string as accepted by the selected
    <A HREF=../dynamic/index.html>dynamic</A> style-element, although not
    all possible strings make sense.
    <P>
    The <I>callback</I> is a Tk::Callback as described in the
    Tk::callbacks manpage. Examples of possible combinations:
    <DL>
    <DT><CODE>-callback =&gt; sub {print "hi\n"}</CODE>
    <DT><CODE>-callback =&gt; [ 'after 10', sub {print "@_\n"}, 'I' ]</CODE>
    <DD>10 seconds after appearance of the slide, the text `I' is
        printed on stdout.
    <DT><CODE>-callback =&gt; [ 'phase 1', 'setRunning', $show->find('main'), 1 ]</CODE>
    <DD>The result of <CODE>find</CODE> is an object (say $main).  The
        callback will result in <CODE>$main->setRunning(1)</CODE>.
    </DL>
</DL>

<H2><A NAME=examples>Examples</A></H2>

Examples of simple slide-specifications: one viewport, or multiple viewports
all showing the same.  For more complicated examples, visit the
<A HREF=../slideview/index.html>slide-view</A> page.
<P>
<H4>Example 1</H4>
<PRE>
    $show->addSlide( -title    => 'demo'
                   , -template => 'tm'
                   , -bgcolor  => 'red'
                   , -backdrop => 0
                   , -main     => 'text'
                   , -reqtime  => 5*60);
</PRE>
The <CODE>-title</CODE> flag is the only obligatory argument, although...
if you forget to mention it, the name will be "Slide <I>number</I>".  With
the <CODE>-reqtime</CODE> of 5 minutes, these are the real slide options.
<P>
The <CODE>-template</CODE> option selects the template style-element
<CODE>tm</CODE> ("title-main": a screen which show a titlebar and
the rest of the screen is used as one large piece of text).
The <CODE>-main</CODE> option describes the text to be shown there.
The "text" will be handled by the selected formatter, when time comes that
it has to be displayed.
<P>
The other style-elements are not specified, so their respectively selected