Document Conventions and Tools

Oracle Cloud Infrastructure documentation employs various visual cues to enhance the clarity and usefulness of the information it provides. This page explains those font and presentation conventions. It also provides tips for effective searches in the online Help and describes other features and tools.

Font Conventions

The following font conventions have specific meaning within this document.

User Interface Labels

Text and labels that appear in the user interface appear in bold text. For example:

In the Console, click Compute, and then choose your Compartment.

Commands

Commands that you enter from your keyboard appear in a monospace typeface. For example:

sudo su

Variables

Placeholder text for required values appears in red text surrounded by angle brackets. For example:

useradd <new_user>

Code and Response Examples

Code and system response examples appear in a monospace typeface. For example:

# UPDATEDEFAULT specifies if new-kernel-pkg should make
# new kernels the default
UPDATEDEFAULT=yes

# DEFAULTKERNEL specifies the default kernel package type
DEFAULTKERNEL=kernel-uek

Notes, Tips, and Warnings

The documentation applies the following styles to draw your attention to important information:

Note

"Note" boxes provide information of special interest or importance to help you understand the behavior of the system.

Important

"Important" boxes address essential points to complete a task or understand a topic.

Tip

"Tips" provide helpful suggestions that can improve your experience using Oracle Cloud Infrastructure, or alternative ways of doing things.

Warning

"Warnings" provide important information to help you prevent data loss or damage.

Document Tools

Oracle Cloud Infrastructure documentation provides several tools to help you find the information you need. Chief among these tools is a powerful full-text search engine that features phrase and partial-word searching.

The following tools do not apply to PDF documentation.

Online Search

When you search the Oracle Cloud Infrastructure documentation, results appear in a ranked-order list. The ranking favors topics with search terms in headings and pages with multiple instances of the search terms. The results include the topic title and an excerpt from the topic's first paragraph. When you click a topic to open it, your search terms are highlighted in the topic.

Full-text searches are case-insensitive. A search for the word "availability" returns results with both "availability" and "Availability". Searches also return variant endings. For example, a search for the word "run" also returns matches for words like "runner", "running", and "runs".

Your search results can include topics that contain synonyms for the search term you specified. If the results include topics that do not appear to have your search term in them, be sure to scan those topics for relevant information. To avoid seeing results that contain synonyms, enclose your search term in quotation marks.

You can search for partial words and number strings with a minimum of three characters. For example, a search for "345" returns results such as "345", "12345", "34567", and "1234567".

Tip

The search engine does NOT recognize the asterisk (*) as a wildcard character.

Searching in PDF documents conforms to the search capabilities of your PDF reader.

Breadcrumbs

Image of documentation breadcrumbs

Breadcrumbs are hyperlinks that help you see where you are in the document and navigate up the hierarchy.

Topic Toolbar

Image of topic toolbar buttons

The topic toolbar includes three buttons. They are, from left to right:

  • Remove search highlights: When you search for terms, the documentation highlights your search terms wherever they appear on the topic pages. Use the Remove search highlights button to clear the highlights.
  • Expand all: The Expand all button expands all drop-down text in the current topic. It toggles between Expand all and Collapse all.

    Example Drop-down Hotspot
  • Print: The print button sends the current topic to your default printer. It opens your system's print dialog box for you to confirm the print settings.

Glossary Terms

A full glossary page provides definitions for all special terms used in this document. On many pages, glossary terms also appear as links upon their first use within the topic. To see the definition, hover your cursor over the term. For example:

Volumes are only accessible to instances in the same availability domain .

Supported Browsers

Oracle Cloud Infrastructure supports the following browsers and versions:

  • Google Chrome 69 or later
  • Safari 12.1 or later
  • Firefox 62 or later