The following formatting conventions are used in this documentation:
Pieces of programming code
, also HTML or XML source
Names of classes
,
methods
and properties
in
OO programming, for example C++
Names of attributes
,
elements
and entities
in
the SGML/XML space
Inline error texts
returned by the system
Names of variables
whose values are
specified by the user (for example environment variables)
Names of parameters
whose values are specified
by the user or program, usually as keyword=value
pair
KEYS that can be pressed on the keyboard (uppercase, smaller font)
Placeholder for values specified by the user or known only at runtime
Reference to a book, online manual, section of book or manual; reference to a location on internet. If hyperlinked, the browser default will be used
File and directory names, path names
Text to be emphasised
Command
; names of on the menu bar; names of opened from the menu barTitles of windows and dialog boxes; labels on tabs, fields, check boxes, radio butons, lists
Items selectable from lists in a GUI environment
"Quotations"
"Cited values" of parameters, attributes, element contents etc.