Skip to main content

Customizing the Tour

The Tour is invoked by clicking the question mark icon in the upper right corner of GIPS. It darkens the window and highlights each control with a popup describing what it does — helping the user understand how to use GIPS.

Editing the tour from GIPS Desktop​

New in v4.0: the Tour pane in the Settings dialog. It lists the six controls a step may point at and lets steps be added, reworded, reordered, and removed, with an undo for each.

  • Highlight spotlights a step's target in the running app, so the wording can be checked against what the user will see.
  • A JSON tab shows and accepts the file directly, for bulk edits.
  • Content is validated as it is typed, and Save is refused while anything is wrong.
  • Load shipped tour puts the bundled steps back.

Saving writes tour.json to the configuration directory — Configuration Files... in GIPS Desktop opens it — which is the file GIPS Desktop already preferred over the bundled tour.json. Desktop only, and the file is carried into an exported GIPS Lite or Pro bundle.

note

Steps naming the harmers table are kept but skipped in GIPS Lite, which has no such table.

Control names​

Each control in the window has a name that uniquely identifies it:

  1. scenarios
  2. MWInjection
  3. pois
  4. map
  5. flowgates
  6. harmers

Things of note​

  1. The order of the tour is determined by the order of the items in the "tour" array. To describe the map first, simply put its entry first.
  2. Controls can be duplicated — two dialogs can be displayed one after the other describing the same control.
  3. Controls with the same name do not have to be together. You can describe the flowgates, then the map, then back to the flowgates — but this can be annoying, so do not do it too often.
  4. Not every control needs to be in the tour. If the map is self-explanatory, remove all entries whose control is "map".