home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / FEEDBACK.ZIP / SYSOP.DOC < prev    next >
Encoding:
Text File  |  1995-02-25  |  13.0 KB  |  473 lines
  1.                               
  2.                             INDEX
  3.  
  4.  
  5. INDEX                                                    
  6.  
  7. OVERVIEW OF PROGRAM                                      
  8.      
  9.      QUICKSTART                                          
  10.           
  11.           MAXIMUS                                        
  12.           
  13.           PROBOARD                                       
  14.           
  15.           REMOTE ACCESS                                  
  16.      
  17.      FILE DESCRIPTION                                    
  18.           
  19.           ANSI graphical files                           
  20.           
  21.           ASCII graphical files                          
  22.           
  23.           Language files                                 
  24.           
  25.           Program files                                  
  26.           
  27.           Special notes.                                 
  28.           
  29.           Drop files                                     
  30.           
  31.           FEEDBACK database specifications               
  32.           
  33.           Documentation files                            
  34.           
  35.           BATCH FILE                                     
  36.  
  37.           LAST MINUTE ADDITION
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54. OVERVIEW OF PROGRAM
  55.  
  56. QUICKSTART
  57.  
  58.      For those who are eager to get the software up and
  59. running in as little as possible time (ie - read the manuals
  60. later [if ever]) I have included 3 examples on how to get
  61. the feedback door operational on three major bulletin
  62. boards.
  63.  
  64.  
  65.  
  66.   MAXIMUS
  67.      
  68. This explanation is to aid a novice sysop to install the
  69. FEEDBACK door onto the MAXIMUS Bulletin Board System. (Most
  70. experienced sysops would not need this detail)
  71.  
  72. STEP 1.
  73.  
  74. Edit the MENUS.CTL file with a standard ASCII text editor,
  75. such as DOS's EDIT.
  76.  
  77. Scroll through the file to the MENU section, (The most
  78. simple installation is to have the feedback door run from
  79. the Bulletin Board's main menu).
  80.  
  81. Insert the following lines:
  82.  
  83. display_file        misc\dorinfo        disgrace "<Feedback door"
  84. noDsp Xtern_Dos     feedback\runfeed    disgrace "<"
  85.  
  86. Save the MENUS.CTL file and exit.
  87.  
  88.  
  89. STEP 2.
  90.  
  91. To invoke the changes you must run the maximus SILT program.
  92. (To do that type SILT MAX at the dos prompt).
  93.  
  94. STEP 3.
  95.  
  96. Create a directory under the MAXIMUS directory (FEEDBACK is
  97. a good name for the sub-directory)
  98.  
  99. STEP 4.
  100.  
  101. Copy all the relevant FEEDBACK files into that sub-directory
  102.  
  103.  
  104. STEP 5.
  105.  
  106. Edit the RUNFEED.BAT file and change the directory paths to
  107. represent your own (Most likely you wont need to change
  108. much)
  109.  
  110. STEP 6.
  111.  
  112. Log on locally as the sysop and test that the program runs.
  113. You can now use the SETUP feature to configure the DOOR to
  114. your liking.
  115.  
  116.      
  117.   PROBOARD
  118.  
  119. This explanation is to aid a novice sysop to install the
  120. FEEDBACK door onto the PROBOARD Bulletin Board System. (This
  121. explanation has been supplied by Mr Gary Smith)
  122.  
  123.  
  124. STEP 1.
  125.  
  126. Within PROBOARD, specify a menu type 7
  127.  
  128. In the data field put the following (To suit your directory
  129. structure)
  130.  
  131. *ZD:\PROBOARD\RUNFEED.BAT
  132.  
  133.  
  134. STEP 2.
  135.  
  136. Create a directory under the PROBOARD directory (FEEDBACK is
  137. a good name for the sub-directory)
  138.  
  139. STEP 3.
  140.  
  141. Copy all the relevant FEEDBACK files into that sub-directory
  142.  
  143.  
  144. STEP 4.
  145.  
  146. Edit the RUNFEED.BAT file and change the directory paths to
  147. represent your own (Most likely you wont need to change
  148. much)
  149.  
  150. STEP 5.
  151.  
  152. Log on locally as the sysop and test that the program runs.
  153. You can now use the SETUP feature to configure the DOOR to
  154. your liking.
  155.   REMOTE ACCESS
  156.  
  157.  
  158. This explanation is to aid a novice sysop to install the
  159. FEEDBACK door onto the REMOTE ACCESS Bulletin Board System.
  160. (This explanation has been supplied by Mr Grant Beatie)
  161.  
  162.  
  163. STEP 1.
  164.  
  165. Within Remote Access, specify a menu type 7
  166.  
  167. In the data field put the following (To suit your directory
  168. structure)
  169.  
  170. FEEDBACK /D:C:\RA
  171.  
  172.  
  173. STEP 2.
  174.  
  175. Create a directory under the REMOTE ACCESS directory
  176. (FEEDBACK is a good name for the sub-directory)
  177.  
  178. STEP 3.
  179.  
  180. Copy all the relevant FEEDBACK files into that sub-directory
  181.  
  182.  
  183. STEP 4.
  184.  
  185. Edit the RUNFEED.BAT file and change the directory paths to
  186. represent your own (Most likely you wont need to change
  187. much)
  188.  
  189. STEP 5.
  190.  
  191. Log on locally as the sysop and test that the program runs.
  192. You can now use the SETUP feature to configure the DOOR to
  193. your liking.
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204. FILE DESCRIPTION
  205.  
  206.  
  207.      To give you a better idea of how the program works, so
  208. that you can easily customise this door to your liking, it
  209. is an advantage if you understand what each different type
  210. of file is for, and how it is used.
  211.  
  212.      Below is a list of files that would most likely be in
  213. the sub-directory you created for the feedback door.
  214.  
  215.   ANSI graphical files
  216.  
  217. BANNERH.ANS    BANNERL.ANS    HELPH.ANS      HELPL.ANS
  218. INTROH.ANS     INTROL.ANS     MENUH.ANS      MENUL.ANS
  219.  
  220. Ansi files use PC extended characters and colors. They can
  221. be displayed by the dos TYPE command as long as you have
  222. ANSI.SYS loaded in the computer's memory. (consult your dos
  223. manual for greater detail). You are free to change these
  224. files to suit your needs. The files that end in H.ANS are
  225. the HIGH quality ANSI screens, (and those that end in L.ANS
  226. are ofcourse the LOW quality screens). The file names should
  227. be easy to understand (but refer below for further details).
  228.  
  229. BANNER    - Is a approximately 3 lines deep. It appears on
  230.             options such as Voting, Entering a question and
  231.             the Delete function.
  232. HELP      - This is the simple help screen.
  233. INTRO     - As the name implies, it is the introduction
  234.             screen.
  235. MENU      - This is the Main Menu screen.
  236.  
  237.  
  238.   ASCII graphical files
  239.  
  240. Ascii files are similar to the ANSI, except that they do not
  241. have any color codes, they usually contain the PC extended
  242. characters. The names of the files and their application is
  243. identical to the ANSI files.
  244.  
  245. BANNERH.ASC    BANNERL.ASC    HELPH.ASC      HELPL.ASC
  246. INTROH.ASC    INTROL.ASC      MENUH.ASC      MENUL.ASC
  247.  
  248.  
  249.   Language files
  250.  
  251. The language files are a plain ASCII text file (No extended
  252. characters used here). The feedback door will read one of
  253. these files into the program when it starts up. These files
  254. can give your Bulletin Board have a distinct and totally
  255. unique vocabulary. The details of what each line stands for
  256. is detailed below (Lines must be less that 80 characters).
  257.  
  258. Line No.  Description
  259. 1         Text displayed after Chat mode has ended.
  260. 2         Text displayed after the sysop has returned from shelling to DOS
  261. 3         Text displayed when the sysop has entered Chat mode.
  262. 4         Text displayed when the sysop shells to dos.
  263. 5         Text displayed asking for a reason to page the sysop.
  264. 6         Text displayed when sysop is not available for a Chat session.
  265. 7         Text displayed while paging sysop for a chat session.
  266. 8         Text displayed asking the user to choose a topic
  267. 9         Text displayed when there are no topics to choose from 
  268. 10        Text displayed asking the user to choose a topic 
  269.           or press return for menu
  270. 11        Text displayed asking what is the topic of the user's question
  271. 12        Text displayed asking what is the user's question
  272. 13        Text displayed asking what are the possible answers for the 
  273.           user's question
  274. 14        Text displayed to say select "O" for other or enter to "PASS" vote.
  275. 15        Text displayed when asking what is the user's "OTHER" possible 
  276.           answer. 
  277. 16        Text displayed to see if the user wants to save the question 
  278.           just entered.
  279. 17        Text displayed advising the user that the question was not saved.
  280.  
  281. To gain a better understanding of where these lines of text
  282. appear in the program, print out the language file that you
  283. have set the feedback door to use (default is ENGLISH). Run
  284. the program, and when the program runs, take note of where
  285. each line is displayed.
  286.  
  287. Language files that I have included in this package are :
  288.  
  289. ENGLISH.LAN    STARTREK.LAN   SURFER.LAN
  290.  
  291.  
  292.  
  293.   Program files
  294.  
  295. There are a number of files that relate to the operation of
  296. the FEEDBACK door, the files and their description are
  297. listed below.
  298.  
  299. FEEDBACK.EXE   - Main program used from the Bulletin Board.
  300. SETUP.EXE      - Program used to setup the feedback door
  301. RUNFEED.BAT    - Example batch file used by some bulletin Boards
  302. VIP.BIN        - A Binary file containing V.I.P. user's names
  303. FEEDBACK.DAT   - A Binary file containing the vote information.
  304. SETUP.CFG      - A plain ASCII text file containing the configuration 
  305.                  of the feedback door.
  306.  
  307.  
  308.  
  309.  
  310.  
  311.   Special notes.
  312.  
  313. SETUP.CFG
  314. If the configuration file is missing then you will receive a
  315. message to that effect, but then the program will still
  316. function using it's own built in presets.
  317.  
  318. You can make your own configuration file using a plain ASCII
  319. text editor instead of using the SETUP program. The details
  320. of the configuration file are shown below.
  321.  
  322. Line No.  Description                                  Example
  323. 1         The BBS name        [Max 25 characters].     My BBS Name
  324. 2         The Sysop's name    [Max 25 characters].     Dean Menhennet
  325. 3         The Language name   [Max 9   characters].    ENGLISH
  326. 4         The Prompt color    [Max 1   characters].    5
  327. 5         The User's color    [Max 1   characters].    3
  328. 6         The Sysop's color   [Max 1   characters].    8
  329. 7         The Vote color      [Max 1   characters].    2
  330. 8         Page start time     [Max 4   characters].    1000
  331. 9         Page end time       [Max 4   characters].    2200
  332. 10        Page length         [Max 2   characters].    10
  333. 11        Split menus         [Max 12  characters].    2400
  334. 12        Use multi menus     [Max 1   characters].    0
  335. 13        Default menu        [Max 1   characters].    0
  336.  
  337. Color codes are as follows:
  338. 1    BLUE
  339. 2    GREEN
  340. 3    CYAN
  341. 4    RED
  342. 5    MAGENTA
  343. 6    BROWN
  344. 7    WHITE
  345. 8    YELLOW
  346.  
  347.  
  348. VIP.BIN
  349. This program will continue to function properly if certain
  350. files are accidentally or purposely deleted (If you feed
  351. this file is corrupt in some way, then delete it). If the
  352. file is not found then the feedback door will give you an
  353. error message to that effect, but will continue to run. To
  354. re-create the VIP.BIN file, all that is required that you
  355. run the SETUP program (and save when you exit). The setup
  356. program will make a new VIP.BIN file if it doesn't find one.
  357.  
  358. FEEDBACK.DAT
  359. This file can also be delete if you feel that is somehow
  360. corrupt. The feedback door will advise you that it's cannot
  361. find it, but then make a brand new one for you.
  362.  
  363. DROP FILES
  364.  
  365. This program needs a drop files (a plain ascii text that is
  366. "DROPPED" onto the computer containing information about the
  367. user, the Bulletin board modem/port settings, color options
  368. etc).
  369.  
  370. This door "SHOULD" run on the following drop files.
  371.  
  372. DORINFO?.DEF
  373. EXITINFO.BBS (Normal, Extended and Quick BBS)
  374. CHAIN.TXT
  375. SFDOORS.DAT
  376. CALLINFO.BBS
  377. DOOR.SYS (GAP/PC-Board, Doorway style, Wildcat standard)
  378.  
  379. Unfortunately I have cannot test all of these options,
  380. however, if you find that one of these listed drop files do
  381. not work properly with the FEEDBACK door, you may contact
  382. myself and I will endeavour to resolve any problems
  383. encountered.
  384.  
  385.  
  386.  
  387.   FEEDBACK database specifications
  388.  
  389. Total number of questions     MAX 20
  390. Length of topic text          MAX 60 Characters
  391. Question by (user's name)     MAX 36 Characters
  392. Length of Question text       MAX 60 Characters
  393. Numbers of answers            MAX 20 Answers per Topic
  394. Length of answers             MAX 60 Characters
  395. Number of users               MAX 200
  396.  
  397.  
  398.  
  399.  
  400.   Documentation files
  401.  
  402. There are three main ascii text files that relate to the
  403. feedback door. Their names and a brief description are shown
  404. below.
  405.  
  406. MANUAL.DOC     General user information
  407. SYSOP.DOC      Quickstart and Technical information
  408. FIL_ID.DIZ     Generic description file [used by most BBS's]
  409.  
  410.  
  411.  
  412.  
  413.   BATCH FILE
  414.  
  415. The RUNFEED.BAT file is used by most Bulletin Board Systems
  416. to enable the environment to be set up prior to running a
  417. program. Below is a copy of the RUNFEED.BAT file.
  418.  
  419. @echo off
  420.  
  421. Rem This is a BATCH file to run the FEEDBACK door
  422. Rem Written By Dean J Menhennet.
  423. Rem Change to the FEEDBACK door directory
  424. Rem --------------------------------------------------------
  425. -
  426.  
  427. cd c:\max\feedback
  428.  
  429. Rem Move the dorinfo1.def file to the sub-director & start
  430. feedback door
  431. Rem --------------------------------------------------------
  432. -
  433.  
  434. move c:\max\dorinfo1.def c:\max\feedback\dorinfo1.def
  435. feedback.exe
  436.  
  437. Rem Move the dorinfo1.def file back & return back to the BBS
  438. Rem --------------------------------------------------------
  439. -
  440.  
  441. move c:\max\feedback\dorinfo1.def c:\max\dorinfo1.def
  442. cd c:\max
  443. exit
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.  
  451. Last Minute additions
  452. ---------------------
  453.  
  454. You can Specify the path to the drop file on the command line
  455. ie.
  456.  
  457. FEEDBACK C:\MAX
  458.  
  459. important ..............DO NOT !  add the dropfile name
  460. -------------------------------------------------------
  461.  
  462. ---->           FEEDBACK C:\MAX\DOORINFO1.DEF    <----- Is WRONG !!!!!
  463.  
  464.  
  465.  
  466.  
  467.  
  468.  
  469.  
  470.  
  471.  
  472.  
  473.