When it comes to describing actions on the real console (or on the simulated one), the following conventions are used (an extensive example is Recorded vs. coded macros):
always write as like as you were performing on a real console, even if playing with the simulator
always write as like as you were performing on a real console, even if playing with Titan One
any actions on the console shall be written as Monospaced Text
pressing real buttons shall be denoted using <angled brackets>, e.g. <Clear>
numbers may be slightly abbreviated, e.g. entering 12 (<1>
<2>
) may be denoted as <12>
pressing buttons consecutively is denoted as <button A>
<button B>
whereas holding button A pressed whiile pressing button B shall be denoted with a + (plus sign) <button A>
+ <button B>
clicking touch buttons shall be denoted using [square brackets], e.g. [Palette 1]
menu buttons (which can be called as touch buttons as well as hard keys A~H) shall be denoted as touch buttons regardless if there are real buttons or not (e.g. in root menu <A>
should be denoted as [Edit Times]
)
{curly braces} are used for variable inputs like {Select group of fixtures}
or {Select playback}
it's good pratice to comment the code - anything after double slashes //
is regarded as comment/annotation, as well as <!– the multiline syntax –>