Document Conventions - Cisco OL-18696-01 Development Manual

Obtaining Documentation and Submitting a Service Request

Document Conventions

This document uses the following conventions:
Convention
bold font
italic font
[ ]
{x | y | z }
[ x | y | z ]
string
courier
< >
[ ]
!, #
Means reader take note.
Note
Means the following information will help you solve a problem.
Tip
Caution Means reader be careful. In this situation, you might perform an action that could result in equipment
damage or loss of data.
Means the described action saves time. You can save time by performing the action described in
Timesaver
the paragraph.
Means reader be warned. In this situation, you might perform an action that could result in
Warning
bodily injury.
Cisco Unified IP Phone Services Application Development Notes
x
Indication
Commands and keywords and user-entered text appear in bold font.
Document titles, new or emphasized terms, and arguments for which you supply
values are in italic font.
Elements in square brackets are optional.
Required alternative keywords are grouped in braces and separated by
vertical bars.
Optional alternative keywords are grouped in brackets and separated by
vertical bars.
A nonquoted set of characters. Do not use quotation marks around the string or
the string will include the quotation marks.
font Terminal sessions and information the system displays appear in
Nonprinting characters such as passwords are in angle brackets.
Default responses to system prompts are in square brackets.
An exclamation point (!) or a pound sign (#) at the beginning of a line of code
indicates a comment line.
Preface
font.
courier
OL-18696-01