Home » Archimedes archive » Acorn User » AU 1997-10 A.adf » Extras » Apple][e/PD/BOB/ARMBOB/doc/!See/!Help/Write

Apple][e/PD/BOB/ARMBOB/doc/!See/!Help/Write

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 » Acorn User » AU 1997-10 A.adf » Extras
Filename: Apple][e/PD/BOB/ARMBOB/doc/!See/!Help/Write
Read OK:
File size: 0A01 bytes
Load address: 0000
Exec address: 0000
File contents
\#��
\ SeeHelp:Write version 0.0 �  G.C.Wraith  01/05/96

 �B#WRITING SEEFILES#
 
 This file is visible as �AWrite�7 if you click Adjust
 on the command �8*Filer_Opendir <See$Dir>.!Help�7.

 If you �1#SHIFT-DOUBLECLICK#�0 on this file's icon you will 
 see its underlying textual source. It is instructive to 
 compare this with what you see in a See-window.

 The first thing to note is the top line, which makes no
 appearance in the See-window. This line determines four
 things, in order:

 1.   �AThe comment character
 2.   �AThe changefont character
 3.   �AThe foreground colour character
 4.   �AThe background colour character

 The first line of a SeeFile is not displayed.
 Subsequently an instance of the comment character and
 all text following it, up to, but �1not�0 including
 the next newline, if any, is not displayed.
\ Here is a comment!
 The changefont character toggles use of the extra font.
 It is displayed as a space in the See-window.
\ For this file it is #.
 The foreground and background colour characters, if
 followed by a single hexadecimal digit, 0-9, A-F cause
 that colour to be set up to the next change, or up to the
 end of the line. The two characters, colour character and
 hexadecimal digit, are not displayed. To see which colours
 correspond to which numbers, click Select on the Palette
 icon on the iconbar (we are talking Risc OS 3.1 here).
\ For this file foreground colour is changed by �
\ and background colours by �.
 It is convenient to take top-bit-set characters for these,
 but you do not have to. � and � are convenient because
 they are accessible from the keyboard.
\ You can choose these characters how you like.
 The width of the window displaying the Seefile is determined
 by the maximum width of a line of text, including the
 undisplayed comment lines.

 For a test card �8*see SeeHelp:Test�7.

 You can, of course, use any colour combinations for commands:

                 �9*Time�0           �C�D*FontList�7�0

 It is suggested that you construct �1booklets�0 of SeeFiles
 by constructing an application, say a directory called !Booklet.
 Choose its appearance by creating a !Sprites file containing
 a sprite called !booklet. Put your individual SeeFiles inside
 !Booklet. If the initial page is called, say, index, then create
 an Obey file called !Run containing the lines

     �BSet Booklet$Path <Obey$Dir>.
     �BRun Booklet:index

 Then you can include commands of the form *See Booklet:xxx in
 your SeeFiles to open a SeeFile called xxx.

  �8*See SeeHelp:!Run�7  Return to index.
 
00000000  5c 23 a3 a4 0a 5c 20 53  65 65 48 65 6c 70 3a 57  |\#...\ SeeHelp:W|
00000010  72 69 74 65 20 76 65 72  73 69 6f 6e 20 30 2e 30  |rite version 0.0|
00000020  20 a9 20 20 47 2e 43 2e  57 72 61 69 74 68 20 20  | .  G.C.Wraith  |
00000030  30 31 2f 30 35 2f 39 36  0a 0a 20 a3 42 23 57 52  |01/05/96.. .B#WR|
00000040  49 54 49 4e 47 20 53 45  45 46 49 4c 45 53 23 0a  |ITING SEEFILES#.|
00000050  20 0a 20 54 68 69 73 20  66 69 6c 65 20 69 73 20  | . This file is |
00000060  76 69 73 69 62 6c 65 20  61 73 20 a3 41 57 72 69  |visible as .AWri|
00000070  74 65 a3 37 20 69 66 20  79 6f 75 20 63 6c 69 63  |te.7 if you clic|
00000080  6b 20 41 64 6a 75 73 74  0a 20 6f 6e 20 74 68 65  |k Adjust. on the|
00000090  20 63 6f 6d 6d 61 6e 64  20 a3 38 2a 46 69 6c 65  | command .8*File|
000000a0  72 5f 4f 70 65 6e 64 69  72 20 3c 53 65 65 24 44  |r_Opendir <See$D|
000000b0  69 72 3e 2e 21 48 65 6c  70 a3 37 2e 0a 0a 20 49  |ir>.!Help.7... I|
000000c0  66 20 79 6f 75 20 a4 31  23 53 48 49 46 54 2d 44  |f you .1#SHIFT-D|
000000d0  4f 55 42 4c 45 43 4c 49  43 4b 23 a4 30 20 6f 6e  |OUBLECLICK#.0 on|
000000e0  20 74 68 69 73 20 66 69  6c 65 27 73 20 69 63 6f  | this file's ico|
000000f0  6e 20 79 6f 75 20 77 69  6c 6c 20 0a 20 73 65 65  |n you will . see|
00000100  20 69 74 73 20 75 6e 64  65 72 6c 79 69 6e 67 20  | its underlying |
00000110  74 65 78 74 75 61 6c 20  73 6f 75 72 63 65 2e 20  |textual source. |
00000120  49 74 20 69 73 20 69 6e  73 74 72 75 63 74 69 76  |It is instructiv|
00000130  65 20 74 6f 20 0a 20 63  6f 6d 70 61 72 65 20 74  |e to . compare t|
00000140  68 69 73 20 77 69 74 68  20 77 68 61 74 20 79 6f  |his with what yo|
00000150  75 20 73 65 65 20 69 6e  20 61 20 53 65 65 2d 77  |u see in a See-w|
00000160  69 6e 64 6f 77 2e 0a 0a  20 54 68 65 20 66 69 72  |indow... The fir|
00000170  73 74 20 74 68 69 6e 67  20 74 6f 20 6e 6f 74 65  |st thing to note|
00000180  20 69 73 20 74 68 65 20  74 6f 70 20 6c 69 6e 65  | is the top line|
00000190  2c 20 77 68 69 63 68 20  6d 61 6b 65 73 20 6e 6f  |, which makes no|
000001a0  0a 20 61 70 70 65 61 72  61 6e 63 65 20 69 6e 20  |. appearance in |
000001b0  74 68 65 20 53 65 65 2d  77 69 6e 64 6f 77 2e 20  |the See-window. |
000001c0  54 68 69 73 20 6c 69 6e  65 20 64 65 74 65 72 6d  |This line determ|
000001d0  69 6e 65 73 20 66 6f 75  72 0a 20 74 68 69 6e 67  |ines four. thing|
000001e0  73 2c 20 69 6e 20 6f 72  64 65 72 3a 0a 0a 20 31  |s, in order:.. 1|
000001f0  2e 20 20 20 a3 41 54 68  65 20 63 6f 6d 6d 65 6e  |.   .AThe commen|
00000200  74 20 63 68 61 72 61 63  74 65 72 0a 20 32 2e 20  |t character. 2. |
00000210  20 20 a3 41 54 68 65 20  63 68 61 6e 67 65 66 6f  |  .AThe changefo|
00000220  6e 74 20 63 68 61 72 61  63 74 65 72 0a 20 33 2e  |nt character. 3.|
00000230  20 20 20 a3 41 54 68 65  20 66 6f 72 65 67 72 6f  |   .AThe foregro|
00000240  75 6e 64 20 63 6f 6c 6f  75 72 20 63 68 61 72 61  |und colour chara|
00000250  63 74 65 72 0a 20 34 2e  20 20 20 a3 41 54 68 65  |cter. 4.   .AThe|
00000260  20 62 61 63 6b 67 72 6f  75 6e 64 20 63 6f 6c 6f  | background colo|
00000270  75 72 20 63 68 61 72 61  63 74 65 72 0a 0a 20 54  |ur character.. T|
00000280  68 65 20 66 69 72 73 74  20 6c 69 6e 65 20 6f 66  |he first line of|
00000290  20 61 20 53 65 65 46 69  6c 65 20 69 73 20 6e 6f  | a SeeFile is no|
000002a0  74 20 64 69 73 70 6c 61  79 65 64 2e 0a 20 53 75  |t displayed.. Su|
000002b0  62 73 65 71 75 65 6e 74  6c 79 20 61 6e 20 69 6e  |bsequently an in|
000002c0  73 74 61 6e 63 65 20 6f  66 20 74 68 65 20 63 6f  |stance of the co|
000002d0  6d 6d 65 6e 74 20 63 68  61 72 61 63 74 65 72 20  |mment character |
000002e0  61 6e 64 0a 20 61 6c 6c  20 74 65 78 74 20 66 6f  |and. all text fo|
000002f0  6c 6c 6f 77 69 6e 67 20  69 74 2c 20 75 70 20 74  |llowing it, up t|
00000300  6f 2c 20 62 75 74 20 a4  31 6e 6f 74 a4 30 20 69  |o, but .1not.0 i|
00000310  6e 63 6c 75 64 69 6e 67  0a 20 74 68 65 20 6e 65  |ncluding. the ne|
00000320  78 74 20 6e 65 77 6c 69  6e 65 2c 20 69 66 20 61  |xt newline, if a|
00000330  6e 79 2c 20 69 73 20 6e  6f 74 20 64 69 73 70 6c  |ny, is not displ|
00000340  61 79 65 64 2e 0a 5c 20  48 65 72 65 20 69 73 20  |ayed..\ Here is |
00000350  61 20 63 6f 6d 6d 65 6e  74 21 0a 20 54 68 65 20  |a comment!. The |
00000360  63 68 61 6e 67 65 66 6f  6e 74 20 63 68 61 72 61  |changefont chara|
00000370  63 74 65 72 20 74 6f 67  67 6c 65 73 20 75 73 65  |cter toggles use|
00000380  20 6f 66 20 74 68 65 20  65 78 74 72 61 20 66 6f  | of the extra fo|
00000390  6e 74 2e 0a 20 49 74 20  69 73 20 64 69 73 70 6c  |nt.. It is displ|
000003a0  61 79 65 64 20 61 73 20  61 20 73 70 61 63 65 20  |ayed as a space |
000003b0  69 6e 20 74 68 65 20 53  65 65 2d 77 69 6e 64 6f  |in the See-windo|
000003c0  77 2e 0a 5c 20 46 6f 72  20 74 68 69 73 20 66 69  |w..\ For this fi|
000003d0  6c 65 20 69 74 20 69 73  20 23 2e 0a 20 54 68 65  |le it is #.. The|
000003e0  20 66 6f 72 65 67 72 6f  75 6e 64 20 61 6e 64 20  | foreground and |
000003f0  62 61 63 6b 67 72 6f 75  6e 64 20 63 6f 6c 6f 75  |background colou|
00000400  72 20 63 68 61 72 61 63  74 65 72 73 2c 20 69 66  |r characters, if|
00000410  0a 20 66 6f 6c 6c 6f 77  65 64 20 62 79 20 61 20  |. followed by a |
00000420  73 69 6e 67 6c 65 20 68  65 78 61 64 65 63 69 6d  |single hexadecim|
00000430  61 6c 20 64 69 67 69 74  2c 20 30 2d 39 2c 20 41  |al digit, 0-9, A|
00000440  2d 46 20 63 61 75 73 65  0a 20 74 68 61 74 20 63  |-F cause. that c|
00000450  6f 6c 6f 75 72 20 74 6f  20 62 65 20 73 65 74 20  |olour to be set |
00000460  75 70 20 74 6f 20 74 68  65 20 6e 65 78 74 20 63  |up to the next c|
00000470  68 61 6e 67 65 2c 20 6f  72 20 75 70 20 74 6f 20  |hange, or up to |
00000480  74 68 65 0a 20 65 6e 64  20 6f 66 20 74 68 65 20  |the. end of the |
00000490  6c 69 6e 65 2e 20 54 68  65 20 74 77 6f 20 63 68  |line. The two ch|
000004a0  61 72 61 63 74 65 72 73  2c 20 63 6f 6c 6f 75 72  |aracters, colour|
000004b0  20 63 68 61 72 61 63 74  65 72 20 61 6e 64 0a 20  | character and. |
000004c0  68 65 78 61 64 65 63 69  6d 61 6c 20 64 69 67 69  |hexadecimal digi|
000004d0  74 2c 20 61 72 65 20 6e  6f 74 20 64 69 73 70 6c  |t, are not displ|
000004e0  61 79 65 64 2e 20 54 6f  20 73 65 65 20 77 68 69  |ayed. To see whi|
000004f0  63 68 20 63 6f 6c 6f 75  72 73 0a 20 63 6f 72 72  |ch colours. corr|
00000500  65 73 70 6f 6e 64 20 74  6f 20 77 68 69 63 68 20  |espond to which |
00000510  6e 75 6d 62 65 72 73 2c  20 63 6c 69 63 6b 20 53  |numbers, click S|
00000520  65 6c 65 63 74 20 6f 6e  20 74 68 65 20 50 61 6c  |elect on the Pal|
00000530  65 74 74 65 0a 20 69 63  6f 6e 20 6f 6e 20 74 68  |ette. icon on th|
00000540  65 20 69 63 6f 6e 62 61  72 20 28 77 65 20 61 72  |e iconbar (we ar|
00000550  65 20 74 61 6c 6b 69 6e  67 20 52 69 73 63 20 4f  |e talking Risc O|
00000560  53 20 33 2e 31 20 68 65  72 65 29 2e 0a 5c 20 46  |S 3.1 here)..\ F|
00000570  6f 72 20 74 68 69 73 20  66 69 6c 65 20 66 6f 72  |or this file for|
00000580  65 67 72 6f 75 6e 64 20  63 6f 6c 6f 75 72 20 69  |eground colour i|
00000590  73 20 63 68 61 6e 67 65  64 20 62 79 20 a3 0a 5c  |s changed by ..\|
000005a0  20 61 6e 64 20 62 61 63  6b 67 72 6f 75 6e 64 20  | and background |
000005b0  63 6f 6c 6f 75 72 73 20  62 79 20 a4 2e 0a 20 49  |colours by ... I|
000005c0  74 20 69 73 20 63 6f 6e  76 65 6e 69 65 6e 74 20  |t is convenient |
000005d0  74 6f 20 74 61 6b 65 20  74 6f 70 2d 62 69 74 2d  |to take top-bit-|
000005e0  73 65 74 20 63 68 61 72  61 63 74 65 72 73 20 66  |set characters f|
000005f0  6f 72 20 74 68 65 73 65  2c 0a 20 62 75 74 20 79  |or these,. but y|
00000600  6f 75 20 64 6f 20 6e 6f  74 20 68 61 76 65 20 74  |ou do not have t|
00000610  6f 2e 20 a3 20 61 6e 64  20 a4 20 61 72 65 20 63  |o. . and . are c|
00000620  6f 6e 76 65 6e 69 65 6e  74 20 62 65 63 61 75 73  |onvenient becaus|
00000630  65 0a 20 74 68 65 79 20  61 72 65 20 61 63 63 65  |e. they are acce|
00000640  73 73 69 62 6c 65 20 66  72 6f 6d 20 74 68 65 20  |ssible from the |
00000650  6b 65 79 62 6f 61 72 64  2e 0a 5c 20 59 6f 75 20  |keyboard..\ You |
00000660  63 61 6e 20 63 68 6f 6f  73 65 20 74 68 65 73 65  |can choose these|
00000670  20 63 68 61 72 61 63 74  65 72 73 20 68 6f 77 20  | characters how |
00000680  79 6f 75 20 6c 69 6b 65  2e 0a 20 54 68 65 20 77  |you like.. The w|
00000690  69 64 74 68 20 6f 66 20  74 68 65 20 77 69 6e 64  |idth of the wind|
000006a0  6f 77 20 64 69 73 70 6c  61 79 69 6e 67 20 74 68  |ow displaying th|
000006b0  65 20 53 65 65 66 69 6c  65 20 69 73 20 64 65 74  |e Seefile is det|
000006c0  65 72 6d 69 6e 65 64 0a  20 62 79 20 74 68 65 20  |ermined. by the |
000006d0  6d 61 78 69 6d 75 6d 20  77 69 64 74 68 20 6f 66  |maximum width of|
000006e0  20 61 20 6c 69 6e 65 20  6f 66 20 74 65 78 74 2c  | a line of text,|
000006f0  20 69 6e 63 6c 75 64 69  6e 67 20 74 68 65 0a 20  | including the. |
00000700  75 6e 64 69 73 70 6c 61  79 65 64 20 63 6f 6d 6d  |undisplayed comm|
00000710  65 6e 74 20 6c 69 6e 65  73 2e 0a 0a 20 46 6f 72  |ent lines... For|
00000720  20 61 20 74 65 73 74 20  63 61 72 64 20 a3 38 2a  | a test card .8*|
00000730  73 65 65 20 53 65 65 48  65 6c 70 3a 54 65 73 74  |see SeeHelp:Test|
00000740  a3 37 2e 0a 0a 20 59 6f  75 20 63 61 6e 2c 20 6f  |.7... You can, o|
00000750  66 20 63 6f 75 72 73 65  2c 20 75 73 65 20 61 6e  |f course, use an|
00000760  79 20 63 6f 6c 6f 75 72  20 63 6f 6d 62 69 6e 61  |y colour combina|
00000770  74 69 6f 6e 73 20 66 6f  72 20 63 6f 6d 6d 61 6e  |tions for comman|
00000780  64 73 3a 0a 0a 20 20 20  20 20 20 20 20 20 20 20  |ds:..           |
00000790  20 20 20 20 20 20 a4 39  2a 54 69 6d 65 a4 30 20  |      .9*Time.0 |
000007a0  20 20 20 20 20 20 20 20  20 20 a4 43 a3 44 2a 46  |          .C.D*F|
000007b0  6f 6e 74 4c 69 73 74 a3  37 a4 30 0a 0a 20 49 74  |ontList.7.0.. It|
000007c0  20 69 73 20 73 75 67 67  65 73 74 65 64 20 74 68  | is suggested th|
000007d0  61 74 20 79 6f 75 20 63  6f 6e 73 74 72 75 63 74  |at you construct|
000007e0  20 a4 31 62 6f 6f 6b 6c  65 74 73 a4 30 20 6f 66  | .1booklets.0 of|
000007f0  20 53 65 65 46 69 6c 65  73 0a 20 62 79 20 63 6f  | SeeFiles. by co|
00000800  6e 73 74 72 75 63 74 69  6e 67 20 61 6e 20 61 70  |nstructing an ap|
00000810  70 6c 69 63 61 74 69 6f  6e 2c 20 73 61 79 20 61  |plication, say a|
00000820  20 64 69 72 65 63 74 6f  72 79 20 63 61 6c 6c 65  | directory calle|
00000830  64 20 21 42 6f 6f 6b 6c  65 74 2e 0a 20 43 68 6f  |d !Booklet.. Cho|
00000840  6f 73 65 20 69 74 73 20  61 70 70 65 61 72 61 6e  |ose its appearan|
00000850  63 65 20 62 79 20 63 72  65 61 74 69 6e 67 20 61  |ce by creating a|
00000860  20 21 53 70 72 69 74 65  73 20 66 69 6c 65 20 63  | !Sprites file c|
00000870  6f 6e 74 61 69 6e 69 6e  67 0a 20 61 20 73 70 72  |ontaining. a spr|
00000880  69 74 65 20 63 61 6c 6c  65 64 20 21 62 6f 6f 6b  |ite called !book|
00000890  6c 65 74 2e 20 50 75 74  20 79 6f 75 72 20 69 6e  |let. Put your in|
000008a0  64 69 76 69 64 75 61 6c  20 53 65 65 46 69 6c 65  |dividual SeeFile|
000008b0  73 20 69 6e 73 69 64 65  0a 20 21 42 6f 6f 6b 6c  |s inside. !Bookl|
000008c0  65 74 2e 20 49 66 20 74  68 65 20 69 6e 69 74 69  |et. If the initi|
000008d0  61 6c 20 70 61 67 65 20  69 73 20 63 61 6c 6c 65  |al page is calle|
000008e0  64 2c 20 73 61 79 2c 20  69 6e 64 65 78 2c 20 74  |d, say, index, t|
000008f0  68 65 6e 20 63 72 65 61  74 65 0a 20 61 6e 20 4f  |hen create. an O|
00000900  62 65 79 20 66 69 6c 65  20 63 61 6c 6c 65 64 20  |bey file called |
00000910  21 52 75 6e 20 63 6f 6e  74 61 69 6e 69 6e 67 20  |!Run containing |
00000920  74 68 65 20 6c 69 6e 65  73 0a 0a 20 20 20 20 20  |the lines..     |
00000930  a3 42 53 65 74 20 42 6f  6f 6b 6c 65 74 24 50 61  |.BSet Booklet$Pa|
00000940  74 68 20 3c 4f 62 65 79  24 44 69 72 3e 2e 0a 20  |th <Obey$Dir>.. |
00000950  20 20 20 20 a3 42 52 75  6e 20 42 6f 6f 6b 6c 65  |    .BRun Bookle|
00000960  74 3a 69 6e 64 65 78 0a  0a 20 54 68 65 6e 20 79  |t:index.. Then y|
00000970  6f 75 20 63 61 6e 20 69  6e 63 6c 75 64 65 20 63  |ou can include c|
00000980  6f 6d 6d 61 6e 64 73 20  6f 66 20 74 68 65 20 66  |ommands of the f|
00000990  6f 72 6d 20 2a 53 65 65  20 42 6f 6f 6b 6c 65 74  |orm *See Booklet|
000009a0  3a 78 78 78 20 69 6e 0a  20 79 6f 75 72 20 53 65  |:xxx in. your Se|
000009b0  65 46 69 6c 65 73 20 74  6f 20 6f 70 65 6e 20 61  |eFiles to open a|
000009c0  20 53 65 65 46 69 6c 65  20 63 61 6c 6c 65 64 20  | SeeFile called |
000009d0  78 78 78 2e 0a 0a 20 20  a3 38 2a 53 65 65 20 53  |xxx...  .8*See S|
000009e0  65 65 48 65 6c 70 3a 21  52 75 6e a3 37 20 20 52  |eeHelp:!Run.7  R|
000009f0  65 74 75 72 6e 20 74 6f  20 69 6e 64 65 78 2e 0a  |eturn to index..|
00000a00  20                                                | |
00000a01