                             List All Users
                              Verison 1.01
                        Release date: 2009-05-13

                                  by

                             Eric Oulashin
                     Sysop of Digital Distortion BBS
                 BBS internet address: digdist.bbsindex.com
                     Email: eric.oulashin@gmail.com



This file describes the Digital Distortion user lister.

Contents
========
1. Introduction
2. Installation & Setup
3. Colors
4. Revision History

1. Introduction
===============
The Digital Distortion user lister is a JavaScript door application written for
Synchronet that lists the users on the BBS.  The output is nicely formatted with
colors that can be changed by the sysop, if desired, by editing the JavaScript
source file.

2. Installation & Setup
=======================
The Digital Distortion user lister is a JavaScript application contained in the file
DigitalDistortionListUsers.js.  No additional configuration is required; this is
designed as a drop-in replacement for Synchronet's default user list functionality.
The script file can be placed anywhere, but the recommended location would be
Synchronet's exec directory.

In a Baja script, you can include the following line to run the message lister:
   exec "?DigitalDistortionListUsers.js"
Running the script from JavaScript can be done in several ways; among them is the load()
function, as in the following:
   load("DigitalDistortionListUsers.js");
The script can also be set up as an external door in the Synchronet configuration program
(SCFG).  Simply use the following command:
   ?DigitalDistortionListUsers.js
The multi-user option should be set to Yes.

3. Colors
=========
In DigitalDistortionListUsers.js, there is an array declared near the beginning called
colors.  The colors array is indexed using strings that signify the text the color is
used for.  The values are Synchronet color codes.  The following
are the color array indexes and what they're used for:
Array index                          Use
------------                         ---
"veryTopHeader"                      The title text that appears above the user list
                                     ("User List")
"border"                             The table border lines
"colLabelText"                       The column labels
"userNum"                            User number
"userName"                           User name
"location"                           User's location
"lastCallDate"                       User's last call date
"connectionType"                     User's connection type
"numCalls"                           User's number of calls

4. Revision History
===================
Date         Description
----         -----------
2009-05-10   First public release
2009-05-11   No change; released alongside other scripts.