home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format 50 / af050sub.adf / Menu_System / README.DOC / README.DOC
Text File  |  1993-06-25  |  15KB  |  333 lines
  1.  
  2.                       Menu System Version 5.00A And 5.00B
  3.                                 By Samuel Colak
  4.  
  5.  
  6. ----------------------------------------------------------------------------
  7.      This program is SHAREWARE And Was Written Using AMOS PROFESSIONAL
  8. ----------------------------------------------------------------------------
  9.  
  10. Contribution
  11.  
  12.     This program has been classified as SHAREWARE. If you find this program
  13. of use then I would appreciate a samll contribution of say five quid.
  14.     Doing so will result in continuous TECHNICAL SUPPORT and free upgrades
  15. when they come available.
  16.  
  17.  
  18. Files
  19.  
  20.     The following files accompany MSYS and may be removed from circulation
  21. if you need more disk space.
  22.  
  23.                 SYS (dir)
  24.                     MSYSA
  25.                     MSYSB
  26.                     README.DOC
  27.                     SOURCE.DOC
  28.                     SOURCE_MSYSA.AMOS
  29.                     SOURCE_MSYSB.AMOS
  30.  
  31.     These files must be placed in the relevant directorys otherwise MSYS
  32. may not work.
  33.  
  34.               * C (Dir)
  35.               *     Run
  36.               *     Execute
  37.               * Fonts (Dir)
  38.               *     Peridot.Font
  39.               *     Peridot (Dir)
  40.               *         7
  41.               * Libs (Dir)
  42.               *     Diskfont.Library
  43.  
  44. What Does It Do?
  45.  
  46.     Menu System is a control program which has been written to allow users
  47. to load files directly form the disk rather than go through the laborious
  48. tasks of loading workbench etc. ALSO this program only takes up a couple of
  49. files and so memory is saved on your disks.
  50.     As a request by floppy users, I have included another version of
  51. MENU SYSTEM which is slightly smaller in size. This however means that this
  52. version lacks the editor. HARD DRIVE users will not find this of any use
  53. however it may save valuable disk space.
  54.     The difference between both versions is the lettering after the version
  55. number. If it reads `A` then this version includes the editor otherwise the
  56. editor has been removed.
  57.  
  58. Operating System
  59.  
  60.     This program is compatible with all versions of the AMIGA and has been
  61. tested on the following versions of KICKSTART.
  62.  
  63.                 V1.3.4 [A500]
  64.                 V1.3.5 [A500]
  65.                 V2.0   [A500 Plus]
  66.                 V3.0   [A1200 AND A4000]
  67.  
  68. Credits
  69.  
  70.     The following people have aided in the development of this package:-
  71.  
  72.                 Bob Briggs - BETA TESTING And IDEAS
  73.                 Matthew Colak - DOCUMENTATION And BETA TESTING
  74.                 Giles Middleton - BETA TESTING
  75.                 June Hudson - BETA TESTING
  76.  
  77. Loading
  78.  
  79.     To load this program enter the CLI and type `MSYSA` or `MSYSB` followed
  80. by return. (Read Documentation further for distinction)
  81.     If the program has found all the files it requires, the program should
  82. boot and present itself to you with the credit screen. If not then please
  83. read the section of this document entitled PROBLEMS. Pressing the LEFT MOUSE
  84. button will move you into the menu editor.
  85.  
  86. The Interface
  87.  
  88.     After loading MENU SYSTEM, the program should present you with a screen
  89. divided into 83 buttons. These are arranged in 20 rows of 4 and with 3 at
  90. the bottom.
  91.     Please note that `MSYSB` does not included the Editor Or Prefs Options
  92. which are included in `MSYSA` due to memory limitations.
  93.     If you click on a couple of buttons from the 20 rows you should notice
  94. that these will invert themselves and then return to their original state
  95. after you release the mouse button. Clicking like this when one of the
  96. bottom three read `EXEC` will cause the appropriate button to be executed.
  97. By pressing the button labelled `QUIT` MENU SYSTEM will automatically close
  98. and release the memory to the computer.
  99.  
  100. The Editor - [Only Available In `MSYSA`]
  101.  
  102.     The Editor forms the most powerful section of MENU SYSTEM. To enter this
  103. you must click on the button labelled `EXEC`. Doing this should change the
  104. word inside to `EDIT` signifying that you are now in the Editor mode.
  105.     After this has been done, click on one of the buttons above the set of
  106. three. Once you have done this the editor screen should appear infront of
  107. you.
  108.     This screen is divided into 2 areas. In the top halve you will find
  109.  buttons.
  110.  
  111.     RUN... This button is cyclic ie if you click on this button the word
  112.             inside will change but will eventually return back to RUN.
  113.  
  114.             These words symbolise the function which will be carried out
  115.             when you click on the button. These are listed below:-
  116.  
  117.             RUN - This is the equivelent to typing the following command
  118.                 directly into the CLI.
  119.  
  120.                         RUN <NIL: >NIL: Filename
  121.  
  122.                 This will execute the file whose filename is held in the
  123.                 region next to the button labelled `FILENAME`.
  124.  
  125.             EXECUTE - This is similar to the RUN command except that the
  126.                 command sent to the CLI is :-
  127.  
  128.                         EXECUTE Filename
  129.  
  130.                 This is especially useful when creating a button which
  131.                 needs to execute a shell script file such as the
  132.                 WORKBENCH script.
  133.  
  134.             MENU - This command is a MENU SYSTEM specific command in that
  135.                 the filename in the region next to the `FILENAME` button
  136.                 is the name of another menu definition held on disk.
  137.                 Clicking on this type of button will cause the computer to
  138.                 load the new menu definition into memory.
  139.  
  140.             DIRECT - This command sends the Filename held in the region
  141.                 next the `FILENAME` button directly to the CLI as if
  142.                 you had typed the filename yourself.
  143.  
  144.             TEXT - When this is shown it means that the text inside the
  145.                 text box will be outputted to a button but the button
  146.                 will not depress when clicked on.
  147.  
  148.             BLANK - This blanks the button on the main screen and places
  149.                 any text in the blank space. Again this button cannot
  150.                 be selected.
  151.  
  152.         Buttons labelled RUN, EXECUTE, DIRECT and MENU will all invert when
  153.     the mouse button is pressed upon them. The others will not respond and
  154.     so this fact can be exploited to use for messages.
  155.  
  156.     SIZE.. This button alters the physical size of the button in the
  157.             horizontal direction depending on the structure of the buttons
  158.             to its immediate right ie the button can be expanded by clicking
  159.             on this button as long as the button on the right is of
  160.             size 1. If it is possible to change the button the number in the
  161.             box on the right will be incremented and the button in the
  162.             other section of the editor will expand. If the button is unable
  163.             to expand any further then the computer resets the size of the
  164.             button to one.
  165.             Physical changes can only be seen by selecting the EXIT button
  166.             situated on the far right of the editor screen.
  167.  
  168.     DEF... This button resets all buttons to their defaults and clears
  169.             any text currently assigned to that button.
  170.  
  171.     COLOUR. This Option dictates the physical colour of the button. See
  172.             the documentation covering the PREFERENCES for information
  173.             regarding the physical differences between the two types of
  174.             button.
  175.  
  176.     FILENAME.. This option reveals a hidden area in the editor. This area
  177.                 is used to enter text by clicking on the button labelled
  178.                 `TEXT` or it allows you to select a filename using a
  179.                 requester. The area next to the button labelled `FILENAME`
  180.                 must contain some text for the RUN, EXECUTE, DIRECT or
  181.                 MENU options to work.
  182.                 Clicking the `TEXT` option will allow you to enter
  183.                 characters from the keyboard, each inturn will be displayed
  184.                 in the editing window beside the button. This option
  185.                 updates the previous contents held in the option selected
  186.                 and so if you make a mistake then it can be ammended simply
  187.                 by re-selecting the option.
  188.                 Selecting the `FILENAME` option automatically amends any
  189.                 previous text in this option by adding the filename
  190.                 returned from the requester.
  191.                 The current text in the requester will only be returned if
  192.                 the Q button is pressed when you have finished entering
  193.                 teh text.
  194.  
  195.     X..... This has been implemented to allow extended filenames such as
  196.             holding parameters to pass to programs when they execute such
  197.             as the filename of a piece of music which has to be passed to
  198.             the module player otherwise the program won`t work.
  199.  
  200.         At the base of the editor you will find a centralised button which
  201.     appears to be blank. Clicking on this button will allow you to enter
  202.     text which will be displayed on the main menu. This applies to all
  203.     menu buttons.
  204.  
  205.     MENU / CLI.... This options dictates to the menu system where the
  206.                     output should be directed. If `MENU` is present the
  207.                     the computer assumes that you wish to keep the menu
  208.                     system memory resident otherwise the program
  209.                     automatically closes down once the command has been
  210.                     sent to the CLI.
  211.  
  212.     SHRINK / MENU. This option has been included to determine the screen
  213.                     which is brought to front when a command is executed
  214.                     and may only to selected when the button beside it
  215.                     (See information on button before this one) reads
  216.                     `MENU`. This is mainly due to the program being
  217.                     notified that you wish to keep the menu system
  218.                     memory resident and that before an option has started
  219.                     executing the menu system knows what to do.
  220.                     Selecting `SHRINK` will cause the menu system to
  221.                     disappear until the program has stopped executing.
  222.                     Once this has taken place the menu system will move
  223.                     back into view.
  224.                     The other option `MENU` tells the menu system that
  225.                     the menu is to remain resident in view at all times.
  226.                     This is very useful if you wish to make options which
  227.                     play music in the background etc.
  228.  
  229.  
  230. Saving A Menu Definition [Only Available In `MSYSA`]
  231.  
  232.     This option brings up a requester which allows you to save the present
  233. menu definition to disk. To reload it in future simply type the
  234. following :-
  235.  
  236.                     MSYS [Filename Of Menu Definition]
  237.  
  238.     This will automatically boot in your menu definition and display it.
  239.  
  240.  
  241. The Preference Editor - [Only Available In `MSYSA`]
  242.  
  243.     This option allows you to change the colour format of the screen to
  244. whatever colours you want. This is made easy by the use of three
  245. horizontal bars with small sliders within them. These can be used by
  246. depressing any mouse button on the slider and moving the mouse left or
  247. right, [Warning:The slider is very sensitive and in order to move the
  248. slider the mouse must remain inside the colour bar until movement has
  249. stopped or the movement will stop prematurely].
  250.     This will increase or decrease the amount of pigmentation in the
  251. colour depending on which way you move the slider, moving right will
  252. increase the pigmentation with left doing the opposite.
  253.     There are three types of pigmentation Red, Green and Blue which allow
  254. up to 4096 colour combinations which is the maximum amount for the
  255. standard Amiga anyway. There are eight colours incorporated into the
  256. program and each affects a certain feature:
  257.  
  258.     0 - Background Colour           1 - Text Colour
  259.     2 - Colour of Text Bar 2        3 - Border of Text Bar 2.1
  260.     4 - Border of Text Bar 2.2      5 - Colour of Main Bar Type 1
  261.     6 - Border of Text Bar 1.1      7 - Border of Text Bar 1.2
  262.  
  263.     Another option of the the Preference Editor is the `Sys Dir` option
  264. for hard disk users. This enables the MENU SYSTEM to locate the system
  265. commands such as RUN and EXECUTE by looking in the area dicatated by this
  266. option for the `C` folder. If this cannot be found problems will arise and
  267. the program will remain in its ready condition. This also applies to the
  268. Execute command!!
  269.  
  270. Software Support
  271.  
  272.     I`m constantly ungrading this piece of software and so and thoughts you
  273. may have would be gratefully recieved. If you wish to contact me about
  274. anything for interest sakes then write to me at the following address.
  275. I will reply to all letters.
  276.  
  277.                     Samuel Colak
  278.                      5 Meteor Road,
  279.                       Manby,
  280.                        Louth,
  281.                         Lincolnshire. LN11 8UB
  282.  
  283.     Also I`m in the process of setting up a club to exchange AMOS software.
  284. Its free and worth it.. If you want to join then send your letters to the
  285. address above...
  286.  
  287.  
  288. History
  289.  
  290.     MSYS has had a varied history regarding its creation. Version 5.00 is
  291. the result of continuous software support and BETA testing by my close
  292. friends.
  293.     However careful you are in programming there is always the chance that
  294. a bug may creep into the clockwork which is overlooked for some unexplained
  295. reason and so this is were you come in..
  296.     If at any time you find something that is unexplained or something which
  297. crashes your computer completely then write to me at the address above and
  298. i`ll send you a new version with the bug removed.
  299.     At present the history of MSYS is as follows...
  300.  
  301.  
  302. VERSION 1.00
  303. Primary Version Release - DATE 12th NOVEMBER 1992 - NOT RELEASED !!
  304. Bugs appeared when the computer attempted to load a string containing a
  305. comma. Solved by replcing the command `INPUT# 1,string` with
  306. `LINE INPUT# 1,string`.
  307.  
  308.  
  309. VERSION 2.00
  310. Editor Amendment - DATE 3rd JANUARY 1993 - NOT RELEASED !!
  311. Unsafe passing of `PARAM` command crashed system on A500`s but not
  312. A500 plus`s. Solved by rewriting routine.
  313.  
  314.  
  315. VERSION 3.10
  316. Editor Amendment - DATE 5th MAY 1993 - NOT RELEASED !!
  317. Window routines added to allow MSYS to communicate with CLI.
  318.  
  319.  
  320. VERSION 4.10 - PUBLIC DOMAIN
  321. Program Finished - DATE 11th JUNE 1993 - AMIGA FORMAT V1 !!
  322. Editor and Separate program sent to AF for inclusion on DISK..
  323.  
  324.  
  325. VERSION 5.00 - SHAREWARE [This Version]
  326. Progarm Finished And Cleaned Up - DATE 17th JUNE 1993 - AMIGA FORMAT V2 !!
  327. Sent to AF for inclusion onto DISK.. 100% bugs found and removed. (I HOPE)
  328.  
  329.  
  330.  
  331.  
  332.  
  333.