====== S5 Presentations ======

---- plugin ----
description: Create slideshow presentations from a DokuWiki page
author     : Andreas Gohr
email      : andi@splitbrain.org
type       : render
lastupdate : 2009-01-07
compatible : 2008-05-05
depends    : 
conflicts  : 
similar    : 
tags       : media, slideshow, javascript
----

//S5 is a slide show format based entirely on XHTML, CSS, and JavaScript. With one file, you can run a complete slide show and have a printer-friendly version as well.//

This plugin can create [[http://meyerweb.com/eric/tools/s5/|S5 slide show]] presentations from any DokuWiki page.


===== Download and Install =====

Use this URL to download or install the plugin through the plugin manager.

  * {{http://dev.splitbrain.org/download/snapshots/s5-plugin-latest.tgz}}

==== Changes ====

{{rss>http://dev.splitbrain.org/darcsweb/darcsweb.cgir=dwplugins/s5;a=rss}}

===== Configuration =====

  * You may choose from 7 different themes using the config manager or setting ''%%$conf['plugin']['s5']['template']%%''.
  * New S5 themes can be installed in ''lib/plugins/s5/ui/''
  * If you're using the [[folded]] plugin, you may have to make sure the ''getSort()'' level for it is higher than the s5 plugin.


===== Usage =====

Usage is simple. Just add ''%%~~SLIDESHOW~~%%'' somewhere in the page (at the very top is recommended), and start your page with a H1 headline. Following content will go on the first (welcome) slide. Additional slides are created by H2 headlines. Adding a horizontal rule finishes the current slide and additional content goes to the "Handout" area (only visible when the slide is printed). Footnotes and abbreviation will be ignored on the slide. Plugin output won't be visible unless a plugin handles the mode ''s5'' explicitly.

Have a look at this [[plugin:s5:example|Example Presentation]] (follow the link and press the slideshow icon in the upper right corner).

Opera users need to press ''F11'' to enter the presentation mode. Navigating between the slides is then possible using ''PAGE_UP'' and ''PAGE_DOWN''.


Another option is to insert a link to the s5 view of any page in your template. For example edit: <wiki_dir>/lib/tpl/<your-template>/main.php to add
<code><a href="<php echo exportlink($ID, 's5')>" title="online slideshow"><img src="<php echo DOKU_BASE>lib/plugins/s5/screen.gif" height="16px" alt="online slideshow"></a></code>
in the bar__topright div.


====== Discussion ======

S5 looks great already.  I think a really important feature would be to make the slide-show savable.  That is, if I save the documentation file with Save Web Page (Complete) under Firefox, the resulting HTML file should be usable off-line.  

Unfortunately, right now, when I save a presentation, the output still seems to depend on network resources.  (See [[http://www.tiddlywiki.com/]] for an example of what is possible with saved HTML files containing JavaScript.)

----

I don't know it it's a bug but I had to add this rewrite rule, hope it can help someone :
<file>RewriteRule ^_export/([^/]+)/(.*)$    doku.phpdo=export_$1&id=$2 [QSA,L]</file>
[[http://www.zeitoun.net|Stéphane Gully]]

> No, this is not a bug. That RewriteRule was added to the standard DokuWiki installation since the latest stable release (2006-11-06, in devel since 2006-04-05). But as the .htaccess file is never overwritten during the upgrading process, changes to it are often overlooked. So, it is worth mentioning here.

>>Hello. Perhaps it should be possible to extend the ODF plugin in order to save the slideshow in Impress ODF XML format 
--- //[[sa.majeste4@gmail.com|Smat]] 2009-08-24 23:15//
----
How exactly do we add the rewrite rule

> Edit ''<dokuwiki>/.htaccess'' and add the rule mentioned above after the following line:
<file>RewriteRule ^_detail/(.*)                           lib/exe/detail.phpmedia=$1             [QSA,L]</file>  --- //[[chi@chimeric.de|Michael Klier]] 2007-07-11 16:14//

----
How can we easily escape from the slideshow

> Insert a regular DokuWiki link to the page itself on the first and last slide. The link will work when the slide is displayed and brings you back in the wiki read condition.  
 --- //[[atc.gerritsen@hccnet.nl|Ton Gerritsen]] 2007-08-09 14:59//

>> Insert the backlink in the footer area. Change renderer.php 
  <div id="footer">
  <h1>'.$ID.'</h1>
to
  <div id="footer">
  <h1>'.html_wikilink($ID).'</h1>
 --- //[[hans.huber@oleco.net|Hans Huber]] 2007-08-30 13:47//
----
Unfortunately, I got a "No renderer for s found" after installing an clicking on the Slideshow image.
I'm using Debian Sage and DokuWiki 2006-11-06, have you any Idea
> Okay fixed it, I saw DokuWiki 2007-07-06RC is needed 8-)

 --- //[[hans.huber@oleco.net|Hans Huber]] 2007-08-30 9:55//

----
Jay Dickon Glanville writes:

> I have two questions concerning the S5 slide show plugin.
>
> 1) Is there a way to preview the slide show without having to save the
> article first

no

> 2) There is a way to change the theme of a slide show, but that
> affects all slide shows in the wiki (in the config manager).  Is there
> a way to state the theme for a single slide show

no

Andi

--- //Jay Dickon Glanville 2007-09-25 8:09//
----
Hi Andreas,

after installing your plugin within a current DokuWiki version and putting <code>~~SLIDESHOW~~</code> at the top of a page I am receiving this error message:
Fatal error: Call to undefined function exportlink() in /home/netsh10317/html/dokuwiki/lib/plugins/s5/syntax.php on line 71

What is the reason

--- //Ayshe 2007-10-22//

----

Hi Andreas,

we want to have a page break before each slide. We tried to modify "each" CSS without a positive result. Our idea was to add a page-break for h2. 

  h2 {page-break-before: always;}

The best would be if there is another print slideshow button, so the user can decide whether he wants to print it in the normal way (File->Print) or to get a slideshow handout (new button beside the slideshow button).

--- //Michael Arlt 2007-11-02//

----


Any chance for math plugin support so that the formulas would get proper size font too. 

In practice, this would mean that command \Huge should be added in front of formula when showing it on presentation.
e.g. when you have <math>\lambda=c*T </math> in normal DokuWiki document, when presentation is created it should be 
<math>\Huge\lambda=c*T<math> and thus the mimetex plugin provides proper size formula.

> I got math support to work using the [[plugin:jsmath|jsMath plugin]].  All the equations resize appropriately with the slideshow.  After installation of jsMath, change ''lib/plugins/s5/renderer.php'' to include following line of code to the ''<head>'' part of the HTML (around line 90): <code html><SCRIPT SRC="http://path_to_your_jsMath_folder/easy/load.js" type="text/javascript"></SCRIPT> </code>
> --- //Adam Morgan 2008-12-04 18:00//

Similar problem arises with figures. How to show them in proper size on text and in presentation.


----

For normal images you can add in s5 renderer.php following code

   function internalmedia($src,$title=NULL,$align=NULL,$width=NULL,$height=NULL,$cache=NULL,$linking=NULL) {
        global $ID;
        resolve_mediaid(getNS($ID),$src,$exists);
        list($ext,$mime) =mimetype($src);
        // if figure alignment has not been changed we assume that figure should be "full screen"
        // so we make it's width 800
        if(substr($mime,0,5) == 'image'){
          if ($align==NULL){
             $width = 800;
          }
        // we have figure with alignment, so we assume that there is some text in this slide also
        // so we just double it's size so it should look nice in show
          else{ 
            if ($width)   
                $width = 2*$width;
            if ($height) 
                $height=2*$height;
          }
          $this->doc .= $this->_media ($src, $title, $align, $width, $height, $cache);
        }
        else {
            parent::internalmedia($src,$title,$align,$width,$height,$cache,$linking);
        }
    } 

This will double the size of the images which location have been set i.e. we assume there are text along with image on this slide. In case the location has not been defined, we make the image width to 800. Depending on the resolution you want to show your presentation, you might want to change the width to fit for you. 

--- // Pekka Jäppinen 2008-1-7//

===Floating Images===
As it's common practice to have right aligned pictures in a presentation, you might experience your Presentation jams in non-s5 mode (which you don't want for shure ;)\\
You can fix this by adding linebreaks (ugly) \\
or you can use this Plugin:
http://www.dokuwiki.org/plugin:clearfloat
 -- dothebart
----
Nice plugin, but when I click on the slideshow icon all I get is the error message: 

  No renderer for s found

What have I missed 

 -- Simon North 


=== show listings one by one ===

In the documentation you can read, that it´s possible to show listings incremental. You can read [[http://yatil.de/s5/funktionen/|there]], that you can enable that feature by adding "incremental" to the class. 

Does anyone have a clue where to add this in a DokuWiki page or in source

Greetings ---- Steve

Could this be done by the [[http://www.dokuwiki.org/plugin:important_paragraf|important-paragraph-plugin]].

<code>!!increment|  * unordered List</code>

Greetings -- Christian

=== Text doesn't fit to side ===

We have a big document and I want to make a slideshow out of it. The problem is, that the slideshow only shows a part oft text  in the the first page oft the show and in this page isn't the whole text of this part. Then you have the second page of the slide and there is also not tho whole text of this part of Text. And so on...

How can I have all sides with all the text of the document in one slideshow

Greetings -- Oli

==== AsciimathMl and S5 ====

I made the S5 work with asciimathml javascript library - see explanation on the:
[[plugin:asciimath]] asciimath plugin page. The principle is as shown above for jmath, but obviously with reference to the asciimath javascript file. My reason for not using jmath was the wish for use of $$ as delimiter (And I could not figure out how to get all the fonts in place for Jmath).
>-- J Lauritsen Feb 12th 2009

==== S5 and Redirect ====
Hello, Is there any way to get this //great// plugin to work in combination with the redirect: http://www.dokuwiki.org/plugin:page_redirector  meaning: to display in slideshow mode the content of the redirect target page rather than the original page content.

I would be willing to have a look at the code, but have no clue where to start. Any help is welcome either here or by mail: berteh@hotmail.com.

-- Berteh Feb 19th 2009

==== Not working ====
This is not working with my DokuWiki install. I thought it might be my template, but I switched to the default - no dice. I also tried to FTP it instead of uploading from the URL, and no luck. Help