sonaryr / reveal.js-coursemod

A courseware plugin for Reveal.js

reveal.js - Coursemod

Giving a presentation is great, but sometimes (or most of the times in my case) I also want to publish my presentation for my audience to review it later. By doing this a lot of the context might get lost (not everything you say in class is on the presentation), but not anymore!

With this plugin you are able to start your presentation with the speaker notes next to it.

##Installation First of all download the coursemod folder (javascript and css) and place it in plugin/

The second thing to do, is include it as a dependency in your initialization. And enable it.

Reveal.initialize({
    ...
    coursemod: {
    	enabled: true
    },
    ...
    dependencies: [
        ...
        { src: 'plugin/coursemod/coursemod.js', async: true}
    ]
});

That's all for installation

##Configuration As you have already seen in the installation part I have added an extra config block for this plugin. This block needs to be passed along to Reveal.initialize().

coursemod: {
	enabled: true, //enable or disable the plugin, default to false
	shown: true //immediatly show the course notes view, this defaults to true if not present.
}

###Overriding the shown config You can override the shown parameter on a slide to slide basis. You just have to add data-coursemod-shown = "true" (or false) to the slide (<section>) you want to override and it will be done. ##Usage in presentation If you want to toggle the coursemode, I have also added an event to the V key. so pressing V with the plugin enabled will show or hide the notes view.

reveal.js-coursemod's Issues

Sync on fragments

Hide specific notes until a fragment is shown

TOC-progress plugin does not resize

I'd like to use your plugin in combination with the TOC-Progess plugin, which adds a footer without class, with fixed id #toc-progress-footer. That footer does not change its size when changing to the coursemod view. If I add the footer's id as new line 14 of coursemod.css, resizing works.

Would you accept such a change as PR? Have you got a suggestion how to use both plugins simultaneously?

Printing needs fixing

Print PDF css gets understandably confused by the new format.
Might there be an option to print only slides or slides + notes? In the meantime, printing only slides like before is enough, as you can easily crank up some script to extract and format notes as a separate text-only handout.

Keeping top position when slide changes

When a coursemod piece of text is long enough for the first lines to be scrolled off the screen, the first lines in the following slide appear also scrolled off. I think returning the coursemod frame in the following slide to top position would be safer.

Run-time toggle option

Is there a way to set coursemod.shown="false" directly in the URL?

initialization

What do you mean by "in your initialization..."
Do I have to create a "initialization.js" file and put inside the
reveal.jf-coursemod folder?
Thx

Add default settings for slides

Be able to set the shown indicator seperatly per slide

Poor MathJAX rendering of subindices

Please refer to these slides for an example. Last line in the coursemod notes of the first shown slide show a couple of "(2" subindices. These are generally badly rendered. Sometimes superindices like exponents are as well, but the main problem is with subindices. They tend to be shifted to the left, overwriting other characters -- looks like the length of the line would have been computed without considering the math font size. This does not happen in regular, MathJAX using slides. Pandoc utility also does convert them alright to PDF. The only place where this seems to happen is in coursemod panel.
Can something be done about this?

Alternative layout for mobile devices

Trend fact
Students' use of mobile telephones to browse course material is growing.

Problem
Vertical text aside thrown to the right looks too stretched on vertically held phones. While mobiles' screens are normally sensitive to rotation, some users disable this. Besides, when holding the device horizontally, grip may be less secure in certain travel conditions.

Proposal
Is there any way for Reveal or Coursemod to know whether we're running on a mobile AND the device is vertically held?
a) If yes, just apply a different CSS.
b) else add hotkey to turn 90 º the horizontal layout to vertical layout thus presenting slide above aside. Can we cycle layouts using always the same 'V' hotkey? e.g.:

Sld+asd --'V'--> Sld-no-asd --'V' --> Sld-over-asd --'V' --+
^ ---------------------------------------------------------+

Absolute positioning of some elements

The audio-slideshow plugin sound control bar still shows at the absolute center of the window, not the slide subwindow's. That way it bumps over other controls (see https://egrosclaude.github.io/RDCI/Introducción.html)

Absolute-positioned items in general are guaranteed to be a hassle...

'C' hot key conflicts with other plugin's

How about 'V'