Frozen Fish 1: Amiga

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

/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d8xx / d815 / inspiredemo.lha / InspireDemo / Manual.Doc < prev next >

Wrap

Text File | 1993-02-15 | 26.1 KB | 684 lines

Inspire! Reference Manual JoshWorks Software Creation Date:1/30/93 Table of Contents 1. The Archive 1.1 Contents 1.2 Installation 1.3 Running Inspire! 2. Window Attributes 2.1 Display Area 2.2 Gadgets 2.3 Title Bar 2.4 Menus 3. Editing Text 3.1 The Cursor 3.2 Entering Text 3.3 Correcting Text 3.4 Block Selection 4. Project Menu 4.1 Open File... 4.2 Open New... 4.3 Save 4.4 Save As... 4.5 Clear 4.6 Print 4.7 About... 4.8 Quit 5. Window Menu 5.1 New 5.2 Activate Next 5.3 Activate Previous 5.4 Select... 6. Edit Menu 6.1 Cut 6.2 Copy 6.3 Paste 6.4 Erase 6.5 Tab Left 6.6 Tab Right 6.7 Open Clip... 6.8 Save Clip As... 6.9 Print Clip 6.10 Undo 6.11 Conv to UPPER 6.12 Conv to lower 6.13 Capitalize 6.14 Center 7. Search Menu 7.1 Find & Replace... 7.2 Find Next 7.3 Find Match Bracket 7.4 Jump to Line... 7.5 Set Bookmark 7.6 Retrieve Bookmark 8. Utility Menu 8.1 ARexx Macros... 8.2 Edit Config... 8.3 Procedures... 9. ARexx 9.1 ARexx Information 9.2 Running ARexx scripts 9.3 Writing ARexx scripts 9.4 Command Reference 10. Error Reference 1. The Archive 1.1 Contents The Demonstration version of Inspire! V1.2 comes in an LHA archive which includes the items directly following. The Demonstration version of Inspire! is freely distributable as long as the archive is kept intact in its original form. Inspire! Demonstration V1.2 Inspire!Demo: Demonstration version of Inspire! V1.2 Manual.Doc: Documentation to Inspire V1.2 Compile.rexx: ARexx script to compile a SAS C Program SCOpts.rexx: ARexx script to run SAS C SCOpts Program PrintRegisterForm: Utility to print out Register.form Register.doc: Information on why and how to register Register.form: Form to fill out in order to register The Registered version of Inspire! V1.2 comes on disk with the items which directly follow. The Registered version of Inspire! V1.2 is Copyright ©1993 by Josh Van Abrahams. All Rights Reserved. It may not be redistributed. Inspire! V1.2 Inspire!: Registered version of Inspire! V1.2 Manual.Doc: Documentation to Inspire V1.2 Compile.rexx: ARexx script to compile a SAS C Program SCOpts.rexx: ARexx script to run SAS C SCOpts Program Communication.form:Form to fill out to communicate with JoshWorks Disclamer: All programs and documentation are provided "AS IS" and without warranties as to operation. 1.2 Installation Demonstration Version If you are working with the demo version of the program, then it is already installed to where you un-LHAed it. You may move it to wherever you want to. Registered Version In order to install the registered version, open the icon to where you want it installed in the workbench, then move the disk icon into that window. A directory will be created with all of the on disk files. Inspire! is ready to run from that point. 1.3 Running Inspire! Inspire may be run in many ways. The simplest way is to double click on its icon in the Workbench. Inspire! may also be run from a Shell window. In order to do that, cd to the Inspire! directory and run Inspire! by typing Inspire! <file>. File is the name of an optional file which you want to load at the start. Inspire can also be run by a project icon which specifies its default tool as Inspire!. Please note that this will only run Inspire!, it does not load the text file which it was started from. This will be fixed in future versions. If you start Inspire!, and the program never shows up, then you 1) Do not have enough memory 2) Do not have the standard 2.0+ libraries Inspire! will run on any Amiga computer with at least 200k of free memory and a correct installation of AmigaDos V2.0+. 2. Window Attributes 2.1 Display Area The main area where text editing occurs in Inspire! is within the windows borders. When you start up Inspire! with nothing loaded, this area will be clear. A small square block will be in the upper left-hand corner, this is the cursor. Text files are always edited and displayed only in this area. 2.2 Gadgets Every Inspire! editing window has standard system gadgets, in addition to Inspire!'s own custom gadgets. To learn more about system gadgets, consult Commodore's manual 'Using The System Software.' Inspire!'s gadgets consist of one proportional bar gadget, one up arrow gadget, and one down arrow gadget. These are found in the right window border. The bar gadget can be dragged up and down when the text file is greater that one screen page long. This allows you to move to any area in the document quickly. If the bar is moved a long distance, the screen will automatically update to that exact position. If the bar is only moved small distances, then the display is smoothly scrolled to the given location. Clicking on the arrow gadgets move the text display one line at a time in the direction of the arrow. Note that the cursor is not affected by the movement of any of these gadgets. 2.3 Title Bar The first piece of information that the title bar displays is the name of the file. If the file is not yet named, then this area is blank. If the file has been edited since last saved, then an E, for Edited, will be displayed after the name of the file. On the right side of the title bar the current cursor position is displayed in the format X,Y, or Horizontal Position, Vertical Position. 2.4 Menus Inspire! has many different menus. They are described in depth in the chapters 4-8. Every menu item has an Amiga key short cut, by pressing Right Amiga and the letter given in the menu, that menu item's operation takes effect. It is recommended that you try to memorize these, they will help to increase your operating speed. 3. Editing Text 3.1 The Cursor The cursor is the place at which text is entered or deleted. The cursor may be moved in many ways. The primary way is by using the arrow keys. Each arrow keys corresponds to the direction in which the cursor will be moved if you press it. Keep in mind that the cursor must stay within the bounds of already existing text. The cursor can also be moved by clicking in the display area with the mouse. The cursor will then move to the mouse position. The arrow keys also have special operations that can be done when they are used in combination with other keys. The following list shows these operations. When doing these operations, press the special key first and hold it down, then press the arrow key. Alt Shift Up Arrow: Top Of Document Page Up Down Arrow: Bottom Of Document Page Down Left Arrow: Start of Line Word Left Right Arrow: End of Line Word Right 3.2 Entering Text Text is entered at the cursor position by pressing any key on the keyboard. All keys are valid unless they are assigned to another function. Whenever you enter text, the cursor is moved one place to the right. The tab key will enter a tab which will move the text to the next defined tab position as defined by the program configuration. To move down to the next line, press the return key. Anything to the right of the cursor when you press return will be brought down to the next line. 3.3 Correcting Text Text to the left may be removed by pressing the backspace key. If you backspace at the beginning of the line, then the line you are on will be moved to the end of the previous line. Text to the right may be removed by pressing the delete key. 3.4 Block Selection Areas of text may be selected by holding down on the mouse button in the display area and moving the mouse to a different area. This is called drag selecting; you are selecting blocks of text to do an operation on. One word of text can be selected by double clicking on the word. A line of text can be selected by triple clicking on the line. To deselect the block and get the cursor back, click once in the text area. These blocks of text are used in many menu functions. Also note that if a block of text is selected, and you begin typing, then the block will be deleted from the document. 4. Project Menu 4.1 Open File... Selecting Open File will bring up a standard ASL file requester which allows you to enter a name of a file to load. If the last file was not saved, then a warning requester will pop up allowing you to cancel before opening the requester. If you Ok the ASL file requester with a correct file name, then the file will load into your current editing window. 4.2 Open New... Open New works the same as open file, but a new window will open before the ASL file requester pops up. The selected file will be loaded into the new window. 4.3 Save Selecting Save will save the contents of the current editing window to the file name previously given. If the current editing window has no file name, then this menu item will function as a Save As. 4.4 Save As... Same as a standard save, but an ASL file requester pops up before the contents of the window are saved so that you may give the document a file name. 4.5 Clear Selecting Clear will totally clear the current editing window file from memory. A conformation requester will pop up to make sure this is what you want to do if the file has not been saved. Selecting Cancel in the requester will stop the clearing operation. 4.6 Print Selecting Print will print the contents of the current editing window. The printing information will be transferred to another process. That process will then carry out the printing. You may then continue to use Inspire! while the printing is carried out. 4.7 About... Selecting this menu item will bring up the About information window. This window contains copyright information if you are working with the registered version. If you are using the demo version, then this window will contain information about registering. The about window also contains additional information as follows: Number of Lines is the number of lines of text in the current window, Number of Bytes Used is the number of bytes used on disk if this file were saved, Available Chip Memory is the amount of chip memory available in your system, Available Fast Memory is the amount of fast memory available in your system, ARexx Port is the name of the current ARexx port. 4.8 Quit Selecting Quit will quit the program. All windows will be closed and all allocated resources will be freed. If any windows contain information that has not yet been saved, then warning requesters will appear making sure that you want to quit. 5. Window Menu 5.1 New Selecting New will open a new editing window which contains nothing in it. The new window will be added to the window list directly after the currently open window. 5.2 Activate Next Selecting Activate Next will activate the next window on the window list. If you are on the last window, then the first window will be made active. 5.3 Activate Previous Selecting Activate Previous will activate the window one before the current window on the window list. If you are on the first window in the list, then the last window will be made the current window. 5.4 Select... Selecting Select will pop up the window selection window. The window list will appear in a standard gadget. You may select a window to go instantly to by clicking on the file name that corresponds to that window. Unnamed windows will be given the name 'Untitled' in the list. You may cancel the operation by clicking on the close gadget of the window. 6. Edit Menu 6.1 Cut Selecting cut will delete the currently selected block and copy it to the Clipboard buffer. (Please note: true Amiga clipboards are not used. Other applications will not be effected by this or any other clip operation.) 6.2 Copy Selecting copy will copy the currently selected block into the Clipboard buffer. This function will not delete the currently selected block. 6.3 Paste Selecting paste will insert the text from the clipboard buffer at the current cursor position. 6.4 Erase Erase will delete the currently selected block of text. 6.5 Tab Left Tab left will move the currently selected block of text one tab unit to the left. If there are no tabs to delete at the left of a given line, then that line will not be effected. 6.6 Tab Right Tab Right will move the currently selected block of text one tab unit to the right. 6.7 Open Clip... This function operates much like opening a file, however the information is opened into the clipboard buffer. 6.8 Save Clip As... This function operates like save file as, however the information in the clipboard is saved, and not the current file. 6.9 Print Clip Print Clip will print the contents of the clipboard. Please note that this operation will not use another process to print from, you will not be able to continue editing while the clip prints. 6.10 Undo Selecting Undo will undo the edits made to a single line of text. This only works for single line edits. If no changes have been made to a given line, then selecting Undo will have no effect. 6.11 Conv to UPPER Conv to UPPER will convert the selected block of text to all upper case. If a character does not have an upper case version, then this operation will not effect that letter. 6.12 Conv to lower Conv to lower will convert the selected block of text to all lower case. If a character does not have an upper case version, then this operation will not effect that letter. 6.13 Capitalize Capitalize will capitalize the beginning of every word in the block. If a character does not have an upper case version, then this operation will not effect that letter. 6.14 Center Center will center a given block of text based upon the width of the current window. 7. Search Menu 7.1 Find & Replace... Find & Replace will bring up the Find & Replace window. In this window you will find a find string gadget, a replace string gadget, a case sensitivity cycle gadget, a find button, a replace button, and replace all button. When the window opens, the cursor will be placed in the find string gadget. Here you may enter a string of text that you want to search for. When finished, press the return key. Now the cursor will move to the replace string gadget. If you want to do a replace operation, then enter the text here. If you want to continue and just do the find, then press return from this gadget. If the text can not be found, then the screen will flash. If you are still in the window, then you have the options of clicking on the find gadget and searching for the text in the find string gadget, or you may press the replace gadget to have the computer find the text and instantly replace it with the replace text. Finally, you may press the replace all gadget. This gadget can be dangerous if you make a mistake. This gadget will find every occurrence of the find string and replace it with the replace string. Pressing the Case Sensitivity cycle gadget will change between a case sensitive search and a non case sensitive search. A Case sensitive search is slightly faster than a non case sensitive search. If you wish to cancel the find/replace before you start it, then press the close gadget of the window. 7.2 Find Next Selecting find next will find the next occurrence of the text entered in the find string gadget in the Find & Replace window. 7.3 Find Match Bracket Selecting Find Match Bracket will find the bracket (i.e. ],),} ) that matches the bracket that your cursor is on (i.e. [,(,{ ). Also, if you are on the end bracket and press this, then you will go back to the first bracket that matches it. If you are not on a valid bracket, or a matching bracket can not be found, then the screen will flash. 7.4 Jump to Line... Selecting Jump to Line will bring up the Jump window. The cursor will be placed in the Jump to Line integer gadget. From here, you may enter the line you wish to jump to. To do the operation, press return or click on the Jump button. If the number is invalid, then you will jump to the nearest valid line number. If you wish not to jump, then click on the close gadget of the window. 7.5 Set Bookmark Selecting Set Bookmark will bring up a submenu. From there you may select the number of the bookmark to set (1-5). A Bookmark records the position of the cursor, the view area of the text in the window, and the window number. 7.6 Retrieve Bookmark Selecting Retrieve Bookmark and the bookmark number will recall the cursor, view area, and window of the particular bookmark. If the book mark has not been set for that number, or the window which that bookmark pointed to is gone, then a Bookmark Invalid notice will pop up. If the exact cursor position no longer exists, then the closest possible position is used. 8. Utility Menu 8.1 Arexx Macros... Selecting this menu item will bring up the ARexx Macros window. You will then see ten string gadgets. In those you may enter the names of ARexx scripts that you want to have assigned to each particular function key. Each string gadget also has a file button that corresponds to it. Pressing one of these buttons will bring up an ASL file requester. You may then select a script that you want to have entered into the particular string gadget. If you are finished with your edits and you do not want to save them, then press the use button. If you wish to cancel your edits, then press the close gadget of the window. If you want to save your macro list under a specific name, then press the Save... button. An ASL requester will pop up that allows you to enter a file name. If you wish to open a macro list, then press the Open... button. Again, an ASL requester will pop up that will allow you to enter the name of the file to open. If you wish to save this list such that this list will be used every time at startup, then press the button Save As Default. This button will overwrite the startup macro file s:Inspire!ARexx.pth. 8.2 Edit Config... Selecting Edit Config will bring up the Configure window. This window sets many basic attributes that Inspire! uses. Screen Modes This gadget allows you to select what screen you want Inspire! to open upon at startup. The first selection is always Workbench, this starts Inspire! up on the standard Workbench screen. If you have monitor names bound to the system, then other selections will follow. Inspire! will allow you to select any named screen type available in a resolution of 640 horizontal or more and available in four colors. Select Font This gadget will pop up an ASL font requester which will allow you to select any fixed width font. Note that this font name will only have effect if Inspire! is placed on a custom screen other than the Workbench screen. If you wish to change the font for use on the Workbench screen, then you must change the default font in the System Preferences. Auto Indent This checkbox gadget allows you to toggle Auto Indent on and off. Auto Indenting means that when you press return the cursor will start at the position where text started on the last line. This is used for programming, outlines, or whenever you want text to start at an even position. Word Wrap This checkbox gadget allows you to toggle Word Wrapping on and off. Word wrapping will take the last word you are on when you reach a given width point and take it down to the next line. Turbo I/O Turbo I/O is a checkbox gadget which allows you to toggle between different styles of loading, saving and printing. It is by default on. When on, main file loading and saving will use a large speed up buffer to load and save very fast. When off, main file loading and saving is much slower, however it takes much less memory. If you get an out of memory error while turbo loading or saving, try toggling this off. Note that the non-turbo versions are not capable of translating CR+LF formats. Also, when turbo I/O is on, then main printing uses a second process to print from. This takes much more memory than non-turbo printing, however it is much more convenient. Turbo I/O only effects main file loading, it does not effect clip operations. Save CR+LF Amiga text files have one line feed (LF) at the end of every line. Other computers, for instance IBMs, use a carriage return (CR) and a line feed (LF) at the end of every line. This checkbox gadget allows you to toggle Saving in the CR+LF format on and off. Normally, you want this off. Tab This integer gadget allows you to specify that you want tabs to be set at every Xth column. Width This integer gadget allows you to set the point at which word wrapping occurs. This only takes effect if word wrapping is on. Use Clicking on this gadget will use the current settings you have entered into the window. The settings are not saved by this button. Open... Clicking on this gadget will open an ASL file requester so that you may enter the name of a config file to open. Save As... Clicking on this gadget will open an ASL file requester so that you may enter the name of the current configuration to save. Save As Default Clicking on this gadget will save the current settings to the default startup settings. This will write over the file s:Inspire!.cfg. 8.3 Procedures... Selecting this menu item will bring up the Select Procedure window. This window is used only for C programmers. It will list all C procedures that it finds in the current text. To select a procedure to jump to, click on its name. If you don't want to move to a procedure, then click the window close gadget. Inspire! decides if a line starts a new procedure by checking to make sure that the line starts with a letter and ends with a right parenthesis. This method can yield strange results if you are not currently working with a C file. 9. ARexx 9.1 ARexx Information ARexx is a programming language used for macros and between process communication. ARexx is included with v2.0+ of AmigaDos. Your system manual describes how ARexx works. Look in it for basic information. 9.2 Running ARexx scripts ARexx scripts are entered by name into the ARexx Macro window. They are ran from within Inspire! by pressing a corresponding function key. ARexx scripts should be either located in REXX: or in the current startup directory. In order for an ARexx script to work, RexxMast must be running, if RexxMast is not running and you try to start a macro, you will get requester notifying you of this. Inspire! comes with two macro files. Compile.rexx will invoke the SAS C compiler from within Inspire!, passing the current file name for compilation. Errors will then be displayed from within More, the standard amiga text viewer. SCOpts.rexx will invoke the SAS's scopts program to change compilation options for the current file. 9.3 Writing ARexx scripts ARexx scripts are regular text files, they may be entered from within Inspire! You may use the standard ARexx commands and also Inspire! specific commands as listed below. 9.4 Command Reference Please Note: The ARexx Command Set is not complete. This will be addressed in future versions of Inspire! QUERY CURSOR Returns the position of the cursor in the format X Y QUERY MARKEND Returns the end of the current block QUERY MARKSTART Returns the beginning of the current block QUERY FILENAME Returns the complete name of the current file QUERY PATHPART Returns the path part of the current file name QUERY FILEPART Returns the file part of the current file name QUERY CLIPNAME Returns the complete name of the clipboard file QUERY TAB Returns the distance between every tab QUERY LINESINFILE Returns the number of lines there are in a file QUERY LINESINCLIP Returns the number of lines there are in the clip SET CURSOR X Y Sets the position of the cursor when passed X Y SET MARKEND X Y Sets the position of the end of the block when passed X Y SET MARKSTART X Y Sets the position of the beginning of the block when passed X Y SET STATUSBAR title Displays a new title centered in the title bar SET DEFAULTSTATUSBAR Returns the Status bar to its normal appearance SET TAB N Sets the tab to every Nth column 10. Error Reference "Unable to Lock on File." This is a file error which means that something strange has happened to your file. You should not see this error. "Out of Memory." This error means that you do not have enough memory to do the operation that you requested. If you see this message, be careful. There is a much greater chance of crashing if you are running low on memory. "Unable to Examine File." This error means that the file resisted examination. "Unable to Open File." Inspire! was unable to open the file you selected for either opening or saving. This is most likely caused by an AmigaDos protection bit the prohibits the operation. "File Not Completely Read." For some reason, Inspire! was unable to completely read the file you selected. "File Not Completely Written." Inspire! was unable to completely write the file to disk. This is most likely caused by a disk that is full. "Unable to Open New Window." This means that there was not enough memory to open the window. "File Not Completely Printed." For some reason, Inspire! was unable to completely print the file. "Unable to Print File." Inspire! was unable to print the file. "Print Process Already Running." Inspire! can not print because the printer is still in use from another printing job that you requested. "File Not Found." Inspire! can not find the file that you entered into an ASL requester.