Home » Archimedes archive » Archimedes World » archimedes_world_volume_15_issue_1_scp.adf » !ProFiler_ProFiler » !ProFiler/Dox/Menus

!ProFiler/Dox/Menus

This website contains an archive of files for the Acorn Electron, BBC Micro, Acorn Archimedes, Commodore 16 and Commodore 64 computers, which Dominic Ford has rescued from his private collection of floppy disks and cassettes.

Some of these files were originally commercial releases in the 1980s and 1990s, but they are now widely available online. I assume that copyright over them is no longer being asserted. If you own the copyright and would like files to be removed, please contact me.

Tape/disk: Home » Archimedes archive » Archimedes World » archimedes_world_volume_15_issue_1_scp.adf » !ProFiler_ProFiler
Filename: !ProFiler/Dox/Menus
Read OK:
File size: 0849 bytes
Load address: 0000
Exec address: 0000
File contents
<html><head><title>ProFiler Menus</title></head>

<body>
<h1><center><u>ProFiler Menus</u></center></h1>

<h2><i>Preliminary</i></h2>
<i>There is no GUI for defining the order of the functions in the menus yet. To enable some users to do it anyway, this describes the format of the file.</i>

<h2>!Menus file</h2>
There is a file called '!Menus' in the ProFiler directory. If you want to modify the contents, copy it into Choices:Filer, and modify the copy.
<p>The format of the file is simple, but since it will be generated by a program soon, the syntax is fairly strict. Every line is significant, and empty lines are not allowed.
<p>See <a href="external">External</a> for information about function IDs.
<p>The file consists of lines, each giving the full ID of a function. The presence and sequence of the IDs is the important thing here. If a function is left out of this file, it will be added to the bottom of the relevant menu. This happens to new utilities loaded. The exact places the functions will have are undefined in this case, except functions from a given utility will be kept together.
<p>To ensure that a function's place is well defined, you should insert the ID of that function into the file.

