Add reveal.js library (version 2.4.0) inside IPython

[damianavila]

Currently, it is already open a PR for the integration of nbconvert into IPython (#3500).

This lead us to the discussion of the integration of reveal.js library inside IPython because it is a necessary step to render correctly the slideshow provide by reveal option in nbconvert.

We had a previous discussion about this issue here: https://github.com/ipython/nbconvert/pull/155 and now, for suggestion of Brian, I am moving the ongoing discussion here...

Damián

[minrk]

Thanks for moving the issue. To summarize my perspective, I think reveal.js should only be in IPython if it's a dependency of the live notebook. From the user confusion perspective of a partial reveal.js in nbconvert, I think we should do one of:

1. move the reveal export to an independent extension (which includes reveal.js, etc.)
2. make sure the reveal export works with reveal from a CDN
3. (my least favorite) include reveal.js in IPython

[ellisonbg]

The new Writer API that @jdfreder is adding to nbconvert should help with
this. Writer is responsible for taking the converted template and figure
resources and writing it somewhere. We are using this to manage things
like files referred to in "files/" URLs. A custom Writer could be built
which knows how to install the reveal.js files. It might be a nice test
case for a standalone (third party) converter (hosted as a separate project
on github under the ipython org). It could also possibly be in the ipython
repo. But I completely agree with Min that the reveal.js files should not
be installed in the ipython repo unless the live notebook depends on them.

Cheers,

Brian

On Wed, Jul 3, 2013 at 4:56 PM, Min RK notifications@github.com wrote:

Thanks for moving the issue. To summarize my perspective, I think
reveal.js should only be in IPython if it's a dependency of the live
notebook. From the user confusion perspective of a partial reveal.js in
nbconvert, I think we should do one of:

1. move the reveal export to an independent extension (which includes
   reveal.js, etc.)
2. make sure the reveal export works with reveal from a CDN
3. (my least favorite) include reveal.js in IPython

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/3499#issuecomment-20452361
.

Brian E. Granger
Cal Poly State University, San Luis Obispo
bgranger@calpoly.edu and ellisonbg@gmail.com

[damianavila]

My current thoughts about this issue:

• I can understand the refusal to include reveal.js in IPython because it wouldn't be a dependency for the live notebook. I hope to learn enough js to do a live version of the reveal converter, but probably it will not be soon...
• I also think that we need to provided (by default) a static slideshow converter inside IPython, and reveal can do this job. The idea that Brian has proposed with the Writer seems interesting and a perfect use case...
  I am also trying to get a CDN from jsdelivr with all the necessary reveal.js files. Here is the current PR: Added lib folder and some minimal and essential plugins. jsdelivr/jsdelivr#46
• I am thinking about an independent reveal slideshow extension... but for a more complex converter with new features to give the users the possibility to change more design patterns. I talked about this idea in my talk and in the sprint (with Brian, Fernando and Tomas) when I explained a closed PR: Added alingment property to slideshow preset from CellToolBar. #3432

So, to summarize...

• I would like to make sure that the basic (the current one) reveal slideshow converter work with a CDN (o maybe through a Writer) but inside IPython. A static slideshow capability, I think, is an enough useful tool to exist by default (the use of this converter by a lot of people in the SciPy2013 conference - at least 8 talks - show us the need for a capability such as a slideshow - reveal - converter).
• I will develop an improved version for all the users who wants to go deeper in the design of their slideshows.
  (probably I will need to do some changes inside IPython.nbconvert, but this changes will be hidden and will not bother to the basic users).

Thoughts?

Damián.

[damianavila]

Closing this issue because it is already resolved.