#!/usr/sbin/perl
#**************************************************************************
#* *
#* Copyright (c) 1996 Silicon Graphics, Inc. *
#* All Rights Reserved *
#* *
#* THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF SGI *
#* *
#* The copyright notice above does not evidence any actual of intended *
#* publication of such source code, and is an unpublished work by Silicon *
#* Graphics, Inc. This material contains CONFIDENTIAL INFORMATION that is *
#* the property of Silicon Graphics, Inc. Any use, duplication or *
#* disclosure not specifically authorized by Silicon Graphics is strictly *
#* prohibited. *
#* *
#* RESTRICTED RIGHTS LEGEND: *
#* *
#* Use, duplication or disclosure by the Government is subject to *
#* restrictions as set forth in subdivision (c)(1)(ii) of the Rights in *
#* Technical Data and Computer Software clause at DFARS 52.227-7013, *
#* and/or in similar or successor clauses in the FAR, DOD or NASA FAR *
#* Supplement. Unpublished - rights reserved under the Copyright Laws of *
#* the United States. Contractor is SILICON GRAPHICS, INC., 2011 N. *
#* Shoreline Blvd., Mountain View, CA 94039-7311 *
#**************************************************************************
# DEMO_help.pl
#
# Routines to print help information
1; # Return true
sub Generate_Help_Menu {
# Don'want to password protect the help page any longer since the admin
# stuff has been broken out
# if ($_[0]) {
# $no_passwd = "&$CGI_MAINT_OUTSIDE_SWITCH=$CGI_MAINT_FALSE_FLAG";
# } else {
# $no_passwd = "";
# }
local($help_page) = "$WWW_SCRIPT?$CGI_SWITCH=$FRAME_MAIN&$CGI_SUB_SWITCH=$CGI_HELP_FLAG";
&Print_HTTP_Header;
print "
\n";
print "Help Information\n
\n";
print "\n";
print "\n";
print "- HTML Demo Interface...\n";
print "
\n";
print "
\n";
print "\n";
print "Quick Start
\n";
print "\n";
print "
\n";
print "\n";
print "HTML Demo Interface Frames
\n";
print "\n";
print "
\n";
print "\n";
print "Demo Lists
\n";
print "\n";
print "
\n";
print "\n";
print "Demo Information Pages
\n";
print "\n";
print "
\n";
print "\n";
print "Searching
\n";
print "\n";
print "
\n";
print "\n";
print "Administration
\n";
print "\n";
print "
\n";
print "
\n";
&Print_HTTP_Footer;
}
sub Print_Help_Page {
&Print_HTTP_Header;
print <
Quick Start for the Impatient!
|
Clicking the
image icon in the left frame will start a demo.
|
|
Clicking the demo name in the left frame will display demo information.
|
|
Use the menu button located at the top of the left frame to select various demo lists.
|
HTML Demo Interface Frames
This HTML Demo Interface consists of three primary display areas (frames).
The main frame is used for displaying this help document, information about individual demos, and searching and administrative utilities.
The left-most frame is primarily used to display demo lists. Demo lists are selected from among the choices available in menu button found at the top of the frame. Demo lists contain two items for each demo. The "Do It!" icon item starts a demo and the \"Info\" hyperlink item displays demo information into the main frame.
The bottom-most frame is accessible from every page, and contains a set of buttons. These buttons are used to access the Home page for the HTML Demo Interface as well as the Search, Administration and Help functionality.
|
Demo Lists
Demo Information Pages
Each demo has a detailed information page which is intended to provide the following information.
|
Title
Start Button
Brief 1-2 Sentence Description
Author Name(s)
Minimal Instructions
Detailed Instructions
Additional Information (Contributing authors etc)
Special System Requirements
Categorization Information
Links to Related Categories
|
Searching
| |
Use the icon located in the bottom frame to search for a demo by Title, or by a combination of Features, Industries and Hardware options.
|
| |
|
| Title Search: |
Enter a text string into the Title field and click Search to search by demo title. For example, ant would return the Ant and Atlantis demos, if both are installed on the system.
|
|
| |
|
| Category Search: |
Enter a more specific query by selecting any combination of items in the Industries, Features and/or Hardware categories from the Search page.
By default a "Normal Search" is done. If a less restrictive search is desired, select "Match ANY Selected Items"; if a more restrictive search is desired, select "Match ALL Selected Items".
|
|
Administration
Use the icon located in the bottom frame to access the following Administration functions:
|
Managing Custom Demo Lists
|
Create, edit or remove custom demo lists.
|
|
Password Protection
|
Password protect the administration functions of the HTML Demo Interface.
|
|
Editing Demo Information
|
Edit demo information page.
|
|
Add a Demo
|
Add a Custom Demo to the HTML Demo Interface.
|
|
Add a Group of Demos
|
Add a group of demos so they can be used within the HTML Demo Interface.
|
|
Managing Categories
|
Add, Change or Remove items in the Features, Industries or Hardware categories.
|
|
Update Demo Tables
|
Update the demo tables used by the HTML Demo Interface to keep track of various demo information.
|
|
EOT
;
} # end Print_Help_Page
sub Print_Help_Page_Admin {
# This will need to work but I'm not sure it does yet so I'll not uncomment it yet.
# if ("$in{$CGI_MAINT_OUTSIDE_SWITCH}" eq "$CGI_MAINT_FALSE_FLAG") {
# $no_passwd = "&$CGI_MAINT_OUTSIDE_SWITCH=$CGI_MAINT_FALSE_FLAG";
# } else {
# $no_passwd = "";
# }
########### The following assignments was take from the Print_Help_Page subrouting ###############
########### If these lines are changed, they should be changed in both places ###############
# Create the urls to the different forms for simplicity
$passwd_form = "$WWW_SCRIPT?$CGI_SWITCH=$CGI_MAINT_FLAG$no_passwd&$CGI_SUB_SWITCH=$CGI_MAINT_PASSWD_FLAG";
$edit_form = "$WWW_SCRIPT?$CGI_SWITCH=$CGI_MAINT_FLAG$no_passwd&$CGI_SUB_SWITCH=$CGI_MAINT_EDIT_FLAG";
$add_form = "$WWW_SCRIPT?$CGI_SWITCH=$CGI_MAINT_FLAG$no_passwd&$CGI_SUB_SWITCH=$CGI_MAINT_ADD_FLAG";
$tree_form = "$WWW_SCRIPT?$CGI_SWITCH=$CGI_MAINT_FLAG$no_passwd&$CGI_SUB_SWITCH=$CGI_MAINT_ADD_TREE_FLAG";
$custom_form = "$WWW_SCRIPT?$CGI_SWITCH=$CGI_MAINT_FLAG$no_passwd&$CGI_SUB_SWITCH=$CGI_MAINT_CUSTOM_FLAG";
$category_form = "$WWW_SCRIPT?$CGI_SWITCH=$CGI_MAINT_FLAG$no_passwd&$CGI_SUB_SWITCH=$CGI_MAINT_ELEMENTS_FLAG";
$update_form = "$WWW_SCRIPT?$CGI_SWITCH=$CGI_MAINT_FLAG$no_passwd&$CGI_SUB_SWITCH=$CGI_MAINT_UPDATE_FLAG";
# Create link objects
$passwd_link = "Password Protection Form";
$edit_link = "Edit Demo Information Form";
$add_link = "Load New Demo Form";
$tree_link = "Load New Tree Form";
$update_link = "Update Tables Form";
$custom_link = "Custom List Manager";
$category_link = "Cataegory Manager";
########### The previous assignments was take from the Print_Help_Page subrouting ###############
########## If these lines are changed, they should be changed in both places #########
$DOIT = "click on the
icon in the "Do It!" column, next to the";
print <
Managing Custom Demo Lists
To manage custom demo lists, $DOIT "Managing Custom Demo Lists" text.
Managing Custom Demo List Functionality
- Creating a Custom Demo List
- Enter the name of the custom demo list (e.g. "Network Games") in the text field and press "Enter".
- This will bring up a page with a list of all demos loaded in the interface.
- Check the demos you wish to include in your custom demo list and press the "Make List" button to create your custom demo list.
- Editing a Custom Demo List
- Click on the "Edit List" button.
- This will bring up a page with a list of all demos on your system.
- Check and uncheck demos to add and delete them from your custom list and press "Make List" when done.
- Changing a Custom Demo List Name
- Find the name of the custom demo list in the "Pick Demo List" portion of the page.
- To change the list's name, change the text in the "name" field and then click "Change Name".
- Viewing a Custom Demo List
- Find the list you want to view under the "Pick Demo List" portion of the page.
- Click on "View List" to bring up a pop-up window with the demos found in that list.
- Deleting a Custom Demo List
- Find the name of the custom list in the "Pick Demo List" portion of the page.
- To delete the list click on "Delete List" in the appropriate row.
- You will be prompted for confirmation. Click "OK" and the custom list will be deleted.
|
Password Protection
To create/change or delete a password, $DOIT "Password Protection" text.
During public displays, it may be desirable to password protect the administration functionality of the HTML Demo Interface.
|
Editing Demo Information
|
To edit demo information, $DOIT "Edit Demo Information" text.
Editing Demo Information Functionality
- Find the demo whose information you to wish edit in the "Edit" section.
- Click on the demo name.
- This will bring up a page with many fields.
- For each field, enter or select the appropriate information.
- Click on "Update" to continue.
- The next page is an example of what the completed demo information looks like.
- To make more changes, click the
button in the bottom frame of your browser. Otherwise, the process is complete.
|
Add a Demo
To add a new demo, $DOIT "Add a Demo" text.
Adding a Demo
- Select the tree in which your demo is to be added. The directory that the demo lives in must be in the same directory as the other demo in that particular tree. For instance, to add a demo the "IRIX Demos" tree the new demo has to located in the directory /usr/demos/General_Demos.
- Now, click "Add Demo".
- The next page should contain the "Add Demo: Customize Demo Information" form, if not, see "Handling Add Demo Errors" below.
- For each field, enter or select the appropriate information.
- Press the "Update" button.
- The demo information page, for the demo you just added, appears and the HTML Demo Interface demo tables are updated.
- You will now be able to access the new demo from the Demo List to which you added it.
Handling Add Demo Errors
- If there are problems adding a demo, the HTML Demo Interface will prompt you to
make certain changes. For example, if the demo directory you specified does not
exist, you will receive an error asking you to re-enter the demo directory.
- In most cases, you will receive a page with a list of errors. Each error is
a link to a pop-up window describing the error and how to correct it. In a few
cases, the interface will ask if you want to use default images for your demo.
Using default images is a good idea, as it will save you from having to create the images. The images can always be edited later.
- When you have fixed the error(s), click on "Try Again".
- Repeat as necessary.
|
Add a Group of Demos
|
To add a group of demos, $DOIT "Add a Group of Demos" text.
Installing an SGI demo product like IRIX Demos, installs demos
into one directory. IRIX Demos uses /usr/demos/General_Demos. All of these demos
are available in the HTML Demo Interface via the IRIX Demos
demo list.
The "Add a Group of Demos" form allows anyone to create their own
demo list from their own group of demos. This prevents anyone from
having to add each demo to an existing demo list.
This mechanism is very useful for anyone who wants to ship a CD-ROM that
contains a group of demos. These demos can be run directly from the CD-ROM
and be available from the HTML Demo Interface.
Add a Group of Demos Functionality
- Adding a Group of Demos
- In the "Add Demo List" section of the form enter the directory path to the group of demos in the "Path" field. (eg. IRIX Demos uses /usr/demos/General_Demos here.)
- In the "Name" field, enter the name for the demo list that will automatically be created.
- Click on "Add List" to add the group and create the new demo list.
- Changing a Group's Demo List Name
- Find the demo list that you wish to change.
- In the text field, type in the new name.
- Click "Change Name" to complete the process.
- Viewing Demos in a Group
- Find the of the demo list in "Pick Demo List" section.
- Click on "View Demos".
- This will pop up a list of all demos loaded under that demo list.
- Deleting a Demo List Group
- Find the of the demo list in "Pick Demo List" section.
- Click on "Delete Tree".
- Click "OK" to complete the process.
- Note: Deleting a tree does not physically remove any files from your hard drive, the HTML Demo Interface simply will not "know about" those demos.
|
Managing Categories
To manage demo categories, $DOIT "Managing Categories" text.
|
Managing Categories Functionality
- Adding a Category
- Find the type of category you want to add (eg. Features, Industries, Hardware).
- Click on the "New" button.
- This will prompt you for the name of your new category.
- Type the name of the new category in the text field and then click "OK".
- Removing a Category
- Find the category you want to remove.
- Click on the "Remove" button.
- This will bring up a confirmation box.
- Click on "OK" and the category will be removed.
- Changing a Category Name
- Find the category you want to rename.
- Click on the "ChangeName" button.
- This will prompt you for the new name.
- Enter the new name into the text field and click on "OK".
|
Update Demo Tables
To update HTML Demo Interface demo tables, $DOIT "Update Demo Tables" text.
|
|
The HTML Demo Interface keeps track of all the demos loaded on your system
in a set of tables. Every time you change demo information or add a new demo, the
interface recreates these tables. If your interface seems to display incorrect
demo information, then you might want to use the "Update Demo Tables"
form to update the tables manually.
|
EOT
;
&Print_HTTP_Footer;
}