slideparser_wiki

Background and rationale

MoinMoin 1.9 provides a single page slide show feature in Modernized theme using SlideShow action (see HelpOnSlideShows). The action code includes a slide parser that divides the page on level 1 headings into separate sections presented as slides using slideshow.css. The slide show action has the option to import an alternative slide parser as a plugin in wiki/data/plugin/parser. An alternative parser could enable slides to be defined by specific strings (tokens) or other heading levels, and include a mechanism to have content displayed in the rendered page but not in the slides.

Description

A slide parser for SlideShow action, which by default behaves as the in-built parser, that can be additionally controlled by #pragma processing instructions to give alternative functionality. The simplest change is to set a different heading level to delimit slides allowing for the page to contain with higher level headings to precede the slide content. Additionally, rather than just use headings, the parser can delimit slides based on specified strings (slide tokens) included in the page content. Likewise notes tokens can be specified to indicate notes that are included in the page but not the slides. When slide tokens are used to delimit slides, the slide heading can be (1) a wiki heading (of any level) when it follows the slide token on the next line (and will be displayed in the rendered page), (2) specified in wiki heading format when it follows the slide token on the same line (and not necessarily displayed in the page), or (3) not included.

The parser does not work as a processing instruction or a page section. Attempting to do so generates a warning message.

Processing instructions

#pragma slides number: Sets the heading level to delimit slides, with number equal 1 to 5.
#pragma slides: Sets the default slide token as the slide delimiter. The default token is ##slide, which must appear at the beginning of a line, if you want it to be treated as a comment not rendered in the page.
#pragma slides on: Same as #pragma slides (described above).
#pragma slides off: Turns off the division of the page into separate slides, even if slide tokens or level 1 headings are included in the page. However, the page is sitll displayed as a single slide using slideshow.css if the SlideShow action is evoked.
#pragma slides text: Sets the slide token to the text provided. This text can include wiki markup and spaces but not line breaks. The token can be a displayable element of the page (unlike the default token when included at the beginning of a line). However, the slide content will begin immediately after the token, so the token inclusion must be considered carefully not to disrupt the wiki markup rendered in the slide.
#pragma notes: Sets the default notes token as the notes delimiter. The default token is ##notes, which must appear at the beginning of the a line, if you want it to be treated as a comment not rendered in the page.
#pragma notes on: Same as #pragma notes (described above).
#pragma notes off: Turns off the exclusion of note content from the rendered slides.

The processing instructions can appear in any order, but if duplicated the last setting overrides any prior setting.

The parser ignores content escaped by {{{ }}} or ` `, so wiki heading code or slide/notes tokens within these are ignored.

Usage

#pragma slides [|on|off|token|1...5]
#pragma notes [|on|off|token]

##slide
= slide heading =
slide content
##notes
notes content

##slide
= slide heading =
== slide subheading ==
slide content

##slide = slide heading (continued) =
== slide subheading ==
slide content

Download & Release Notes

Download	Release Version	Moin Version	Release Notes
slideshow_wiki-1.0.py	1.0	1.9.2

Examples

#pragma slides 
#pragma notes 

<<Action(SlideShow)>>

##slide
= slide content 1 =
 * blah
##notes
= slide notes =
 * some notes
##slide
= slide content 1 =
 * blah

This page has the processing instruction #pragma slides 2 and will be divided into slides on level 2 headings by SlideShow.

Hint

If the content under a slide heading is too much to display in one slide but suitable for display in the rendered page, it can be split across to slides as follows.

##slide
= slide 1 =
 * blah
 * blah
##slide = slide 1 continued =
 * blah
 * blah

Unfortunately, the comment line creates uneven spacing for list items (as above) and breaks a numbered sequence when the page is rendered. This does not happen when the comment line is inserted between normal text paragraphs, a series of headings or even when inserted in a table (as below). So there is an inconsistency in the wiki formatter that needs investigating and patching for the above to work ideally.

##slide
= slide 1 =
||blah||
||blah||
##slide = slide 1 continued =
||blah||
||blah||

History

Developed with inspiration and code from SlideShow action:

@copyright: 2005 Jim Clark, 2005 Nir Soffer, 2008 ThomasWaldmann, 2009 ReimarBauer

Copyright

License

GNU GPL, see COPYING for details.

Known issues and limitations

SlideShow action imports a plugin parser from wiki/data/plugin/parser expecting class SlideParser. However, module wikiutil.py imports all parsers in wiki/data/plugin/parser and expects class Parser. So both run without raising an exception, this parser includes both classes and uses the Parser class for generating a warning if the parser is invoked other than by SlideShow action. The SlideShow action could be altered to look for a plugin slide parser in a different location, but for now it was intended to use the action code unaltered.
Some content is not displayed optimally by slideshow.css, so users should limited the content to markup that renders suitably or modify slideshow.css accordingly.
Ignoring content escaped by {{{ }}} has not been tested for nested instances of this markup.

Hits: 858