
Stargate Globals v0.b {beta}

c 1996 Stargate Computer Technologies


Note: This document has been converted to text from a MS-WORD 6.0 
document.  Some of the formatting has been lost in the conversion.  The 
registered version comes with a printed manual.

Contents:
Introduction .....................	1.0
  Distribution Information ................	1.1
  Legal Disclaimer ...................	1.2
  Overview ......................	1.3
Installation ......................	2.0
Configuration of Globals ..................	3.0
  Global Command Properties ................	3.1
  Creating a Global ...................	3.2
  Editing a Global .....................	3.3
  Deleting a Global ...................	3.4
  Global Command Reference ................	3.5
  Using with Stargate Registries ..............	3.6
Technical Support ...................	4.0	


Section 1.0 - INTRODUCTION:

 Stargate Globals allows Wildcat Systems to offer callers a fast and easy 
method to page other callers, toggle ANSI color and help levels, check for 
mail and a lot more.  The advantage of  Stargate Globals is the ability for 
users to use these functions from anywhere on the system.  The caller can be 
at any command prompt and execute a global.  Because Stargate Globals 
will run any defined wcCODE application, the addition of Stargate Globals 
can add a great deal of power to the sysop.  Below are some of the features 
of Stargate Globals:

  Written in wcCODE for 100% Wildcat 5 compatibility
  100% Custimizable via On-Line Configuration
  Simple commands, make it a snap for users
  Will run any wcCODE application
  Super Fast Database Support
  Internal paging command that does not require a full name or node 
number 


Section 1.1 - DISTRIBUTION INFORMATION:
         
   The following files should have been included in the SGGLB0B.ZIP 
   file:

	README.1ST 	Last Minute Release Information
     	CMDLINE.WCX 	Replacement CMDLINE Library
	SGGLBDOC.TXT	Sysop Manual in MS-DOS ASCII Format
	GLOBALS.DAT	Database Record for Globals
	GLOBALS.WCX	Application called by CMDLINE to process 
				globals.
	SGGLOBAL.BBS	List of Global Command displayed by ";?"


Section 1.2 - LEGAL DISCLAIMER:
 
THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF 
ANY KIND,   EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT 
NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
MERCHANTABILITY, OR FITNESS FOR A PARTICULAR   
PURPOSE.  STARTGATE COMPUTER TECHNOLOGIES DOES NOT 
WARRANT THAT THE FUNCTIONS CONTAINED IN THIS 
SOFTWARE WILL MEET YOUR REQUIREMENTS OR THAT THE 
OPERATION OF THIS SOFTWARE WILL BE UNINTERRUPTED OR 
ERROR-FREE.  THE ENTIRE RISK AS TO THE QUALITY AND 
PERFORMANCE OF THE SOFTWARE IS WITH THE USER.  

IN NO EVENT WILL STARGATE COMPUTER TECHNOLOGIES BE 
LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY LOST 
PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR 
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR   
INABILITY TO USE THE SOFTWARE EVEN IF A STARGATE 
COMPUTER TECHNOLOGIES REPRESENTATIVE HAS BEEN 
ADVISED OF THE POSSIBILITY OF SUCH DAMAGES, OR FOR ANY 
CLAIM BY ANY OTHER PARTY.

BY INSTALLING OR USING THIS SOFTWARE, YOU 
ACKNOWLEDGE THAT YOU HAVE READ THIS AGREEMENT, 
UNDERSTAND IT, AND AGREE TO BE BOUND BY ITS TERMS AND 
CONDITIONS.  YOU FURTHER AGREE THAT IT IS THE COMPLETE 
AND EXCLUSIVE STATEMENT OF THE AGREEMENT BETWEEN 
US, WHICH SUPERSEDES ANY PROPOSAL OR PRIOR 
AGREEMENT, ORAL OR WRITTEN, AND ANY OTHER  
COMMUNICATIONS BETWEEN US RELATING TO THE SUBJECT 
MATTER OF THIS AGREEMENT.

