| Slide Show Plugin
<--
Contributions to this TWiki plugin are appreciated. Please update the plugin page at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPlugin or provide feedback at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPluginDev .
If you are a TWiki contributor please update the plugin in the SVN repository.
-->
Create web based presentations based on topics with headings.
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 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 compelling interactive presentations can be made using the TML (TWiki Markup Language) and plugins, such as TWiki:Plugins.ChartPlugin , TWiki:Plugins.GaugePlugin , TWiki:Plugins.SpreadSheetPlugin , TWiki:Plugins.TWikiDrawPlugin .
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 TWiki 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.
You can start the presentation by clicking on the "Start presentation" button.
Navigation
While in presentation mode you can move around slides using navigation buttons and keys:
Button |
Key |
Action |
|
Home |
Go to first slide |
|
Left-arrow, Page-up |
Go to previous slide |
|
Right-arrow, Page-down |
Go to next slide |
|
End |
Go to last slide |
|
Esc |
End presentation |
Slide navigation is quick because it is done using anchor jumps within the same page. Key-based navigation requires JavaScript enabled.
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 Link to Slides
The %SLIDESHOWSTART% renders as a button. This is the default way to link to the slideshow.
Slides have anchors names Slide_1 , Slide_2 , Slide_3 , etc. For example, write [[#Slide_3][Silly Introduction]] to link to slide 3 of the presentation on the current topic in page view mode, which renders as Silly Introduction.
Write [[%SCRIPTURL{view}%/%WEB%/%TOPIC%?slideshow=on;skin=print#Slide_3][Silly Introduction]] to link to a specific slide in presentation mode, which renders as Silly Introduction.
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:
Slide 1: Silly Sample Slideshow
By TWiki:Main.PeterThoeny
San Jose, 2012-04-07
Slide 2: Agenda
- Silly Introduction
- Silly Feature
- Silly Conclusion
Slide 3: Silly Introduction
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
Slide 4: Silly Feature
- it's foo bar
- more foo bar
Slide 5: Silly Conclusion
This text is not part of the slideshow
Default Slide Template
The part between the rulers defines the default format of a slide:
%SLIDENAVNEXT%
%SLIDETITLE%
%SLIDENAVALL%
COPYRIGHT © 2025 by the contributing authors
Slide %SLIDENUM% of %SLIDEMAX%
SlideShowPlugin Global Settings
<--/twistyPlugin twikiMakeVisibleInline-->
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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
<--/twistyPlugin-->
Plugin Installation Instructions
This plugin is pre-installed. TWiki administrators can upgrade the plugin as needed on the TWiki server.
<--/twistyPlugin twikiMakeVisibleInline-->
- For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
- Or, follow these manual installation steps:
- Download the ZIP file from the Plugins home (see below).
- Unzip
SlideShowPlugin.zip in your twiki installation directory. Content: File: | Description: | data/TWiki/SlideShowPlugin.txt | Plugin topic | data/TWiki/VarSLIDESHOWSTART.txt | Documentation of the SLIDESHOWSTART variable | data/TWiki/VarSLIDESHOWEND.txt | Documentation of the SLIDESHOWEND variable | pub/TWiki/*.gif | Various button image files | lib/TWiki/Plugins/SlideShowPlugin.pm | Plugin Perl module | lib/TWiki/Plugins/SlideShowPlugin/SlideShow.pm | Plugin core module |
- Set the ownership of the extracted directories and files to the webserver user.
- Plugin configuration and testing:
- Run the configure script and enable the plugin in the Plugins section.
- Test if the installation was successful: See example above.
<--/twistyPlugin-->
Plugin Info
|
|
< < |
|
> > |
|
|
|
|
< < |
Plugin Version: |
2015-01-14 |
|
> > |
Plugin Version: |
2018-07-05 |
|
| <--/twistyPlugin twikiMakeVisibleInline--> |
|
> > |
|
|
2015-01-15: |
TWikibug:Item7604 : Switch from GPL v2 to v3 |
2013-04-07: |
TWikibug:Item7216 : Change default slide template from table layout to div layout; add Slide_N anchors for easy linking to specific slides; fix JS so that arrow key navigation works on Safari browser |
2013-01-13: |
TWikibug:Item7091 : Use TWISTY in plugin settings section, installation instructions and change history |
2012-11-14: |
TWikibug:Item7020 : Categorize TWiki Variables SLIDESHOWSTART, SLIDESHOWEND |
2012-09-05: |
TWikibug:Item6837 : Doc fixes |
2011-08-08: |
TWikibug:Item6789 : Better error handling in SLIDESHOWSTART variable |
2011-07-09: |
TWikibug:Item6725 : Change global package variables from "use vars" to "our" |
2010-12-28: |
TWikibug:Item6626 : New slide navigation using keys: Home, Left-arrow, Page-up, Right-arrow, Page-down, End and Esc |
2010-05-16: |
TWikibug:Item6433 : Doc improvements |
02 Aug 2008: |
Fixed corruption of preview |
29 Sep 2007: |
Added VarSLIDESHOWSTART and VarSLIDESHOWEND to have them listed in TWikiVariables |
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 |
<--/twistyPlugin-->
Related Topics: VarSLIDESHOWSTART, VarSLIDESHOWEND, TWikiPreferences, TWikiPlugins
META FILEATTACHMENT |
attachment="next.gif" attr="h" comment="Next button" date="1346889382" name="next.gif" path="next.gif" size="1249" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="prev.gif" attr="h" comment="Previous button" date="1346889382" name="prev.gif" path="prev.gif" size="1253" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="clearpixel.gif" size="807" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="startpres.gif" attr="h" comment="Start Presentation button" date="1346889382" name="startpres.gif" path="startpres.gif" size="2594" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="endpres.gif" attr="h" comment="End Presentation button" date="1346889382" name="endpres.gif" path="endpres.gif" size="2631" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Logo for slide template" date="1037760048" name="logo.gif" path="logo.gif" size="2877" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="first.gif" attr="h" comment="First slide button" date="1346889382" name="first.gif" path="first.gif" size="1265" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="last.gif" attr="h" comment="Last slide button" date="1346889382" name="last.gif" path="last.gif" size="1265" user="TWikiContributor" version="1" |
|
| Slide Show Plugin
<--
Contributions to this TWiki plugin are appreciated. Please update the plugin page at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPlugin or provide feedback at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPluginDev .
If you are a TWiki contributor please update the plugin in the SVN repository.
-->
|
|
< < | |
> > | |
|
Create web based presentations based on topics with headings.
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 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 compelling interactive presentations can be made using the TML (TWiki Markup Language) and plugins, such as TWiki:Plugins.ChartPlugin , TWiki:Plugins.GaugePlugin , TWiki:Plugins.SpreadSheetPlugin , TWiki:Plugins.TWikiDrawPlugin .
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 TWiki 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.
You can start the presentation by clicking on the "Start presentation" button.
Navigation
While in presentation mode you can move around slides using navigation buttons and keys:
Button |
Key |
Action |
|
Home |
Go to first slide |
|
Left-arrow, Page-up |
Go to previous slide |
|
Right-arrow, Page-down |
Go to next slide |
|
End |
Go to last slide |
|
Esc |
End presentation |
Slide navigation is quick because it is done using anchor jumps within the same page. Key-based navigation requires JavaScript enabled.
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 Link to Slides
The %SLIDESHOWSTART% renders as a button. This is the default way to link to the slideshow.
Slides have anchors names Slide_1 , Slide_2 , Slide_3 , etc. For example, write [[#Slide_3][Silly Introduction]] to link to slide 3 of the presentation on the current topic in page view mode, which renders as Silly Introduction.
Write [[%SCRIPTURL{view}%/%WEB%/%TOPIC%?slideshow=on;skin=print#Slide_3][Silly Introduction]] to link to a specific slide in presentation mode, which renders as Silly Introduction.
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:
Slide 1: Silly Sample Slideshow
By TWiki:Main.PeterThoeny
San Jose, 2012-04-07
Slide 2: Agenda
- Silly Introduction
- Silly Feature
- Silly Conclusion
Slide 3: Silly Introduction
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
Slide 4: Silly Feature
- it's foo bar
- more foo bar
Slide 5: Silly Conclusion
This text is not part of the slideshow
Default Slide Template
The part between the rulers defines the default format of a slide:
%SLIDENAVNEXT%
%SLIDETITLE%
%SLIDENAVALL%
COPYRIGHT © 2025 by the contributing authors
Slide %SLIDENUM% of %SLIDEMAX%
SlideShowPlugin Global Settings
<--/twistyPlugin twikiMakeVisibleInline-->
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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
<--/twistyPlugin-->
Plugin Installation Instructions
This plugin is pre-installed. TWiki administrators can upgrade the plugin as needed on the TWiki server.
<--/twistyPlugin twikiMakeVisibleInline-->
- For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
- Or, follow these manual installation steps:
- Download the ZIP file from the Plugins home (see below).
- Unzip
SlideShowPlugin.zip in your twiki installation directory. Content: File: | Description: | data/TWiki/SlideShowPlugin.txt | Plugin topic | data/TWiki/VarSLIDESHOWSTART.txt | Documentation of the SLIDESHOWSTART variable | data/TWiki/VarSLIDESHOWEND.txt | Documentation of the SLIDESHOWEND variable | pub/TWiki/*.gif | Various button image files | lib/TWiki/Plugins/SlideShowPlugin.pm | Plugin Perl module | lib/TWiki/Plugins/SlideShowPlugin/SlideShow.pm | Plugin core module |
- Set the ownership of the extracted directories and files to the webserver user.
- Plugin configuration and testing:
- Run the configure script and enable the plugin in the Plugins section.
- Test if the installation was successful: See example above.
<--/twistyPlugin-->
Plugin Info
|
|
< < |
|
> > |
|
|
|
|
< < |
Plugin Version: |
2013-01-07 |
|
> > |
Plugin Version: |
2015-01-14 |
|
| <--/twistyPlugin twikiMakeVisibleInline--> |
|
> > |
|
|
2013-04-07: |
TWikibug:Item7216 : Change default slide template from table layout to div layout; add Slide_N anchors for easy linking to specific slides; fix JS so that arrow key navigation works on Safari browser |
2013-01-13: |
TWikibug:Item7091 : Use TWISTY in plugin settings section, installation instructions and change history |
2012-11-14: |
TWikibug:Item7020 : Categorize TWiki Variables SLIDESHOWSTART, SLIDESHOWEND |
2012-09-05: |
TWikibug:Item6837 : Doc fixes |
2011-08-08: |
TWikibug:Item6789 : Better error handling in SLIDESHOWSTART variable |
2011-07-09: |
TWikibug:Item6725 : Change global package variables from "use vars" to "our" |
2010-12-28: |
TWikibug:Item6626 : New slide navigation using keys: Home, Left-arrow, Page-up, Right-arrow, Page-down, End and Esc |
2010-05-16: |
TWikibug:Item6433 : Doc improvements |
02 Aug 2008: |
Fixed corruption of preview |
29 Sep 2007: |
Added VarSLIDESHOWSTART and VarSLIDESHOWEND to have them listed in TWikiVariables |
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 |
<--/twistyPlugin-->
Related Topics: VarSLIDESHOWSTART, VarSLIDESHOWEND, TWikiPreferences, TWikiPlugins
META FILEATTACHMENT |
attachment="next.gif" attr="h" comment="Next button" date="1346889382" name="next.gif" path="next.gif" size="1249" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="prev.gif" attr="h" comment="Previous button" date="1346889382" name="prev.gif" path="prev.gif" size="1253" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="clearpixel.gif" size="807" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="startpres.gif" attr="h" comment="Start Presentation button" date="1346889382" name="startpres.gif" path="startpres.gif" size="2594" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="endpres.gif" attr="h" comment="End Presentation button" date="1346889382" name="endpres.gif" path="endpres.gif" size="2631" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Logo for slide template" date="1037760048" name="logo.gif" path="logo.gif" size="2877" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="first.gif" attr="h" comment="First slide button" date="1346889382" name="first.gif" path="first.gif" size="1265" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="last.gif" attr="h" comment="Last slide button" date="1346889382" name="last.gif" path="last.gif" size="1265" user="TWikiContributor" version="1" |
|
| Slide Show Plugin
<--
Contributions to this TWiki plugin are appreciated. Please update the plugin page at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPlugin or provide feedback at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPluginDev .
If you are a TWiki contributor please update the plugin in the SVN repository.
-->
Create web based presentations based on topics with headings.
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 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 compelling interactive presentations can be made using the TML (TWiki Markup Language) and plugins, such as TWiki:Plugins.ChartPlugin , TWiki:Plugins.GaugePlugin , TWiki:Plugins.SpreadSheetPlugin , TWiki:Plugins.TWikiDrawPlugin .
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 TWiki 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.
You can start the presentation by clicking on the "Start presentation" button.
Navigation
While in presentation mode you can move around slides using navigation buttons and keys:
Button |
Key |
Action |
|
Home |
Go to first slide |
|
Left-arrow, Page-up |
Go to previous slide |
|
Right-arrow, Page-down |
Go to next slide |
|
End |
Go to last slide |
|
Esc |
End presentation |
Slide navigation is quick because it is done using anchor jumps within the same page. Key-based navigation requires JavaScript enabled.
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 Link to Slides
The %SLIDESHOWSTART% renders as a button. This is the default way to link to the slideshow.
Slides have anchors names Slide_1 , Slide_2 , Slide_3 , etc. For example, write [[#Slide_3][Silly Introduction]] to link to slide 3 of the presentation on the current topic in page view mode, which renders as Silly Introduction.
Write [[%SCRIPTURL{view}%/%WEB%/%TOPIC%?slideshow=on;skin=print#Slide_3][Silly Introduction]] to link to a specific slide in presentation mode, which renders as Silly Introduction. |
| 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:
Slide 1: Silly Sample Slideshow
By TWiki:Main.PeterThoeny
|
|
< < | San Jose, 29 Sep 2007 |
> > | San Jose, 2012-04-07 |
|
Agenda
- Silly Introduction
- Silly Feature
- Silly Conclusion
Silly Introduction
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
Silly Feature
- it's foo bar
- more foo bar
Silly Conclusion
%SLIDESHOWEND%
This text is not part of the slideshow
Default Slide Template
The part between the rulers defines the default format of a slide:
|
|
< < |
 |
%SLIDETITLE% |
%SLIDENAVNEXT% |
|
> > |
%SLIDENAVNEXT%
%SLIDETITLE%
|
|
< < | |
| %SLIDETEXT% |
|
< < |
%SLIDENAVALL% |
Slide %SLIDENUM% of %SLIDEMAX% |
COPYRIGHT © 2025 by the contributing authors |
|
> > |
%SLIDENAVALL%
COPYRIGHT © 2025 by the contributing authors
Slide %SLIDENUM% of %SLIDEMAX% |
|
> > |
|
|
SlideShowPlugin Global Settings
<--/twistyPlugin twikiMakeVisibleInline-->
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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
<--/twistyPlugin-->
Plugin Installation Instructions
This plugin is pre-installed. TWiki administrators can upgrade the plugin as needed on the TWiki server.
<--/twistyPlugin twikiMakeVisibleInline-->
- For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
- Or, follow these manual installation steps:
- Download the ZIP file from the Plugins home (see below).
- Unzip
SlideShowPlugin.zip in your twiki installation directory. Content: File: | Description: | data/TWiki/SlideShowPlugin.txt | Plugin topic | data/TWiki/VarSLIDESHOWSTART.txt | Documentation of the SLIDESHOWSTART variable | data/TWiki/VarSLIDESHOWEND.txt | Documentation of the SLIDESHOWEND variable | pub/TWiki/*.gif | Various button image files | lib/TWiki/Plugins/SlideShowPlugin.pm | Plugin Perl module | lib/TWiki/Plugins/SlideShowPlugin/SlideShow.pm | Plugin core module |
- Set the ownership of the extracted directories and files to the webserver user.
- Plugin configuration and testing:
- Run the configure script and enable the plugin in the Plugins section.
- Test if the installation was successful: See example above.
<--/twistyPlugin-->
Plugin Info
|
|
< < |
Plugin Version: |
2013-01-13 |
|
> > |
Plugin Version: |
2013-01-07 |
|
| <--/twistyPlugin twikiMakeVisibleInline--> |
|
> > |
2013-04-07: |
TWikibug:Item7216 : Change default slide template from table layout to div layout; add Slide_N anchors for easy linking to specific slides; fix JS so that arrow key navigation works on Safari browser |
|
|
2013-01-13: |
TWikibug:Item7091 : Use TWISTY in plugin settings section, installation instructions and change history |
2012-11-14: |
TWikibug:Item7020 : Categorize TWiki Variables SLIDESHOWSTART, SLIDESHOWEND |
2012-09-05: |
TWikibug:Item6837 : Doc fixes |
2011-08-08: |
TWikibug:Item6789 : Better error handling in SLIDESHOWSTART variable |
2011-07-09: |
TWikibug:Item6725 : Change global package variables from "use vars" to "our" |
2010-12-28: |
TWikibug:Item6626 : New slide navigation using keys: Home, Left-arrow, Page-up, Right-arrow, Page-down, End and Esc |
2010-05-16: |
TWikibug:Item6433 : Doc improvements |
02 Aug 2008: |
Fixed corruption of preview |
29 Sep 2007: |
Added VarSLIDESHOWSTART and VarSLIDESHOWEND to have them listed in TWikiVariables |
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 |
<--/twistyPlugin-->
Related Topics: VarSLIDESHOWSTART, VarSLIDESHOWEND, TWikiPreferences, TWikiPlugins
META FILEATTACHMENT |
attachment="next.gif" attr="h" comment="Next button" date="1346889382" name="next.gif" path="next.gif" size="1249" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="prev.gif" attr="h" comment="Previous button" date="1346889382" name="prev.gif" path="prev.gif" size="1253" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="clearpixel.gif" size="807" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="startpres.gif" attr="h" comment="Start Presentation button" date="1346889382" name="startpres.gif" path="startpres.gif" size="2594" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="endpres.gif" attr="h" comment="End Presentation button" date="1346889382" name="endpres.gif" path="endpres.gif" size="2631" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Logo for slide template" date="1037760048" name="logo.gif" path="logo.gif" size="2877" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="first.gif" attr="h" comment="First slide button" date="1346889382" name="first.gif" path="first.gif" size="1265" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="last.gif" attr="h" comment="Last slide button" date="1346889382" name="last.gif" path="last.gif" size="1265" user="TWikiContributor" version="1" |
|
| Slide Show Plugin
<--
Contributions to this TWiki plugin are appreciated. Please update the plugin page at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPlugin or provide feedback at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPluginDev .
If you are a TWiki contributor please update the plugin in the SVN repository.
-->
Create web based presentations based on topics with headings.
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 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 compelling interactive presentations can be made using the TML (TWiki Markup Language) and plugins, such as TWiki:Plugins.ChartPlugin , TWiki:Plugins.GaugePlugin , TWiki:Plugins.SpreadSheetPlugin , TWiki:Plugins.TWikiDrawPlugin .
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 TWiki 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.
You can start the presentation by clicking on the "Start presentation" button.
Navigation
While in presentation mode you can move around slides using navigation buttons and keys:
Button |
Key |
Action |
|
Home |
Go to first slide |
|
Left-arrow, Page-up |
Go to previous slide |
|
Right-arrow, Page-down |
Go to next slide |
|
End |
Go to last slide |
|
Esc |
End presentation |
Slide navigation is quick because it is done using anchor jumps within the same page. Key-based navigation requires JavaScript enabled.
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:
Slide 1: Silly Sample Slideshow
By TWiki:Main.PeterThoeny
San Jose, 29 Sep 2007
Slide 2: Agenda
- Silly Introduction
- Silly Feature
- Silly Conclusion
Slide 3: Silly Introduction
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
Slide 4: Silly Feature
- it's foo bar
- more foo bar
Slide 5: Silly Conclusion
This text is not part of the slideshow |
|
< < | 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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
|
| 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 |
|
|
> > | SlideShowPlugin Global Settings
<--/twistyPlugin twikiMakeVisibleInline-->
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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
<--/twistyPlugin--> |
| Plugin Installation Instructions |
|
< < | Note: This plugin is pre-installed. TWiki administrators can upgrade it as needed on the TWiki server. |
> > | This plugin is pre-installed. TWiki administrators can upgrade the plugin as needed on the TWiki server. |
|
> > | <--/twistyPlugin twikiMakeVisibleInline--> |
|
- For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
- Or, follow these manual installation steps:
- Download the ZIP file from the Plugins home (see below).
- Unzip
SlideShowPlugin.zip in your twiki installation directory. Content: File: | Description: | data/TWiki/SlideShowPlugin.txt | Plugin topic | data/TWiki/VarSLIDESHOWSTART.txt | Documentation of the SLIDESHOWSTART variable | data/TWiki/VarSLIDESHOWEND.txt | Documentation of the SLIDESHOWEND variable | pub/TWiki/*.gif | Various button image files | lib/TWiki/Plugins/SlideShowPlugin.pm | Plugin Perl module | lib/TWiki/Plugins/SlideShowPlugin/SlideShow.pm | Plugin core module |
- Set the ownership of the extracted directories and files to the webserver user.
- Plugin configuration and testing:
- Run the configure script and enable the plugin in the Plugins section.
- Test if the installation was successful: See example above.
|
|
> > | <--/twistyPlugin--> |
| Plugin Info |
|
> > | |
|
|
|
< < |
|
> > |
|
|
|
|
< < |
Plugin Version: |
2012-12-14 |
Change History: |
<-- versions below in reverse order --> |
|
> > |
Plugin Version: |
2013-01-13 |
%TWISTY{ |
|
> > | mode="div"
showlink="Show Change History http://amazedbygrace.org/pub/TWiki/TWikiDocGraphics/toggleopen.gif"
hidelink="Hide Change History "
}%
2013-01-13: |
TWikibug:Item7091 : Use TWISTY in plugin settings section, installation instructions and change history |
|
|
2012-11-14: |
TWikibug:Item7020 : Categorize TWiki Variables SLIDESHOWSTART, SLIDESHOWEND |
2012-09-05: |
TWikibug:Item6837 : Doc fixes |
2011-08-08: |
TWikibug:Item6789 : Better error handling in SLIDESHOWSTART variable |
2011-07-09: |
TWikibug:Item6725 : Change global package variables from "use vars" to "our" |
2010-12-28: |
TWikibug:Item6626 : New slide navigation using keys: Home, Left-arrow, Page-up, Right-arrow, Page-down, End and Esc |
2010-05-16: |
TWikibug:Item6433 : Doc improvements |
02 Aug 2008: |
Fixed corruption of preview |
29 Sep 2007: |
Added VarSLIDESHOWSTART and VarSLIDESHOWEND to have them listed in TWikiVariables |
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 |
|
|
> > | </> <--/twistyPlugin-->
|
|
Related Topics: VarSLIDESHOWSTART, VarSLIDESHOWEND, TWikiPreferences, TWikiPlugins
META FILEATTACHMENT |
attachment="next.gif" attr="h" comment="Next button" date="1346889382" name="next.gif" path="next.gif" size="1249" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="prev.gif" attr="h" comment="Previous button" date="1346889382" name="prev.gif" path="prev.gif" size="1253" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="clearpixel.gif" size="807" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="startpres.gif" attr="h" comment="Start Presentation button" date="1346889382" name="startpres.gif" path="startpres.gif" size="2594" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="endpres.gif" attr="h" comment="End Presentation button" date="1346889382" name="endpres.gif" path="endpres.gif" size="2631" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Logo for slide template" date="1037760048" name="logo.gif" path="logo.gif" size="2877" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="first.gif" attr="h" comment="First slide button" date="1346889382" name="first.gif" path="first.gif" size="1265" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="last.gif" attr="h" comment="Last slide button" date="1346889382" name="last.gif" path="last.gif" size="1265" user="TWikiContributor" version="1" |
|
| Slide Show Plugin
<--
Contributions to this TWiki plugin are appreciated. Please update the plugin page at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPlugin or provide feedback at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPluginDev .
If you are a TWiki contributor please update the plugin in the SVN repository.
-->
Create web based presentations based on topics with headings.
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 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 compelling interactive presentations can be made using the TML (TWiki Markup Language) and plugins, such as TWiki:Plugins.ChartPlugin , TWiki:Plugins.GaugePlugin , TWiki:Plugins.SpreadSheetPlugin , TWiki:Plugins.TWikiDrawPlugin .
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 TWiki 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.
You can start the presentation by clicking on the "Start presentation" button.
Navigation
While in presentation mode you can move around slides using navigation buttons and keys:
Button |
Key |
Action |
|
Home |
Go to first slide |
|
Left-arrow, Page-up |
Go to previous slide |
|
Right-arrow, Page-down |
Go to next slide |
|
End |
Go to last slide |
|
Esc |
End presentation |
Slide navigation is quick because it is done using anchor jumps within the same page. Key-based navigation requires JavaScript enabled.
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:
Slide 1: Silly Sample Slideshow
By TWiki:Main.PeterThoeny
San Jose, 29 Sep 2007
Slide 2: Agenda
- Silly Introduction
- Silly Feature
- Silly Conclusion
Slide 3: Silly Introduction
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
Slide 4: Silly Feature
- it's foo bar
- more foo bar
Slide 5: Silly Conclusion
This text is not part of the slideshow
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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
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: This plugin is pre-installed. TWiki administrators can upgrade it as needed on the TWiki server.
- For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
- Or, follow these manual installation steps:
- Download the ZIP file from the Plugins home (see below).
- Unzip
SlideShowPlugin.zip in your twiki installation directory. Content: File: | Description: | data/TWiki/SlideShowPlugin.txt | Plugin topic | data/TWiki/VarSLIDESHOWSTART.txt | Documentation of the SLIDESHOWSTART variable | data/TWiki/VarSLIDESHOWEND.txt | Documentation of the SLIDESHOWEND variable | pub/TWiki/*.gif | Various button image files | lib/TWiki/Plugins/SlideShowPlugin.pm | Plugin Perl module | lib/TWiki/Plugins/SlideShowPlugin/SlideShow.pm | Plugin core module |
- Set the ownership of the extracted directories and files to the webserver user.
- Plugin configuration and testing:
- Run the configure script and enable the plugin in the Plugins section.
- Test if the installation was successful: See example above.
Plugin Info
|
|
< < |
Plugin Version: |
2012-09-05 |
|
> > |
Plugin Version: |
2012-12-14 |
|
|
Change History: |
<-- versions below in reverse order --> |
|
|
> > |
2012-11-14: |
TWikibug:Item7020 : Categorize TWiki Variables SLIDESHOWSTART, SLIDESHOWEND |
|
|
2012-09-05: |
TWikibug:Item6837 : Doc fixes |
2011-08-08: |
TWikibug:Item6789 : Better error handling in SLIDESHOWSTART variable |
2011-07-09: |
TWikibug:Item6725 : Change global package variables from "use vars" to "our" |
2010-12-28: |
TWikibug:Item6626 : New slide navigation using keys: Home, Left-arrow, Page-up, Right-arrow, Page-down, End and Esc |
2010-05-16: |
TWikibug:Item6433 : Doc improvements |
02 Aug 2008: |
Fixed corruption of preview |
29 Sep 2007: |
Added VarSLIDESHOWSTART and VarSLIDESHOWEND to have them listed in TWikiVariables |
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.005 |
TWiki:Plugins/Benchmark : |
GoodStyle 98%, FormattedSearch 99%, SlideShowPlugin 99% |
Plugin Home: |
http://TWiki.org/cgi-bin/view/Plugins/SlideShowPlugin |
Feedback: |
http://TWiki.org/cgi-bin/view/Plugins/SlideShowPluginDev |
Appraisal: |
http://TWiki.org/cgi-bin/view/Plugins/SlideShowPluginAppraisal |
Related Topics: VarSLIDESHOWSTART, VarSLIDESHOWEND, TWikiPreferences, TWikiPlugins
META FILEATTACHMENT |
attachment="next.gif" attr="h" comment="Next button" date="1346889382" name="next.gif" path="next.gif" size="1249" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="prev.gif" attr="h" comment="Previous button" date="1346889382" name="prev.gif" path="prev.gif" size="1253" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="clearpixel.gif" size="807" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="startpres.gif" attr="h" comment="Start Presentation button" date="1346889382" name="startpres.gif" path="startpres.gif" size="2594" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="endpres.gif" attr="h" comment="End Presentation button" date="1346889382" name="endpres.gif" path="endpres.gif" size="2631" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Logo for slide template" date="1037760048" name="logo.gif" path="logo.gif" size="2877" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="first.gif" attr="h" comment="First slide button" date="1346889382" name="first.gif" path="first.gif" size="1265" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="last.gif" attr="h" comment="Last slide button" date="1346889382" name="last.gif" path="last.gif" size="1265" user="TWikiContributor" version="1" |
|
| Slide Show Plugin
<--
Contributions to this TWiki plugin are appreciated. Please update the plugin page at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPlugin or provide feedback at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPluginDev .
If you are a TWiki contributor please update the plugin in the SVN repository.
-->
Create web based presentations based on topics with headings.
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 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. |
> > | 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 compelling interactive presentations can be made using the TML (TWiki Markup Language) and plugins, such as TWiki:Plugins.ChartPlugin , TWiki:Plugins.GaugePlugin , TWiki:Plugins.SpreadSheetPlugin , TWiki:Plugins.TWikiDrawPlugin . |
|
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 TWiki 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.
You can start the presentation by clicking on the "Start presentation" button.
Navigation
While in presentation mode you can move around slides using navigation buttons and keys:
|
|
< < |
|
Left-arrow, Pagu-up |
Go to previous slide |
|
> > |
|
Left-arrow, Page-up |
Go to previous slide |
|
|
|
Right-arrow, Page-down |
Go to next slide |
|
End |
Go to last slide |
|
Esc |
End presentation |
Slide navigation is quick because it is done using anchor jumps within the same page. Key-based navigation requires JavaScript enabled.
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:
Slide 1: Silly Sample Slideshow
|
|
< < | By TWiki:Main/PeterThoeny |
> > | By TWiki:Main.PeterThoeny |
|
San Jose, 29 Sep 2007
Agenda
- Silly Introduction
- Silly Feature
- Silly Conclusion
Silly Introduction
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
Silly Feature
- it's foo bar
- more foo bar
Silly Conclusion
%SLIDESHOWEND%
This text is not part of the slideshow
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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
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 TWiki is running. |
> > | Note: This plugin is pre-installed. TWiki administrators can upgrade it as needed on the TWiki server. |
| |
|
< < |
- Download the ZIP file from the Plugin Home (see below)
|
> > |
- For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.
|
|
< < |
- Unzip
SlideShowPlugin.zip in your twiki installation directory. Content: File: | Description: | data/TWiki/SlideShowPlugin.txt | Plugin topic | lib/TWiki/Plugins/SlideShowPlugin.pm | Plugin Perl module | lib/TWiki/Plugins/SlideShowPlugin/SlideShow.pm | Plugin Perl module | pub/TWiki/*.gif | Various button image files |
- TWiki 4.0 and up: Run the configure script, and enable the plugin in the {Plugins} section.
- Test above example if the installation was successful.
|
| |
|
> > |
- Or, follow these manual installation steps:
- Download the ZIP file from the Plugins home (see below).
- Unzip
SlideShowPlugin.zip in your twiki installation directory. Content: File: | Description: | data/TWiki/SlideShowPlugin.txt | Plugin topic | data/TWiki/VarSLIDESHOWSTART.txt | Documentation of the SLIDESHOWSTART variable | data/TWiki/VarSLIDESHOWEND.txt | Documentation of the SLIDESHOWEND variable | pub/TWiki/*.gif | Various button image files | lib/TWiki/Plugins/SlideShowPlugin.pm | Plugin Perl module | lib/TWiki/Plugins/SlideShowPlugin/SlideShow.pm | Plugin core module |
- Set the ownership of the extracted directories and files to the webserver user.
- Plugin configuration and testing:
- Run the configure script and enable the plugin in the Plugins section.
- Test if the installation was successful: See example above.
|
| Plugin Info
|
|
< < |
|
> > |
|
|
|
|
< < |
Plugin Version: |
2011-08-08 |
|
> > |
Plugin Version: |
2012-09-05 |
|
|
Change History: |
<-- versions below in reverse order --> |
|
|
> > |
|
|
2011-08-08: |
TWikibug:Item6789 : Better error handling in SLIDESHOWSTART variable |
2011-07-09: |
TWikibug:Item6725 : Change global package variables from "use vars" to "our" |
2010-12-28: |
TWikibug:Item6626 : New slide navigation using keys: Home, Left-arrow, Page-up, Right-arrow, Page-down, End and Esc |
2010-05-16: |
TWikibug:Item6433 : Doc improvements |
02 Aug 2008: |
Fixed corruption of preview |
29 Sep 2007: |
Added VarSLIDESHOWSTART and VarSLIDESHOWEND to have them listed in TWikiVariables |
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.005 |
TWiki:Plugins/Benchmark : |
GoodStyle 98%, FormattedSearch 99%, SlideShowPlugin 99% |
Plugin Home: |
http://TWiki.org/cgi-bin/view/Plugins/SlideShowPlugin |
Feedback: |
http://TWiki.org/cgi-bin/view/Plugins/SlideShowPluginDev |
Appraisal: |
http://TWiki.org/cgi-bin/view/Plugins/SlideShowPluginAppraisal |
|
|
< < | Related Topics: VarSLIDESHOWSTART and VarSLIDESHOWEND, TWikiPreferences, TWikiPlugins |
> > | Related Topics: VarSLIDESHOWSTART, VarSLIDESHOWEND, TWikiPreferences, TWikiPlugins |
| |
|
< < |
META FILEATTACHMENT |
attr="h" comment="Next button" date="1037510613" name="next.gif" path="next.gif" size="993" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Prev button" date="1037510599" name="prev.gif" path="prev.gif" size="993" user="TWikiContributor" version="1" |
|
> > |
META FILEATTACHMENT |
attachment="next.gif" attr="h" comment="Next button" date="1346889382" name="next.gif" path="next.gif" size="1249" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="prev.gif" attr="h" comment="Previous button" date="1346889382" name="prev.gif" path="prev.gif" size="1253" user="TWikiContributor" version="1" |
|
|
META FILEATTACHMENT |
attr="h" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="clearpixel.gif" size="807" user="TWikiContributor" version="1" |
|
|
< < |
META FILEATTACHMENT |
attr="h" comment="Start Presentation button" date="1037759933" name="startpres.gif" path="startpres.gif" size="2065" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="End Presentation button" date="1037759950" name="endpres.gif" path="endpres.gif" size="2066" user="TWikiContributor" version="1" |
|
> > |
META FILEATTACHMENT |
attachment="startpres.gif" attr="h" comment="Start Presentation button" date="1346889382" name="startpres.gif" path="startpres.gif" size="2594" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="endpres.gif" attr="h" comment="End Presentation button" date="1346889382" name="endpres.gif" path="endpres.gif" size="2631" user="TWikiContributor" version="1" |
|
|
META FILEATTACHMENT |
attr="h" comment="Logo for slide template" date="1037760048" name="logo.gif" path="logo.gif" size="2877" user="TWikiContributor" version="1" |
|
|
< < |
META FILEATTACHMENT |
attr="h" comment="First slide button" date="1037951064" name="first.gif" path="first.gif" size="1010" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Last slide button" date="1037951080" name="last.gif" path="last.gif" size="1014" user="TWikiContributor" version="1" |
|
> > |
META FILEATTACHMENT |
attachment="first.gif" attr="h" comment="First slide button" date="1346889382" name="first.gif" path="first.gif" size="1265" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attachment="last.gif" attr="h" comment="Last slide button" date="1346889382" name="last.gif" path="last.gif" size="1265" user="TWikiContributor" version="1" |
|
| |
| Slide Show Plugin
<--
Contributions to this TWiki plugin are appreciated. Please update the plugin page at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPlugin or provide feedback at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPluginDev .
If you are a TWiki contributor please update the plugin in the SVN repository.
-->
Create web based presentations based on topics with headings.
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 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.
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 TWiki 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.
You can start the presentation by clicking on the "Start presentation" button.
Navigation
While in presentation mode you can move around slides using navigation buttons and keys:
Button |
Key |
Action |
|
Home |
Go to first slide |
|
Left-arrow, Pagu-up |
Go to previous slide |
|
Right-arrow, Page-down |
Go to next slide |
|
End |
Go to last slide |
|
Esc |
End presentation |
Slide navigation is quick because it is done using anchor jumps within the same page. Key-based navigation requires JavaScript enabled.
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:
Slide 1: Silly Sample Slideshow
By TWiki:Main/PeterThoeny
San Jose, 29 Sep 2007
Slide 2: Agenda
- Silly Introduction
- Silly Feature
- Silly Conclusion
Slide 3: Silly Introduction
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
Slide 4: Silly Feature
- it's foo bar
- more foo bar
Slide 5: Silly Conclusion
This text is not part of the slideshow
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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
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 TWiki is running.
- Download the ZIP file from the Plugin Home (see below)
- Unzip
SlideShowPlugin.zip in your twiki installation directory. Content: File: | Description: | data/TWiki/SlideShowPlugin.txt | Plugin topic | lib/TWiki/Plugins/SlideShowPlugin.pm | Plugin Perl module | lib/TWiki/Plugins/SlideShowPlugin/SlideShow.pm | Plugin Perl module | pub/TWiki/*.gif | Various button image files |
- TWiki 4.0 and up: Run the configure script, and enable the plugin in the {Plugins} section.
- Test above example if the installation was successful.
Plugin Info |
|
< < |
|
> > |
|
|
|
|
< < |
Plugin Version: |
2010-12-28 |
|
> > |
Plugin Version: |
2011-08-08 |
|
|
Change History: |
<-- versions below in reverse order --> |
|
|
> > |
|
|
2010-12-28: |
TWikibug:Item6626 : New slide navigation using keys: Home, Left-arrow, Page-up, Right-arrow, Page-down, End and Esc |
2010-05-16: |
TWikibug:Item6433 : Doc improvements |
02 Aug 2008: |
Fixed corruption of preview |
29 Sep 2007: |
Added VarSLIDESHOWSTART and VarSLIDESHOWEND to have them listed in TWikiVariables |
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.005 |
TWiki:Plugins/Benchmark : |
GoodStyle 98%, FormattedSearch 99%, SlideShowPlugin 99% |
Plugin Home: |
http://TWiki.org/cgi-bin/view/Plugins/SlideShowPlugin |
Feedback: |
http://TWiki.org/cgi-bin/view/Plugins/SlideShowPluginDev |
Appraisal: |
http://TWiki.org/cgi-bin/view/Plugins/SlideShowPluginAppraisal |
|
|
< < | Related Topics: TWikiPreferences, TWikiPlugins |
> > | Related Topics: VarSLIDESHOWSTART and VarSLIDESHOWEND, TWikiPreferences, TWikiPlugins |
|
META FILEATTACHMENT |
attr="h" comment="Next button" date="1037510613" name="next.gif" path="next.gif" size="993" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Prev button" date="1037510599" name="prev.gif" path="prev.gif" size="993" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="clearpixel.gif" size="807" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Start Presentation button" date="1037759933" name="startpres.gif" path="startpres.gif" size="2065" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="End Presentation button" date="1037759950" name="endpres.gif" path="endpres.gif" size="2066" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Logo for slide template" date="1037760048" name="logo.gif" path="logo.gif" size="2877" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="First slide button" date="1037951064" name="first.gif" path="first.gif" size="1010" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Last slide button" date="1037951080" name="last.gif" path="last.gif" size="1014" user="TWikiContributor" version="1" |
|
| Slide Show Plugin
<--
Contributions to this TWiki plugin are appreciated. Please update the plugin page at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPlugin or provide feedback at
http://twiki.org/cgi-bin/view/Plugins/SlideShowPluginDev .
If you are a TWiki contributor please update the plugin in the SVN repository.
--> |
|
> > | |
| |
|
> > | |
| Create web based presentations based on topics with headings.
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 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.
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 TWiki 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.
|
> > |
- Presentation mode: Each heading with text is shown as a slide; the format is based on a slide template.
|
|
You can start the presentation by clicking on the "Start presentation" button. |
|
> > | Navigation
While in presentation mode you can move around slides using navigation buttons and keys:
Button |
Key |
Action |
|
Home |
Go to first slide |
|
Left-arrow, Pagu-up |
Go to previous slide |
|
Right-arrow, Page-down |
Go to next slide |
|
End |
Go to last slide |
|
Esc |
End presentation |
Slide navigation is quick because it is done using anchor jumps within the same page. Key-based navigation requires JavaScript enabled. |
| 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:
Slide 1: Silly Sample Slideshow
By TWiki:Main/PeterThoeny
San Jose, 29 Sep 2007
Slide 2: Agenda
- Silly Introduction
- Silly Feature
- Silly Conclusion
Slide 3: Silly Introduction
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
Slide 4: Silly Feature
- it's foo bar
- more foo bar
Slide 5: Silly Conclusion
This text is not part of the slideshow
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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
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 TWiki is running.
- Download the ZIP file from the Plugin Home (see below)
- Unzip
SlideShowPlugin.zip in your twiki installation directory. Content: File: | Description: | data/TWiki/SlideShowPlugin.txt | Plugin topic | lib/TWiki/Plugins/SlideShowPlugin.pm | Plugin Perl module | lib/TWiki/Plugins/SlideShowPlugin/SlideShow.pm | Plugin Perl module | pub/TWiki/*.gif | Various button image files |
- TWiki 4.0 and up: Run the configure script, and enable the plugin in the {Plugins} section.
- Test above example if the installation was successful.
Plugin Info
|
|
< < |
Plugin Version: |
2010-05-16 |
|
> > |
Plugin Version: |
2010-12-28 |
|
|
Change History: |
<-- versions below in reverse order --> |
|
|
< < |
|
> > |
2010-12-28: |
TWikibug:Item6626 : New slide navigation using keys: Home, Left-arrow, Page-up, Right-arrow, Page-down, End and Esc |
|
|
> > |
|
|
Related Topics: TWikiPreferences, TWikiPlugins
META FILEATTACHMENT |
attr="h" comment="Next button" date="1037510613" name="next.gif" path="next.gif" size="993" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Prev button" date="1037510599" name="prev.gif" path="prev.gif" size="993" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="clearpixel.gif" size="807" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Start Presentation button" date="1037759933" name="startpres.gif" path="startpres.gif" size="2065" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="End Presentation button" date="1037759950" name="endpres.gif" path="endpres.gif" size="2066" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Logo for slide template" date="1037760048" name="logo.gif" path="logo.gif" size="2877" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="First slide button" date="1037951064" name="first.gif" path="first.gif" size="1010" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Last slide button" date="1037951080" name="last.gif" path="last.gif" size="1014" user="TWikiContributor" version="1" |
|
| Slide Show Plugin |
|
< < |
This plugin converts a topic with headings into a slideshow. |
> > |
|
| |
|
> > |
Create web based presentations based on topics with headings. |
|
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 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.
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 TWiki 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:
Slide 1: Silly Sample Slideshow
By TWiki:Main/PeterThoeny
San Jose, 29 Sep 2007
Slide 2: Agenda
- Silly Introduction
- Silly Feature
- Silly Conclusion
Slide 3: Silly Introduction
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
Slide 4: Silly Feature
- it's foo bar
- more foo bar
Slide 5: Silly Conclusion
This text is not part of the slideshow
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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
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 TWiki is running.
- Download the ZIP file from the Plugin Home (see below)
- Unzip
SlideShowPlugin.zip in your twiki installation directory. Content: File: | Description: | data/TWiki/SlideShowPlugin.txt | Plugin topic | lib/TWiki/Plugins/SlideShowPlugin.pm | Plugin Perl module | lib/TWiki/Plugins/SlideShowPlugin/SlideShow.pm | Plugin Perl module | pub/TWiki/*.gif | Various button image files |
- TWiki 4.0 and up: Run the configure script, and enable the plugin in the {Plugins} section.
- Test above example if the installation was successful.
Plugin Info
|
|
< < |
Copyright: |
© 2006-2007, Peter Thoeny, TWIKI.NET |
|
> > |
|
|
|
|
< < |
Plugin Version: |
02 Aug 2008 |
|
> > |
Plugin Version: |
2010-05-16 |
|
|
Change History: |
<-- versions below in reverse order --> |
|
|
> > |
|
|
Related Topics: TWikiPreferences, TWikiPlugins |
|
< < |
META FILEATTACHMENT |
attr="h" comment="Next button" date="1037510613" name="next.gif" path="C:\Data\next.gif" size="993" user="TWikiContributor" version="1.2" |
META FILEATTACHMENT |
attr="h" comment="Prev button" date="1037510599" name="prev.gif" path="C:\Data\prev.gif" size="993" user="TWikiContributor" version="1.2" |
META FILEATTACHMENT |
attr="h" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="C:\Data\clearpixel.gif" size="807" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="Start Presentation button" date="1037759933" name="startpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\startpres.gif" size="2065" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="End Presentation button" date="1037759950" name="endpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\endpres.gif" size="2066" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="Logo for slide template" date="1037760048" name="logo.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\logo.gif" size="2877" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="First slide button" date="1037951064" name="first.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\first.gif" size="1010" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="Last slide button" date="1037951080" name="last.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\last.gif" size="1014" user="TWikiContributor" version="1.1" |
|
> > |
META FILEATTACHMENT |
attr="h" comment="Next button" date="1037510613" name="next.gif" path="next.gif" size="993" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Prev button" date="1037510599" name="prev.gif" path="prev.gif" size="993" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="clearpixel.gif" size="807" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Start Presentation button" date="1037759933" name="startpres.gif" path="startpres.gif" size="2065" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="End Presentation button" date="1037759950" name="endpres.gif" path="endpres.gif" size="2066" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Logo for slide template" date="1037760048" name="logo.gif" path="logo.gif" size="2877" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="First slide button" date="1037951064" name="first.gif" path="first.gif" size="1010" user="TWikiContributor" version="1" |
META FILEATTACHMENT |
attr="h" comment="Last slide button" date="1037951080" name="last.gif" path="last.gif" size="1014" user="TWikiContributor" version="1" |
|
| |
| 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 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.
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 TWiki 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:
Slide 1: Silly Sample Slideshow
By TWiki:Main/PeterThoeny
San Jose, 29 Sep 2007
Slide 2: Agenda
- Silly Introduction
- Silly Feature
- Silly Conclusion
Slide 3: Silly Introduction
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
Slide 4: Silly Feature
- it's foo bar
- more foo bar
Slide 5: Silly Conclusion
This text is not part of the slideshow
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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
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 TWiki is running.
- Download the ZIP file from the Plugin Home (see below)
- Unzip
SlideShowPlugin.zip in your twiki installation directory. Content: File: | Description: | data/TWiki/SlideShowPlugin.txt | Plugin topic | lib/TWiki/Plugins/SlideShowPlugin.pm | Plugin Perl module | lib/TWiki/Plugins/SlideShowPlugin/SlideShow.pm | Plugin Perl module | pub/TWiki/*.gif | Various button image files |
- TWiki 4.0 and up: Run the configure script, and enable the plugin in the {Plugins} section.
- Test above example if the installation was successful.
Plugin Info
|
|
< < |
Plugin Version: |
29 Sep 2007 (15091) |
|
> > |
Plugin Version: |
02 Aug 2008 |
|
|
Change History: |
<-- versions below in reverse order --> |
|
|
> > |
02 Aug 2008: |
Fixed corruption of preview |
|
|
Related Topics: TWikiPreferences, TWikiPlugins
META FILEATTACHMENT |
attr="h" comment="Next button" date="1037510613" name="next.gif" path="C:\Data\next.gif" size="993" user="TWikiContributor" version="1.2" |
META FILEATTACHMENT |
attr="h" comment="Prev button" date="1037510599" name="prev.gif" path="C:\Data\prev.gif" size="993" user="TWikiContributor" version="1.2" |
META FILEATTACHMENT |
attr="h" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="C:\Data\clearpixel.gif" size="807" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="Start Presentation button" date="1037759933" name="startpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\startpres.gif" size="2065" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="End Presentation button" date="1037759950" name="endpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\endpres.gif" size="2066" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="Logo for slide template" date="1037760048" name="logo.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\logo.gif" size="2877" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="First slide button" date="1037951064" name="first.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\first.gif" size="1010" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="Last slide button" date="1037951080" name="last.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\last.gif" size="1014" user="TWikiContributor" version="1.1" |
|
| Slide Show Plugin |
|
< < | This Plugin converts a topic with headings into a slide show. |
> > | 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 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. |
> > | 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. |
| |
|
< < | 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: |
> > | 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 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.
|
> > |
- 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.
- 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 |
> > | 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 slide show with
%SLIDESHOWEND%
|
> > |
- 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 slide show with the %SLIDESHOWSTART{ template="MyOwnSlideTemplate" }% setting. |
> > | 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.
|
> > |
- 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 slide show. You should see a "Start presentation" button if this Plugin is installed: |
> > | This is a short example of a slideshow. You should see a "Start presentation" button if this plugin is installed: |
|
|
|
< < | Silly Sample Slide Show |
> > | Silly Sample Slideshow |
|
By TWiki:Main/PeterThoeny |
|
< < | San Jose, 17 Nov 2002 |
> > | San Jose, 29 Sep 2007 |
|
Agenda |
|
< < |
- Silly Introduction
- Silly Feature
- Silly Conclusion
|
> > |
- Silly Introduction
- Silly Feature
- Silly Conclusion
|
| Silly Introduction |
|
< < | |
> > | |
| Comments |
|
< < |
- This text is not shown in the slide if HIDECOMMENTS is set to on.
|
> > |
- This text is not shown in the slide if HIDECOMMENTS is set to on.
|
| Silly Feature |
|
< < |
- it's foo bar
- more foo bar
|
> > |
- it's foo bar
- more foo bar
|
| Silly Conclusion |
|
< < | |
> > | |
| %SLIDESHOWEND% |
|
< < | This text is not part of the slide show |
> > | This text is not part of the slideshow |
|
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.
|
> > |
- 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 )
|
> > |
- Debug plugin: (See output in
data/debug.txt )
|
| |
|
< < |
- Default template for slides:
|
> > |
- Default template for slides:
|
| |
|
< < |
- Hide text starting with a
---+++ Comments heading:
|
> > |
- Hide text starting with a
---+++ Comments heading:
|
|
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 TWiki is running. |
|
< < |
- Download the ZIP file from the Plugin web (see below)
- Unzip
SlideShowPlugin.zip in your twiki installation directory. Content: File: | Description: | data/TWiki/SlideShowPlugin.txt | Plugin topic | lib/TWiki/Plugins/SlideShowPlugin.pm | Plugin Perl module | lib/TWiki/Plugins/SlideShowPlugin/SlideShow.pm | Plugin Perl module | pub/TWiki/*.gif | Various button image files |
- TWiki 4.0 and up: Run the configure script, and enable the plugin in the {Plugins} section.
- Test above example if the installation was successful.
|
> > |
- Download the ZIP file from the Plugin Home (see below)
- Unzip
SlideShowPlugin.zip in your twiki installation directory. Content: File: | Description: | data/TWiki/SlideShowPlugin.txt | Plugin topic | lib/TWiki/Plugins/SlideShowPlugin.pm | Plugin Perl module | lib/TWiki/Plugins/SlideShowPlugin/SlideShow.pm | Plugin Perl module | pub/TWiki/*.gif | Various button image files |
- TWiki 4.0 and up: Run the configure script, and enable the plugin in the {Plugins} section.
- Test above example if the installation was successful.
|
|
Plugin Info
|
|
< < |
|
> > |
Copyright: |
© 2006-2007, Peter Thoeny, TWIKI.NET |
|
|
|
|
< < |
|
> > |
Plugin Version: |
29 Sep 2007 (15091) |
|
|
Change History: |
<-- versions below in reverse order --> |
|
|
> > |
|
|
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.005 |
|
|
< < |
|
> > |
|
|
|
|
< < | Related Topics: TWikiPreferences, TWikiPlugins |
> > | Related Topics: TWikiPreferences, TWikiPlugins |
|
META FILEATTACHMENT |
attr="h" comment="Next button" date="1037510613" name="next.gif" path="C:\Data\next.gif" size="993" user="TWikiContributor" version="1.2" |
META FILEATTACHMENT |
attr="h" comment="Prev button" date="1037510599" name="prev.gif" path="C:\Data\prev.gif" size="993" user="TWikiContributor" version="1.2" |
META FILEATTACHMENT |
attr="h" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="C:\Data\clearpixel.gif" size="807" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="Start Presentation button" date="1037759933" name="startpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\startpres.gif" size="2065" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="End Presentation button" date="1037759950" name="endpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\endpres.gif" size="2066" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="Logo for slide template" date="1037760048" name="logo.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\logo.gif" size="2877" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="First slide button" date="1037951064" name="first.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\first.gif" size="1010" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="Last slide button" date="1037951080" name="last.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\last.gif" size="1014" user="TWikiContributor" version="1.1" |
|
|
< < | |
| Slide Show Plugin
This Plugin converts a topic with headings into a slide show.
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 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 | %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 slide show. You should see a "Start presentation" button if this Plugin is installed:
Slide 1: Silly Sample Slide Show
By TWiki:Main/PeterThoeny
San Jose, 17 Nov 2002
Slide 2: Agenda
- Silly Introduction
- Silly Feature
- Silly Conclusion
Slide 3: Silly Introduction
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
Slide 4: Silly Feature
- it's foo bar
- more foo bar
Slide 5: Silly Conclusion
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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
Default Slide Template
The part between the rulers defines the default format of a slide:
|
|
< < | |
> > | |
| |
|
< < | |
> > | |
| |
|
< < | |
> > | |
|
 |
%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 TWiki is running.
- Download the ZIP file from the Plugin web (see below)
- Unzip
SlideShowPlugin.zip in your twiki installation directory. Content:
|
|
< < |
data/TWiki/SlideShowPlugin.txt,v |
Plugin topic repository |
|
|
lib/TWiki/Plugins/SlideShowPlugin.pm |
Plugin Perl module |
|
|
> > |
lib/TWiki/Plugins/SlideShowPlugin/SlideShow.pm |
Plugin Perl module |
|
|
pub/TWiki/*.gif |
Various button image files |
|
|
< < |
- (Dakar) Visit
configure in your TWiki installation, and enable the plugin in the {Plugins} section.
|
> > |
- TWiki 4.0 and up: Run the configure script, and enable the plugin in the {Plugins} section.
|
|
- Test above example if the installation was successful.
Plugin Info
|
|
< < |
|
> > |
|
|
> > |
|
|
Change History: |
<-- versions below in reverse order --> |
|
|
> > |
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 |
|
|
Related Topics: TWikiPreferences, TWikiPlugins |
|
< < |
META FILEATTACHMENT |
attr="" comment="Next button" date="1037510613" name="next.gif" path="C:\Data\next.gif" size="993" user="TWikiContributor" version="1.2" |
META FILEATTACHMENT |
attr="" comment="Prev button" date="1037510599" name="prev.gif" path="C:\Data\prev.gif" size="993" user="TWikiContributor" version="1.2" |
META FILEATTACHMENT |
attr="" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="C:\Data\clearpixel.gif" size="807" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Start Presentation button" date="1037759933" name="startpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\startpres.gif" size="2065" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="" comment="End Presentation button" date="1037759950" name="endpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\endpres.gif" size="2066" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Logo for slide template" date="1037760048" name="logo.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\logo.gif" size="2877" user="TWikiContributor" version="1.1" |
|
> > |
META FILEATTACHMENT |
attr="h" comment="Next button" date="1037510613" name="next.gif" path="C:\Data\next.gif" size="993" user="TWikiContributor" version="1.2" |
META FILEATTACHMENT |
attr="h" comment="Prev button" date="1037510599" name="prev.gif" path="C:\Data\prev.gif" size="993" user="TWikiContributor" version="1.2" |
META FILEATTACHMENT |
attr="h" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="C:\Data\clearpixel.gif" size="807" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="Start Presentation button" date="1037759933" name="startpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\startpres.gif" size="2065" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="End Presentation button" date="1037759950" name="endpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\endpres.gif" size="2066" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="Logo for slide template" date="1037760048" name="logo.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\logo.gif" size="2877" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="First slide button" date="1037951064" name="first.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\first.gif" size="1010" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="h" comment="Last slide button" date="1037951080" name="last.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\last.gif" size="1014" user="TWikiContributor" version="1.1" |
|
|
< < |
META FILEATTACHMENT |
attr="" comment="First slide button" date="1037951064" name="first.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\first.gif" size="1010" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Last slide button" date="1037951080" name="last.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\last.gif" size="1014" user="TWikiContributor" version="1.1" |
|
| |
|
< < | Slide Show Plugin
This Plugin converts a topic with headings into a slide show.
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 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.
Example
This is a short example of a slide show. You should see a "Start presentation" button if this Plugin is installed:
Slide 1: Silly Sample Slide Show
By TWiki:Main/PeterThoeny
San Jose, 17 Nov 2002
Slide 2: Agenda
- Silly Introduction
- Silly Feature
- Silly Conclusion
Slide 3: Silly Introduction
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
Slide 4: Silly Feature
- it's foo bar
- more foo bar
Slide 5: Silly Conclusion
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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
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 TWiki is running.
- Download the ZIP file from the Plugin web (see below)
- Unzip
SlideShowPlugin.zip 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/SlideShowPlugin.pm | 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: |
<-- versions below in reverse order --> |
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: |
http://TWiki.org/cgi-bin/view/Plugins/SlideShowPlugin |
Feedback: |
http://TWiki.org/cgi-bin/view/Plugins/SlideShowPluginDev |
Related Topics: TWikiPreferences, TWikiPlugins
-- TWiki:Main.PeterThoeny - 21 Mar 2004
META FILEATTACHMENT |
attr="" comment="Clear pixel for spacing" date="1071216910" name="clearpixel.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\clearpixel.gif" size="807" user="PeterThoeny" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Start Presentation button" date="1071217038" name="startpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\startpres.gif" size="2065" user="PeterThoeny" version="1.1" |
META FILEATTACHMENT |
attr="" comment="End Presentation button" date="1071217056" name="endpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\endpres.gif" size="2066" user="PeterThoeny" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Logo for slide template" date="1071217079" name="logo.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\logo.gif" size="2877" user="PeterThoeny" version="1.1" |
META FILEATTACHMENT |
attr="" comment="First slide button" date="1071217098" name="first.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\first.gif" size="1010" user="PeterThoeny" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Last slide button" date="1071217111" name="last.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\last.gif" size="1014" user="PeterThoeny" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Next button" date="1071217145" name="next.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\next.gif" size="993" user="PeterThoeny" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Prev button" date="1071217162" name="prev.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\prev.gif" size="993" user="PeterThoeny" version="1.1" |
|
> > |
Slide Show Plugin
This Plugin converts a topic with headings into a slide show.
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 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 | %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 slide show. You should see a "Start presentation" button if this Plugin is installed:
Slide 1: Silly Sample Slide Show
By TWiki:Main/PeterThoeny
San Jose, 17 Nov 2002
Slide 2: Agenda
- Silly Introduction
- Silly Feature
- Silly Conclusion
Slide 3: Silly Introduction
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
Slide 4: Silly Feature
- it's foo bar
- more foo bar
Slide 5: Silly Conclusion
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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
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 TWiki is running.
- Download the ZIP file from the Plugin web (see below)
- Unzip
SlideShowPlugin.zip 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/SlideShowPlugin.pm | Plugin Perl module | pub/TWiki/*.gif | Various button image files |
- (Dakar) Visit
configure in your TWiki installation, and enable the plugin in the {Plugins} section.
- Test above example if the installation was successful.
Plugin Info
Related Topics: TWikiPreferences, TWikiPlugins |
|
> > |
META FILEATTACHMENT |
attr="" comment="Next button" date="1037510613" name="next.gif" path="C:\Data\next.gif" size="993" user="TWikiContributor" version="1.2" |
META FILEATTACHMENT |
attr="" comment="Prev button" date="1037510599" name="prev.gif" path="C:\Data\prev.gif" size="993" user="TWikiContributor" version="1.2" |
META FILEATTACHMENT |
attr="" comment="Clear pixel for spacing" date="1037523452" name="clearpixel.gif" path="C:\Data\clearpixel.gif" size="807" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Start Presentation button" date="1037759933" name="startpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\startpres.gif" size="2065" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="" comment="End Presentation button" date="1037759950" name="endpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\endpres.gif" size="2066" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Logo for slide template" date="1037760048" name="logo.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\logo.gif" size="2877" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="" comment="First slide button" date="1037951064" name="first.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\first.gif" size="1010" user="TWikiContributor" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Last slide button" date="1037951080" name="last.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\last.gif" size="1014" user="TWikiContributor" version="1.1" |
|
| |
| Slide Show Plugin
This Plugin converts a topic with headings into a slide show.
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 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.
Example
This is a short example of a slide show. You should see a "Start presentation" button if this Plugin is installed:
Slide 1: Silly Sample Slide Show
By TWiki:Main/PeterThoeny
San Jose, 17 Nov 2002
Slide 2: Agenda
- Silly Introduction
- Silly Feature
- Silly Conclusion
Slide 3: Silly Introduction
Comments
- This text is not shown in the slide if HIDECOMMENTS is set to on.
Slide 4: Silly Feature
- it's foo bar
- more foo bar
Slide 5: Silly Conclusion
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 )
- Default template for slides:
- Hide text starting with a
---+++ Comments heading:
Default Slide Template
The part between the rulers defines the default format of a slide:
|
%SLIDETITLE% |
%SLIDENAVNEXT% |
|
|
< < | |
> > | |
|
%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 TWiki is running.
- Download the ZIP file from the Plugin web (see below)
- Unzip
SlideShowPlugin.zip 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/SlideShowPlugin.pm | Plugin Perl module | pub/TWiki/*.gif | Various button image files |
- Test above example if the installation was successful.
Plugin Info
|
|
< < |
Plugin Version: |
24 Dec 2002 (V1.003) |
|
> > |
Plugin Version: |
21 Mar 2004 (V1.003) |
|
|
Change History: |
<-- versions below in reverse order --> |
|
|
> > |
21 Mar 2004: |
Internal change: Fixed inofficial function call |
|
|
Related Topics: TWikiPreferences, TWikiPlugins |
|
< < | -- PeterThoeny - 14 Dec 2002 |
> > | -- TWiki:Main.PeterThoeny - 21 Mar 2004 |
|
META FILEATTACHMENT |
attr="" comment="Clear pixel for spacing" date="1071216910" name="clearpixel.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\clearpixel.gif" size="807" user="PeterThoeny" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Start Presentation button" date="1071217038" name="startpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\startpres.gif" size="2065" user="PeterThoeny" version="1.1" |
META FILEATTACHMENT |
attr="" comment="End Presentation button" date="1071217056" name="endpres.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\endpres.gif" size="2066" user="PeterThoeny" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Logo for slide template" date="1071217079" name="logo.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\logo.gif" size="2877" user="PeterThoeny" version="1.1" |
META FILEATTACHMENT |
attr="" comment="First slide button" date="1071217098" name="first.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\first.gif" size="1010" user="PeterThoeny" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Last slide button" date="1071217111" name="last.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\last.gif" size="1014" user="PeterThoeny" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Next button" date="1071217145" name="next.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\next.gif" size="993" user="PeterThoeny" version="1.1" |
META FILEATTACHMENT |
attr="" comment="Prev button" date="1071217162" name="prev.gif" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\prev.gif" size="993" user="PeterThoeny" version="1.1" |
|