home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 9 / FreshFishVol9-CD2.bin / bbs / util / columns-2.6.lha / Columns / CTED.doc < prev    next >
Text File  |  1993-12-21  |  6KB  |  169 lines
  1.  
  2.  **************************************************************************** 
  3. ******************************************************************************
  4. **                                                                          **
  5. **                       Conversion Table EDitor 1.3                        **
  6. **                                                                          **
  7. **                                                                          **
  8. **                     (c) 1993 MJSoft System Software                      **
  9. **                                                                          **
  10. **                                    -                                     **
  11. **                                                                          **
  12. **                              Martin  Mares                               **
  13. **                                                                          **
  14. **                                   and                                    **
  15. **                                                                          **
  16. **                              Tomas Zikmund                               **
  17. **                                                                          **
  18. ******************************************************************************
  19.  **************************************************************************** 
  20.  
  21.  
  22.    CONTENTS:
  23.    ---------
  24.  
  25.   1. Preview
  26.   2. System requirements
  27.   3. How to start CTED
  28.   4. The main window
  29.   5. The Convert utility
  30.   6. The conversion table format
  31.   7. Remarks
  32.  
  33.  
  34. 1. Preview
  35. ----------
  36.  
  37.    This utility allows you to define your own conversion tables for Columns
  38. and Convert (a small text conversion utility, which will be described later).
  39.  
  40.    Main features:
  41.  
  42.      - Written completely in assembly
  43.  
  44.      - Kickstart 2.0 and 3.0 compatible
  45.  
  46.      - Kickstart 2.0 look
  47.  
  48.  
  49.    CTED  and  its documentation is Copyright (c) Martin Mares & Tomas Zikmund,
  50. MJSoft System Software, Prague, Czech Republic.
  51.  
  52.    This  archive  can be freely redistributed, as long as all of its files are
  53. included   in   their  original  form  without  any  additions,  deletions  or
  54. modifications, and no more than a nominal fee is charged for its distribution.
  55. All  copyright  notices  in  the programs and accompanying documentation files
  56. must  remain  on  their places.  Also '.displayme' and other similar files may
  57. not be added.  This is generally known as FREEWARE.
  58.  
  59.    Special  permission is given to Fred Fish to distribute this program on his
  60. "Fish Disks".
  61.  
  62.    This  software  is  provided  "AS  IS" without warranty of any kind, either
  63. expressed  or implied.  The author is not responsible for any damage caused by
  64. it.
  65.  
  66.  
  67. 2. System requirements
  68. ----------------------
  69.  
  70.    This program requires:
  71.  
  72.       - Kickstart 1.2 or higher
  73.  
  74.       - Arp.library
  75.  
  76.       - Req.library
  77.  
  78.       - ReqTools.library (optional - if present, CTED uses it)
  79.  
  80.       - Some free memory
  81.  
  82.  
  83. 3. How to start CTED
  84. --------------------
  85.  
  86.    There are two ways to start CTED and pass it the parameters:
  87.  
  88.       - Start it from CLI
  89.  
  90.       - Start it from Workbench by doubleclicking its icon.
  91.  
  92.  
  93. 4. The main window
  94. ------------------
  95.  
  96.    If you start CTED, the main window will appear.
  97.  
  98.    This window contains:
  99.  
  100.       - A part of the conversion table with proportional gadget used for
  101.         scrolling.  This table has format "x (X) -> y (Y)", where X is the
  102.         character to be converted (x is its code) and Y is the character,
  103.         which will X be converted to (y is its code). One line of the table is
  104.         highlighted (displayed in inverse video). This is the active line,
  105.         which is being edited.
  106.  
  107.       - Two string gadgets named "Code" and "ASCII" used for editing the table
  108.         manually.
  109.  
  110.       - The LOAD gadget - loads a conversion table from specified file
  111.  
  112.       - The SAVE gadget - saves the conversion table to specified file
  113.  
  114.       - The INIT gadget - performs conversion table initialization
  115.  
  116.       - The DIFF gadget - performs differential scanning. You supply two files
  117.         (each maximally 256 bytes long). CTED will create a conversion table
  118.         saying each character in the first file will be converted to the
  119.         character found in the second file on the same position.
  120.  
  121.       - The SCAN gadget - performs "learning" scanning. You supply the file
  122.         you wish to convert and CTED will search for unrecognised characters
  123.         (characters, which are marked "without conversion" - (x -> x) and
  124.         are in range 128..255). File parts containing these characters will
  125.         be displayed with this character in boldface and other non-recognised
  126.         characters in italics. Then a colon will be displayed as a prompt and
  127.         you will have to enter one character. If you won't enter anything,
  128.         this line will be ignored and scanning will be continued. If you enter
  129.         ESCAPE, the scanning process will be aborted. If you enter some other
  130.         character, it will be written to the conversion table as a conversion
  131.         for that unknown character. Question marks ('?') are displayed instead
  132.         of unprintable characters.
  133.  
  134.  
  135. 5. The Convert utility
  136. ----------------------
  137.  
  138.    Convert  is  a  small  command-line  utility (can be called only from CLI),
  139. which performs a text file conversion.  This utility requires the arp.library.
  140.  
  141.    Arguments:
  142.  
  143.       TABLE - specifies the conversion table you wish to use
  144.  
  145.        FROM - specifies the source file
  146.  
  147.          TO - specifies the destination file. If you omit this name, the
  148.               output will be written back to the source file.
  149.  
  150.         BUF - (not needed) - specifies I/O buffer size (default is 32768)
  151.               If you process longer files, larger values of this parameter
  152.               can increase speed of the operation.
  153.  
  154.    Characters converted to 0x00 will be removed from the output file.
  155.  
  156.  
  157. 6. The conversion table format
  158. ------------------------------
  159.  
  160.    The conversion table file contains one byte for each possible character
  161. code (its size is 256 bytes). This byte contains the character which the
  162. original character will be converted to.
  163.  
  164.  
  165. 7. Remarks
  166. ----------
  167.  
  168.    Send your comments, suggestions and bug reports to mjsoft@k332.feld.cvut.cz.
  169.