REGISTERED LICENSE HOLDERS OF SGREG MAY NOT 
TRANSFER THE LICENSE TO ANOTHER PARTY WITHOUT 
OBTAINING A NEW SERIAL NUMBER FROM STARGATE   
COMPUTER TECHNOLOGIES.


Section 1.3 - OVERVIEW:

The sysop can define up to 40 global commands which the user can execute 
(provided he/she has access to that global) from any command prompt on 
the system.  Once the global command is executed, program controll is 
passed back to the calling function.  So, if a user is reading the bulletins and 
typed ";who" to see who is online, the user would be displayed the online 
callers list, and then returned to the bulletins.  If a user enters ";?" or ";" then 
he/she will be displayed the SGGLOBAL.BBS file.  This file should contain 
a complete list of the globals, and a syntax on how to use each global.

NOTE:  "any command prompt on the system" is defined as any command 
prompt that resides in a wcCODE program that uses the input libraries 
provided with Wildcat.  Thus, if a user is in a door program, such as 
TradeWars, he will not be able to execute a global command.  Also, any 
wcCODE applications that do not call the input routines in the CMDLINE 
library will not recognize global commands.   If you have a third-party 
wcCODE application that does not recognize global commands, please e-
mail us the author's name, e-mail address and product name.  We will 
contact the author and provide him with the information needed to make his 
application recognize global commands.


Section 2.0 - INSTALLATION:

Before any installation, we recommend that you make a backup of your 
Wildcat 5 system.

Unzip the contents of SGGLB0B.ZIP into your Wildcat 5 directory (where 
your wcCODE applications reside.  On our system, this is "C:\WC5".  If you 
are prompted to overwrite your CMDLINE.WCX file, answer "yes" (We 
have made a slight adjustemt to this file, however, it will NOT alter the 
functionality of any other programs.)

Logon to your system and type ";sysop" at any command prompt and the 
globals package will self-install.


Section 3.0 - CONFIGURING STARGATE GLOBALS:

All users that have access to the "Sysop User Editor" will also have access 
to the ";sysop" global.  The ";sysop" global is the only global that can not be 
re-defined by the sysop.  Calling ";sysop" will run the Configuration program 
which allows you to create, edit and delete global commands.  Up to 40 
global commands can be defined and they are stored in the GLOBALS.DAT 
file which resides in your WC5:\DATA directory.  The 40 global commands 
can be defined in any order.  In the sample configuration provided, we have 
grouped the global commands as follows:

Globals 1-10:		wcCODE applications
Globals 11-20:	 	Toggle commands
Globals 21-30:		Internal applications (such as user page)
Globals 31-40:		blank


Section 3.1 - GLOBAL COMMAND PROPERTIES:

Each global command has the following properties:

NAME
	This is the name of the global, not including the global command 
identifier (";").  For example, if a user enters ";who" to see who is online, the 
name property for this global would be "who".

COMMAND NUMBER
	The command number tells Stargate Globals what to do.  A list of 
these commands and their functions is listed in the next section

ARGUMENT SET 1 and 2
	This is a set of parameters that will be passed to the global command 
when the command is executed.  Certain COMMAND NUMBERS have set 
rules for arguments (see below).
NOTE: Any arguments entered by the user will also be passed to the global 
command automatically.  For example, if a user entered ";p mike Hey there!" 
then the argument "mike Hey there!" would be passed to the global 
command.

ACCESS ATTRIBUTES
	This property allows you to define up to 5 security profiles which 
will NOT be able to access the global. 


Section 3.2 - CREATING A GLOBAL:

In this example we will create a global named "doors" that will enable the 
user to type ";doors" and be presented with the Door Menu.

1)  Enter ";sysop" at any command prompt
2)  Enter "1" for Edit Global Commands
3)  Enter a number of an un-defined global
4)  Enter "doors" as the name of the global.  Do not include the ";" 
character.
5)  Enter "100" as the Global Command Number (see the Global Command 
List for a reference of command numbers)
6)  Enter "Door menu" for Argument Set 1
7)  Press "Enter" to skip the Argument Set 2
8)  Now you can toggle up to 5 security profiles to exclude from access to 
the "doors" global.  When you are finished press "Enter"
9)  Enter "Y"es to save changes 
10)  Edit your SGGLOBAL.BBS file to reflect the changes


