1 rizwank 1.1 %META:TOPICINFO{author="PeterThoeny" date="1079859586" format="1.0" version="1.2"}%
2 ---+!! Slide Show Plugin
3
4 This Plugin converts a topic with headings into a slide show.
5
6 %TOC%
7
8 ---++ Introduction
9
10 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.
11
12 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:
13
14 * 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.
15 * 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.
16
17 You can start the presentation by clicking on the "Start presentation" button.
18
19 ---++ Syntax Rules
20
21 ---+++ How to Create a Slide Show
22 rizwank 1.1
23 * Start with =%<nop>SLIDESHOWSTART%=
24 * Use the optional =template= parameter to specify your own slide template topic, e.g. =%<nop>SLIDESHOWSTART{ template="MyOwnSlideTemplate" }%=
25 * Create the slides. Start each slide with a ="---++"= heading and add text like paragraphs, bullets, tables and images.
26 * __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.
27 * __Note:__ You can use any heading level you like, but use the same for all slides.
28 * End your slide show with =%<nop>SLIDESHOWEND%=
29
30 ---+++ How to Create Your own Slide Template
31
32 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 =%<nop>SLIDESHOWSTART{ template="MyOwnSlideTemplate" }%= setting.
33
34 * Use an HTML table that defines a slide. For example, create one row for the slide title, another one for the slide text.
35 * These keywords can be used:
36 | *Keyword* | *What it means* |
37 | =%<nop>SLIDETITLE%= | The heading of the slide |
38 | =%<nop>SLIDETEXT%= | The text of the slide |
39 | =%<nop>SLIDENUM%= | The current slide number |
40 | =%<nop>SLIDEMAX%= | The last slide number |
41 | =%<nop>SLIDENAV%= | The navigation buttons for "First", "Previous", "Next" slide |
42 | =%<nop>SLIDENAVALL%= | The navigation buttons for "First", "Previous", "Next", "Last" slide |
43 rizwank 1.1 | =%<nop>SLIDENAVFIRST%= | The navigation button for "First slide" |
44 | =%<nop>SLIDENAVPREV%= | The navigation button for "Previous slide" |
45 | =%<nop>SLIDENAVNEXT%= | The navigation button for "Next slide" |
46 | =%<nop>SLIDENAVLAST%= | The navigation button for "Last slide" |
47 * Only text between =%<nop>STARTINCLUDE%= and =%<nop>STOPINCLUDE%= is used for the template.
48
49 ---++ Example
50
51 This is a short example of a slide show. You should see a "Start presentation" button if this Plugin is installed:
52
53 %SLIDESHOWSTART%
54 ---+++ Silly Sample Slide Show
55 %BR%
56
57 <center>
58 By TWiki:Main/PeterThoeny
59
60 San Jose, 17 Nov 2002
61 </center>
62
63 ---+++ Agenda
64 rizwank 1.1 * Silly Introduction
65 * Silly Feature
66 * Silly Conclusion
67 ---+++ Silly Introduction
68 * why foo bar
69 * blah blah
70 ---++++ Comments
71 * This text is not shown in the slide if HIDECOMMENTS is set to on.
72 ---+++ Silly Feature
73 * it's foo bar
74 * more foo bar
75 ---+++ Silly Conclusion
76 * foo is bar
77 * bar is foo
78 %SLIDESHOWEND%
79
80 This text is not part of the slide show
81
82 ---++ <nop>%TOPIC% Global Settings
83
84 Plugin settings are stored as preferences variables. To reference a plugin setting write ==%<nop><plugin>_<setting>%==, i.e. ==%<nop>SLIDESHOWPLUGIN_SHORTDESCRIPTION%==
85 rizwank 1.1
86 * One line description, is shown in the %TWIKIWEB%.TextFormattingRules topic:
87 * Set SHORTDESCRIPTION = Create web based presentations based on topics with headings.
88
89 * Debug plugin: (See output in =data/debug.txt=)
90 * Set DEBUG = 0
91
92 * Default template for slides:
93 * Set TEMPLATE = SlideShowPlugin
94
95 * Hide text starting with a =---+++ Comments= heading:
96 * Set HIDECOMMENTS = on
97
98 ---++ Default Slide Template
99
100 The part between the rulers defines the default format of a slide:
101
102 -----
103 %STARTINCLUDE%
104 <table width="100%" border="0" cellspacing="0" cellpadding="0">
105 <tr bgcolor="#003399"><td valign="middle" width="2%">
106 rizwank 1.1 <img src="%PUBURL%/%WEB%/SlideShowPlugin/logo.gif" border="0" alt="TWiki Slide Show" /> </td>
107 <td valign="middle">
108 <font size="+3" color="#FFFFFF">%SLIDETITLE%</font></td>
109 <td align="right" valign="middle">
110 %SLIDENAVNEXT% </td>
111 </tr>
112 </table>
113 <table width="100%" border="0" cellspacing="0" cellpadding="3">
114 <tr bgcolor="#FFFF99"><td width="1">
115 <img src="%PUBURL%/%WEB%/SlideShowPlugin/clearpixel.gif" width="1" height="480" alt="" /></td>
116 <td valign="top">
117 %BR%
118 <font size="+2" color="#003399">
119 %SLIDETEXT%
120 </font></td></tr>
121 </table>
122 <table width="100%" border="0" cellspacing="0" cellpadding="0">
123 <tr bgcolor="#FFFFCC"><td valign="middle">
124 %SLIDENAVALL% </td>
125 <td valign="middle" align="right">
126 <font size="-1" color="#666666">Slide %SLIDENUM% of %SLIDEMAX%</font></td>
127 rizwank 1.1 <td valign="middle" align="right">
128 <font size="-2" color="#666666"> COPYRIGHT © %SERVERTIME{$year}% by the contributing authors </font></td></tr>
129 </table>
130 %STOPINCLUDE%
131 -----
132
133 ---++ Plugin Installation Instructions
134
135 __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.
136
137 * Download the ZIP file from the Plugin web (see below)
138 * Unzip ==%TOPIC%.zip== in your twiki installation directory. Content:
139 | *File:* | *Description:* |
140 | ==data/TWiki/%TOPIC%.txt== | Plugin topic |
141 | ==data/TWiki/%TOPIC%.txt,v== | Plugin topic repository |
142 | ==lib/TWiki/Plugins/%TOPIC%.pm== | Plugin Perl module |
143 | ==pub/TWiki/*.gif== | Various button image files |
144 * Test above example if the installation was successful.
145
146 ---++ Plugin Info
147
148 rizwank 1.1 | Plugin Author: | TWiki:Main/PeterThoeny |
149 | Plugin Version: | 21 Mar 2004 (V1.003) |
150 | Change History: | <!-- versions below in reverse order --> |
151 | 21 Mar 2004: | Internal change: Fixed inofficial function call |
152 | 14 Dec 2002: | Added =%<nop>SLIDENAVALL%= template keyword; added HIDECOMMENTS setting |
153 | 23 Nov 2002: | Added =%<nop>SLIDENAVLAST%= template keyword; using print Skin for presentation mode |
154 | 19 Nov 2002: | Added "Start presentation" and "End presentation" buttons; added =%<nop>SLIDENAVFIRST%=, =%<nop>SLIDENAVPREV%=, =%<nop>SLIDENAVNEXT%= template keywords |
155 | 17 Nov 2002: | Initial version |
156 | CPAN Dependencies: | none |
157 | Other Dependencies: | none |
158 | Perl Version: | 5.005 |
159 | Plugin Home: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC% |
160 | Feedback: | http://TWiki.org/cgi-bin/view/Plugins/%TOPIC%Dev |
161
162 __Related Topics:__ %TWIKIWEB%.TWikiPreferences, %TWIKIWEB%.TWikiPlugins
163
164 -- TWiki:Main.PeterThoeny - 21 Mar 2004
165 %META:FILEATTACHMENT{name="clearpixel.gif" attr="" comment="Clear pixel for spacing" date="1071216910" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\clearpixel.gif" size="807" user="PeterThoeny" version="1.1"}%
166 %META:FILEATTACHMENT{name="startpres.gif" attr="" comment="Start Presentation button" date="1071217038" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\startpres.gif" size="2065" user="PeterThoeny" version="1.1"}%
167 %META:FILEATTACHMENT{name="endpres.gif" attr="" comment="End Presentation button" date="1071217056" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\endpres.gif" size="2066" user="PeterThoeny" version="1.1"}%
168 %META:FILEATTACHMENT{name="logo.gif" attr="" comment="Logo for slide template" date="1071217079" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\logo.gif" size="2877" user="PeterThoeny" version="1.1"}%
169 rizwank 1.1 %META:FILEATTACHMENT{name="first.gif" attr="" comment="First slide button" date="1071217098" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\first.gif" size="1010" user="PeterThoeny" version="1.1"}%
170 %META:FILEATTACHMENT{name="last.gif" attr="" comment="Last slide button" date="1071217111" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\last.gif" size="1014" user="PeterThoeny" version="1.1"}%
171 %META:FILEATTACHMENT{name="next.gif" attr="" comment="Next button" date="1071217145" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\next.gif" size="993" user="PeterThoeny" version="1.1"}%
172 %META:FILEATTACHMENT{name="prev.gif" attr="" comment="Prev button" date="1071217162" path="C:\Data\MyTWiki\Plugins\SlideShowPlugin\pub\TWiki\SlideShowPlugin\prev.gif" size="993" user="PeterThoeny" version="1.1"}%
|
Return to
SlideShowPlugin.txt
CVS log
Up to [RizwankCVS] / geekymedia_web / twiki / data / TWiki