home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / vdocs.zip / VC6D < prev    next >
Text File  |  1993-12-20  |  28KB  |  557 lines

  1. .TOPIC:                                           
  2. Subsystems/Miscellaneous Functions
  3.                                            VBBS 6.12 Documentation -- 6-D-1
  4.  
  5.          ╔════════════════════════════════════════════════════════════════╗
  6.          ║ CHAPTER SIX ANNEX D    SUBSYSTEMS/MISCELLANEOUS FUNCTIONS      ║
  7.          ╚════════════════════════════════════════════════════════════════╝
  8.           See also:  Bulletins/Textfiles        System Info
  9.                      Voting Booth               Autoposts
  10.                      Teleconference             Hypertext Help
  11.                      Quiz System                Callback Verifier
  12.  
  13.                 This particular area of a BBS is usually one of the more
  14.          interesting areas, yet it's one of the most under-utilized.  In
  15.          the subsystems area, users can read a list of all the users on
  16.          the BBS, vote on topics of current interest, read textfiles, and
  17.          do several other Neat Things (caps still intended).
  18.  
  19.          Main Menu Commands and What They Do -- Subsystems
  20.          ═════════════════════════════════════════════════
  21.  
  22.          [T] File Transfers             We just got through with this one.
  23.          [B] Bulletins/Textfiles        Display menu of general textfiles
  24.                                          available for reading.
  25.          [S] System Info                Provides a display of the BBS'
  26.                                          system statistics.
  27.          [V] Voting Booth               Users are allowed to vote on pol-
  28.                                          ling questions posted by the
  29.                                          sysop.
  30.          [D] Defaults                   Allows user to set his or her de-
  31.                                          fault settings; one of the most
  32.                                          important features a new user
  33.                                          can access.
  34.          [O] Online Programs            Displays menu for games and other
  35.                                          online programs configured in
  36.                                          VCONFIG.
  37.          [A] Autoposts                  Displays autoposts.
  38.  
  39.  
  40.          Main Menu Commands and What They Do -- Miscellaneous
  41.          ════════════════════════════════════════════════════
  42.  
  43.          [K] Today's Callers            Displays a list of callers who
  44.                                          have logged on today.
  45.          [U] User Listing               Displays a complete user listing;
  46.                                          sysops also get SL, max time,
  47.                                          and access flags.
  48.          [I] System Info                Shows system usage statistics.
  49.          [C] Page Sysop                 If the console [ScrlLock] or [A]
  50.                                          is set to ON, this will activate
  51.                                          an audible page.
  52.          [W] Who's Online               Shows status of console and each
  53.                                          modem port.
  54.          [Z] Multiuser Teleconference   On multiuser systems, allows the
  55.                                          users to chat between nodes.
  56.          [X] Network Info               Displays network BBSLIST(s).
  57.          [*] Sysop Menu                 Go to sysop function block (dis-
  58.                                          played to 255 SL only).
  59.          [G] Log Off                    Exit the BBS.
  60.  
  61.                                            VBBS 6.12 Documentation -- 6-D-2
  62. .TOPIC:
  63. Bulletins/Textfiles
  64.  
  65.          Bulletins/Textfiles
  66.          ═══════════════════
  67.  
  68.                 The Bulletins section contains text files that users may
  69.          read at their leisure.  The types of files that are placed here
  70.          are generally about the BBS' procedures and policies; other
  71.          possibilities include system news files, virus information, game
  72.          scoreboards and news files (a popular feature), or transcripts
  73.          of articles dealing with topics of particular interest (please
  74.          make sure to give proper credit to the author).
  75.                 To install a textfile, place the file in the directory
  76.          you have indicated in VCONFIG, section E.  Go into the textfile
  77.          area and select the [A]dd option; follow the prompts from there.
  78.                 It's a good idea to keep your titles and descriptions
  79.          brief; lengthy titles and descriptions are truncated.  By the
  80.          way, when a USER looks at the titles, he/she does NOT see the
  81.          filename -- only the title.  The filename is displayed to the
  82.          sysop as a means of keeping track of filenames.
  83. .TOPIC:
  84. System Info
  85.  
  86.          System Info
  87.          ═══════════
  88.  
  89.                 This is the screen produced by the line "sysinfo" in the
  90.          default START.V.  It shows today's statistics and the total cu-
  91.          mulative statistics for your system.  This screen differs from
  92.          the WFC stats screen in that it also shows active/idle minutes
  93.          and a graphical representation of usage by time of day and modem
  94.          speed.
  95.                 The one statistic most sysops are usually concerned about
  96.          is the "Duty Cycle" statistic; it's the ratio of active minutes
  97.          to total minutes online.  Naturally, you want to keep this num-
  98.          ber as high as possible, since it's the quickest measure of how
  99.          active your system is.  A figure of 50% means that your system
  100.          has been in use half the day -- not a bad total at all -- while
  101.          a figure of 70% or better is cause for rejoicing.  If your duty
  102.          cycle is consistently less than 15-20%, you might want to re-
  103.          examine the way you "do business" -- you may be doing something
  104.          that discourages users from calling your board.  
  105.  
  106.          ╔═╗    There is a VirtualNET sub in which sysops discuss ideas
  107.          ╚═╝    for improving board usage:  "BBS Success (Keeping Your
  108.                 Board Going)".
  109. .TOPIC:
  110. Voting Booth
  111.  
  112.          Voting Booth
  113.          ════════════
  114.                 Voting questions are an important way to keep your finger
  115.          on the pulse of your user base.  In VCONFIG, you can set VBBS to
  116.          check whether there are new voting questions when a user logs on;
  117.          this is generally a good idea.  Typical voting questions might 
  118.          include:
  119.  
  120.                                            VBBS 6.12 Documentation -- 6-D-3
  121.  
  122.          ■  How did you hear about this BBS?
  123.          ■  What's the MAIN reason you call <BBS name here>?
  124.          ■  If you could change ONE thing at <BBS name>, what would it be?
  125.              (Think this one through CAREFULLY -- don't suggest changes
  126.               you aren't willing to implement!)
  127.          ■  Which of the following subs would you MOST like to see added?
  128.  
  129.          Of course, you may tailor the questions to your specific needs.
  130.          It should be noted that this multiple-choice format is not par-
  131.          ticularly suited for "ranking"-type questions, as they allow
  132.          only one answer per question.
  133.                 Another thing to consider when constructing voting ques-
  134.          tions is that you may ask your users' opinion on something; the
  135.          best format for "like/don't like" questions is 
  136.  
  137.          1 -- Really like it            It's GREAT!
  138.          2 -- Like it                   I think it's okay.
  139.          3 -- Don't care                Doesn't make any difference to me.
  140.          4 -- Don't like it             I'm not real crazy about it.
  141.          5 -- Really don't like it      I don't like it very much.
  142.  
  143.          You may "disguise" these choices as shown above, but it has been
  144.          shown to be one of the most statistically reliable formats for
  145.          opinion-type questions.
  146.                 Please see "The Voting Booth" for the "how-to" on setting 
  147.          up voting questions.
  148.  
  149.  
  150.          Defaults
  151.          ════════
  152.  
  153.                 This was addressed earlier in the section on VCONFIG, but
  154.          having users set their own defaults is quite an important matter,
  155.          and they are encouraged to do so automatically after they create
  156.          their account.
  157.  
  158.                 The most important default a new user can set is to enable
  159.          the full-screen editor (if he/she has ANSI capability); other
  160.          commonly-adjusted defaults include screen colors, user macros,
  161.          and mail forwarding (if desired).
  162.  
  163. .TOPIC:
  164. Autoposts
  165.  
  166.          Autoposts
  167.          ═════════
  168.  
  169.                 Autoposts are like electronic Post-It Notes <tm> that
  170.          may appear in a user's initial login (depending on his/her de-
  171.          fault settings).  Users who have the appropriate security level
  172.          may post a one-, two-, or three-line message for display; the
  173.          four most recent autoposts are displayed.  These are useful for
  174.          announcing upcoming system changes/downtime or alerting users to
  175.          the existence of new/important files or posts.
  176.                 In addition, there are several VSCRIPT-based autopost
  177.          programs (most notably GREMPOST.V) that allow networking of
  178.  
  179.                                            VBBS 6.12 Documentation -- 6-D-4
  180.  
  181.          autoposts over VirtualNET-networked BBSs; note that these ARE
  182.          NOT included with the original VBBS archive.
  183.  
  184.          Sysop Paging and Chat Screens
  185.          ═════════════════════════════
  186.  
  187.                 As stated earlier, either the [Scroll Lock] key or the
  188.          [A] key from WFC will toggle sysop availability, depending on
  189.          how you have things set up in VCONFIG.
  190.                 There are two ways to answer a chat-call; one is with
  191.          the normal [F1] key.  This allows you to converse with the on-
  192.          line user -- your words show up in one color, the user's in
  193.          another.  To exit this chat method, press [F1] again.
  194.                 The fancier way to answer is with the [Shift-F1] key.
  195.          This divides the screen into two halves, with your words at the
  196.          top and the user's at the bottom.  To exit this chat mode, press
  197.          [Esc].
  198.  
  199.          ╔═╗    Chatting, if done properly, can be a great PR builder.
  200.          ╚═╝    Some helpful hints on chatting:
  201.  
  202.                 1) Try to be available for chat at least SOME of the time.
  203.                    It doesn't usually take TOO long.
  204.                 
  205.                 2) Try NOT to "drop in" on a user when they're in the mid-
  206.                    dle of something, unless they're looking totally lost.
  207.                    Try not to startle your users.
  208.  
  209.                 3) As a way of indicating that you're through typing a 
  210.                    sentence, it's usually a good idea to hit [Enter] twice
  211.                    to double space; that lets the user know you're through 
  212.                    typing, kind of like "over" in a radio conversation.
  213.         
  214.                 4) When you leave the console, make sure sysop avail-
  215.                    ability is toggled where you want it.  If you're tog-
  216.                    gled as available when you're really not, users can 
  217.                    become frustrated.
  218.  
  219.                 As with other functions of VBBS, there are a number of
  220.          alternative chat and paging scripts available -- there is even
  221.          an "emergency chat" script that allows users who know a special
  222.          password to bypass the "sysop not available" message and page
  223.          you anyway.  A fully external chat utility called ISYCHAT10
  224.          also allows for the above, global capture of the chat, is
  225.          configureable for multiple sysops, and is Soundblaster capable.
  226. .TOPIC:
  227. Teleconference
  228.  
  229.          Multi-user Teleconference
  230.          ═════════════════════════
  231.  
  232.                 The multi-user teleconference is an inter-node chat fea-
  233.          ture.  From inside the teleconference, two or more users who are
  234.          online simultaneously can page each other to the teleconference,
  235.          send one-line messages to each other to whatever area the other
  236.          user is active in, and broadcast short messages to ALL users on-
  237.          line at the time.  Also, if you send E-mail to a user who is on-
  238.  
  239.                                            VBBS 6.12 Documentation -- 6-D-5
  240.  
  241.  
  242.          line, VBBS will notify that user that you have sent E-mail to
  243.          him/her.
  244.                 Once inside of the teleconference, users can chat with
  245.          each other within teleconferencing "rooms".  If there were four
  246.          users in the teleconference, for example, two users could decide
  247.          to change rooms in order to have an exclusive conversation with
  248.          each other.  There are 99 such rooms within teleconference.
  249.                 Users have the option in teleconference to change their
  250.          handles within the teleconference.  The sysop may create a file
  251.          called BADNAMES.TXT and place it in the TXT subdirectory.  This
  252.          file should contain, one per line, the handles that are not
  253.          allowed to be used in the teleconference.  Users who do not
  254.          wish to be available for chatting may access the "hide" function
  255.          within the teleconference in order to be invisible to other users
  256.          while executing other BBS areas on a multi-line system.
  257.  
  258.  
  259.          THE SYSOP MENU
  260.          ══════════════
  261.  
  262.                 The sysop menu, available only to users with a 255 SL, is
  263.          accessed by pressing the star [*] key at the Main Menu (although
  264.          with a function-block modification, you could make it accessible
  265.          at ANY menu (... you know where to look for info on this).
  266.                 The functions available at the sysop menu are:
  267.  
  268.          [M] Read All Mail              Review all E-mail on the system.
  269.                                          Use this with extreme discre-
  270.                                          tion, if you use it at all.
  271.          [E] Edit Any File              Pulls a file into the VBBS FSE for
  272.                                          editing; useful for colorizing
  273.                                          system taglines, among other
  274.                                          things.
  275.          [U] User Editor                Go into the user editor to check
  276.                                          on/edit user information.
  277.          [S] Security                   Displays users with SLs greater
  278.                                          than 150 or who have one or more
  279.                                          access flags set.
  280.          [C] Force Cleanup              Force a daily cleanup.  Note that
  281.                                          this isn't a "hit-and-forget"
  282.                                          command; the screen will pause
  283.                                          when it reaches your default
  284.                                          page length.
  285.          [V] Validate Network           Presents the posts scheduled to
  286.                                          go out over the network from
  287.                                          your system; you will be promp-
  288.                                          ted to [A]pprove or [D]isapprove
  289.                                          each one.  Not easy if you have
  290.                                          a lot of active subs that re-
  291.                                          quire network validation.  This
  292.                                          is also an easy thing to forget
  293.                                          to do on a daily basis.
  294.          [Q] Quit                       Return to main (or previous) menu.
  295.  
  296.                                            VBBS 6.12 Documentation -- 6-D-6
  297.  
  298.          QWK OFFLINE READERS
  299.          ═══════════════════
  300.  
  301.                 VBBS features support for .QWK format offline readers.
  302.          Offline readers are special programs that allow a user to down-
  303.          load message packets from a BBS and read them at her leisure.  
  304.          They also allow users to construct packets containing their 
  305.          replies to messages and upload them in return.
  306.                 Some of the more popular offline readers include SLMR,
  307.          JABBER, BlueWave, OFFLINE, and OLX; in addition, there are .QWK 
  308.          readers available for Windows.
  309.  
  310.                 VBBS' auxiliary program, VQWK.EXE, prompts the user to up-
  311.          load a .REP file that tells VBBS which messages have been pre-
  312.          viously downloaded, as well as which message areas the user
  313.          would like to read.  This is configured either by making use of 
  314.          the [J]oin/Ignore Bases command in the Main Menu, or from within
  315.          the QWK menu:
  316.  
  317.          [D]ownload new message packet (QWK)                              
  318.          [U]pload reply message packet (REP)
  319.          [A]lter maximum # of messages/packet
  320.          [C]hange default compression type
  321.          [P]ick # of days for new file scan
  322.          [S]elect message bases for QWKing
  323.          Show (W)ho's currently online
  324.          [R]eturn to the BBS (exiting QWK)
  325.          [G]oodbye/Log off from the BBS                                      
  326.  
  327.          See the respective Appendix for VQWK setup instructions.
  328. .TOPIC:
  329. Hypertext Help
  330.  
  331.          THE VBBS HYPERTEXT HELP SYSTEM (Optional)
  332.          ═════════════════════════════════════════
  333.  
  334.                 The VBBS help system is a fine hypertext help system.
  335.          It can be configured in unlimited ways to meet a variety of
  336.          needs.  The calling sequence is
  337.  
  338.                 VBBS-AUX %1 HELP <help system number>
  339.  
  340.          The <help system number> is used to form a filename of the 
  341.          "lookup" file, which should be placed in your VBBS \DATA direc-
  342.          tory.  For example, for help system number 1, the file name would
  343.          be LOOKUP.1 (not LOOKUP.001).  Help systems from 1 to 999 are
  344.          available; system 0 is reserved for future internal use by VBBS.
  345.             Lookup files have the format -- one entry per line --
  346.  
  347.                 <help filename> <keyword or key phrase>
  348.  
  349.          For example, you might have this as a lookup file:
  350.  
  351.                                            VBBS 6.12 Documentation -- 6-D-7
  352.  
  353.  
  354.                 HELP1   Main Screen
  355.                 HELP2   Primary Topics
  356.                 HELP3   Secondary Topics
  357.                 HELP4   General Information
  358.  
  359.          In the lookup file, do not put in an extension for the help
  360.          filename; .HLP is assumed.  The first entry in your lookup file
  361.          is considered to be the starting point.  The help filename speci-
  362.          fied is displayed, and the user is prompted; continuing or going
  363.          back to the main menu proceeds from there.
  364.  
  365.                 Within each help file, you reference topics in the lookup
  366.          file by bracketing them with [ and ].
  367.                 Using the example LOOKUP file from above, help-file skele-
  368.          tons might look like this:
  369.  
  370.          HELP1.HLP:
  371.          ──────────
  372.  
  373.                         Welcome to the Main Help Screen.
  374.  
  375.                               [Primary Topics]
  376.                              [Secondary Topics]
  377.                             [General Information]
  378.  
  379.          HELP2.HLP
  380.          ─────────
  381.  
  382.                      Welcome to the Primary Topics Screen.
  383.  
  384.                              [Secondary Topics]
  385.                             [General Information]
  386.                                [Main Screen]
  387.  
  388.          HELP3.HLP
  389.          ─────────
  390.  
  391.                     Welcome to the Secondary Topics Screen.
  392.  
  393.                               [Primary Topics]
  394.                             [General Information]
  395.                                [Main Screen]
  396.  
  397.          HELP4.HLP
  398.          ─────────
  399.  
  400.                         Welcome to General Information.
  401.  
  402.                               [Primary Topics]
  403.                              [Secondary Topics]
  404.                                [Main Screen]
  405.                                           VBBS 6.12 Documentation -- 6-D-8
  406.  
  407.          --> IMPORTANT NOTE:  Several complete hypertext help files are
  408.                               available from VBBS support boards for
  409.                               easy installation in standard VBBS systems.
  410. .TOPIC:
  411. Quiz Section
  412.  
  413.          THE VBBS QUIZ/TEST SYSTEM (Optional)
  414.          ════════════════════════════════════
  415.                 The VBBS quiz/test feature can be used to give users tests
  416.          and quizzes online -- trivia quizzes (a great source of competi-
  417.          tion among users), tests on the users' knowledge of the BBS, or
  418.          even (if you can find the time to set it up) an actual test file
  419.          for tests from the local high school, community college, or uni-
  420.          versity (an extremely ambitious project, but unique!).  The cal-
  421.          ling sequence for the test feature is
  422.  
  423.                 VBBS-AUX %1 TEST <test filename>
  424.  
  425.          Test files (and the score files generated) should reside in your
  426.          \DATA directory.  Test files assume a .TST extension (be careful
  427.          typing that extension), and score files have a .SCO extension.
  428.          Score files are simple ASCII files; report generators can ana-
  429.          lyze the score file to produce statistical information.  A report
  430.          generator specifically designed for VBBS (TREPORT.EXE) is avail-
  431.          able for download from the author's BBS.
  432.  
  433.                 Test files are simple ASCII files also.  Each line of a
  434.          test file begins with one of the following prefixes:
  435.  
  436.                 b=   e=   a=   q=   p=
  437.  
  438.                 The "b=" prefix spcifies information displayed to the user
  439.          BEFORE they begin the test; you may have one or more of these at
  440.          the beginning of your test.
  441.                 The "e=" prefix indicates information that is shown to the
  442.          user AFTER they have finished the test; you may have one or more
  443.          of these.
  444.                 The "a=" prefix specifies the correct answer to the ques-
  445.          tion beginning on the next line; it also signals the test proces-
  446.          sor that a new question is beginning.
  447.                 The "q=" prefix contains the actual question (known in
  448.          educational circles as the "stem").  There may be one or more
  449.          lines in a question stem.
  450.                 The "p=" prefix specifies one of up to 20 possible answers
  451.          for the question (although 5 is generally a good number).
  452.          A sample one-question test under the name INTRO.TST might look 
  453.          something like this:
  454.  
  455.                 b=Welcome to this sample test; it only has
  456.                 b=one question.
  457.                 a=3
  458.                 q=Where is the Statue of Liberty located?
  459.                 p=Washington, DC
  460.                 p=Paris, France
  461.                 p=New York City
  462.                 p=Los Angeles
  463.                 e=Thanks for taking this test!
  464.                                          VBBS 6.12 Documentation -- 6-D-9
  465.  
  466.  
  467.          You will have to experiment a little to get proper spacing and
  468.          such, but a well-constructed fun quiz is another way of getting 
  469.          users online ...
  470.  
  471. .TOPIC:
  472. Callback Verifier
  473.  
  474.          THE VBBS CALLBACK VERIFIER (Optional)
  475.          ═════════════════════════════════════
  476.                 The call-back verifier is a means of checking to see whe-
  477.          ther a new user has left a valid phone humber in his/her logon
  478.          information.  It is implemented in VCONFIG; if you choose "yes"
  479.          to the callback verifier, VBBS will look at the two ASCII .CBV
  480.          files you've created in your \DATA directory and establish whe-
  481.          ther the new user is calling from a telephone exchange (accor-
  482.          ding to the sysop's criteria) that will allow callback verifi-
  483.          cation.  If the user is NOT within your defined callback area,
  484.          or leaves a number that you have included in your RESTRICT.CBV
  485.          file (such as 911), the board will not execute the dialout, and
  486.          new-user login will continue normally. The user is allowed to
  487.          complete callback validation successfully up to three times
  488.          before the connection is dropped.
  489.  
  490.          --> IMPORTANT NOTE:  Due to the callout nature of this feature, 
  491.                               its use and proper configuration is the
  492.                               specific responsibility of the individual
  493.                               sysop.
  494.  
  495.                 The callback verifier needs two files to work properly:
  496.          ALLOWED.CBV and RESTRICT.CBV; as mentioned earlier, VBBS will
  497.          look for these in the directory you have configured as your
  498.          \DATA directory in VONFIG.  The two files are discussed below.
  499.  
  500.          ALLOWED.CBV
  501.          ───────────
  502.  
  503.                 ALLOWED.CBV specifies the list of ALLOWED area code/
  504.          prefix combinations.  The format for the file is one entry per
  505.          line, as follows:
  506.  
  507.                 XXX-YYY Z
  508.  
  509.          where XXX is the area code, YYY is the prefix, and Z is a
  510.          "specifier" that tells the callback verifier how to dial this
  511.          area code/prefix combination.  Possible specifiers are given
  512.          below:       
  513.                                   
  514.          Specifier     Type of Call             How Dialed
  515.          ─────────────────────────────────────────────────────────────
  516.              +         Local                    YYY-????
  517.              -         LD within area code      1-YYY-????
  518.              $         LD outside area code     1-XXX-YYY-????
  519.              /         Local outside area code  XXX-YYY-????
  520.  
  521.          It should be noted that the wildcard character "?" is allowed
  522.          when entering prefixes.  For example, the line
  523.  
  524.                                            VBBS 6.12 Documentation -- 6-D-10
  525.  
  526.  
  527.                 205-34? +
  528.  
  529.          in ALLOWED.CBV would enable the BBS to call back ANY phone num-
  530.          ber local to the BBS that began with the digits "34"; in the
  531.          example above, the callback verifier would call Tuscaloosa's
  532.          345, 348, and 349 exchanges as local.  The surest way to han-
  533.          dle proper exchanges is to enter each one manually; while this
  534.          may necessitate a little more work on the sysop's part, it also
  535.          ensures that long-distance numbers that fit the prefix criteria
  536.          won't be called unnecessarily.
  537.  
  538.  
  539.          RESTRICT.CBV
  540.          ────────────
  541.  
  542.                 RESTRICT.CBV specifies the list of restricted phone num-
  543.          bers that may not be dialed by the callback verifier, such as
  544.          local police and/or fire departments, 911, "prank numbers" like
  545.          000-000-0000, or those of previously-known "bad users".
  546.  
  547.  
  548.                 Some final words on optional features:  These are often
  549.          the "something extra" that will keep your users calling back, as
  550.          implementing these features reflects a strong measure of dedica-
  551.          tion on your part.  Sysops are strongly encouraged to make use of
  552.          (and to encourage their users to use) the .QWK-format offline
  553.          readers available; this can significantly reduce the amount of
  554.          time users spend online reading messages, freeing them to explore
  555.          and use other areas of the BBS.
  556.  
  557.