home *** CD-ROM | disk | FTP | other *** search
/ CD Shareware Magazine 1997 January / CD_shareware_1-97.iso / DOS / COMUNICA / WC5PRO12.ZIP / PROFILE.DOC < prev    next >
Encoding:
Text File  |  1996-07-01  |  14.0 KB  |  355 lines
  1.  
  2.                               User PROFILES
  3.  
  4.                        (32-Bit WildCat! 5 Version)
  5.                                   
  6.                                   v1.2
  7.                                   
  8.                                    by
  9.  
  10.                               Al Lawrence
  11.  
  12.                             Sunrise-80  BBS
  13.                  (404) 256-9525 (USR v.everything 33.6)
  14.                  (404) 705-9104 (USR v.everything 33.6)
  15.                  (404) 256-9518 (Voice 9am-9:30pm EST)
  16.                     (EMAIL) al_lawre@ix.netcom.com
  17.  
  18.  
  19.                                 OVERVIEW
  20.                                 ________
  21.  
  22.  
  23. This Door can be used to capture information about a user, for other users to 
  24. review. The Sysop has complete control over the questions to ask, and the way 
  25. the anwers will be displayed.
  26.  
  27.  
  28.  
  29.                 NON-REGISTERED   R E S T R I C T I O N S
  30.                 ----------------------------------------
  31.  
  32.                 ° Maximum number of database entries is 10
  33.                 ° Door time limit disabled
  34.                 ° Allow Player to Send and Read Messages from the 
  35.                   Door Message Center
  36.                 ° CHAT option is disabled
  37.                 ° PROFEVNT (Database Purge) must be registered
  38.  
  39.                  
  40.                 
  41.                 
  42.  
  43.  
  44.                               INSTALLATION
  45.                               ____________
  46.  
  47.  
  48.  
  49.       1) Create a directory to hold all PROFILE files.
  50.  
  51.       2) Unzip wc5PROxx.ZIP into the the above directory
  52.  
  53.       3> MOVE the PROFILE.WCX file to your WC5 directory and delete it from
  54.          the directory created in step <1>
  55.  
  56.       4) Modify the supplied PROFILE.CFG file. A description follows:
  57.  
  58.             SUNRISE-80 BBS           Your BBS Name
  59.             
  60.             Al Lawrence              Sysop's First AND Last name
  61.  
  62.             00000000                 Registration Number
  63.         
  64.         #   0                        Time Allowed in Door per day. 
  65.                                      (0 = BBS Time remaining)
  66.         
  67.             Y                        Y = Log all callers to USAGEx
  68.                                      N = Do not log callers
  69.         
  70.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  71.                                      2 = Display ADOPT-A-DOOR message
  72.  
  73.         #   c:\wc5\profile           Drive:\Path\ to PICTURE directory
  74.            
  75.         #   Y                         Y = Allow player to send PRIVATE messages
  76.                                           from the Door Message Center
  77.                                       N = Do NOT allow PRIVATE messages
  78.  
  79.         #   0                         Place PRIVATE messages in this BBS Conf #
  80.  
  81.         #   Y                         Y = Allow player to send PUBLIC messages 
  82.                                           addressed to ALL from Message Center
  83.                                       N = Do NOT allow PUBLIC messages
  84.  
  85.         #   1                         Place PUBLIC messages in this BBS conf. #
  86.             
  87.         #   Y                         Y = Allow Player to Check for Mail from
  88.                                           the Door Message Center
  89.                                       N = Do NOT allow Check for Mail
  90.  
  91.         #   Y                         Y = Allow caller to send EMAIL messages    
  92.                                           to Al Lawrence. 
  93.                                       N = DO NOT allow EMAIL to Al Lawrence
  94.  
  95.         #   al_lawre@ix.netcom.com    Al Lawrence's EMAIL address
  96.  
  97.  
  98.            # = Requires registration to change to a different value.
  99.  
  100.                NOTE: There are NO Blank Lines in the Config File!!
  101.  
  102.  
  103.       4) Create a menu entry to run the wcCODE Door and you MUST pass the 
  104.          FULL drive:\path of the PROFILE directory as a command line 
  105.          parameter when defining the Door on the menu. An example follows:
  106.             
  107.             
  108.             Program Name: PROFILE
  109.             Parameter   : c:\wc5\doors\profile
  110.             
  111.             
  112.  
  113.           Running a SUNRISE 32-BIT DOOR From An HTML Screen
  114.           -------------------------------------------------
  115.  
  116. Enclosed in this archive you will find  PROFHTML.WCX.  This program will 
  117. enable you to run the PROFILE from your HTML screens.
  118.  
  119. There is one "catch" though to using the supplied program. When we created the 
  120. program we had to make ONE assumption, that being that you have your Door 
  121. directories set up EXACTLY as defined below. If you have a different naming 
  122. convention AND you have wcCODE, you can create your own "personalized" .WCX 
  123. file(s) using the following template of code:
  124.  
  125. RUN "name of door .wcx","path to door directory" 
  126. END
  127.  
  128. Using PROFILE as an example, your PROFHTML.WCC file would read as follows:
  129.  
  130. RUN "PROFILE","c:\wc5\doors\PROFILE"
  131. END
  132.  
  133. Now compile the program and create an 'HREF" statement. An example of an 
  134. "HREF" statement follows:
  135.  
  136. <A HREF="Client?term&PROFHTML"><B>PROFILE</B></A>
  137.  
  138. Be sure to give your USERS access to the new PROFHTML.WCX program via the 
  139. following sequence:
  140.  
  141. (wcCONFIG / Access Profiles / <security level> / MENUS)
  142.  
  143.  
  144. Program Name    Door Name               WCX Name     Path to Door Directory
  145. ------------    -------------------     ---------    ----------------------
  146. PROFHTML.WCX    User PROFILES           PROFILE       c:\wc5\doors\PROFILE
  147.  
  148.  
  149.  
  150.                      PURGE PROFILE DATABASE (PROFEVNT.WCX)
  151.                      -------------------------------------
  152.  
  153. This program was designed to be run in an event. It will PURGE all deleted 
  154. records as well as all records where the logon name does not match an existing 
  155. entry in the Wildcat user database. Thus if you remove a caller from the 
  156. database you will be ensured that if the caller exists in the PROFILE 
  157. database, they will be purged as well.
  158.  
  159.  
  160.                              USAGE LOG
  161.                              ---------
  162.  
  163. As an option, we provide you with the ability to log every player to a text 
  164. file. IF you enter Y in the CFG file to log callers, the Door will place the 
  165. caller's name as well as the ON and OFF times each time a caller selects the 
  166. Door. A separate file will be created for each Node and the name of the file 
  167. will be USAGEx, where x is the Node number.
  168.  
  169. You may delete these files at any time and the Door will recreate them the 
  170. next time a caller enters the Door. If you do NOT want to continue logging 
  171. callers, change the CFG file entry to N.
  172.  
  173.  
  174.  
  175.                        VALID INPUT CHARACTERS (CHAR.OK)
  176.                        --------------------------------
  177.  
  178. If you wish to restrict the type of characters a caller may enter, in response 
  179. to any questions, be sure to either create or edit the CHAR.OK file. This file 
  180. contains all the valid characters you will accept in reponse o a Profile 
  181. question. You can delete CHAR.OK, if you do not wish to validate any input 
  182. characters or you may edit it to add/change existing entries.
  183.  
  184. A CHAR.OK file is supplied that contains only the alpha and numeric keys
  185.  
  186.  
  187.  
  188.           
  189.                 
  190.                     QUESTIONS/DISPLAY VERBAGE(PROFILE.DAT)
  191.                     ______________________________________
  192.  
  193. This file contains all the questions you will be asking the callers to 
  194. complete, whether or not they must answer the question and the corresponding 
  195. display verbage to be used when displaying the caller's answers to the 
  196. questions.
  197.  
  198. PROFILE.DAT an ASCII file created/edited with any ASCII editor. Each line will 
  199. reference an individual question, with a maximum of 38 questions.
  200.  
  201. The format of each line in the file, is as follows:
  202.  
  203.                      aaaaaaaaaaaa|b|ccccccccccccc
  204.          
  205.           where a = the question to be asked (maximum of 50 characters)
  206.                 b = Y (question MUST be answered)
  207.                     N (question may be bypassed)
  208.                 c = verbage to be used when displaying answer (max of 18 char.)
  209.  
  210.       The program will perform checks on the PROFILE.DAT file and will report 
  211.       any errors it detects. A message will be displayed containing the 
  212.       offending PROFILE.DAT line number and an error number. The error numbers 
  213.       and their meaning follows:
  214.  
  215.           Error 1: Question length greater than 50
  216.           Error 2: 'Must answer' field contains other than Y or N
  217.           Error 3: Display verbage length greater than 18
  218.           Error 4: File contains more than 38 questions
  219.  
  220.       PLEASE NOTE: When designing the questions, bear in mind that answers to 
  221.                    the questions are limited to 18 characters.
  222.  
  223.  
  224.                       PICTURE ATTACH/PICTURE DOWNLOADING
  225.                       __________________________________
  226.  
  227.  
  228. PROFILE allows the Sysop to ATTACH a picture to a User's profile. 
  229.  
  230. The format of the picture files are left up to the Sysop (ie: GIF, PCX, etc). 
  231. The caller uploads the picture file thru hte Profile DOor itself. If the 
  232. Sysop, after reviewing the file, accepts it he/she uses the SYSOP option off 
  233. the Profile Door Menu to add the FILENAME of the picture to the appropriate 
  234. field in the caller's record. The Drive:\Path\ to the Picture Filename must be 
  235. defined in the PROFILE.CFG file.
  236.  
  237. Callers that choose to view another callers profile, will be informed that 
  238. there is a picture available for Downloading/Viewing. The caller is given the 
  239. option of downloading it and viewing it offline OR if they are using a 
  240. terminal program with a GIF viewer TSR, viewing it as they download it.
  241.  
  242.  
  243.  
  244.                      
  245.                                 TRASHCAN FILE
  246.                                 _____________
  247.  
  248. This is a text file you must create (if you wish to use one), with a file name 
  249. of PROFTCAN.DAT and it must reside in the Door directory.
  250.  
  251. This file is used if you want to block the use of "offensive" words callers 
  252. may choose to use. Each word must appear on a separate line within the text 
  253. file with a maximum of 100 words.
  254.  
  255. NOTE: The word must match EXACTLY !!!
  256.  
  257.  
  258.  
  259.  
  260.                                ADOPT-A-DOOR
  261.                                ____________
  262.  
  263. Having been a Sysop for a number of years, I have had my share of problems and 
  264. frustrations getting financial support for my board's upkeep. A fellow Sysop 
  265. left a message on my board, not long ago, about a concept that was being used 
  266. by several boards around the country.
  267.  
  268. The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It 
  269. would be the same as sending in a donation, only this way it is earmarked for 
  270. registering a particular door. In a way, the user feels he/she is "getting 
  271. something in return". As a Door author I have decided to build this concept 
  272. into each of my Door programs. The concept replaces the usual message "tell 
  273. the Sysop to register this Door" we find in most doors.
  274.  
  275. If the Door is unregisterd then a message appears on the opening screen to 
  276. that effect. After finishing or suspending a game, a message screen is 
  277. displayed about the ADOPT-A-DOOR concept. The message also tells the caller to 
  278. contact the Sysop to find out if there is any further details to the 
  279. ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online time, etc to 
  280. callers that ADOPT-A-DOOR.
  281.  
  282. If the Door has been registered, either by the Sysop or other callers, the 
  283. names of those contributors will be displayed in the closing screen.
  284.  
  285. NOTE: If you want to display the names of the callers that contributed to 
  286. registering the Door, you must create an ASCII file called ADOPT.SYS. You 
  287. create it with an Editor or Word Processor. Enter the name(s) of the 
  288. contributors (one on each line, maximum of 5 entries, each a maximum of 30 
  289. characters long). This file must be saved, in ASCII format, and placed in the 
  290. Door directory.
  291.  
  292.  
  293.  
  294.                               LEGALITIES
  295.                               __________
  296.  
  297.  
  298. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT 
  299. WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT LIMITED TO ANY 
  300. IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN 
  301. NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND PRODUCTION OF THIS 
  302. PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT 
  303. OF ANY USE THEREOF OR BREACH OF ANY WARRANTY.
  304.  
  305.  
  306.  
  307.  
  308.  
  309.                              DISTRIBUTION
  310.                              ____________
  311.  
  312. You may make this file available for downloading from your BBS or you may 
  313. upload it to any BBS of your choice, provided that you do not make any changes 
  314. to the contents of the archive (ZIP file). The archive and its individual 
  315. contents may not be used by any service that charges any money whatsoever, 
  316. without the written permission of the author.
  317.  
  318.  
  319.  
  320.  
  321.  
  322.                              REGISTRATION
  323.                              ____________
  324.  
  325. Registration and the subsequent insertion of the registration number into your 
  326. configuation file, allows for the display of your BBS name on the opening and 
  327. closing screen as well as the reduction of a delay built into the opening 
  328. screen display along with the ability to change certain values in the 
  329. configuration file.
  330.  
  331. To register your copy of PROFILE please fill out the registration form 
  332. (REGISTER.FRM) and mail it along with the registration fee to the name and 
  333. address on the form.
  334.  
  335. Once a door is registered, any changes to registration information (Sysop name 
  336. or BBS Name) will require the doors to be re-registered at the registration 
  337. fee in effect at that time.
  338.  
  339. Be sure to use the proper upper/lower case when filling in your name and BBS 
  340. name, as they MUST match the way you entered them in the configuration file.             
  341. ^^^^
  342.  
  343. Based upon information supplied on the registration form, I will pre- register 
  344. you on my BBS. You will then be able to call SUNRISE-80 and pick up your 
  345. registration number.
  346.  
  347.  
  348.  
  349.                                  MISC
  350.                                  ____
  351.  
  352. The latest version of PROFILE and other fine SUNRISE DOOR programs are always 
  353. available for download from SUNRISE-80 BBS.
  354.  
  355.