High Voltage Shareware

home *** CD-ROM | disk | FTP | other *** search

/ High Voltage Shareware / high1.zip / high1 / DIR8 / FRUGALED.ZIP / FE.DOC < prev next >

Wrap

Text File | 1993-10-13 | 23KB | 495 lines

=============================================================================== [FE] F U N C T I O N K E Y M E N U Help SEARCH FILE BLOCK MODE STAMP Exit F1 F2 F3 F4 F5 F6 F7 =============================================================================== ALL CAPITLAS = grouped functions. [Esc] to abort any selection. Exit = Save and Quit editing. [Enter] to select a default function. =============================================================================== [FE] FrugalEdit v1.0 (c) 1993 S.C.Park, Esq. All Right Reserved. [FE] is an user-configurable text editor which is mainly designed to be a built-in editor for other programs. Even though it can be quite handy as the stand alone text editor, some of the functions may be intentionally limited to make its use as the built-in editor or text viewer simpler and more intuitive. If you just want to see what can be done with [FE], either run FE.EXE and experiment (F1 for help); or run the following demonstration programs: FE-DEMO.BAT - shows how to use fe.exe from batch file by simply running fe.exe to view this text. DEMO.EXE - example program in C calling fedit() function. source code (demo.c) enclosed. =============================================================================== STATUS LINE =========== FE.DOC |woctvp [FE] F1=Help F2=Block F3=File 80/ 35 ====== ======= ================================================ ========= | | | | current | default message when not used currrent filename | for specific messages by [FE] column/line | mode flags: will show a dot ('.') if not active | = file is changed ("dirty") w = word wrap mode is on o = overwrite mode is on (no insert) c = case sensitive search/replace t = tabs in file (save file with tabs for spaces)* v = viewing mode (no modification of text allowed)** p = file is bigger than buffer (partial)*** * If tabs are used in a text file, [FE] turn the tab flag on and expands the tabs into spaces according to the tabsize variable. If it is still on when exiting [FE], any spaces bigger than the tabsize will be contracted and turned into tabs. ** In view mode, normal alpha-numeric characters may be used to search for any specific string of text. Pressing [Enter] or other editing keys will erase the buffer. As the search string is stored in the regular search buffer, once the search string is made up, normal search or replace function may be used. Usually search_again is the most used function in that context. *** The size of text which may be loaded into [FE] is limited to less than a full segment (Maximum = segment(64K) - block buffer(4096 bytes) * 3) in compact/large/huge memory model (FE.EXE). It will be much less if small memory model (FES.EXE) is used or the size of text buffer is intentionally limited by the programmer (Minimum = block buffer * 3 = 12288 bytes). If the current file is bigger than the text buffer the remaining text may be loaded into [FE] by using file_more function as many times necessary to load in the whole file. Even though all the editing done to the previous section will be saved when quitting the file, users will only be able to edit the current section loaded into [FE] and they will not be able to go back to edit the previous section. To go back to edit it, users should quit and then reload the file. NOTE: Multiple windows with limited function* (accessed by file_load function) are implemented to allow the block copying operation. For that reason, loading of the same file more than once is allowed. However, users should be careful not to overwrite the editing done to the same file opend late and therefore saved earlier. The only reason to open the same file more than once is to copy from a section of the file not loaded into the text buffer becuase the file is too big. * No free movement between the windows are allowed. To go back to the earlier window, all the windows opened later than the target window should be closed by exiting them. For the normal use of [FE] as a built-in editor, no more than two windows are required. If no block copying from other files are anticipated, loading of other files (thereby opening more than one window not counting the help windows) should not be allowed (by setting the no_other_files parameter on). The main reason for this limitation is that [FE] is designed to be a built-in editor to obtain text input from the end user. This limitation will force the end user to finish with the original text window supplied by the programer and not to stray form the given task. For this reason, the functions to execute a DOS command and to shell out to DOS should not be allowed by the programmer without a good reason. =============================================================================== SYSTEM REQUIREMENT ================== [FE] writes directly to Video Memory. DOS version 3.3 and up. IBM compatible PC's only =============================================================================== GROUPED FUNCTIONS - MAY BOUND TO TWO KEYS ================= Name Description Default key ------- ----------------------------------------- ----------- Search_main Search Forward/Backward/Again and F2 or ^s Replace all with/without prompt. File_main Load in MORE of the current file, if any. F3 or ^v LOAD another file to edit. Save and Quit editing. Block_main Mark block beginning or Store marked block. F4 or ^a Cut and store the marked block. Print or Write to file. OTHER FUNCTIONS WITH DEFAULT BINDING TO FUNCTION KEY - TWO KEYS ALLOWED ---------------------------------------------------- Name Description Default key ------- ----------------------------------------- ----------- Show_help* Show short help for grouped functions. F1 or @h Show_helpfile* Show HELP Documentation using VIEW only mode. ^h Mode_toggle Toggle the active MODES. F5 or ^o Wrap/Overwrite/Case/Tab/View Stamp_main Stamp string at the cursor. F6 or @p Both/Date/Time/User/Make Save_quit Save file and Exit the program. F7 or ^z Show_status Show the current STATUS. Size of file and buffer in bytes F8 Memory left (and pointer to buffers) Shift-F8 Date and time Alt-F8 Shell_HOOK User's shell if implemented F9 Otherwise, built-in DOS shell Menu_HOOK Uaer's menu if implemented F10 Otherwise, built-in DOS command execution =============================================================================== Most of the editing keys except movement keys may be configured. To change the key-binding of an editing command, use the CONFIG.EXE. Please, read the text of the default configuration file very carefully. Any change of the order of values or inadvertant deletion of a portion of the values will make the stand alone [FE] programs behave unexpectedly. Make sure you keep all the original programs safely stored. You may also change the assignments in the variable declaration statement (FeKey[]). This cannot be done unless you have the compiler and the linker necessary. Remember that using the configuration program in combination with change of the Fedit()'s parameters will achieve most of the modifications you have in mind. LIST OF COMMANDS ---------------- Abort [Esc]* * (fixed binding) To abort user input from the status line. Also use to quit viewing help string or help file and to unmark block. CURSOR MOVEMENT COMMANDS Name Key - fixed binding ------------------ ------------------- Character Left Left Arrow Character Right Right Arrow Line Beginning Home Line End End Line Down Down Arrow Line Up Up Arrow File Beginning Ctrl-Pageup File End Ctrl-PageDown Page Down Page Down Page Up Page Up SPECIAL COMMANDS fixed binding ------------- Insert newline and go to the first of next line or Enter Just go to the first letter of next line (view mode). Insert Fromfeed and do Enter in edit mode or Ctrl-Enter Just go to the first letter of next line Insert tabsize number of spaces in Insert mode or Tab Advance tabsize number of spaces in Overwrite mode. Advance in Insert mode; Insert in Overwrite mode. Shift-Tab INSERT AND DELETE COMMANDS Delete Before Backspace Delete Under Delete Insert Mode On/Off Insert ------------------- DEFAULT KEY Delete Word Right Ctrl-t Delete Line Ctrl-y Delete to End of Line Meta-t* * Meta Key Default = ^p or ^q While not required when the key bindings are modified, use of meta key is recommended because it makes the editing key structure more intuitive and logical. (See defaults for search forawrd and serach backward). BLOCK COMMANDS Mark Block Ctrl-a* * or Shift-cursor Keys Copy Block Ctrl-k (-or Home/End) Delete Block Meta-k Once the blocking begins, Paste Block Ctrl-u use any cursor movement key Write Block to Disk Ctrl-n to mark a block. No need to Print Block Meta-n hold down the shift key any more. Unmark Block [Esc]** ** [Esc] key is also used to exit from viewing help or to abort user input. OTHER EDITING COMMANDS default --------- DOS Line Ctrl-x Executes a DOS command DOS Goto Meta-x Go to DOS shell Goto Column Meta-g Goto Line Ctrl-g Format Paragraph Ctrl-b Then go to next paragraph Help - show internal help Alt-h* Also bound with F1 key Help - show document file Ctrl-h* Info file F8 Show file size Info mem Shift-F8 Show memory size Info now Alt-F8 Show date/time Meta Key Ctrl-p Meta key Ctrl-q Modes Toggle Ctrl-o File More (read in) Ctrl-m Only if text is bigger than buffer File Load Meta-m Load in another file to edit/view File Quit Ctrl-z Quit editing after saving file File Saveas Meta-z Save As (only if all text in buffer) Repeat last search Ctrl-l Following the last search direction Replace Ctrl-r Confirm for each replace Replace All Meta-r Without requesting confirmation Search Forward Ctrl-f Search Backward Meta f Stamp Date Ctrl-d Stamp Time Meta-d Stamp User Ctrl-e Insert user made string into text Stamp Make Meta-e Get user made stamp string * Pressing the same key again or [Esc] key will end the viewing of the internal help or help file, as well as exiting from the window using quit. Consult Internal Help (F1 or Alt-h) for a list with function numbers. ------------------------------------------------------------------------------- [FE] User's Manual [FE] FrugalEdit for DOS =================== (c) 1993 S.C.Park, Esq. Shareware Registration ---------------------- * [FE] Frugal Edit (c) 1993 is a shareware program. * [FE] is offered AS IS without any express or implied warranty. ============================================================= The author will not be liable for any damages caused by the use of this program as is or modified by the user. * Use of [FE] as a stand alone editor (fe.exe) is free of any charge. * Use of the included configuration program is also free so long as the user does not change the key binding of the copyright notice. * Any direct modification of [FE] execution files using binary editor is NOT allowed (even for the registered users). * Voluntary contribution of $10.00 will be appreciated. * To receive the next version with macro and file pick menu, register as a user of the stand-alone version for $15.00. * For the use of [FE] in user's own program, users should register. * Registered users may incorporate [FE] in their own commercial programs without paying any further fee so long as [FE] is not the sole substantial part of the programs. For example, the other part of the program should be at least 1000 lines of source code. * Even the registered users are NOT allowed to use [FE] to make stand alone editors for commercial purpose. Any stand alone text editors incorporating [FE] should be free and should NOT be distributed WITHOUT including the whole [FE] package. They should also be named "FE-" plus something, for example, "FE-mine" or "FE-steve", etc. Note the required dash ("-"). However, any program with substantial front end, for example a specialized letter writer or a personal journal keeper, would not be considered as a stand alone text editor. * Even though [FE] can be configured not to show any copyright notice under normal use to make the user's program appear fully integrated, pressing Alt and two numeric keys (Alt-[26]) will show the notice on the status line. Registered users are required to show the notice either within the user's program itself or at least in the documentation as follows: Built-in Editor is [FE] FrugalEdit v1.0 Copyright (c) 1993 S.C.Park, Esq.[ShareWare] Configured and incorporated with permission. * Registered users are also required to send to the author of [FE] any commercial progrqam incorporating [FE] as a condition of the license granted upon their registration, and the author of [FE] reserves the right to cancel the registration for good reason upon the full refund of the registration fee and a written notice of such a cancellation. * Registration fee for incorporation of [FE] into user's program is $30.00 * To receive next upgrade with macro, add $15.00. * Make the ckeck payable to S.C.Park, Esq. * Author's mailing address is: S.C.Park, Esq. 5038 N. 5th Street Philadelphia, PA 19120 Using [FE] ---------- * To use [FE] as the stand alone text editor, just do so by running fe.exe with any command line options you like. (type "fe /?" for help) * Use the included Configuration program (CONFIG.EXE) to configure the editing key binding, default colors, and default help messages, etc. * The easiest way to use [FE] in user's program is to call the stand alone [FE] with command line options, either by calling proper [FE] program for small text size - use fes.exe (small memory model) for normal text - use fe.exe (compact memory model) from a batch file or from user's program, for example, by using exec...() or spawn...() functions in C. * The best way is to write a module defining all available options and link it with the [FE] library file. The main module should include "fe.h" to call Fedit() as well as some other minor functions. Note: Some of the codes in "fe.h" are function definitions. They are user modifiable hooked functions. As usual, users should not change the declarations or protypes. But they may freely modify the function definitions so long as they are not deleted completely and return the legitimate value if required. * Run demonstration programs and study the batch file or C source code for demonstration program (DEMO.EXE) included with [FE] programs. * If you have any question or comment, send a letter to the author of [FE]. Please, enclose self addressed and stamped envelope if you want to get response. Why [FE] -------- How many things you think you can do better only if you have the time to do it yourself? After using Turbo Prolog to study the rule-based expert systems, I found that the built-in text (string) edit() function of Turbo Prolog is indispensible in any programs which need to get input of more than a line of text. Unfortunately, C or C++ compilers usually do not come with such a complex funtion. Of course, we can always let the users use their own text editors. But, it will complicate the installation of our programs and also make them appear incomplete. Therefore, I decided to make a simple but quite functional text editor mainly to be used as the built-in text editor. I sure hope that we can enjoy many more such separate modules as our time on earth is rather limited. The menu and window modules are comparatively abundant. I have't seen any text editor module yet. I think there is a big market for reasonably priced modules (registration fee for unmodified use at the price of ten to thirty dollars) for casual programmers. The ultimate prize will be the artificial intelligence module which can keep track of the end user's activity and provide a recommended option, all the next available options, or any user designated information in a pick list while maintaining a database of all activity. LIST OF FILES ------------- FE.EXE Stand alone text editor with command line options (Compact). FES.EXE Small memory model stand alone text editor. FE.H Include file to use [FE] by calling Fedit(...). FE?.LIB Four object library files to be linked for most memory model. (? = Small, Compact, Large, or Huge) FE.DOC This [FE] documentation you are reading. READ.ME Summary introduction to [FE]. REGISTER.TXT [FE] registration form. CONFIG.EXE Configuration Program for stand alone [FE]'s. DEMO.C A simple demo program source code useing [FE]. DEMO.EXE Demonstration Program using [FE]. FE-DEMO.BAT Batch file calling fe.exe to view this text. MAKEFILE -------- For Borland's MAKE (program manager). To make demo.exe using small memory model [FE]. .c.obj: tcc -c -d -G -O -Z -ms $< FILES = demo.obj demo.exe: $(FILES) tlink c0s $(FILES), demo, ,cs fes.lib demo.obj: demo.c fe.h ACKNOWLEDGMENT ============== [FE] FrugalEdit v1.0 is written in C with Turbo C++ v1.0. It is based on the public domain text editor EE (Easy Edit) (c) 1991 Yijun Ding. Turbo C++ (c) 1990 by Borland international Inc. =============================================================================== [FE] REGISTRATION FORM ---------------------- To register your copy of [FE], fill in the following form and mail it to: S.C.Park, Esq. 5038 N. 5th Street Philadelphia, PA 19120 * Use block print function to address envelope and to print the form below. =============================================================================== REGISTRATION OF [FE] FrugalEdit v1.0 (c) ======================================== ORDER mark one Registration as the user of stand-alone [FE] $15.00 ______ (will receive next version without further charge) Registration of [FE] v1.0 $30.00 ______ Registration of [FE] v1.0 and order of next version (next version registered without further charge) $45.00 ______ Shipping and handling charges are included in the price. Subtotal $_____________ Sales Tax $_____________ TOTAL $_____________ * Make the check or money order payable to: S.C.Park, Esq. * Next version (FrugalEdit v2.0) will be available by the end of December, 1993. CHOICE OF DISKETTE (if ordering next version) 5&1/4" ______ Both will be in Double Density only. 3&1/2" ______ REGISTRATION FOR (Natural Person Only) Name:____________________________________________________ Title:________________ Company:___________________________ Address:____________________________________________________ City:___________________ State:____ Zip Code:____________ Telephone:(______)_______________ Fax:(______)_______________ I have read the registration section of the documentation for [FE] and I understand and agree to abide by the terms described therein. Date: _______________ Signature:________________________________