home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 12 / CD_ASCQ_12_0294.iso / vrac / sappha.zip / CUSTOM.DOC < prev    next >
Text File  |  1994-01-01  |  23KB  |  545 lines

  1.  
  2.    ===========================================================================
  3.    ===                                                                     ===
  4.    ===                 CUSTOMIZING YOUR SYSTEM'S APPEARANCE                ===
  5.    ===                                                                     ===
  6.    ===========================================================================
  7.  
  8.  
  9.    Sapphire comes preconfigured as a "private online conversation club" named
  10.    "The Pinnacle Club".  This is a fairly general design, so some Sapphire
  11.    sysops find this approach appropriate to their requirements.
  12.  
  13.    After running the basic system for a while, many sysops decide to fine-tune
  14.    its function and appearance to suit their needs...
  15.  
  16.  
  17.  
  18.                     -----------------------------------------
  19.                     YOUR CUSTOMIZATION OPTIONS -- AN OVERVIEW
  20.                     -----------------------------------------
  21.  
  22.    There are several areas of customization for you to consider, which are
  23.    listed below in order of increasing difficulty:
  24.  
  25.  
  26.    1.   Configuration
  27.  
  28.    2.   Application
  29.  
  30.    3.   Hardware
  31.  
  32.    4.   Stock file text
  33.  
  34.    5.   Message bases
  35.  
  36.    6.   Doors and events
  37.  
  38.    7.   Stock file programming
  39.  
  40.    8.   Custom programming
  41.  
  42.  
  43.    These are described, in order, below.
  44.  
  45.  
  46.  
  47.                              ------------------------
  48.                              OPTION 1.  CONFIGURATION
  49.                              ------------------------
  50.  
  51.    The configuration program (SYSOP:CONFIG -- that is to say, CONFIG on the
  52.    main menu of the SYSOP utility) lets you specify some general information
  53.    about your hardware and how you want your BBS to run.  In particular, you
  54.    may wish to change some of the following items:
  55.  
  56.      1.   Settings on the console ("Presentation" on the CONFIG menu bar)
  57.           - Use of color
  58.           - Number of lines displayed on the console (25, 43, or 50)
  59.  
  60.      2.   General preferences  ("General" on the CONFIG menu bar)
  61.           - Console sound on/off
  62.           - Key click at the console
  63.           - Phone number format (e.g. 999-999-9999 or (999) 999-9999)
  64.           - Command prompt (e.g. ==> or "Enter your command now")
  65.  
  66.      3.   User settings ("Security" on the CONFIG menu bar)
  67.           - Minimum baud-rate to sign on
  68.           - Length of time a user may spend on the system
  69.  
  70.    For a complete list of the items you can configure with SYSOP:CONFIG,
  71.    refer to the appendix at the end of this chapter:  "Items Configurable
  72.    via SYSOP:CONFIG".
  73.  
  74.  
  75.  
  76.                               ----------------------
  77.                               OPTION 2.  APPLICATION
  78.                               ----------------------
  79.  
  80.    In deciding how to customize your system, it helps to keep in mind the
  81.    goals you have set.  For example, if you are running a purely conversa-
  82.    tional system, your users will benefit more from hearing your thoughts on
  83.    the current topic than they will if you spent time writing online documen-
  84.    tation.
  85.  
  86.    Similarly, if you are running a files system, your users want files, so
  87.    your time may be well spent reading shareware catalogs, or calling other
  88.    systems.
  89.  
  90.    In other words, sometimes the best customization is none at all.  Because
  91.    when you come right down to it, BBS's are about people interacting, not
  92.    text files.
  93.  
  94.    In order to best support your system's goals, you may decide to change the
  95.    privileges you give to the various membership levels.  For more information
  96.    about this, see "Customizing Membership Levels" (later in this chapter).
  97.  
  98.  
  99.  
  100.                                -------------------
  101.                                OPTION 3.  HARDWARE
  102.                                -------------------
  103.  
  104.    Without a doubt, the easiest way to improve your BBS is to add a faster
  105.    modem.  This attracts more members -- especially those who own fast modems,
  106.    since they tend to avoid systems that now seem "slow".  Since people can
  107.    move more data in less time, the traffic on your system picks up, which in
  108.    turn attracts more traffic.
  109.  
  110.    Sapphire supports modem speeds up to 19200, although at higher baud-rates
  111.    you may find that you need a faster computer.  For example, although an old
  112.    4.77 Mhz XT can support 9600 baud calls, it doesn't actually send the text
  113.    out at that speed; the connection will look more like a 2400-baud connec-
  114.    tion.
  115.  
  116.          TECHNICAL NOTE:  The current version of Sapphire does not
  117.          explicitly support "locked baud rates", but you can simulate
  118.          it by setting all but one connect string to "XXX" (i.e. some
  119.          nonsense string) and the locked baud-rate as "CONNECT".  This
  120.          will cause all connections to be interpreted as a connection at
  121.          that speed. In order to do this, though, you must be sure that
  122.          computer can support the locked baud-rate.  For example,
  123.          you could not lock at 4.77 MHz XT at 9600 baud; it would miss
  124.          characters.
  125.  
  126.    If you are running a file-transfer system, you can improve it by increasing
  127.    the disk space.  When you increase your disk capacity, you should set your
  128.    related configuration items ("Free space for upload", "Number of files
  129.    listed" and so on) accordingly.  (See SYSOP:CONFIG:ADVANCED:DOWNLOAD)
  130.  
  131.  
  132.  
  133.                             --------------------------
  134.                             OPTION 4.  STOCK FILE TEXT
  135.                             --------------------------
  136.  
  137.    The easiest and most immediately gratifying way to customize your system is
  138.    to modify the text of your "Stock files".  This is explained in detail in
  139.    SYSOP:INFO:MANUAL:STOCK.
  140.  
  141.  
  142.  
  143.                              ------------------------
  144.                              OPTION 5.  MESSAGE BASES
  145.                              ------------------------
  146.  
  147.    A "message base" is a logical grouping of messages.  For example, if your
  148.    system catered to dog breeders, you might group messages about Dalmatians
  149.    separately from messages about Spaniels.  Thus, somebody with no interest
  150.    in Dalmatians would not have to read messages about that breed of dog.
  151.  
  152.    In the preceding example, the messages were grouped by subject ("breed of
  153.    dog").  You may decide to group messages by some other criterion, such as
  154.    how long the person has been a member of your system, or how much they paid
  155.    to join.
  156.  
  157.    Sapphire is initially configured with 5 general message bases which group
  158.    messages according to membership level.  That is to say, a Level 1 (lowest)
  159.    member has access to no message bases, a Level 2 member has access to one
  160.    message base, and so on.  A Level 5 member has access to 5 message bases.
  161.    (The sysop, at Level 8, has access to all message bases.)
  162.  
  163.    These message bases, along with three other special-case message bases, are
  164.    defined in a text file named MSGBASES.DEF.  You can edit this file with a
  165.    standard text editor, such as DOS's EDLIN or EDIT, a programmer's editor,
  166.    or a word-processor in non-document (generic DOS text) mode.
  167.  
  168.    The format of the file is literally self-explanatory, since the file itself
  169.    contains an explanation of its format.  In order to view the file, enter
  170.    the following command at the DOS prompt:  SEE MSGBASES.DEF
  171.  
  172.    The SEE command can also print the file.  Before you modify the file, it is
  173.    a good idea to either print it out or make a backup copy.  You can make a
  174.    backup copy by entering this DOS command:  COPY MSGBASES.DEF MSGBASES.OLD
  175.  
  176.    This creates a second copy of the file, named MSGBASES.OLD.  Thus, if you
  177.    make a mistake and Sapphire no longer understands the file, you can restore
  178.    it to its original form with the command: COPY MSGBASES.OLD MSGBASES.DEF
  179.  
  180.    In general, the MSGBASES.DEF file allows you to define up to 15 message
  181.    bases (including logon announcements, feedback to sysop, and E-Mail).
  182.  
  183.    After modifying the MSGBASES.DEF file, log on and try the BASES command to
  184.    verify that the messages bases are set up the way you want.  You can use
  185.    the level-change function keys (ALT-F3 and ALT-F4) to try the BASES command
  186.    at each membership level.
  187.  
  188.  
  189.  
  190.                            ---------------------------
  191.                            OPTION 6.  DOORS AND EVENTS
  192.                            ---------------------------
  193.  
  194.    Doors are external processes that the user can run while online.  Events
  195.    are external processes the run automatically, under a particular set of
  196.    conditions that you determine.  See SYSOP:INFO:MANUAL:EXTERN for details.
  197.  
  198.  
  199.  
  200.                         ---------------------------------
  201.                         OPTION 7.  STOCK FILE PROGRAMMING
  202.                         ---------------------------------
  203.  
  204.    Stock file programming allows you to insert special actions at various
  205.    places of a standard Sapphire session.  For more information about stock
  206.    file programming, see SYSOP:INFO:MANUAL:STOCK.
  207.  
  208.  
  209.  
  210.                           -----------------------------
  211.                           OPTION 8.  CUSTOM PROGRAMMING
  212.                           -----------------------------
  213.  
  214.    You might find that Sapphire is excellent for your application, but needs
  215.    just one little change to make it perfect.  For example, you may have an
  216.    idea for a new command that you think your members would find particularly
  217.    helpful.
  218.  
  219.    In such case, you will require some custom programming.  We can do it for
  220.    you, or -- if you are familiar with Turbo Pascal -- you can do it yourself.
  221.  
  222.    There is, of course, a cost associated with custom programming, but this
  223.    cost can frequently be lowered if your idea can be applied to other
  224.    customers' systems.  For example, Sapphire's file download and message
  225.    reading systems were largely influenced by custom work.  Since in each case
  226.    the customer had a good idea, we performed the modifications for a
  227.    low price.
  228.  
  229.    Similarly, if you wish to purchase a source code license to make the
  230.    modifications yourself, we are willing to offer discounts if your work has
  231.    a wider application.  If you have a good idea and you are handy with Turbo
  232.    Pascal, give us a call!
  233.  
  234.    For more details about custom programming and some other choices that are
  235.    available to you, see SYSOP:INFO:OPTIONS.
  236.  
  237.  
  238.  
  239.    ===========================================================================
  240.    ===                                                                     ===
  241.    ===                    CUSTOMIZING MEMBERSHIP LEVELS                    ===
  242.    ===                                                                     ===
  243.    ===========================================================================
  244.  
  245.  
  246.                           -----------------------------
  247.                           OVERVIEW OF MEMBERSHIP LEVELS
  248.                           -----------------------------
  249.  
  250.    Sapphire supports 8 membership levels.  In general, these levels function
  251.    as follows:
  252.  
  253.  
  254.    Level   1      Non-members
  255.  
  256.    Levels 2-5     Members
  257.  
  258.    Levels 6-8     System operations staff
  259.  
  260.  
  261.    Each membership level has a set of privileges associated with it:
  262.  
  263.    - Message bases that can be read (see "Message Bases", above)
  264.  
  265.    - Commands that can be used
  266.  
  267.  
  268.    For example, as initially configured, Sapphire provides a non-member (Level
  269.    1) with the SEND command, but no READ command.  This means that a non-
  270.    member can ask for greater access privileges ("Tell us a bit more about
  271.    yourself, please!") but can not really use the system (i.e. read messages).
  272.    A basic member (Level 2) gets the READ command and (as defined in the
  273.    MSGBASES.DEF file) gets to use one message base.
  274.  
  275.    The initial setup described above works well because it forces new users
  276.    to type in a message.  You'll find that you can judge just by reading that
  277.    one message whether or not to make the person a full member.
  278.  
  279.  
  280.  
  281.                                --------------------
  282.                                WHY CHANGE ANYTHING?
  283.                                --------------------
  284.  
  285.    No BBS design works for everybody!  You may find it necessary to change the
  286.    initial configuration.  For example, if you are a shareware author, you
  287.    might want to make the GET (i.e. download software) command available to
  288.    non-members, so that people can obtain your software without waiting around
  289.    to become a full member.  (You can set up a "Guest" account for this kind
  290.    of application.  See SYSOP:CONFIG:BASIC:SECURITY:SIGN-ON)
  291.  
  292.    Alternatively, you might decide to give non-members their own message base,
  293.    so you can watch them in action.  You could give them access to a message
  294.    base by modifying the MSGBASES.DEF file (as explained in the last chapter).
  295.    In such case, you you would also have to give them access to the READ
  296.    command by modifying the COMMANDS.LEV file.
  297.  
  298.  
  299.  
  300.                               ---------------------
  301.                               THE COMMANDS.LEV FILE
  302.                               ---------------------
  303.  
  304.    COMMANDS.LEV is a text file that defines the minimum membership level
  305.    required for each of the internal (non-door) commands that Sapphire
  306.    supports.
  307.  
  308.    You can edit COMMANDS.LEV with a standard text editor, such as DOS's EDLIN
  309.    or EDIT, a programmer's editor, or a word-processor in non-document
  310.    (generic DOS text) mode.
  311.  
  312.    The format of the file is literally self-explanatory, since the file itself
  313.    contains an explanation of its format.  In order to view the file, enter
  314.    the following command at the DOS prompt:
  315.  
  316.    SEE COMMANDS.LEV
  317.  
  318.    The SEE command can also print the file.  Before you modify the file, it is
  319.    a good idea to either print it out or make a backup copy.  You can make a
  320.    backup copy by entering this DOS command:  COPY COMMANDS.LEV COMMANDS.OLD
  321.  
  322.    This creates a second copy of the file, named COMMANDS.OLD.  Thus, if you
  323.    make a mistake and Sapphire no longer understands the file, you can restore
  324.    it to its original form with the command:  COPY COMMANDS.OLD COMMANDS.LEV
  325.  
  326.    After modifying the COMMANDS.LEV file, log on and try the HELP command to
  327.    verify that the commands are set up the way you want.  You can use the
  328.    level-change function keys (ALT-F3 and ALT-F4) to try the HELP command at
  329.    each membership level.
  330.  
  331.  
  332.                            -------------------------
  333.                             DEFAULT MEMBERSHIP DESIGN
  334.                             -------------------------
  335.  
  336.    Before designing your membership levels, you may find it helpful to
  337.    understand our rationale in designing the default setup.  This is explained
  338.    below.
  339.  
  340.  
  341.  
  342.    Level 1:       Non-member
  343.  
  344.    May post:      Non-member message base
  345.  
  346.    Commands:      BYE            Disconnect  from  system  (i.e. logoff)
  347.                   HELP           Display a list of commands  you can use
  348.                   INFO           Membership requirements for this system
  349.                   SEND           Leave a message for other users to read
  350.                   SPECS          Change the way things  look around here
  351.                   TIME           Display how much time is left for visit
  352.                   VERSION        Display  software version and copyright
  353.  
  354.    Comments:      Note the absence of the READ command.  Note also that we do
  355.                   NOT put the BASES command at this level.  New users who try
  356.                   out that command tend to get miffed and log off.  It's
  357.                   better for them to read the INFO article, and thus get some
  358.                   idea of what you are trying to accomplish with your system.
  359.  
  360.    Note:          The BYE, TIME and VERSION command are locked at level 1 and
  361.                   can not be assigned to a different membership level.
  362.  
  363.  
  364.    Level 2:       Basic Member
  365.  
  366.    May post/read: Non-member and Basic member message bases
  367.    May post:      Feedback to Sysop message base
  368.    May read:      Report from Sysop message base
  369.  
  370.    Added cmds:    EXPERT         Switch  between  casual and expert mode
  371.                   BASES          Summary of  message  bases  you can use
  372.                   GIMMICKS       Describes various  tricks  for messages
  373.                   GRAPHICS       Switch  graphic  characters  on and off
  374.                   HINTS          Tricks and tips  for using  this system
  375.                   LIBRARY        Browse and read  in our  online library
  376.                   MESSAGES       Quick summary of messages (time & user)
  377.                   NAMES          Specify names  for  selecting READ etc.
  378.                   PROTOCOL       Select  method  used for  file transfer
  379.                   READ           Read  new messages  left by other users
  380.                   REVIEW         Inspect a single message by DATE:MINUTE
  381.                   SET            Modify the DATE:MINUTE for READ command
  382.                   TEXT           Specify text to reduce READ output etc.
  383.                   USERS          Display  information  about  our  users
  384.  
  385.  
  386.  
  387.    Level 3:       Special Member
  388.  
  389.    Added base:    Special Member
  390.  
  391.    Added cmds:    ACTIVITY       Display system activity for past 7 days
  392.                   CHANGE         Modify a message you've sent previously
  393.                   FILES          List software available for downloading
  394.                   GET            Get some software  from our  collection
  395.                   GIVE           Contribute software  to our  collection
  396.                   MOVE           Move a message from one base to another
  397.  
  398.  
  399.  
  400.    Level 4:       Top Notch Member
  401.  
  402.    Added base:    Top Notch
  403.  
  404.    Added cmds:    CHAT           Page system operator for a conversation
  405.                   OBSERVE        Overview of logon/logoff activity, etc.
  406.  
  407.    Comments:      Note that lower-level members, when doing the USERS command,
  408.                   see Top Notch members listed as "Special".  Top Notch mes-
  409.                   saging is completely hidden from lower levels. The idea here
  410.                   is to avoid displaying membership-level differences where it
  411.                   is not relevant, while providing higher-level members with a
  412.                   measure of privacy.
  413.  
  414.  
  415.    Level 5:       Inner Circle Member
  416.  
  417.    Added base:    Inner Circle
  418.  
  419.    Added cmds:    None
  420.  
  421.    Comments:      Lower-level members, when doing a USERS command, see an
  422.                   Inner Circle member listed only as "Special" (or "Top
  423.                   Notch", in the case of Level 4 members).  Inner Circle
  424.                   messaging is hidden from lower levels.  See Level 4 for
  425.                   explanation.
  426.  
  427.  
  428.  
  429.    Level 6:       Aide-de-Sysop
  430.  
  431.    Added cmds:    ERASE          Remove message  (resets it to time 0:0)
  432.  
  433.    Comments:      This level of authority allows people to keep the system
  434.                   tidy without having access to personal member information,
  435.                   such as phone numbers.
  436.  
  437.  
  438.  
  439.    Level 7:       Co-Sysop
  440.  
  441.    May read:      Feedback to Sysop
  442.  
  443.    Added cmds:    BANISH         Devalidate user (remove from user list)
  444.                   DOORS          Update  your  list of  "Door"  programs
  445.                   DOS            Shell out to DOS; type "EXIT" to return
  446.                   DUMBTERM       Start dumb terminal  for outgoing calls
  447.                   EVENTS         Schedule your BBS's  close-down  events
  448.                   PROBE          Display user info  (see also USERS cmd)
  449.                   VALIDATE       Grant a user  a higher membership level
  450.  
  451.    Comments:      At this level, the USERS command gives more detailed inform-
  452.                   ation, such as password and phone number.  A co-sysop can
  453.                   run the entire system remotely.  He can not, however, find
  454.                   out the sysop's password.
  455.  
  456.  
  457.  
  458.    Level 8:       Sysop
  459.  
  460.    May post:      Logon Announcements
  461.  
  462.    Added cmds:    CLOSE          Shut down system; prevent further calls
  463.  
  464.    Comments:      The user named "SYSOP" is automatically placed in "Ultra-
  465.                   Mode".  See the explanation of "Ultra-Mode" (Alt-F10) in the
  466.                   "Function Keys" section.
  467.  
  468.  
  469.  
  470.                ------------------------------------------------
  471.                APPENDIX A:  ITEMS CONFIGURABLE VIA SYSOP:CONFIG
  472.                ------------------------------------------------
  473.  
  474.                          (Listed in alphabetic order)
  475.  
  476.  
  477.    Accounting -- Enable or Disable
  478.    Accounting Date Format
  479.    Address of COM Port
  480.    Annunciator Tune
  481.    Answer Incoming Calls
  482.    Attention String
  483.    Automatically Select File Area by Membership Level
  484.    Automatically Select File Destination by Membership Level
  485.    Bonus Connect Time
  486.    Broken Connection
  487.    Command Failed
  488.    Command Successfully Completed
  489.    Configuration Start-up Menu
  490.    Configurator Opening Menu
  491.    Days Back for Files
  492.    Days Back for Messages
  493.    Default File Transfer Protocol
  494.    Detect ANSI Automatically?
  495.    Disconnect Delay
  496.    Disconnect Method
  497.    Display Mode
  498.    Display in Color
  499.    Door Safety Level
  500.    Free Space Required for Questionnaires
  501.    Free Space Required for Upload
  502.    Gearshift -- Enable or Disable
  503.    Give-to-All Level
  504.    Ignore Incoming Calls
  505.    Initial Membership Level
  506.    Initial Setup
  507.    Initializing Baud Rate
  508.    Key Click
  509.    Library Directory -- Extensions to Exclude
  510.    Local Text Editor
  511.    Long-distance Call Pattern
  512.    Main Pulldown Menu
  513.    Maximum Sign-ups
  514.    Membership Level Description
  515.    Membership Level Masking in USERS Command
  516.    Membership Levels Subject to Time-Out
  517.    Minimum Baudrate
  518.    Modem Command Pacing
  519.    Modem Connection Response
  520.    Modem Ring
  521.    Name of Guest Account
  522.    Number of Files Listed in Files Area
  523.    Number of Hours Between Calls
  524.    Passwords Considered
  525.    Path to Library Files
  526.    Path to Message Files
  527.    Path to Upload/Download Files
  528.    Phone Hang-up
  529.    Phone Number Format
  530.    Phone Pick-up
  531.    Pop-up Message Speed
  532.    Pre-call Setup
  533.    Quote File Name for Local Text Editor
  534.    Registration or Evaluation Extension Serial Number
  535.    Screen Saver Delay
  536.    Screen Saver Speed
  537.    Show Private and Exclusive Headers
  538.    Shutdown Reset
  539.    Software Documentation Files Extension
  540.    Sound Effects
  541.    Standard and Graphics Prompts
  542.    Use Questionnaires Instead of Editor for GIVE Documentation
  543.    User List Clean-Up Settings
  544.  
  545.