home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR8 / TEXTUTIL.ZIP / TEXTUTIL.DOX next >
Text File  |  1993-10-25  |  5KB  |  123 lines

  1. HOW TO RUN TEXTUTIL:
  2. (References herein to ABZ are for an editing program I have been working on. A version is on PC-OHIO BBS and an upgrade is on its way.)
  3.  
  4. Type TEXTUTIL on the DOS command line and specify the files you will work with:
  5.  
  6.            textutil sourcefile outputfile 
  7.  
  8. and press <enter>.
  9.  
  10. Note there is a space between each word and that case doesn't matter.
  11. If you don't specify the files you want to work with, you'll be prompted to provide the filenames later.
  12.  
  13.  
  14. A menu appears:
  15. Press the appropriate letter to select
  16.        "a. Split file into chapters,"
  17.        "b. De-format files"
  18.        "c. Make a help file index."
  19.        "d. Convert all-caps file to proper-name style."
  20.  
  21. Press enter.
  22. If you typed a letter other than A, B, C or D, the program will end.
  23.  
  24.  
  25. SPLITTING A FILE:
  26. Type A or a. Press enter.
  27.  
  28. If you did not specify a source filename on the command line, you will be asked
  29. to provide one now.
  30.  
  31. TEXTUTIL does not need an output filename for this process.  It will add a numeral from 1 to 999 to the input filename, so that when it is finished, 
  32. you will have:
  33.  
  34. (from a monster called PROCOMM.LOG)
  35.           PROCOMM1.LOG
  36.           PROCOMM2.LOG
  37.           PROCOMM3.LOG
  38.           ... etc.
  39.  
  40. You will be prompted for the desired length, in thousands of bytes, of each
  41. chapter.  64 (32 screenfuls) is the maximum for TEXTUTIL.  If you plan to work with the documents extensively, you may want something shorter.
  42. The program will report its progress as it works.
  43. The original document is not affected.
  44.  
  45.  
  46. DE-FORMATTING A FILE:
  47.  
  48. Type b or B. Press Enter.
  49. A second menu asks for another choice.
  50.      a:  Strip Wordstar characters
  51.      b:  Remove excess spaces
  52.      c:  Remove line endings and excess spaces.
  53.  
  54. If you did not specify source and output filenames on the command line, you will be prompted to provide them now.  Be sure the output filename is not in use anywhere else in the current directory:  TEXTUTIL will not check before rewriting it, and you might lose something you wanted to save.
  55.  
  56. If you selected:
  57.  
  58. A: Remove Wordstar characters
  59.    TEXTUTIL will process the source file with no further ado.
  60.    Print, margin, and other commands in some documents will leave a few
  61.    characters of gibberish behind as they are converted to readable ASCII
  62.    characters.  Though named for Wordstar, the process will convert graphics
  63.    characters with code numbers higher than 127 in any file.
  64.  
  65. B: Strip out excess spaces
  66.    You will next be prompted for the width of tab indents if you want to
  67.    preserve the paragraphing in the original.
  68.   
  69.    If you don't know the width, you can quit TEXTUTIL by pressing Ctrl-C
  70.    this point.  The easiest way to check is to view the document with the
  71.    DOS command
  72.               TYPE filename
  73.    Press control-C again after a couple of paragraphs appear on your screen.
  74.    Then count the indent spaces and start TEXTUTIL over again.
  75.  
  76. C: Strip out excess spaces and line endings
  77.    After following the steps in B, TEXTUTIL removes line endings except those
  78.    it can recognize as paragraphs.  The program recognizes both indented 
  79.    and block paragraphs.  Block paragraphs are the style with no indent but 
  80.    a blank line between them.
  81.  
  82. Remaking the index:
  83.  
  84. OK, OK, you don't like the help screens.  So rewrite them.  You may have up to 36 screens.  These instructions will also allow you to reindex a help file you trashed by reading it in ABZ.
  85.  
  86. Step 1: Rename the original HELPTXT.TXT. It will be your source file. Then make
  87.         a copy of it to save, just in case.
  88. Step 2: Call up the new source file in ABZ.
  89.         Delete the spaces and odd characters up to the beginning of the text.
  90.         That's the index; you don't want to make it part of a help screen.
  91. Step 3: Make your editing changes. 
  92. Step 4: Each screen must begin with a caret: ^. Put an additional one at the
  93.         end of the last screen.
  94. Step 5: Save your work.  Quit ABZ.
  95. Step 6: Run TEXTUTIL, specifying your edited file as the source file and 
  96.         HELPTXT.TXT as the output file:
  97.                 textutil myhelp helptxt.txt
  98. Step 7: Select C from the initial menu.  The program will do the rest.
  99.  
  100. -- TEXTUTIL searches the text for ^ characters and records their position in
  101.    the file.  When it finishes processing, it writes the positions into a space
  102.    it makes at the top of HELPTXT.TXT.  The help feature of ABZ reads
  103.    the index and is then able to skip directly to the appropriate page in the
  104.    file when you press F1 and choose a topic.
  105. -- The ^ characters are not saved.
  106. -- Pages are limited to 2,000 characters, approximately a screenful.
  107.  
  108. Convert all-caps text.
  109.  
  110.    Rather an esoteric function, it's useful in working
  111.    with borrowed mailing lists.   Use it the same way as the Wordstar function     under de-formatting.
  112.  
  113.  
  114. WHOM TO CALL
  115.      This is freeware.  It is offered without charge to interested users,
  116.      at the user's own risk.
  117.  
  118.      All other rights are reserved.
  119.  
  120. I m Peter Zicari; leave messages for me at Compuserve 71760,2575 or on the 
  121. PC-OHIO BBS, 216-381-3320.  
  122.  
  123.