[Contents] [Prev] [Next] [Index] [Report an Error]


Documentation Conventions

Table 1 defines notice icons used in this reference.

Table 1: Notice Icons 
Icon
Meaning
Description

Informational note

Indicates important features or instructions.

Caution

Indicates a situation that might result in loss of data or hardware damage.


Table 2 defines the JUNOS XML-specific typeface and notational conventions used in this reference. For a list of general JUNOS and J-Web conventions, see Table 3.

Table 2: JUNOS XML Typeface and Notational Conventions 
Convention
Element
Example

<name-in-sans-serif-typeface>

Represents a tag element. The angle brackets do not indicate that the enclosed element is optional, as they do in JUNOS configuration statements or commands.

The server emits the <generation> tag element before the <local-index> tag element.

<name-in-bold-sans-serif-
typeface>

Represents the tag element under discussion.

<rpc-reply>
    <end-session/>
</rpc-reply>

<!-- and --> (angle brackets, exclamation point, and hyphens)

Enclose an XML comment.

<!-- This is a comment; ignore it -->

... (ellipsis)

In the "Usage" section of a reference entry, appears between opening and closing tags to indicate that the child tag element is itself a container tag element with a separate entry in the reference.

<aggregate>
   <defaults>...</defaults>
   <route>...</route>
</aggregate>

| (pipe symbol)

In the "Usage" section of a reference entry, separates multiple possible parent tag elements for a child tag element.
Also separates mutually exclusive values for an attribute.

<chassis-inventory | firmware-information>
   <chassis>
      . . .
   </chassis>
</chassis-inventory | firmware-information>

[ ] (square brackets)

Enclose optional attributes in an opening tag.

<junoscript version="version"
[hostname="hostname"] [release="release"]>


Table 3 defines the general JUNOS and J-Web typeface and notational conventions used in this reference.

Table 3: JUNOS and J-Web Typeface and Notational Conventions
Convention
Element
Example
JUNOS Conventions



Bold sans serif typeface

Represents text that you type.

To enter configuration mode, type the configure command:

user@host> configure

Fixed-width typeface

Represents output on the terminal screen.

user@host> show chassis alarms
No alarms currently active

Italic typeface

  • Introduces important new terms.
  • Identifies book names.
  • Identifies RFC and Internet draft titles.
  • A policy term is a named structure that defines match conditions and actions.
  • JUNOS System Basics Configuration Guide
  • RFC 1997, BGP Communities Attribute

Italic sans serif typeface

Represents variables (options for which you substitute a value) in commands or configuration statements.

Configure the machine's domain name:

[edit]
root@#
set system domain-name domain-name

Sans serif typeface

Represents names of configuration statements, commands, files, and directories; IP addresses; configuration hierarchy levels; or labels on routing platform components.

  • To configure a stub area, include the stub statement at the [edit protocols ospf area area-id] hierarchy level.
  • The console port is labeled CONSOLE.

< > (angle brackets)

Enclose optional keywords or variables in JUNOS configuration statements or commands.

stub <default-metric metric>;

... (ellipsis)

Represents parts of a file or other example that are omitted to highlight the remaining elements.

if ( $config_node && $config_node ne "" ) {

    ... actions if XML DOM tree contains data ...

}

| (pipe symbol)

Indicates a choice between the mutually exclusive keywords or variables on either side of the symbol. The set of choices is often enclosed in parentheses for clarity.

broadcast | multicast

(string1 | string2 | string3)

# (pound sign)

Indicates a comment specified on the same line as the configuration statement to which it applies.

rsvp {  # Required for dynamic MPLS only

[ ] (square brackets)

Enclose a variable for which you can substitute one or more values.

community name members [ community-ids ]

Indention and braces ( { } )

Identify a level in the configuration hierarchy.

[edit]
routing-options {
       static {
           route default {
                nexthop
address;
                retain;
           }
       }
 }


; (semicolon)


Identifies a leaf statement at a configuration hierarchy level.

J-Web GUI Conventions

Bold typeface

Represents J-Web graphical user interface (GUI) items you click or select.

  • In the Logical Interfaces box, select All Interfaces.
  • To cancel the configuration, click Cancel.

> (bold right angle bracket)

Separates levels in a hierarchy of J-Web selections.

In the configuration editor hierarchy, select Protocols>Ospf.



[Contents] [Prev] [Next] [Index] [Report an Error]