**************************** * * * MANUAL.TXT * * * **************************** * Manual for Smooth Editor * **************************** for version 2.1 Contents: --------- Chapter 1. Introduction to Smooth Editor. Chapter 2. Installing Smooth Editor. Chapter 3. Using Smooth Editor. Chapter 4. Scrolling and moving. Chapter 5. Block functions. Chapter 6. Macro's. Chapter 7. Wrapping. Chapter 8. SE.INI settings. Chapter 9. Menu functions. Chapter10. Keyboard functions. Chapter 1. Introduction to Smooth Editor ---------------------------------------- Smooth Editor is a DOS text editor with FAST smooth scrolling and complete Windows(R) interface. Smooth scrolling is a way of moving text over the screen with a speed that is synchronized with the frequency at which the image is built on the screen. For instance with VGA video cards, the screen image is refreshed 70 times per second. If the image on screen is moved one pixel every 1/70th of a second, what we see is an absolutely fluid motion. Smooth Editor uses horizontal and vertical smooth and smoothly accelerated scrolling. The Windows interface makes it possible to use cut/copy/paste from and to Windows applications, to use drag/drop from the file manager and to have Smooth Editor close down like other applications under Windows, with a save file query if necessary, when you exit Windows. For more information about the Windows interface, see the SEWIN.TXT file. SE also has virtually unlimited file lengts, undo and redo functions, macros, multiple documents open, symbol table, wordwrap functions, bookmarks, find and replace functions, scrolling and color customization, command line switches, text viewing mode etc. Smooth Editor is released under the Shareware concept. For more information see REGISTER.TXT. Chapter 2. Installing Smooth Editor ----------------------------------- To use Smooth Editor you need a PC with: - 80386 processor or higher. - VGA video card or higher. For editing large files you need: - At least 370 kB of free conventional memory. - Extended memory. - An XMS-driver (like HIMEM or QEMM). To install Smooth editor, you can copy the SE.EXE program to a directory that is part of the Path (that is mentioned after the PATH statement in the AUTOEXEC.BAT). Or, if you use DOSKEY you can include it in a DOSKEY macro, for instance with this instruction in the AUTOEXEC.BAT: DOSKEY SE=C:\SE\SE.EXE $* For using Smooth Editor under Windows, see the SEWIN.TXT file. If you use Smooth Editor from the command line within a DOS-box under Windows and you have a number of applications running, you may experience stuttering scrolling. To solve this you can close down the DOS-box (using the `EXIT' command), set the Execution: Exclusive checkbox in the DOSPRMPT.PIF and start a new DOS-box. Chapter 3. Using Smooth Editor ------------------------------ When you first start up Smooth editor, you will be asked whether you would like to see the demo. This demo demonstrates a number of functions. If you want to see this demo again later, delete the SE.INI file before you start SE. To start up SE you use: SE [filename(s)] [/v][/e][/s][/n][/t][/i][/w][/l] Filenames: Up to ten file names. Wildcards (* and ?) are allowed. All corresponding files will be opened. /v View mode. For viewing text files without editing. /e Edit mode. This mode is default. Opposite of View mode. /s Smooth Scrolling. This mode is default. /n No Smooth Scrolling. /t Tab Repeat. With this mode Enter will copy opening tabulators and indents from previous line (useful for instance for programming with indents) /i Individual tabs (no Tab Repeat). This is the default mode. /w Word Wrap. When typing long lines will be split without splitting words. /l Long lines (no Word Wrap). This is the default mode. /1 This will fix jittered scrolling on slow computers. These command line switches will override SE.INI settings. Smooth Editor will then start up with the File Open window. If you want to start with a new file you can press the Escape key to exit this window. What you see now is an empty screen with one line of information at the bottom. This is the status line. On the left, it shows the file name. Next to that the flags are shown (at startup this displays: `Esc: Menu F1: Help'. When any key is pressed this will change into the flags), five three letter abbreviations that indicate the state of the program. When a flag is white it indicates that that state is on, when it is dark gray it means that it is off. The five flags are: - MOD : Modified, this indicates that the file has been altered since the last load or save. - INS : Insert mode. Typing is inserted at the cursor position. - OVR : Overwrite mode. Typing overwrites the text under the cursor. The Insert button switches between insert and overwrite mode. - CLB : Data present in Clipboard (from Cut or Copy). - WRP : WordWrap mode (see menu option WordWrap). On the right side of the status line four numbers are displayed: S:xx : Indicates current scroll speed in lines per frame. C:xxx : Current Column. L: xxxx/ xxxx: Current Line / Total number of lines in the current file. In Smooth Editor you can use the Escape or Alt buttons to enter the menu. In the menu you can use the arrow keys and the Enter key to navigate through the items. You can also use the character keys to move to the items with those characters highlighted. Many functions in Smooth Editor can be called with more than one key. This is done, so that if you are used to different hotkeys, you can use SE without having to learn new keys. To exit SE for instance, you can use F12, Alt+F4, Ctrl+q, Alt+x or use the menu option with ALT+F,X. You can get online help with the F1 key. Every change to the document can be undone with Ctrl+Z, Ctrl+U or the Undo menu option with Alt+E,U. By repeatedly undoing you can trace back all your steps. The MOD (Modified) flag is updated when you undo, so you can see when the file is in the original state again. After you undo changes you can redo them with Ctrl+Shift+Z or the Redo menu option with Alt+E,R. Undo and Redo are both limited to 32 kB of data. Scroll speeds and color usage are set in the SE.INI file. When SE starts up, it checks the directory where SE.EXE is located for SE.INI. If it is not there SE will look for it in the path (that is mentioned after the PATH statement in the AUTOEXEC.BAT). If it is still not found SE will ask to create a new SE.INI in the directory where SE.EXE is located. In this file all parameters will be set to their default values. In the COLORS.TXT file there are a couple of premade color configurations. You can copy these and paste them over the color settings in SE.INI. Other than standard characters can be inserted by typing Alt+0 or Alt+[code]. A window will appear with all possible characters. You can choose a character by typing it's code or by moving the blue cursor to it. If the 'Tab repeat' option in the Settings menu is enabled and you press enter on a line that starts with an indent (spaces) or a tabulator, these will be copied to the next lines. Chapter 4. Scrolling and moving ------------------------------- Smooth Scrolling can be disabled or enabled with the 'Toggle Smoothscrolling' option in the Settings menu, with the Smoothscrolling setting in the SE.INI file or with the command line options. The following keys are used for scrolling and moving through the file: With the arrow keys, the cursor can be moved through the text. The text scrolls when necessary. The PageUp and PageDown keys can be used in two ways. When they are tipped shortly the text scrolls one page quickly with smooth acceleration and deceleration. When they are kept down the acceleration stops at a lower speed. When the Ctrl key is kept down, the Arrow up and down keys accelerate the text scrolling. In this way you can control the scrolling speed. With the Ctrl key kept down, the PageUp and PageDown key accelerate the text scrolling at a faster rate. Ctrl+arrow right and Ctrl+arrow left move the cursor to the next / previous word, scrolling when necessary. Ctrl+Home moves to the beginning of the text, Ctrl+End moves to the end. The scroll speeds can be changed by editing SE.INI. Chapter 5. Block functions -------------------------- When the position of the cursor changes with the shift key pressed, the text between the old and the new cursor position will be selected. This is indicated by the fact that this text becomes inverted. With the menu function Cut, or the keys Ctrl+X or Shift+Delete the selected text will be copied to the clipboard and deleted from the text. The CLB flag at the bottom of the screen will turn white to indicate that there is information on the clipboard. With the menu function Copy, or the keys Ctrl+C or Ctrl+Insert the selection will only be copied to the clipboard. If the functions Cut and Copy are used when there's no selection, the whole current line will be cut or copied. With the menu function Paste, or the keys Ctrl+V or Shift+Insert the text on the clipboard will be copied to the cursor position. If there is a selection this text will be overwritten, otherwise it will be inserted before the cursor position. If the Delete key is pressed while there is a selection, the selection will be deleted. Ctrl + -(minus key) types a character from the previous sentence. F9 copies the current line. F10 cuts the current line. F11 pastes before the current line. Chapter 6. Macros ----------------- In Smooth Editor you can record, name, save and playback macros. The kind of macros Smooth Editor has are keystroke recordings. This means that when you record a macro, every keystroke that takes place is registered. When this macro is played back these keystrokes will be executed in quick succession, independent of what these keystrokes do. For instance, while recording, you can use the Find menu option and edit the Search string and press enter. You have to remember that when the macro is executed, the previous Search string will appear in the Find window. Since Smooth Editor will only dumbly execute the keystrokes, it could go wrong if you haven't anticipated this. During macro recording and playback Smooth Scrolling is disabled. With Shift+F1..F10 recording starts on macro 1..10. This can also be done by using the Macro menu options in the Edit menu or Ctrl+M and selecting the macro you want to record. After you execute the keystrokes you want to record you press F1 to end recording. Smooth Editor will prompt you for the name for this macro. This name will appear in the Macro menu when you want to execute the macro. If you want to you can save the current macros by selecting the Save option in the Macro window (this window is opened by the Macros option in the Edit menu or the Ctrl+m key). If you don't save it, you will be prompted that there are unsaved macros when you exit the program. To execute a macro you can use Ctrl+F1..F10 or select Play in the macro window. Chapter 7. Wrapping ------------------- Wordwrapping is the function that when a line is longer than 80 characters, part of it is moved to the next line. When a document is loaded into the program all lines end in 'hard returns'. This means that the program treats every line like a seperate paragraph. For instance if wordwrap mode is on and text is inserted in a line, so that the line becomes longer than 80 characters, an empty line is created after this one and the last word on this line will be moved to the new line. If this happens, the first line ends in a 'soft return'. If some more text is inserted in this line, so that it becomes longer than 80 characters again, the last word moves to the next line instead of creating a new line. Also if a line ends in a 'soft return' and it is shortened enough for the first word on the line to fit on the screen after the first line, it is moved there. The 'Wrap doc/selection' option in the Settings menu splits all lines longer than 80 characters in the (selected part of) the document. The program will only ask if it should justify the whole document or the selection if there is a selection. The 'Justify doc/selection' option will do the same but will also join lines that are shorter than 80 characters. It will replace all the 'hard returns' with 'soft returns' unless the following line is empty or starts with a summation character (- or *). The Toggle WordWrap function will enable or disable wordwrap. The initial mode for wordwarp (enabled or disabled) can be set in SE.INI or with a command line option. Chapter 8. SE.INI settings -------------------------- The SE.INI file contains settings for Smooth Editor. It is loaded when SE starts up. Command line options override SE.INI settings. When SE doesn't find a SE.INI file it suggests to create one with all settings on default. The SE.INI file Smooth Editor creates contains explanation for all settings in it. The color settings are made up of two sections. There is the pallette, in which you create all the colors you want to have available in the program. These are specified in a red value, a green value and a blue value, all ranging from 0-63. For instance bright white is 63,63,63, black is 0,0,0, bright red is 63,0,0. You also have to specify where to use which color. This is done in the Color... settings. In the COLORS.TXT file there are a couple of premade color configurations. You can copy these and paste them over the color settings in SE.INI. Chapter 9. Menu functions ------------------------- File menu ------- New -Starts with new file, the old file is still in memory ------ Open -Opens the File Open Window. Here you can navigate through the directories and choose a file you want to edit. ----- Save -Save current file. ---- Save As -Opens the File Save Window. --- Print -Prints current file. If there is a selection you will be asked if you want to print the selection or the whole file. -- Edit SE.INI -Opens the file SE.INI for editing. In it you can change the scrolling speeds and the color usage. - Exit -Quits SE and returns to the OS (for instance DOS). Edit menu --------- Undo -Undoes last action. -------- Redo -Undoes last undo. ------- Cut -Cuts selection or line. ------ Copy -Copies selection or line. ----- Paste -Pastes over selection or before cursor position. ---- Clear -Deletes selection. --- Select All -Selects whole file. -- Symbol -Opens the symbol table window. With it you can insert any character. - Macro -Opens the Macro window. Settings menu ------ Wrap doc/selection -Splits all long lines in document or selection. ----- Justify doc/selection -Splits long lines and joins short lines in document or selection ---- Toggle Wordwrap -Disables/enables wordwrap --- Toggle Tab repeat -With Tab repeat on, when you press enter on a line that starts with an indent (spaces) or a tabulator, these will be copied to the next lines. -- Toggle Smooth Scrolling -Disables/enables smoothscrolling - Toggle View/Edit mode -In View mode there is no cursor and it is not possible to change the document. Search ----- Find -The program will ask for a search string. It will then search the document from the cursor for that string. ---- Find Previous -Searches from the cursor upward for the last entered search string. --- Find Next -Searches from the cursor downward for the last entered search string. -- Replace -Finds and replaces a search string. - Bookmarks -Enters the Bookmark Window. Help menu -- Help -Shows three screen of useful information. - About -Shows some information about Smooth Editor. Chapter 10. Keyboard functions ----------------------------- Escape, Alt : Enters menu. F12,Alt+F4,Ctrl+q,Alt+x: Exit Smooth Editor. F1 : This on-line help. Alt+ : Insert symbol, by number or from table. Ctrl+Z, Ctrl+U : Undo. Undo levels limited only by 32k buffer. Ctrl+Shift+Z : Redo. Redo levels limited only by 32k buffer. PageUp, PageDown : - Only tipped shortly: A quick one-page scroll. - Sustained : Scroll with constant speed. Ctrl + Up,Down : Accelerate scroll slowly. Ctrl + PageUp,PageDown : Accelerate scroll fast. (With this accelerated scrolling the cursor position does not change until it reaches the screen border. Scrolling stops when Ctrl is released.) Ctrl + Right,Left : Move to next/previous word. Ctrl + Home,End : Move to begin/end of file. Shift+ cursor movement : Selection. Ctrl+X, Shift+Delete : - With selection : Cut selection. - Without selection: Cut current line. Ctrl+C, Ctrl+Insert : - With selection : Copy selection. - Without selection: Copy current line. Ctrl+V, Shift+Insert : - With selection : Paste, overwriting selection. - Without selection: Paste before cursor position. Delete(with selection) : Delete selection. Ctrl + - (minus key) : Type from previous line. Shift + F1..F10 : Record macro 1..10 Ctrl + F1..F10 : Play macro 1..10 Other key combination are mentioned in the menu functions between square brackets. Windows is a registered trademark of Microsoft Corporation.