Home >
Online Product Documentation >
Table of Contents >
Conventions in This Document
Conventions in This Document
This section describes the typographical and formatting conventions used in this document for text, notes, warnings, and important messages. It covers
Typographical Conventions
This document uses the following typographical conventions:
-
Bold typeface in this font indicates keyboard key names (such as
Tab or
Enter) and the names of windows, menu commands, buttons, and other user-interface elements. For example, "From the
File menu, select
Open."
Bold typeface in this font emphasizes new terms when they are introduced.
-
Monospace typeface indicates text that might appear on a computer screen other than the names of user-interface elements, including all of the following:
- Code examples
- Code that the user must enter
- System output (such as responses, error messages, and so on)
- Filenames and pathnames
- Software component names, such as class and method names
Essentially,
monospace typeface indicates anything that the computer is "saying," or that must be entered into the computer in a language that the computer "understands."
Bold monospace typeface emphasizes text that would otherwise appear in
monospace typeface.
Monospace typeface in italics or Bold monospace typeface in italics (depending on context) indicates variables or placeholders for values you supply or that might vary from one case to another.
Syntax Notation
This document uses the following syntax notation conventions:
- Brackets (
[ ]) in syntax statements indicate parameters that are optional.
- Braces (
{ }) indicate that one (and only one) of the enclosed items is required. A vertical bar (
|) separates the alternative selections.
- Ellipses (
...) indicate that you can choose one or more of the preceding items.
Information Alerts
This document highlights special kinds of information by shading the information area, and indicating the type of alert in the left margin.
|
Tip
|
|
A
Tip flag indicates helpful usage information about Stylus Studio.
|
|
Note
|
|
A
Note flag indicates information that complements the main text flow. Such information is especially needed to understand the concept or procedure being discussed.
|
|
Important
|
|
An
Important flag indicates information that must be acted upon within the given context in order for the procedure or task (or other) to be successfully completed.
|
|
Warning
|
|
A
Warning flag indicates information that can cause loss of data or other damage if ignored.
|
Home Edition Alerts
Some features are supported only in Stylus Studio XML Professional Edition. Documentation that describes these features is identified with an alert like the following:
|
|
|
XQuery support is available only in Stylus Studio XML Professional Edition.
|
A summary of features that are available only in Stylus Studio XML Professional Edition can be found in
About Stylus Studio Home Edition.
Cart
