Style Guide
Sample Technical Code
Statelake coding examples and sample technical code such as snippets of JSON, XML or Pascal script, will be displayed in a grey text code box with line numbers such as the following example -
procedure
ScriptEvent (
var
Value:variant);
begin
Value:= Dataset[
'FieldName'
].Value
end
;
This code can easily be copied where required, and pasted into scripts.
Information, warning icons
Information or alerts crucial to the information contained in the document will be highlighted by different icons. These alerts will be inserted into the text where appropriate.
Note. This icon indicates that important or additional information follows.
This denotes a NOTE text box.
INFORMATION. Similar to the NOTE text box. Indicates that more information or clarification should be sought.
This denotes an INFORMATION text box.
Hint. Small piece of practical or useful advice.
This denotes a HINT text box.
Warning. Details to be aware of.
This denotes a WARNING text box.
Stop. A critical warning that should not be ignored.
This denotes an ERROR or STOP text box.