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 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 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

By John Doe London, 29 Sep 2007

Slide 1 of 5

COPYRIGHT © 2024 by the contributing authors

Agenda

Silly Introduction Silly Feature Silly Conclusion

Slide 2 of 5

COPYRIGHT © 2024 by the contributing authors

Silly Introduction

why foo bar blah blah

Slide 3 of 5

COPYRIGHT © 2024 by the contributing authors

Comments

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

Silly Feature

it's foo bar more foo bar

Slide 4 of 5

COPYRIGHT © 2024 by the contributing authors

Silly Conclusion

foo is bar bar is foo

Slide 5 of 5

COPYRIGHT © 2024 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 ---+++ Comments heading:
  • Set HIDECOMMENTS = on

Default Slide Template

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

%SLIDETITLE%

%SLIDENAVNEXT%

%SLIDETEXT%

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.zip in your Foswiki installation directory. Content:

  File:	Description:
  data/System/SlideShowPlugin.txt	Plugin topic
  lib/Foswiki/Plugins/SlideShowPlugin.pm	Plugin Perl module
  lib/Foswiki/Plugins/SlideShowPlugin/SlideShow.pm	Plugin Perl module
  pub/System/*.gif	Various 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 © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback