home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 247.lha / QED_v1.0_beta_0.15 / Qed_User.doc < prev    next >
Text File  |  1989-06-08  |  39KB  |  889 lines

  1.  
  2.  
  3.  
  4.  
  5.                                      QED
  6.  
  7.                               AMIGA TEXT EDITOR
  8.                                    REV 1.0
  9.  
  10.                      Copyright 1989 by Darren M. Greenwald
  11.  
  12.                               All rights reserved
  13.  
  14.  
  15.                              User's documentation
  16.                              Last revised 5/5/89
  17.  
  18.      QED may be freely distributed.  It may not be distributed in any
  19. commercial product, shareware product, or commercial publication without
  20. permission.  It is permissible to release QED as part of a public domain
  21. collection, or on a telecommunication service as long as no "special
  22. charge" is made for this program; "special charge" does not include
  23. "reasonable" charges for replication of the media, or standard charges for
  24. use of the system. 
  25.  
  26.      The intent of the above should be clear - I did the work, and while
  27. you are allowed to freely distribute the program, you may not profit from
  28. it.
  29.  
  30.      Any archived files which the author distributes MUST be left intact. 
  31. If you do distribute this program, I insist that you distribute all the
  32. files including any notices.
  33.  
  34.      QED is SHAREWARE - the registration fee is $20, and in return you will
  35. receive complete documentation describing QED's command line language,
  36. ARexx interfacing, keyboard mapping, etc.
  37.  
  38.  
  39.      Darren M. Greenwald
  40.      2511 W. Sunflower Av. #D-16
  41.      Santa Ana, CA 92704
  42.  
  43.      GEnie E-MAIL address: DMG
  44.  
  45.  
  46. DISCLAIMER:
  47. ---------------------------------------------------------------------
  48.  
  49.      In no way can the author be held responsible for any damages, loss of
  50. anticipated profits, or any other perceived loss related to using this
  51. program.  The user assumes the entire risk, and responsibility when using
  52. this program.
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65. Section 1.0                   STARTING QED
  66. =====================================================================
  67.  
  68.      It is assumed the user knows how to install QED on their system, or
  69. working disk.  QED is a stand alone program, and is easily copied to any
  70. destination directory; no special support libraries, or files are required.
  71.  
  72.      By default, QED opens a single, unnamed text editing window upon
  73. start up.  You may begin entering text immediately if you like, or open an
  74. existing file for editing.  ARexx owners have the option of creating a
  75. start up macro which will be automatically executed when QED is started. 
  76. All of QED's options, and capabilities can be accessed using the macro
  77. capability, so this is an excellent way to create a configuration file to
  78. set the various options up the way that you want.  Only registered users
  79. will receive documentation describing QED's built in command language, and
  80. how to write ARexx macros for use with QED. 
  81.  
  82.  
  83. Section 2.0                QED REQUESTERS
  84. =====================================================================
  85.  
  86.      At times QED will ask for a response from you in the form of a
  87. requester.  All QED requesters are opened in draggable windows, and the
  88. position of all requesters is remembered for the duration of the editing
  89. session.  Therefore you can place the requester windows where you want
  90. them, and they will be opened in the same position where you last left
  91. them.  The size of all requesters are adjusted (width & height) to use your
  92. system font.
  93.  
  94.  
  95.      The File Requester -
  96.      ------------------
  97.  
  98.      Amiga users should be relatively familiar with file requesters,
  99.      however it is worth noting the following:
  100.  
  101.      The QED file requester does not make you wait for the directory to be
  102.      read before you can enter a file name, or change directories.
  103.  
  104.      The string gadget labeled "File:" is automatically activated, so it is
  105.      possible in some cases to enter a file name from the keyboard, and
  106.      press the RETURN key without ever touching the mouse.
  107.  
  108.      This file requester dynamically allocates, and deallocates memory as
  109.      needed for the directories; there is no built-in limit on the number
  110.      of directory entries that this requester can handle.
  111.  
  112.      A gadget labeled "TOGGLE:" allows you to toggle between a list of
  113.      devices in your system, and the directory list.  There is no built-in
  114.      limit on the number of devices which this requester can handle, and 
  115.      device names of up to 31 characters in length do not present a problem
  116.      as they do with some requesters.
  117.  
  118.      Input requesters -
  119.      ----------------
  120.  
  121.      Input requesters expect you to respond by typing in a number, or a
  122.      string of text.  Input requesters automatically activate the string
  123.      gadgets so often it is possible to respond by entering the
  124.      number or string(s), and pressing the RETURN key.  Of course you can
  125.      also respond using the mouse to select OK, or CANCEL.  If none of the 
  126.      string gadgets are activated, you can respond with the 'o' or 'c' keys 
  127.      on the keyboard.
  128.  
  129.      Notices & Queries -
  130.      -----------------
  131.  
  132.      Notices can only be responded to with an "OK" response, while queries
  133.      allow you to respond with an "OK" or "CANCEL" response.  If you
  134.      prefer, you can also respond to these requesters using the 'o' or 'c'
  135.      keys on the keyboard
  136.  
  137.  
  138. Section 3.0                   OPENING FILES
  139. =====================================================================
  140.  
  141.      QED allows you to OPEN, or INSERT existing files.  The difference is
  142. that opening a file replaces the text editing buffer, while inserting a
  143. file 'inserts' the file below the cursor position.  When opening a file,
  144. you will be prompted with a requester if you have made any changes to the
  145. text buffer being replaced.
  146.  
  147.      It is also possible to specify one, or more file names to be
  148. automatically opened in separate text editing windows when starting QED
  149. such as:
  150.  
  151. 1> run qed hello.c read_me "df0:my file"
  152.  
  153.      In the above example, QED will attempt to open the files named
  154. "hello.c", "read_me", and "df0:my file" in separate text editing windows. 
  155. If any of the above files are not found, then QED assumes you want to
  156. create a file of the same name, and opens an empty text editing window.
  157.  
  158.      QED is not suitable for use as a binary file editor because some
  159. binary characters are stripped, and converted to other characters when
  160. opening, or inserting a file.
  161.  
  162. Binary value         Action taken
  163. --------------------------------------------------------
  164. 11-255               Valid characters.  No stripping or conversion.
  165.  
  166. 10                   Linefeed - treated as an end of line character.
  167.  
  168. 9                    Tab - converted to spaces based upon the tab size
  169.                      setting for the window in which the file is opened.
  170.                      The default tab size is eight (8), but can be set to
  171.                      a unique value for each window from 1-20.  When a tab
  172.                      is found in a file, enough spaces are added to move
  173.                      the cursor to the next tab position.
  174.  
  175. 1-8                  Valid characters.  No stripping or conversion.
  176.  
  177. 0                    Stripped at load time.
  178.  
  179.  
  180. Selecting "OPEN", or "INSERT" file under the "Project" will result in the
  181. file requester being displayed.
  182.  
  183.  
  184. Section 4.0                   SAVING FILES
  185. =====================================================================
  186.  
  187.      QED allows you to save the entire text editing buffer, or a marked
  188. block of text using the "SAVE AS" option under the "Project" menu.  The
  189. "SAVE AS" option causes the file requester to be displayed.  Named files
  190. can be quickly saved (if any changes have been made to the file) using the
  191. "SAVE" option under the "Project" menu.
  192.  
  193.      In order to save a marked block of text, highlight the block (see the
  194. section described later on how to mark blocks of text), and simply select
  195. "SAVE AS".  When mark block mode is on, it is implied that you want to save
  196. just the marked block of text.  When mark block mode is off, it is implied
  197. that you want to save the entire text editing buffer to a file.
  198.  
  199.      You have the option of creating a backup file under the "Options"
  200. menu.  When turned on, QED will rename any file which is going to be
  201. over-written as 'qed.backup' before saving the file.  This allows you an
  202. opportunity to recover the over-written file should you over-write a file
  203. by mistake.
  204.  
  205.      You also have the option of saving text to a file in append mode under
  206. the "Options" menu.  This capability is often handy when you want to save
  207. multiple blocks of text to a single file.  When this option is turned on,
  208. all text written to a file will be appended to the end of the file.  If the
  209. file does not exist, it will be created.
  210.  
  211.  
  212. Section 5.0                OPENING A NEW WINDOW
  213. =====================================================================
  214.  
  215.      QED supports multiple text editing buffers in the form of an unlimited
  216. number of text editing windows.  This is advantageous because you can see
  217. what each buffer holds, and edit any buffer.  There is no built-in limit
  218. on the number of windows which can be opened other then that which the
  219. operating system can handle, and memory limitations.  There is also no
  220. significant performance penalty for opening multiple windows other then
  221. that which is typical of the operating system when managing multiple
  222. windows on the Workbench screen.
  223.  
  224.      In order to open a new window, select "NEW" under the "Project" menu. 
  225. Note that the pull-down menus are accessable, and shared by all text
  226. editing windows.  It is also important to note that menu selections affect
  227. the window from which the menu item was selected.  For example, selecting
  228. "QUIT" from a window causes only that window to be closed.  When the last
  229. window is closed, QED is automatically terminated.
  230.  
  231.      The general layout of a QED text editing window is depicted by the
  232. diagram below:
  233.  
  234.        ------ File name           -------  Line/Column cursor position
  235.        |                          |
  236. ----------------------------------------------------------
  237. | QED - Untitled              L:     1  C:    20   |  |  |- Front/Back
  238. ----------------------------------------------------------
  239. |                                                      |_|- Top of file
  240. |                                                      |_|- Page up
  241. |                                                        |
  242. |                                                        |
  243. |                      Text editing                      |
  244. |                        work area                       |
  245. |                                                        |
  246. |                                                        |
  247. |                                                       _|
  248. |                                                      |_|-Page down
  249. |                                                      |_|-End of file
  250. |                                                      | |-Window size
  251. ----------------------------------------------------------
  252.  
  253.      You can define the default window size that QED will use to open a
  254. window upon startup, as well as any NEW windows opened via the pull-down
  255. menus.  This capability requires the use of the SETENV function provided as
  256. part of the 1.3 operating system.
  257.  
  258.      In order to use this function, assign ENV: to the RAM: disk, and
  259. use the SETENV command such as -
  260.  
  261. 1>setenv qedsize "0 20 300 100"
  262.  
  263.      Where the four parameters are left edge, top edge, width, and height in
  264. pixels.  If you enter any erroneous arguments, the window is opened to the
  265. full size of the WB screen a few pixels below the title bar.  Ideally you
  266. would make the assignment of the environment variable "qedsize" as part of
  267. your startup-sequence.
  268.  
  269.  
  270. Section 6.0                WINDOW OPTIONS
  271. =====================================================================
  272.  
  273.      Each text editing window has its own private text editing buffer, and
  274. private characteristics including:
  275.  
  276.      Under the "Tools" menu
  277.      ----------------------
  278.  
  279.      Pen and paper colors -
  280.  
  281.           Pen, and paper colors can be toggled between 4 preset color
  282.      combinations by selecting "COLOR" under the "Tools" menu.  These
  283.      color combinations have been selected to also work properly using a
  284.      one bit-plane Workbench screen such as is possible using the
  285.      1008x800 monitor.
  286.  
  287.           From the command line mode it is also possible to set a specific
  288.      preset color combination, or any pen/paper color combination of your
  289.      choice.  Pen/Paper colors can be set from 0-255 should newer Amigas
  290.      offer more on-screen colors.
  291.  
  292.  
  293.      Tab size -
  294.  
  295.           The tab size can be set individually from 1-20 for each window
  296.      under the "Tools" menu, but by default is set to the proper value of
  297.      eight (8).
  298.  
  299.  
  300.      Right margin -
  301.  
  302.           The right margin can be set individually for each window under
  303.      the "Tools" menu.  The right margin setting is used by the formatter,
  304.      and word-wrap routine.  By default, the right margin is set to 75, but
  305.      can be set to any value from 8-10000.
  306.  
  307.           As an alternative, you can set the right margin to a value of one
  308.      (1) in which case the right margin is variable based on window, and
  309.      font width.  In this case the right margin is equivalent to the
  310.      maximum number of columns visible in the window.
  311.  
  312.      Show end of lines -
  313.  
  314.           Selecting "SHOW EOLS" under the "Tools" menu toggles visible
  315.      end of line characters on/off.
  316.  
  317.  
  318.      Under the "Options" menu
  319.      ------------------------
  320.  
  321.      Overstrike mode -
  322.  
  323.           QED allows you to enter text in insert, or overstrike mode.
  324.  
  325.      Word wrap -
  326.  
  327.           QED will perform "simple" word-wrap when text is entered past the
  328.      right margin.  This feature should not be confused with the more
  329.      complex real-time paragraph reformatters typical of many word-
  330.      processors.
  331.  
  332.      Case sensitive search mode -
  333.  
  334.           QED allows you to search for text in case, or non-case sensitive
  335.      search modes.  When case sensitive mode is turned off, the alpha
  336.      characters (a-z and A-Z) are treated as equivalent.
  337.  
  338.           For example, you could enter "cat" as a search string, and
  339.      "cat", "CAT", "Cat", etc., would all be found when searching for
  340.      text, and/or when searching & replacing text.
  341.  
  342.      Append saves -
  343.  
  344.           This option allows you to save text to a file in append mode in
  345.      which case any text written to an existing file will be appended to
  346.      the end of the file.  This capability is often useful when marking
  347.      multiple blocks of text to be saved to single a file.
  348.  
  349.      Backup files -
  350.  
  351.           This option will cause any file which is going to be over-written
  352.      by a save operation to be renamed as "qed.backup" before saving the
  353.      file.  This allows you an opportunity to recover a file which is
  354.      inadvertently replaced by a save operation.  
  355.  
  356.      Mark line mode -
  357.  
  358.           When this option is turned on, you can only mark whole lines
  359.      of text to be cut, copied, saved, erased, formatted, replaced,
  360.      and printed.  The block, and project insert functions are also
  361.      affected.  When this options is turned on, a block of text which is
  362.      inserted from the clipboard, or a file will be inserted as a group of
  363.      lines above the cursor position.  This mode will most likely be
  364.      preferred by those working with line oriented text (e.g., programmers).
  365.  
  366.           When this option is turned off, you can mark a block of text
  367.      from any line/column position to any line/column position.  The block,
  368.      and project insert functions are also affected.  When this option is
  369.      turned off, a block of text which is inserted from the clipboard, or a
  370.      file will be inserted at the cursor position.  This mode will most
  371.      likely be preferred by those working with document oriented text.
  372.  
  373.  
  374.      Free form editing -
  375.  
  376.           This option affects the cursor's behavior.  When turned on, the
  377.      cursor can be positioned past the end of line allowing you to enter
  378.      text beyond the end of a line in which case spaces are automatically
  379.      inserted as needed.  This mode will most likely be preferred by those
  380.      working with line oriented text (e.g., programmers).
  381.  
  382.           When turned off, the cursor cannot be moved past the end of line.
  383.      The right cursor key is also affected; if you cursor right past the
  384.      end of a line, the cursor is wrapped to the first character of the
  385.      next line.  This mode will most likely be preferred by those working
  386.      with document oriented text.
  387.  
  388.      Insert tabs -
  389.  
  390.           This option affects how the TAB key behaves.  When turned off,
  391.      the tab key moves the cursor to the next tab stop.  When turned on,
  392.      enough spaces are inserted at the cursor position to move the cursor
  393.      to the next tab stop.  When free form editing is turned off, and this
  394.      option is turned off, spaces may still be appended to the end of a
  395.      line if needed.
  396.  
  397.  
  398.      When opening a new window, these characterstics are inherited from the
  399. window from which the "NEW" command was issued.  It is also possible to
  400. write macros which are automatically executed when a file is opened.  This
  401. capability is extremely useful for automatically adjusting the various
  402. window options listed above to suit the type of file you are working on.
  403.  
  404. For example, you might load a "C" source code file in one window, and have
  405. a macro which automatically sets your tab size to three (3), turns mark
  406. line mode on, turns free-form editing on, etc.
  407.  
  408. In another window you might then load a document file, and have a macro
  409. which automatically sets your tab size to five (5), turns mark line mode
  410. off, turns free-form editing off, etc.
  411.  
  412.  
  413. Section 7.0                CURSOR POSITIONING
  414. =====================================================================
  415.  
  416.      Like most text editors, QED allows you to insert, or over-strike text
  417. at the cursor position.  Perhaps the easiest way to position the cursor is
  418. with the mouse using the "point & click" method.  Of course the keyboard
  419. can be used to position the cursor using the cursor keys.
  420.  
  421.      Text scrolling is allowed in all directions, and can be accomplished
  422. via the cursor keys, or mouse using the "point & drag" method.
  423.  
  424.      It is also possible to go to a specific line number (see the "Cursor"
  425. menu), or mark & go to a spot.  Command line mode users have many more
  426. cursor positioning tools available such as the ability to go to a specific
  427. line, and column position.
  428.  
  429.  
  430. Cursor key   |  Result
  431. ---------------------------------------------------------------------------
  432.              |
  433. Up           | Move the cursor up a single line.
  434.              |
  435. Down         | Move the cursor down a single line.
  436.              |
  437. Left         | Move the cursor left a single character.  If the cursor is
  438.              | at the beginning of a line, the cursor is wrapped up to the
  439.              | end of the previous line.
  440.              |
  441. Right        | Move the cursor right a single character.
  442.              |
  443. SHIFTED      | Move the cursor up a single window page.
  444. Up           |
  445.              |
  446. SHIFTED      | Move the cursor down a single window page.
  447. Down         |
  448.              |
  449. SHIFTED      | Move the cursor to the previous word.
  450. Left         |
  451.              |
  452. SHIFTED      | Move the cursor to the next word.
  453. Right        |
  454.              |
  455. ALT          | Move the cursor to the first line in the text editing
  456. Up           | buffer.
  457.              |
  458. ALT          | Move the cursor to the last line in the text editing buffer.
  459. Down         |
  460.              |
  461. ALT          | Move the cursor to the beginning of the line.
  462. Left         |
  463.              |
  464. ALT          | Move the cursor to the end of the line.
  465. Right        |
  466.              |
  467. CTRL         | Move the cursor to the top of the window.
  468. Up           |
  469.              |
  470. CTRL         | Move the cursor to the bottom of the window.
  471. Left         |
  472. ---------------------------------------------------------------------------
  473.  
  474.  
  475. Section 8.0                BASIC EDITING KEYS
  476. =====================================================================
  477.  
  478.  
  479. Keypress     |   Result
  480. ---------------------------------------------------------------------------
  481.              |
  482. RETURN       | Splits the line at the cursor position.  If the cursor
  483.              | is positioned beyond the end of the line, a new line is 
  484.              | inserted.
  485.              |
  486. ENTER        | Inserts a new line with auto-indent.
  487.              |
  488. DELETE       | Deletes the character under the cursor.
  489.              |
  490. BACKSPACE    | Deletes the character to the left of the cursor.  If the 
  491.              | cursor is on the beginning of a line, the BACKSPACE key
  492.              | can be used to join the line with the previous line by
  493.              | effectively deleting the previous end-of-line character.
  494.              |
  495. TAB          | Moves the cursor to the next tab stop.  The tab size by 
  496.              | default is set to the proper tab value of 8, but can be
  497.              | set individually for each window.  You also have the option
  498.              | under the "Options" menu of having the tab key insert a
  499.              | sufficient number of spaces at the cursor position to move
  500.              | the cursor to the next tab stop.
  501.              |
  502. ---------------------------------------------------------------------------
  503.  
  504.  
  505. Section 9.0                DELETING TEXT
  506. =====================================================================
  507.  
  508.      At times you may want to delete larger pieces of text then is
  509. practical using the BACKSPACE, and DELETE keys described above.  QED
  510. provides a number of tools for deleting text listed under the "Edit" menu.
  511.  
  512.      Delete line -
  513.  
  514.           The entire line on which the cursor resides is deleted.
  515.  
  516.      Delete to end of line -
  517.  
  518.           Deletes all text from the cursor position to the end of the line.
  519.  
  520.      Delete word -
  521.  
  522.           Deletes the word on which the cursor resides.
  523.  
  524.      Undelete -
  525.  
  526.           Text which has been deleted using any of the above 3 functions is
  527.      copied to a 256 byte private backup buffer (one buffer per editing
  528.      window).  The last bit of deleted text (line, word, or end of line)
  529.      can be restored using the undelete command.
  530.  
  531.           QED will allow you to work with lines longer then 256 characters,
  532.      however to insure that you have an opportunity to undelete text, the
  533.      delete tools listed above will not work if the amount of text to be
  534.      deleted exceeds 256 characters.  In this case use the block cut, or
  535.      erase commands.
  536.  
  537.  
  538. Section 10.0                BLOCK OPERATIONS
  539. =====================================================================
  540.  
  541.      QED allows you to mark a block of text to be cut, or copied to a
  542. clipboard area which is used by all the text editing windows.  In addition,
  543. many of the QED commands can be restricted to a marked block of text (e.g.,
  544. SAVE AS, REPLACE, PRINT, FORMAT, etc.).
  545.  
  546.      Mark block mode can be toggled on/off from the pull-down menus under
  547. the "Edit" menu, or can be toggled on/off by "double-clicking" the left
  548. mouse button over the same row/column position.
  549.  
  550.      Mark block mode is transparent; you can continue to edit text like
  551. usual, and the pull-down menus are always accessable.  In order to mark a
  552. block of text, simply toggle mark block mode on, and use the cursor keys,
  553. or mouse to highlight a range of text.
  554.  
  555.      As indicated above, you have the option under the "Options" menu of
  556. toggling between line mark mode (always marks whole lines), or free mark
  557. mode (allows you to mark from/to any row/column position).
  558.  
  559.      Both the CUT, and COPY block tools under the "Edit" menu copy
  560. the marked block of text to the clipboard, however CUT block also deletes
  561. the text.
  562.  
  563.      In some cases you may want to cut a block of text, but you don't
  564. want it copied to the clipboard.  In this case use the ERASE tool under the
  565. "Project" menu.  ERASE will erase all text in a text editing window, and
  566. free any up any memory that it can, however if mark block mode is on, the
  567. ERASE function will only erase the marked block.  In either case you will
  568. be prompted with a requester because any erased text cannot be restored.
  569.  
  570.      INSERT block under the "Edit" menu inserts whatever is in the clipboard
  571. at the cursor position.  If MARK LINE MODE is ON, the contents of clipboard
  572. will be inserted as a group of lines above the cursor position.  If MARK
  573. LINE MODE is OFF, the contents of the clipboard will be inserted at the
  574. cursor position.
  575.  
  576.  
  577. Section 11.0                SEARCH & REPLACE
  578. =====================================================================
  579.  
  580.      The SEARCH, REPLACE, and HUNT tools under the "Tools" menu allow you
  581. to search for a phrase, replace a phrase, and quickly repeat the last
  582. search and/or replace operation.
  583.  
  584.      As indicated above, QED supports both case, and non-case sensitive
  585. search modes, and can be optionally set for each text editing window.
  586.  
  587.      Both SEARCH, and REPLACE will prompt you for strings using a
  588. requester.  Both commands will search forward from the cursor position for
  589. a matching search string, and position the cursor on the first occurrance
  590. of the search string if a match was found.
  591.  
  592.      When using the REPLACE command, you will also be prompted with a
  593. message in the title bar of the window such as:
  594.  
  595.      Replace? (Y)es (N)o (G)lobal (M)arked (Q)uit
  596.  
  597.      You may respond using the upper, or lower case keys on the keyboard
  598.      where (?) causes the following action to be taken:
  599.  
  600.      (Y)es    - Yes, replace the string with the search string, and
  601.                 continue searching.
  602.  
  603.      (N)o     - No, don't replace the string, and continue searching.
  604.  
  605.      (G)lobal - Replace all occurrences of the search string forward from
  606.                 the cursor position.
  607.  
  608.      (M)arked - Replace all occurrences of the search string found within
  609.                 a marked block.  In order to use this option, you must
  610.                 first mark a block of text.
  611.  
  612.      (Q)uit   - Quit searching.  You may also click in the window with
  613.                 the LEFT mouse button to abort the search.
  614.  
  615.      In order to search, and replace on 'end-of-line' characters, simply
  616. use the CTRL-J character in your search, and replace strings to denote
  617. 'end-of-line' characters.  CTRL-J is equivalent to a binary value of 10;
  618. also known as a LINEFEED.  Other control key sequences as listed in Section
  619. 16.0 below may also be used in your search strings as needed.
  620.  
  621.      The HUNT command can be used to repeat the last SEARCH, and/or REPLACE
  622. operation.  When using the HUNT command, searches will skip the character
  623. under the cursor to avoid finding duplicate matches of a string.
  624.  
  625.      
  626. Section 12.0                FORMATTING TEXT
  627. =====================================================================
  628.  
  629.      The FORMAT tool under the "Tools" menu allows you to format a
  630. paragraph, or a marked block of text.
  631.  
  632.      If mark block mode is off, then FORMAT searches forward from the line
  633. on which the cursor resides for two (2) consecutive end of line characters.
  634.  The following illustration may be helpful in better understand how the
  635. FORMAT tool works.
  636.  
  637. Let's suppose the original piece of text looks like this:
  638. --------------------------------------------------------
  639.  
  640. This is some text to demonstrate a point.
  641.  
  642. This is some more text.
  643.  
  644.  
  645. This is how the text is evaluated by the FORMAT command:
  646. -------------------------------------------------------
  647.            _________________________________Cursor position column 11.
  648.           |
  649.           |          _______________________Wrapping will occur here.
  650.           |         |
  651.           |         |    ___________________Right margin is 25.
  652.           |         |   |
  653.           |         |   |        ___________Column 33 is > right margin.
  654.           |         |   |       |
  655. This is some text to demonstrate a point. - This line of text is terminated
  656.                                           - by 2 end-of-line characters.
  657. This is some more text
  658.  
  659.  
  660. This is the result after using the FORMAT command:
  661. -------------------------------------------------
  662.  
  663. This is some text to
  664. demonstrate a point.
  665.  
  666. This is some more text.
  667.  
  668.  
  669.      FORMAT will never insert, or delete any spaces.  What it will do is
  670. replace spaces with end-of-line characters, and vice-versa in an attempt to
  671. cause the affected text to fit in the right margin setting with word-wrap.
  672.  
  673.  
  674. Section 13.0                INDENTING TEXT
  675. =====================================================================
  676.  
  677.      Programmers who work with block oriented languages frequently find
  678. themselves indenting sections of source code left, and right.  Often this
  679. can mean manually deleting, and/or inserting spaces or tabs.  QED provides
  680. a tool which allows you to easily indent a line, or a range of lines to the
  681. next left or right tab position.
  682.  
  683.      Under the "Tools" menu, you have the option of indenting the current
  684. line left, or right to the next tab stop, or indenting multiple lines.  If
  685. you choose the INDENT MULTIPLE tool, you will be prompted with a message in
  686. the window's title bar such as:
  687.  
  688.      Indent? (R)ight (L)eft (S)kip ([) (]) (Q)uit
  689.  
  690.      You may respond using the upper, or lower case keys on the keyboard
  691.      where (?) causes the following action to be taken:
  692.  
  693.      (R)ight - Indent line right, and move cursor to the next line.
  694.  
  695.      (L)eft  - Indent line left, and move cursor to the next line.
  696.  
  697.      (S)kip  - Skip the line, and move cursor to the next line.
  698.  
  699.      ([)     - Indent line left, and don't move the cursor.
  700.  
  701.      (])     - Indent line right, and don't move the cursor.
  702.  
  703.      (Q)uit  - Abort multiple indent utility.  You may also click in the
  704.                window with the LEFT mouse button to quit.
  705.  
  706.  
  707. The INDENT MULTIPLE tool is extremely useful when you wish to change the
  708. indent of a range of lines.  Place the cursor at the top line of the range
  709. you want to change, and repeatedly use the (R), or (L) keys.  You can also
  710. skip lines you dont want changed, and adjust each line individually using
  711. the ([), and (]) keys.
  712.  
  713.  
  714. Section 14.0             MISCELLANEOUS FEATURES
  715. =====================================================================
  716.  
  717.      QED allows you to assign any built in QED command, ARexx macro, and
  718. any DOS command to ANY key when pressed alone (including the FUNCTION
  719. keys), or to ANY key when pressed in conjunction with the CTRL, ALT, or
  720. SHIFT keys.  In order to use this capability you will need the Registered
  721. User's Documentation.
  722.  
  723.      By default the ALT/keys are mapped to imitate the RIGHT AMIGA key menu
  724. alternatives listed in the pull-down menus.  For those of you who are
  725. uncomfortable with using the RIGHT AMIGA key, you can use the LEFT, or
  726. RIGHT ALT key instead unless you reassign these keys.
  727.  
  728.      Even though there is no "NEW CLI" command in the pull-down menus, the
  729. CTRL/HELP key combination is by default mapped to open a new CLI window.
  730.  
  731.      If you own Brian Jackson's ACK terminal program for the Amiga, you can
  732. mark blocks of text to be sent to ACK via a message port just as if you had
  733. typed the text directly, or sent an ASCII file.  In order to do this,
  734. simply mark a block of text that you want to send, and press CTRL "`". 
  735. Remember that if this does not suit your taste, you can remap the keyboard
  736. as mentioned above.  Only the Amiga makes it possible!
  737.  
  738.      Brian Jackson can be reached on GEnie: E-MAIL address "B.J."
  739.  
  740.      The ERASE function under the "Project" menu will clear, and reset the
  741. text editing buffer as described under section 10.0 above.
  742.  
  743.      The JOIN command under the "Edit" menu will join the line on which the
  744. cursor resides with the previous line.  Joining lines can also be
  745. accomplished by back spacing over the previous end of line character as
  746. described under section 8.0 above.
  747.  
  748.      The MARK SPOT, and GOTO SPOT commands under the "Edit" menu can be
  749. used to mark spot, and quickly return to the same position later, however
  750. the spot may be lost when using the global replace capabilities, or if you
  751. delete the text corresponding to the marked spot.
  752.  
  753.      QED has a built-in keyboard repeat limiting feature which will only
  754. limit repeating key press messages if QED cannot keep up (e.g., during
  755. heavy multi-tasking, or when working with very large files).  If you have
  756. ever used an Amiga program in which you inadvertently held down a repeating
  757. key such as the BACKSPACE key too long, and watched your last 10 minutes of
  758. work be erased, you will appreciate this feature.
  759.  
  760.  
  761. Section 15.0         THE COMMAND LINE MODE & AREXX MACROS
  762. =====================================================================
  763.  
  764.      The "CMD LINE" command under the "Tools" menu causes the command line
  765. window to be opened (if its not already), and assigns the command line
  766. window to the text editing buffer from which this command was issued.  As
  767. an alternative, you can use the ESC key.  The command line mode allows you
  768. to enter commands, and execute/debug ARexx macros.  Any command which can
  769. be performed using the pull-down menus, or keyboard can be accomplished
  770. from the command line mode, and much more...
  771.  
  772.      The command line mode allows you to perform all of the functions
  773. available in the pull-down menus, execute ARexx macros, and more.  In order
  774. to use this capability you will need the Registered User's Documentation.
  775.  
  776.      The "RUN MACRO" command under the "Tools" menu will list, and allow you
  777. to execute all ARexx macros in your REXX: directory.
  778.  
  779.  
  780. Section 16.0            EDITING BINARY CHARACTERS
  781. =====================================================================
  782.  
  783.      QED is a text editor, so binary file editing is not fully supported,
  784. however you can open, display, edit, and save most of the binary character
  785. set other then binary 0, and binary 9 (TABS are currently converted to
  786. spaces).  This capability should provide sufficient for those who would
  787. like to insert ANSI, or printer device control sequences in their files.
  788.  
  789.      QED utilizes your system font, and it is worth noting that AMIGA fonts
  790. generally do not contain character definitions for the complete binary
  791. character set 0-255.  Most system fonts only have character imagery for
  792. binary 32-255, and possibly a smaller subset of characters.  Undefined
  793. characters are displayed using a default image (generally a box).
  794.  
  795.      In order to compensate, QED will display the characters "A" through
  796. "_" in inverted imagery to represent binary 1-31.
  797.  
  798.      You can also enter these characters from the keyboard by holding down
  799. the CTRL key, and pressing the following keys on the keyboard:
  800.  
  801.      a = binary 1                  q = binary 17
  802.      b = binary 2                  r = binary 18
  803.      c = binary 3                  s = binary 19
  804.      d = binary 4                  t = binary 20
  805.      e = binary 5                  u = binary 21
  806.      f = binary 6                  v = binary 22
  807.      g = binary 7                  w = binary 23
  808.      h = binary 8                  x = binary 24
  809.      i = binary 9  (Hard tab)      y = binary 25
  810.      j = binary 10 (Line feed)     z = binary 26
  811.      k = binary 11                 [ = binary 27
  812.      l = binary 12                 \ = binary 28
  813.      m = binary 13 (Cairrage ret)  ] = binary 29
  814.      n = binary 14                 ^ = binary 30 (CTRL SHIFTED 6)
  815.      o = binary 15                 _ = binary 31 (CTRL SHIFTED -)
  816.      p = binary 16
  817.  
  818.      The above sequences rely on the standard operating system routines to
  819. decode the keyboard, however you can assign key values to any keyboard
  820. combination of your choice from the command mode.  Of course you can also
  821. assign whole strings of text which may include binary control sequences to
  822. a key press combination.
  823.  
  824.  
  825. Section 17.0                  PRINTING
  826. =====================================================================
  827.  
  828.      QED allows you to print the entire contents of a windows text editing
  829. buffer, or a marked block of text (if a block is marked).  Simply select
  830. PRINT from the pull down menus, and respond to the requester verifying that
  831. you want to print.  Printing occurs as a background task, and does not
  832. interfere with any other QED features.  You may even quit QED while
  833. printing is still in process.  In this case QED will release as much
  834. memory as it can, and will hang around in a wait state until the printer is
  835. done before fully exiting.
  836.  
  837.      If you select PRINT again while the printer is busy, you will be
  838. prompted with a requester asking if you want to cancel the current print
  839. job.  If you elect to cancel printing, the printer will stop as soon as
  840. possible.  This may take a few seconds for the printer.device to abort.
  841.  
  842.  
  843. Section 18.0             MAKING QED RESIDENT
  844. =====================================================================
  845.  
  846.      QED can be started in "resident" mode by including "-r" (no quotes) as
  847. the first argument on the command line.  This mode will force QED to hang
  848. around in memory until awakened by another small utility program provided
  849. with QED.
  850.  
  851.      Normally when you load QED from disk, or from ram disk, QED will exit
  852. when the last text editing window is closed freeing up all the memory used
  853. by QED.  If you run, and exit QED frequently, this means that QED must be
  854. reloaded each time.  Many users place commonly used programs in a ram disk;
  855. this avoids the delays of reloading a program from floppy, or hard drive,
  856. but still means that the program must be copied from ram disk to another
  857. section of memory before being run.
  858.  
  859.      QED's resident mode allows you to keep a "single" copy of QED hanging
  860. around in memory at all times.  This is more efficient then run QED from a
  861. ram disk, and faster then reloading QED from a floppy, or hard drive.
  862.  
  863.      Remember that QED allows you to open an unlimited number of text
  864. editing windows, that there is no significant performance penalty for
  865. opening multiple windows, and that this is much more efficient then running
  866. multiple copies of QED to edit separate files.  You can still run QED as
  867. separate tasks if desired, however only one copy of QED can be made
  868. resident, and in most cases one copy of QED is sufficient to handle your
  869. multi-file editing needs.  
  870.  
  871.      If QED is started in resident mode using the "-r" flag, by default no
  872. text editing windows, or files will be opened.  You can still include a
  873. list of file names following this command line flag to be automatically
  874. loaded into separate text editing windows.  See section 3.0 for details on
  875. specifying a list of files to be opened as CLI arguments.
  876.  
  877.      A small utility program has been provided called "QGO" which will send
  878. the necessary commands to a resident QED task to open new QED windows,
  879. files, etc.  In fact "QGO" behaves much like QED in that you can specify a
  880. list of files names to be automatically opened in separate text editing
  881. windows.  If no file names are included as CLI arguments, "QGO" will send
  882. the necessary commands to QED to open a single, un-named text editing
  883. window.
  884.  
  885.      Finally "QGO" can also send a command to QED to turn resident mode
  886. off, in which case QED will be fully exited once the last window is closed.
  887.  In order to do this, simple include "-q" as the first CLI argument when
  888. using the "QGO" program.
  889.