Style Guide

Header Tags

-- @description [Name of script in sentence case]
-- @author Ben Smith
-- @link bensmithsound.uk
-- @source [Name of original author]
-- @version [1.0]
-- @testedmacos [most recent version of MacOS this has been tested with]
-- @testedqlab [most recent version of Qlab this has been tested with]
-- @about [Description of what the script does]
-- @separateprocess TRUE or FALSE [if the script needs to run within qlab as a separate process]

-- @changelog
--   v2.0  + new features
--   v1.0  + init

Changelog is optional for v1.0

Customisable variables

-- USER DEFINED VARIABLES -----------------

[enter variables here]

---------- END OF USER DEFINED VARIABLES --

Use 43 columns for these headings, and 2 blank lines either side.

If the script requires editing after the functions (for example, the script defines functions and the user decides which to use and how) then add the following before "end of user customisation area"

-- ENTER YOUR SCRIPT AT THE END -----------

Main Script

Highlight the start of the script with a 2 line gap and the following

---- RUN SCRIPT ---------------------------

Add notes to signpost the script with a blank line either side, like this.

-- What the script is doing

To signpost larger sections, you can use 4 hyphens.

---- A new section

Try to put them in the most logical places. For example, if one section is optional depending on a user defined variable, you can put the notes before the "if".

---- Do the thing

if theVariable is not "" then

Functions

Highlight the functions section with

-- FUNCTIONS ------------------------------

You can give descriptions of each one if you wish, or you can leave them without if the names are self explanatory.