Scheme of notation

Particular items on this site are indicated in a special manner to distinguish them. This table lists those items and gives the respective indication used together with one or more examples.

what indication example
names / literals quote »theRealNameOfSomething«
files / directories color /path/to/a/certain/file
environment variables prefix »$« $PYTHONPATH
shell commands monospaced block
> cd an/arbitrary/path
> ./aScript.py --foo theParameter [--bar]
options monospace --someOption or -s
optional items square brackets [--anOptionalSwitch]
variable items italics --theOption variableParameter

This topic: About > NotationScheme
Topic revision: 01 Nov 2012, PhilipEisenlohr
This site is powered by FoswikiCopyright by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding DAMASK? Send feedback
§ Imprint § Data Protection