| BDAYSTAT v2.00 Documentation
|
| Telegard Birthday Statistics Generator
|
| Copyright 1991,1995 by Tim Strike and Forbidden Knights Systems.
| Released on October 15th, 1995.
____________
INTRODUCTION
____________
For use with Telegard 3.0. If used with any other versions of
TG, BDAYSTAT could cause unpredictable and unrepairable results.
BDAYSTAT was formerly TGBDAY. TGBDAY was a utility written
originally for Telegard 2.7 to output a full months worth of user
birthdays. Now four years later and a major upgrade in Telegard,
BDAYSTAT has been released more configurable then ever before.
BDAYSTAT works with the basis of templates; you design the
output colours and format that you want, and BDAYSTAT fills in the
neccessary MCI codes with the correct statistical information,
compiled directly from your user records.
_________________
PROGRAM OPERATION
_________________
BDAYSTAT <filename-of-USERS> <output> <template>
<filename-of-USERS> is the full path and filename to the users
file that you want compiled. This will for most normal setups be
the /data/USERS.DAT file.
<output> is the filename to output. This should be a .MSG file
since you should likely use Telegard colour codes, but this isn't
neccessary. You should include the output PATH as well.
<template> is the full path and filename to the template file.
Template files define the output that will be sent to <output> so
it is a good idea to configure these in the way that you want --
SEE SECTION TITLED TEMPLATE FILES.
Sample command lines might be:
BDAYSTAT \BBS\DATA\USERS.DAT \BBS\TEXT\LOGON2.MSG BDAYTODY.TPL
BDAYSTAT \BBS\DATA\USERS.DAT \BBS\TEXT\BULL10.MSG BDAYMTH.TPL
______________
TEMPLATE FILES
______________
Several sample template files have been provided with this version
of BDAYSTAT. These template files may be freely used (one mimics
closely the output of the old TGBDAY program).
BDAY.TPL Sample BDAY template, including all macro
listings and text lines.
BDAYMTH.TPL Birthdays for current month
BDAYNEXT.TPL Birthdays for next week
BDAYTODY.TPL Birthdays for today
BDAYTOMM.TPL Birthdays for tommorow
BDAYWEEK.TPL Birthdays for current week
Please review these template files before you attempt to create
your own template files. To create your own template files you
will need a text editor and an understanding of the MCI codes that
are used in the file, as well as the lines which are coded.
The template files support 10 output lines. These lines output
text in various ways dependant on the information that is being
processed at the time.
001 Header line #1 004 Birthday: Current Month
002 Header line #2 005 Birthday: Current Week
003 Header line #3 006 Birthday: Today
009 Footer line #1 007 Birthday: Tommorow
010 Footer line #2 008 Birthday: Next Week
The lines should be numbered, and followed by the text to use for
those lines. The lines support the following MCI codes:
~ELnn Left-justify next MCI code in field of nn characters.
~ERnn Right-justify next MCI code in field of nn characters.
~ECnn Center next MCI code in field of nn characters.
And the statistical MCI codes:
Starting Ending
~!M . . . . Month . . . . ~@M Today ~!D
~!W . . Current Week . . ~@W Tommorow ~!T
~!N . . . Next Week . . . ~!N Total listed ~&T
Current Month ~!L
All other text will be left as-is -- which means you can use
Telegard MCI codes in these template files as well. The output
file will have those MCI codes untranslated, so when Telegard
displays the bulletin, the MCI codes are translated properly.
This naturally also means that you can imbed colour codes without
question to spice up your bulletin in whatever fashion.
________
VERSIONS
________
This section will always contain the history/update information
on this program. It will list a general summary of bug fixes and new
features. Please read this section on every upgrade, even if you
don't plan on reading any other section.
+:New Feature *:Updated (Fixed) Feature
Prior to v2.00
+ Written in Turbo Pascal 6.0 for TELEGARD 2.7
v2.00
+ Written in Turbo Pascal 7.0 for TELEGARD 3.0
+ Added template configuration removing need for all other
switches and adding the ability to change the output
colour and formats.
__________
LEGALITIES
__________
WARRANTY
BDAYSTAT is provided as-is without a warranty of any kind,
either express or impled. This program is guarenteed to occupy
disk space and nothing more. Under no circumstances shall the
author or anyone related to the production of this utility be
liable to you or anyone else for any damages, including (but not
limited to) any lost profits, lost savings or other incidental
or consequential damages arising out of the use or misuse of
this program. Usage of this program is an understanding of said
statement.
In other words -- RUN THIS PROGRAM AT YOUR OWN RISK. By
choosing to use this program you are taking all responsibility
for anything that occurs with its usage.
COPYRIGHT
The program, and all documents and files included in the
original BDAYSTAT release package are copyrighted to Tim Strike
and Forbidden Knights Systems. The included files may not be
modified in any manner.
The original archive may be freely distributed WITHOUT
charge. The format of the original archive can be changed to
another archiving product. At no point in the archives
distribution may files be added or removed.
BDAYSTAT may be packaged on a distribution diskette or in a
compilation archive, but under no circumstances may any charge
be incurred beyond the physical cost of the hardware (disks,
CD...) or trasfer medium (phone, mail...).
CREDITS
All brand and product names referenced in this document are
trademarks, registered trademarks, or copyrighted works of
their respective holders.
_____________________
CONTACTING THE AUTHOR
_____________________
I can be contacted in a number of different methods. When
sending netmail or posting in one of the conferences, direct mail
to "Tim Strike". Replies will be forthcoming as soon as I can get
to them.
NETMAIL:
Telenet Canada Fidonet ITCnet
20:22/101 1:259/423 85:896/908
INTERNET:
ts@gryn.org
ECHOMAIL CONFERENCES:
TELEGARD Telegard Support (ITCNET)
TNC_FKNIGHTS Forbidden Knights Support (TNC)
TNC_TG Telegard Support (TNC)
TG_SUPPORT Telegard Support (FIDONET)
POSTAL MAIL:
Forbidden Knights Systems
Attn: Tim Strike
3360 Council Rind Rd, Unit 11
Mississauga, ON
L5L 2E4
BULLETIN BOARD:
Forbidden Knights Systems
(905)820-7273
2400-16,800 HST/v.32bis
Access denied between 4:00am and 5:00am
Restricted access between 10:00pm and 11:00pm
Any changes or upgrades that need to be made to BDAYSTAT v2.00
will be made as time permits. Further suggestions, comments and/or
bug reports can be directed through one of the above methods.
Enjoy fully.