home *** CD-ROM | disk | FTP | other *** search
/ C!T ROM 2 / ctrom_ii_b.zip / ctrom_ii_b / PROGRAM / UTILS / NE / NE.DOC < prev    next >
Text File  |  1992-12-19  |  21KB  |  486 lines
  1.  
  2.  
  3.                                    NE.EXE
  4.                                July 13, 1992
  5.  
  6.  
  7. INTRODUCTION
  8. ------------
  9.  
  10. This small, fast editor is based  on  the IDE   editor from BORLAND.  It has
  11. MANY features including wordwarp and spell checking.
  12.  
  13. This limited documentation  is provided to  help you get started. Please use
  14. the help feature of the program  (F1)  and read  about the various features.
  15. Many of the commands are  WORDSTAR, and if you are  familiar  with this very
  16. popular editor, you'll catch on fast.
  17.  
  18. The rest of this document deals with the  some of the features of the editor
  19. editor, and may  help  you to work   through  any problems that you have.  I
  20. think once you'll find this editor to be one of the better ones around.
  21.  
  22. SPELL CHECKING
  23. --------------
  24.  
  25. This editor provides  for what  has   got to  be one  of  the most important
  26. functions of any word   processor,  at   least for   me,  and  that is spell
  27. checking. Without it, I'm afraid that  I'd be lost. The spell check  program
  28. that I use is  Webster's New World spelling  checker,  but   there are  many
  29. "shareware" checkers around  that  work  just as  well.  One popular one  is
  30. "SHARESPELL" by Acropolis, found on many BBS's around the country.
  31.  
  32. To access the spell checking,  you MUST tell the program  what spell checker
  33. you will use.  To do  this, from the DOS command  line type "NE SPELL=????",
  34. (replace the question marks with  the  name of the program  you  want to use
  35. for spell  checking.).  The program will  remember this until you change it.
  36. One IMPORTANT NOTE : Make sure that the spell check  program is SOMEWHERE in
  37. your path statement.  To check your path, type "PATH" at the  DOS prompt and
  38. all of the current paths will be displayed.  If the spell checker  IS NOT in
  39. one of these paths, then place it  there or at its path the the current PATH
  40. statement. If you don't the  editor will  not  find it,  and spell  checking
  41. will be disabled.
  42.  
  43. After all this is done,   Spell checking can be accessed from  the editor by
  44. pressing the keys "ALT E" (Edit Menu) and then pressing the "S" key.
  45.  
  46.  
  47. PRINTING THE DOCUMENT
  48. ---------------------
  49.  
  50. Choose PRINT from  the menu  (ALT P) and you  are given the option  to print
  51. the current document, set the top print margin,  the left print margin or to
  52. select the type of printer that  you   are using. The  printer  choices  are
  53. common ones, and hopefully you will be able   to  find one  that  suits your
  54. printer. Text will be printed in  NEAR  LETTER QUALITY  mode, and the choice
  55. tells the program what control codes to send to your printer.
  56.  
  57. The margin settings   and printer choice are saved   for  future use  of the
  58. program, and will be in effect until the next time you change them.
  59.  
  60. The WORDSTAR command ^KP   is  available for  document   printing, and   the
  61. document will be printed with the current settings.
  62.  
  63. As printing occurs, the line and cursor indicator will be updated.  Pressing
  64. ESCAPE will cease the printing operation at any time.
  65.  
  66.  
  67. 43/50 LINE VIDEO
  68. ----------------
  69.  
  70. You will have  the capability of using 43/50 line screens if you have EGA or
  71. better.  The option  can  be found in the DESKTOP menu.  It is automatically
  72. disabled if the user doesn't have the capability.
  73.  
  74. Note that Load/Store   remembers  what video  mode   you  were in and resets
  75. the program to that mode when the desktop is automatically loaded.
  76.  
  77.  
  78.  
  79. AUTOINDENT
  80. ----------
  81.  
  82. The AutoIndent command is ^QI.  This makes the editor conform to WordStar.
  83.  
  84.  
  85. CENTERING TEXT
  86. --------------
  87.  
  88. A line of text may be centered  by   using ^OC.   Centering is based on  the
  89. setting of the Right_Margin.  If  a line is blank, or the length of the line
  90. exceeds the Right_Margin value,   nothing     will  happen.    Spaces at the
  91. beginning of lines are not used when calculating the line length.
  92.  
  93. The cursor will be moved to the end of the line after it has been centered.
  94.  
  95. COLORS
  96. ------
  97.  
  98. To be quite honest, the whole business of allowing users to change colors is
  99. quite a problem.  It adds a lot  of code to the program, and more often than
  100. not, it is used only once  by  the  user.  I like  the  colors   that I have
  101. chosen, If you don't, find another editor.
  102.  
  103. CTRL-BACKSPACE
  104. --------------
  105.  
  106. This feature will allow two options for deleting text from the cursor to the
  107. left margin.  You can use ^BackSpace or ^QH.
  108.  
  109.  
  110. CTRL-HOME AND CTRL-END
  111. ----------------------
  112.  
  113. You have the ability to jump to the top and bottom of a page.  [Ctrl]-[Home]
  114. will take the cursor to the  top of a page and [Ctrl]-[End] will  take   the
  115. cursor to the bottom of a page.
  116.  
  117. Note that the  cursor does NOT go to the first  position in  the   line. The
  118. actual position it ends up at is based on the current position of the cursor
  119. on the current line when  one  of  these key sequences are pressed, and  the
  120. length of the new line it ends up on.
  121.  
  122. PARAGRAPH REFORMAT
  123. ------------------
  124.  
  125. This feature is available  to the user  via the ^B key.  It works regardless
  126. of whether or not wordwrap is active.  Reformatting is based on  the current
  127. right margin position.   As  with  wordwrap, reformatting is not possible if
  128. the cursor is beyond   the right  margin  position. An  error dialogue  will
  129. appear.
  130.  
  131. Paragraph reformat also works with the AutoIndent  feature.  However, it  is
  132. important to note that the reformat  process is    based on the current line
  133. the cursor happens to  be sitting  on when ^B is pressed.  Therefore, if you
  134. use hanging paragraphs  (a paragraph where the first line sticks out further
  135. to the left margin than  the rest of the paragraph) you need  to be careful.
  136. If the cursor  is on the first line of the paragraph, the reformatting takes
  137. place according to that line's left margin  setting.  This is a feature, not
  138. a bug.  Try the same thing with MicroStar or SideKick  and you'll see what I
  139. mean.
  140.  
  141. If AutoIndent is  on,   and the paragraph is  so  indented that reformatting
  142. encounters a word that will  not  fit on the line  according to the left and
  143. right margin settings, an  error  dialogue  will   appear.     However,  any
  144. reformatting accomplished prior  to this  situation will  have taken effect.
  145. The cursor should stop on  the word  it couldn't wrap.  This should preclude
  146. the reformatting process locking up the system because it can't  wrap a word
  147. that is too long.
  148.  
  149. The cursor will end up at the first blank line after the  paragraph when you
  150. press ^B.  Therefore, you can reformat paragraphs in quick succession.
  151.  
  152. Note that unlike  some other editors,  this   implementation    of paragraph
  153. reformatting will retain  double spaces after  periods, exclamation  points,
  154. question marks, and colons.  If    you  are in  the habit of  only using one
  155. space, it's not syntactically correct.  Two spaces will be inserted instead,
  156. providing the cursor was sitting on one of  these punctuation marks when the
  157. reformatting process was doing its thing.  Otherwise, no change will be made
  158. to your original text.
  159.  
  160.  
  161. DOCUMENT REFORMAT
  162. -----------------
  163.  
  164. Pressing ^QU will allow  you to  reformat a document from either the current
  165. line, or the beginning of a   document, to    the  end of the    document. A
  166. dialogue box appears with  radio buttons asking you where  you want to start
  167. reformatting.
  168.  
  169. You must be VERY careful   when    using  this  option.  It is based on  the
  170. paragraph reformat feature.  You will note in that section that reformatting
  171. is based on the indentation of the first line in a paragraph, and whether or
  172. not the AutoIndent feature is toggled on.
  173.  
  174. Your screen will scroll to follow the reformat process. This allows the user
  175. to know something is  happening, instead of just having  the  system lock up
  176. while text is reformatted.
  177.  
  178.  
  179. PARAGRAPH JUSTIFY
  180. -----------------
  181.  
  182. Pressing ^OJ will allow you to RIGHT   JUSTIFY the  current  paragraph.  The
  183. entire paragraph EXCLUDING  the last line will  be  lined up  with the right
  184. margin setting.
  185.  
  186.  
  187. END OF LINE SPACES
  188. ------------------
  189.  
  190. Spaces at the end of lines are automatically removed.  This was  required to
  191. make the wordwrap and reformat feature work properly.  Spaces on blank lines
  192. are also removed.  Only the CR/LF is kept.
  193.  
  194. Spaces are NOT  removed until the cursor has traveled  over or onto  a line.
  195. Therefore, if you load  a file created by another ASCII editor that does not
  196. strip spaces, they will remain  in the   document until you move through the
  197. document with the cursor keys.
  198.  
  199.  
  200.  
  201. INDICATOR LINE
  202. --------------
  203.  
  204. The Edit Indicator  line  appears at the bottom of the  edit window.  If the
  205. text has been modified,    an    "M" appears.   Also,   an "I"  appears when
  206. AutoIndent is active, and a "W" pops up when wordwrap is on.   Additionally,
  207. the current line and column is indicated (line:col);
  208.  
  209. INSERT NEW LINE
  210. ---------------
  211.  
  212. Pressing ^N will insert a  CR/LF pair at  the current cursor  position.  All
  213. characters AT the cursor and to the  end of the  line will be moved  down to
  214. the next line.  The difference between pressing  ^N and [Enter] is that with
  215. ^N the cursor  stays at  its current position and does NOT  move down to the
  216. next line.  The only exception to this would be if the cursor was at the end
  217. of a line that has its spaces removed when ^N is pressed.  In that case, the
  218. cursor goes to the new end of line.
  219.  
  220. JUMP TO LINE NUMBER
  221. -------------------
  222.  
  223. Pressing ^JL will allow   the  user to jump to a particular line   number. A
  224. dialogue box will appear that requests the  user input a line number to jump
  225. to.  Valid entries range from 1 to 9999.
  226.  
  227.  
  228. LOAD/STORE OPERATIONS
  229. ---------------------
  230.  
  231. The editor keeps track of the LAST files that were edited, and saves  a file
  232. to disk ending in ".DSK".  The next time into the editor, the previous files
  233. will be loaded.   However, if you start the editor  with a NEW command line,
  234. this file WILL NOT BE LOADED.  This editor is a MULTIPLE file editor, and up
  235. to 16 files can  be   loaded  at   once.  See the SYNTAX section    for more
  236. information.
  237.  
  238. MEMORY
  239. ------
  240.  
  241. Only files of  64K  or  less can be edited with this  editor.  Maybe one  of
  242. these  days, I'll get  around to  creating  a "VIRTUAL" editor, but this one
  243. ain't it.
  244.  
  245.  
  246. PLACE MARKERS
  247. -------------
  248.  
  249. This editor allows the user to set place markers  within the document.  ^K#,
  250. where # is a value between 1  and 0 on the keyboard, allows the user  to set
  251. up to 10 place  markers.   The user can  jump to  a place marker by pressing
  252. ^Q#, where # is a value between 1 and 0 on the keyboard.
  253.  
  254. Place markers are not visible, but they are there none-the-less.
  255.  
  256. Place markers are constantly  updated as the user inserts and deletes  text.
  257. If a place  marker is contained within text that is deleted,  it is set back
  258. to zero.  The cursor key goes  nowhere if it encounters a place  marker with
  259. a zero value as a  result of a  ^Q# request.  Of course, this also means you
  260. can not set   a  place   marker in column 1   of line  1, for it is the  0th
  261. position in the document.  Use [Ctrl]-[PgUp] instead!
  262.  
  263.  
  264. PRESET TABS
  265. -----------
  266.  
  267. The preset tab feature  allows the user to define up to 74 tab  stops.   The
  268. ^OI keys will bring  up a tab stop dialogue box. The box has a ruler  across
  269. the top and an input line beneath the ruler.
  270.  
  271. To set tabs, the user   should place a  character in the input line directly
  272. beneath the ruler   setting where  a tab is wanted.  Note  that if the input
  273. line is filled with spaces the user will not be able to enter any data.
  274.  
  275. Tab Settings is automatically initialized to increments of 7.
  276.  
  277. Pressing [Esc] or the OK dialogue button will keep the current Tab Settings.
  278.  
  279. RIGHT MARGIN
  280. ------------
  281.  
  282. The user can set the right margin of the document. This is done by  pressing
  283. the ^OR sequence. A  dialogue box will appear   asking the user to  enter  a
  284. right margin value.  The current value  will be shown each time the dialogue
  285. comes up. The  default value is 76. The  user has only three options;  enter
  286. the value, press  the OK   button, or press [Esc]. Pressing OK or [Esc] will
  287. keep the current  value.  Valid  entries  are  10  through 255. If the  user
  288. enters a value that  is  not  within   this   range, the current  value   is
  289. maintained. No error message will be given!
  290.  
  291.  
  292. SAVE FEATURES
  293. -------------
  294.  
  295. The most important WordStar commands that apply to saving the document have
  296. been implemented.
  297.  
  298.  
  299.   [F2] or ^KS -     Save text to current file and
  300.                     resume editing.
  301.   ^KF         -     Save text to another file.
  302.   ^KD or ^KX  -     Save text to current file and exit
  303.                     editor.
  304.  
  305.  
  306. SCROLL DOWN
  307. -----------
  308.  
  309. Pressing ^Z provides  the    function   of  scrolling  the  screen up  while
  310. maintaining the cursor position.  If  the original cursor  position  scrolls
  311. off the screen,  the cursor scrolls  down a line.  This forces the cursor to
  312. stay in the  upper   left corner  of  the screen should the original  cursor
  313. position scroll away.
  314.  
  315.  
  316. SCROLL UP
  317. ---------
  318.  
  319. Pressing ^W provides the   function    of scrolling   the screen  down while
  320. maintaining the cursor position.   If   the original cursor position scrolls
  321. off the screen, the  cursor  scrolls up  a line.   This forces the cursor to
  322. stay in the lower left corner  of the screen  should   the original   cursor
  323. position scroll away.
  324.  
  325.  
  326.  
  327. SELECT WORD
  328. -----------
  329.  
  330. Pressing ^KT will highlight the current word the cursor is sitting on.
  331.  
  332. The word is marked from the current cursor  position to the  next  space  or
  333. end of line,  whichever comes  first.  The marked  word   is  put into   the
  334. clipboard without further effort  on the  users  part.  Marking works in the
  335. normal manner, i.e., it disappears the moment you move the cursor.
  336.  
  337. Note that NOTHING  will happen if  you try to    use this  command  when the
  338. cursor is sitting on a space or the end of a line.
  339.  
  340.  
  341. TABS
  342. ----
  343.  
  344. When in INSERT mode, the  cursor  will attempt to go to  the next tab  stop,
  345. happily INSERTING SPACES as it looks for that next stopping point.  If it is
  346. at the last tab stop, it stops inserting spaces and takes a big jump  to the
  347. first character of the next line.  Try to keep tab use to a minimum when the
  348. cursor is in insert mode.  You eat up valuable buffer space real quick!
  349.  
  350. When in OVERSTRIKE mode, the cursor will attempt to go to the next tab stop,
  351. happily skipping over characters as  it  looks for that next stopping point.
  352. If it is at the last tab stop, OR the line is too short to allow it to reach
  353. the next tab stop,  it takes a big jump to the first character  of the  next
  354. line.
  355.  
  356. UNDO
  357. ----
  358.  
  359. ^U is the normal   UNDO sequence.  However  you can get the  same thing with
  360. ^QL.  The line is restored to its condition BEFORE any carriage return.
  361.  
  362.  
  363. WORDWRAP
  364. --------
  365.  
  366. Wordwrap is toggled on/off via the ^OW sequence.  When wordwrap is on, a "W"
  367. appears on the  status line.  Wordwrap is fast, and should keep  up with the
  368. most fluid typist.  There should be no "jerkiness" in the wrap effect.
  369.  
  370. Wordwrap is based on the "push the  line  out  to the right until the cursor
  371. reaches the current right margin setting"  principle.  Therefore, if you are
  372. on a line and inserting  text,    the text will be  pushed  beyond the right
  373. margin until the cursor  gets there,  at   which point the text beyond   the
  374. cursor is wrapped.
  375.  
  376. The right margin is considered to be the  current  right margin value +   1.
  377. For example, if your right margin is set to 69, then the  cursor CAN   go to
  378. column 70.  Trying to exceed column 70 will cause wordwrap to occur.
  379.  
  380. Wordwrap will not work if the  cursor is   beyond the current  right  margin
  381. setting.  In this event, an error dialogue box will appear.
  382.  
  383. Wordwrap will also work with the AutoIndent mode  turned on.   In this case,
  384. the cursor goes to the same first character position on the new line as  the
  385. line it was on when wrap occurred.
  386.  
  387. If you try to type a blank line of spaces to the right margin, wordwrap will
  388. remove the spaces and insert just a CR/LF pair.  Wordwrap will also bring up
  389. an error message if you try to   type in  an  entire line out to  the  right
  390. margin without spaces.
  391.  
  392.  
  393. COMMAND SUMMARY
  394. ---------------
  395.  
  396. The following list contains all the commands available in the editor :
  397.  
  398. Command                  Description
  399. --------------------     ------------------------------------------------
  400.  
  401.           [Ctrl]-[A] -   Move cursor left to previous word.
  402.           [Ctrl]-[B] -   Reformat paragraph to current margins.
  403.           [Ctrl]-[C] -   Page down one screen.
  404.           [Ctrl]-[D] -   Move cursor right one character.
  405.           [Ctrl]-[E] -   Move cursor up one line.
  406.           [Ctrl]-[F] -   Move cursor right to next word.
  407.           [Ctrl]-[G] -   Delete character cursor is on.
  408.           [Ctrl]-[H] -   Delete character to left of cursor.
  409.           [Ctrl]-[I] -   Move right to next tab position.
  410.       [Ctrl]-[J]-[L] -   Jump to a line number.
  411.       [Ctrl]-[K]-[#] -   Set place marker (0 to 9).
  412.       [Ctrl]-[K]-[B] -   Begin selecting text.
  413.       [Ctrl]-[K]-[C] -   Copy text from clipboard into document.
  414.       [Ctrl]-[K]-[D] -   Save document and exit editor immediately.
  415.       [Ctrl]-[K]-[F] -   Save current document to another file.
  416.       [Ctrl]-[K]-[K] -   Copy text from document into clipboard.
  417.       [Ctrl]-[K]-[P] -   Print current document using current settings.
  418.       [Ctrl]-[K]-[S] -   Save document and continue editing.
  419.       [Ctrl]-[K]-[T] -   Select current word cursor is on.
  420.       [Ctrl]-[K]-[Y] -   Remove text from document into clipboard.
  421.       [Ctrl]-[K]-[X] -   Save document and exit editor immediately.
  422.           [Ctrl]-[L] -   Continue searching for specified text.
  423.           [Ctrl]-[M] -   Enter CR/LF pair.
  424.           [Ctrl]-[N] -   Add CR/LF pair AT cursor and keep cursor position.
  425.       [Ctrl]-[O]-[D] -   Output current DATE into text.
  426.       [Ctrl]-[O]-[I] -   Set tab positions.
  427.       [Ctrl]-[O]-[J] -   Right Justify Paragraph.
  428.       [Ctrl]-[O]-[R] -   Set right margin position of line.
  429.       [Ctrl]-[O]-[T] -   Output current TIME into text.
  430.       [Ctrl]-[O]-[W] -   Toggle word wrap mode on or off.
  431.       [Ctrl]-[Q]-[#] -   Move cursor to specified place marker (0 to 9).
  432.       [Ctrl]-[Q]-[A] -   Search for text and replace it.
  433.       [Ctrl]-[Q]-[C] -   Move cursor to end of document.
  434.       [Ctrl]-[Q]-[D] -   Move cursor to end of line.
  435.       [Ctrl]-[Q]-[F] -   Find specified text.
  436.       [Ctrl]-[Q]-[H] -   Delete text from cursor to start of line.
  437.       [Ctrl]-[Q]-[I] -   Toggle IndentMode on and off.
  438.       [Ctrl]-[Q]-[R] -   Move cursor to beginning of document.
  439.       [Ctrl]-[Q]-[S] -   Move cursor to beginning of line
  440.       [Ctrl]-[Q]-[U] -   Reformat the document text.
  441.       [Ctrl]-[Q]-[Y] -   Delete text from cursor to end of line.
  442.           [Ctrl]-[R] -   Page up one screen.
  443.           [Ctrl]-[S] -   Move cursor left one character.
  444.           [Ctrl]-[T] -   Delete text from current cursor to next word.
  445.           [Ctrl]-[U] -   Restore text to previous state.
  446.           [Ctrl]-[V] -   Toggle cursor between insert and overstrike mode.
  447.           [Ctrl]-[W] -   Scroll screen up one line keeping cursor position.
  448.           [Ctrl]-[X] -   Move cursor down one line.
  449.           [Ctrl]-[Y] -   Delete line of text cursor is on.
  450.           [Ctrl]-[Z] -   Scroll screen down one line keeping cursor position.
  451.          [Backspace] -   Delete character to left of cursor.
  452.         [Left Arrow] -   Move cursor left one character.
  453.        [Right Arrow] -   Move cursor right one character.
  454.  [Ctrl]-[Left Arrow] -   Move cursor left to previous word.
  455. [Ctrl]-[Right Arrow] -   Move cursor right to next word.
  456.               [Home] -   Move cursor to start of line.
  457.                [End] -   Move cursor to end of line.
  458.        [Ctrl]-[Home] -   Move cursor to top of current page.
  459.         [Ctrl]-[End] -   Move cursor to bottom of current page.
  460.           [Up Arrow] -   Move cursor up one line.
  461.         [Down Arrow] -   Move cursor down one line.
  462.               [PgUp] -   Page up one screen.
  463.               [PgDn] -   Page down one screen.
  464.        [Ctrl]-[PgUp] -   Move cursor to beginning of document.
  465.        [Ctrl]-[PgDn] -   Move cursor to end of document.
  466.                [Ins] -   Toggle cursor between insert and overstrike mode.
  467.                [Del] -   Delete character cursor is on or selected text.
  468.   [Ctrl]-[BackSpace] -   Delete text from cursor to start of line.
  469.        [Shift]-[Ins] -   Copy text from clipboard into document.
  470.        [Shift]-[Del] -   Remove text from document into clipboard.
  471.         [Ctrl]-[Ins] -   Copy text from document into clipboard.
  472.         [Ctrl]-[Del] -   Clear out and dispose of clipboard contents.
  473.  
  474. CREDITS
  475. -------
  476.  
  477. This editor is written in Turbo Pascal 6.0, and  is based on the BORLAND IDE
  478. editor.  MOST of the modifications to the editor kernel were done by
  479.  
  480.                                Al Andersen
  481.                                PO BOX 2436
  482.                          Sierra Vista, AZ 85636
  483.  
  484. and he deserves MUCH credit for his work.
  485.  
  486.