home *** CD-ROM | disk | FTP | other *** search
/ The CDPD Public Domain Collection for CDTV 3 / CDPDIII.bin / pd / utilities / editors / textra / docs / textra.doc < prev    next >
Encoding:
Text File  |  1993-01-07  |  39.8 KB  |  942 lines

  1.  
  2.    This document describes TEXTRA, a very user-friendly text editor.  So 
  3. user-friendly, I hope, that you could use it without reading a manual.  
  4. Good learning philosophy: play with it.  One of the easiest, that's the 
  5. goal.
  6.  
  7.    TEXTRA is SHAREWARE.  For $25.00, I will send you a personalized 
  8. executable that does not contain the 60-second startup-delay screens that 
  9. are in the otherwise-identical UN-registered version.
  10.  
  11.    The UN-registered version is freely-distributable.  However, please 
  12. insure that the unaltered 'doc' files & rexx scripts accompany the 
  13. executable if you do pass it around.
  14.  
  15.    If you are using TEXTRA to read this file, just Press F4 to view the 
  16. next page.  F5 to review the previous page.
  17.  
  18.    TEXTRA was written in JForth Professional, which I recommend highly.  As 
  19. far as I know, TEXTRA is enforcer-clean under WB 2.04.
  20.  
  21. 26-Apr-89 v1.01 executable size 60148
  22. 29-May-89 v1.02   "    "    "   60864
  23. 22-Jul-89 v1.03   "    "    "   61080
  24. 21-Oct-89 v1.04   "    "    "   65208
  25. 05-Jan-90 v1.05   "    "    "   69836
  26. 18-Feb-90 v1.06   "    "    "   69400
  27. 18-Apr-90 v1.07   "    "    "   70520
  28. 06-Jun-90 v1.08   "    "    "   71544
  29. 15-Dec-90 v1.09   "    "    "   79404
  30. 26-Aug-91 v1.10   "    "    "   98976 ARexx, horiz scroll bar, help kbd
  31. 23-Oct-91 v1.11   "    "    "  100500 WB2.0 graphics, fix GET CURSOR CHAR
  32. 16-Mar-92 v1.12   "    "    "  108920 Undo, SmartLaunch, 1st shareware
  33.   "   "     "     "    "    "  111280 -- v1.12 Unregistered version
  34. 07-Jan-93 v1.13   "    "    "  126780 Fonts, Multi-Processing, lots more
  35.   "   "     "     "    "    "  129252 -- v1.13 Unregistered version
  36.  
  37. (see the 'WhatsNew.doc' file for better history/features information)
  38. ---------------------------------------------------------------------------
  39.  
  40.  
  41.               T A B L E     O F     C O N T E N T S
  42.              ---------------------------------------
  43.  
  44. NOTE: If you're using TEXTRA to read this Table Of Contents, a GREAT
  45.       way to find specific topics is to...
  46.       
  47.       1. Double-click on the section number (for example, 9.2.1 )
  48.       2. "Find" it by using Right-Amiga-F (press RETURN in the requester)
  49.       3. If necessary, use Right-Amiga-N (Find Next) to locate the next
  50.          occurence of the same text (most likely a cross-reference).
  51.  
  52.  
  53. 1.  INSTALLING TEXTRA
  54.     1.1  The Textra Package
  55.          1.1.1 The Program and Icon
  56.          1.1.2 The ARexx Scripts
  57.          1.1.3 The Documentation
  58.     1.2  The Provided Installation Program
  59.          1.2.1 Installation of the program and icon
  60.          1.2.2 Installation of the Textra-ARexx Scripts
  61.          1.2.3 Installation of the Documentation
  62.          1.2.4 Final Verification before Installation
  63.     1.3  Manual Installation
  64.  
  65. 2.  INVOKING TEXTRA
  66.     2.1  General
  67.     2.2  Invoking from Workbench
  68.     2.3  Invoking from CLI or SHELL
  69.     2.4  TEXTRA as the Default Tool for "Project"-type icons
  70.     2.5  Launching more than once.
  71.  
  72. 3.  THE TEXTRA CURSOR
  73.     3.1  Cursor appearance
  74.     3.2  Positioning the cursor with the mouse
  75.     3.3  Positioning the cursor with the keyboard arrow keys
  76.     3.4  Quickly finding the cursor (function key F3)
  77.  
  78. 4.  ENTERING TEXT INTO THE DOCUMENT
  79.     4.1  Inserting text at the cursor location
  80.     4.2  The RETURN key
  81.          4.2.1  The "Auto-Indent" mode
  82.     4.3  The BACKSPACE key
  83.          4.3.1  The "Auto-BackSpace" mode
  84.     4.4  The DEL key
  85.     4.5  The TAB key
  86.     4.6  The control-key filter and defeat feature (Function key F2)
  87.     4.7  The HELP key
  88.  
  89. 5.  SELECTING A RANGE OF TEXT
  90.     5.1  Using the mouse to select a range of characters
  91.     5.2  Selecting text by double and triple clicking
  92.     5.3  Operations on selected ranges
  93.     5.4  Selecting more than the visible screen
  94.     5.5  Extending a select range by SHIFT-clicking
  95.  
  96. 6.  VIEWING PAGES
  97.     6.1  The vertical scroll arrow gadgets
  98.     6.2  The vertical scroll thumb gadget
  99.     6.3  Scrolling the page with the keyboard arrow keys
  100.     6.4  Keys that PAGE-up or PAGE-down
  101.     6.5  The horizontal scroll gadget
  102.  
  103. 7.  TEXTRA WINDOWS
  104.     7.1  Limitations
  105.     7.2  The title bar
  106.     7.3  The close gadget
  107.     7.4  The sizing gadget
  108.     7.5  The Window-Size-Toggle feature (Function key F1)
  109.     7.6  The 'Previous Window' feature (Function key F6)
  110.     7.7  The Window's font
  111.  
  112. 8.  THE TEXTRA AREXX INTERFACE  ("TREXXTRA" -- hoo boy!)
  113.     8.1  General AREXX Information
  114.     8.2  Executing TEXTRA/AREXX Scripts or Commands
  115.     8.3  Running scripts in the background
  116.     8.4  Writing Your Own TEXTRA/AREXX scripts
  117.  
  118. 9.  TEXTRA MENUS
  119.     9.1  Accessing the menus
  120.     9.2  The "Project" menu
  121.          9.2.1  Open A File...
  122.          9.2.2  Open By Name...
  123.          9.2.3  New File
  124.          9.2.4  Insert File...
  125.          9.2.5  Revert To Saved
  126.          9.2.6  Save File
  127.          9.2.7  Save File As...
  128.          9.2.8  Save All Files
  129.          9.2.9  Close File
  130.          9.2.10  Print File
  131.          9.2.11  Print Selected Lines
  132.          9.2.12 Printing Preferences...
  133.          9.2.13 About TEXTRA...
  134.          9.2.14 Quit
  135.     9.3  The "Windows" menu
  136.          9.3.1  Dynamically-changing items
  137.          9.3.2  Additional information
  138.     9.4  The "Edit" menu
  139.          9.4.1  Undo
  140.          9.4.2  Cut
  141.          9.4.3  Copy
  142.          9.4.4  Paste
  143.          9.4.5  Find
  144.                 9.4.5.1  String...
  145.                          9.4.5.1.1 Wrap-around search option
  146.                 9.4.5.2  Next Occurence
  147.          9.4.6  Replace
  148.                 9.4.6.1  String...
  149.                 9.4.6.2  Next Occurence
  150.                 9.4.6.3  Then Find
  151.          9.4.7  Case
  152.                 9.4.7.1  lower
  153.                 9.4.7.2  UPPER
  154.                 9.4.7.3  Capitalize
  155.          9.4.8  Go to Line...
  156.          9.4.9  Editing Preferences...
  157.     9.5  The "Utilities" menu
  158.          9.5.1  File Protections...
  159.          9.5.2  Help on Keyboard...
  160.          9.5.3  ARexx...
  161.          9.5.4  Set Window Font...
  162.          9.5.5  Font Preferences...
  163.          
  164. 10.  TEXTRA GENERAL INFORMATION
  165.     10.1  TEXTRA's use of Path and File names
  166.     10.2  TEXTRA String Gadget Shortcuts
  167.     10.3  TEXTRA String Gadgets and the RETURN key
  168.     10.4  TEXTRA Requesters
  169.     10.5  TEXTRA Preferences File
  170.     10.6  TEXTRA behavior when reading in files
  171.          10.6.1  Converting CR,LF sequences to Amiga End-Of-Lines.
  172.          10.6.2  Checks file type when reading in a file.
  173.     10.7  TEXTRA behavior when writing files to disk
  174.          10.7.1  Stripping extra Blank Lines.
  175.     10.8  Operation under Workbench 2.0+ vs. earlier
  176.     10.9  TEXTRA Keyboard Summary
  177.  
  178. ---------------------------------------------------------------------------
  179.  
  180.  
  181. 1. INSTALLING TEXTRA
  182.  
  183. 1.1 TEXTRA may be run without any installation at all.  The 
  184. installation procedure simply copies the program and a set of support 
  185. files (none required) to your hard disk.
  186.  
  187. 1.1.1 The program and icon file are supplied at the root of the 
  188. installation package.  They may be used to view any and all 
  189. documentation.  All supplied text files default tool fields point to 
  190. this TEXTRA.
  191.  
  192. 1.1.2 The TEXTRA package includes a variety of macro files, executable 
  193. under its powerful ARexx interface.  General page/paragraph-formatting 
  194. macros, useful utilities, and scripts that allow TEXTRA to act as an 
  195. integrated editing environment for JForth Professional and HSPascal 
  196. are provided.
  197.  
  198. 1.1.3 The accompanying documentation, of which this is a part of, is 
  199. detailed and complete.  It includes separate files covering Textra as 
  200. editing environment, its ARexx interface and command set, detailed 
  201. version history, and list of known gotchas (almost empty!).
  202.  
  203. 1.2 The package provides an installation program with icon that will 
  204. prompt the user through the installation process.  When the installer 
  205. prompts for a destination location for anything, it will create the 
  206. specified directory, if it doesn't already exist.
  207.  
  208. 1.2.1 The user is asked for the location for the program and icon.
  209.  
  210. 1.2.2 If ARexx is running on the system, it will automatically copy 
  211. the ARexx scripts in the REXX: directory, if assigned.  (If REXX: is 
  212. not assigned, the user is prompted to specify their location.)
  213.   If Arexx does not seem to be running at all on the system, then the 
  214. user is give the option of installing the scripts.
  215.  
  216. 1.2.3 The user is asked if he/she wishes the Documentation files to be 
  217. copied, and prompted for a location if so.
  218.  
  219. 1.2.4 Finally, all choices are listed, ending with a prompt to either 
  220. continue, retry or exit the installer.  
  221.  
  222. 1.3 If desired, the package can be installed from CLI with the
  223. following commands (assuming the Textra package is on a floppy in df0:)...
  224.  
  225.    copy df0:Textra#? "<wherever-you-want-program+icon>"
  226.    
  227. If you want the docs...
  228.  
  229.    copy df0:docs/#? "<wherever-you-want-the-docs>"
  230.  
  231. If you want the ARexx macro files...
  232.  
  233.    copy df0:scripts/#?.textra rexx:
  234.  
  235. If you want the JForth-oriented ARexx macros...
  236.  
  237.    copy df0:scripts/JForth_Scripts/#?.textra rexx:
  238.  
  239. If you want the C-oriented ARexx macros...
  240.  
  241.    copy df0:scripts/C_Scripts/#?.textra rexx:
  242.  
  243. If you want the HSPascal-oriented ARexx macros...
  244.  
  245.    copy df0:scripts/HSPascal_Scripts/#?.textra rexx:
  246.  
  247.  
  248. ---------------------------------------------------------------------------
  249.  
  250.  
  251. 2. INVOKING TEXTRA
  252.  
  253. 2.1 TEXTRA may be launched in all of the various ways the Amiga
  254. permits.
  255.  
  256. 2.2 TEXTRA may double-clicked from Workbench (probably the most
  257. common means of starting it).  Workbench Extended-Selection mode
  258. is implemented to provide opening a specific set of document icons.
  259. For information about this mode, refer to your Workbench manual.
  260.  
  261. 2.3 "TEXTRA" may be typed into the CLI or SHELL, with as many
  262. optional filenames as the AmigaDOS command line will allow.
  263. For example...
  264.  
  265.     1> RUN TEXTRA <filename1> <filename2> ... <filenameX>
  266.  
  267. 2.4 A "Project" icon that has TEXTRA specified in its "Default Tool"
  268. field will invoke TEXTRA, when double-clicked, and be opened in its
  269. own window.
  270.  
  271. 2.5 TEXTRA will not launch twice.  If a TEXTRA B is launched and finds
  272. TEXTRA A already running, B will send to A the names of the files that
  273. B was passed via the mechanisms described above in sections 2.2, 2.3
  274. or 2.4.  TEXTRA B will the exit.  This feature allows users to "get
  275. that file open" in the absolute most convienient method possible.  (Note
  276. that enough memory must be available for TEXTRA B and TEXTRA A to
  277. momentarily reside in the machine.)
  278.  
  279. ---------------------------------------------------------------------------
  280.  
  281.  
  282. 3. THE TEXTRA CURSOR
  283.  
  284. 3.1 The current cursor location (where text will be inserted) is
  285. represented by a thin line, of a different color than either text
  286. or background.  The cursor marks the place where newly-typed
  287. characters will be inserted (characters following will 'shift right').
  288.  
  289. 3.2 The cursor may be positioned by simply single-clicking the LEFT MOUSE
  290. BUTTON on the text where you want thecursor to be.
  291.  
  292. 3.3 The cursor may also be moved with the "arrow" keys on the keyboard.
  293. A SHIFT-left-arrow or SHIFT-right-arrow will move the cursor to the
  294. beginning or end of the current line, respectively.
  295.  
  296. 3.4 If the cursor or select range is not on the visible part of the
  297. screen, it can be located and displayed via the F3 key.
  298.  
  299. ---------------------------------------------------------------------------
  300.  
  301.  
  302. 4. ENTERING TEXT INTO THE DOCUMENT
  303.  
  304. 4.1 As keys are typed at the keyboard, they are entered in the file
  305. at the current cursor location, and the cursor is advanced by one.
  306.  
  307. 4.2 The RETURN key inserts a new line, and moves the cursor there.
  308.  
  309. 4.2.1 If the Auto-Indent mode is enabled (see section 9.4.9), the
  310. cursor will align with the line above when the RETURN key is pressed.
  311.  
  312. 4.3 The BACKSPACE deletes the character to the immediate left of the
  313. cursor and backs the cursor up one column.  If the cursor is at the
  314. leftmost column, the line is joined with the previous one.
  315.  
  316. 4.3.1 When the cursor rests on the 1st non-blank character of a line, 
  317. the Auto-BackSpace mode (section 9.4.9) comes into play, if enabled.  
  318. The BACKSPACE key will"back-up" the line text by whatever it takes to 
  319. line up with the beginning of the text on the line above.  If the 
  320. previous line does not start to the left of the cursor position, the 
  321. alignment is made to the next line above that does.
  322.  
  323. 4.4 The DELETE key removes the character to the immediate right of the
  324. cursor.  If the cursor is at the end of a line, the next line is joined with
  325. the cursor line.
  326.  
  327. 4.5 The TAB key advances the cursor to the next column that is an
  328. even multiple of the TAB width value (section 9.4.9).
  329.  
  330. 4.6 Normally, TEXTRA will not allow control characters into the
  331. window, permitting only visible or white-space characters.  This
  332. feature can be temporarily defeated, for 1 character, by pressing F2.
  333. Following F2, the next character will be accepted into the window
  334. unfiltered.
  335.  
  336. 4.7 The HELP key will display an informational requestor, displaying
  337. information about the keyboard-activated functions.
  338.  
  339. ---------------------------------------------------------------------------
  340.  
  341.  
  342. 5. SELECTING A RANGE OF TEXT
  343.  
  344. 5.1 It is possible to mark a series of characters for the next
  345. operation by "dragging" with the mouse.  Just press and hold the
  346. left mouse button, then drag to the desired selection end-point.
  347.  
  348. 5.2 A series of characters will become selected when the
  349. LEFT MOUSE BUTTON is double-clicked while the mouse cursor is
  350. positioned over them.  Based on the setting of the EDITING PREFERENCES
  351. (section xx), the series will consist of either contiguous 
  352. non-white-space or aplha-numeric characters.  If the LEFT MOUSE BUTTON
  353. is triple-clicked, that entire line will become selected.
  354.  
  355. 5.3 When a range of text is selected, a subsequent operation will
  356. affect the entire selected area.  For example, if a key is typed while
  357. a range is selected, the range will be cut from the file, replaced by
  358. that key.  Other examples are the BACKSPACE and DEL keys, which both
  359. act to simply delete any selected area.  Certain items under the EDIT
  360. menu, described later, also operate on any current range.
  361.  
  362. 5.4 If, while selecting text, the mouse is moved near the bottom or top
  363. of the window, available text in the appropriate direction will scroll
  364. into view, becoming selected in the process.  Therefore, a select range
  365. can extend past the visible limits of the window.
  366.  
  367. 5.5 A select range may be established or size changed by holding
  368. down the SHIFT key when clicking in the window.  If the click occurs
  369. outside the current select range, the range is extended to there.
  370. If inside, the end-point of the select range is adjusted to the
  371. click-point.
  372.  
  373. ---------------------------------------------------------------------------
  374.  
  375.  
  376. 6. VIEWING PAGES
  377.  
  378. 6.1 The easiest method for moving through the file is to use the vertical
  379. scroll bar on the right side of the window.  Clicks of the left
  380. mouse button on the arrows at either end move the document vertically
  381. in continuous scroll fashion.
  382.  
  383. 6.2 The "thumb" in the middle of the scroll bar not only indicates the
  384. visible-page-area relative to the total-file-size (by it's height),
  385. but also the position within the file (by its vertical positioning).
  386. It can also be "selected" with the left mouse button and moved as
  387. a "coarse adjust".  The area immediately above and below the "thumb"
  388. may be clicked with the left button as a "page-scroll" mechanism.
  389.  
  390. 6.3 Another method by which text may be scrolled into view is by moving
  391. the cursor...attempts to move the cursor "off the window"
  392. will cause text in that direction to scroll.
  393.  
  394. 6.4 Function keys F4 and F5 will PAGE the display down and up,
  395. respectively.  The Shift-UP/DOWN-arrow-key combinations will also PAGE
  396. the display in the appropriate direction AND position the cursor
  397. to the middle of the new page.
  398.  
  399. 6.5 The horizontal scroll gadget works similarly to the vertical
  400. scroll gadget.  It becomes functional when a line is being displayed
  401. that exceeds the current width of the window.  When typing, the display
  402. will auto-scroll to center the cursor when it reaches a window edge.
  403.  
  404. ---------------------------------------------------------------------------
  405.  
  406.  
  407. 7. TEXTRA WINDOWS
  408.  
  409. 7.1 TEXTRA allows any number of windows, limited by the amount of 
  410. memory in your computer (most limiting is possibly the amount of 
  411. available CHIP ram, at least in early amigas).  Textra lines can be up 
  412. to 255 characters long, number of lines limited by your total 
  413. available memory (entire file is kept in ram, FAST is grabbed first).
  414.  
  415. 7.2 The title of each TEXTRA window is set to the full-pathname
  416. of the file that was read in (or created).  This is also the name
  417. of the file that will be written during a SAVE operation (unless
  418. the "SAVE AS..." menu option is chosen, section 9.2.7).  If the
  419. file has been modified since last saved, the filename will be
  420. preceeded by a '*'.
  421.  
  422. 7.3 Each window includes a standard Intuition close gadget, which
  423. performs the same action as the "CLOSE FILE" menu option.  See the
  424. discussion on "CLOSE FILE" (section 9.2.9) for more information.
  425.  
  426. 7.4 The "sizing" gadget in the lower-right hand corner of each window
  427. may be used to adjust the dimensions of that window, up to the
  428. full-screen limitations of the Workbench.
  429.  
  430. 7.5 Function key F1 may be used as a "window-size-toggle" between
  431. default size (when F1 was first hit) and that size specified in the
  432. "Edit Preferences..." requester (9.4.9).  This preference setting
  433. defaults to full-screen.
  434.  
  435. 7.6 Function key F6 will re-select the previously-selected window.
  436. This a handy "toggle between 2 windows" mode, facilitating convienient
  437. evolutions such as successive Cut, Copy & Paste sequences (sections 9.2.2,
  438. 9.2.3 and 9.2.5).
  439.  
  440. 7.7 If the asl.library is available (usually means WB2.0 or later), 
  441. the font in which a window is initially rendered is configurable via 
  442. the "Font Preferences..." requester (9.5.5).  A windows font may be 
  443. changed at any time via the "Set WIndow Font..." asl requester 
  444. (9.5.4).
  445.  
  446. ---------------------------------------------------------------------------
  447.  
  448.  
  449. 8. THE TEXTRA-AREXX INTERFACE
  450.  
  451. 8.1 When TEXTRA starts up, it opens a message port called "TEXTRA".  
  452. This port listens for AREXX messages from other programs, and allows 
  453. you to control the editor both from other applications or from AREXX 
  454. "scripts", many of which are supplied with TEXTRA (they should be 
  455. copied to your 'rexx:' directory).  These scripts may contain a 
  456. mixture of AREXX and TEXTRA commands; they allow access to many 
  457. internal TEXTRA editing functions which may be performed on the 
  458. 'current' window.
  459.  
  460. 8.2 TEXTRA/AREXX scripts or commands may be executed via the "AREXX..."
  461. menu item (section 9.5.3).
  462.   That will present present the ARexx requester which contains
  463. four string gadgets, each with an accompanying button describing the
  464. function key to execute the gadgets contents without having to
  465. bring up the requester.
  466.   The string gadgets will assume default strings when initially
  467. installed.  The contents may be changed and either executed and saved,
  468. just executed or just saved.  The CANCEL button allows the requester
  469. to be closed and reverted to it's original state upon opening.
  470.   Into any string gadget, you can enter the name of a Textra-ARexx 
  471. script that exists in the rexx: directory (followed
  472. by any required arguments), as in...
  473.  
  474.         slide 8
  475.  
  476.    Optionally, you can directly enter ARexx and Textra commandsinto
  477. the string gadgets, but they should be preceeded with an '@' char-
  478. acter.  Examples...
  479.  
  480.         @notify "Hello world!"
  481.         @prefs autoindent on
  482.         @options results; get file name; notify result
  483.  
  484. 8.3 Normally, while a script is executing, another window may be made 
  485. frontmost and edited.  (It should be noted that some system global 
  486. resources, such as the cut, copy & paste buffer, are shared between 
  487. the script and the edited window.  While none of the supplied
  488. scripts use the CUT, COPY or PASTE commands, it is worth keeping in
  489. mind if you write your own.)
  490.  
  491. 8.4 Please refer to the accompanying file "RexxCommand.doc" for a
  492. description of the TEXTRA/AREXX command set as well as general
  493. information about writing your own scripts.
  494.  
  495. 8.5 Using section 8.2 as a guide, execute the "Tutorial" ARexx script
  496. for an interactive 'training session' for beginners.  In one of the
  497. ARexx requester string gadgets, simply enter:
  498.  
  499.         tutorial
  500.  
  501. ---------------------------------------------------------------------------
  502.  
  503.  
  504. 9. TEXTRA MENUS
  505.  
  506. 9.1 Four menus are available and present themselves when the RIGHT
  507. MENU BUTTON is depressed and held.  Some menu items may also
  508. be activated by simultaneously pressing the RIGHT AMIGA key
  509. and the one that is specified in the menu item text.  When the HELP
  510. key is pressed (section 4.7), a list of such menu "key equivalents" 
  511. presents itself.
  512.  
  513. 9.2 The "Project" Menu
  514.  
  515. 9.2.1 OPEN FILE... opens a new window with a full file-selector
  516. requester and buttons that allow quick access to the top 8 disk
  517. devices (like DF0:).  The PARENT button changes the current directory
  518. to the level above the one being displayed.  The KEYBOARD button
  519. presents the user with a string requester into which a file or
  520. directory specification may be typed.  The CANCEL button exits the
  521. requester with no other action while the OK button enters the file
  522. or directory selected in the list box (the same as CANCEL if nothing
  523. is selected).  Double-clicking one of the names performs the same
  524. action as the OK button.
  525.  
  526. 9.2.2 OPEN BY NAME... opens a new window, then presents a string
  527. requester for specifying the filename from the keyboard, bypassing
  528. the directory scan for the list of names (which can take time on
  529. large directories, especially on floppy drives).  The current 
  530. directory of the requester is that of the spawning window.  If a 
  531. pathname is typed into this requester, the "OPEN FILE" selector 
  532. requester is opened, presenting a list of the files in that directory.
  533.  
  534. 9.2.3 OPEN NEW FILE opens a window without specifying a filename; the
  535. default name "Untitled" is assigned, at the directory level of
  536. the spawning window.  (No actual disk file will be written until
  537. the SAVE AS... function is invoked.)
  538.  
  539. 9.2.4 INSERT FILE... presents the TEXTRA file-requester allowing
  540. selection of a file to INSERT at the current cursor location (as
  541. though the entire file were typed in).  Any select range will be
  542. deleted prior to the insertion.
  543.  
  544. 9.2.5 REVERT TO SAVED causes the read-in version of the selected
  545. file to be discarded, replaced by the version that was last-saved
  546. to disk.  A verification requester is presented to make sure this
  547. is not done accidently.
  548.  
  549. 9.2.6 SAVE FILE causes the currently-selected file to be written to
  550. disk, if modified.  If the file has not been changed (no '*' before
  551. the title), this menu item is disabled.
  552.  
  553. 9.2.7 SAVE FILE AS... allows saving the currently selected file under 
  554. a different name.  After this operation, the title bar will contain 
  555. the new name, and it will have been created on disk.  If the specified 
  556. file already exists, the user is warned and given a chance to abort.  
  557. If a directory name is entered (or no name at all), the SAVE AS... 
  558. file requester is presented.  This requester is very similar in 
  559. operation to the "OPEN FILE..." requester; all buttons work the same, 
  560. except the OK button will overwrite the selected file (as does 
  561. double-clicking a filename).
  562.  
  563. 9.2.8 SAVE ALL FILES causes all files that have been modified and not
  564. saved to be written to disk.  If there are no modified files, this
  565. menu item is disabled.
  566.  
  567. 9.2.9 CLOSE FILE will check if the file has been modified but not
  568. saved and warn the user if so.  Note that closing TEXTRA's last window
  569. will cause it to exit; a requester will notify you if you are closing
  570. the last window and give you the chance to abort.  After the window
  571. has closed, TEXTRA will select and front another TEXTRA window if any
  572. remain.
  573.  
  574. 9.2.10 PRINT FILE prints (to the printer.device) the currently selected
  575. window using the current preference settings (section 9.2.12).  While
  576. a print job is in progress, other windows may be edited or have ARexx
  577. scripts executed in them, but not printed.  Print jobs may be cancelled
  578. at any time by using the CANCEL button on the "Printing in progress..."
  579. requester.  (Any delay experienced is the amount of time it takes your
  580. printer to respond to the RESET command).  If the window to be printed
  581. is the only one open, TEXTRA will ask if you want to open another.
  582.  
  583. 9.2.11 PRINT SELECTED LINES prints any and all lines, in their 
  584. entirity, if any part of it is currently selected.  The current 
  585. preference settings (section 9.2.12) are observed.  The same 'print 
  586. job' behavior described in section 9.2.10 applies.
  587.  
  588. 9.2.12 PRINTING PREFERENCES... presents a dialog to allow the user to
  589. enable/disable the following print job behavior...
  590.  
  591.   1). Print a one-line page header at the top of each page noting the 
  592.       date, filename and page number.
  593.   2). Print sequential line numbers at the beginning of each line.
  594.   3). Skip over perforated page boundries of fanfold paper.
  595.   4). Eject the page (form-feed) after printing an entire file (9.2.10)
  596.   5). Eject the page (form-feed) after printing selected lines (9.2.11)
  597.  
  598. Note that TEXTRA also observes the system 'Preferences' settings for 
  599. left & right margin, characters-per-line, and lines-per-page (use your 
  600. system 'Preferences' tool to set these).  The USE button causes the 
  601. currently displayed settings to go into effect.  The USE+SAVE button 
  602. does the USE function, and also saves the current settings in the 
  603. Textra Preferences file (section 10.5).  The CANCEL button causes any 
  604. currently displayed settings that have been changed to be discarded.  
  605. If the PRINT PREFERENCES requester is active, this menu item is 
  606. disabled from other windows.
  607.  
  608. 9.2.13 ABOUT TEXTRA provides the author's address and describes
  609. distribution information.  Also, if the TEXTRA is registered, the name
  610. and address of the honest person who has earned my thanks and respect
  611. is displayed in this requester.
  612.  
  613. 9.2.14 QUIT will exit TEXTRA, closing all files in the process.  All
  614. files that have been modified but not saved will issue a notification
  615. requester, providing the opportunity to save at that time.
  616.  
  617. 9.3 The "Windows" Menu
  618.  
  619. 9.3.1 One item exists in the "WINDOWS" menu for each open file, the
  620. menu item text being the same as the title bar for the associated
  621. window.  Selecting an item makes it the current window, if not
  622. already.
  623.  
  624. 9.3.2 Additionally, the text includes the "*" character before the
  625. filename if the file has been modified since last written to disk.
  626. A checkmark preceeds the item representing the current file.
  627.  
  628. 9.4 The "Edit" Menu
  629.  
  630. 9.4.1 UNDO reverts all changes since the last time the cursor was
  631. positioned by clicking the mouse or by using the cursor arrow keys.
  632.  
  633. 9.4.2 CUT removes the selected range of characters from the 
  634. currently-selected file, but saves them in the TEXTRA clip area
  635. (TEXTRA does not interface with the standard Amiga Clipboard
  636. Device...future versions may do so).  The previous contents of
  637. the TEXTRA clip area are lost.  If there is no select range,
  638. this menu item is disabled.
  639.  
  640. 9.4.3 COPY moves the selected range of characters of the 
  641. currently-selected file to the TEXTRA clip area, but does not
  642. remove them from the file.  The previous contents of the TEXTRA
  643. clip area are lost.  If there is no select range, this menu
  644. item is disabled.
  645.  
  646. 9.4.4 PASTE inserts whatever is in the TEXTRA clip area into the
  647. currently-selected file, at the current cursor location.  If a select
  648. range is active in this file, it is deleted before the insertion takes
  649. place.  There is no effect on the contents of the TEXTRA clip area.
  650. It nothing has been placed into the TEXTRA clip area (via CUT or COPY),
  651. this menu item is disabled.
  652.  
  653. 9.4.5 FIND presents a sub-menu with 2 choices:
  654.  
  655. 9.4.5.1 STRING... presents a requester prompting for the string
  656. to search for, ignoring character case.  The string gadget will, as
  657. a default, contain the previous string searched for (empty if none).
  658. However, if a range of characters is selected that is ALL ON ONE
  659. LINE, it will supercede any previously-searched-for string as the
  660. default for the string gadget.  The search begins just past the
  661. current cursor location or selected range of characters.
  662.  
  663. 9.4.5.1.1 WRAP... On the FIND STRING requester is a checkbox that
  664. allows you to enable "wrap-around" search.  Normally, if the search
  665. string is not found, TEXTRA terminates the search at the end of the
  666. document.  With the "wrap" box checked, the search will continue from
  667. line 1, and end when either the text is found, or the starting line
  668. is reached.  This mode also applies to the "FIND NEXT OCCURENCE" menu
  669. item (section 9.4.5.2).
  670.  
  671. 9.4.5.2 NEXT OCCURENCE conducts another case-insensitive search for 
  672. the same text string that had previously been searched for.  If no 
  673. search had yet been conducted the "STRING..." requester is presented.
  674.  
  675. 9.4.6 REPLACE presents a sub-menu with 2 choices:
  676.  
  677. 9.4.6.1 STRING... presents a double-string-requester, prompting for
  678. both the string to conduct a case-insensitive search for and a
  679. string to replace the it with.  The RETURN key will
  680. toggle the selected string gadget.  The user may optionally:
  681.  
  682.   1). replace all instances of the found string (with the "ALL" 
  683.       button)
  684.  
  685.   2). replace just the next one found (via the "ONCE" button)
  686.  
  687.   3). abort (via "CANCEL").
  688.  
  689. The search begins just past the current cursor location
  690. or selected range of characters.
  691.  
  692. 9.4.6.2 NEXT OCCURENCE conducts another "REPLACE" operation, using the
  693. same strings that were used last time.  If none exist, the "STRING..."
  694. requester is presented.
  695.  
  696. 9.4.6.3 THEN FIND allows the user to decide which instances of
  697. the specific text will be REPLACEd, and which will not.  This feature
  698. is usually used thusly:
  699.  
  700.   1). Bring up the REPLACE STRING Requester (via menu or 
  701.       Right-Amiga-R).
  702.   
  703.   2). Enter the appropriate strings in the 2 string gadgets.
  704.   
  705.   3). Click on the SEARCH button.  The first instance of the "Search 
  706.       for:" text will be located and highlighted (text must occur 
  707.       AFTER the cursor in the file, so if you want the entire file 
  708.       checked, put the cursor at the beginning of the document).
  709.   
  710.   4). If you want to REPLACE the highlighted text, press 
  711.       Right-Amiga-Y.  If not, Right-Amiga-N.  (like Yes and No)
  712.   
  713.   5). The editor will respond accordingly and locate the next instance 
  714.       of the text.
  715.  
  716. 9.4.7 CASE presents a sub-menu with 3 choices:
  717.  
  718. 9.4.7.1 LOWER exhibits 2 behaviors depending on whether an area
  719. is selected or not.  If there is, the entire selected area is converted
  720. to lower case.  If not, the next word after the cursor is searched for
  721. and converted to lower case if found. 
  722.  
  723. 9.4.7.2 UPPER exhibits 2 behaviors depending on whether an area
  724. is selected or not.  If there is, the entire selected area is converted
  725. to upper case.  If not, the next word after the cursor is searched for
  726. and converted to upper case if found. 
  727.  
  728. 9.4.7.3 CAPITALIZE exhibits 2 behaviors depending on whether an area
  729. is selected or not.  If there is, each word in the selected area is
  730. located and capitalized.  If not, the next word after the cursor is
  731. located and capitalized. 
  732.  
  733. 9.4.8 GO TO LINE... presents a string requester prompting for the
  734. desired line number, with the initial string gadget contents being
  735. equal to the current cursor line (or the beginning of any selected
  736. range).  First line of file is considered line 1.
  737.  
  738. 9.4.9 EDITING PREFERENCES... presents a requester allowing configuration
  739. of:
  740.  
  741.   1). "Auto-Indent" mode (section 4.2.1)
  742.   
  743.   2). "Auto-BackSpace" mode (section 4.3.1)
  744.   
  745.   3). TAB WIDTH value (section 4.5)
  746.   
  747.   4). "Convert CR,LF to LF on OPEN" mode (section 10.6)
  748.   
  749.   5). "Strip Extra Blank Lines on SAVE" mode (section 10.7.1)
  750.   
  751.   6). AlphaNumeric OR Non-Whitespace double-click highlighting
  752.       (section 5.2)
  753.  
  754.   7). Operation of the F1 Window Size Toggle function key.
  755.       (section xx).
  756.  
  757.    The USE button causes the currently displayed settings to go into effect.
  758. The USE+SAVE button performs the USE function, and also saves the current
  759. settings in the Textra Preferences file (section 10.5).  The CANCEL button
  760. causes any currently displayed settings (that have been changed), to be
  761. discarded.  If the EDITING PREFERENCES requester is active, this menu item
  762. is disabled from other windows.  (Right-Amiga-E is a keyboard equivalent
  763. for this menu item.)
  764.  
  765. 9.5  The "Utilities" Menu
  766.  
  767. 9.5.1  FILE PROTECTIONS... provides the ability to set the 6 relevant
  768. file protection bits that are stored and processed by AmigaDOS.  These
  769. include Deletable, Executable, Writable, Readable, Archived and Script
  770. (particularly handy when writing AmigaDOS scripts).  The SAVE button
  771. causes the currently displayed settings to become active.  The CANCEL
  772. button is self-explanatory.
  773.  
  774. 9.5.2  HELP ON KEYBOARD... performs the same action as the HELP key
  775. (section 4.7).
  776.  
  777. 9.5.3  AREXX... presents a requester with 4 string gadgets.  Each
  778. will accept either the name of an available TEXTRA-AREXX script such as:
  779.  
  780.     slide 4
  781.  
  782. or a TEXTRA/AREXX command line such as:
  783.  
  784.     @gotoxy 0 0;text "Hi, there!"
  785.  
  786. Note that if a command line is entered (as opposed to a script name),
  787. it must be preceeded by an '@' character.
  788.    Also present on the requester is a button beside each string
  789. gadget.  Clicking it has the same effect as selecting a string gadget and
  790. pressing RETURN...that is, to execute the contents of the string gadget.
  791. The button text describes the F-KEY that can be used to execute the
  792. string gadget contents, but only when the requester is NOT active.
  793.    Two additional buttons are presented, one to SAVE the current strings
  794. for later reloading when TEXTRA is launched.  The other button is to
  795. CANCEL the requester operation.  (The string gadget contents are saved
  796. in "S:TEXTRA.CMDS" which is only as large as the length of the 4 strings
  797. plus 4 EOL characters).
  798.    Note that the AREXX menu item is dimmed if AREXX is not available when
  799. TEXTRA is launched.
  800.    While an ARexx script is executing, the 'ARexx...' menu text changes
  801. to "Cancel ARexx Script".  This feature tries to tell the running script
  802. that the user wishes it to terminate, but will only have an effect if the
  803. running script uses the CHECKCANCEL Textra-ARexx command.
  804.    The supplied TEXTRA/AREXX scripts, as well as any you might otherwise
  805. aquire, should be copied to your REXX: directory and should end in
  806. ".textra".
  807.  
  808. 9.5.4  SET WINDOW FONT... allow the user to change or find the name of
  809. the currently selected window's font.  This function requires the asl.library.
  810. The selection is completely independant of the selected font used for
  811. Newly-Opened Windows (9.5.5).
  812.  
  813. 9.5.5  FONT PREFERENCES... presents those aspects of the font display facility
  814. which provide save-able configuration parameters.  This version (v1.13) only
  815. has one; the selection of which font will be used for all subsequent newly-
  816. opened windows.  The consistant USE, USE+SAVE, CANCEL interface of the other
  817. TEXTRA preferences dialog is preserved.
  818.  
  819.  
  820. ---------------------------------------------------------------------------
  821.  
  822.  
  823. 10. TEXTRA GENERAL INFORMATION
  824.  
  825. 10.1 TEXTRA always fully expands a specified file or directory name
  826. and uses that form to again find the file, if necessary.  For example,
  827. you may have typed in "DF1:MyFile" as the filename, but the window
  828. title will substitute the name of the volume, possibly "MyDisk:MyFile".
  829. This is almost always desirable, because if TEXTRA saved "DF1:", you
  830. might unknowingly save it to the wrong disk, just because you switched
  831. the disk in that drive.  TEXTRA will ask you specifically for the same
  832. name.
  833.    The only situation you should be aware of is WHEN YOU HAVE TWO
  834. DISKS OF THE SAME NAME in your system.  In this case, AmigaDOS can
  835. sometimes choose the wrong disk when TEXTRA passes the full-pathname
  836. to it.
  837.   In the above example, we could save it to the wrong disk if the disk
  838. in DF0: is also named "MyDisk:" (a backup, perhaps???).  This is not
  839. caused by TEXTRA, but can happen anytime in AmigaDOS that you use the
  840. full-pathname to specify a file.
  841.  
  842. 10.2 Intuition provides two String Gadget shortcuts that can be
  843. useful to the TEXTRA user.  TEXTRA string gadgets that provide
  844. a default text string when they appear will revert back to this
  845. string whenever "Right Amiga-Q" is pressed.  The "Right Amiga-X"
  846. combination will clear any displayed string.
  847.  
  848. 10.3 For most string gadgets, the RETURN key will perform the same
  849. action  as the "OK" button.  One exception is the
  850. "REPLACE" double-string requester, where the RETURN key toggles
  851. between the two string gadgets.
  852.  
  853. 10.4 TEXTRA Requesters are attached to (drawn in) the window that they
  854. have been spawned from.  The advantage is that multiple requesters
  855. are possible...you can select and work in another file even if
  856. the previous window is waiting for you to answer a question.  Every
  857. window can, in fact, have one or more open requesters.
  858.   Note that a TEXTRA window will automatically increase in size
  859. to accomodate a given requester, and will return to it's original
  860. position/size when the requester is closed.
  861.  
  862. 10.5 TEXTRA maintains certain user-settable parameters in the file
  863. "devs:Textra.prefs".  If your system disk is of the floppy variety,
  864. you may therefore be asked to insert this disk if you elect to save it.
  865. Normally, TEXTRA looks for this file only once, at startup.
  866.  
  867. 10.6 TEXTRA performs certain operations when reading in a file
  868. from disk...
  869.  
  870. 10.6.1 Whenever TEXTRA reads in a file (as a result of an OPEN or
  871. REVERT operation, for example), any CR,LF (Carraige Return, Line Feed)
  872. combinations will be automatically converted to the standard Amiga
  873. End-of-Line representation (Line Feed alone) IF the "Convert CR,LF to
  874. LF on OPEN" item is checked in the "Editing Preferences" (section 9.4.9).
  875.  
  876. 10.6.2 Whenever TEXTRA reads in a file, it examines the first 32 characters
  877. in an effort to evaluate the file's "text-ness".  If TEXTRA thinks
  878. it may not be a text file, it will give you the opportunity to abort and
  879. read in another file.
  880.  
  881. 10.7 TEXTRA performs certain operations when writing a file
  882. to disk...
  883.  
  884. 10.7.1 If the "Strip Extra Blank Lines on SAVE" option is checked
  885. in the EDITING PREFERENCES requester (section 9.4.9), TEXTRA will
  886. insure that the version on disk will not contain any blank lines at the
  887. end.  Note that if this feature is used, the SAVE (section 9.2.6) and
  888. SAVE AS... (section 9.2.7) operations will take a little longer.
  889.  
  890. 10.8  TEXTRA v1.11 changed it's gadget imagery to be like that in 
  891. Workbench 2.0.  While this color scheme still looks quite attractive 
  892. under the standard Workbench 1.3 and earlier colors, 1.3 users often 
  893. customized their palette in radically different ways.  For example, 
  894. instead of something of intermediate brightness for the background 
  895. color (color 0...WB 1.3 used pale blue), using black causes the 
  896. shaded-gadget imagery of 2.0 to appear very odd.  For this reason, 
  897. under Workbench 1.3 and earlier, TEXTRA v1.11 will render it's 
  898. requester and gadget imagery primarily in monochrome (colors 0 and 1).  
  899. Boolean gadgets (checkboxes) are also rendered differently.
  900.  
  901. 10.9 Keyboard Summary:
  902.  
  903.     F1 - Window Size Toggle (7.4)
  904.     F2 - Keyboard Filter Defeat (4.6)
  905.     F3 - Page to Cursor or Beginning of Select Range (3.4)
  906.     F4 - Display next page (6.4)
  907.     F5 - Display previous page (6.4)
  908.     F6 - Present previous file (7.6)
  909.     F7 - AREXX string (9.5.3)
  910.     F8 -   "      "      "
  911.     F9 -   "      "      "
  912.     F10-   "      "      "
  913.  
  914.     Help - Displays this information (Keyboard Summary)
  915.     
  916.     Shift-Left-arrow  - Cursor to beginning of current line (3.2)
  917.     Shift-Right-arrow - Cursor to end of current line (3.2)
  918.     Shift-Up-arrow    - Display previous page, cursor to middle (6.4)
  919.     Shift-Down-arrow  - Display next page, cursor to middle (6.4)
  920.  
  921.     Right-Amiga-O - Open existing file via file requester (9.2.1)
  922.     Right-Amiga-P - Open existing file by typing its name (9.2.2)
  923.     Right-Amiga-[ - Open a new file (9.2.3)
  924.     Right-Amiga-S - Save the current file (9.2.6)
  925.     Right-Amiga-X - Cut selected text, save in clip area (9.4.2)
  926.     Right-Amiga-C - Copy selected text into clip area (9.4.3)
  927.     Right-Amiga-V - Paste clip area into file (9.4.4)
  928.     Right-Amiga-F - Find string in any case (9.4.5.1)
  929.     Right-Amiga-N - Find the next occurance of same string (9.4.5.2)
  930.     Right-Amiga-R - Replace string with another (9.4.6.1)
  931.     Right-Amiga-T - Find & replace same string again (9.4.6.2)
  932.     Right-Amiga-L - Set text or next word to lower case (9.4.7.1)
  933.     Right-Amiga-U - Set text or next word to upper case (9.4.7.2)
  934.     Right-Amiga-K - Capitalize words or next word (9.4.7.3)
  935.     Right-Amiga-G - Go to a specific line (9.4.8)
  936.     Right-Amiga-E - Display the Editing Preferences requester (9.4.9)
  937.     
  938.     Requester control...
  939.     
  940.     Right-Amiga-X - Clear text in string requester (10.2)
  941.     Right-Amiga-Q - Restore original string requester text (10.2)
  942.