search

esciencecenter-digital-skills / software-support-essentials

https://esciencecenter-digital-skills.github.io/software-support-essentials/
Other
0 stars 1 forks source link

Add presentation template using revealjs #20

Closed raar1 closed 1 year ago

raar1 commented 1 year ago

If a chapter has a 'presentation' tag then the corresponding markdown file (assumed to be formatted correctly for reveal.js) will be displayed instead of the usual two panes. The "speaker notes" are displayed on the right, replacing the text side panel in other media.

You can test this by looking at the react.js test story (non presentation stories will currently not render).

Currently there is only a presentation for one chapter. Do we really want one per chapter? It is possible, but might get messy in the code. I think Peter's idea was that we could instead fetch the chapter names from the react.js component somehow. I'm not sure yet if that's possible.

raar1 commented 1 year ago

OK I've fixed a few things and I think it could now be merged (after review).

As the revealjs presentations are inherently multimedia, I have restricted each to point to a single revealjs markdown file. This comes in the form of a presentation tag in the story header (see the test static/stories/revealjs.md file for an example).

The revealjs presentation works and the old stories also render correctly. This does not yet integrate Jaro's work, but that should be able to slot into the part of pages/_story.vue beneath the comment <!-- Other multimedia-based chapter divs -->.

@JaroCamphuijsen if you don't mind, could you take a look again, and review if you have time?

JaroCamphuijsen commented 1 year ago

This looks great and it works. Some remarks:

  1. I would prefer to have the presentation on the chapter level instead of the story level. I think we would like to be able to have multiple chapters for a certain topic with one being a presentation, another maybe being a video that isn't part of the presentation. In this way the story can host more background materials, exercises, etc. while the presentation can be used for what it's meant to do, present the topic to people.
  2. Also currently I don't seem to be able to incorporate all the reveal.js functionalities, like for example 2 dimensional slide progression, right now it only has vertical slides for each double hash markdown header and using a single hash (like I would expect intuitively, and according to these docs doesn't render another horizontal slide.

I will merge this PR as it doesn't break anything and the other story types can still be used. I will make two issues for my two remarks.