The overlay protocol goes like this
overlay
¶If we find an overlay
entry in the livereveal
section of the notebook metadata, this string will be inserted in a div#rise-overlay
element that shows on every slide.
So this is a very low-level entry point, you are entirely responsible for providing a complete html fragment, and for styling it - how you can inject styling here is another story entirely.
header
, footer
and backimage
¶If OTOH overlay
cannot be found, then RISE looks for
header
footer
backimage
(again in the livereveal
section of the notebook metadata)Then it creates an html element that looks like this
<div id='rise-overlay'>
<div id='rise-header'> ...</div>
<div id='rise-backimage'><img src=... /></div>
<div id='rise-footer'> ...</div>
</div>
with minimum styling so that the header is at the top, the footer at the bottom, and the images
In this case you can define
header
and footer
as a regular string or a more elaborate html elementbackimage
as a url pathand you are still responsible for styling.
This notebook demonstrates defining overlay
, (this other one)[header-footer.ipynb] shows how to use header
and footer
and backimage
.