home *** CD-ROM | disk | FTP | other *** search
/ QBasic & Borland Pascal & C / Delphi5.iso / Basic / Samples / BOZOL2 / BOZOL2.ZIP / USER.DOC < prev    next >
Encoding:
Text File  |  1994-02-08  |  8.6 KB  |  180 lines
  1.  
  2.         {{{THIS DOCUMENT DESCRIBES HOW TO EDIT TEXT WITH PBWRITE}}}
  3.  
  4.         Using PBWRITE
  5.         =============
  6.  
  7.         PBWrite is an ASCII text editor that contains many editing features.
  8.         The largest document size you can edit is just under 32K.  While
  9.         this is not an extremely large amount of space to edit a document,
  10.         32K is substantially enough room for most and probably all of the
  11.         types of editing that will be done by the people who need to use
  12.         it.  Larger and more complex editing tasks would probably be
  13.         done outside of the application with a more advanced word processor
  14.         or program editor.  32K is sufficient to store approximately 800
  15.         lines of average text, or about 15 full pages.
  16.  
  17.         (((PBWrite is also quite adaptable to editing portions of large
  18.         documents with multiple window views and multiple windows containing
  19.         various other portions of the same document.  In this way, huge
  20.         text files can be edited in memory.  It depends on how the programmer
  21.         makes use of the options and techniques available.  Although PBWrite
  22.         contains features which allow loading, reformatting, and saving
  23.         text, and has a wide range of utilities built in, a resourceful
  24.         programmer can do a great deal with how and when the PBWrite
  25.         subroutine is called, what is passed to it, and what happens when
  26.         it is exited.  For instance, the document in PBWrite can be printed
  27.         with the word-star keystrokes ^K-P.  If the user presses the F7
  28.         key (one of several exit keys) the PBWrite subroutine will exit.
  29.         The programmer can tell what key was used to exit the program and,
  30.         as an example, if F7 was used, he may then initiate a mail-merge
  31.         and print routine of his own design.  F10 could, perhaps, advance
  32.         to the next file in a row or ESC could go back to the previous
  33.         window.  It is all up to the programmer.  PBWrite is designed to
  34.         provide the best possible environment during which editing is
  35.         taking place.)))
  36.  
  37.         EDITING KEYSTROKES
  38.  
  39.         Navigation
  40.  
  41.         Of course the cursor pad controls cursor movement within the
  42.         edit window, up, down, left, right, home, end, etc. all are
  43.         used to navigate within the text in the window.  The cursor
  44.         will not advance beyond the end of the document or beyond
  45.         the end of a line with these navigation keys.  The only way
  46.         to move beyond the end of a line is by adding more text to it,
  47.         and the only way to scroll past the end of the document is
  48.         by adding lines by typing more lines in or pressing ENTER.
  49.  
  50.         Why Word-Star
  51.  
  52.         PBWrite's hot keys are closely related to the Word-Star convention
  53.         which, although considered old fashioned by the new generation of
  54.         mouse and track-ball jockeys, are still the most widely used, widely
  55.         standardized, and widely remembered convention.  These keystrokes
  56.         were not implemented because they are the most pleasant, they were
  57.         implemented because any other hot-key convention would probably be
  58.         more alien to more people than these.  The author of PBWrite also
  59.         declined to invent his own set of keystrokes because nothing is more
  60.         irritating to him than when people try to invent conventions and
  61.         actually expect a tiny handful of people to take the time getting
  62.         used to them.  If you are going to get used to a standard set of
  63.         keystrokes, it might as well be something that can be found else-
  64.         where as well.
  65.  
  66.         Editing Hot Keys
  67.  
  68.         Some edit functions can be performed with a simple control+key
  69.         operation, that is, you hold down the control key and press another
  70.         simultaneously.  Other more specialized editing functions require
  71.         that you press control+K or control+Q and then follow it with
  72.         an additional keystoke (without holding down the control key).
  73.  
  74.          ^Y  means control+Y   (which means to hold down the control key and)
  75.          ~~        ~~~~~~~~~   (then press Y simultaneously, then release.  )
  76.  
  77.         ^K-D means control+K and then D
  78.                                (which means to press both control and K,    )
  79.                                (then release, and then press just the D key.)
  80.  
  81.         ^Y = Delete the current line that the cursor is on.
  82.         ^T = Delete the word immediately following the cursor.
  83.         ^U = Restore the last line or word deleted.
  84.  
  85.         Every line and word you delete will be remembered, up to 32K, in
  86.         the order they were deleted.  You can restore any number of lines
  87.         or words deleted with ^U in the reverse order they were originally
  88.         deleted.
  89.  
  90.         ^D = Erase all text in the current edit window.  If you have not
  91.              saved the document since it was last changed, PBWrite will
  92.              ask if you want to save it.
  93.  
  94.         ^G = Change margins.  A box will pop up with the right margin
  95.              value in it.  Enter another number (from 15 to 4096) or press
  96.              escape to abort.  If you enter a number to change the margin
  97.              you will be given three options for reformatting.
  98.  
  99.                 1) reformat on double carriage returns
  100.                 2) reformat, preserve carriage returns
  101.                 3) do not reformat and continue
  102.  
  103.              The first option will rebuild every paragraph with the new
  104.              margines.  It will only start a new paragraph where a blank
  105.              line appears, that is, a double carriage return.  The second
  106.              option will reformat, however every line will be followed
  107.              by a carriage return, so very little actual reformatting will
  108.              take place.  The final option will reset the current margin
  109.              leaving existing text unchanged.
  110.  
  111.         Block Operations
  112.  
  113.         ^K-B = Mark beginning of block at current cursor position.
  114.         ^K-K = Mark end of block at current cursor position.
  115.  
  116.                 A marked block will not appear highlighted in the
  117.                 current version of PBWrite.
  118.  
  119.         ^K-C = Copy a marked block to the current cursor position.
  120.         ^K=V = Move a marked block to the current cursor position.
  121.         ^K-Y = Erase a marked block of text
  122.         ^K-W = Write a marked block to a disk file
  123.                 (You will be prompted for a file name.)
  124.         ^K-P = Print a marked block to the default PRN printer.
  125.         ^K-R = Read a file into the block paste buffer.
  126.                 (You must use ^K-C to actually insert the block at
  127.                  the current cursor location)
  128.  
  129.         Loading and Saving
  130.  
  131.         ^K-D = Save the current text to disk and exit PBWrite
  132.         ^K-S = Save the current text but do not exit
  133.         ^K-Q = DO NOT SAVE the current text and exit PBWrite.  You will
  134.                be prompted "Are you sure?"
  135.  
  136.  
  137.         F2   = Save text (same as ^K-S)
  138.         F3   = Load a new document into the editor
  139.         F4   = Print the current document to LPT1, 2 or 3
  140.  
  141.         Other operations
  142.  
  143.         F5   = Toggle ZOOM the current window from small to full-screen
  144.                and back again.  The window will automatically return to
  145.                small (the original size) when exited.
  146.  
  147.         ^K-M = Start Macro.  You will be prompted for a hot key (ALT+
  148.                something) for the macro.  Then enter any sequence of
  149.                keystrokes (without exiting PBWrite).  Press ALT+M to
  150.                finish recording.  Macros are not saved unless the
  151.                program containing PBWrite is designed to save them.
  152.  
  153.         ^Q-A = Search and Replace.  You will be prompted for a string
  154.                of characters (case sensitive) to search for and then
  155.                a string to replace them with.  All occurances of the
  156.                search string will be replaced with the replace string.
  157.  
  158.         The following keys will exit PBWrite.  It is up to the programmer
  159.         what happens after that.  The scan code or ASCII code of the
  160.         exit key is stored in the ExitCode% parameter.  The programmer
  161.         must list in his documentation what each key may possible do.
  162.  
  163.         ESCAPE
  164.         ALT-X
  165.         ATL-Q
  166.         F6
  167.         F7
  168.         F8
  169.         F9
  170.         F10
  171.  
  172.         Comments and suggestions for PBWrite please send to ...
  173.  
  174.         Erik Olson
  175.         C/O PowerBASIC Tech Support
  176.         1350 Birchcrest Blvd.
  177.         Port Charlotte, FL  33952
  178.  
  179.         (813) 625-1172 = PowerBASIC Tech Support line.
  180.