home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 1 / ARM_CLUB_CD.iso / contents / apps / program / d / exthelp / !StrongHlp / HelpData / StrongHelp / Helpdata next >
Encoding:
Text File  |  1992-12-16  |  4.8 KB  |  163 lines
  1. Help on StrongHelp
  2.       StrongHelp v 1.20
  3.  
  4. This program is part of the
  5. !StrongED2 package, and is not
  6. to be distributed separately.
  7.  
  8.         * <How to Use =>Use> *
  9.         * <How to Edit=>Edit> *
  10.         * <Tech. Info =>tech> *
  11.         * <RiscOS 3   =>RO3> *
  12.         * <Credits    > *
  13.  
  14.    Guttorm 'ArmStrong' Vik.Main Menu :
  15. You can get help on :
  16.  
  17. #Indent 6
  18. <Assembly=>Assembly.$>
  19. <Basic   =>Basic.$>
  20. <Filetypes=>Filetypes.$>
  21. <Machine =>Machine.$>
  22. <SWI     =>SWI.$>
  23. <StrongHelp=>StrongHelp.$>
  24. <VDU     =>VDU.$>
  25. #indent 5
  26.  _
  27. (-)rmStrongHow to use StrongHelp
  28. * Click on the iconbar icon to open the main
  29.   help-page.
  30.   
  31. * Click on red words to go to new pages. If
  32.   you use adjust, the old page will disappear.
  33.   
  34. * Close page with adjust to open parent page.
  35.   If you press shift, then old page will stay.
  36.   
  37. * Press F1 in StrongED2 to search for a page
  38.   for the word the caret is in.
  39.  
  40. * You can copy from a page by pressing
  41.   Shift-Menu, and dragging to your own text.
  42.  
  43. * If you drop a file on StrongHelp's iconbar
  44.   icon, it will try to find a description of
  45.   this filetype. Note that very few filetypes
  46.   are currently described.How to Edit
  47. New help-system:
  48.   * Create empty directory in HelpData$Dir
  49.   * Run StrongHelp
  50.  
  51. Open Index:
  52.   * Select help from menu, with Shift down.
  53.  
  54. New help-page:
  55.   * Drag textfile to index
  56.  
  57. Change page:
  58.   * Save to editor from index, or from page itself (shift-menu)
  59.   * Drag back to page (shift down), or delete from index & drag there.
  60.  
  61.   * You can also select "Edit" from the index menu, or the savebox.
  62.     This will send the text directly to any avalable text editor which
  63.     supports the "External Edit" protocol. To send text back to
  64.     StrongHelp, just do F3 + Return (or something..) in the editor..
  65.  
  66. Note : If you alter any of the supplied help-systems, you'll have to
  67.        do it all again when the next version comes along.
  68.  
  69. If you want to create some help, then please *DON'T* just copy the
  70. text from Acorn's manuals. It's not legal..Page syntax
  71. First line is title. If this is empty, the page won't
  72. have a title-bar, and thus: no close-icon..
  73.  
  74. Then comes the page text.
  75. Everything appears as written, except :
  76.  
  77.   \< x >    x is displayed in red. When you click on it,
  78.            StrongHelp tries to open a help page called x.
  79.  
  80.   \<x=>y>   x is displayed in red. When you click on it,
  81.            StrongHelp tries to open a help page called y.
  82.  
  83.   \<x=>y.z> x is displayed in red. When you click on it,
  84.            StrongHelp tries to open a help page called z,
  85.            from the helpsystem y.
  86.  
  87.   \<x=>*y>  x is displayed in blue. When you click on it,
  88.            StrongHelp tries to execute the command y.
  89.  
  90.   \\c       '\\c' is replaced with 'c'. This is so that
  91.            you can use '\<' in normal text,
  92.            and '=' and '>' inside \<>
  93.  
  94.   #Table x y
  95.    Lines between here, will be arranged into x lines and
  96.    as many columns as necessary. Y is width of columns.
  97.   #EndTable
  98.  
  99.   #Prefix str
  100.    When a prefix string is set, \< x > is displayed as
  101.    before, but when you click on it StrongHelp tries
  102.    to open a helppage called str + x.
  103.  
  104.   #Indent x
  105.    The following lines will be indented with x spaces.
  106.  
  107.   #Sprite x,y sprite1[,sprite2] [=>link]
  108.    ( For the time beeing, this can only use the
  109.      wimp sprites. )
  110.  
  111. Take a look at some of the help-entries already present.File Formats
  112. There are two files:
  113.  
  114. Index
  115.   First word is number of entries (N)
  116.   Then comes N 4-word entries, containing
  117.      offset to name
  118.      offset to help-page (in other file)
  119.      lenght of help-page
  120.      flags :
  121.        bit 0 set if searchable
  122.        bit 1 set if postfix *
  123.   Finally comes N \\0-terminated names
  124.  
  125. HelpData:
  126.   Contains N help-pagesRiscOS 3
  127. When I first made this program, I redefined some
  128. characters to do simple graphics. These characters
  129. (‘’‹›“”„–—−Œœ†) that were unused under RO2, are now
  130. used by RO3.
  131. Because of this, there is an option to turn the
  132. redefine on/off. With redefine off, some of the
  133. help-entries look rather strange ( such as <this=>machine.$>.. )Technicals
  134. * <Page Syntax=>syntax> *
  135. * <File format=>format> *
  136. * <Commands   =>comm> *Commands
  137. Commands are sent to StrongHelp using
  138. my own "<Dialogue>" protocol. This will
  139. be replaced with CC's "Intuition" at a
  140. later stage.
  141.  
  142. Commands recognized:
  143.  
  144. Help_Install pathname [-DieWithTask]
  145.   If -DieWithTask switch is on,
  146.   StrongHelp will delete the
  147.   help-system when sender dies.
  148.  
  149. Help_Word    [helpsystem.]word
  150.   If helpsystem is specified, any
  151.   word from that will be checked.
  152.   If not, all searchable words in
  153.   all helpsystems will be checked.Dialogue
  154. Broadcast string with usermessage &43B00, or
  155. the *Message command. The latter requires the
  156. Dialogue module to be present.
  157.  
  158. Note: The *Message command installs itself as
  159. a wimp-task to send the message, and then
  160. quits, so you can't use the -DieWithTask switchCredits
  161. Most of the help-data is written by
  162. me, but all the Sound swis, and a few
  163. others, are written by Eduard Pfarr.