home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / vdocs.zip / VAH < prev    next >
Text File  |  1994-01-10  |  7KB  |  153 lines
  1. .TOPIC:
  2. VBBS External Strings Editor
  3.  
  4.                                             VBBS 6.12 Documentation -- G-1
  5.  
  6.  
  7.          ╔════════════════════════════════════════════════════════════════╗
  8.          ║ APPENDIX G         VBBS EXTERNAL STRINGS EDITOR                ║
  9.          ╚════════════════════════════════════════════════════════════════╝
  10.  
  11.           INTRODUCTION
  12.           ════════════
  13.           The ability to change strings in VBBS allows you virtually
  14.           unlimited opportunities to customize your bbs.  Aside from the
  15.           multi-language abilities, strings may be altered to call
  16.           up scripts, screens, user information, change colors, and
  17.           other features.  String customization adds flexibility that,
  18.           along with the script language itself, truly makes VBBS the most
  19.           customizeable bbs software available today.
  20.  
  21.           Source registered sysops are able to modify the strings in
  22.           VBBS through use of the VSTRING editor (VSTRING2 for
  23.           the OS/2 version).  Unmodified, the precompiled string file
  24.           is named DEFAULT.STR and placed in the TXT subdirectory.
  25.           This file cannot be altered without the string editor, so
  26.           please do not attempt to do so since tampering may have
  27.           disastrous consequences.
  28.  
  29.           The VBBS String Editor and DEFAULT String Source File are
  30.           licensed for use by source registered VBBS SysOps Only and may
  31.           not be redistributed. Registered sysops who have not
  32.           registered the source code are encouraged to register, and will
  33.           be given access to the VString Editor at the source
  34.           distribution sites.  Please see Order Information.
  35.  
  36.           INSTALLATION
  37.           ════════════
  38.  
  39.           To use the VBBS External String Editor, do the following:
  40.  
  41.           1. Place DEFAULT.S in your VBBS Text Directory
  42.  
  43.           2. VBBS-DOS: Execute VSTRING.EXE from your VBBS Main Directory
  44.              VBBS-OS2: Execute VSTRING2.EXE from your VBBS Main Directory
  45.              or type Vconfig from the command prompt and enter letter J.
  46.  
  47.           The following keys may then be accessed in the editor:
  48.  
  49.                 F-1     Help
  50.                 F-2     Save
  51.                 F-3     Goto (Goes to the string number entered)
  52.                 F-4     List (lists External Srrings)
  53.                 F-9     Compiles (Compiles Strings)
  54.                 ESC     Escape to Quit and Exit
  55.  
  56.           TIPS -->  Do NOT re-compile strings while your bbs is online.
  57.                     Backup Your BBS before Using The External Strings
  58.                     Editor.  After compiling, you must re-start VBBS
  59.                     for any changes to take place.
  60.                                           VBBS 6.12 Documentation --G-2
  61.  
  62.  
  63.           FEATURES
  64.           ════════
  65.  
  66.           All of the hard-coded "string text" (ie.."Please enter name
  67.           or number or NEW" and "Login: ") has been made totally
  68.           sysop configurable.  Sysops are be able to customize the text
  69.           displays and prompts.  Color may be used freely, and as an
  70.           advanced option,  sysops can substitute text files, or Vscripts
  71.           for a text string.  RIP graphics files can also be substituted
  72.           and added as needed.
  73.  
  74.  
  75.           With VBBS the sysop is able to run a script or executeable at
  76.           any prompt. If you want to run a script before a prompt, put
  77.           it in Vstring.
  78.  
  79.           For example, the following command calls a script if placed
  80.           on the string line:
  81.  
  82.           !<scriptname>  - no extension
  83.  
  84.           The following command would call up a RIP graphic file:
  85.  
  86.           @<filename.rip>
  87.  
  88.           e.g. r145.rip  would call up rip menu 145 from the TXT
  89.           subdirectory.  In addition, a full path may be specified.
  90.           If none is supplied, the TXT subdirectory is assumed.
  91.  
  92.  
  93.           The following command would call up a screen, and is similar
  94.           to the echofile command:
  95.  
  96.           @ <filename>
  97.  
  98.           The function will search your text subdirectory for a filename
  99.           with a .mnu, .ans,.asc, or .rip extension. Again, a full path
  100.           may be stipulated.
  101.  
  102.           The default text string source file is DEFAULT.S. The VSTRING
  103.           editor/compiler can edit this file, and compiles it into a
  104.           DEFAULT.STR file, which the software reads when it loads nad
  105.           executes.  Both DEFAULT.S and DEFAULT.STR reside in the TXT
  106.           sub-directory, and must exist.  You may add other languages,
  107.           dialects, board layouts, etc., as needed by creating more
  108.           .S files (ie GERMAN.S, SPANISH.S, SERIOUS.S, FUNNY.S, INSULTS.S).
  109.           
  110.           The multi-language files should be included in a LANGUAGE.CFG
  111.           file which is located in your main VBBS directory.  The file
  112.           itself is a simple Ascii file with one entry per line, such as:
  113.  
  114.           GERMAN
  115.           FRENCH
  116.           SPANISH
  117.                                           VBBS 6.12 Documentation --G-3
  118.  
  119.  
  120.           For each .S file you add, you must edit the first line
  121.           manually with a text editor to indicate the name you want
  122.           shown to the users on the language menu.  The VString editor
  123.           will not edit this for you.  Taking the Default.S file as an
  124.           example, notice that the first line reads:
  125.  
  126.           English (Default)
  127.           
  128.           In similar manner, you would edit the first line of each
  129.           additional .S file to indicate the name of the language file.
  130.           When a user logs on to VBBS, a small menu is shown which
  131.           prompts them for the language they would like to use.  Whatever
  132.           you have configured in your language.cfg file, will be offered
  133.           to all callers (even the SysOp using the Fast OR Local login
  134.           from the WFC) at login.
  135.  
  136.           Fortunately, pre-made language files have been developed by
  137.           sysops and are made available at the VBBS Support Boards as
  138.           they are released.  You are encouraged to participate in this
  139.           development project yourself.
  140.  
  141.           As for colors use , many colors that are used with the
  142.           VSTRING editor (or the default.str) are based on what the user
  143.           has configured as his user Default colors.  In the string
  144.           editor, %h is header color, %b is base color, %l is line color,
  145.           etc.  The sysop can make the color consistent by replacing the
  146.           %<letter> with the CTRL-C code for a color, so all users see the
  147.           SAME color.
  148.  
  149.           For further information on the VBBS External Strings Editor
  150.           and features, please participate in the discussions on the
  151.           various VirtualNET message bases.
  152.  
  153.