Aide contextuelle (F1)

Chaque bouton, champ, onglet ou commande d'EVENT a une clé, et chaque clé a sa section dans cette aide : la touche F1 ouvre l'aide exactement là où il faut.

Le principe

1. Une clé par élément. Dans EVENT, chaque élément qu'on peut chercher porte une clé stable : courses.generer pour le bouton « Générer les courses », inscriptions.dossards pour « Dossards… ». Ce sont les clés de la recherche de l'en-tête (Ctrl+K) : la liste complète est le catalogue de recherche d'EVENT.
2. Une section par clé. Dans la référence par écran, la section qui décrit un élément a pour identifiant sa clé : la page reference/composition.html contient la section courses.generer.
3. Une table. Le fichier aide/commun/f1/event.json associe chaque clé à sa page et à sa section : "courses.generer": "reference/composition.html#courses.generer".
4. F1. EVENT part de l'élément qui a le focus (sinon de celui qui est sous la souris) et remonte jusqu'à la fenêtre en notant chaque clé rencontrée, onglet choisi compris ; la première clé connue de f1.json donne la page et la section (par exemple reference/composition.html#courses.generer). Aucune : l'accueil de l'aide d'EVENT. Un menu ouvert : F1 vise sa commande. La section visée est mise en évidence quelques secondes.

Essayez avec un lien : reference/composition.html#courses.generer.

Où est l'aide, et sans F1

EVENT ouvre l'aide installée avec lui (dossier aide à côté du programme), dans la langue du logiciel (en français pour une page dont la traduction est à venir). Sans aide installée, il ouvre l'aide en ligne, sur le site chronofeed.ca. Pour trouver une section sans F1 :

• Dans cette aide, tapez le libellé de l'élément dans la recherche (Ctrl+K, en haut de chaque page) : « graine », « Dossards », « ligne d'arrivée ». Chaque section de la référence est indexée, avec ses mots-clés.
• Dans EVENT, la recherche de l'en-tête (Ctrl+K) trouve le même élément par les mêmes mots et le montre à l'écran.
• Le tableau ci-dessous mène de chaque clé à sa section.

Les modes

Certaines clés n'existent que pour un mode d'événement : la recherche d'EVENT ne les propose que si l'événement ouvert est de ce mode, et leur section porte un badge Temps ou Position. « Performances SSR » n'est proposé qu'en patinage de vitesse, longue piste.

Toutes les clés

Les 296 clés du catalogue de recherche d'EVENT, dans l'ordre du catalogue, avec le libellé et l'endroit tels que le logiciel les affiche.

Pour les rédacteurs

Un élément ajouté au catalogue de recherche d'EVENT demande une section dont l'id est sa clé, et sa ligne dans f1.json ; le contrôle tools/verif/aide_liens.py signale les clés qui n'ont pas encore de section. Le mode d'emploi est dans aide/LISEZMOI.md.