Jump to content

Extension:S5SlideShow

From mediawiki.org
MediaWiki extensions manual
S5SlideShow
Release status: unmaintained
Implementation Tag
Description Allows simple, fast and convenient creation of slide shows using S5 in the context of MediaWiki and Wiki pages. Full description.
Author(s) Vitaliy Filippov (VitaliyFilippovtalk)
Latest version 0.4 (2013-05-21)
MediaWiki 1.17+
Composer mediawiki/s5-slide-show
License GNU General Public License 2.0 or later
Download

Download snapshot
GitHub:

Note:
No localisation updates are
provided by translatewiki.net .

Example slide show, article (russian)
Parameters
  • $egS5DefaultStyle
  • $egS5SlideHeadingMark
  • $egS5SlideIncMark
  • $egS5SlideCenterMark
  • $egS5SlideTemplateFile
  • $egS5BrowserScaleHack
  • $egS5Scaled
Tags
‎<slideshow>
Hooks used
Quarterly downloads 1 (Ranked 133rd)

S5 or simply S5 is a cross-browser slide-show system using pure HTML and JavaScript. Its name is derived from Simple Standards-based Slide Show System — 5 times «S», or simply S5.

S5SlideShow is a MediaWiki extension allowing simple, fast and convenient creation of slide shows using S5 in the context of MediaWiki and Wiki pages.

Full description and usage information is here: http://wiki.4intra.net/S5SlideShow

Setup

[edit]

Download

[edit]

The source code now lives on Github:

See full feature list and usage information on extension homepage: http://wiki.4intra.net/S5SlideShow (English), http://wiki.4intra.net/S5SlideShow/ru (Russian).

This extension is similar to TooooOld's S5 extension (it was somewhere on this wiki, but now probably is removed), but it's far more advanced.

Installation

[edit]

PHP DOM extension is required.

After the download and copy of the files, add the following line to your LocalSettings.php. 

// headingmark attribute default value
$egS5SlideHeadingMark = false;
// incmark attribute default value
$egS5SlideIncMark = '(step)';

require_once( "$IP/extensions/S5SlideShow/S5SlideShow.php" );

Compatibility

[edit]
MW Version Result(s)
MW 1.17 The download from 2011-05-10.tar.bz2 does not work with MW 1.17. Fixed 2011-11-01
MW 1.27 The original repository code still works
MW 1.33 alpha code available at https://github.com/WolfgangFahl/S5SlideShow see discussion at http://wiki.bitplan.com/index.php/S5SlideShow

Getting started

[edit]

The tag <slideshow></slideshow> is used to allow to generate a link for the display of the slideshow. 

<slideshow style="custis" headingmark="⌘⌘" incmark="…" scaled="true" font="Comic Sans MS, Calibri, cursive" >
;title: Let's start
;author: Vitaliy Filippov
</slideshow>
Attribute Description
style 7 skins are available "out-of-the-box": blue, default, custis, nobook, flower, yatil, pixel. You can also create your own styles using wiki pages. See further information on the website [1].
headingmark The extension searches for this character sequence inside all headings (== Just a simple MediaWiki heading like this ==), and if found, it maps the heading to a slide in the slide show mode. If the heading includes this substring then it will be a slide. If the headingmark attribute value is empty, no MediaWiki headings will be mapped to slides, only <slides> tags.
Example: ; headingmark: Slide:.
incmark A similar character sequence that identifies «step-by-step» slides. Step-by-step means that if there are any lists (ordered # or unordered *) on the slide, they will be shown grayed, and with each mouse or Enter key click, the next list item will be highlighted.
centermark This sequence is used to center the slide content without removing the heading.
scaled If this attribute’s value is 1, true or yes (case insensitive), then all slides' content is scaled automatically to fit the screen. Images, including SVG ones, are scaled too, and will always have size "relative" to the font size. This is not the basic S5 ability, but an our feature.
author Slide show author (for the first (title) slide). Can contain Wiki markup.
title Slide show title. Can contain Wiki markup.
subtitle Slide show subtitle (for the title slide). Can contain Wiki markup.
subfooter A string displayed in page footer on each slide. Can contain Wiki markup. Also, the word {{date}} is special inside it — it is replaced with last article edit timestamp.

Changes

[edit]
  • 2020-01: Fixes in the works see http://wiki.bitplan.com/index.php/S5SlideShow
  • 2015-10-10: Subsections are no more included in slides. If anybody needs the old behaviour — please fill an issue on github.
  • 2015-10-03: Added support for MediaWiki 1.25.
  • 2014-05-28: Added the ability to turn all page sections into slides, enabled by headingmark equal to an empty string.
  • 2013-11-06: Fixed <code>class="anim over"</code>, i.e. — now slides with animations are scaled correctly, and only the last animation item is shown in print and normal article modes.
  • 2013-09-30: Added display of slideshow tag field values in a definition list.
  • 2013-05-21: Added printing and PDF export ability (for auto-scaled presentations).
  • 2013-05-15: Fixed SVG scaling on initially opened slide in Chrome.
  • 2013-05-15: Automatic slide content scaling now honors content width overflow (previously it scaled slides only based on its content height).
  • 2013-05-07: Committed 'nobook' style.
  • 2012-08-08: Added a check for PHP DOM extension and DOM MediaWiki preprocessor — they are required for this extension to work.
  • 2012-01-19: Smooth slide transitions using CSS3 animations.
  • 2011-11-01: Removed all warnings under E_STRICT. Removed register_globals vulnerabilities. Allow centered slides with titles (centermark).
  • 2011-09-19: Parser hack for better image quality in presentations ($egS5BrowserScaleHack). Images inserted with a specified width will be scaled by browser instead of MediaWiki software.
  • 2011-09-12: Fix SVG scaling errors.
  • 2011-06-17: Allow custom style previews to be stored as uploaded files.
  • 2011-06-15: «noslide» and «slideonly» CSS classes to allow hiding/showing certain elements.
  • 2011-06-10: Fix non-working «incmark» error.
  • 2011-06-06: Follow redirects in presentation mode.
  • 2011-05-29: Refactoring — totally new article parsing method, <slide> is renamed to <slideshow>, much better content scaler (+images +SVG +CSS3), always scales content relatively to the text. Also new optional experimental method for specifying slides — <slides> tag, allows «live thumbnails» mode when viewing article. «pagebreak» option is removed.
  • 2011-05-10: Allow to create own skins using Wiki pages.

Open issue(s)

[edit]
  • FIXME remove hardcode extensions/S5SlideShow/
  • TODO cache generated stylesheets and flush the cache after saving style articles
  • TODO remove support for loading text from session object and replace it by support for save-staying-in-edit-mode extension

See also

[edit]
Retrieved from "https://www.mediawiki.org/w/index.php?title=Extension:S5SlideShow&oldid=6639064"