Slide Show Plugin
This plugin converts a topic with headings into a slideshow.
Introduction
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 Foswiki: 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 Foswiki and other plugins like Foswiki:Extensions/ChartPlugin, Foswiki:Extensions/GaugePlugin, Foswiki:Extensions/SpreadSheetPlugin, Foswiki:Extensions/FoswikiDrawPlugin can be used to create appealing presentations.
Any topic with headings can be converted into a slideshow. 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 Foswiki rendering, representing the outline of the slideshow. 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 Slideshow
- Start with
%SLIDESHOWSTART%- Use the optional
templateparameter to specify your own slide template topic, e.g.%SLIDESHOWSTART{ template="MyOwnSlideTemplate" }%
- Use the optional
- 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 slideshow 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 slideshow 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 %SLIDECOMMENT%The comment of the slide (optional; appended to slide of missing) %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.
Example
This is a short example of a slideshow. You should see a "Start presentation" button if this plugin is installed:
 |
Silly Sample Slideshow |
 |
 |
London, 29 Sep 2007
|
   |
Slide 1 of 5 | COPYRIGHT © 2025 by the contributing authors |
|
|
Agenda |
|
|
|
|
|
|
Slide 2 of 5 | COPYRIGHT © 2025 by the contributing authors |
|
|
Silly Introduction |
|
|
|
|
|
|
Slide 3 of 5 | COPYRIGHT © 2025 by the contributing authors |
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
|
|
Silly Feature |
|
|
|
|
|
|
Slide 4 of 5 | COPYRIGHT © 2025 by the contributing authors |
|
|
Silly Conclusion |
|
|
|
|
|
|
Slide 5 of 5 | COPYRIGHT © 2025 by the contributing authors |
This text is not part of the slideshow
SlideShowPlugin Global Settings
Plugin settings are stored as preference settings. 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
- Default template for slides:
- Set TEMPLATE = SlideShowPlugin
- Hide text starting with a
---+++ Commentsheading:- Set HIDECOMMENTS = on
Default Slide Template
The part between the rulers defines the default format of a slide:
|
|
%SLIDETITLE% | %SLIDENAVNEXT% |
|
|
%SLIDETEXT% |
| %SLIDENAVALL% | Slide %SLIDENUM% of %SLIDEMAX% | COPYRIGHT © 2025 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 Foswiki is running.
- Download the ZIP file from the Plugin Home (see below)
- Unzip
SlideShowPlugin.zipin your Foswiki installation directory. Content:File: Description: data/System/SlideShowPlugin.txtPlugin topic lib/Foswiki/Plugins/SlideShowPlugin.pmPlugin Perl module lib/Foswiki/Plugins/SlideShowPlugin/SlideShow.pmPlugin Perl module pub/System/*.gifVarious button image files - Run the configure script, and enable the plugin in the {Plugins} section.
- Test above example if the installation was successful.
Plugin Info
| Copyright: | Copyright (C) 2006-2007 Peter Thoeny, peter@thoeny.org and TWiki Contributors; 2008 Foswiki Contributors |
| License: | GPL (GNU General Public License) |
| Plugin Version: | 16 Dec 2008 |
| Change History: | |
| 16 Dec 2008: | Foswiki version |
| 02 Aug 2008: | Fixed corruption of preview |
| 29 Sep 2007: | Added VarSLIDESHOWSTART and VarSLIDESHOWEND to have them listed in System.Macros |
| 12 Feb 2007: | fixed construction of view urls (TWiki:Main/MichaelDaum) |
| 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 |
| 16 Mar 2005: | 1.005 Crawford Currie prepped for Dakar, and fixed multiple evaluation bug |
| 21 Nov 2004: | 1.004 Added support for %SLIDECOMMENT% template keyword (TWiki:Main/ArthurClemens); added benchmarks |
| 21 Mar 2004: | Internal change: Fixed unofficial 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.008 |
| Plugin Home: | http://foswiki.org/Extensions/SlideShowPlugin |
| Support: | http://foswiki.org/Support/SlideShowPlugin |
Related Topics: DefaultPreferences, SitePreferences, Plugins
This topic: System > Plugins > SlideShowPlugin
Topic revision: r1 - 02 Aug 2008 - 10:26:59 - ProjectContributor
Copyright © by the contributing authors. All material on this site is the property of the contributing authors. Ideas, requests, problems regarding Wiki? Send feedback