Beijing Paradise BBS Backup

home *** CD-ROM | disk | FTP | other *** search

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / CLASFY19.ZIP / CLASSIFY.DOC < prev next >

Wrap

Text File | 1992-12-27 | 26.1 KB | 594 lines

CLASSIFIED ADS v1.9 by Al Lawrence Sunrise-80 BBS (404) 256-9525 FIDO 1:133/410 OVERVIEW ________ The CLASSIFIED Ads Door allows your callers to post classified ads in up to 34 different categories. The categories are defined by you, the Sysop, along with the number of days you want the ads to be active. A maintenance program, that runs at night in your event, will handle the purging automatically. Note: There is no limitation to the number of classified ads you can have in the database, provided you are running a registered version. * Unregistered version allows for 20 ads. * Unregistered version allows for 15 messages. NOTE: Most errors will be logged to a file called DFRAME.ERR which is created in the directory you run the door from. INSTALLATION ____________ Installation is fairly easy and straight-forward. The following steps and examples should have you up and running in a very short period of time. It is assumed that you are familiar with setting up DOORS on your system. To this end, only examples of the configuration file and Door batch file are described. 1) Create a directory to hold all CLASSIFY files 2) Unzip CLASFYxx.ZIP into the the above directory NOTE: BRUN45.EXE is not included but is required !!! 3) Create a configuration file, with a name of your choice, or modify the supplied CLASSIFY.CFG file. You can do this manually with an editor of your choice OR you can use the supplied setup program, called CLSETUP. To use CLSETUP, type CLSETUP and supply the configuration file name. You will be show the default configuration file if one of that name does not already exist. If it finds the configuration file it will load it and allow you to edit it. Description of the Configuration file follows: ** Location of system file (See Below) SUNRISE-80 BBS Your BBS Name Al Sysop's First name Lawrence Sysop's Last Name |-----------------------------------------------------------------------------| | READ! 1 CommPort \ These 2 lines are required | | READ! 1 Node # / ONLY for GTUSER.BBS | |-----------------------------------------------------------------------------| 00000000 Registration Number # 2 Keyboard timeout value in Minutes # NONE Drive:\Path\Filename to contain the Bulletin summarizing all classified ads in the database. Y Y=Display the Originating BBS Name N=Do Not Display the Originating BBS Name N Y = Use European Date Format (DDMMYY) N = Use Regular Date Format (MMDDYY) 0 Minimum Logon Security Level required to enter a new AD option. Zero(0) will allow access to everyone. 0 Minimum Logon Security Level required to access the DELETE option. Zero(0) will allow access to everyone. 0 Minimum Logon Security Level required to access the MODIFY option. Zero(0) will allow access to everyone. 0 Minimum Logon Security Level required to access the MESSAGES option. Zero(0) will allow access to everyone. 00000000 Ads Exchange Program Registration Number CLASSIFY Name of the EXPORT file that is generated by the CLEXCH program. We suggest that it be a unique name. DO NOT include an extension! WELCOME Name of the WELCOME file. If you wish, this filename CAN contain an extension. GOODBYE Name of the GOODBYE file. If you wish, this filename CAN contain an extension. Y Y=OK to use PKZIP for Compression, N=No N Y=OK to use ARJ for Compression, N=No ** = Replace with ONE of the following: C:\BBS\PCBOARD.SYS <- For PCBoard systems using PCBOARD.SYS only C:\BBS\CALLINFO.BBS <- For Wildcat! systems (prior to v3.0) C:\BBS\USERINFO.DAT <- For Wildcat! systems using v3.x (Note:DOOR.SYS must be in SAME directory) C:\BBS\DOOR.SYS <- For ANY systems that support DOOR.SYS C:\BBS\DORINFOx.DEF <- For ANY systems that support DORINFOx.DEF C:\BBS\SFDOORS.DAT <- For Spitfire systems. C:\BBS\CHAIN.TXT <- For WWIV systems C:\BBS\GTUSER.BBS <- For GT Power * if using this option you must put the ComPort # on line 5 and the Node # on line 6 of the configuration file # = Requires registration to change to a different value. NOTE: There are NO Blank Lines in the Config File!! 4) Create a batch file or modify the CLASSIFY file supplied. A description of this file follows: ECHO off cd\BBS\DOORS\CLASSIFY Location of CLASSIFY files CLASSIFY CLASSIFY.CFG EXE filename and CFG filename (Name used in creating file in #3 above) CD\BBS BOARD 5) When running in more than one node, read MULTI-NODE SETUP below RESTRICTIONS! ------------- UnRegistered versions of CLASSIFY limit the number of messages in the database to 15 and the number of ads to 20. The Ads Download function only valid in registered versions. DOWNLOADING ADS ---------------- Classified Ads only supports Zmodem protocol when downloading ads. The Ads will be compressed with PKZIP and/or ARJ. You must choose compression method you support, in the Config file. READING DOWNLOADED ADS OFFLINE ------------------------------ CLREADER is a simple offline Ads reader. You must first unzip/unarj the downloaded file and place the name of the unzipped file on the command line that executes the CLREADER program. For Example: CLREADER ADS* * = node number you were logged onto when you downloaded the file. You should make the reader available to your callers as it will encourage the users to download the ads and read them offline. There is a separate file enclosed within the main CLASFYxx.ZIP file called CLREADxx.ZIP. This file contains CLREADER.EXE, CLREADER.DOC and FILE_ID.DIZ, making it ready for you to place on your BBS for your users to download! CATEGORY FILE (Classify.CAT) ---------------------------- Be sure to give a lot of thought to your choice of categories, since the category position in this file is carried in each Ad record. This means, if you set up the categories so that #2 was 'Want Ads - General' and the caller entered an Ad under that category, the Ad would carry category #2 as the category number. If you then decide that you want to change the 'Want Ad - General' category to say, 'Announcements', then the Ads carrying #2 in their record would be classified incorrectly. The format of the Classify.Cat file follows: UUUUUUUU,VV,W,X,Y,Z Where u = Category name. Max length: 25 characters(NO COMMAS) v = Number of days to remain active. Min:1 Max 365 w = Should the program ask for COST ($$$) info. You would answer Y for a For Sale type category and an N for a WANT AD or Announcment type category. x = Category security level. If caller's logon security level is less than this security level, they will not be able to enter or view an ad in this category. A category security level of 0 allows anyone access. y = Allow Ads to be downloaded from this conference. Y=yes, N=no z = 'Pay' Category. P = Pay F = Free NOTE: Maximum number of entries is 340 WELCOME and GOODBYE Files ------------------------- The following applies to registered versions of CLASSIFY ONLY! You can define the name of the WELCOME file in the configuration file. If the program finds that filename, it will display that file after the opening screen and before the main menu screens. The file must reside in the same directory as CLASSIFY.EXE You can define the name of the GOODBYE file in the configuration file. If the program finds that filename, it will display that file when the caller exits the program. It will display prior to displaying the file called ADOPT.SYS (if you have created it). The file must reside in the same directory as CLASSIFY.EXE "PAY-TO-ADVERTISE" Option ________________________ Classified Ads can be used to charge for the placement of an advertisement and/or allow for the ads to be placed free of charge. You decide which on a category-by-category basis. You make a category a 'pay' category by changing the appropriate entry in the Classify.Cat file from an "F" to a "P". You have the option to create an ASCII file that will be displayed to the caller, everytime they choose a particular 'pay' category in which to enter an ad. This file can contain any pertenant information such as the method of payment, information required, etc. If you want the same file to be used for ALL 'pay' categories, then you must name the file "PAY" (no quotes). If you want to display a unique file for each or some categories then you must name the file "PAYx", where x is the category number. If the program does not find a 'PAYx" for a particular 'pay' category, it will then search for a "PAY" file. If neither is found it will not display anything. We strongly suggest that you create a file for display for all 'pay' categories so as to ensure that the callers understand what they are getting into. Any ads entered into a 'PAY' category, will remain INVISIBLE to everyone until payment is received and the Sysop makes that ad VISIBLE, via the maintenance program (CLPAYMNT.EXE). Ads remain active for the length of time called for, for that category as defined in the CLASSIFY.CAT file. The CLPAYMNT.EXE maintenance program will display EVERY ad in the database that is flagged as INVISIBLE. You will have the choice of BYPASSING it, DELETING it or making it VISIBLE. Once an ad is deleted or made VISIBLE, it can not be reversed... so BE CAREFUL! AUTOMATED PURGING ----------------- When you set up the categories to be used in your version of CLASSIFIEDS, you are asked to define the number of days the ad should remain active. By running the CLPURGE program in your nightly event process you will ensure that the ads are deleted, automatically. In addition CLPURGE will pack the Message Database and delete all messages that have been read. The following is all that is required to execute the purge: CLPURGE CLASSIFY.CFG ^^^^^^^^^^^^ | |------ or whatever you call the CFG file Note: This is only available in registered versions! DATABASE EXCHANGE _________________ ** A GREAT WAY TO SHARE THE CLASSIFIED ADS DATABASE BETWEEN 2 OR MORE BBS' ** ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The optional Classified Ads Database Exchange feature will allow you to participate in the exchange of Classified Ads databases with other BBS' (Any number of BBS' can participate). The exchange program is named CLEXCH and comes included in the CLASFYxx.ZIP file. CLEXCH performs two (3) major functions: (1) EXPORT: Extracts all active ads from the Classified Ads database. It creates a file named XXXXXXXX.EXP (filename is defined in the CFG file) and will bypass any ad already flagged for deletion. (2) IMPORT: Imports the XXXXXXXX.EXP (filename is defined in the CFG file) created by the EXPORT option and merges all ads into the Classified Ads database. It will not import any ads that duplicates ads found in the existing database. Note that this option will IMPORT ALL files with an extension of EXP, during a single execution of the program. (3) IMPEXP: This option will first IMPORT (as in (2) above) then turn around and EXPORT (as in (1) above) during one execcution of the program. All BBS' involved in the exchange MUST run registered versions of BOTH Classified Ads and Classified Exchange (CLEXCH). CLEXCH will only work with version 1.4 of CLASSIFY or later! It is critical that ALL participants in the exchange use the SAME Category file. Failure to do so will result in ads meant for a certain category on one system, showing up in a category totally unrelated on another system. To run the Exchange you do the following: EXPORT: a) Change to the directory containing your CLASSIFY.DAT file b) Issue this command: CLEXCH EXPORT CLASSIFY.CFG If you use a different name for your Config file, then substitute that name for CLASSIFY.CFG c) Send (transmit) the XXXXXXXX.EXP file to those invoved in the exchange or to the HUB. d) Delete XXXXXXXX.EXP IMPORT: a) Change to the directory containing your CLASSIFY.DAT file b) Copy the XXXXXXXX.EXP file that was sent to you by the BBS you are exchanging with, to the directory used in item (a) above. c) Issue the command: CLEXCH IMPORT CLASSIFY.CFG If you use a different name for your Config file, then substitute that name for CLASSIFY.CFG d) Delete XXXXXXXX.EXP IMPEXP: a) Change to the directory containing your CLASSIFY.DAT file b) Copy the XXXXXXXX.EXP file that was sent to you by the BBS you are exchanging with, to the directory used in a) c) Issue the command: CLEXCH IMPEXP CLASSIFY.CFG If you use a different name for your Config file, then substitute that name for CLASSIFY.CFG d) Send (transmit) the XXXXXXXX.EXP file to those invoved in the exchange or to the HUB. NOTE: When registering CLEXCH, you MUST use the EXACT SAME Sysop Name AND BBS NAME as used for CLASSIFIED ADS!!!!!!!!!!!!!!!!!!!!!!!!! NOTE: All IMPORT and EXPORT transactions are now recorded in a file called CLEXCH.LOG. If the file exists it will append the information, if not it will create the file and add the information. Thus you are free to delete it at any time. NOTE: HOW TO SETUP AS A HUB AND DO CLASSIFIED ADS EXCHANGES ----------------------------------------------------- Below, is a fully working batch file complete with comments, for the group hub. There are a few very important things to remember in running the Classified Ads as a hub. FIRST, make sure all your nodes have the same categories or mass confusion will result. SECOND, it is highly advisable that you and your nodes use a unique name (representative of your board) instead of the generic "Classify.exp", for example Sun.exp would be the name for Sunrise BBS. THIRD, this batch file (Exchange.bat) is best run during your event each night, rather than each time the door is executed, especially if you are connected to boards that are long distance. The commands for your nightly event batch file would be: CD\CLASSIFY CLPURGE CLASSIFY.CFG CALL EXCHANGE.BAT DEL CLASSIFY.EXP CD\ Exchange.bat would be located in your classified directory and would be the batch file listed below. You may feel free to remove the comments and use the batch file below after modification for your system drive/path/name specifications. _______________________________________________________________________________ BATCH FILE EXAMPLE FOR THE HUB USING THE CLASSIFIED ADS EXCHANGE PROGRAM @echo off del I:\db\files\classify.exp ^ ^^ ^^^^^ Comment: Above would be the drive/path to your inbound/outbound files directory. This command will delete your previous night's export. NOTE: DO NOT use this command the first night you start the import/export with other boards. cd\db\files copy *.exp I:\ra\doors\classify ^^^^^ del *.exp ^^^^^ Comment: Copy all exported files sent to you into your classified directory, then delete all the exported files. FAILURE to use a unique .exp name will result in files over writing and only the last .exp file copied will be imported into your database. cd\ra\doors\classify clexch IMPEXP classify.cfg ^^^^^^^^^^^^ copy classify.exp i:\db\files ^^^^^^^^^^^^ ^^ ^^^^^ Comment: Perform the import/export (IMPEXP) then copy the resulting export file from your classify directory to your outbound files directory. cd\db dbutil i send 1:114/203 i:\db\files\classify.exp ^^^^^^ Comment: Send the export file to the other boards. Note above that the command used is for D'Bridge...you may substitute the proper command and outbound files directory for your front end mailer. You will need to do an export for every BBS connected to you. __________________________________________________________ | This example provided to you courtesy of: Window In Time | | 1:114/203 | | 602-253-1946 | | | | Feel free to contact the Sysop of Window In Time!!!! | |__________________________________________________________| NON-STANDARD COM SUPPORT ________________________ Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ number after the configuration filename. Let's assume your Door is called FOOBAR and you want to use COM1 and IRQ5. The command line passed to your Door would be: FOOBAR FOOBAR.CFG /5 The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is normally used with COM1. No /x parameter is needed for the standard IRQ's. As an alternative, you may use an environmental variable on the command line. To use the variable (following the example above), place a SET IRQ=5 in the batch file used to bring up your BBS (you would need a different IRQ number for each node). The command line would now look like this: FOOBAR FOOBAR.CFG /%IRQ% This, in combination with the use of the environmental variables described in the MULTI-NODE SETUP section will allow you to use one batch file and one config file to run this door on all nodes. MULTI-NODE SETUP ________________ All Sunrise Doors are Multi-Node capable. Each node must have the ability to access a configuration file which will have its own system file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first line. There are 2 ways to accomplish this: (1) Create a separate configuration file for each node. The only difference between each file would be the location of the system file for that particular node. For example, on my system there are 2 nodes and the first line of the config files would look like this: NODE1: H:\PCB1\DOOR.SYS NODE2: H:\PCB2\DOOR.SYS Thus, if you have a 4 node BBS, you will need 4 configuration files. (2) Use ONE configuration file for ALL nodes. This Door will recognize the following PCBoard environmental variables: PCBDIR (Directory containing the System file) PCBDRIVE (Drive containing the System file) Thus, the first line of the SINGLE configuration file, for this Door would look like this: %PCBDRIVE%%PCBDIR%\DOOR.SYS NOTE: This option, as described, assumes that you are running PCBoard 14.5a software. The environmental variables are automatically created by the software for each node. HOWEVER, if you are running other BBS software you should be able to set the variables EXACTLY as described below, for EACH node (more than likely in each batch file you use to bring up EACH node): PCBDRIVE=C: ^^^^^^^^^ PCBDIR=\NODE2 ^^^^^^^^ Info with a carat (^) under it, MUST be typed as is. The rest depends on your naming conventions. This, in combination with the use of the optional environmental variable described in the NON-STANDARD COM SUPPORT section, will allow you to use one batch file and one config file to run this door on all nodes. LEGALITIES __________ THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY. DISTRIBUTION ____________ You may make this file available for downloading from your BBS or you may upload it to any BBS of your choice, provided that you do not make any changes to the contents of the archive (ZIP file). The archive and its individual contents may not be used by any service that charges any money whatsoever, without the written permission of the author. REGISTRATION ____________ Registration and the subsequent insertion of the registration number into your configuation file, allows for the display of your BBS name on the opening and closing screen as well as the reduction of a delay built into the opening screen display along with the ability to change certain values in the configuration file. To register your copy of CLASSIFY, please fill out the registration form (REGISTER.FRM) and mail it along with the registration fee to the name and address on the form. Be sure to use the proper upper/lower case when filling in your name and BBS name, as they MUST match the way you entered them in the configuration file. ^^^^ Based upon information supplied on the registration form, I will pre- register you on my BBS. You will then be able to call SUNRISE-80 and pick up your registration number. MISC ____ The latest version of CLASSIFIED ADS and other fine SUNRISE DOOR programs are always available for download from SUNRISE-80 BBS. Remember, should you have any problems, questions or suggestions, be sure to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, PCBHints, SYSops) or on SMARTNET (SN_Sysops) or FIDO 1:133/410.