home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / v612docs.zip / VAH < prev    next >
Text File  |  1993-12-22  |  5KB  |  121 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.           For example, the following command calls a script if placed
  75.           on the string line:
  76.  
  77.           !<scriptname>
  78.  
  79.           The following command would call up a RIP graphic file:
  80.  
  81.           r<filename.rip>
  82.  
  83.           e.g. r145.rip  would call up rip menu 145 from the TXT
  84.           subdirectory.  In addition, a full path may be specified.
  85.           If none is supplied, the TXT subdirectory is assumed.
  86.  
  87.  
  88.           The following command would call up a screen, and is similar
  89.           to the echofile command:
  90.  
  91.           @ <filename>
  92.  
  93.           The function will search your text subdirectory for a filename
  94.           with a .mnu, .ans,.asc, or .rip extension. Again, a full path
  95.           may be stipulated.
  96.  
  97.           The default text string source file is DEFAULT.S. The VSTRING
  98.           editor/compiler can edit this file, and compiles it into a
  99.           DEFAULT.STR file, which the software reads when it loads nad
  100.           executes.  Both DEFAULT.S and DEFAULT.STR reside in the TXT
  101.           sub-directory, and must exist.  You may add other languages,
  102.           dialects, board layouts, etc., as needed by creating more
  103.           .S files (ie GERMAN.S, SPANISH.S, SERIOUS.S, FUNNY.S, INSULTS.S).
  104.  
  105.           The multi-language files should be included in a LANGUAGE.CFG
  106.           file and place in your main VBBS directory.  The file itself
  107.           is a simple Ascii file with one entry per line, such as:
  108.  
  109.           GERMAN.1
  110.           FRENCH.2
  111.           SPANISH.3
  112.  
  113.           Pre-compiled language files will be made available as they
  114.           are developed, and you are encouraged to participate in this
  115.           development project.
  116.  
  117.           For further information on the VBBS External Strings Editor
  118.           and features, please participate in the discussions on the
  119.           various VirtualNET message bases.
  120.  
  121.