<h2>Order of functions</h2>
The order of the lines in the file defines the order of the functions in the menu. Functions that appear in different parts of the menu tree can have any order in the file, but it is recommended to keep the submenus together for clarity.
<p>When a function is inserted into a menu, the following happens:
<ol>
<li>If it is not in the file, the function is put at the bottom of the menu.
<li>If it is the first entry in the file, it is put at the top of the menu, regardless of the existing contents.
<li>If one of the IDs above this function is already in the menu, the function is put just below that place.
<li>If an ID after this function is in the menu, the function is put just above that place.
<li>If no place has been found after this, the function is placed at the end. This usually only happens to the very first function inserted into a menu.
</ul>
</body></html>
00000000  3c 68 74 6d 6c 3e 3c 68  65 61 64 3e 3c 74 69 74  |<html><head><tit|
00000010  6c 65 3e 50 72 6f 46 69  6c 65 72 20 4d 65 6e 75  |le>ProFiler Menu|
00000020  73 3c 2f 74 69 74 6c 65  3e 3c 2f 68 65 61 64 3e  |s</title></head>|
00000030  0a 0a 3c 62 6f 64 79 3e  0a 3c 68 31 3e 3c 63 65  |..<body>.<h1><ce|
00000040  6e 74 65 72 3e 3c 75 3e  50 72 6f 46 69 6c 65 72  |nter><u>ProFiler|
00000050  20 4d 65 6e 75 73 3c 2f  75 3e 3c 2f 63 65 6e 74  | Menus</u></cent|
00000060  65 72 3e 3c 2f 68 31 3e  0a 0a 3c 68 32 3e 3c 69  |er></h1>..<h2><i|
00000070  3e 50 72 65 6c 69 6d 69  6e 61 72 79 3c 2f 69 3e  |>Preliminary</i>|
00000080  3c 2f 68 32 3e 0a 3c 69  3e 54 68 65 72 65 20 69  |</h2>.<i>There i|
00000090  73 20 6e 6f 20 47 55 49  20 66 6f 72 20 64 65 66  |s no GUI for def|
000000a0  69 6e 69 6e 67 20 74 68  65 20 6f 72 64 65 72 20  |ining the order |
000000b0  6f 66 20 74 68 65 20 66  75 6e 63 74 69 6f 6e 73  |of the functions|
000000c0  20 69 6e 20 74 68 65 20  6d 65 6e 75 73 20 79 65  | in the menus ye|
000000d0  74 2e 20 54 6f 20 65 6e  61 62 6c 65 20 73 6f 6d  |t. To enable som|
000000e0  65 20 75 73 65 72 73 20  74 6f 20 64 6f 20 69 74  |e users to do it|
000000f0  20 61 6e 79 77 61 79 2c  20 74 68 69 73 20 64 65  | anyway, this de|
00000100  73 63 72 69 62 65 73 20  74 68 65 20 66 6f 72 6d  |scribes the form|
00000110  61 74 20 6f 66 20 74 68  65 20 66 69 6c 65 2e 3c  |at of the file.<|
00000120  2f 69 3e 0a 0a 3c 68 32  3e 21 4d 65 6e 75 73 20  |/i>..<h2>!Menus |
00000130  66 69 6c 65 3c 2f 68 32  3e 0a 54 68 65 72 65 20  |file</h2>.There |
00000140  69 73 20 61 20 66 69 6c  65 20 63 61 6c 6c 65 64  |is a file called|
00000150  20 27 21 4d 65 6e 75 73  27 20 69 6e 20 74 68 65  | '!Menus' in the|
00000160  20 50 72 6f 46 69 6c 65  72 20 64 69 72 65 63 74  | ProFiler direct|
00000170  6f 72 79 2e 20 49 66 20  79 6f 75 20 77 61 6e 74  |ory. If you want|
00000180  20 74 6f 20 6d 6f 64 69  66 79 20 74 68 65 20 63  | to modify the c|
00000190  6f 6e 74 65 6e 74 73 2c  20 63 6f 70 79 20 69 74  |ontents, copy it|
000001a0  20 69 6e 74 6f 20 43 68  6f 69 63 65 73 3a 46 69  | into Choices:Fi|
000001b0  6c 65 72 2c 20 61 6e 64  20 6d 6f 64 69 66 79 20  |ler, and modify |
000001c0  74 68 65 20 63 6f 70 79  2e 0a 3c 70 3e 54 68 65  |the copy..<p>The|
000001d0  20 66 6f 72 6d 61 74 20  6f 66 20 74 68 65 20 66  | format of the f|
000001e0  69 6c 65 20 69 73 20 73  69 6d 70 6c 65 2c 20 62  |ile is simple, b|
000001f0  75 74 20 73 69 6e 63 65  20 69 74 20 77 69 6c 6c  |ut since it will|
00000200  20 62 65 20 67 65 6e 65  72 61 74 65 64 20 62 79  | be generated by|
00000210  20 61 20 70 72 6f 67 72  61 6d 20 73 6f 6f 6e 2c  | a program soon,|
00000220  20 74 68 65 20 73 79 6e  74 61 78 20 69 73 20 66  | the syntax is f|
00000230  61 69 72 6c 79 20 73 74  72 69 63 74 2e 20 45 76  |airly strict. Ev|
00000240  65 72 79 20 6c 69 6e 65  20 69 73 20 73 69 67 6e  |ery line is sign|
00000250  69 66 69 63 61 6e 74 2c  20 61 6e 64 20 65 6d 70  |ificant, and emp|
00000260  74 79 20 6c 69 6e 65 73  20 61 72 65 20 6e 6f 74  |ty lines are not|
00000270  20 61 6c 6c 6f 77 65 64  2e 0a 3c 70 3e 53 65 65  | allowed..<p>See|
00000280  20 3c 61 20 68 72 65 66  3d 22 65 78 74 65 72 6e  | <a href="extern|
00000290  61 6c 22 3e 45 78 74 65  72 6e 61 6c 3c 2f 61 3e  |al">External</a>|
000002a0  20 66 6f 72 20 69 6e 66  6f 72 6d 61 74 69 6f 6e  | for information|
000002b0  20 61 62 6f 75 74 20 66  75 6e 63 74 69 6f 6e 20  | about function |
000002c0  49 44 73 2e 0a 3c 70 3e  54 68 65 20 66 69 6c 65  |IDs..<p>The file|
000002d0  20 63 6f 6e 73 69 73 74  73 20 6f 66 20 6c 69 6e  | consists of lin|
000002e0  65 73 2c 20 65 61 63 68  20 67 69 76 69 6e 67 20  |es, each giving |
000002f0  74 68 65 20 66 75 6c 6c  20 49 44 20 6f 66 20 61  |the full ID of a|
00000300  20 66 75 6e 63 74 69 6f  6e 2e 20 54 68 65 20 70  | function. The p|
00000310  72 65 73 65 6e 63 65 20  61 6e 64 20 73 65 71 75  |resence and sequ|
00000320  65 6e 63 65 20 6f 66 20  74 68 65 20 49 44 73 20  |ence of the IDs |
00000330  69 73 20 74 68 65 20 69  6d 70 6f 72 74 61 6e 74  |is the important|
00000340  20 74 68 69 6e 67 20 68  65 72 65 2e 20 49 66 20  | thing here. If |
00000350  61 20 66 75 6e 63 74 69  6f 6e 20 69 73 20 6c 65  |a function is le|
00000360  66 74 20 6f 75 74 20 6f  66 20 74 68 69 73 20 66  |ft out of this f|
00000370  69 6c 65 2c 20 69 74 20  77 69 6c 6c 20 62 65 20  |ile, it will be |
00000380  61 64 64 65 64 20 74 6f  20 74 68 65 20 62 6f 74  |added to the bot|
00000390  74 6f 6d 20 6f 66 20 74  68 65 20 72 65 6c 65 76  |tom of the relev|
000003a0  61 6e 74 20 6d 65 6e 75  2e 20 54 68 69 73 20 68  |ant menu. This h|
000003b0  61 70 70 65 6e 73 20 74  6f 20 6e 65 77 20 75 74  |appens to new ut|
000003c0  69 6c 69 74 69 65 73 20  6c 6f 61 64 65 64 2e 20  |ilities loaded. |
000003d0  54 68 65 20 65 78 61 63  74 20 70 6c 61 63 65 73  |The exact places|
000003e0  20 74 68 65 20 66 75 6e  63 74 69 6f 6e 73 20 77  | the functions w|
000003f0  69 6c 6c 20 68 61 76 65  20 61 72 65 20 75 6e 64  |ill have are und|
00000400  65 66 69 6e 65 64 20 69  6e 20 74 68 69 73 20 63  |efined in this c|
00000410  61 73 65 2c 20 65 78 63  65 70 74 20 66 75 6e 63  |ase, except func|
00000420  74 69 6f 6e 73 20 66 72  6f 6d 20 61 20 67 69 76  |tions from a giv|
00000430  65 6e 20 75 74 69 6c 69  74 79 20 77 69 6c 6c 20  |en utility will |
00000440  62 65 20 6b 65 70 74 20  74 6f 67 65 74 68 65 72  |be kept together|
00000450  2e 0a 3c 70 3e 54 6f 20  65 6e 73 75 72 65 20 74  |..<p>To ensure t|
00000460  68 61 74 20 61 20 66 75  6e 63 74 69 6f 6e 27 73  |hat a function's|
00000470  20 70 6c 61 63 65 20 69  73 20 77 65 6c 6c 20 64  | place is well d|
00000480  65 66 69 6e 65 64 2c 20  79 6f 75 20 73 68 6f 75  |efined, you shou|
00000490  6c 64 20 69 6e 73 65 72  74 20 74 68 65 20 49 44  |ld insert the ID|
000004a0  20 6f 66 20 74 68 61 74  20 66 75 6e 63 74 69 6f  | of that functio|
000004b0  6e 20 69 6e 74 6f 20 74  68 65 20 66 69 6c 65 2e  |n into the file.|
000004c0  0a 0a 3c 68 32 3e 4f 72  64 65 72 20 6f 66 20 66  |..<h2>Order of f|
000004d0  75 6e 63 74 69 6f 6e 73  3c 2f 68 32 3e 0a 54 68  |unctions</h2>.Th|
000004e0  65 20 6f 72 64 65 72 20  6f 66 20 74 68 65 20 6c  |e order of the l|
000004f0  69 6e 65 73 20 69 6e 20  74 68 65 20 66 69 6c 65  |ines in the file|
00000500  20 64 65 66 69 6e 65 73  20 74 68 65 20 6f 72 64  | defines the ord|
00000510  65 72 20 6f 66 20 74 68  65 20 66 75 6e 63 74 69  |er of the functi|
00000520  6f 6e 73 20 69 6e 20 74  68 65 20 6d 65 6e 75 2e  |ons in the menu.|
00000530  20 46 75 6e 63 74 69 6f  6e 73 20 74 68 61 74 20  | Functions that |
00000540  61 70 70 65 61 72 20 69  6e 20 64 69 66 66 65 72  |appear in differ|
00000550  65 6e 74 20 70 61 72 74  73 20 6f 66 20 74 68 65  |ent parts of the|
00000560  20 6d 65 6e 75 20 74 72  65 65 20 63 61 6e 20 68  | menu tree can h|
00000570  61 76 65 20 61 6e 79 20  6f 72 64 65 72 20 69 6e  |ave any order in|
00000580  20 74 68 65 20 66 69 6c  65 2c 20 62 75 74 20 69  | the file, but i|
00000590  74 20 69 73 20 72 65 63  6f 6d 6d 65 6e 64 65 64  |t is recommended|
000005a0  20 74 6f 20 6b 65 65 70  20 74 68 65 20 73 75 62  | to keep the sub|
000005b0  6d 65 6e 75 73 20 74 6f  67 65 74 68 65 72 20 66  |menus together f|
000005c0  6f 72 20 63 6c 61 72 69  74 79 2e 0a 3c 70 3e 57  |or clarity..<p>W|
000005d0  68 65 6e 20 61 20 66 75  6e 63 74 69 6f 6e 20 69  |hen a function i|
000005e0  73 20 69 6e 73 65 72 74  65 64 20 69 6e 74 6f 20  |s inserted into |
000005f0  61 20 6d 65 6e 75 2c 20  74 68 65 20 66 6f 6c 6c  |a menu, the foll|
00000600  6f 77 69 6e 67 20 68 61  70 70 65 6e 73 3a 0a 3c  |owing happens:.<|
00000610  6f 6c 3e 0a 3c 6c 69 3e  49 66 20 69 74 20 69 73  |ol>.<li>If it is|
00000620  20 6e 6f 74 20 69 6e 20  74 68 65 20 66 69 6c 65  | not in the file|
00000630  2c 20 74 68 65 20 66 75  6e 63 74 69 6f 6e 20 69  |, the function i|
00000640  73 20 70 75 74 20 61 74  20 74 68 65 20 62 6f 74  |s put at the bot|
00000650  74 6f 6d 20 6f 66 20 74  68 65 20 6d 65 6e 75 2e  |tom of the menu.|
00000660  0a 3c 6c 69 3e 49 66 20  69 74 20 69 73 20 74 68  |.<li>If it is th|
00000670  65 20 66 69 72 73 74 20  65 6e 74 72 79 20 69 6e  |e first entry in|
00000680  20 74 68 65 20 66 69 6c  65 2c 20 69 74 20 69 73  | the file, it is|
00000690  20 70 75 74 20 61 74 20  74 68 65 20 74 6f 70 20  | put at the top |
000006a0  6f 66 20 74 68 65 20 6d  65 6e 75 2c 20 72 65 67  |of the menu, reg|
000006b0  61 72 64 6c 65 73 73 20  6f 66 20 74 68 65 20 65  |ardless of the e|
000006c0  78 69 73 74 69 6e 67 20  63 6f 6e 74 65 6e 74 73  |xisting contents|
000006d0  2e 0a 3c 6c 69 3e 49 66  20 6f 6e 65 20 6f 66 20  |..<li>If one of |
000006e0  74 68 65 20 49 44 73 20  61 62 6f 76 65 20 74 68  |the IDs above th|
000006f0  69 73 20 66 75 6e 63 74  69 6f 6e 20 69 73 20 61  |is function is a|
00000700  6c 72 65 61 64 79 20 69  6e 20 74 68 65 20 6d 65  |lready in the me|
00000710  6e 75 2c 20 74 68 65 20  66 75 6e 63 74 69 6f 6e  |nu, the function|
00000720  20 69 73 20 70 75 74 20  6a 75 73 74 20 62 65 6c  | is put just bel|
00000730  6f 77 20 74 68 61 74 20  70 6c 61 63 65 2e 0a 3c  |ow that place..<|
00000740  6c 69 3e 49 66 20 61 6e  20 49 44 20 61 66 74 65  |li>If an ID afte|
00000750  72 20 74 68 69 73 20 66  75 6e 63 74 69 6f 6e 20  |r this function |
00000760  69 73 20 69 6e 20 74 68  65 20 6d 65 6e 75 2c 20  |is in the menu, |
00000770  74 68 65 20 66 75 6e 63  74 69 6f 6e 20 69 73 20  |the function is |
00000780  70 75 74 20 6a 75 73 74  20 61 62 6f 76 65 20 74  |put just above t|
00000790  68 61 74 20 70 6c 61 63  65 2e 0a 3c 6c 69 3e 49  |hat place..<li>I|
000007a0  66 20 6e 6f 20 70 6c 61  63 65 20 68 61 73 20 62  |f no place has b|
000007b0  65 65 6e 20 66 6f 75 6e  64 20 61 66 74 65 72 20  |een found after |
000007c0  74 68 69 73 2c 20 74 68  65 20 66 75 6e 63 74 69  |this, the functi|
000007d0  6f 6e 20 69 73 20 70 6c  61 63 65 64 20 61 74 20  |on is placed at |
000007e0  74 68 65 20 65 6e 64 2e  20 54 68 69 73 20 75 73  |the end. This us|
000007f0  75 61 6c 6c 79 20 6f 6e  6c 79 20 68 61 70 70 65  |ually only happe|
00000800  6e 73 20 74 6f 20 74 68  65 20 76 65 72 79 20 66  |ns to the very f|
00000810  69 72 73 74 20 66 75 6e  63 74 69 6f 6e 20 69 6e  |irst function in|
00000820  73 65 72 74 65 64 20 69  6e 74 6f 20 61 20 6d 65  |serted into a me|
00000830  6e 75 2e 0a 3c 2f 75 6c  3e 0a 3c 2f 62 6f 64 79  |nu..</ul>.</body|
00000840  3e 3c 2f 68 74 6d 6c 3e  0a                       |></html>.|
00000849