home *** CD-ROM | disk | FTP | other *** search
/ Acorn User 1 / AU_CD1.iso / demos / a_to_i / dbedit / !DBEdit / ReadMe < prev    next >
Text File  |  1992-09-06  |  6KB  |  168 lines
  1.  
  2. ------------------------------ ReadMe for DBEdit --------------------------
  3.  
  4. As DBEdit has been constantly evolving since inception, it has been hard
  5. to get everything into the manual. Every time I thought the editor was
  6. finished, someone would say "How about doing..." (often enough, that
  7. someone was me).
  8.  
  9. This document describes features of the editor that have not been covered
  10. within the manual. Some knowledge of DBEdit is assumed and this text is
  11. best read after, or in conjunction with, the manual.
  12.  
  13.  
  14. --------------------------------------------------------------------------
  15.                                   One Key
  16. --------------------------------------------------------------------------
  17.  
  18. One Key is a method by which you can follow the logic of a program through
  19. calls and returns via single keystrokes.
  20.  
  21. The keystrokes Ctrl 1 through Ctrl 4 may be used to initiate a Find Next
  22. from the start of a program using a search string optionally based on the
  23. word in the editor that currently contains the caret.
  24.  
  25. Obvious uses of this facility are procedure and function calls in BASIC and
  26. the use of labels in Assembly. With this in mind, the first two search
  27. strings in the "One Key" dialog box off the "Search" submenu are initially
  28. defined as:
  29.  
  30. Ctrl 1: "<DEF$&"       Find the definition of a Procedure or Function.
  31. Ctrl 2: "<.&"          Find the label referenced within Assembly code.
  32.  
  33.  
  34. Wildcards for One Key
  35. ---------------------
  36.  
  37. In the search strings, the standard wildcards may be used (the examples use
  38. "<" for start of line, and "$" for 0..many spaces). See the manual or
  39. online help for more details on these. The case sensitivity flag is obeyed.
  40.  
  41. The extra wildcard "Current Word" (default value [&] ) may also be used.
  42. DBEdit assumes the start/end of the line, or any of the following
  43. characters indicate the bounds of the "current word":
  44. ( ) [ ] < > . , ; : ' " + - * / = and the space character.
  45.  
  46.  
  47. One Key Examples
  48. ----------------
  49.  
  50. If the caret is within the word "PROCcancel" of the line:
  51.  
  52. IF Quit% THEN PROCcancel:PROCexit:END
  53.  
  54. and you press Ctrl 1, DBEdit will search for "<DEF$PROCcancel". 
  55.  
  56.  
  57. If the caret is anywhere along the word "SetSrchFlags" in the line:
  58.  
  59.           BL      SetSrchFlags   ; Initialise search flags for find next
  60.  
  61. and you press Ctrl 2, DBEdit will search for "<.SetSrchFlags"
  62.  
  63.  
  64. Returning from Searches
  65. -----------------------
  66.  
  67. Once you have inspected the target of the find, the obvious requirement
  68. is a single keystroke to return. Ctrl B accesses an eight level stack of
  69. return points allowing you to freely look at procedures/functions/labels/
  70. etc., and return to the previous position within the code instantly.
  71.  
  72. In the first example above, you might well want to inspect PROCexit after
  73. you have seen the definition of PROCcancel. Press Ctrl B, move the
  74. caret over to the P of PROCexit, and press Ctrl 1 again, and there it is.
  75.  
  76. The current position of the caret / work area is stored whenever a search
  77. is initiated by whatever means, so you can also use Ctrl B to return from
  78. incremental searches and "Find box" finds.
  79.  
  80.  
  81. Personalisation of One Key searches
  82. -----------------------------------
  83.  
  84. You may modify the search strings and "current word" wildcard character at
  85. any time. The new values may be saved with the profile in the normal
  86. fashion.
  87.  
  88.  
  89. --------------------------------------------------------------------------
  90.                              Three D Icons
  91. --------------------------------------------------------------------------
  92.  
  93. **** Make a backup of DBEdit before you try the following suggestions ****
  94.  
  95. DBEdit supports some of the 3D effects offered by RiscOS 3 and if you feel
  96. competent, you can enhance these further by editing the template file
  97.  
  98. DBEdit also caters for the use of 3D selection buttons even under RiscOS 2.
  99. Edit the !Sprites file using !Paint and change the sprite named "3d_no" to
  100. "no" and "3d_yes" to "yes". Save the new !Sprites file then double click on
  101. DBEdit's !Boot file to activate the new sprites.
  102.  
  103. Note: ALL tick and cross icons in RiscOS (not just within DBEdit) will now
  104. use the new sprites.
  105.  
  106.  
  107. --------------------------------------------------------------------------
  108.                            Copy Sequence Mode
  109. --------------------------------------------------------------------------
  110.  
  111. To make the Copy mode (where the caret is split into two) more useful,
  112. two new keystrokes have been added.
  113.  
  114. Once the mode has been entered in the normal fashion, as well as the Copy
  115. key copying a single character, multiple characters may be copied via:
  116.  
  117. Shift Copy - All characters up to the end of the "current word" (as
  118.              described earlier in this document).
  119.            - If the first character to copy is a double quote, then DBEdit
  120.              will copy to the next double quote or end of the line.
  121.  
  122. Ctrl Copy  - All characters to end of the line.
  123.  
  124.  
  125. --------------------------------------------------------------------------
  126.                            New Colour Controls
  127. --------------------------------------------------------------------------
  128.  
  129. Comment text
  130. ------------
  131.  
  132. One of the guys at work wrote a program for listing source on the mainframe
  133. at work, that incorporated what I thought was a neat idea. To make the
  134. comments stand out from the other text, display them in a different colour.
  135.  
  136. The Profile box now contains an extra colour control titled "Comment text".
  137. This works in the same way as the other colour controls in this dialog box,
  138. and the REM line in the example window shows the chosen colour.
  139.  
  140. Once set, all lines beginning in column one with:
  141.  REM : - / ; \ ( or {
  142. will be displayed in the different colour. To disable this feature, simply
  143. set the "Comment text" the be the same as "Work Foreground".
  144.  
  145.  
  146. Highlighted text
  147. ----------------
  148.  
  149. Originally, DBEdit chose the colour for the highlighted text based on a
  150. built in table and according to the colours chosen for the foreground and
  151. background of the work area. While I was adding the ability to select the
  152. comment text colour, I decided to give user control over the highlight
  153. colour as well.
  154.  
  155. As with the "Comment text" control in the Profile dialog box, there is also
  156. a control "Highlighted text" so the highlight colour can be set.
  157.  
  158.  
  159. Other combinations
  160. ------------------
  161.  
  162. I hope you will like the default colours I have set. Another possible
  163. combination is "Comment text" in dark blue, and "Highlighted text" in red.
  164.  
  165.  
  166. ----------------------------- End of ReadMe -------------------------------
  167.  
  168.