home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / programming / armbob / armbob_1 / ARMBOB / doc / !See / !Help / Write < prev   
Encoding:
Text File  |  1996-07-24  |  2.5 KB  |  67 lines
  1. \#£¤
  2. \ SeeHelp:Write version 0.0 ©  G.C.Wraith  01/05/96
  3.  
  4.  £B#WRITING SEEFILES#
  5.  
  6.  This file is visible as £AWrite£7 if you click Adjust
  7.  on the command £8*Filer_Opendir <See$Dir>.!Help£7.
  8.  
  9.  If you ¤1#SHIFT-DOUBLECLICK#¤0 on this file's icon you will 
  10.  see its underlying textual source. It is instructive to 
  11.  compare this with what you see in a See-window.
  12.  
  13.  The first thing to note is the top line, which makes no
  14.  appearance in the See-window. This line determines four
  15.  things, in order:
  16.  
  17.  1.   £AThe comment character
  18.  2.   £AThe changefont character
  19.  3.   £AThe foreground colour character
  20.  4.   £AThe background colour character
  21.  
  22.  The first line of a SeeFile is not displayed.
  23.  Subsequently an instance of the comment character and
  24.  all text following it, up to, but ¤1not¤0 including
  25.  the next newline, if any, is not displayed.
  26. \ Here is a comment!
  27.  The changefont character toggles use of the extra font.
  28.  It is displayed as a space in the See-window.
  29. \ For this file it is #.
  30.  The foreground and background colour characters, if
  31.  followed by a single hexadecimal digit, 0-9, A-F cause
  32.  that colour to be set up to the next change, or up to the
  33.  end of the line. The two characters, colour character and
  34.  hexadecimal digit, are not displayed. To see which colours
  35.  correspond to which numbers, click Select on the Palette
  36.  icon on the iconbar (we are talking Risc OS 3.1 here).
  37. \ For this file foreground colour is changed by £
  38. \ and background colours by ¤.
  39.  It is convenient to take top-bit-set characters for these,
  40.  but you do not have to. £ and ¤ are convenient because
  41.  they are accessible from the keyboard.
  42. \ You can choose these characters how you like.
  43.  The width of the window displaying the Seefile is determined
  44.  by the maximum width of a line of text, including the
  45.  undisplayed comment lines.
  46.  
  47.  For a test card £8*see SeeHelp:Test£7.
  48.  
  49.  You can, of course, use any colour combinations for commands:
  50.  
  51.                  ¤9*Time¤0           ¤C£D*FontList£7¤0
  52.  
  53.  It is suggested that you construct ¤1booklets¤0 of SeeFiles
  54.  by constructing an application, say a directory called !Booklet.
  55.  Choose its appearance by creating a !Sprites file containing
  56.  a sprite called !booklet. Put your individual SeeFiles inside
  57.  !Booklet. If the initial page is called, say, index, then create
  58.  an Obey file called !Run containing the lines
  59.  
  60.      £BSet Booklet$Path <Obey$Dir>.
  61.      £BRun Booklet:index
  62.  
  63.  Then you can include commands of the form *See Booklet:xxx in
  64.  your SeeFiles to open a SeeFile called xxx.
  65.  
  66.   £8*See SeeHelp:!Run£7  Return to index.
  67.