data/TWiki/SlideShowPlugin.txt
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
child 1 e2915a7cbdfa
permissions -rw-r--r--
RELEASE 4.2.0 freetown
colas@0
     1
%META:TOPICINFO{author="TWikiContributor" date="1191133709" format="1.1" version="6"}%
colas@0
     2
---+!! Slide Show Plugin
colas@0
     3
colas@0
     4
This plugin converts a topic with headings into a slideshow.
colas@0
     5
colas@0
     6
%TOC%
colas@0
     7
colas@0
     8
---++ Introduction
colas@0
     9
colas@0
    10
There is already a defacto standard for presentations, why this plugin? This plugin makes sense for organizations that do already have lots of content in TWiki: It is easy to create a web based presentation that contains many links to related content. The plugin does not try to compete with the bells and whistles of the other presentation program, but the markup of TWiki and other plugins like TWiki:Plugins/ChartPlugin, TWiki:Plugins/GaugePlugin, TWiki:Plugins/SpreadSheetPlugin, TWiki:Plugins/TWikiDrawPlugin can be used to create appealing presentations.
colas@0
    11
colas@0
    12
Any topic with headings can be converted into a slideshow. Each slide starts with a ="---++"= heading. There are two modes to view a topic:
colas@0
    13
colas@0
    14
   * Normal topic view mode: Headings and text is shown in the usual TWiki rendering, representing the outline of the slideshow. This mode is useful to print handouts.
colas@0
    15
   * Presentation mode: Each heading with text is shown as a slide; the format is based on a slide template. Navigation buttons are added to go to the "First", "Previous", and "Next" slide. Slide navigation is quick because it is done with anchor jumps to the same page. 
colas@0
    16
colas@0
    17
You can start the presentation by clicking on the "Start presentation" button.
colas@0
    18
colas@0
    19
---++ Syntax Rules
colas@0
    20
colas@0
    21
---+++ How to Create a Slideshow
colas@0
    22
colas@0
    23
   * Start with =%<nop>SLIDESHOWSTART%=
colas@0
    24
      * Use the optional =template= parameter to specify your own slide template topic, e.g. =%<nop>SLIDESHOWSTART{ template="MyOwnSlideTemplate" }%=
colas@0
    25
   * Create the slides. Start each slide with a ="---++"= heading and add text like paragraphs, bullets, tables and images.
colas@0
    26
      * __Hint:__ Make sure to keep each slide short enough so that you do not need to scroll to see all text of a slide during the presentation.
colas@0
    27
      * __Note:__ You can use any heading level you like, but use the same for all slides.
colas@0
    28
   * End your slideshow with =%<nop>SLIDESHOWEND%=
colas@0
    29
colas@0
    30
---+++ How to Create Your own Slide Template
colas@0
    31
colas@0
    32
To create your own template topic, copy the "Default Slide Template" section below into your own slide template topic and customize it to your needs. It can be activated as the default template in the plugin's =TEMPLATE= setting, or per slideshow with the =%<nop>SLIDESHOWSTART{ template="MyOwnSlideTemplate" }%= setting.
colas@0
    33
colas@0
    34
   * Use an HTML table that defines a slide. For example, create one row for the slide title, another one for the slide text.
colas@0
    35
   * These keywords can be used:
colas@0
    36
     | *Keyword* | *What it means* |
colas@0
    37
     | =%<nop>SLIDETITLE%= | The heading of the slide |
colas@0
    38
     | =%<nop>SLIDETEXT%= | The text of the slide |
colas@0
    39
     | =%<nop>SLIDECOMMENT%= | The comment of the slide (optional; appended to slide of missing) |
colas@0
    40
     | =%<nop>SLIDENUM%= | The current slide number |
colas@0
    41
     | =%<nop>SLIDEMAX%= | The last slide number |
colas@0
    42
     | =%<nop>SLIDENAV%= | The navigation buttons for "First", "Previous", "Next" slide |
colas@0
    43
     | =%<nop>SLIDENAVALL%= | The navigation buttons for "First", "Previous", "Next", "Last" slide |
colas@0
    44
     | =%<nop>SLIDENAVFIRST%= | The navigation button for "First slide" |
colas@0
    45
     | =%<nop>SLIDENAVPREV%= | The navigation button for "Previous slide" |
colas@0
    46
     | =%<nop>SLIDENAVNEXT%= | The navigation button for "Next slide" |
colas@0
    47
     | =%<nop>SLIDENAVLAST%= | The navigation button for "Last slide" |
colas@0
    48
   * Only text between =%<nop>STARTINCLUDE%= and =%<nop>STOPINCLUDE%= is used for the template.
colas@0
    49
colas@0
    50
---++ Example
colas@0
    51
colas@0
    52
This is a short example of a slideshow. You should see a "Start presentation" button if this plugin is installed:
colas@0
    53
colas@0
    54
%SLIDESHOWSTART%
colas@0
    55
---+++ Silly Sample Slideshow
colas@0
    56
