Possibility to configure reveal.js plugins

[imagejan]

Is it possible to configure RISE to use any of the plugins for reveal.js? If yes, are there examples illustrating how to do that?

[parmentelat]

Hello It is possible, but tricky; IIUC the first one historically was for managing notes, and Damian confirmed recently that it does not behave as expected Recently there was also a proposal to ship the chalkboard plugin (see #226 and #355)

Generally speaking, there are several families of issues:

• a recurring but simple one is to provide a setting so that the addition is optional; now that we are compliant with jupyter extension's configurator (see pending PR #344), this becomes easy

• one is that the keyboard shortcuts may need to be tweaked as we always have jupyter working in the background, so there may be a need to decide what a given keyboard shortcut should be doing, or to redefine them so as to avoid overlaps; example, chalkboard defines keyboard b to toggle the blackboard, but b for jupyter means insert a cell below; similarly, if the plugin adds buttons we may need to tweak their position on the screen

• finally, apparently not all the plugins can be installed through npm (chalkboard is one of them, I found out) and in this case we need to add this code to the RISE repo, which is suboptimal.

For a reference of how to deal with these, I suggest you start with the version here https://github.com/parmentelat/RISE/blob/chalkboard-redeux/rise/static/main.js#L500-L517

which unfortunately has not yet been merged - and hopefully this will give an additional incentive for Damian to do so in the near future ;)

[damianavila]

and hopefully this will give an additional incentive for Damian to do so in the near future ;)

I just need a 48 hs day instead of a 24 hs one :wink: Planning to merge several of your PRs during this week.

[buschbapti]

Hello, I am not sure what is the status with that. Is the the chalckboard plugin usable in RISE? If it has not been merged yet @parmentelat could you explain how to use your implementation of it? Thanks a lot in advance.

[parmentelat]

Hey there Sorry to have not answered that earlier, somehow I managed to miss this question altogether

Honestly I don't remember the status of this either; but at its best point it kind of worked, but AFAIR there remains some flaws, having to do with keyboard actions being managed ambiguously

In any case, I am currently in vacation and can't really check it out; using it should be straightforward, there should be 2 additional buttons in the lower left corner; There might be a need to turn on the feature in the config pane though.

Please check the corresponding branch by yourself; It's too bad this project moves so slowly, I can't even remember myself where that feature stands..

-- Thierry

Sent from my iPhone

On 26 Jul 2018, at 17:19, Baptiste Busch notifications@github.com wrote:

Hello, I am not sure what is the status with that. Is the the chalckboard plugin usable in RISE? If it has not been merged yet @parmentelat could you explain how to use your implementation of it? Thanks a lot in advance.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

[damianavila]

As I said in another issue, I plan to release a new version in the next 2 weeks and it will include this feature.

It's too bad this project moves so slowly, I can't even remember myself where that feature stands..

I would love to have more time to move it faster but as you know, everyone has a life and regrettably, things happen :wink: (in fact, I am on vacation with my son right now, not sure why we are talking here, jeje).

I am and I will always appreciate your contributions @parmentelat and I really hope I could be more responsive in the future. Thanks for your, and all the RISE users, patience.

[buschbapti]

Thanks @parmentelat and @damianavila for both your replies and for working on this great project.

As I said in another issue, I plan to release a new version in the next 2 weeks and it will include this feature.

Glad to hear that. I'll check on it when it is released. Enjoy both your vacations.

[damianavila]

Now the chalkboard PR is merged into master: https://github.com/damianavila/RISE/pull/408. Soon to be released with 5.4.0. Stay a tune!

[imagejan]

Thanks for your awesome work, @damianavila and @parmentelat! What needs to be added to environment.yml or postBuild to have the chalkboard extension enabled?

[damianavila]

What needs to be added to environment.yml or postBuild to have the chalkboard extension enabled?

You can use any of the options described here: https://rise.readthedocs.io/en/stable/customize.html#how-to-customize

[damianavila]

with something like this:

{
  "rise": {
    "enable_chalkboard": true
  }
}

in case you use JSON files or the notebook metadata.