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" boxes provide information of special interest or importance to help you understand the behavior of the system.

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

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

"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, partial-word, and Boolean 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".

When you search using multiple terms, a Boolean AND is inferred. You can search for precise matches on terms and phrases by enclosing the terms in quotation marks. For example, you can use quotation marks to search for the phrase "availability domain" and get results for topics in which those terms appear in that exact order.

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".

You can use the following Boolean operators to refine your search:

Operator Usage
AND

Narrows the search to retrieve only topics that contain all the words it separates.

Type AND between two or more terms. It is not case-sensitive. AND is inferred when terms are separated by a blank space.

You can use the plus symbol (+) or an ampersand (&) instead of the word AND.

OR

Broadens the search to retrieve topics that contain any of the words it separates.

Type OR between two or more terms. It is not case-sensitive.

You can use the pipe symbol (|) instead of typing OR.

NOT

Restricts the search to retrieve topics that contain one term but not another.

Type NOT between two terms. It is not case-sensitive.

You can use the carat symbol (^) instead of typing NOT.

Cannot be used with a single term.

( )

Parentheses combine Boolean phrases and search terms.

Type parentheses ( ) around the combined terms. For example:

(availability AND domain) OR region

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.

Search filters help you restrict your search to a group of related topics. For example, a search for "subnets" can return dozens of results. You can apply the Load Balancing Topics filter to see only results from the Load Balancing topics that contain the term "subnets".

  • To see a list of available filters, click the funnel icon This image shows the search filter background icon in the search bar.
  • To restrict your search, click a filter such as Load Balancing Topics.
  • To show results for a different set of topics, choose a different filter.
  • To remove a filter, click All Files in the list of available filters.
  • You can apply only one filter at a time.

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.

  • 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 domainOne or more isolated, fault-tolerant Oracle data centers that host cloud resources such as instances, volumes, and subnets. A region contains several availability domains..

Supported Browsers

Oracle Cloud Infrastructure supports the latest desktop versions of Google Chrome, Microsoft Edge, Internet Explorer 11, Firefox, and Firefox ESR. Note that private browsing mode is not supported for Firefox, Internet Explorer, or Edge. Mobile browsers are not supported.