                           List Today's Callers
                               Version 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 today's callers lister.

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

1. Introduction
===============
The Digital Distortion today's callers lister is a JavaScript door application
written for Synchronet that lists the day's callers.  The output is nicely
formatted with colors that can be changed by the sysop, if desired, by editing
the JavaScript source file.

The caller list is read from the logon.lst file in Synchronet's data directory.
This file is written by Synchronet and displayed for Synchronet's built-in today's
callers list.  If for some reason this day's caller lister can't open logon.lst,
the caller lister will read through all user records looking for users who have
called today.  However, in the latter case, only one entry per user will be listed,
even if they have called more than once in the day, rather than listing all of
a user's callers that day, as is the case with logon.lst.

2. Installation & Setup
=======================
The Digital Distortion day's callers lister is a JavaScript application contained
in the file DigitalDistortionListTodaysCallers.js.  No additional configuration is
required; this is designed as a drop-in replacement for Synchronet's default
callers 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 "?DigitalDistortionListTodaysCallers.js"
Running the script from JavaScript can be done in several ways; one is the load()
function, as in the following:
   load("DigitalDistortionListTodaysCallers.js");
If you don't want the script to pause at the end (for example, if you run it in your
logon script), you can pass false as an argument using the load() function, as follows:
   load("DigitalDistortionListTodaysCallers.js", false);
(Note: Using load() this way is a way to pass arguments to a JavaScript source file, in
the argv array.  In DigitalDistortionListTodaysCallers.js, the false is recognized as
argv[0].)
The script can also be set up as an external door in the Synchronet configuration program
(SCFG).  Simply use the following command:
   ?DigitalDistortionListTodaysCallers.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

"timeOn"                             The time that the user logged on
"userName"                           User name
"location"                           User's location
"nodeNumber"                         The node that the user used
"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.