Home

Standardized formatting for tours

We suggest the following standardized formatting:

• Any references to UI elements should use <font color="#402ee8">NAME OF UI ELEMENT</font>. The colour is deliberately chosen to be somewhere between black and the blue used for highlighting hyperlinks. The first letter of the UI element should be capitalized - it's a name, after all. One should make references to UI elements sparingly, as the tour inherently references UI elements by its very nature; it is not usually necessary to refer to it again in the text, other than for pedagogical purposes or when referring to linked panels.
• Any actions to be performed by the users should be marked with <strong>Action:</strong>. If following a block of other text, this should be on a new line with a space, i.e., <br /><br />. There should be no more than one action instruction per tour step.
• Any warnings should be labelled with <strong><font color="#ff0000">SOME WARNING HERE</font></strong>. This should involve starting a new line with a space if necessary, and again, this should be used judiciously.

We also suggest putting the following disclaimer on your first tour element, in case the tour does not work properly upon session flush:

<font color="##FF0000"><strong>NOTE:</strong></font> if the tour is not jumping to the correct UI elements, exit by clicking anywhere else on the app, and click on the top-right question mark to start a new tour.