From e9089e17b0d8b34dc01812c3486dfd0c2c043968 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?C=C3=A9dric=20Krier?= <ced@b2ck.com>
Date: Mon, 29 Jan 2024 20:33:22 +0100
Subject: [PATCH] Toggle a single instance of help dialog when pressing F1

Closes #12970
---
 sao/index.html |   1 +
 sao/src/sao.js | 104 +++++++++++++++++++++++++++----------------------
 2 files changed, 58 insertions(+), 47 deletions(-)

diff --git a/sao/index.html b/sao/index.html
index 302f961cf4..21067ea1f5 100644
--- a/sao/index.html
+++ b/sao/index.html
@@ -20,6 +20,7 @@ this repository contains the full copyright notices and license terms. -->
         <script type="text/javascript" src="bower_components/fullcalendar/dist/fullcalendar.min.js"></script>
         <script type="text/javascript" src="bower_components/fullcalendar/dist/locale-all.js"></script>
         <script type="text/javascript" src="bower_components/mousetrap/mousetrap.min.js"></script>
+        <script type="text/javascript" src="bower_components/mousetrap/plugins/pause/mousetrap-pause.min.js"></script>
         <script type="text/javascript" src="bower_components/Sortable/Sortable.min.js"></script>
 
         <link rel="stylesheet" href="bower_components/c3/c3.min.css">
diff --git a/sao/src/sao.js b/sao/src/sao.js
index 1268434a4c..f5a2ae13d9 100644
--- a/sao/src/sao.js
+++ b/sao/src/sao.js
@@ -1215,58 +1215,68 @@ var Sao = {
         }
     }
 
+    var _help_dialog = null;
+
     function help_dialog() {
-        var dialog = new Sao.Dialog(
-            Sao.i18n.gettext("Help"), 'help-dialog', 'md', true,
-            Sao.__version__);
-        jQuery('<button>', {
-            'class': 'close',
-            'data-dismiss': 'modal',
-            'aria-label': Sao.i18n.gettext("Close"),
-        }).append(jQuery('<span>', {
-            'aria-hidden': true,
-        }).append('&times;')).prependTo(dialog.header);
-        jQuery('<a/>', {
-            'class': 'btn btn-link',
-            'href': Sao.config.doc_url,
-            'target': '_blank',
-        }).text(Sao.i18n.gettext("Documentation..."))
-            .appendTo(dialog.footer);
-        jQuery('<h4/>')
-            .text(Sao.i18n.gettext("Keyboard shortcuts"))
-            .appendTo(dialog.body);
-        var row = jQuery('<div/>', {
-            'class': 'row'
-        }).appendTo(dialog.body);
-        var global_shortcuts_dl = jQuery('<dl/>', {
-            'class': 'dl-horizontal col-md-6'
-        }).append(jQuery('<h5/>')
-            .text(Sao.i18n.gettext('Global shortcuts')))
-            .appendTo(row);
-        var tab_shortcuts_dl = jQuery('<dl/>', {
-            'class': 'dl-horizontal col-md-6'
-        }).append(jQuery('<h5/>')
-            .text(Sao.i18n.gettext('Tab shortcuts')))
-            .appendTo(row);
+        Mousetrap.pause();
+        var dialog;
+        if (!_help_dialog) {
+            dialog = new Sao.Dialog(
+                Sao.i18n.gettext("Help"), 'help-dialog', 'md', true,
+                Sao.__version__);
+            jQuery('<button>', {
+                'class': 'close',
+                'data-dismiss': 'modal',
+                'aria-label': Sao.i18n.gettext("Close"),
+            }).append(jQuery('<span>', {
+                'aria-hidden': true,
+            }).append('&times;')).prependTo(dialog.header);
+            jQuery('<a/>', {
+                'class': 'btn btn-link',
+                'href': Sao.config.doc_url,
+                'target': '_blank',
+            }).text(Sao.i18n.gettext("Documentation..."))
+                .appendTo(dialog.footer);
+            jQuery('<h4/>')
+                .text(Sao.i18n.gettext("Keyboard shortcuts"))
+                .appendTo(dialog.body);
+            var row = jQuery('<div/>', {
+                'class': 'row'
+            }).appendTo(dialog.body);
+            var global_shortcuts_dl = jQuery('<dl/>', {
+                'class': 'dl-horizontal col-md-6'
+            }).append(jQuery('<h5/>')
+                .text(Sao.i18n.gettext('Global shortcuts')))
+                .appendTo(row);
+            var tab_shortcuts_dl = jQuery('<dl/>', {
+                'class': 'dl-horizontal col-md-6'
+            }).append(jQuery('<h5/>')
+                .text(Sao.i18n.gettext('Tab shortcuts')))
+                .appendTo(row);
 
-        for (const definition of shortcuts_defs()) {
-            var dt = jQuery('<dt/>').text(definition.label);
-            var dd = jQuery('<dd/>').append(jQuery('<kbd>')
-                .text(definition.shortcut));
-            var dest_dl;
-            if (definition.id) {
-                dest_dl = tab_shortcuts_dl;
-            } else {
-                dest_dl = global_shortcuts_dl;
+            for (const definition of shortcuts_defs()) {
+                var dt = jQuery('<dt/>').text(definition.label);
+                var dd = jQuery('<dd/>').append(jQuery('<kbd>')
+                    .text(definition.shortcut));
+                var dest_dl;
+                if (definition.id) {
+                    dest_dl = tab_shortcuts_dl;
+                } else {
+                    dest_dl = global_shortcuts_dl;
+                }
+                dt.appendTo(dest_dl);
+                dd.appendTo(dest_dl);
             }
-            dt.appendTo(dest_dl);
-            dd.appendTo(dest_dl);
+            dialog.modal.on('hidden.bs.modal', function() {
+                jQuery(this).remove();
+            });
+            _help_dialog = dialog;
+        } else {
+            dialog = _help_dialog;
         }
-        dialog.modal.on('hidden.bs.modal', function() {
-            jQuery(this).remove();
-        });
 
-        dialog.modal.modal('show');
+        dialog.modal.modal('toggle');
+        dialog.modal.one('shown.bs.modal hidden.bs.modal', Mousetrap.unpause);
         return false;
     }