1.7 Using Oracle Application Express Documentation

Oracle Application Express provides a hosted online documentation library and field-level Help. You access, search, or download the online documentation library by going to the Oracle Help Center.

1.7.1 Accessing Oracle Help Center

You can access the Oracle Application Express documentation by clicking Documentation on the Help menu, or by clicking Learn More... links within the user interface.

To access Oracle Help Center:

  • Click the Help menu in the upper right corner and select Documentation Library.

    Oracle Help Center appears.

  • Click Learn More... links within the user interface to view information regarding the current page.

    Information regarding the current page appears.

Redirecting the Help Menu

Administrators can redirect the Help menu at the instance-level in Manage Instance, Instances Settings in the Oracle Application Express Administration Services application. Oracle Application Express Administration Services is a separate application that enables an Instance administrator to manage an entire Oracle Application Express hosted instance. This functionality is not available to some customers who are using a hosted instance.

See Also:

“Configuring the Help Menu” in Oracle Application Express Administration Guide

1.7.2 Searching the Oracle Help Center

To perform a keyword search of the online documentation library:

  1. Click the Help menu in the upper right corner of most Oracle Application Express pages.
  2. Select Documentation .
    Oracle Help Center appears.
  3. To search the entire library:
    1. Enter keywords in the Search field at the top of the page and press Enter (or click the Search icon).
      Search results display.
    2. Select a topic to view.
  4. To search a specific document:
    1. Enter keywords in the Search field in the left pane and press Enter (or click the Search icon).
      Search results display.
    2. Select a topic to view.

Tip:

While viewing a topic, a table of content displays in the left pane. To hide this pane, click the left facing arrow beneath the document title. The left pane is temporarily hidden.

1.7.3 Downloading the Documentation Library

Use the Download all Oracle Application Express release 5.1 books link to download the Oracle Application Express documentation library.

To download the online documentation library:

  1. Access Oracle Help Center. Click the Help menu in the upper right corner and select Documentation
  2. Under Download the Oracle Application Express Bookshelf, click Download all Oracle Application Express release 5.1 books.
  3. Save the ZIP file locally.
  4. Download the ZIP file and extract it locally.
  5. Open the extracted folder and click index.html.

    The Oracle Application Express Documentation Library welcome page appears.

1.7.4 Viewing Field-Level Help

Most select lists, check boxes, items, and fields within the Oracle Application Express include field-level Help. Field-level Help displays in two different ways depending upon where you are viewing it.

1.7.4.1 Viewing Field-level Help in Oracle Application Express

Most select lists, check boxes, items, and fields within the Oracle Application Express include field-level Help.

To view field-level help:

  1. Navigate to the attribute you need information about.

    Most attributes in Oracle Application Express include field-level Help. Attributes with field-level Help, have light gray icon that resembles a question mark (?). Passing your cursor over the icon displays the tooltip, Help Text:....

  2. To view field-level Help, click the Help Text icon.

    A Help window appears.

    Tip:

    To access field-level help with the keyboard, focus on the correct field and then press Alt+F1.

1.7.4.2 Viewing Help in Page Designer

Page Designer includes Help for all properties in the Property Editor.

To view Help in Page Designer:

  1. Access Page Designer.

    Page Designer appears.

  2. Select a component or control in either the left pane or the central pane.

    As you change focus in either view, the Property Editor automatically updates to reflect the currently selected component.

  3. In the Property Editor, select an attribute.
  4. To view help for an attribute, select the attribute in the Property Editor and click the Help tab in the central pane.

    Once you activate the Help pane, the content that displays changes every time you select another attribute.

    Tip:

    To view an online summary that describes just the Page Designer window, view a page in Page Designer, click the Help menu at the top of the page, and select Getting Started with Page Designer.