%META:TOPICINFO{author="TWikiContributor" date="1452383393" format="1.1" version="16"}%
---+!! Slide Show Plugin
%TOC%
%SHORTDESCRIPTION%
---++ 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* |
| %ATTACHURL%/first.gif | Home | Go to first slide |
| %ATTACHURL%/prev.gif | Left-arrow, Page-up | Go to previous slide |
| %ATTACHURL%/next.gif | Right-arrow, Page-down | Go to next slide |
| %ATTACHURL%/last.gif | End | Go to last slide |
| %ATTACHURL%/endpres.gif | 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 %ATTACHURL%/startpres.gif 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 [[#Slide_3][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 [[%SCRIPTURL{view}%/%WEB%/%TOPIC%?slideshow=on;skin=print#Slide_3][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:
%SLIDESHOWSTART%
---+++ Silly Sample Slideshow
%BR%
By TWiki:Main.PeterThoeny
San Jose, 2012-04-07
---+++ Agenda
* Silly Introduction
* Silly Feature
* Silly Conclusion
---+++ Silly Introduction
* why foo bar
* blah blah
---++++ 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
* foo is bar
* bar is foo
%SLIDESHOWEND%
This text is not part of the slideshow
---++ Default Slide Template
The part between the rulers defines the default format of a slide:
-----
%STARTINCLUDE%
