Differences

This shows you the differences between two versions of the page.

--- plugin:revealjs [2015-01-27 10:49] – neuralyzer
+++ plugin:revealjs [2020-09-20 13:12] (current) – lastupdate Aleksandr
@@ Line 3: / Line 3: @@
 ---- plugin ----
 description: Converts a DokuWiki page into a Reveal.js slideshow
-author     : Emmanuel Klinger
+author     : Emmanuel Klinger, Ottmar Gobrecht
-email      : emmanuel.klinger@gmail.com
+email      : emmanuel.klinger@gmail.com, ottmar.gobrecht@gmail.com
-type       : render
+type       : render syntax
-lastupdate : 2015-01-27
+lastupdate : 2020-05-27
-compatible : 2014-09-29 "Hrun"
+compatible : elenor of tsort, hrun, detritus, frusterick manners, greebo
 depends    :
 conflicts  :
@@ Line 21: / Line 21: @@
 ----
-This plugin creates [[https://github.com/hakimel/reveal.js/|reveal.js]] presentations from Dokuwiki pages. Many reveal.js features such as themes and PDF export are also supported.
+This plugin creates [[https://github.com/hakimel/reveal.js/|reveal.js]] presentations from DokuWiki pages. Many reveal.js features such as themes and PDF export are also supported.
-See also the [[https://github.com/neuralyzer/dokuwiki-plugin-revealjs/blob/master/README.md|readme]] on github for a plugin description.
+The documentation is maintained on Github: [[https://github.com/neuralyzer/dokuwiki-plugin-revealjs/blob/master/README.md|DokuWiki plugin reveal.js documentation]].
 ===== Installation =====
-Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. 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. Possible values:
-  * black
-  * white
-  * beige
-  * blood
-  * league
-  * default
-  * moon
-  * night
-  * serif
-  * simple
-  * sky
-  * solarized
-The default is 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.
-==== Transition ====
-The slide transition. Possible settings:
-  * none
-  * fade
-  * slide
-  * convex
-  * concave
-  * zoom
-The default is fade.
@@ Line 104: / Line 33: @@
 === Change Log ===
-  * **2014-10-11**
+  * **2018-09-02**
-    * Initial release
+    * Fix problems with Greebo Release. Contributed by Jochen Metzger (https://github.com/jmetzger)
-  * **2014-10-28**
+  * **2017-02-05**
-    * Add support for the Reveal.js (highlight.js) syntax highlighter
+    * Major update with all the work done by Ottmar Gobrecht (<ottmar.gobrecht@gmail.com>, https://github.com/ogobrecht)
-  * **2014-10-31**
+    * Improved slide handling: Since slides are indicated by headers you are relative inflexible regarding the header levels and sizes on vertical (nested) slides - they are normally simply to small
-    * Load MathJax over secure connection if available
+    * New conf option horizontal_slide_level: Headers on this level or above starting a horizontal slide. Levels below starting a vertical (nested) slide - no effect on slides, which are indicated by alternative slide indicators
-  * **2014-12-09**
+    * New conf option enlarge_vertical_slide_headers: Increase headers on slides below horizontal_slide_level - no effect on slides, which are indicated by alternative slide indicators
-    * Add configuration option to build all lists by default
+    * New alternative slide indicator:
-    * Remove black border in theme "beige_white"
+      * ''<nowiki>----></nowiki>'' opens a new slide with default transition in default speed (open previous slides will be closed implicitly)
+      * Full example - parameters are parsed dynamically like in CSS, the parameter order is not important: ''<nowiki>---- orange wiki:dokuwiki-128.png 10% repeat bg-slide zoom-in fade-out slow no-footer ----></nowiki>''
+        * All possible HTML color names and codes are supported: ''red'', ''#f00'', ''#ff0000'', ''rgb(255,0,0)'', ''rgba(255,0,0,0.5)'', ''hsl(0,100%,50%)'', ''hsla(0,100%,50%,0.5)''
+        * Background images are recognized case insensitive by the endings gif, png, jpg, jpeg, svg
+        * Background image size is recognized by postfix ''%'' and ''px'' or by keywords ''auto'', ''contain'' and ''cover'' (cover is the default in Reveal.js) - example: ''10%'' or ''250px''
+        * Background image position is recognized by keywords ''top'', ''bottom'', l''eft'', ''right'', ''center'' (center is the default in Reveal.js) - examples: ''top left'', ''bottom center''
+        * Background image repeat is recognized by the keyword ''repeat'' (no-repeat is the default in Reveal.js)
+        * Background transition: prefix ''bg-'' followed by ''none'', ''fade'', ''slide'', ''convex'', ''concave'' or ''zoom''
+        * Slide transition: ''none'', ''fade'', ''slide'', ''convex'', ''concave'' or ''zoom'' followed by optional postfix ''-in'' or ''-out'' for different transitions on one slide
+        * Transition speed: ''default'', ''fast'', ''slow''
+      * ''<nowiki>---->></nowiki>'' opens a new slide container for vertical (nested) slides and a new slide with the given options - example: ''<nowiki>---- red zoom ---->></nowiki>''
+      * The next ''<nowiki>---->></nowiki>'' will close the previous container (and slide) implicitly
+      * Technical details:
+        * In the rendering the slide mode changes from "headers driven" to "special horizontal rule driven" - headers are no longer interesting in this mode for slide changes
+        * You can create of course a whole presentation with this alternative slide indicator
+        * if you want to leave this slide mode you need a way to explicit close a slide or container:
+        * ''<nowiki><<----</nowiki>'' closes a slide container (and possibly open slide inside)
+        * ''<nowiki><----</nowiki>'' closes a slide
+    * Improved existing background indicator: ''<nowiki>{{background>orange bg-zoom}}</nowiki>''
+      *  allowing now all options from the new slide indicator (see above)
+    * Improved wiki page rendering:
+      * New conf option show_slide_details (default on): Show slide details on wiki page: start of slide and options, background preview, start of notes
+    * Improved section editing:
+      * Slide background definition or alternative slide indicators must be noted before the headers/slide content
+      * The normal section editing has the problem, that it is starting on the headers, so the background definition or alternative slide indicators are on the wrong section
+      * With the section editing improvement the whole slide can be edited at once including the background definitions
+    * New conf option for the start button:
+      * You can now select between the default one(start_button.png), the one from the s5 plugin (start_button.screen.png) and an own one (start_button.local.png), which is upgrade safe and must be copied into the plugin directory
+      * If you are able to edit the page, then a export to PDF link is rendered under the start slideshow button - this is the reveal.js default export and works only in Chromium and Chrome - more infos [[https://github.com/hakimel/reveal.js#pdf-export|here]]
+    * Introducing new syntax for [[https://github.com/hakimel/reveal.js#speaker-notes|speaker notes]]:
+      * ''<notes>'' - no parameters
+      * No changes on wiki pages
+      * On a slideshow the content is wrapped into ''<nowiki><aside class="notes"></nowiki>''
+      * Lists in notes are always NOT incremental, because the list is unvisible and you would have to press the next key for each entry without any obvious effect
+    * Introducing new syntax for [[https://github.com/hakimel/reveal.js#fragments|fragments]]:
+      * ''<fragment>'' for inline usage (only formatting and substitutions supported)
+      * ''<fragment-block>'' for any wiki content
+      * ''<fragment-list>'' to overwrite the global option build_all_lists (if false)
+      * ''<no-fragment-list>'' to overwrite the global option build_all_lists (if true)
+      * Support for style and index where possible - see also the source code file example_presentation.dokuwiki and [[http://lab.hakim.se/reveal-js/#/7/1|this reveal online demo]]
+    * Improved blockquote handling:
+      * The nesting is suppressed on the slideshow to support the way Reveal is showing notes
+    * Improved DokuWiki text formatting on the slides:
+      * Underlined text is now underlined and no longer italic
+      * Subscript and superscript are now a bit smaller than the default text
+    * New conf option for image borders:
+      * In DokuWiki in the default theme images have no borders
+      * In Reveal the images have borders
+      * Now you can configure this globally in the plugin settings and since all options are overwritable per wiki page you can have different settings on different pages/presentations
+    * New conf options for slide size:
+      * Default size in Reveal.js is ''960x700''
+      * Sometimes you need to align this if you have content that does not fit on this size
+      * As all options this one is overwritable per page/presentation - see also example_presentation.dokuwiki
+    * New theme dokuwiki:
+      * This is a copy of the theme solarized: the only change is the aligned background color, which match the background color of the default DokuWiki theme
+      * Images are looking good with activated borders
+    * Upgrade to reveal.js 3.4.1
+  * **2016-09-15**
+    * Better IE support
+    * Add syntax to set and override all options for a presentation
+  * **2016-09-07**
+    * Add option to open presentation in new window and make this behavior default
+    * Nicer description of the reveal.js options
+  * **2016-02-11**
+    * fix small method signature inconsistency
+  * **2016-02-04**
+    * Upgrade to reveal.js 3.2
+  * **2015-07-09**
+    * Upgrade to reveal.js 3.1
+  * **2015-03-28**
+    * add support for footers
+    * add option to insert a button which starts the presentation together with theme selection similar to the [[plugin:s5|S5 Presentations Plugin]]
+    * slide background are also supported
   * **2015-01-27**
     * update to reveal.js 3.0
     * new default theme "white"
     * more configuration options
+  * **2014-12-09**
+    * Add configuration option to build all lists by default
+    * Remove black border in theme "beige_white"
+  * **2014-10-31**
+    * Load MathJax over secure connection if available
+  * **2014-10-28**
+    * Add support for the Reveal.js (highlight.js) syntax highlighter
+  * **2014-10-11**
+    * Initial release
-===== 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.