beautypg.com

Typographic conventions – Altera Stratix III User Manual

Page 34

background image

Info–2

Additional Information

Typographic Conventions

Stratix III Development Kit User Guide

© August 2008

Altera Corporation

Typographic Conventions

This document uses the typographic conventions shown in the following table.

Visual Cue

Meaning

Bold Type with Initial
Capital Letters

Command names, dialog box titles, checkbox options, and dialog box options are shown in
bold, initial capital letters. Example: Save As dialog box.

bold type

External timing parameters, directory names, project names, disk drive names, filenames,
filename extensions, and software utility names are shown in bold type. Examples: f

MAX

,

\qdesigns directory, d: drive, chiptrip.gdf file.

Italic Type with Initial
Capital Letters

Document titles are shown in italic type with initial capital letters. Example: AN 75: High-Speed
Board Design.

Italic type

Internal timing parameters and variables are shown in italic type. Examples: t

PIA

, n + 1.

Variable names are enclosed in angle brackets (< >) and shown in italic type.
Example: , .pof file.

Initial Capital Letters

Keyboard keys and menu names are shown with initial capital letters. Examples: Delete key, the
Options menu.

“Subheading Title”

References to sections within a document and titles of on-line help topics are shown in
quotation marks. Example: “Typographic Conventions.”

Courier type

Signal and port names are shown in lowercase Courier type. Examples:

data1

,

tdi

,

input.

Active-low signals are denoted by suffix

n

, e.g.,

resetn

.

Anything that must be typed exactly as it appears is shown in Courier type. For example:

c:\qdesigns\tutorial\chiptrip.gdf

. Also, sections of an actual file, such as a Report

File, references to parts of files (e.g., the AHDL keyword

SUBDESIGN

), as well as logic function

names (e.g.,

TRI

) are shown in Courier.

1., 2., 3., and
a., b., c., etc.

Numbered steps are used in a list of items when the sequence of the items is important, such
as the steps listed in a procedure.

Bullets are used in a list of items when the sequence of the items is not important.

v

The checkmark indicates a procedure that consists of one step only.

1

The hand points to information that requires special attention.

c

The caution calls attention to a condition that could damage the product or design and should
be read prior to starting or continuing with the procedure or process.

w

The warning calls attention to a condition that could cause injury to the user and should be
read prior to starting or continuing the procedure or processes.

r

The angled arrow indicates you should press the Enter key.

f

The feet direct you to more information on a particular topic.