home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / utilities / utilst / wombat / !Wombat / !Help < prev    next >
Text File  |  1994-01-10  |  10KB  |  206 lines
  1.  
  2.                                ======
  3.                                Wombat
  4.                                ======
  5.                             Version 0.26
  6.  
  7.                         © Peter Gaunt, 1993
  8.  
  9.                            Copyright notice
  10.                            ================
  11.      No part of this program is in the public domain though it may be
  12.       freely distributed provided no charge (other than to cover the
  13.                  cost of the medium and postage) is made.
  14.  
  15.      Folks running public domain libraries should seek my permission if
  16.      they want to put it on their lists. Similarly, publications wishing
  17.      to include it on cover discs or the like should seek my permission.
  18.  
  19.  
  20.  
  21.                      Wombat needs RISC OS 3.10 or later.
  22.  
  23.  
  24.  
  25.          Folks with earlier versions of this program should delete or
  26.         move the older version before installing this one. Some of the
  27.            files have changed their names and you could end up with
  28.       both old and new versions loaded if you simply install this version
  29.                            on top of the old.
  30.  
  31.         This program is a conversion of a BASIC which I put together a
  32.       while back, which was distributed to a select few people. It uses
  33.          the same table files as later versions of the BASIC program.
  34.     Wombat is my first C program of any consequence and was compiled with
  35.      RISC Developments Easy C compiler and uses the DeskLib WIMP library.
  36.  
  37.           This version is (I hope) functionally the same as previous
  38.         versions except that it can't use RAM transfer for loading files
  39.        from other applications (it always uses the scrap file mechanism as
  40.         I haven't yet got round to converting the RAM transfer parts of my
  41.                             BASIC library into C).
  42.  
  43.  
  44. Wombat is a simple utility which attempts to convert Latin 1 text files from
  45. the Acorn A-series machines into PC ("ANSI") format (the standard character
  46. set used on PCs not running Windows), Mac format or Windows text files. It
  47. can also be used to translate from these formats to Latin 1. (See
  48. "Limitations and points to note", below, for info on the terminology used.)
  49.  
  50. When run the program installs a somewhat naff icon on the icon bar.
  51.  
  52. The file which you wish to translate must have its type set to "Text".
  53.  
  54. To translate the file drop it onto the Wombat icon. The file will be loaded
  55. into the program's memory and a dialogue box will open. Wombat will accept
  56. text files dragged to it directly from other applications.
  57.  
  58. Click on the menu icon to the right of the conversion type icon. A list of
  59. available conversion types will appear. Click on the conversion which you
  60. wish to make. Wombat makes no attempt to determine the origin of the input
  61. file. The list of conversion types is also available on the icon bar menu.
  62.  
  63. Under the conversion type icon is an option icon labelled "Output control
  64. chars". If this is NOT selected then any characters from the input file
  65. (apart from Returns or Line feeds) which translate into a control character
  66. will not be added to the output file. This icon exists because in the PC
  67. character set some control characters are normally printable but there may
  68. be some applications which don't like them; I've not come across any but you
  69. never know...
  70.  
  71. Once you've set up the translation type, enter the name of the output file
  72. into the writeable icon and drag the text icon to a directory window. The
  73. file will be translated and saved. Any apparently untranslateable characters
  74. will be replaced with "#". The characters used to mark ends of lines are
  75. also translated. Files can be saved directly to other applications; this
  76. uses the scrap file mechanism.
  77.  
  78. You can save your current settings as the default by selecting "Save
  79. settings" on the icon bar menu.
  80.  
  81. That's all there is to it.
  82.  
  83. Limitations and points to note
  84. ==============================
  85. Where a translation type lists as "Latin 1" this means Acorn's version of
  86. the Latin 1 alphabet. Any variations on this (such as the EFF versions) are
  87. listed as such.
  88.  
  89. Input files should contain nothing but straight text plus line end characters.
  90. Control characters in the input file (except for line endings) are normally
  91. replaced with "#", except where they translate into something printable.
  92.  
  93. Wombat assumes that Acorn text files use the Line Feed character for the ends
  94. of lines (or paragraphs), PCs use Return plus Line Feed and Macs use Returns.
  95. Wombat translates these as well as the printable characters.
  96.  
  97. Wombat treats RETURN characters in Acorn text files in the same way as it
  98. treats LINE FEEDs. This is because some RISC OS word processors (such as
  99. EasiWriter) save "soft" line breaks as RETURNs when documents are saved as
  100. text.
  101.  
  102. TAB characters in the input file are preserved in the output file so long
  103. as "Output control characters" is selected otherwise they are converted to "#"
  104. in the same way as other untranslatable characters.
  105.  
  106. Wombat assumes that the Acorn fonts you are using contain the same characters
  107. as the RISC OS 3 version of Trinity, Homerton & Corpus. Some RISC OS 2 fonts
  108. lack a few characters which are present in RISC OS 3. Some Public Domain
  109. fonts may also be missing some characters and may even have some in
  110. different places. See also the note below about Electronic Font Foundry
  111. fonts.
  112.  
  113. Sometimes characters in the input file may be translated into reasonable
  114. equivalents. For example, if the input file is Acorn format and the output
  115. file is PC then em-dashes are translated into minus signs since the PC
  116. character set doesn't include an em-dash. Another example, is that "OE"
  117. ligature characters in Latin 1 files are converted to "O" and "E" if the
  118. file is translated to PC format.
  119.  
  120. Accented characters in the input file are translated where possible. If the
  121. accented character doesn't exist in the output file's character set then the
  122. unaccented version is written instead.
  123.  
  124. For this version of Wombat a couple of extra tables have been added called
  125. "EFF Latin 1 to Mac" and "Mac to EFF Latin 1". These are for use when
  126. translating from an application where the text used an Electronic Font
  127. Foundry font or where you intend using an EFF font. These tables are
  128. necessary since when Acorn produced the fonts for RISC OS 3 they put some of
  129. the extension characters (such as the ellipsis) in different places to those
  130. which EFF already used for their fonts. Except for some of the character
  131. numbers 128 to 140 Acorn fonts are identical to EFF fonts. EFF fonts also
  132. contain some characters which don't exist in the Acorn fonts; the EFF tables
  133. translate these where possible.
  134.  
  135. This version also includes tables for converting between (Acorn) Latin 1
  136. and EFF Latin 1.
  137.  
  138. For the Mac translation the character set used is that for the Times font
  139. found on my machine at work. So far as I can tell all the Mac fonts on that
  140. machine have the same character set, although some of them (such as Chicago)
  141. are not complete.
  142.  
  143. Windows uses the Latin 1 character set with most characters in the same
  144. positions as on the Arc. The Acorn extensions (characters 128-159) don't
  145. exist in Windows 3.0, except for smart single quotes (which are in a
  146. different place and which Wombat translates). Further extensions may exist
  147. in Windows 3.1 but I've not yet been able to check.
  148.  
  149. Confusingly the Windows 3.0 manual refers to its "Latin 1" character set as
  150. "ANSI". While this may be strictly correct (I don't know) it is not what
  151. we normal mortals usually call ANSI. By "ANSI" normal mortals usually mean
  152. the standard (non-Windows) PC character set. Wombat avoids refering to ANSI
  153. in its window in order to avoid confusion.
  154.  
  155. If you're moving the resulting files to a Mac on a DOS disc then if you use
  156. Apple File Exchange to read the disc make sure all translation options are
  157. off. Far better to have something like AccessPC installed on the Mac. Do not
  158. give the file a ".TXT" extension; this can cause some Mac programs (such as
  159. PageMaker) to assume the text uses the PC character set and it tries to help
  160. by converting it to the Mac set, which of course it gets wrong since the
  161. file is already in the Mac character set. (This even happens if the file is
  162. saved with a .TXT extension from a Mac a