home *** CD-ROM | disk | FTP | other *** search
/ Tools en Utilities / CDASS_5.ISO / shell / file / smed102.arj / MANUAL.TXT < prev    next >
Encoding:
Text File  |  1995-05-01  |  13.7 KB  |  318 lines
  1. ****************************
  2. *                          *
  3. *        MANUAL.TXT        *
  4. *                          *
  5. ****************************
  6. * Manual for Smooth Editor *
  7. ****************************
  8.  
  9.  
  10. Contents:
  11. ---------
  12. Chapter 1. Introduction to Smooth Editor.
  13. Chapter 2. Installing Smooth Editor.
  14. Chapter 3. Using Smooth Editor.
  15. Chapter 4. Scrolling and moving.
  16. Chapter 5. Block functions.
  17. Chapter 6. Wrapping.
  18. Chapter 7. Menu functions.
  19. Chapter 8. Key functions.
  20.  
  21.  
  22. Chapter 1. Introduction to Smooth Editor.
  23. -----------------------------------------
  24.  
  25. Smooth Editor is an ASCI-text editor, like DOS EDIT, that uses smooth 
  26. scrolling. Smooth scrolling is a way of moving text over the screen with a 
  27. speed that is synchronized with the frequency at which the image is built on 
  28. the screen. For instance with VGA video cards, the screen image is refreshed 
  29. 70 times per second. If the image on screen is moved one pixel every 1/70th of 
  30. a second, what we see is an absolutely fluid motion.
  31.  
  32. Apart from horizontal and vertical smooth (and smoothly accelerated) scrolling 
  33. these features are incorporated in SE:
  34.  
  35. - Usage of XMS memory when available, leading to virtually unlimited file
  36.   lengths.
  37. - Multiple documents open at the same time.
  38. - Extensive Undo and Redo functions, number of Undo and Redo levels limited
  39.   only by 32kB buffers.
  40. - Symbol table for inserting other than standard characters.
  41. - Cut/Copy/Paste functions using XMS when available.
  42. - Customizable scroll speeds and color usage.
  43. - Word-wrap functions.
  44. - Fades, growing and shrinking windows.
  45.  
  46. Smooth Editor is released under the Shareware concept. For more information see 
  47. README.TXT.
  48.  
  49.  
  50.  
  51. Chapter 2. Installing Smooth Editor.
  52. ------------------------------------
  53.  
  54. To use Smooth Editor you need a PC with:
  55. - 80386 processor or higher.
  56. - VGA video card or higher.
  57.  
  58. For editing large files you need:
  59. - At least 508 kB of free conventional memory.
  60. - Extended memory.
  61. - An XMS-driver (like HIMEM.SYS or QEMM).
  62.  
  63. To install Smooth editor, you can copy the SE.EXE program to a directory that 
  64. is part of the Path (that is mentioned after the PATH statement in the 
  65. AUTOEXEC.BAT). Or, if you use DOSKEY you can include it in a DOSKEY macro, for 
  66. instance with this instruction in the AUTOEXEC.BAT:
  67.  
  68. DOSKEY SE=C:\SE\SE.EXE $*
  69.  
  70. If you want to use Smooth Editor under Microsoft Windows, the SE.PIF file 
  71. should be in the same directory. The important settings are:
  72. XMS-memory kB limit: -1
  73. Execution: Exclusive checked.
  74.  
  75. If you use Smooth Editor from the command line within a DOS-box under Windows 
  76. and you have a number of applications running, you may experience stuttering 
  77. scrolling. To solve this you can close down the DOS-box (using the `EXIT' 
  78. command), set the Execution: Exclusive checkbox in the DOSPRMPT.PIF and start 
  79. a new DOS-box.
  80.  
  81.  
  82.  
  83. Chapter 3. Using Smooth Editor.
  84. -------------------------------
  85.  
  86. When you first start up Smooth editor, you will be asked whether you would 
  87. like to see the demo. This demo demonstrates a number of functions. If you 
  88. want to see this demo again later, delete the SE.INI file before you start SE.
  89.  
  90. To edit an existing text file, start SE with the name of the file after SE:
  91.  
  92. SE MYTEXT.TXT
  93.  
  94. You can use wildcards (* and ?). SE will open all matching files.
  95. Of course you can also just use SE. Smooth Editor will then start up with the 
  96. File Open window. If you want to start with a new file you can press the 
  97. Escape key to exit this window.
  98.  
  99. What you see now is an empty screen with one line of information at the 
  100. bottom. This is the status line. On the left, it shows the file name (at 
  101. startup this displays: `Esc: Menu  F1: Help'. When the arrow right key is 
  102. pressed this will change into the file name). Next to that the flags are 
  103. shown, five three letter abbreviations that indicate the state of the program. 
  104. When a flag is white it indicates that that state is on, when it is dark gray 
  105. it means that it is off. The five flags are:
  106.  
  107. - MOD        : Modified, this indicates that the file has been altered since
  108.                the last load or save.
  109. - INS        : Insert mode. Typing is inserted at the cursor position.
  110. - OVR        : Overwrite mode. Typing overwrites the text under the cursor.
  111.                The Insert button switches between insert and overwrite mode.
  112. - CLB        : Data present in Clipboard (from Cut or Copy).
  113. - WRP        : WordWrap mode (see menu option WordWrap).
  114.  
  115. On the right side of the status line four numbers are displayed:
  116.  
  117. S:xx         : Indicates current scroll speed in lines per frame.
  118. C:xxx        : Current Column.
  119. L: xxxx/ xxxx: Current Line / Total number of lines in the current file.
  120.  
  121. In Smooth Editor you can use the Escape or Alt buttons to enter the menu. In 
  122. the menu you can use the arrow keys and the Enter key to navigate through the 
  123. items. You can also use the character keys to move to the items with the same 
  124. characters highlighted.
  125.  
  126. Many functions in Smooth Editor can be called with more than one key. This is 
  127. done, so that if you are used to different hotkeys, you can use SE without 
  128. having to learn new keys.
  129.  
  130. To exit SE for instance, you can use F12, Alt+F4, Ctrl+q or use the menu 
  131. option with ALT+F,X.
  132.  
  133. You can get on-line help with the F1 key.
  134.  
  135. Every change tot the document can be undone with Ctrl+Z, Ctrl+U or the Undo 
  136. menu option with Alt+E,U. By repeatedly undoing you can trace back all your 
  137. steps. The MOD (Modified) flag is updated when you undo, so you can see when 
  138. the file is in the original state again. After you undo changes you can redo 
  139. them with Ctrl+R, Ctrl+Shift+Z or the Redo menu option with Alt+E,R. Undo and 
  140. Redo are both limited to 32 kB of data.
  141.  
  142.  
  143.  
  144. Scroll speeds and color usage are set in the SE.INI file. When SE starts up, 
  145. it checks the directory where SE.EXE is located for SE.INI. If it is not there 
  146. SE will look for it in the path (that is mentioned after the PATH statement in 
  147. the AUTOEXEC.BAT). If it is still not found SE will create a new SE.INI in the 
  148. directory where SE.EXE is located. In this file all parameters will be set to 
  149. their default values.
  150.  
  151. Other than standard characters can be inserted by typing Alt+0. A window will 
  152. appear with all possible characters. You can choose a character by typing it's 
  153. code or by moving the blue cursor to it.
  154.  
  155.  
  156.  
  157. Chapter 4. Scrolling and moving.
  158. --------------------------------
  159.  
  160. The following keys are used for scrolling and moving through the file:
  161. With the arrow keys, the cursor can be moved through the text. The text 
  162. scrolls when necessary.
  163.  
  164. The PageUp and PageDown keys can be used in two ways. When they are tipped 
  165. shortly the text scrolls one page quickly with smooth acceleration and 
  166. deceleration. When they are kept down the acceleration stops at a lower speed.
  167.  
  168. When the Ctrl key is kept down, the Arrow up and down keys accelerate the text 
  169. scrolling. In this way you can control the scrolling speed. With the Ctrl key 
  170. kept down, the PageUp and PageDown key accelerate the text scrolling at a 
  171. faster rate.
  172.  
  173. Ctrl+arrow right and Ctrl+arrow left move the cursor to the next / previous 
  174. word, scrolling when necessary. Ctrl+Home moves to the beginning of the text, 
  175. Ctrl+End moves to the end.
  176.  
  177. The scroll speeds can be changed by editing SE.INI. This is a menu option in 
  178. the File menu.
  179.  
  180. The long vertical scrolls can be sped up by pressing the Escape button.
  181.  
  182.  
  183.  
  184. Chapter 5. Block functions.
  185. ---------------------------
  186.  
  187. When the position of the cursor changes with the shift key pressed, the text 
  188. between the old and the new cursor position will be selected. This is 
  189. indicated by the fact that this text becomes inverted.
  190.  
  191. With the menu function Cut, or the keys Ctrl+X or Shift+Delete the selected 
  192. text will be copied to the clipboard and deleted from the text. The CLB flag 
  193. at the bottom of the screen will turn white to indicate that there is 
  194. information on the clipboard.
  195.  
  196. With the menu function Copy, or the keys Ctrl+C or Ctrl+Insert the selection 
  197. will only be copied to the clipboard.
  198.  
  199. If the functions Cut and Copy are used when there's no selection, the whole 
  200. current line will be cut or copied.
  201.  
  202. With the menu function Paste, or the keys Ctrl+V or Shift+Insert the text on 
  203. the clipboard will be copied to the cursor position. If there is a selection 
  204. this text will be overwritten, otherwise it will be inserted before the cursor 
  205. position.
  206.  
  207. If the Delete key is pressed while there is a selection, the selection will be 
  208. deleted.
  209.  
  210. Ctrl + -(minus key) types a character from the previous sentence.
  211.  
  212. F9 copies the current line.
  213. F10 cuts the current line.
  214. F11 pastes before the current line.
  215.  
  216.  
  217.  
  218. Chapter 6. Wrapping.
  219. --------------------
  220.  
  221. With the Wrap Document menu function, or with Ctrl+D, all lines in the 
  222. document longer than 80 characters will be split in shorter lines. The lines 
  223. will be split at spaces, so that all the words remain intact.
  224.  
  225. With the Toggle WordWrap menu function, or with Ctrl+W, the WordWrap mode is 
  226. enabled or disabled. If it is enabled the WRP flag in the status line will be 
  227. white. With this mode, if you type in a line longer than 80 characters, it 
  228. will be split in two lines, moving the last word to the next line.
  229.  
  230.  
  231.  
  232. Chapter 7. Menu functions.
  233. --------------------------
  234.  
  235. File menu  ------- New             -Deletes text in memory and starts with new
  236.                                     file.
  237.             ------ Open            -Opens the File Open Window. Here you can
  238.                                     navigate through the directories and
  239.                                     choose a file you want to edit.
  240.              ----- Save            -Save current file.
  241.               ---- Save As         -Opens the File Save Window.
  242.                --- Print           -Prints current file. If there is a
  243.                                     selection you will be asked whether you
  244.                                     want to print the selection or the whole
  245.                                     file.
  246.                 -- Edit SE.INI     -Opens the file SE.INI for editing. In it
  247.                                     you can change the scrolling speeds and
  248.                                     the color usage.
  249.                  - Exit            -Quits SE and returns to the OS (for
  250.                                     instance DOS).
  251.  
  252. Edit menu -------- Undo            -Undoes last action.
  253.            ------- Redo            -Undoes last undo.
  254.             ------ Cut             -Cuts selection or line (see chapter @).
  255.              ----- Copy            -Copies selection or line (see chapter @).
  256.               ---- Paste           -Pastes over selection or before cursor
  257.                                     position (see chapter @).
  258.                --- Clear           -Deletes selection.
  259.                 -- Symbol          -Opens the symbol table window. With it you
  260.                                     can insert any character.
  261.                  - Select All      -Selects whole file.
  262.  
  263. Wrapping menu   -- Toggle WordWrap -Sets/clears WordWrap mode (See Chapter @).
  264.                  - Wrap document   -Splits long lines (See Chapter @).
  265.  
  266. Search         --- Find            -The program will ask for a search string.
  267.                                     It will then search the document from the
  268.                                     cursor for that string.
  269.                 -- Find Previous   -Searches from the cursor upward for the
  270.                                     last entered search string.
  271.                  - Find Next       -Searches from the cursor downward for the
  272.                                     last entered search string.
  273.  
  274. Help menu       -- Help            -Shows three screen of useful information.
  275.                  - About           -Shows some information about Smooth
  276.                                     Editor.
  277.  
  278.  
  279.  
  280. Chapter 8. Key functions.
  281. -------------------------
  282.  
  283. Escape, Alt            : Enters menu.
  284. F12, Alt+F4, Ctrl+q    : Exit Smooth Editor.
  285. F1                     : This on-line help.
  286. Alt+<Number>           : Insert symbol, by number or from table.
  287. Ctrl+Z, Ctrl+U         : Undo. Undo levels limited only by 32k buffer.
  288. Ctrl+Shift+Z, Ctrl+R   : Redo. Redo levels limited only by 32k buffer.
  289.  
  290. PageUp, PageDown       : - Only tipped shortly: A quick one-page scroll.
  291.                          - Sustained          : Scroll with constant speed.
  292. Ctrl + Up,Down         : Accelerate scroll slowly.
  293. Ctrl + PageUp,PageDown : Accelerate scroll fast.
  294.                         (With this accelerated scrolling the cursor position
  295.                          does not change until it reaches the screen border.
  296.                          Scrolling stops when Ctrl is released.)
  297. Ctrl + Right,Left      : Move to next/previous word.
  298. Ctrl + Home,End        : Move to begin/end of file.
  299.  
  300. Shift+ cursor movement : Selection.
  301. Ctrl+X, Shift+Delete   : - With selection   : Cut selection.
  302.                          - Without selection: Cut current line.
  303. Ctrl+C, Ctrl+Insert    : - With selection   : Copy selection.
  304.                          - Without selection: Copy current line.
  305. Ctrl+V, Shift+Insert   : - With selection   : Paste, overwriting selection.
  306.                          - Without selection: Paste before cursor position.
  307. Delete(with selection) : Delete selection.
  308. Ctrl + - (minus key)   : Type from previous line.
  309.  
  310. Ctrl+D                 : Wrap document. All lines longer than 80 characters
  311.                          will be split at spaces between words.
  312. Ctrl+W                 : Toggle WordWrap mode. When the line length exceeds 80
  313.                          in this mode, the last word will be moved to the next
  314.                          line.
  315.  
  316. Other key combination are mentioned in the menu functions between square 
  317. brackets.
  318.