home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d5xx / d535 / accent.lha / Accent / Accent.doc < prev    next >
Text File  |  1991-08-26  |  14KB  |  270 lines
  1.                         Accent v1.1 *** July 1991
  2.                         ~~~~~~~~~~~~~~~~~~~~~~~~~
  3.               An universal accented character converter
  4.  
  5.         This program can be freely redistributed, but it
  6.         must be bundled with its documentation files.
  7.  
  8. Accent is an improved version of Vortex (Fred Fish no. 454), fitted with a
  9. file requester, a simple file reader, and a mouse-driven interface, The name
  10. was changed because "Vortex" was already taken. Accent was developed in C on
  11. the Amiga, then ported to the PC with Quick C (DOS-only version). 
  12.  
  13. Accent will convert all accented characters common to a pair of computers
  14. (Amiga <-> IBM-PC, Amiga <-> MacIntosh or IBM-PC <-> Mac). Unfortunately,
  15. not all accented characters are convertible because some computers have an
  16. incomplete set of accented capitals; did you know that only the Amiga offers
  17. a complete set of lower and upper case accented characters for most european
  18. languages? Naturally, only common characters can be converted from one
  19. computer to another. For conversions to and from the IBM-PC, Accent assumes
  20. that the extended character set (Code 850) is used, although this many PCs
  21. use Code 863 or 437, which comprise only a few accented capitals (É, Ç and
  22. Ü). Then, the user may get some graphic characters and mathematic symbols
  23. instead of certain accented capitals... On the Mac side, some fonts like
  24. Times and Helvetica offer a complete set of accented capitals, but most of
  25. them are not implemented on "City" fonts (New York, Chicago...). Accent
  26. assumes that the former are used.
  27.  
  28.     The standard ASCII set (0-127), true to its american origin, ignores
  29. accented characters. This is too bad, because there are only two latin
  30. alphabet languages without accents: English and ... Dutch. So, accented
  31. characters had to be patched up, and the result was called "extended ASCII
  32. set" (128-255). Good idea, but every computer came up with its own standard!
  33. Commodore implemented the international convention codes on the Amiga, but
  34. was the only one to do so (nice shot anyway, Commodore). In a nutshell,
  35. Accent will work for all languages provided with a keymap (Danish, Finnish,
  36. French, German, Italian, Islandic, Norwegian, Spanish, Swedish), and any
  37. other language using only "standard" accents (acute, grave and circumflex
  38. accents, plus the tilde and the dieresis), that is, most west european
  39. languages, and some others with other characters, e.g. the scandinavian
  40. languages.   
  41.  
  42. NOTE: Accent converts files, but not the diskette format. It won't read
  43. IBM, Mac or C64 diskettes. You have to copy the file to be processed on an
  44. Amiga disk. To do so, you can use utilities like Mac Link (PC <-> Mac),
  45. DOS2DOS, CrossDOS or MessyDOS (Amiga <-> IBM), Mac2DOS or File Transfer
  46. (Amiga <-> Mac), or Transfer (C64 <-> Amiga), with appropriate disk units.
  47. You can also use a modem. Accent does not replace any of the
  48. above-mentionned utilities, but merely complements them.
  49.     
  50. Without Arp.library, Acent will run from the CLI only. If you don't already
  51. have it in your libs: drawer, copy it by double-clicking the ArpLibInstall
  52. icon (18K free space needed). Icon.library is also needed, so boot from a
  53. standard Workbench. Accent is garanteed to work with both Workbench 1.3 and
  54. 2.0 (Color-corrected for the Amiga 3000).
  55.  
  56. USAGE (from the Workbench): 
  57. ==========================
  58. Double-click on the icon. Extended icon selection is possible: while holding
  59. Shift, select the Accent icon and double-click the source text file icon,
  60. or vice-versa.
  61.  
  62. A) Source file to convert: (Keyboard shortcut: Right-Amiga-O)
  63.    ~~~~~~~~~~~~~~~~~~~~~~  
  64. Click the Open submenu to select the file to convert, and an Arp file
  65. requester will pop up. 
  66.  
  67. B) Destination file:       (Keyboard shortcut: Right-Amiga-D)
  68.    ~~~~~~~~~~~~~~~~
  69. Then, the default destination file name is shown in the Destination box;
  70. Accent creates it by appending the ".ax" extension to the source file name.
  71. The default file path is to ram: to speed up the conversion, but you may
  72. send it to any disk. You may enter a different name with the Arp requester
  73. (called by the Destination submenu), or write it directly into the box.
  74.  
  75. C) Direction and Options:
  76.    ~~~~~~~~~~~~~~~~~~~~~
  77. Select the appropriate Direction and Option with the » « buttons.
  78. * CR/LF conversion is automatic, but manual override is possible.
  79. * Tabs are not converted if the Tab box is empty or displays a zero.
  80.  
  81. D) Conversion:
  82.    ~~~~~~~~~~~
  83. Click "O.K." to generate a converted destination file. The source file is
  84. unchanged by the process.
  85.  
  86. E) Reading a file:
  87.    ~~~~~~~~~~~~~~
  88. You may then click the "Read" button to check the converted file.
  89. * This button may also be used to display any file anytime.
  90. * Click the mouse or press the DOWN cursor to scroll down a file.
  91. * Display width is limited to 80 characters. 
  92.  
  93. F) Notes:
  94.    ~~~~~
  95. * MS-DOS file names are limited to 8 characters, plus an optional 3-
  96.   character extension. Any extra character will be left out.
  97. * Use the ASCII->WP4 option for WP 4.2 only (WP 5 can load accented ASCII
  98.   files without problem). 
  99. * To speed up conversion, the default destination path is to ram:.
  100.   You may then copy that file from ram: to your disk (see below).
  101. * To copy any file anywhere, select the "Copy" submenu. Both Direction and
  102.   Option are set to "No Conv.". The Tab box must be empty or set to zero.
  103. * To change only tabs or format (ASC->WP) and not accents, set Direction
  104.   to "No Conv." To convert CR/LF only, a Direction must be provided (ex.
  105.   Ami->IBM), and Option must be set to "No Conv.".
  106. * Hit Right-Amiga X to clear any box and R-Amiga Q to undo.
  107. * Click the Iconify gadget (in the upper right corner) to close the window, 
  108.   and double-click the iconify icon to re-open it. This icon can be dragged 
  109.   on any part of the screen.
  110.  
  111. PRESELECTION OF DEFAULT VALUES
  112. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  113. You may change the startup values by editing the Tool Types box of the icon
  114. (Workbench Icon submenu). For instance, FR=1 will change the default
  115. language (English) to French. Delete this entry to get English back. You may
  116. also enter any of the following parameters: AI=1, AM=1, IA=1, IM=1, MA=1,
  117. MI=1, CA=1, NC=1, WP=1, AW=1, SL=1 (or SL=0), TB=4 (or any integer smaller
  118. than 20), to open Accent with the Direction or Option you want (more
  119. information about these parameters below).
  120. Note: No spaces or lower case allowed in the Tools Types.
  121.  
  122. USAGE (from the CLI): 
  123. ====================
  124.   Accent source_file [destination_file] -direction [-option -option...]
  125.   accent ?    this help screen
  126. where:
  127.      DIRECTION:       | -ai/-ia:  Amiga  -> IBM-PC /or vice versa
  128.      choose one from: | -am/-ma:  Amiga  -> Mac /or vice versa
  129.                       | -im/-mi:  IBM-PC -> Mac /or vice versa
  130.                       | -ca:      C64(Traitex) -> Amiga
  131.                       | -nc:      No accent conversion
  132.               
  133.      OPTIONS:         -wp:      Word Perfect source file
  134.      [optional]       -aw:      ASCII -> Word Perfect
  135.                       -sl/-sl0: Converts line feeds /or keeps them
  136.                       -tx:      Replace tabs by x spaces
  137.  
  138. Source and Destination Files:
  139. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  140. Parameters between braces are optional; if no destination file name is
  141. given, Accent will create one by appending ".ax" to the source file name
  142. (thus, "yuck" gives "yuck.ax"). On the IBM side, only 8-character file names
  143. with an optional 3-character extension are accepted. Any extra character
  144. will be truncated. If your source file name already has an extention, a
  145. distinct destination file name must be specified. Moreover, any of the first
  146. three parameters (prefixed by a dash) may include an AmigaDOS path: thus, 
  147.     1> accent  df1:texts/donald.doc  ram:daffy.doc -ai
  148. will read in the Amiga ASCII file "donald.doc" from the texts directory in
  149. df1: and create the converted Amiga ASCII file "daffy.doc" in ram:. ASCII
  150. file conversion selects -sl as default (-sl0 to override it). 
  151. Another example:
  152.     1> df1:c/accent myfile -ia -wp -t4
  153. will run Accent from df1:c and read the Word Perfect IBM file "myfile" in
  154. the current directory, where "myfile.ax" (Amiga WP file) will be created.
  155. Option -wp selects -sl0 as default. Note that in the above example, option
  156. -t4 will convert tabs to 4 spaces.
  157.  
  158. NOTE: * To speed up a conversion, copy your source file to ram:. Accent     
  159.         is quite fast: it can convert a 40K file in 10 seconds or less.     
  160.       * The following command lines: 1> accent source_file 
  161.                                      1> accent source_file dest_file
  162.         are accepted and open the window just like clicking the icon.
  163.       * Any command line "-f" will open the window with a French display.
  164.  
  165. Direction and Options: 
  166. ~~~~~~~~~~~~~~~~~~~~~ 
  167. The following parameters (direction and options) must be preceded by a dash
  168. and they can be in any order or number. You may use many options, or none,
  169. but you have to use one (and only one) direction. Remember: one direction is
  170. needed, but options are... well, optional. If two parameters give opposite
  171. results (ex. -sl and -sl0), the last one prevails.
  172.  
  173. Directions: -ai -am -ia -im -ma and -mi:
  174. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  175. The first letter designates the source computer and the second one,
  176. the destination computer. Thus, -ai means Amiga -> IBM-PC. 
  177. NOTE: ASCII files exported to the Mac should not be loaded in MacWrite,     
  178.       which uses its own format for text files. MS Word, which uses  ASCII  
  179.       files, is a better choice.
  180.  
  181. Direction -ca: 
  182. ~~~~~~~~~~~~~ 
  183. Accent will also convert Traitex files (Commodore 64/128) to Amiga files
  184. (ASCII or WP). This is a special case because every C64 word processor uses
  185. its own codes for the accents... Option -ca can convert with unequal success
  186. other C64 files using screen codes, like PaperClip or Scripsit files, but
  187. not PETSCII files. (If you don't know what they are, you don't need to read
  188. this in the first place). Note that the -ca direction ignores all the
  189. options below except -aw.
  190.  
  191. Direction -nc:
  192. ~~~~~~~~~~~~~
  193. With option -nc, source accented characters are left unconverted. This
  194. option is used with options -aw, -sl and -tx (below) to change only the file
  195. format, the line feeds or the tabs without changing the accents.
  196. Example:            1> accent  mystuff  -nc  -aw 
  197. will convert an Amiga ASCII file to an Amiga WP file.
  198. Another example:    1> accent  ram:myletter  df0:myletter -ai  -nc
  199. This line uses Accent as a simple file copier. Nothing is changed.
  200. One more example:   1> accent  blurp  -nc -t4 
  201. This line will only replace all the tabs by 4 spaces in blurp.ax.
  202. Another example:    1> accent  mytext -nc -ai  -sl
  203. This line will change the LF to CR+LF in mytext.ax, and nothing else.
  204. Please note that this operation requires *two* directions, the second
  205. direction beeing needed for the right CR/LF conversion.
  206.  
  207. Option -wp: 
  208. ~~~~~~~~~~ 
  209. Option -wp converts Word Perfect files from one computer to another. Why
  210. Word Perfect? Because it's the only word processor implemented on 4
  211. different machines (this, in turn, creates a  need for Accent). Besides,
  212. it's my favorite word processor... Please note that with other word
  213. processors, you should save your files with the ASCII (or Text) option
  214. before feeding them to Accent if a straight file conversion does not work.
  215.  
  216. Accent can also convert ASCII files to WP files (option -aw), but not the
  217. reverse, because the "Save Text File" option in Word Perfect already does
  218. that. Likewise, Accent can create WP 4.2 files (and not WP 5.x files) from
  219. ASCII files because WP 5.x already accepts and converts WP 4.2 files. In
  220. short, I kept Accent streamlined and fast by restricting its options to
  221. those not already provided by Word Perfect. 
  222.  
  223. Option -aw: 
  224. ~~~~~~~~~~ 
  225. To convert an ASCII file to a WP 4.2 file, use option -aw. This option was
  226. implemented because WP 4.2, unlike WP 5.x,  will not load correctly an ASCII
  227. file with accented characters. Try it and see what I mean. Option -aw
  228. selects -sl0 as default. The file format may be slightly disturbed, but at
  229. least, every word is displayed. 
  230.  
  231. Options -sl and -sl0: 
  232. ~~~~~~~~~~~~~~~~~~~~ 
  233. Accent can also convert the line feed character(s), which vary for each
  234. computer. (simple line feed (LF) for the Amiga, carriage return + line feed
  235. (CR + LF) for the PC and simple carriage return (CR) for the Mac). Option
  236. -sl is chosen by default for ASCII file conversions (-sl0 will cancel it),
  237. and option -sl0 is selected with -wp and -aw options.
  238.  
  239. Option -txx 
  240. ~~~~~~~~~~~ 
  241. Accent can also convert tabs to spaces (1-20), which is handy for texts that
  242. have been formatted with non standard tab values (telltale sign: when you
  243. see a scrambled text on your screen). Normally, a tabulation character
  244. stands for 8 spaces (ASCII) or 5 spaces (WP). Give it a few tries and you
  245. will become an ace text straightener (and eventually get hired as a ghost
  246. writer for some politician).
  247.  
  248. Calling Accent from another program 
  249. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  250. You can program Accent with all the options you need with batch files,
  251. macros, hot keys or in a directory utility like Disk Master or SID. With DM,
  252. all you need is the line: c:accent %s -ai -wp to convert a WP file from
  253. Amiga to IBM. Two mouse clicks and look what happens: a cute .ax file
  254. appears in the file requester.
  255.  
  256.  
  257.     Any comment is welcome. 
  258.                                                      
  259.                                                 Michel Laliberté
  260.                                                 875, avenue Dollard
  261.                                                 Outremont, Québec
  262.                                                 Montréal, H2V 3G8 
  263.  
  264. Bugs & Updates: 8-)
  265. ~~~~~~~~~~~~~~
  266.     I may add a fully configurable character set, with Load and Save buttons,
  267.     if you users ask for it. No known bugs; please notify me if you find one.
  268.  
  269.                                                 ||\/| ||_
  270.