| 1 | [[PageOutline(2-5,Contents,pullout)]] |
| 2 | = Convert content of wiki pages to S5 Slideshows = |
| 3 | |
| 4 | == Description == |
| 5 | |
| 6 | This page documents the `0.11`/`0.12` version of the plugin. For the `0.10` version documentation, see [wiki:S5Plugin/0.10]. |
| 7 | |
| 8 | 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]. |
| 9 | |
| 10 | 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. |
| 11 | |
| 12 | 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. |
| 13 | |
| 14 | === Themes === |
| 15 | |
| 16 | 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''. |
| 17 | |
| 18 | Themes can be selected from the macro with: `[[SlideShow(theme=<theme>)]]`. |
| 19 | |
| 20 | == Bugs/Feature Requests == |
| 21 | |
| 22 | Existing bugs and feature requests for S5Plugin are |
| 23 | [report:9?COMPONENT=S5Plugin here]. |
| 24 | |
| 25 | If you have any issues, create a |
| 26 | [http://trac-hacks.org/newticket?component=S5Plugin&owner=rjollos new ticket]. |
| 27 | |
| 28 | == Download == |
| 29 | |
| 30 | Download the zipped source from [download:s5plugin here]. |
| 31 | |
| 32 | == Source == |
| 33 | |
| 34 | You can check out S5Plugin from [http://trac-hacks.org/svn/s5plugin here] using Subversion, or [source:s5plugin browse the source] with Trac. |
| 35 | |
| 36 | == Install == |
| 37 | |
| 38 | 1. Install |
| 39 | * By hand: |
| 40 | 1. .... |
| 41 | * Using easy_install: |
| 42 | {{{ |
| 43 | #!sh |
| 44 | $ [sudo] easy_install https://trac-hacks.org/svn/s5plugin/0.11 |
| 45 | }}} |
| 46 | * ,,`sudo` is optional case you already have enough authority to modify your server.,, |
| 47 | 1. Restart your web server ,,(this example command line for Apache on Ubuntu),,. |
| 48 | {{{ |
| 49 | #!sh |
| 50 | $ [sudo] /etc/init.d/apache2 restart |
| 51 | }}} |
| 52 | 1. Enable the plugin. |
| 53 | * by updating your [wiki:TracIni trac.ini] with this: |
| 54 | {{{ |
| 55 | [components] |
| 56 | ... |
| 57 | s5.s5.s5renderer = enabled |
| 58 | ... |
| 59 | }}} |
| 60 | * or accessing your Admin panel ({{{ ..admin/general/plugins }}}); |
| 61 | 1. Configure your environment. See section bellow. |
| 62 | {{{ |
| 63 | #!comment |
| 64 | * by modifiying `trac.ini` file; |
| 65 | * by accessing your Admin panel case you have WebAdminPlugin enabled; |
| 66 | }}} |
| 67 | 1. Plugin install troubleshooting (general) visit [http://trac.edgewall.org/wiki/TracPlugins TracPlugins]. |
| 68 | |
| 69 | == Configure == |
| 70 | |
| 71 | There are a few options that can be specified in the `[s5slideshow]` section of ''trac.ini''. |
| 72 | |
| 73 | The '''Slideshow''' content conversion link at the bottom of each wiki page can be disabled with the following option: |
| 74 | {{{ |
| 75 | show_content_conversion = false |
| 76 | }}} |
| 77 | |
| 78 | The default theme can be specified with the following option: |
| 79 | {{{ |
| 80 | default_theme = <themename> |
| 81 | }}} |
| 82 | |
| 83 | Note that one of the themes is named ''default'' and if the `default_theme` option is unspecified, then `default_theme = default` is used. |
| 84 | |
| 85 | == Example == |
| 86 | |
| 87 | {{{ |
| 88 | #!html |
| 89 | <pre class="code"><div style="background: #ddf"> |
| 90 | = Slideshow Title = |
| 91 | |
| 92 | Title page content. |
| 93 | |
| 94 | </div><div style="background: #fdd"> |
| 95 | == Slide 1 Title == |
| 96 | |
| 97 | Slide 1 content. |
| 98 | |
| 99 | </div><div style="background: #dfd"> |
| 100 | == Slide 2 Title == |
| 101 | |
| 102 | Slide 2 content. |
| 103 | |
| 104 | </div></pre> |
| 105 | }}} |
| 106 | |
| 107 | [[Image(title.png)]] |
| 108 | |
| 109 | == Recent Changes == |
| 110 | |
| 111 | [[ChangeLog(s5plugin/0.11, 3)]] |
| 112 | |
| 113 | == Author/Contributors == |
| 114 | |
| 115 | '''Author:''' [wiki:athomas] [[BR]] |
| 116 | '''Maintainer:''' [wiki:rjollos] [[BR]] |
| 117 | '''Contributors:''' dgynn, JimCheetham |