%BR%
colas@0
    57
colas@0
    58
<center>
colas@0
    59
By TWiki:Main/PeterThoeny
colas@0
    60
colas@0
    61
San Jose, 29 Sep 2007
colas@0
    62
</center>
colas@0
    63
colas@0
    64
---+++ Agenda
colas@0
    65
   * Silly Introduction
colas@0
    66
   * Silly Feature
colas@0
    67
   * Silly Conclusion
colas@0
    68
---+++ Silly Introduction
colas@0
    69
   * why foo bar
colas@0
    70
   * blah blah
colas@0
    71
---++++ Comments
colas@0
    72
   * This text is not shown in the slide if HIDECOMMENTS is set to on.
colas@0
    73
---+++ Silly Feature
colas@0
    74
   * it's foo bar
colas@0
    75
   * more foo bar
colas@0
    76
---+++ Silly Conclusion
colas@0
    77
   * foo is bar
colas@0
    78
   * bar is foo
colas@0
    79
%SLIDESHOWEND%
colas@0
    80
colas@0
    81
This text is not part of the slideshow
colas@0
    82
colas@0
    83
---++ <nop>%TOPIC% Global Settings
colas@0
    84
colas@0
    85
Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop>&lt;plugin&gt;_&lt;setting&gt;%==, i.e. ==%<nop>SLIDESHOWPLUGIN_SHORTDESCRIPTION%==
colas@0
    86
colas@0
    87
   * One line description, is shown in the %SYSTEMWEB%.TextFormattingRules topic:
colas@0
    88
      * Set SHORTDESCRIPTION = Create web based presentations based on topics with headings.
colas@0
    89
colas@0
    90
   * Debug plugin: (See output in =data/debug.txt=)
colas@0
    91
      * Set DEBUG = 0
colas@0
    92
colas@0
    93
   * Default template for slides:
colas@0
    94
      * Set TEMPLATE = SlideShowPlugin
colas@0
    95
colas@0
    96
   * Hide text starting with a =---+++ Comments= heading:
colas@0
    97
      * Set HIDECOMMENTS = on
colas@0
    98
colas@0
    99
---++ Default Slide Template
colas@0
   100
colas@0
   101
The part between the rulers defines the default format of a slide:
colas@0
   102
colas@0
   103
-----
colas@0
   104
%STARTINCLUDE%
colas@0
   105
<table width="100%" border="0" cellspacing="0" cellpadding="5">
colas@0
   106
<tr bgcolor="#003399"><td valign="middle" width="2%">
colas@0
   107
<img src="%PUBURL%/%WEB%/SlideShowPlugin/logo.gif" border="0" alt="TWiki Slide Show" /></td>
colas@0
   108
<td valign="middle">
colas@0
   109
<font size="+3" color="#FFFFFF">%SLIDETITLE%</font></td>
colas@0
   110
<td align="right" valign="middle">
colas@0
   111
%SLIDENAVNEXT%</td>
colas@0
   112
</tr>
colas@0
   113
</table>
colas@0
   114
<table width="100%" border="0" cellspacing="0" cellpadding="3">
colas@0
   115
<tr bgcolor="#FFFF99"><td width="1">
colas@0
   116
<img src="%PUBURL%/%WEB%/SlideShowPlugin/clearpixel.gif" width="1" height="480" alt="" /></td>
colas@0
   117
<td valign="top">
colas@0
   118
%BR%
colas@0
   119
<font size="+2" color="#003399">
colas@0
   120
%SLIDETEXT%
colas@0
   121
</font></td></tr>
colas@0
   122
</table>
colas@0
   123
<table width="100%" border="0" cellspacing="0" cellpadding="0">
colas@0
   124
<tr bgcolor="#FFFFCC"><td valign="middle">
colas@0
   125
%SLIDENAVALL%&nbsp;</td>
colas@0
   126
<td valign="middle" align="right">
colas@0
   127
<font size="-1" color="#666666">Slide %SLIDENUM% of %SLIDEMAX%</font></td>
colas@0
   128
<td valign="middle" align="right">
colas@0
   129
<font size="-2" color="#666666"> COPYRIGHT &copy; %SERVERTIME{$year}% by the contributing authors </font></td></tr>
colas@0
   130
</table>
colas@0
   131
%STOPINCLUDE%
colas@0
   132
-----
colas@0
   133
colas@0
   134
---++ Plugin Installation Instructions
colas@0
   135
colas@0
   136
__Note:__ You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running. 
colas@0
   137
colas@0
   138
   * Download the ZIP file from the Plugin Home (see below)
colas@0
   139
   * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
colas@0
   140
     | *File:* | *Description:* |
colas@0
   141
     | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
colas@0
   142
     | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
colas@0
   143
     | ==lib/TWiki/Plugins/%TOPIC%/SlideShow.pm== | Plugin Perl module |
