DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:revealjs

This is an old revision of the document!


revealjs Plugin

Compatible with DokuWiki

2014-09-29 "Hrun"

plugin Converts a DokuWiki page into a Reveal.js slideshow

Last updated on
2014-12-09
Provides
Render
Repository
Source
Conflicts with
mathjax

This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.

Similar to impressjs, s5, s5reloaded

Tagged with javascript, presentation, slideshow

This plugin creates reveal.js presentations from Dokuwiki pages. Many reveal.js features such as themes and PDF export are also supported.

See also the readme on github for a plugin description.

Installation

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

Examples/Usage

Add a &do=export_revealjs or ?do=export_revealjs to the end of the page url to see the page rendered as reveal.js slideshow.

Syntax

Every new H1 or H2 section, that is 6 equal signs or 5 equal signs open a new slide horizontally. New H3 sections (4 equal signs) are appended vertically if they follow after an H2 section.

Caution: Only H2 sections open the vertical axis. If an H3 section follows after an H1 section it is appended horizontally.

Other supported DokuWiki syntax

So far the following syntax elements are supported:

  • alignment of images: either left or right or centered
  • dokuwiki plugin wrap's <wrap lo></wrap> and <WRAP lo></WRAP> produce also in the presentation smaller text

Configuration and Settings

Available themes

Available themes are the Reval.js themes

  • beige
  • blood
  • default
  • moon
  • night
  • serif
  • simple
  • sky
  • solarized

Plus additionally the theme

  • beige_white

which is a simple modification of the beige theme. The only change to the original beige theme is that the background is white instead of the beige radial gradient.

The default is beige_white

Controls

Show the reveal.js controls. Two values

  • false
  • true

The default is true.

Build all lists

Whether to build up all bullet point lists item by item by for every slide.

The default is false.

Development

Change Log

  • 2014-10-11
    • Initial release
  • 2014-10-28
    • Add support for the Reveal.js (highlight.js) syntax highlighter
  • 2014-10-31
    • Load MathJax over secure connection if available
  • 2014-12-09
    • Add configuration option to build all lists by default
    • Remove black border in theme “beige_white”

Include plugin compatibility

Change in the file dokuwiki/lib/plugin/include/syntax/wrap.php in the function render the line

if ($mode == 'xhtml') {

to

if ( ($mode == 'xhtml') && (! is_a($renderer, 'renderer_plugin_revealjs')) ) {

The include plugin will otherwise put some

<div class= "plugin_include_content ..." ...> ...</div>

at such places that the closing and opening div tags interfere with the reveal.js section tags.

MathJax compatibility

At the moment this plugin loads MathJax from the MathJax CDN directly whether the Dokuwiki MathJax plugin is installed or not. It ignores Dokuwiki's MathJax plugin and the custom settings you might have made.

plugin/revealjs.1418114619.txt.gz · Last modified: 2014-12-09 09:43 by neuralyzer

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki