Slide Show Plugin

This Plugin converts a topic with headings into a slide show.


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 an appealing presentation.

Any topic with headings can be converted into a slide show. Each slide starts with a "---++" heading. There are two modes to view a topic:

  • Normal topic view mode: Headings and text is shown in the usual TWiki rendering, representing the outline of the slide show. This mode is useful to print handouts.
  • 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.

You can start the presentation by clicking on the "Start presentation" button.

Syntax Rules

How to Create a Slide Show

  • Start with %SLIDESHOWSTART%
    • Use the optional template parameter to specify your own slide template topic, e.g. %SLIDESHOWSTART{ template="MyOwnSlideTemplate" }%
  • Create the slides. Start each slide with a "---++" heading and add text like paragraphs, bullets, tables and images.
    • 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.
    • Note: You can use any heading level you like, but use the same for all slides.
  • End your slide show with %SLIDESHOWEND%

How to Create Your own Slide Template

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 slide show with the %SLIDESHOWSTART{ template="MyOwnSlideTemplate" }% setting.

  • Use an HTML table that defines a slide. For example, create one row for the slide title, another one for the slide text.
  • These keywords can be used:
    Keyword What it means
    %SLIDETITLE% The heading of the slide
    %SLIDETEXT% The text of the slide
    %SLIDENUM% The current slide number
    %SLIDEMAX% The last slide number
    %SLIDENAV% The navigation buttons for "First", "Previous", "Next" slide
    %SLIDENAVALL% The navigation buttons for "First", "Previous", "Next", "Last" slide
    %SLIDENAVFIRST% The navigation button for "First slide"
    %SLIDENAVPREV% The navigation button for "Previous slide"
    %SLIDENAVNEXT% The navigation button for "Next slide"
    %SLIDENAVLAST% The navigation button for "Last slide"
  • Only text between %STARTINCLUDE% and %STOPINCLUDE% is used for the template.


This is a short example of a slide show. You should see a "Start presentation" button if this Plugin is installed:

End Presentation

TWiki Slide Show Silly Sample Slide Show Next

By TWiki:Main/PeterThoeny

San Jose, 17 Nov 2002

First slide Previous Next Last slide  Slide 1 of 5 COPYRIGHT © 2024 by the contributing authors

TWiki Slide Show Agenda Next

  • Silly Introduction
  • Silly Feature
  • Silly Conclusion
First slide Previous Next Last slide  Slide 2 of 5 COPYRIGHT © 2024 by the contributing authors

TWiki Slide Show Silly Introduction Next

  • why foo bar
  • blah blah

First slide Previous Next Last slide  Slide 3 of 5 COPYRIGHT © 2024 by the contributing authors


  • This text is not shown in the slide if HIDECOMMENTS is set to on.

TWiki Slide Show Silly Feature Next

  • it's foo bar
  • more foo bar
First slide Previous Next Last slide  Slide 4 of 5 COPYRIGHT © 2024 by the contributing authors

TWiki Slide Show Silly Conclusion Next

  • foo is bar
  • bar is foo

First slide Previous Next Last slide  Slide 5 of 5 COPYRIGHT © 2024 by the contributing authors

First slide Previous End Presentation

This text is not part of the slide show

SlideShowPlugin Global Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %SLIDESHOWPLUGIN_SHORTDESCRIPTION%

  • One line description, is shown in the TextFormattingRules topic:
    • Set SHORTDESCRIPTION = Create web based presentations based on topics with headings.

  • Debug plugin: (See output in data/debug.txt)
    • Set DEBUG = 0

  • Hide text starting with a ---+++ Comments heading:
    • Set HIDECOMMENTS = on

Default Slide Template

The part between the rulers defines the default format of a slide:


%SLIDENAVALL%  Slide %SLIDENUM% of %SLIDEMAX% COPYRIGHT © 2024 by the contributing authors

Plugin Installation Instructions

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.

  • Download the ZIP file from the Plugin web (see below)
  • Unzip in your twiki installation directory. Content:
    File: Description:
    data/TWiki/SlideShowPlugin.txt Plugin topic
    data/TWiki/SlideShowPlugin.txt,v Plugin topic repository
    lib/TWiki/Plugins/ Plugin Perl module
    pub/TWiki/*.gif Various button image files
  • Test above example if the installation was successful.

Plugin Info

Plugin Author: TWiki:Main/PeterThoeny
Plugin Version: 21 Mar 2004 (V1.003)
Change History:  
21 Mar 2004: Internal change: Fixed inofficial function call
14 Dec 2002: Added %SLIDENAVALL% template keyword; added HIDECOMMENTS setting
23 Nov 2002: Added %SLIDENAVLAST% template keyword; using print Skin for presentation mode
19 Nov 2002: Added "Start presentation" and "End presentation" buttons; added %SLIDENAVFIRST%, %SLIDENAVPREV%, %SLIDENAVNEXT% template keywords
17 Nov 2002: Initial version
CPAN Dependencies: none
Other Dependencies: none
Perl Version: 5.005
Plugin Home:

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main.PeterThoeny - 21 Mar 2004

I Attachment Action Size Date Who Comment
gifgif clearpixel.gif manage 0.8 K 12 Dec 2003 - 05:15 UnknownUser Clear pixel for spacing
gifgif endpres.gif manage 2.0 K 12 Dec 2003 - 05:17 UnknownUser End Presentation button
gifgif first.gif manage 1.0 K 12 Dec 2003 - 05:18 UnknownUser First slide button
gifgif last.gif manage 1.0 K 12 Dec 2003 - 05:18 UnknownUser Last slide button
gifgif logo.gif manage 2.8 K 12 Dec 2003 - 05:17 UnknownUser Logo for slide template
gifgif next.gif manage 1.0 K 12 Dec 2003 - 05:19 UnknownUser Next button
gifgif prev.gif manage 1.0 K 12 Dec 2003 - 05:19 UnknownUser Prev button
gifgif startpres.gif manage 2.0 K 12 Dec 2003 - 05:17 UnknownUser Start Presentation button

This topic: TWiki > SlideShowPlugin
Topic revision: r2 - 21 Mar 2004 - 05:59:46 - PeterThoeny
This site is powered by the TWiki collaboration platformCopyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on at TWiki:TWiki.SlideShowPlugin