Console API Typographical Conventions

Typographical conventions are used in our code examples. Learn what Courier font, italics, and brackets mean.

Convention	Description
`Courier font`	In descriptions of syntax, monospace font indicates items that you should type as shown, except for brackets. For example: `1Public class HelloWorld`
`Italics`	In descriptions of syntax, italics represent variables. You supply the actual value. In the following example, three values need to be supplied: `datatype` `variable_name` [ = `value`]; If the syntax is bold and italic, the text represents a code element that needs a value supplied by you, such as a class name or variable value: `1public static class YourClassHere { ... }`
`Bold Courier font`	In code samples and syntax descriptions, bold courier font emphasizes a portion of the code or syntax.
< >	In descriptions of syntax, less-than and greater-than symbols (< >) are typed exactly as shown. `1<apex:pageBlockTable value="{!account.Contacts}" var="contact"> 2 <apex:column value="{!contact.Name}"/> 3 <apex:column value="{!contact.MailingCity}"/> 4 <apex:column value="{!contact.Phone}"/> 5</apex:pageBlockTable>`
{ }	In descriptions of syntax, braces ({ }) are typed exactly as shown. `1<apex:page> 2 Hello {!$User.FirstName}! 3</apex:page>`
[ ]	In descriptions of syntax, anything included in brackets is optional. In the following example, specifying `value` is optional: `1data_type variable_name [ = value];`
\|	In descriptions of syntax, the pipe sign means “or”. You can do one of the following (not all). In the following example, you can create a new unpopulated set in one of two ways, or you can populate the set: `1Set<data_type> set_name 2 [= new Set<data_type>();] \| 3 [= new Set<data_type{value [, value2. . .] };] \| 4 ;`

Salesforce Console Developer Guide

Console API Typographical Conventions