|
Oracle® HTML DB
Release 2.0 |
|
 Previous |
 Next |
Oracle HTML DB includes built-in attributes to create Help for your application. Creating Help for your application involves the following steps:
Create a dedicated Help page and Help region
Define page Help text
Define item Help text
Create a navigation bar icon to link to your Help page
Help created in Oracle HTML DB displays on a dedicated Help page. To access Help, users click a link that takes them to a dedicated Help page. This Help page displays page and item Help topics specific to the page they are viewing.
Topics:
The first step in creating Help for your application it to create a dedicated page and Help Text region.
To create a new Help Text region:
Create new page for your Help. See "Adding Pages to an Application".
Navigate to the Page Definition of your Help page. See "Accessing a Page Definition".
Under Regions, the Create icon.
When prompted to select a region type, select Help Text.
Follow the on-screen instructions.
You define Help text for a page or single item by editing attributes. Ideally, you would define these attributes as you create your application. For simplicity, however, the following procedures describe how to define this text after the fact.
To define page Help text:
Navigate to the Page Definition for the page for which you want to add page Help.
Click Edit Attributes to view the existing page attributes.
Scroll down to Page Help Text.
Enter your Help text in the field provided.
Click Apply Changes.
Repeat the previous procedure for each page requiring page Help text.
To define item Help text for each page:
Navigate to the Page Definition for the page for which you want to add item Help.
Under Items, click name of the item you want to edit.
Scroll down to Help Text.
Enter your Help text in the field provided.
Click Apply Change.
Repeat the previous procedure for each item requiring Help text.
If you are including item Help in your application, you can edit multiple item Help topics at once using the Bulk Edit Item Help report.
To view the Bulk Edit Item Help report:
Navigate to the Workspace home page.
Click the Application Builder icon.
Select an application.
From the Tasks list, select View Application Reports.
Click Page Components.
Select Item Help Text.
A report displays at the bottom on the page.
In Bulk Item Help Report you can:
Update existing Help topics. Edit the Help text that appears and click Apply Changes.
Link to the Page Definition containing the item by clicking the page ID.
Link to the Page Item by clicking the item name.
If you application does not yet contain item Help, you perform a mass update of default Help text.
To seed item Help topics:
Access the Bulk Edit Item Help report.
Click Seed Item Help Text.
In Default Help Text, enter the default text to appear in all Help topics.
Click Apply Changes.
You can search for existing Help text, or for an item label.
To search for existing item Help topic:
In Help Contains, enter keywords.
Click Go.
Once you have created your Help, the next step is to create a navigation bar entry so users can link to it.
To create a navigation bar entry:
Navigate to the Page Definition:
Navigate to the Workspace home page.
Click the Application Builder icon.
Select an application.
Select a page.
The Page Definition appears.
Under Navigation Bar, click the Create icon.
Specify the appropriate navigation bar entry attributes:
Sequence
Alt Tag Text
Icon Image Name
Image Height and Image Width
Text
Specify the target location.
To specify the target location:
From Target type, select Page in this application.
In Page, specify the page ID.
In Request, type:
&APP_PAGE_ID.
By specifying substitution string &APP_PAGE_ID as the Request, you are instructing the HTML DB engine to display Help text for the current page when the user clicks this icon.