Raccourcis

Description#

Par défaut des raccourcis clavier sont fournis pour permettre d’intéragir plus facilement avec le thème, mais il est possible de définir des raccourcis spécifique par le biais d’un minimum de configuration.
Par exemple, il est possible d’obtenir la liste des raccourcis disponibles en utilisant le raccourci Maj + k.

Définir un raccourci spécifique#

Afin de définir un raccourci, il faut suivre le process suivant (exemple avec le raccourci example (Maj + 1) du site du thème):

  1. Définir la configuration générale du raccourci dans le fichier de configuration spécifique du site (Cf. lignes surlignées ci-dessous):
    hugo.toml (section [params])
      1[params]
  2  # Chemin des fichiers logo du site
  3  logo                    = "images/logo.png"
  4  logoTouch               = "images/logoTouch.png"
  5  # Chemin du fichier de l'image affichée en cas d'erreur 404
  6  image404                = "images/404.gif"
  7  # Chemin du fichier du favicon du site
  8  favicon                 = "images/favicon.png"
  9  # Aperçu par défaut de la page d'accueil
 10  homeLayout              = "onboarding"
 11  # Ordre du contenu du site (https://gohugo.io/templates/lists/#order-content)
 12  siteContentOrder        = "weight"
 13  # Active/Désactive la table des matières de manière globale (sur tout le site)
 14  toc                     = true
 15  # Active une bannière globale sur toutes les pages du site
 16  globalBanner            = true
 17  # Version courante du site
 18  currentVersion          = "latest"
 19  # Url de la dernière version du site
 20  latestVersionUrl        = "https://jgazeau.github.io/shadocs/"
 21  # Active le mode sombre par défaut
 22  darkMode                = true
 23  # Force la résolution des liens en utilisant la fonction relref (https://gohugo.io/content-management/cross-references/)
 24  enforceRefrelLinks      = true
 25  # Désactive le bouton "Imprimer" dans la barre de navigation
 26  navbarPrintEntry        = false
 27  # Désactive le bouton "QR code" dans la barre de navigation
 28  navbarQRCodeEntry       = false
 29  # Désactive le bouton "Raccourcis" dans la barre de navigation
 30  navbarSchortcutsEntry   = false
 31  # Désactive le bouton "À propos" dans la barre de navigation
 32  navbarInfo              = false
 33  # Liste des raccourcis clavier
 34  # Pour chaque raccourci il faut renseigner les clés suivantes:
 35  # - keys     = [Table des touches de clavier du raccourci](https://developer.mozilla.org/fr/docs/Web/API/KeyboardEvent/key/Key_Values)
 36  # - function = "Nom de la fonction javascript à appeler par le raccourci"
 37  [params.navbar.shortcuts]
 38    # Définition du raccourci d'exemple
 39    [params.navbar.shortcuts.example]
 40      keys     = ["Shift","1"]
 41      function = "scExample"
 42  # Liste des taxonomies
 43  # Pour chaque taxonomie il est possible de renseigner les clés suivantes:
 44  # - icon = "Classes fontawesome associées à la taxonomie"
 45  [params.taxonomies]
 46    [params.taxonomies.categories]
 47      icon = "fa-solid fa-table-cells"
 48  #
 49  # Liste des assets (https://gohugo.io/hugo-pipes/resource-from-template/) à inclures
 50  # Les assets gérés:
 51  # - css                   = [Liste des fichiers CSS]
 52  # - js                    = [Liste des fichiers javascript]
 53  # - jsModules             = [Liste des fichiers modules javascript]
 54  # - fencedcodes.css       = [Liste des fichiers CSS à inclure quand le language d'un bloc de code cloisonné associé est présent dans le contenu de la page]
 55  # - fencedcodes.js        = [Liste des fichiers javascript à inclure quand le language d'un bloc de code cloisonné associé est présent dans le contenu de la page]
 56  # - fencedcodes.jsModules = [Liste des fichiers modules javascript à inclure quand le language d'un bloc de code cloisonné associé est présent dans le contenu de la page]
 57  # - shortcodes.css        = [Liste des fichiers CSS à inclure quand le shortcode associé est présent dans le contenu de la page]
 58  # - shortcodes.js         = [Liste des fichiers javascript à inclure quand le shortcode associé est présent dans le contenu de la page]
 59  # - shortcodes.jsModules  = [Liste des fichiers modules javascript à inclure quand le shortcode associé est présent dans le contenu de la page]
 60  #
 61  [params.includes]
 62    css = [
 63      "css/file1.css",
 64      "css/fileX.css"
 65    ]
 66    js = [
 67      "js/file1.js",
 68      "js/fileX.js"
 69    ]
 70    jsModules = [
 71      "js/modules/file1.js",
 72      "js/modules/fileX.js"
 73    ]
 74  [params.includes.fencedcodes.css]
 75    fencedcode1 = [
 76        "css/fencedcodes/fencedcode1.css"
 77      ]
 78    fencedcodeX = [
 79        "css/fencedcodes/fencedcodeX.css"
 80      ]
 81  [params.includes.fencedcodes.js]
 82    fencedcode1 = [
 83        "js/fencedcodes/fencedcode1.js"
 84      ]
 85    fencedcodeX = [
 86        "js/fencedcodes/fencedcodeX.js"
 87      ]
 88  [params.includes.fencedcodes.jsModules]
 89    fencedcode1 = [
 90        "js/fencedcodes/modules/fencedcode1.js"
 91      ]
 92    fencedcodeX = [
 93        "js/fencedcodes/modules/fencedcodeX.js"
 94      ]
 95  [params.includes.shortcodes.css]
 96    shortcode1 = [
 97        "css/shortcodes/shortcode1.css"
 98      ]
 99    shortcodeX = [
100        "css/shortcodes/shortcodeX.css"
101      ]
102  [params.includes.shortcodes.js]
103    shortcode1 = [
104        "js/shortcodes/shortcode1.js"
105      ]
106    shortcodeX = [
107        "js/shortcodes/shortcodeX.js"
108      ]
109  [params.includes.shortcodes.jsModules]
110    shortcode1 = [
111        "js/shortcodes/modules/shortcode1.js"
112      ]
113    shortcodeX = [
114        "js/shortcodes/modules/shortcodeX.js"
115      ]
  2. Définir les libellés du raccourci qui apparaitront dans le menu d’aide des raccourcis (dans le fichier de traduction i18n adéquat):
    fr.yaml
     1- id: navbarinfo_content
 2  translation: |
 3    Site généré avec [Hugo](https://gohugo.io/)
 4- id: navbarinfo_github_main
 5  translation: Projet GitHub
 6- id: navbarinfo_github_download
 7  translation: Télécharger
 8- id: navbarinfo_github_issue
 9  translation: Signaler une anomalie
10- id: navbarinfo_github_fork
11  translation: Fork
12# Libellés (séparés par des virgules) associés au touches de clavier du raccourci
13- id: example_keys_wording
14  translation: 'Maj,1'
15# Description du raccourci
16- id: example_wording
17  translation: 'Afficher un exemple de raccourci'
18- id: shortcut_example
19  translation: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed ut aliquam metus. Nam massa lectus, consequat nec est eget, faucibus suscipit nunc. Donec dapibus tortor eget libero laoreet, quis commodo orci mattis. Pellentesque in arcu et odio viverra varius vitae sit amet dolor. Mauris venenatis malesuada leo, et egestas lectus feugiat vel. Morbi pretium id turpis ac varius. Integer ut ipsum augue.'
  3. Définir le code javascript associé au raccourci et appelé par le biais de la fonction définie à l’étape 1:
    shortcuts.js
    import {
  addElementToModal,
  displayModal,
} from './theme/modules/helpers.min.js';

// Function to display a shortcut example
window.scExample = scExample;
function scExample() {
  let el = document.createElement('div');
  el.classList.add('shortcut-example');
  el.innerHTML = '{{- i18n "shortcut_example" -}}';
  addElementToModal(el);
  displayModal();
}