home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / fish / translators / vortex / vortex.doc < prev    next >
Text File  |  1991-02-14  |  9KB  |  183 lines
  1.                         Vortex v1.5
  2.                         ~~~~~~~~~~~
  3.               An universal accented character converter
  4.  
  5.     Vortex will convert all accented characters common to a pair of
  6. computers (Amiga <-> IBM-PC, Amiga <-> MacIntosh or IBM-PC <-> Mac).
  7. Unfortunately, not all accented characters are convertible because some
  8. computers have an incomplete set of accented capitals; did you know that
  9. only the Amiga offers a complete set of lower and upper case accented
  10. characters for most european languages? Naturally, only common characters
  11. can be converted from one computer to another. For conversions to and from
  12. the IBM-PC, Vortex assumes that the extended character set is used, although
  13. this may not be the case for older PCs that use the standard set, which is
  14. much poorer (only 5 accented capitals). Then, the user may get some graphic
  15. characters and mathematic symbols instead of certain accented capitals...
  16.  
  17.     The standard ASCII set (0-127), true to its american origin, ignores
  18. accented characters. This is too bad, because there are only two latin
  19. alphabet languages without accents: english and ... dutch. So, accented
  20. characters had to be patched up, and the result was called "extended ASCII
  21. set" (128-255). Good idea, but every computer came up with its own standard!
  22. Commodore implemented the international convention codes on the Amiga, but
  23. was the only one to do so (nice shot anyway, Commodore). In a nutshell,
  24. Vortex will work for all languages provided with a keymap (danish, finnish,
  25. french, german, italian, islandic, norwegian, spanish, swedish), and any 
  26. other language using only "standard" accents (acute, grave and circumflex
  27. accents, plus the tilde and the dieresis), that is, most west european
  28. languages, and then some.   
  29.  
  30. NOTE: Vortex converts files, but not the diskette format. It won't read
  31. IBM, Mac or C64 diskettes. You have to copy the file to be processed on an
  32. Amiga disk. To do so, you can use utilities like DOS2DOS, CrossDOS or
  33. MessyDOS (Amiga <-> IBM), Mac2DOS or File Transfer (Amiga <-> Mac), or
  34. Transfer (C64 <-> Amiga). You can also use a modem. Vortex does not replace
  35. any of the above-mentionned utilities.
  36.     
  37. USAGE (from the CLI): 
  38. ~~~~~
  39.    vortex  source_file  [destination_file]  -direction  [-options...]
  40. where:
  41.      DIRECTION:       -ai/-ia:  Amiga  -> IBM-PC /or vice versa
  42.      choose one:      -am/-ma:  Amiga  -> Mac /or vice versa
  43.                       -im/-mi:  IBM-PC -> Mac /or vice versa
  44.                       -ca:      C64(Traitex) -> Amiga
  45.               
  46.      OPTIONS:         -wp:      Word Perfect source file
  47.      [optional]       -aw:      ASCII -> Word Perfect
  48.                       -sl/-sl0: Converts line feeds /or keeps them
  49.                       -nc:      No accent conversion
  50.                       -tx:      Replace tabs by x spaces
  51.  
  52. Source and Destination Files:
  53. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  54. Parameters between braces are optional; if no destination file name is
  55. given, Vortex will create one by appending ".vx" to the source file name
  56. (thus, "yuck" gives "yuck.vx"). Moreover, any of the first three parameters
  57. may include an AmigaDOS path: thus,   
  58.  
  59.     1> vortex  df1:texts/donald.doc  ram:daffy.doc -ai
  60.  
  61. will read in the Amiga ASCII file "donald.doc" from the "texts" directory in
  62. df1: and create the converted Amiga ASCII file "daffy.doc" in ram:. ASCII
  63. file conversion selects -sl as default (-sl0 to override it). Another
  64. example:
  65.  
  66.     1> df1:c/vortex myfile -ia -wp -t4
  67.  
  68. will run Vortex from df1:c and read the Word Perfect IBM file "myfile" in
  69. the current directory, where "myfile.vx" (Amiga WP file) will be created.
  70. Option -wp selects -sl0 as default. Note that in the above example, option
  71. -t4 will convert tabs to 4 spaces.
  72.  
  73. NOTE: To speed up a conversion, copy your source file to ram:. Vortex is
  74. quite fast: it can convert a 40K file in 10 seconds or less. No wonder:it is
  75. written in C.
  76.  
  77. Direction and Options: 
  78. ~~~~~~~~~~~~~~~~~~~~~ 
  79. The following parameters (direction and options) must be preceded by a dash
  80. and they can be in any order or number. You may use many options, or none,
  81. but you have to use one (and only one) direction. Remember: one direction is
  82. needed, but options are... well, optional. If two parameters give opposite
  83. results (ex. -sl and -sl0), the last one prevails.
  84.  
  85. Directions: -ai -am -ia -im -ma and -mi:
  86. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  87. The first letter designates the source computer and the second one,
  88. the destination computer. Thus, -ai means Amiga -> IBM-PC. 
  89.  
  90. Direction -ca: 
  91. ~~~~~~~~~~~~~ 
  92. Vortex will also convert Traitex files (Commodore 64/128) to Amiga files
  93. (ASCII or WP). This is a special case because every C64 word processor uses
  94. its own codes for the accents... Option -ca can convert with unequal success
  95. other C64 files using screen codes, like PaperClip or Scripsit files, but
  96. not PETSCII files. (If you don't know what they are, you don't need to read
  97. this in the first place). Note that the -ca direction ignores all the
  98. options below except -aw.
  99.  
  100. Option -wp: 
  101. ~~~~~~~~~~ 
  102. Option -wp converts Word Perfect files from one computer to another. Why
  103. Word Perfect? Because it's the only word processor implemented on 4
  104. different machines (this, in turn, creates a  need for Vortex). Besides,
  105. it's my favorite word processor... Please note that Prowrite, Excellence and
  106. Brand X users should save their files with the ASCII (or Text) option before
  107. feeding them to Vortex if straight file conversion does not work.
  108.  
  109. Option -aw will convert ASCII files to WP files, but not the reverse,
  110. because the "Save Text File" option in Word Perfect already does that.
  111. Likewise, Vortex creates WP 4.2 files (and not WP 5.x files) from ASCII
  112. files because WP 5.x accepts and converts WP 4.2 files. In short, I kept
  113. Vortex streamlined and fast by restricting its options to those not already
  114. provided by Word Perfect. 
  115.  
  116. Option -aw: 
  117. ~~~~~~~~~~ 
  118. To convert an ASCII file to a WP file, use option -aw. This option was
  119. implemented because WP will not load correctly an ASCII file with accented
  120. characters. Try it and see what I mean. Option -aw selects 
  121. -sl0 as default. The file format may be slightly disturbed, but at least,
  122. every word is displayed. 
  123.  
  124. Options -sl and -sl0: 
  125. ~~~~~~~~~~~~~~~~~~~~ 
  126. Vortex can also convert the line feed character(s), which vary for each
  127. computer. (simple line feed (LF) for the Amiga, carriage return + line feed
  128. (CR + LF) for the PC and simple carriage return (CR) for the Mac). Option
  129. -sl is chosen by default for ASCII file conversions (-sl0 will cancel it),
  130. and option -sl0 is selected with -wp and -aw options.
  131.  
  132. Option -nc:
  133. ~~~~~~~~~~
  134. With option -nc, source accented characters are left unconverted. This
  135. option is used with options -aw, -sl and -tx (below) to change the file
  136. format, the line feeds or the tabs without changing anything else.
  137.  
  138.     example:          1> vortex  mystuff  -ai  -nc  -aw 
  139.  
  140. will convert an Amiga ASCII file to an Amiga WP file. Note that direction 
  141. -ia, cancelled by -aw, is a bogus valus, but it has to be there to enable
  142. the ASCII -> WP conversion process.
  143.  
  144.     other example:    1> vortex  ram:myletter  df0:myletter -ai  -nc
  145. This line uses Vortex as a simple file copier. Nothing is changed.
  146.     other example:    1> vortex  mytext  -ai  -nc  -sl
  147. This line will change the LF to CR+LF in mytext.vx, and nothing else.
  148.     one last example: 1> vortex  blurp  -am  -t4 -nc
  149. This line will only replace all the tabs by 4 spaces in blurp.vx.
  150.  
  151. Option -txx 
  152. ~~~~~~~~~~~ 
  153. Vortex can also convert tabs to spaces (1-20), which is handy for texts that
  154. have been formatted with non standard tab values (telltale sign: when you
  155. see a scrambled text on your screen). Normally, a tabulation character
  156. stands for 8 spaces (ASCII) or 5 spaces (WP). Give it a few tries and you
  157. will become an ace text straightener (and eventually get hired as a ghost
  158. writer for some politician).
  159.  
  160. How to use with a mouse 
  161. ~~~~~~~~~~~~~~~~~~~~~~~
  162. Vortex is a CLI-only command, but it comes with an icon on this disk. 
  163. Double-clicking on "XVortex" launches a Xicon-driven batch file that opens
  164. a CLI ("endcli" to exit) and prints the instructions. If you copy XVortex to
  165. another disk, make sure that Vortex itself is copied, and don't forget
  166. to copy Xicon in your disk's c: directory.
  167.  
  168. You can program Vortex with all the options you need with batch files, WP
  169. macros, hot keys or in a directory utility like Disk Master or SID. With DM,
  170. all you need is the line: c:Vortex %s -ai -wp to convert a WP file from
  171. Amiga to IBM. Two mouse clicks and look what happens: a cute .vx file
  172. appears in the file requester.
  173.  
  174.  
  175.     Any comment is welcome. 
  176.                                                      
  177.                                    Michel Laliberté
  178.                                    Montréal, February 1991 
  179.  
  180. NOTE: ASCII files exported to the Mac should not be loaded in MacWrite,     
  181.       which uses its own format for text files. MS Word, which uses ASCII   
  182.       files, is a better choice.
  183.