Changes between Initial Version and Version 1 of SlideShowPlugin

Timestamp:

Aug 28, 2010, 8:17:56 PM (14 years ago)

Author:

Ryan J Ollos

Comment:

Content moved from S5Plugin page.

SlideShowPlugin

@@ +1 @@
+[[PageOutline(2-5,Contents,pullout)]]
+= Convert content of wiki pages to S5 Slideshows =
+
+== Description ==
+
+This page documents the `0.11`/`0.12` version of the plugin. For the `0.10` version documentation, see [wiki:S5Plugin/0.10].
+
+The S5 plugin converts Wiki pages into a DHTML enabled slideshow using [http://meyerweb.com/eric/tools/s5/ S5]. It is based loosely on the [http://wiki.splitbrain.org/plugin:s5 DocuWiki S5 plugin].
+
+Click the ''Slideshow'' link at the bottom of any Wiki page to view that page using S5. Alternatively you can add the `[[SlideShow]]` macro to a page.
+
+A top-level level 1 heading (`= Heading =`) and its following section will be converted into the title page of the slideshow, with following level 2 headings and their corresponding sections converted into subsequent slides.
+
+=== Themes ===
+
+There are 7 themes available, copied from the !DocuWiki plugin as the original links on the S5 page were broken. The themes are ''blue'', ''default'', ''dokuwiki'', ''flower'', ''i18n'', ''pixel'', and ''yatil''.
+
+Themes can be selected from the macro with: `[[SlideShow(theme=<theme>)]]`.
+
+== Bugs/Feature Requests == 
+
+Existing bugs and feature requests for S5Plugin are 
+[report:9?COMPONENT=S5Plugin here].
+
+If you have any issues, create a 
+[http://trac-hacks.org/newticket?component=S5Plugin&owner=rjollos new ticket].
+
+== Download ==
+
+Download the zipped source from [download:s5plugin here].
+
+== Source ==
+
+You can check out S5Plugin from [http://trac-hacks.org/svn/s5plugin here] using Subversion, or [source:s5plugin browse the source] with Trac.
+
+== Install ==
+
+ 1. Install
+   * By hand:
+     1. ....
+   * Using easy_install:
+{{{
+#!sh
+$ [sudo] easy_install https://trac-hacks.org/svn/s5plugin/0.11
+}}}
+    * ,,`sudo` is optional case you already have enough authority to modify your server.,,
+ 1. Restart your web server ,,(this example command line for Apache on Ubuntu),,.
+{{{
+#!sh
+$ [sudo] /etc/init.d/apache2 restart
+}}}
+ 1. Enable the plugin. 
+   * by updating your [wiki:TracIni trac.ini] with this:
+{{{
+[components]
+...
+s5.s5.s5renderer = enabled
+...
+}}}
+   * or accessing your Admin panel ({{{ ..admin/general/plugins }}});
+ 1. Configure your environment. See section bellow.
+{{{
+#!comment
+   * by modifiying `trac.ini` file;
+   * by accessing your Admin panel case you have WebAdminPlugin enabled;
+}}}
+ 1. Plugin install troubleshooting (general) visit [http://trac.edgewall.org/wiki/TracPlugins TracPlugins].
+
+== Configure ==
+
+There are a few options that can be specified in the `[s5slideshow]` section of ''trac.ini''.
+
+The '''Slideshow''' content conversion link at the bottom of each wiki page can be disabled with the following option:
+{{{
+show_content_conversion = false
+}}}
+
+The default theme can be specified with the following option:
+{{{
+default_theme = <themename>
+}}}
+
+Note that one of the themes is named ''default'' and if the `default_theme` option is unspecified, then `default_theme = default` is used.
+
+== Example ==
+
+{{{
+#!html
+<pre class="code"><div style="background: #ddf">
+= Slideshow Title =
+
+Title page content.
+
+</div><div style="background: #fdd">
+== Slide 1 Title ==
+
+Slide 1 content.
+
+</div><div style="background: #dfd">
+== Slide 2 Title ==
+
+Slide 2 content.
+
+</div></pre>
+}}}
+
+[[Image(title.png)]]
+
+== Recent Changes ==
+
+[[ChangeLog(s5plugin/0.11, 3)]]
+
+== Author/Contributors ==
+
+'''Author:''' [wiki:athomas] [[BR]]
+'''Maintainer:''' [wiki:rjollos] [[BR]]
+'''Contributors:''' dgynn, JimCheetham