Skip to Content
Advanced Oracle PL/SQL Programming with Packages
book

Advanced Oracle PL/SQL Programming with Packages

by Steven Feuerstein
October 1996
Intermediate to advanced
687 pages
16h 41m
English
O'Reilly Media, Inc.
Content preview from Advanced Oracle PL/SQL Programming with Packages

5.14. PLVhlp: Online Help Architechture

The PLVhlp (PL/Vision HeLP) package provides an architecture with which you can build online help for your own PL/SQL programs. See Chapter 17 for details.

5.14.1. Package constants

c_main CONSTANT CHAR(4) := 'HELP';

The keyword used to designate the main help for a program. This is the default kind of help to be shown.

c_examples CONSTANT VARCHAR2(30) := 'EXAMPLES';

The keyword used to designate the section of help displaying examples for a program. Other keywords can be added to the package to support other kinds of sections.

5.14.2. Setting the page size

PROCEDURE set_pagesize (pagesize_in IN NUMBER);

Sets the number of lines of help text to be displayed before a pause. The default is 25.

FUNCTION pagesize RETURN NUMBER;

Returns the number of lines of help text to be displayed before a pause.

5.14.3. Help text stub generators

FUNCTION help_start (context_in IN VARCHAR2 := NULL)
RETURN VARCHAR2;

Returns the string needed to start a comment to be used as online help text.

FUNCTION help_end (context_in IN VARCHAR2 := NULL)
RETURN VARCHAR2;

Returns the string needed to end a comment to be used as online help text.

5.14.4. Displaying online help

PROCEDURE show (context_in IN VARCHAR2, part_in IN
   VARCHAR2 := c_main);

Displays the first page of help for the specified context.

PROCEDURE more;

Displays the next page of help, if there is any.

Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.

Read now

Unlock full access

More than 5,000 organizations count on O’Reilly

AirBnbBlueOriginElectronic ArtsHomeDepotNasdaqRakutenTata Consultancy Services

QuotationMarkO’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.
Julian F.
Head of Cybersecurity
QuotationMarkI wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.
Addison B.
Field Engineer
QuotationMarkI’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.
Amir M.
Data Platform Tech Lead
QuotationMarkI'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Mark W.
Embedded Software Engineer

You might also like

Oracle Database 12c PL/SQL Programming

Oracle Database 12c PL/SQL Programming

Michael McLaughlin
Resilient Oracle PL/SQL

Resilient Oracle PL/SQL

Stephen B. Morris
Oracle PL/SQL

Oracle PL/SQL

Lewis Cunningham

Publisher Resources

ISBN: 1565922387Catalog PageErrata