docs for #1816 and remove showHelp

This commit is contained in:
Hakim El Hattab 2017-02-09 11:37:47 +01:00
parent 1749f0d019
commit 5ad66f3779
2 changed files with 11 additions and 12 deletions

View file

@ -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 });

View file

@ -1643,19 +1643,18 @@
function toggleHelp( override ){
if( typeof override === 'boolean' ) {
override ? showHelp( true ) : closeOverlay();
override ? showHelp() : closeOverlay();
}
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,