Apache Forrest s5 Plugin

This plugin enables you to automatically create slides from Apache Forrest Documents. It uses S5: A Simple Standards-Based Slide Show System to present the slides.

Viewing Slide Shows

To view any page as a slide show simply place s5slides at the start of a pages URL. For example, s5slides/index.html will show this page as a slideshow.

There are two ways of generating slides, the first is fully automatic, whilst the second requires that documents be marked up accordingly. The automatic method is a convenient technique for some types of document, but does not work well in all cases. The manual approach provides full control over the generation of slides and is therefore much more powerful.

The Manual Method

The manual method of creating slide shows is the most reliable. To indicate a section should be a slide simply add a class attribute with the value slide. For example:

`
<section>
  <title>This section is not a Slide</title>
  <p>This is a normal section.</p>
</section>

<section class="slide">
  <title>This section is a Slide</title>
  <p>This section is a slide, it will be displayed as normal in a web page or PDF
  document (although you could have the skin hide it since it has a unique 
  class). In slide view it will appear as a slide.</p>
</section>

        

You can view an example of a manually described slide.

The Automatic Method

The automatic method does its best to create a slideshow from any Forrest docuemnt. It uses some basic rules to decide what a slide should look like. At present this facility is very limited, but we welcome contributions and suggestions to improve upon it.

See automatic sample for more information.

This plugin would not be possible without S5: A Simple Standards-Based Slide Show System. There is much more to this plugin than is currently documented, I recomend you visit the the S5 introductory slide show for a full breakdown of functionality.