Support for speaker notes

[mfontanini]

It could be nice to support speaker notes. The idea would be to have a way to hook up another <something> (likely another instance of presenterm) which displays any speaker notes in the current slide, where notes would likely be some form of HTML comment.

I don't personally use speaker notes, but I'm keeping this issue open so that those who want speaker note support state their expectations so we don't implement something blindly.

[xstasi]

Hello there!

I make ample use of speaker notes and found the lack of support in presenterm a little bit distressing, so I cooked up a very simple "implementation" (emphasis on the quotes) using kitty.

Not claiming to be anywhere near a proper implementation, but perhaps others who stumble on this issue while looking around for speaker note support may find it useful.

Gist over here

Ta!

[dmackdev]

I think speaker notes would be a useful addition to presenterm. I would definitely make use of them myself.

I experimented with a PoC of using 2 instances of presenterm to support speaker notes as follows:

• I added support for a speaker notes HTML comment: <!-- speaker_note: Your speaker note here. -->.
• I added a new optional CLI option: --speaker-notes-mode.
• --speaker-notes-mode=publisher is used to present slides. In this mode, speaker note comments are ignored, and every time the slide changes, an event is sent via inter-process communication (IPC) using https://github.com/eclipse-iceoryx/iceoryx2.
• --speaker-notes-mode=receiver is used to view speaker notes. In this mode, only speaker note comments are rendered, and on each iteration of the render loop, a check is performed to see if there are any IPC events to change slide.
• If --speaker-notes-mode is not specified, no IPC structures are created, no events are sent/listened for, and speaker notes are ignored.

Branch is here https://github.com/dmackdev/presenterm/tree/speaker-notes.

See a demo below. There is a slight layout issue on the second speaker note slide, but it's just a rough PoC at this stage. Here I am running the two instances of presenterm using the options described above, and navigating the presentation slides in the left terminal only. The speaker notes in the right terminal automatically navigates slides.

Screen.Recording.2024-11-05.at.09.48.17.mov

Keen to know your thoughts @mfontanini.

[mfontanini]

Love the approach @dmackdev! Can you create a PR so we can go over the changes?

[mikavilpas]

I like it! I think it would be very easy to embed the note viewer in a terminal inside my editor. It would fit my workflow really well 👍🏻

[dmackdev]

Great!

PR started here: #389

I will continue to improve it.