home *** CD-ROM | disk | FTP | other *** search
/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / STRCOM.ZIP / STRCOM.DOC next >
Text File  |  1993-02-02  |  5KB  |  117 lines
  1. ≡ STRCOM 1.1 ■ Freeware external string compiler for WWIV 4.22
  2.  
  3. This archive should contain the programs STRCOM.EXE and STRDEC.EXE.  Strcom
  4. will convert a text file with one string per line into a 4.22 format
  5. external string file.  Strdec (de-compiler) does the opposite.
  6.  
  7. Advantages of STRCOM: You can use any text editor to create your input files.
  8. Adding new strings is simply a matter of putting blank lines at the end.
  9. I believe that editing the strings in a text file is the superior method, as
  10. you can simply open up another window in the Borland C editor and make the
  11. changes while you work on the source, rather than shelling out to run
  12. ESM/MINIESM.
  13.  
  14. ≡ Compatibility
  15.  
  16. This is meant to be used only with WWIV 4.22.  The files produced are
  17. identical to the formats used by ESM and MINIESM.  A three-byte header
  18. (255, 255, length) opens the file, followed immediately by the data.
  19.  
  20. The previous version of STRCOM (1.0) will not work with 4.22, as it does not
  21. produce the 4.22 header. It produces files in the format of ESM 1.4.  The
  22. version in this archive is 1.1, meant for WWIV 4.22.  Please remove the older
  23. version from your download directory, to prevent confusion with the current
  24. one.
  25.  
  26. ≡ STRCOM Usage
  27.  
  28.  STRCOM infile.txt outfile.str [-Lxxx] [-E]
  29.  
  30.  STRCOM will process a text file with one string per line and write a
  31.  file suitable for use as an external string database.  The absolute
  32.  length of the strings can be specified on the command line with the
  33.  -L parameter.  (The default length is 100, which is the length used
  34.  by Random in the ENGLISH.STR file included with 4.22).
  35.  
  36.  If the -E switch is specified, the following translations take place:
  37.  
  38.    \n    : linefeed                        \r   : return
  39.    \\    : backslash                       \c,\3: color symbol
  40.    \_, \#: space                           \b   : backspace
  41.  
  42.  Other characters, such as ESC and upper-128 graphics (║─═╔≡■) can be
  43.  placed in the text file, so translations are unnecessary.
  44.  
  45. (The program runs significantly faster without '-E.'  Use it only if you must
  46. embed linefeeds, as most other special characters can exist in the text file)
  47.  
  48. ≡ STRDEC Usage
  49.  
  50. The string file provided with 4.22 was already in compiled format.  It is
  51. necessary to convert it to a text file so that it may be edited.  STRDEC
  52. does this- it is invoked as "STRDEC infile.str outfile.txt".  The length
  53. is read from the header of the string file, and no translations are performed
  54. (as there are no special characters in Random's file that cannot exist in a
  55. text file.)  You only need to execute this program once, when converting a
  56. string file you received from someone else into a strcom-compatible input
  57. file.
  58.  
  59. ≡ Spaces at the end of lines.
  60.  
  61. Most editors, including Q and the BC++ editor, remove spaces at the ends of
  62. lines.  However, it is often necessary to leave these in - for example,
  63. if this is not done, there may be lines like
  64.  
  65. Starship Trooper #1 @2750 read your mail on01/30/93
  66.  
  67. (Notice there is no space between 'on' (the end of an external string) and
  68. the date).  To prevent this problem, it is necessary to embed a space in
  69. the input text file.  This can be done with the -E switch as
  70.  
  71.  read your mail on\_
  72.  
  73. However, the -E switch slows the program.  Another way is to put a real space
  74. there, and follow with color-change codes.  That way, the editor will not
  75. strip the space, because it does not end a line.
  76.  
  77.  read your mail on 1
  78.  
  79. (Note that you change color with control-C digit, which appears as heart-digit.
  80.  This is done the same way you would do it in the source, by pressing the
  81.  ALT-3, or by pressing your editor's quote character (usually ^P) and then
  82.  ^C)
  83.  
  84. ≡ AUTOMATIC UPDATING OF STRING FILES:
  85.  
  86.  You can use Borland's MAKE utility to automatically update the string file
  87.  while compiling the bbs.  It will check to see if your string data file
  88.  is older than the text file, and will compile if true.  For each file
  89.  you want automatically compiled, place lines like these in MAKEFILE.MAK:
  90.  
  91. english.str: english.txt
  92.   strcom english.txt english.str [-Lxxx] [-E]
  93.  
  94.  I placed it just after the section describing BBS.COM, and it works fine.
  95.  
  96. ≡ Warranty
  97.  
  98. There is none.  All I can say is, "it works for me."  I suggest you make
  99. backup copies of your files first.
  100.  
  101. ≡ Distribution and freeware notice
  102.  
  103. STRCOM, STRDEC, and this text file may be freely used and distributed
  104. in unmodified form.  This software is completely free; however, I'd
  105. appreciate email from people using it, just so I know there are people
  106. who would be interested in future versions.
  107.  
  108. ≡ Disclaimers, copyright notices, etc.
  109.  
  110. WWIV is Copyright 1988-1993 by Wayne Bell.
  111. ESM  is Copyright 1990-1993 by Jon R. Rickher
  112.  
  113. STRCOM supplements WWIV and is meant to be used only by registered usersof WWIV.
  114. This program is not "official" or "endorsed" in any way.
  115.  
  116.  STARSHIP TROOPER 1@2750/12754
  117.