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, PLVhlp: Online Help for PL/SQL Programs for details.
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.
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.
FUNCTION help_start (context_in IN VARCHAR2 := NULL)
Returns the string needed to start a comment to be used as online help text.
FUNCTION help_end (context_in IN VARCHAR2 := NULL)
Returns the string needed to end a comment to be used as online help text.
PROCEDURE show (context_in IN VARCHAR2, part_in IN
VARCHAR2 := c_main);
Displays the first page of help for the specified context.
Displays the next page of help, if there is any.
Copyright (c) 2000 O'Reilly & Associates. All rights reserved.