Context help (F1)

Every EVENT button, field, tab or command has a key, and every key has its section in this help: the F1 key opens the help exactly where it should.

How it works

1. One key per item. In EVENT, each item you can search for carries a stable key: courses.generer for the “Generate races” button, inscriptions.dossards for “Bibs…”. These are the keys of the header search (Ctrl+K): the full list is EVENT's search catalogue.
2. One section per key. In the reference by screen, the section that describes an item has its key as its identifier: the page reference/composition.html contains the section courses.generer.
3. A table. The file aide/commun/f1/event.json maps each key to its page and section: "courses.generer": "reference/composition.html#courses.generer".
4. F1. EVENT starts from the item that has the focus (otherwise the one under the mouse) and goes up to the window, noting each key it meets, the selected tab included; the first key known to f1.json gives the page and section (for example reference/composition.html#courses.generer). None: the home page of the EVENT help. An open menu: F1 targets its command. The targeted section is highlighted for a few seconds.

Try it with a link: reference/composition.html#courses.generer.

Where the help is, and without F1

EVENT opens the help installed with it (the aide folder next to the program), in the software's language (in French for a page whose translation is still to come). With no help installed, it opens the online help, on the chronofeed.ca website. To find a section without F1:

• In this help, type the item's label in the search (Ctrl+K, at the top of each page): “seed”, “Bibs”, “finish line”. Each section of the reference is indexed, with its keywords.
• In EVENT, the header search (Ctrl+K) finds the same item with the same words and shows it on screen.
• The table below leads from each key to its section.

The modes

Some keys exist only for one event mode: EVENT's search offers them only if the open event is in that mode, and their section carries a Time or Position badge. “SSR performances” is offered only in speed skating, long track.

All the keys

The 296 keys of EVENT's search catalogue, in catalogue order, with the label and the location as the software shows them (here in English).

For writers

An item added to EVENT's search catalogue needs a section whose id is its key, and its line in f1.json; the tools/verif/aide_liens.py check reports keys that do not have a section yet. The instructions are in aide/LISEZMOI.md.