colas@0
   144
     | ==pub/TWiki/*.gif== | Various button image files |
colas@0
   145
   * TWiki 4.0 and up: Run the [[%SCRIPTURL%/configure%SCRIPTSUFFIX%][configure]] script, and enable the plugin in the {Plugins} section.
colas@0
   146
   * Test above example if the installation was successful.
colas@0
   147
colas@0
   148
---++ Plugin Info
colas@0
   149
colas@0
   150
|  Plugin Author: | TWiki:Main/PeterThoeny |
colas@0
   151
|  Copyright: | &copy; 2006-2007, Peter Thoeny, [[http://www.twiki.net/][TWIKI.NET]] |
colas@0
   152
|  License: | GPL ([[http://www.gnu.org/copyleft/gpl.html][GNU General Public License]]) |
colas@0
   153
|  Plugin Version: | 29 Sep 2007 (15091) |
colas@0
   154
|  Change History: | <!-- versions below in reverse order -->&nbsp; |
colas@0
   155
|  29 Sep 2007: | Added %SYSTEMWEB%.VarSLIDESHOWSTART and %SYSTEMWEB%.VarSLIDESHOWEND to have them listed in %SYSTEMWEB%.TWikiVariables |
colas@0
   156
|  12 Feb 2007: | fixed construction of view urls (TWiki:Main/MichaelDaum) |
colas@0
   157
|  19 Nov 2006: | 12011: Preserve URL parameters in slideshow (suggested by TWiki:Main/ThomasWeigert); changed logo in default template to T-logo; fixed warning errors introduced by 1.005 |
colas@0
   158
|  16 Mar 2005: | 1.005 Crawford Currie prepped for Dakar, and fixed multiple evaluation bug |
colas@0
   159
|  21 Nov 2004: | 1.004 Added support for =%<nop>SLIDECOMMENT%= template keyword (TWiki:Main/ArthurClemens); added benchmarks |
colas@0
   160
|  21 Mar 2004: | Internal change: Fixed unofficial function call |
colas@0
   161
|  14 Dec 2002: | Added =%<nop>SLIDENAVALL%= template keyword; added HIDECOMMENTS setting |
colas@0
   162
|  23 Nov 2002: | Added =%<nop>SLIDENAVLAST%= template keyword; using print Skin for presentation mode |
colas@0
   163
|  19 Nov 2002: | Added "Start presentation" and "End presentation" buttons; added =%<nop>SLIDENAVFIRST%=, =%<nop>SLIDENAVPREV%=, =%<nop>SLIDENAVNEXT%= template keywords |
colas@0
   164
|  17 Nov 2002: | Initial version |
colas@0
   165
|  CPAN Dependencies: | none |
colas@0
   166
|  Other Dependencies: | none |
colas@0
   167
|  Perl Version: | 5.005 |
colas@0
   168
|  TWiki:Plugins/Benchmark: | %SYSTEMWEB%.GoodStyle 98%, %SYSTEMWEB%.FormattedSearch 99%, SlideShowPlugin 99% |
colas@0
   169
|  Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
colas@0
   170
|  Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
colas@0
   171
|  Appraisal: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Appraisal |
colas@0
   172
colas@0
   173
__Related Topics:__ %SYSTEMWEB%.TWikiPreferences, %SYSTEMWEB%.TWikiPlugins
colas@0
   174
colas@0
   175
%META:FILEATTACHMENT{name="next.gif" attr="h" comment="Next button" date="1037510613" path="C:\Data\next.gif" size="993" user="TWikiContributor" version="1.2"}%
colas@0
   176
%META:FILEATTACHMENT{name="prev.gif" attr="h" comment="Prev button" date="1037510599" path="C:\Data\prev.gif" size="993" user="TWikiContributor" version="1.2"}%
colas@0
   177
%META:FILEATTACHMENT{name="clearpixel.gif" attr="h" comment="Clear pixel for spacing" date="1037523452" path="C:\Data\clearpixel.gif" size="807" user="TWikiContributor" version="1.1"}%
colas@0
   178
%META:FILEATTACHMENT{name="startpres.gif" attr="h" comment="Start Presentation button" date="1037759933" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\startpres.gif" size="2065" user="TWikiContributor" version="1.1"}%
colas@0
   179
%META:FILEATTACHMENT{name="endpres.gif" attr="h" comment="End Presentation button" date="1037759950" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\endpres.gif" size="2066" user="TWikiContributor" version="1.1"}%
colas@0
   180
%META:FILEATTACHMENT{name="logo.gif" attr="h" comment="Logo for slide template" date="1037760048" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\logo.gif" size="2877" user="TWikiContributor" version="1.1"}%
colas@0
   181
%META:FILEATTACHMENT{name="first.gif" attr="h" comment="First slide button" date="1037951064" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\first.gif" size="1010" user="TWikiContributor" version="1.1"}%
colas@0
   182
%META:FILEATTACHMENT{name="last.gif" attr="h" comment="Last slide button" date="1037951080" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\last.gif" size="1014" user="TWikiContributor" version="1.1"}%