Syntax (style guide)
From IFWiki
This page should provide a standard on how to consistently present examples of programming syntax.
literal | Literal token. Bold text should be entered literally. |
var | Variable token. Italic text means that the token must be replaced with something else. What that something else is should be defined on the same page, or this token should be a link to a page that does define it. |
a b | And. Use both token a and token b in the order given. |
a | b | Either-or. Use either token a or token b, but not both. |
[ a b ] | Token group. Italic square brackets can group a set of tokens; the square brackets should not be entered literally. |
token? | Optional token. A superscript question mark means that the token can be either included or left out. In other words, the token appears 0 or 1 times. |
token0+ | Optional multi-token. A superscript "0+" means that the token is optional, but may be included multiple times. That is, the token may have 0 or more instances. |
token1+ | Required multi-token. A superscript "1+" means that the token is required at least once, but may be included multiple times. That is, the token may have 1 or more instances. |