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.
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 that you enter from your keyboard appear in a monospace typeface. For example:
Placeholder text for required values appears in red text surrounded by angle brackets. For example:
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 Cautions
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.
"Cautions" provide important information to help you prevent data loss or damage.
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.
When you search the Oracle Cloud Infrastructure documentation, results appear in a ranked-order list. The ranking favors topics with search terms in page titles, followed by headings, and pages with multiple instances of the search terms. After titles and headings, search evaluates metadata descriptions, and then body text last. Search 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 by using multiple terms, a Boolean AND is inferred. (However, Boolean search is not supported.) 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" and "34567". A partially matching result always begins with the same first letter as the search term it matches.
To compensate for misspellings, searches apply fuzzy matching to search terms with a minimum of four characters. For example, a search for "victual network" returns results for "virtual network", replacing the letter "c" with the letter "r" to match "victual" to "virtual". The degree to which letter substitutions are allowed depends on the length of the search term. Search does not attempt the replacement of any letters in words that are four characters or less. If a word has between five and nine characters, search attempts to replace up to one letter when matching results. If a word has 10 characters or more, search allows up to two substitutions.
To determine the relevancy of a result, a search begins by matching against each word independently. Then, it treats the search input as a single phrase. Lastly, the location of matching terms, publication date, and popularity are considered. Popularity is determined by traffic, and an older topic might rank more highly in results than a newer topic if it is more popular.
By default, results are limited to content in the Oracle Cloud Infrastructure product documentation. If you want to expand a search to the rest of the Oracle Help Center, close the scope chip by hovering over the Oracle Cloud Infrastructure scope chip, and then clicking the X.
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.
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
In its default collapsed state, drop-down text lets you quickly scan the information available on the page. You then click the link to expose detailed information. Click the link again to collapse the text. The Expand all topic toolbar button opens or closes all drop-down text at once.
- 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.
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 .
Oracle Cloud Infrastructure supports the following browsers and versions:
- Google Chrome 69 or later
- Safari 12.1 or later
- Firefox 62 or later*
* The Console does not support Firefox Private Browsing.