Section 3.3 - EDITING A GLOBAL:

To edit a global, follow the same steps as creating a global.  The only 
difference between editing a global and creating a global is step #3.  If you 
want to edit a global, select a global number that is already defined.


Section 3.4 - DELETING A GLOBAL:

To delete a global, select the global just as if you were going to edit it.  Then 
erase the global's name by pressing the delete key.  Then save your changes.  
If a global does not have a name, it will not be recognized.


Section 3.5 - GLOBAL COMMAND REFERENCE:

Command Code: 100
Description: Run a wcCODE application
Argument Set 1: The name of the wcCODE application
Argument Set 2: Any parameters to pass to the application
Notes: Any wcCODE application can be run.  If it is not in the default 
wcCODE directory, then include the path to the application

Command Code: 101
Description: Run a wcCODE application 
Argument Set 1: The name of the wcCODE application
Argument Set 2: <none>
Notes: This command is similar to Command Code 100, except it passes 
the arguments entered by the user to the wcCODE application.

Command Code: 102
Description: Display a file
Argument Set 1: The name of the file to be displayed
Argument Set 2: <none>
Notes: The file must be located in your display directory.  Do not 
include the file extension, just the file name.  For example, to display 
the file "SGGLOBAL.BBS" enter "SGGLOBAL".


Command Code: 200
Description: Toggle Page Available
Argument Set 1: <none>
Argument Set 2: <none>

Command Code: 201
Description: Toggle ANSI Color
Argument Set 1: <none>
Argument Set 2: <none>

Command Code: 202
Description: Toggle Help Level
Argument Set 1: <none>
Argument Set 2: <none>

Command Code: 300
Description: Page a User
Argument Set 1: <none>
Argument Set 2: <none>
Notes: This command expects arguments from the user in the form of 
<user to be paged> <message>.  The user name does not have to be 
complete.  For example, to page Mike Smooth the user could enter ";p 
mi Hey, are these globals great or what?"

Command Code: 301
Description: Instant Log-Off
Argument Set 1: <none>
Argument Set 2: <none>


Section 3.6 - USING WITH STARGATE REGISTRIES

Stargate Registries is a powerful user profile program.  The sysop can define 
up to 20 fields that can contain input from the user, or file attachments.  
When used with global commands, users can look up other users profiles 
while in chat, or just after viewing who is online.  For sysop familiar with 
multi-line systems, this is a great benefit that spawns new life into user 
interactivity.  Stargate Registries v1.1 and higher support command line 
options that allow it to seamlessly integrate with Stargate Globals.  The 
following is a sample global property list for Stargate Registries:

Name: reg
Command Code: 101
Argument Set 1: sgreg
Argument Set 2: <leave blank>

You should then add the following line to your sgGLOBAL.BBS file: 
";reg <user> .... View a users registry"

Note:  Command Code 101 will take input entered by the user and pass it to 
the wcCODE application.  Thus, if a user entered ";reg mike" that argumant 
"mike" would be passed to Stargate Registries.  Like the user page 
command, the user does not have to enter the entire user's name.  


Section 4.0 - TECHNICAL SUPPORT:

Technical support via e-mail is free of charge for both registered and non-
registered customers.  E-Mail is responded to as soon as possible, on a first 
come, first serve basis.  Voice technical support can be purchased in 5 hour 
blocks.  Voice support is valid for all Stargate products and services.  A 5 
hour block of support time is $40.00, a 10 hour block is $60.00

To receive technical support, call or e-mail:

 
STARGATE Computer Technologies
6419 S. Montgomery
Tacoma, WA 98409
phone: 206.208.6338
e-mail: troy.kruthoff@mustang.com
(BBS number and new e-mail address to be announced)


 

