package Help;

=head1 NAME

Help -- Provides help for extropy

=head1 SYNOPSIS

Help->display(int);

=head1 DESCRIPTION

This package provides help for extropy.

=head1 VERSION

0.001 (last update:  6/30/04)

=head1 AUTHOR

Chet Langin, clangin@siu.edu

SIU Plant Biotechnology and Genomics Core-facility

=head1 BUGS

The module is not yet finished.

=head1 SEE ALSO

extropy ExtropyConstants ExtropyUtils Extropy::MenuMain Extropy::Configuration Extropy::DBManager Extropy::ProjectCreate

=head1 COPYRIGHT

Copyright 2004, Chet Langin, All Rights Reserved.

This program is free software.  You may copy or
redistribute it under the same terms as Perl itself.

=head1 METHODS

The remainder of this document describes the methods available to the
programmer.

=cut

# load the pragmas
use warnings;
use strict;

# load other modules
use ExtropyUtils;
use ExtropyConstants;
# use Extropy::Configuration;
# use Extropy::DBManager;
# use Extropy::ProjectCreate;


# ********************************  display  **************************

=head2 display(int)

Displays a help message.

The parameter indicates which help message to display.

For example:

Help->display(1);

Display help message 1.

=cut

# --------------------------------------------------------------------

sub display {
  shift;
  my $message_number = shift;

  message_start;
  if($message_number == 1) {
    message("Enter a number or the character in parentheses () to select");
    message("a menu item.");
    blank_line;
    message("In general, work from the top down.");
    blank_line;
    message("A plus (+) indicates that something is already done");
    message("(but can be done, again).");
    blank_line;
    message("A minus (-) indicates that something else must be done, first.");
    blank_line;
    press_enter;
  } # if
  else {
    message("Help message $message_number will go here");
  } # else
} # disaply

1