From 5ad66f3779a7b26e43f899753a26ef5e3fe9667f Mon Sep 17 00:00:00 2001 From: Hakim El Hattab Date: Thu, 9 Feb 2017 11:37:47 +0100 Subject: [PATCH] docs for #1816 and remove showHelp --- README.md | 7 ++++--- js/reveal.js | 16 +++++++--------- 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index bfd5c9f..288de99 100644 --- a/README.md +++ b/README.md @@ -466,14 +466,15 @@ Reveal.nextFragment(); // Randomize the order of slides Reveal.shuffle(); -// Shows a help overlay with keyboard shortcuts -Reveal.showHelp(); - // Toggle presentation states, optionally pass true/false to force on/off Reveal.toggleOverview(); Reveal.togglePause(); Reveal.toggleAutoSlide(); +// Shows a help overlay with keyboard shortcuts, optionally pass true/false +// to force on/off +Reveal.toggleHelp(); + // Change a config value at runtime Reveal.configure({ controls: true }); diff --git a/js/reveal.js b/js/reveal.js index a5783e0..882149e 100644 --- a/js/reveal.js +++ b/js/reveal.js @@ -1641,21 +1641,20 @@ * help is open, false means it's closed. */ function toggleHelp( override ){ - + if( typeof override === 'boolean' ) { - override ? showHelp( true ) : closeOverlay(); + override ? showHelp() : closeOverlay(); } - else { + else { if( dom.overlay ) { closeOverlay(); } else { - showHelp( true ); + showHelp(); } } } - /** * Opens an overlay window with help material. */ @@ -4878,10 +4877,6 @@ navigatePrev: navigatePrev, navigateNext: navigateNext, - // Shows a help overlay with keyboard shortcuts - showHelp: showHelp, - toggleHelp: toggleHelp, - // Forces an update in slide layout layout: layout, @@ -4894,6 +4889,9 @@ // Returns an object with the available fragments as booleans (prev/next) availableFragments: availableFragments, + // Toggles a help overlay with keyboard shortcuts + toggleHelp: toggleHelp, + // Toggles the overview mode on/off toggleOverview: toggleOverview,