home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / _ / 7plus / !7Plus / !Help < prev    next >
Text File  |  1993-04-03  |  16KB  |  396 lines
  1. 7Plus for the Archimedes : Version 1.00
  2. =======================================
  3.  
  4. Introduction
  5. ------------
  6.  
  7. Hip Hip Hooray!! Throw away that tired old PC emulator and install
  8. 7Plus for the Archimedes instead. Its been a long time coming but the
  9. Archimedes now has a native version of 7Plus, all be it in command
  10. line form.
  11.  
  12. For those of you who already use 7Plus under the PC Emulator this
  13. program should not be too much of a culture shock. For those who don't
  14. use the PC emulator or the command line I apologize for releasing this
  15. program with no nice'n'easy desktop front end, but once this
  16. conversion is proven in the field then I shall devote more time to the
  17. desktop version.
  18.  
  19. Theory behind the conversion
  20. ----------------------------
  21.  
  22. When I started porting 7Plus across to the Archimedes it soon became
  23. apparent that much of 7Plus' internal workings were dependant on the
  24. PC concept of file name extensions (similar to RISC OS file types).
  25. ie-:
  26.   
  27. EXAMPLE.DOC
  28.  
  29. Where 'EXAMPLE' is the filename and 'DOC' is the file name extension.
  30. In this case a DOCument for a word processor. This would be the
  31. equivalent to the Archimedes file type TEXT (&FFF) or similar.
  32.  
  33. So in order to keep as much of the original 7Plus source code untouched
  34. I have wrapped it in cotton wool by translating RISC OS file names and
  35. types into DOS format and back again.
  36.  
  37. The upshot of all this is that we only have a command line version of
  38. the program. This should be easy to keep up to date and in line with the
  39. PC version and it also has a command line syntax almost exactly the
  40. same. This also means WE understand what PC owners are going on about
  41. when they ask for a re-send of 'EXAMPLE.P06' for example.
  42.  
  43. If you have not read the 7Plus manual written by Axel DG1BBQ then it
  44. would be advisable to do so now. This is kept in the Archive '7+ 4 PC'
  45. and is called '7PLUS_E/DOC'. The manual covers the operation of all the
  46. versions of 7Plus across all the platforms except for RISC OS machines.
  47. The rest of this file gives a quick guide as to the structure of 7Plus
  48. under RISC OS and how to use it.
  49.  
  50. How 7Plus organises its work files.
  51. -----------------------------------
  52.  
  53. In order to keep the command line as close to the PC format as possible
  54. all 7Plus 'work' files are kept in one place. This is the '!7+_Work'
  55. directory with the open brief case icon. Double clicking on this will
  56. cause the directory to open revealing a couple of 7Plus files called
  57. '!Spock' and '!Spocky'. The directory structure of the '!7+_Work'
  58. directory is shown here.
  59.  
  60.  
  61.  
  62.  
  63. !7+_Work--------|
  64.                 |----!Sprites22
  65.                 |----!Sprites
  66.                 |----!Boot
  67.                 |----!Run
  68.                 |
  69.                 |----Work----|
  70.                              |-----!Spock  (7+ 'file')
  71.                              |-----!Spocky (7+ 'file')
  72.                              |-----Spock   (decoded sprite file)
  73.                              |-----JPEG----|
  74.                                            |-----Spocky (JPG decoded PC)
  75.                                                         (file stamped  )
  76.                                                         (with DOS type )
  77.  
  78.  
  79.  
  80.  
  81. Any successfully decoded Archimedes files are also put in this
  82. directory. If the file was originally from a PC or other machine the
  83. file is put in a newly created Sub-directory whose name is the files
  84. file extension. Sounds complicated but hopefully all will be made clear
  85. in the following examples.
  86.  
  87. Decoding Examples.
  88. ------------------
  89.  
  90. This is a small example to show you how to decode the 7Plus file
  91. '!Spock' into its normal Archimedes sprite form.
  92.  
  93. Press the 'F12' to get to the * command line prompt and then type the
  94. following
  95.  
  96. *7Plus Spock
  97.  
  98. and then press 'Return'
  99.  
  100. 7Plus will now display its banner and proceed to decode the '!Spock'
  101. 7Plus file. You may have noticed that to decode we did not type in
  102. '!Spock' but 'Spock'. When decoding you do not use the first '!' in
  103. the file name.
  104.  
  105. Once the decoding has finished press 'Return' to go back to the desktop.
  106. If you have opened the '!7+_Work' directory ( called the work directory
  107. from now on ) you will now find a successfully decoded sprite file
  108. called 'Spock'. The '!Spock' 7Plus file is now redundant and can be
  109. deleted.
  110.  
  111. You have now successfully decoded a 7Plus file that was created on the
  112. Archimedes. Now how about a file that was created on a PC.
  113.  
  114. Press 'F12' again and type
  115.  
  116. *7Plus Spocky
  117.  
  118. When it has finished press 'Return' to get back to the desktop. You
  119. will now find a new directory in the work directory called 'JPG'.
  120. Inside you will find a file called 'Spocky' with a file type of DOS.
  121. This file would have had the full name of 'SPOCKY.JPG' on a PC. I have
  122. implemented PC file names in this manner instead of the more usual
  123. 'SPOCKY/JPG' so that no truncation of the name occurs.
  124.  
  125. The '!Spocky' 7Plus file is now redundant and could be deleted.
  126.  
  127. To view 'Spocky' you will need the application !changeFSI (comes with
  128. RISC OS 3.1) or !Translator ( a shareware program ) and djpeg.
  129.  
  130. The nitty gritty of the !7Plus files
  131. ------------------------------------
  132.  
  133. Yep you've guessed it '!Spock' was not a file at all but another fancy
  134. 'file' directory as inspired by !Impression. The structure of '!Spock'
  135. is shown here.
  136.  
  137. !Spock---|
  138.          |---!Run
  139.          |---!Sprites
  140.          |---!Sprites22
  141.          |---!Help
  142.          |---7ix-----|
  143.          |           |---7ix (data type)
  144.          |
  145.          |---7mf-----|
  146.          |           |---7mf (data type)
  147.          |
  148.          |---cor-----|
  149.          |           |---cor (text type)
  150.          |           |---c01 (text type)
  151.          |           |--- ......
  152.          |             
  153.          |---err-----|---err (text type)
  154.          |           |---e01 (text type)
  155.          |           |--- ......
  156.          |            
  157.          |---p0_-----|---p01 (text type)
  158.          |           |---p02 (text type)
  159.          |           |---p03 (text type)
  160.          |           |--- ...... upto p0f
  161.          |                       
  162.          |---p1_-----|---p10
  163.          |           |--- ...... upto p1f
  164.          | 
  165.          |... upto pf_ 
  166.                 
  167.  
  168. Double clicking on '!Spock' will open the file to reveal a number of
  169. files and directories. The '!Run' and '!Sprites' are the normal run of
  170. the mill stuff and can be ignored. The !Help file is slightly special
  171. and to find out why just double click on it and read.
  172.  
  173. Why the complicated directory structure?.....
  174. ---------------------------------------------
  175.  
  176. 7Plus produces many different file name extensions on the PC which can
  177. cause problems when exceeding the 77 file limit on ADFS. The file
  178. extensions, to recap, are-:
  179.   
  180. 7PL     A file encoded into 7Plus format and has only one part
  181.         ( 1 of 1)
  182. P01     A file encoded into 7Plus format and is the first part of many
  183. ERR     A file generated while decoding a set of corrupted 7Plus files.
  184. COR     A file generated to correct the errors listed by the ERR file.
  185. 7MF     A file generated while decoding. This is a partly decoded file
  186.         and is kept to speed up the process of decoding when a COR
  187.         file is received.
  188. 7IX     A file that is related to the 7MF file.
  189.  
  190. When downloading 7Plus files from a BBS it is possible to download more
  191. than one 'COR' file. In this case the 'COR' files will be named 'COR'
  192. for the first file and then the sequence C01,C02..C4C will be used.
  193. (ie a maximum of 77 'COR' files).
  194.  
  195. The same also applies to the 'ERR' files. You will almost certainly
  196. receive more than one error file when you have encoded and distributed
  197. some 7Plus files.
  198.  
  199. All the above file name extensions are kept in sub-directories of the
  200. same name for each file that you are de/encoding. Have another look at
  201. the '!Spocky' directory structure.
  202.  
  203. The only exception to this rule is the parts files ('P01'..etc). These
  204. are kept in directories of names described as follows. The files 'P01'
  205. to 'P0F' are kept in the sub-directory 'P0_', similarly the files 'P30'
  206. to 'P3F' are kept in the sub-directory 'P3_' . This enables the
  207. Archimedes to support 255 parts for 7Plus files ( over the top I know )
  208. and still keep within the 77 file limit of the ADFS filing system.
  209. Remember if only one part of one is created it will hav