aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHakim El Hattab <hakim.elhattab@gmail.com>2017-02-09 11:37:47 +0100
committerHakim El Hattab <hakim.elhattab@gmail.com>2017-02-09 11:37:47 +0100
commit5ad66f3779a7b26e43f899753a26ef5e3fe9667f (patch)
tree59bc11a6fd6deb9d8370273c136a1f4aea34b6d4
parent1749f0d019c4460e13530db19882079c4ec0a124 (diff)
downloadfosdem-2018-presentation-5ad66f3779a7b26e43f899753a26ef5e3fe9667f.tar
fosdem-2018-presentation-5ad66f3779a7b26e43f899753a26ef5e3fe9667f.tar.gz
docs for #1816 and remove showHelp
-rw-r--r--README.md7
-rw-r--r--js/reveal.js16
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,