Re-enable the red box to show available space #2932
Conversation
|
Cc @gribozavr, @LukeMathWalker, @timClicks since I hope you folks will find it useful for the new course material you're working on 😄 |
Way back in #187, I introduced a hacky tool to show the available space on a slide: it was a `mdbook` plugin which injected the necessary CSS on each slide. Crude, but it got the job done. The logic was moved from Python to a real CSS file with associated JavaScript in #1842. In #1917, the functionality was moved to a dedicated “instructor menu”, together with functionality for saving the state of the Playground on each slide. Unfortunately, the whole thing was disabled in #1935 since I found that the Playgrounds lost their code with the saving logic. I was also not 100% happy with dedicating space on each slide for a menu only used by instructors. However, I really think we need a tool to let slide editors know about the available space, so I would like to re-introduce the red box. This time via a keyboard shortcut to make it easy to toggle as needed. I’m suggesting enabling this for everyone, with the expectation that most people won’t find the shortcut and will quickly disable the box if they do (there is a dedicated button to hide it again). End-to-end tests have been added for the new functionality.
mgeisler
force-pushed
the
red-box-shortcut
branch
from
7e16db9 to
5f3010d
Compare
|
Thanks @qwandor! It seems I need to rework the new tests since they somehow fail in CI 😄 I'll try to look at this soon! |
|
@michael-kerscher, do you have an idea why the test failed with
I think this might be unrelated to my changes, but I'm mystified why we see this here and not on every other PR. |
Way back in #187, I introduced a hacky tool to show the available space on a slide: it was a
mdbookplugin which injected the necessary CSS on each slide. Crude, but it got the job done.The logic was moved from Python to a real CSS file with associated JavaScript in #1842. In #1917, the functionality was moved to a dedicated “instructor menu”, together with functionality for saving the state of the Playground on each slide.
Unfortunately, the whole thing was disabled in #1935 since I found that the Playgrounds lost their code with the saving logic. I was also not 100% happy with dedicating space on each slide for a menu only used by instructors.
However, I really think we need a tool to let slide editors know about the available space, so I would like to re-introduce the red box. This time via a keyboard shortcut to make it easy to toggle as needed.
I’m suggesting enabling this for everyone, with the expectation that most people won’t find the shortcut and will quickly disable the box if they do (there is a dedicated button to hide it again).
End-to-end tests have been added for the new functionality.