home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 448b.lha / Magnetic_Pages / Displayer / Displayer.docs < prev    next >
Encoding:
Text File  |  1990-12-02  |  8.8 KB  |  197 lines
  1.               M A G N E T I C  P A G E S: Displayer (V1.0)
  2.              ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  3.  
  4. Introduction
  5. ~~~~~~~~~~~~
  6.     This is the program used to view a magazine. In addition to displaying
  7. the magazine, the reader may save text as a standard ascii file, save an
  8. entire page as an IFF picture, or print the text and/or graphics on a page.
  9.  
  10.  
  11. Running the Displayer
  12. ~~~~~~~~~~~~~~~~~~~~~
  13.     The Displayer can be run from the CLI or the Workbench. In addition to
  14. the actual magazine articles, the Displayer requires a special control file
  15. which contains information about the magazine contents. This control file
  16. is created using the Organiser and unless you have this program you can't
  17. make a magazine.
  18.  
  19. Running from CLI:
  20.     The displayer has one argument, the AmigaDos path/name of the control
  21. file. This control file may be called anything and located anywhere on the
  22. disk. eg.
  23.  
  24.             1> Displayer My_Mag
  25.  
  26.             ^               ^
  27.             |               |
  28.             |                Control file name
  29.             |
  30.              CLI prompt
  31.  
  32.  
  33. Running from Workbench:
  34.     To run the Displayer from Workbench, the Displayer must have an icon.
  35. The control file must be in the same directory as the Displayer and must be
  36. called Mag_Ctrl. Unfortunately this is not a nice way of doing it but
  37. because of an annoying bug (see Annoying Bug below) this was the only way
  38. I could do it. Ideally the control file would have the icon and using the
  39. 'Default Tool' field it would automatically load the Displayer. As soon as
  40. the bug is fixed, it will operate this way. If you want more than one
  41. magazine on a disk, I suggest you use something like IconX or XIcon so it
  42. thinks it is running from a CLI.
  43.  
  44.  
  45. Memory Requirements
  46. ~~~~~~~~~~~~~~~~~~~
  47.     An optimum setup is an Amiga with 512k of Chip ram and 512k of Fast Ram.
  48. However it will run on all other configurations. It is up to the magazine
  49. editor to make sure that all articles can be displayed on a 512k machine.
  50.     When an article is loaded, the Displayer will try and load it all into
  51. Fast ram. Then when a page is displayed, any graphics, sound or music needed
  52. for the page will be copied into Chip ram. As the graphics are copied to
  53. Chip Ram they will also be decompressed.
  54.     The worst situation is displaying a page containing sound or music on
  55. a 512k machine. The Displayer doesn't know the sound/music is already in
  56. Chip ram, and goes ahead and makes another copy in chip ram. This is a bit
  57. wasteful and may be changed in future versions.
  58.     As all 2000's have at least 512k of Chip and 512k of Fast and most
  59. 500 owners soon expand their machines to 1 Meg, this should not be much of
  60. a problem.
  61.  
  62.  
  63. Using the Displayer
  64. ~~~~~~~~~~~~~~~~~~~
  65.  
  66. Moving around a magazine:
  67.     The most basic operation is moving around the magazine. On a standard
  68. text page, you can use the menus or gadgets. On a custom graphics page you
  69. have to use the menu commands. The menu bar is hidden so it is important
  70. that people realise this is the only method of getting off a graphics page.
  71. The commands for moving around the magazine are as follows:
  72.  
  73. Menu Command   Gadget   KeyBoard
  74. ~~~~~~~~~~~~   ~~~~~~   ~~~~~~~~
  75.  Next Page       >     RIGHT ARROW - Takes you to the next page in an
  76.                                      article. If you are on the last page of
  77.                                      an article, you will be taken to the
  78.                                      first page of the next article.
  79.  
  80. Previous Page    <     LEFT ARROW  - Takes you to the previous page in an
  81.                                      article. If you are on the first page
  82.                                      of an article, you will be taken to the
  83.                                      last page of the previous article.
  84.  
  85. Next Article     >>    UP ARROW    - Takes you to the next article in the
  86.                                      magazine. If you are at the last
  87.                                      article of the magazine, you will be
  88.                                      taken back to the first article.
  89.  
  90. Previous Article <<    DOWN ARROW  - Takes you to the previous article in
  91.                                      the magazine. If you are on the first
  92.                                      article of the magazine, you will be
  93.                                      taken to the last article.
  94.  
  95.  Contents    Contents  SPACE BAR   - This depends on the layout of the
  96.                                      magazine and where you currently are.
  97.                                      For example a magazine may be divided
  98.                                      up into various sections. Eg articles,
  99.                                      reviews, Feedback, Art Gallery, etc.
  100.                                      There may also be a main contents page
  101.                                      which has icons on it that allow you to
  102.                                      branch to the different sections. Once
  103.                                      you have branched to a section (eg
  104.                                      articles) you should be able to get back
  105.                                      to the main contents by selecting the
  106.                                      Contents command.
  107.  
  108.  
  109.     As well as moving through a magazine sequentially, a well designed
  110. magazine will be divided up into different sections, each with there own
  111. contents page. On a contents page, you can select an article to read, or
  112. branch to another section by clicking on icons (boxes) on the page. A box
  113. that can be clicked on will respond with a push-button effect or with
  114. several frames of animation. To get back to the previous contents page,
  115. select the 'Contents' command.
  116.  
  117.  
  118. Sound/Music:
  119.     Some pages may play a piece of sound or music when you turn to them.
  120. This is nothing to be frightened about, it is perfectly normal. If it is
  121. a long piece of music or sound, or it has been told to repeat continuously
  122. it may not stop until you exit the magazine. You can turn the sound off
  123. yourself at any stage by toggling the menu item 'Sound On' in the 'Other'
  124. menu.
  125.     Some pages may also have boxes on them which will play sound/music
  126. when you click on them.
  127.  
  128. Save as IFF:
  129.     This menu command allows you to save one or several pages as IFF
  130. pictures. If you want to save off one page, simply enter the filename
  131. at the prompt.
  132.     To save off a whole article, you use the same procedure. Each page will
  133. be saved as filename.PAGENUM, where filename is the AmigaDos path/name you
  134. entered at the prompt and PAGENUM is the page number. Only pages from the
  135. current page to the end of the article will be saved. For example if an
  136. article has 6 pages and you are on page 3 when you select 'Save as IFF',
  137. only pages 3,4,5 and 6 will be saved.
  138.  
  139. Save Text:
  140.     This menu command allows you to save a page of text or all the text
  141. from an article. The text will be saved as a standard ASCII file. Simply
  142. enter the filename at the prompt.
  143.  
  144. Print:
  145.     This menu command allows you to print a page or a whole article. There
  146. are two printing modes available.
  147.  
  148. 'Text Only'    will only print out the text on a page.
  149. 'Screen Dump'  will print out the whole page as a graphics dump, similar to
  150.                printing on Deluxe Paint.
  151.  
  152. Only pages from the current page to the end of the article will be printed
  153. if you choose 'Print Article'.
  154.  
  155.                     -----------------------------------
  156.  
  157. Annoying Bug
  158. ~~~~~~~~~~~~
  159.     This is the bug mentioned earlier when the Displayer is run from the
  160. Workbench. What I wanted to do was to be able to click on a control file
  161. icon (type Project) which would then load the Displayer. This is a
  162. standard way of running this type of program from the Workbench.
  163.     I was able to get this to work to a certain extent. You could click on
  164. a control file icon, which would load the Displayer. The Displayer would
  165. then load the control file. This is pretty standard and is documented in
  166. the Rom Kernel Manuals. The problem was when the Displayer tried to load
  167. the first article. As soon as the Displayer tried to open the article, I
  168. got a GURU (870000004). I don't think it has anything to do with the load
  169. routine, as it has always worked perfectly before. If anyone can help, it
  170. would be much appreciated.
  171.  
  172.  
  173. Upgrades
  174. ~~~~~~~~
  175.     The Displayer is by no means perfect. I will continue to work on it when
  176. I get the time. I'm not promising anything but if enough interest is shown
  177. in Magnetic Pages I hope to make the following improvements to the Displayer.
  178.  
  179.     * Faster page rendering.
  180.  
  181.     * More memory efficient in certain areas.
  182.  
  183.     * Speech capabilities so the text may be spoken out loud.
  184.  
  185.     * A more flexible sound/music playing technique.
  186.  
  187.     * Support for continous animated boxes.
  188.  
  189.     * An Arexx port. Only because it's trendy.
  190.  
  191.     The above improvements are just a few general ideas I have planned. If
  192. you have any suggestions, or complaints please let me know when you order
  193. the Organiser.
  194.  
  195.                                                             Mark Gladding.
  196.  
  197.