@database GED.HYPER @index INDEX @node MAIN @{b}©1996 Dietmar Eilert. All Rights Reserved.@{ub} Topics @{" Features " link FEATURES} @{" Command list " link COMMAND_LIST} @{" Licence " link LICENCE} @{" Variables " link QUERY} @{" Introduction " link INTRODUCTION} @{" Tools " link TOOLS} @{" Required system " link REQUIRED_SYSTEM} @{" Register GoldED " link REGISTER_GOLDED} @{" Getting started " link GETTING_STARTED} @{" Updates " link UPDATES} @{" Mouse configuration " link MOUSE_CONFIGURATION} @{" Upgrading to GoldED 4 " link UPGRADING_TO_GOLDED_4} @{" Menu " link MENU} @{" Credits " link CREDITS} @{" Keyboard " link KEYBOARD} @{" Address " link ADDRESS} @{" ARexx port " link AREXX_PORT} @{" Index " link INDEX} Menus @{" Project menu " link PROJECT_MENU} @{" View menu " link VIEW_MENU} @{" Block menu " link BLOCK_MENU} @{" Extras menu " link EXTRAS_MENU} @{" Layout menu " link LAYOUT_MENU} @{" Macro menu " link MACRO_MENU} @{" Search menu " link SEARCH_MENU} @{" About GoldED " link M001} @endnode @node FEATURES "FEATURES" @{b} FEATURES @{ub} @{" Folding " link M106} Nested folding @{" Undo & redo " link M132} Unlimited configurable undo & redo @{" Menu configuration " link EXTRAS_OPTIONS_LOCAL_MENU} Configurable menus @{" Options local " link M175} Notebook windows simplify configuration @{" ARexx port " link AREXX_PORT} ARexx port offers 250+ commands and options @{" Filetypes " link EXTRAS_OPTIONS_GLOBAL_FILETYPES} Local configuration, filetype detection @{" Toolbar " link M178} Configurable toolbar @{" Mouse configuration " link MOUSE_CONFIGURATION} Configurable mouse buttons @{" Drag & Drop " link MOUSE_CONFIGURATION} Move text using the mouse @{" Syntax highlighting " link EXTRAS_OPTIONS_LOCAL_SYNTAX} Configurable syntax highlighting @{" QuickReference " link M074} QuickReference capability for includes, guides, ... @{" APC " link M076} Automatic phrase completion based on dictionary @{" Shifting " link M046} Indention of blocks @{" HotKey " link M020} HotKey support, commodity support @{" File list " link EXTRAS_OPTIONS_LOCAL_MENU} Open files are listed in the menu @{" Hide " link M118} Hide windows @{" WordWrap " link M054} Formatting functions, word wrap @{" SmartIndention " link EXTRAS_OPTIONS_LOCAL_INDENT} Context-sensitive indention (SmartIndention) @{" AutoBackup " link EXTRAS_OPTIONS_GLOBAL_MISC} Automatic backups @{" MenuHelp " link GETTING_STARTED} Menu help based on AmigaGuide library @{" Language " link GETTING_STARTED} Localized @{" Debugger " link M173} Breakpoints display: source level debugger frontend @{" Printer " link EXTRAS_OPTIONS_LOCAL_PRINTER} Printer configuration available @{" Spooler " link EXTRAS_OPTIONS_LOCAL_PRINTER} Asynchronous printing @{" Multiselection " link M005} File requesters support multiselection @{" XPK support " link M015} XPK support: (de)crunching & encryption @{" Search/ASCII table " link M077} ASCII character selection table @{" Display mode " link EXTRAS_OPTIONS_LOCAL_DISPLAY} Configurable GUI: display mode, fonts @{" Clipboard " link M031} Clipboard support @{" Project/Open fast " link M006} Fast loading @{" AutoCase " link EXTRAS_OPTIONS_LOCAL_WORDS} Automatic online case correction @{" Parenthesis check " link EXTRAS_OPTIONS_LOCAL_GUI} Automatic online parenthesis check @{" QuickFunc " link M085} Displays a table of functions defined in source code @{" Insertion of columns " link M043} Insertion of columns, removal of columns @{" Dynamic tabs " link EXTRAS_OPTIONS_LOCAL_TABS} Fixed, regular, solid and dynamic tabs @{" Character set remap " link M080} Character set remap (e.g. Amiga to MS-DOS) @{" Quickstarter " link GETTING_STARTED} Quickstarter @{" Sequences " link M149} Sequence recording @{" Templates " link M055} Templates @{" Global search " link M126} Global search handles multiple files @{" Search/Replace History " link M066} Search & Replace history @{" File hunter " link M127} Built-in file search @{" Configurable gadgets " link EXTRAS_OPTIONS_LOCAL_GADGETS} Configurable gadgets @{" Preview " link EXTRAS_OPTIONS_LOCAL_DISPLAY} Preview display mode @{" Wildcards " link M066} Search functions support wildcards and many more ... @endnode @node LICENCE "LICENCE" @{b} LICENCE @{ub} This licence agreement affects all programs, manuals and disks of the editor package GoldED, release 4 or later. You agree to accept this licence. Violations of any of the topics below will terminate your rights to use or otherwise handle (e.g. distribute) the package. You may not duplicate, distribute, hire or sell a registered GoldED package or GoldED keyfiles. Keyfiles are ©1995-1996 Dietmar Eilert. You may not distribute original GoldED keyfiles nor are you allowed to create, use or distribute reverse-engineered keyfiles. Distribution of keyfiles is a violation of copyright laws and will be prosecuted by the copyright owner(s). The unregistered trial version version may be made available for downloading by online services - e.g. FTP sites - if the package is made available free of charge. No other forms of distribution are allowed unless you have written permission of the copyright owners, including, but not limited to, CD ROM distribution or distribution on cover disks. A distribution licence for GoldED can be purchased from the copyright owner(s). The copyright owner(s) reserve the right to interdict distribution at any time if a distributor fails to obey to this licence. You may not modify the package: you may not change the compilation, you may not modify, reverse-engineer or translate files and you may not add or remove files. You are not allowed to distribute translations of material found in this package unless authorized by the copyright owner(s). All translation rights reserved. The copyright owner(s) provide this program "as is". The entire risk of using this program is with you. The copyright owner(s) won't be liable for damages to you - whether they arise from the use of this package or the inability to use it, whether they are direct or consequential, including, but not limited to, the loss of data or the generation of inaccurate data. @endnode @node INTRODUCTION "INTRODUCTION" @{b} INTRODUCTION @{ub} This editor has been designed as a powerful and flexible tool made for software developers: a fast and reliable development environment. Installation and usage have been designed to be simple and clear, the user interface is functional and unobtrusive. The internal design is event based: the editor waits for events like a keystroke or a menu selection and then calls a dispatcher to perform the appropriate action. Action is not hard coded: you may assign any of the editor's internal functions to events (though most people won't do any assignments at all but use the default configuration). For example you may assign the "open file" function to the key by using GoldED's keyboard requester. Or assign the text "don't panic" to the A key. Or assign an ARexx macro script to it. Or a DOS command. Or just leave it as it is. No matter what kind of interface to GoldED you use (the menus, the keyboard or its ARexx port): all of them do support the same command set. It's easy to use, straight-forward and flexible. GoldED doesn't use an internal macro language like DME: Its internal functions are function calls only, performing some straight-forward kind of action. The editor relies on ARexx as far as conditional statements, variables and flow control are concerned. @endnode @node REQUIRED_SYSTEM "REQUIRED SYSTEM" @{b} REQUIRED SYSTEM @{ub} Minimum requirements are OS2.04, 68000 and 1 MB free RAM. However, this configuration isn't suitable for working effectively. Besides, GoldED has not been tested with a 68000. Suggested minimum system for average performance is a 68020 CPU and 2 MB free RAM. Total memory requirements including memory consumed by a compiler and the OS will be 8 MB RAM to 16 MB RAM. Usage of @{" syntax highlighting " link EXTRAS_OPTIONS_LOCAL_SYNTAX} increases resources requirements: a fast CPU and a fast graphics adapter should be installed. Several features (localized requesters, cursor control in listviews, free color design of menus, multiple selection in listviews, etc.) require OS3 and are not available if OS2.x is installed. We strongly recommend to install/rekick OS3; GoldED's performance increases noticeably if OS3 is available. Additional software requirements - the following packages should be installed on your machine (available at most Amiga freeware & PD distributors): o Reqtools library (required) o XPK library (optional) o AmigaGuide library (optional) @endnode @node GETTING_STARTED "GETTING STARTED" @{b} GETTING STARTED @{ub} You may start this editor the way other programs are started, too: doubleclick at the icon or type the name ("golded:golded") in a shell window. However, these methods are not recommended to start GoldED: the main disadvantage is that a new instance of GoldED is started every time, consuming memory and reducing usability. We recommend that you use the QuickStarter instead: QuickStarter The quickstarter ED is a small (4 KB) GoldED frontend. You can use it as if it were a real editor. For example, you could type "ed letter" to edit the file "letter". The advantage of the quick starter is its ability to pass a new job to a running instance of GoldED (if there is one - a new GoldED process is started if necessary). The quick starter may be made resident (the main editor may not be made resident). The source code of ED is available in the GoldED drawer (developer/examples/quickstarter). Arguments The quickstarter and GoldED support several startup options (besides a list of file names to be edited) explained below: HIDE (example: ED HIDE) Use the HIDE option but don't supply file names if you want the editor to stay in the background initially (waiting for @{" Hotkey " link M020} activation and ARexx commands). The editor will not open a window. FILETYPE (example: ED sys:letter FILETYPE=TEXT) Overrides automatic filetype detection: the example above tells GoldED to provide the environment usually used for files of the type "TEXT". You'll learn more about file types and local configuration later in this manual. Usually configuration is controlled by automatic file type detection based on file names ("sys:letter" in the example above). The FILETYPE option overrides automatic file type detection: configuration selection now depends on the symbolic file name given as argument (e.g. "TEXT", ".c", ".guide"). See @{" options global " link M176} for more information on file types. STICKY (supported by the quickstarter only) The quickstarter supports synchronous and asynchronous operation (unless the HIDE option is used to run the editor in the background) depending on whether or not the STICKY option is used. A call to ED returns immediately if STICKY is not specified. The Quickstarter returns after the window opened by ED is closed if the STICKY option is specified (GoldED itself may keep on running if there are further windows to handle): ED returns when the user quits out of the file. This option is designed to be used to synchronize GoldED with a program running the editor to edit a file. Typical usage: GoldED launched by a browser to edit e-mails. Example: ED mail:answer STICKY AREXX/K This option sets the name of GoldED's ARexx port if the editor is not yet running (it is ignored if GoldED is running already). Defaults to "GOLDED.1". Example: ED AREXX="PORT.1". SESSION/K The SESSION option can be used to restore the environment of a previous session quickly (saved using the @{" macros/session save " link M170} menu). Example: ED SESSION="golded:sessions/old.session". MenuHelp The editor's help facility is based on Commodore's AmigaGuide tool and the AmigaGuide library. Doubleclick the manual icon to make AmigaGuide display the help file. You may use MultiView of OS3.0 to read the guide file, too. GoldED supports menu help: press the key while selecting a menu to get explanations related to the item you selected. Help windows block text windows if your machine doesn't run OS3. Language Locale library of OS2.1 or better is supported as far as requesters are concerned: Requesters will use German translations if you have selected German to be your default language (using the 'locale' preferences of your Workbench). English, French, German, Italian and Swedish are available so far; further languages may be available in the future. Locale settings do not affect menus: menus are not part of the editor itself but external files. The default menu definition file is available in several languages. It is installed during GoldED installation. GUI (Graphical User Interface} The editor's user interface supports the look & feel of OS3. Most gadgets support keyboard activation: underlined characters within gadget labels indicate shortcuts. Shortcut keys allow you to move a slider gadget or to activate a button gadget without your mouse. Use the shift key simultaneously to toggle the direction of changes - e.g. to move a slider gadget one step to the left instead of one step to the right. Use the Amiga key simultaneously to activate another gadget from within a string gadget (your input would go to the string gadget if R-Amiga is not used). Amiga-X clears string gadgets. CTRL+L inserts a form feed code, CTRL-ESC an ESC code, CTRL-TAB a tab code. @endnode @node MOUSE_CONFIGURATION "MOUSE CONFIGURATION" @{b} MOUSE CONFIGURATION @{ub} A simple mouse click into a text window positions the cursor. Doubleclick into the window to mark the word under the cursor. Hold down the mouse button and drag the mouse pointer over the text to mark lines or single words. This editor offers two marker resolutions: character resolution and line resolution. Hold down the SHIFT key while marking to change from character resolution (useful to mark words) to line resolution (useful to mark paragraphs). Drag & Drop Clicking at a marked section while holding down the ALT key activates the drag & drop mode: the cursor shape changes to a symbolized block, indicating that you can now move the block using the mouse. Release the mouse button to have the text moved to the mouse position. All mouse functions described above can be customized; this is a description of factory defaults only. @endnode @node MENU "MENU" @{b} MENU @{ub} @{" Project menu " link PROJECT_MENU} @{" View menu " link VIEW_MENU} @{" Block menu " link BLOCK_MENU} @{" Extras menu " link EXTRAS_MENU} @{" Layout menu " link LAYOUT_MENU} @{" Macro menu " link MACRO_MENU} @{" Search menu " link SEARCH_MENU} GoldED offers almost unlimited user configuration - there is no "standard" appearance. Colors, resolution, fonts, menus: all major parts of GoldED are configurable. This text describes the default configuration shipped with the editor. You'll probably want to customize the standard setup using @{" extras/options local " link M175} or @{" extras/options global " link M176}. @endnode @node PROJECT_MENU "PROJECT MENU" @{b} PROJECT MENU @{ub} Menu tree of project menu @{" project/clear window " link M003} @{" project/save and close " link M016} @{" project/open " link M005} @{" project/print " link M018} @{" project/open fast " link M006} @{" project/name " link M011} @{" project/open new " link M007} @{" project/information " link M134} @{" project/open original " link M008} @{" project/protection " link M017} @{" project/insert " link M009} @{" project/current dir... " link M012} @{" project/append " link M010} @{" project/current dir " link M161} @{" project/save " link M013} @{" project/quit all & exit " link M019} @{" project/save as " link M014} @{" project/quit buffer " link M020} @{" project/save as XPK " link M015} The project menu offers a variety of commands related to general handling of a document, especially as far as basic input/output functions are concerned (load, save, print). @endnode @node M003 "project/clear window" @{b}project/clear window@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Clears contents of current window. Protection bits are set to the defaults (see @{" extras/options local/misc " link EXTRAS_OPTIONS_LOCAL_MISC}). The path is reset to the current path, the file name is reset to "unnamed". You are asked for confirmation if the text has been modified. @endnode @node M005 "project/open" @{b}project/open@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Loads a new text (file requester selection). Discards current text if any was loaded. A confirmation request has to be answered if the text has been modified. Multiselection File requesters offered by GoldED usually support multi selection: you may select more than one file (hold down the SHIFT key while selecting files). Multi selection handling depends on the context: @{" project/append " link M010} loads all selected files into one window, @{" project/open " link M005} opens a new window for each file. AppWindows Text windows are AppWindows if GoldED is running on the Workbench screen: drag icons of text files over a text window to have those files loaded by GoldED. The files are appended to existing text. Multi selection is supported: You may drag more than one file over a window using extended selection (hold down the shift key while you select icons). XPK files (see @{" project/save as XPK " link M015}) are recognized and decompressed if the @{" XPK " link CREDITS} libraries are available. This function recognizes tabs (dez. 9): Tabs are replaced by spaces (dez. 32) while loading. Usually one tab code is expanded to eight spaces. @{" Extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC} allows you to customize substitution. This function uses a small input buffer to speed up operation. Better performance (at the cost of higher RAM usage) is provided by @{" project/open fast " link M006}. Files usually are scanned for folded sections after loading if the AutoFold feature has been enabled: marked sections are folded before the text is displayed for the first time. The AutoFold feature can be turned off (@{" extras/options local/misc " link EXTRAS_OPTIONS_LOCAL_MISC}) in order to decrease loading time. All file related functions of GoldED can handle text files only. Don't attempt to edit binaries (programs). GoldED is a text editor, not a file monitor. It will change the data in a way suitable for text files but definitely unsuitable for binaries (e.g. remove CR return codes, substitute spaces, clear the executable bit). @endnode @node M006 "project/open fast" @{b}project/open fast@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} FastLoad A fast replacement for @{" Project/Open " link M005}. This function uses a large cache (same size as the file you want to load) in order to increase loading speed. Performance advantage (compared to @{" Project/Open " link M005}): up to 50% faster. RAM requirements example: about 900 K are used if loading a 400K file: 400K cache and 500K to store the file in the internal format. The cache is freed immediately after the file has been loaded. Technical information: Exact RAM usage depends on the average line width. 28 Bytes are allocated for each text line (to store general information) plus sufficient RAM to store the line's text. That's why a 40K text consisting of empty lines only consumes much more RAM than a normal 40K text. This function doesn't recognize tab codes: tab codes usually are not expanded to spaces. That's not a problem if loading documents generated by GoldED: files saved by GoldED don't include tabs. Ignoring tabs allows usage of a faster loader. You should use the normal load function (@{" Project/Open " link M005}) if loading files generated by other editors. Tabs found in those files are displayed as inverted "T" otherwise. The editor attempts to reduce this problem using an automatic detection routine: Fallback to normal loading if a tab code is found in the first 1500 bytes of the document. @endnode @node M007 "project/open new" @{b}project/open new@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Loads a document into a new window (see @{" project/open " link M005}). @endnode @node M008 "project/open original" @{b}project/open original@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Reloads current file from disk. Useful after you have made some changes but want to switch back to the original. This function uses slow loading (see @{" project/Open fast " link M006}), i.e. tabs are substituted by spaces. @endnode @node M009 "project/insert" @{b}project/insert@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Inserts a file at current cursor position (before the current line). A file requester will pop up, asking you for one or more files to be inserted. Hold down the SHIFT key to select more than one file (this feature is called "multiselection"). @endnode @node M010 "project/append" @{b}project/append@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Appends one or more files to your current text. A file requester will pop up, asking you for one or more files to append to your text. Quite useful to join a couple of files together. @endnode @node M013 "project/save" @{b}project/save@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Saves the text to the file displayed in the window's title bar. Old copies are overwritten without asking for confirmation if overwrite mode (@{" extras/options local/misc " link EXTRAS_OPTIONS_LOCAL_MISC}) has been enabled. Turn on backup creation (@{" extras/options local/misc " link EXTRAS_OPTIONS_LOCAL_MISC}) if you want the editor to backup the old version. Automatic backups (e.g. every ten minutes) are available, too: the backup path is set using the @{" extras/options local/misc " link EXTRAS_OPTIONS_LOCAL_MISC} requester, the backup interval is set by the @{" extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC} requester. Backups are written to the directory a text has been loaded from if no dedicated backup path is selected. A new suffix ".bak" is appended to all backups files. This function is not available if a window is read-only to prevent you from accidentally overwriting important files. QuickRef windows are read-only (see @{" QuickReference " link M074}). @{" Project/protection " link M017} allows you to change the windows status. @endnode @node M014 "project/save as" @{b}project/save as@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Saves current buffer (compare @{" project/save " link M013}) to the file you select in a file requester (defaults to the name displayed in the window title). This function is not available if the buffer status has been set to read-only (see @{" project/save " link M013}). @endnode @node M015 "project/save as XPK" @{b}project/save as XPK@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} XPK support Saves current file in compressed mode. See @{" extras/options local/misc " link EXTRAS_OPTIONS_LOCAL_MISC} on how to select a compression mode. Some compression modes require a password - the password is set using the @{" extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC} configuration. Encrypted files can not be loaded if the password isn't set correctly (neither by GoldED nor by other editors). This function requires installed XPK libraries. XPK libraries are not shipped with GoldED. Other programs may or may not be able to handle XPK files. Compilers usually can not load XPK files. @endnode @node M016 "project/save and close" @{b}project/save and close@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Saves a buffer and closes its window. The file is not saved if the window status has been set to read-only (see @{" project/save " link M013}) or if the file could not be saved successfully. GoldED is either terminated or kept running in the background after the last window has been saved depending on the "resident" setting (@{" extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC}). @endnode @node M018 "project/print" @{b}project/print@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Sends current text to the printer. Several output-related options can be set using the @{" extras/options local/printer " link EXTRAS_OPTIONS_LOCAL_PRINTER} configuration. Further configuration depends on the Workbench printer setup (prefs/printer). LaserJet/DeskJet owners may use the HiSpeed printing utility @{" extras/HiSpeed " link M137} instead - it provides better configuration options (e.g. book printing mode). HiSpeed is a shareware program; a HiSpeed registration is part of every GoldED Pro/NET registration. @endnode @node M011 "project/name" @{b}project/name@{ub} Allows you to change the name of the current buffer (you are prompted for a new name). The buffer is renamed, however, the file the text has been loaded from is not renamed (@{" extras/files " link M138} allows you to rename files). Changing the name triggers file-type-detection (@{" extras/options global/filetypes " link EXTRAS_OPTIONS_GLOBAL_FILETYPES} and may result in a modified environment @endnode @node M134 "project/information" @{b}project/information@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Presents some statistics related to the current text: Bytes, lines, folds and non-ASCII-characters (codes above 127) are counted. The width of the longest line is determined. Invisible linefeed characters are included in the figures. Additionally, a global figure is displayed: total UNDO RAM consumption. This figure should help you to customize the undo buffer size (@{" extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC}). @endnode @node M017 "project/protection" @{b}project/protection@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Displays protection bits of the current text. Please refer to your AmigaDOS manual if you are unfamiliar with the meaning of these bits. Usually only the script bit should be changed: Enable the script bit if creating batch file. Changes won't have any effect until you save the text. These bits are set to a default state by @{" project/clear window " link M003} (@{" extras/options local/misc " link EXTRAS_OPTIONS_LOCAL_MISC}). @endnode @node M012 "project/current dir..." @{b}project/current dir...@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} A filerequester allows you to select a new "current path". The current path defaults to the current path of the application running GoldED (e.g. current path of the shell window GoldED has been started from). The current path is used by several functions of GoldED (e.g. displayed as default path by @{" project/open new " link M007}). It is passed as current path to programs run by GoldED, too. A few functions (e.g. @{" project/open " link M005}) ignore the current path: those functions extract path information from the document's name. Setting the current path doesn't change the text name. @{" Project/Clear window " link M003} resets the path to the current directory. @endnode @node M161 "project/current dir" @{b}project/current dir@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Instructs the editor to use the document's path as default "current path" (see @{" Project/Current dir... " link M012}). @endnode @node M019 "project/quit all & exit" @{b}project/quit all & exit@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Closes all text buffers and terminates GoldED. A confirmation request is displayed if one of more buffers have been modified. The editor is completely removed from memory and is not kept running in the background (see @{" Project/Quit buffer " link M020}) unless a @{" debugger " link M173} has locked GoldED: GoldED can not be terminated during a debugger session. @endnode @node M020 "project/quit buffer" @{b}project/quit buffer@{ub} of: @{" PROJECT MENU " link PROJECT_MENU} Closes current window. A confirmation request is displayed if the document has been modified. GoldED is either terminated or kept resident in the background (waiting for a @{" hotkey " link M020}) after the last window has been closed. @{" extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC} allows you to choose the behaviour you prefer (resident switch). GoldED internally uses asynchronous memory management: you won't have to wait until all memory has been freed after you close a window (this job is handled by a background task). Your Amiga might feel slightly slower than usual while the background task is busy - especially if the text buffer has been large (200 KB or more). HotKey GoldED is not removed from memory after the last window has been closed if hotkey support has been activated (@{" extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC}: resident switch enabled). Instead, the editor will wait for hotkey activation (ALT + right SHIFT + RETURN) in the background and then reopen its windows. Other ways and means to reopen a GoldED task waiting in the background include the Commodities Exchange program of your Workbench and macro execution (commands sent to the ARexx port of GoldED will wake GoldED up). Main advantage of keeping the editor resident is reduced startup time. Main disadvantage is increased memory consumption. @endnode @node BLOCK_MENU "BLOCK MENU" @{b} BLOCK MENU @{ub} Menu tree of block menu @{" block/mark " link M172} @{" block/delete " link M040} @{" block/mark line " link M021} @{" block/move " link M041} @{" block/mark paragraph " link M179} @{" block/column " link BLOCK_COLUMN} @{" block/mark hide " link M022} @{" block/block sort " link M047} @{" block/clipboard cut " link M023} @{" block/block to uppercase " link M048} @{" block/clipboard copy " link M027} @{" block/block to lowercase " link M049} @{" block/clipboard paste " link M031} @{" block/block print " link M051} @{" block/paste column " link M035} @{" block/block save " link M050} @{" block/copy " link M039} All functions of the block menu are related to the management of "blocks", which are marked sections of lines. Usually one would use menu functions or corresponding keyboard shortcuts to mark lines, however the @{" mouse " link MOUSE} may be used, too: simply hold down the left mouse button while you drag the pointer over a desired section of lines. You can have only one block per document. @endnode @node M172 "block/mark" @{b}block/mark@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Marks a block. This function is used to mark single characters as opposed to @{" block/mark line " link M021}. Cursor movements resize the block. Further usage of this menu toggles flow marker mode on or off. Use @{" block/mark hide " link M022} to turn the marker off completely. Cursor movements either set the block start or the block end depending on the cursor position (the block start is set if the cursor is closer to the block start than to the block end). Some functions of this editor require line blocks. For example you can't mark a single word and block-format it. GoldED automatically converts blocks to line blocks if required. @endnode @node M021 "block/mark line" @{b}block/mark line@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Marks beginning or end of a block. This command is used to mark whole lines (see @{" block/mark " link M172}). Sets block start if this function is used for the fist time (no marked lines so far). Sets block end if you use this function a second time. All lines between start and end position are marked. Handling is different if you use this function after a block has been selected already: The block end is set if the cursor position is closer to the end of the current block than to its start. Otherwise the start position is set to the cursor's line. Use @{" block/mark hide " link M022} to turn the marker off. @endnode @node M179 "block/mark paragraph" @{b}block/mark paragraph@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Marks paragraph: all lines between the previous empty line and the next empty line are highlighted. Use this function again (or @{" Block/Mark hide " link M022}) to remove the selection. @endnode @node M022 "block/mark hide" @{b}block/mark hide@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Removes block selection set using @{" block/mark " link M172} (or other marker functions). @endnode @node M023 "block/clipboard cut" @{b}block/clipboard cut@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Cut selected parts (see @{" block/mark " link M172}/@{" mouse " link MOUSE}) from text. These lines are written to the clipboard, ready to be inserted into applications supporting the clipboard device (e.g. into a shell window by pressing AMIGA & V or into a GoldED document using @{" block/clipboard paste " link M031}). The clipboard offers several storages called "units" and thus is able to keep several text blocks. Standard unit (used to exchange data between applications) is unit 0. You shouldn't use this function to move/copy data within GoldED documents: @{" block/copy " link M039} or @{" block/move " link M041} perform the same task much faster. @endnode @node M027 "block/clipboard copy" @{b}block/clipboard copy@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Writes selected text (see @{" block/mark " link M172}, @{" mouse " link MOUSE}) to the clipboard device, ready to be inserted into applications supporting this device. The clipboard offers several storages called "units" and thus is able to keep many blocks of data; standard unit (used to exchange data between applications) is unit 0. This function doesn't affect your current text, the selection is not deleted (see @{" block/clipboard cut " link M023}). Use @{" block/clipboard paste " link M031} to insert text posted to the clipboard into a GoldED document. @endnode @node M031 "block/clipboard paste" @{b}block/clipboard paste@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Insert clipboard contents (if any are available) into current text. An empty clipboard is reported as "clipboard error". Single words found in the clipboard are inserted at the current cursor position. Paragraphs (i.e. multiple lines) found in the clipboard are treated differently: they are inserted before the current line. Clipboard The clipboard (actually the 'CLIPS:'-directory) is used by many applications to exchange data. It offers several storages called "units" and thus is able to keep several blocks of data simultaneously. GoldED can access any unit (see @{" CLIP " link CLIP} command), though usually only unit 0 is used. Postings to the clipboard are IFF files. GoldED supports IFF/FTXT clipboard access (text files). Other files posted to the clipboard can not be insert into editor windows. Example usage: mark a text in a shell window, press AMIGA + C to copy these lines to the clipboard unit 0 and then reinsert them into a GoldED window using AMIGA + V. A paste operation won't remove the data from the clipboard, i.e. you can paste the same data multiple times. @endnode @node M035 "block/paste column" @{b}block/paste column@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Inserts @{" clipboard " link M031} contents "vertically" at current cursor position: the clipboard contents are mixed to the existing lines. Useful to paste a second column of text next to an existing column of text. Depending on insertion mode (@{" layout/insert mode " link M108}) pasted text is either inserted into the existing text or overwrites existing text. While insert mode is recommended for pasting single words, overwrite mode should be used to create multi-column documents. You will get a 'clipboard error' if the clipboard is empty. Use @{" block/clipboard copy " link M027} to move text sections to the clipboard. @endnode @node M039 "block/copy" @{b}block/copy@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Copies selected text (see @{" block/mark " link M172}, @{" mouse " link MOUSE}) to current cursor position. Useful to duplicate sections within editor windows. Can not be used to copy text from one window to another window. Use @{" block/clipboard cut " link M023} and @{" block/clipboard paste " link M031} to exchange data between windows or applications. @endnode @node M040 "block/delete" @{b}block/delete@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Deletes highlighted section (see @{" block/mark " link M172} or @{" mouse " link MOUSE}). @endnode @node M041 "block/move" @{b}block/move@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Moves highlighted text (see @{" block/mark " link M172}, @{" mouse " link MOUSE}) to current cursor position (if single words have been marked) or to the cursor line (if lines have been marked). Can not be used to move text from one window to another window. Use @{" block/clipboard cut " link M023}/@{" block/clipboard paste " link M031} to exchange data between windows or applications. @endnode @node BLOCK_COLUMN "block/column" @{b}block/column @{ub} of: @{" BLOCK MENU " link BLOCK_MENU} This menu offers column-oriented editing functions: @{" block/column delete " link M042} @{" block/column insert " link M043} @{" block/column text " link M045} @{" block/append text " link M044} @endnode @node M042 "block/column delete" @{b}block/column delete@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Removal of columns Deletes cursor column from selected lines (see @{" block/mark " link M172} on how to select lines). Move the cursor to the column to be removed before you call this function (e.g. move cursor to column 10 if you want to delete this column from all block lines). You shouldn't use this function to change indention of a paragraph to avoid accidentally deleting text; use @{" layout/indent block " link M046} instead. @endnode @node M043 "block/column insert" @{b}block/column insert@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Insertion of columns Inserts a new column into highlighted lines (see @{" block/mark " link M172} on how to mark lines). Move the cursor to the correct position before you call this function. Example: Move cursor to column 40 if you want to insert one space character at position 40 into all block lines. @endnode @node M045 "block/column text" @{b}block/column text@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Allows you to insert a text at any position into multiple lines simultaneously. Example usage: Mark some lines (see @{" block/mark " link M172}), move cursor to the destination column (e.g. column 1) and call this function. A requester pops up, asking you for a text to be inserted. Enter 'Prototype'. GoldED inserts this text into all block lines at column 1. This function simplifies table creation (insertion of '|' creates a vertical line. @endnode @node M044 "block/append text" @{b}block/append text@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Allows you to append text at the end of all highlighted lines (see @{" block/mark " link M172} on how to select lines). Example usage: Mark some lines and call this function. A requester pops up, asking you for the text to be appended to the lines. A semicolon is added at the end of each line if you enter ";". @endnode @node M047 "block/block sort" @{b}block/block sort@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Sorts selected lines (see @{" block/mark " link M172}) alphabetically. This function is not case sensitive (i.e. 'A' and 'a' are considered equal). @endnode @node M048 "block/block to uppercase" @{b}block/block to uppercase@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Converts selected text (see @{" block/mark " link M172}) to uppercase characters. This function uses the locale library if available to convert non-ASCII characters (e.g. 'ß') correctly. The locale library is part of OS2.1 and OS3.0 or better. It is not available is using OS2.04. @endnode @node M049 "block/block to lowercase" @{b}block/block to lowercase@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Converts selected text (see @{" block/mark " link M172}) to lowercase characters. This function uses the locale library if available to convert non-ASCII characters (e.g. 'ß') correctly. The locale library is part of OS2.1 and OS3.0 or better. It is not available is using OS2.04. @endnode @node M050 "block/block save" @{b}block/block save@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Saves selected lines (see @{" block/mark " link M172}) to disk (see @{" project/save " link M013}. You are asked for a file name. @endnode @node M051 "block/block print" @{b}block/block print@{ub} of: @{" BLOCK MENU " link BLOCK_MENU} Prints marked lines (see @{" block/mark " link M172}). The standard preferences printer is used. See @{" extras/options local/printer " link EXTRAS_OPTIONS_LOCAL_PRINTER} if you want to affect output settings like quality or linefeed. @endnode @node LAYOUT_MENU "LAYOUT MENU" @{b} LAYOUT MENU @{ub} menu tree of layout menu @{" layout/set right margin " link M052} @{" layout/block right " link M058} @{" layout/use current margin " link M053} @{" layout/block centered " link M059} @{" layout/insert mode " link M108} @{" layout/indent " link LAYOUT_INDENT} @{" layout/solid tabs " link M109} @{" layout/paragraph justified " link M060} @{" layout/word wrap " link M054} @{" layout/paragraph left " link M061} @{" layout/templates " link M055} @{" layout/paragraph right " link M062} @{" layout/AutoCase " link M064} @{" layout/paragraph centered " link M063} @{" layout/block justified " link M056} @{" layout/NumPad = movement " link M110} @{" layout/block left " link M057} Formatter All functions of the layout menu are related to formatting a text and layout modifications. Paragraph vs. block Some formatting functions affect selected lines only (refer to @{" block/mark " link M172} if you don't yet know how to mark lines). Others affect the 'current paragraph' of a text: all lines between the previous and the next empty line. @endnode @node M052 "layout/set right margin" @{b}layout/set right margin@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Sets right margin to match current cursor position. Example usage: move cursor to column 80, then call this menu. This will set the right margin to column 80. Margin values are considered by formatting operations only (e.g. @{" WordWrap " link M054}). Layout margins don't necessarily restrict cursor movements. This function allows you to adjust the right margin faster than using the layout configuration (@{" extras/options local/layout " link EXTRAS_OPTIONS_LOCAL_LAYOUT}). @endnode @node M053 "layout/use current margin" @{b}layout/use current margin@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Formatting functions (including word wrap) ignore the left border settings (@{" extras/options local/layout " link EXTRAS_OPTIONS_LOCAL_LAYOUT}) if this menu appears checked: the left margin is set to the indention of the cursor line instead. Usage of this option simplifies reformatting a text using a complex indention scheme. @endnode @node M108 "layout/insert mode" @{b}layout/insert mode@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Toggles writing mode from insert mode to overwrite mode and vice versa. In insert mode keyboard input is inserted into the text without overwriting the existing text. In overwrite mode the existing text is replaced by your input. The current mode is displayed in the window's title bar: INSR (insert) or OVER (overwrite). @endnode @node M109 "layout/solid tabs" @{b}layout/solid tabs@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Toggles tab mode from solid tabs to light tabs and vice versa. Solid tabs insert blank characters into your text. Depending on whether insert mode is on or off (see @{" layout/insert mode " link M108}) the existing text is either indented or overwritten. Light tabs do not overwrite text - the cursor is simply moved to the next tab position. See @{" extras/options local/tabs " link EXTRAS_OPTIONS_LOCAL_TABS} on how to set tab positions. @endnode @node M054 "layout/word wrap" @{b}layout/word wrap@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} WordWrap Toggles word warp mode on/off. Current status is displayed in the screen's title bar (WRAP). Word wrap enabled: the editor automatically inserts a return if the cursor is moved beyond the right margin while typing. Words exceeding the right margin are moved to the next line. Additionally, the paragraph is reformatted if automatic reformatting has been enabled (@{" extras/options local/layout " link EXTRAS_OPTIONS_LOCAL_LAYOUT}). See @{" extras/options local/layout " link EXTRAS_OPTIONS_LOCAL_LAYOUT} on how to adjust the right margin. Word wrap is very useful if you edit a plain ASCII text. Word wrap should be disabled if editing source files or tables. @endnode @node M055 "layout/templates" @{b}layout/templates@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Templates Toggles template mode on/off. Current status is displayed in screen's title bar (TMPL). If template mode is on, the editor will look for search patterns (templates) during user input. If a template is found, template-specific action as set up by the user is performed. Using templates you could make the editor replace "SNC" by "sincerely" immediately while you are typing. Several action types are available, including playback of recorded @{" sequences " link M149}, @{" internal commands " link INTERNAL_COMMANDS} or execution of ARexx macros. Template setup is described in the @{" layout/templates " link M055} section. @endnode @node M064 "layout/AutoCase" @{b}layout/AutoCase@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Toggles @{" AutoCase " link EXTRAS_OPTIONS_LOCAL_WORDS} mode on/off (automatic uppercase/lowercase correction). AutoCase correction is based on a dictionary (@{" extras/options local/words " link EXTRAS_OPTIONS_LOCAL_WORDS}). @endnode @node M056 "layout/block justified" @{b}layout/block justified@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Reformats marked lines (see @{" block/mark " link M172}) to make them left & right aligned. The block's last line is made left aligned. Empty lines are not removed during formatting, i.e. your document's basic structure remains unchanged. Multiple spaces are removed: don't attempt to format tables. Use @{" extras/options local/layout " link EXTRAS_OPTIONS_LOCAL_LAYOUT} to adjust layout margins. @endnode @node M057 "layout/block left" @{b}layout/block left@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Reformats marked lines (see @{" block/mark " link M172}) to make them left aligned. Empty lines are not removed during formatting, i.e. your document's basic structure remains unchanged. Multiple spaces are removed: don't attempt to format tables. Use @{" extras/options local/layout " link EXTRAS_OPTIONS_LOCAL_LAYOUT} to adjust layout margins. @endnode @node M058 "layout/block right" @{b}layout/block right@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Reformats marked lines to make them right aligned. Empty lines are not removed during formatting, i.e. your document's basic structure of paragraphs remains unchanged. Multiple spaces are removed: don't attempt to format tables. Use @{" extras/options local/layout " link EXTRAS_OPTIONS_LOCAL_LAYOUT} to adjust layout margins. @endnode @node M059 "layout/block centered" @{b}layout/block centered@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Reformats marked lines to make them appear centered within the layout area. Empty lines are not removed during formatting, i.e. your document's basic structure of paragraphs remains unchanged. Multiple spaces are removed: don't attempt to format tables. Use @{" extras/options local/layout " link EXTRAS_OPTIONS_LOCAL_LAYOUT} to adjust layout margins. @endnode @node LAYOUT_INDENT "layout/indent" @{b}layout/indent @{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} This menu offers indention-oriented editing functions: @{" layout/indent block " link M046} @{" layout/line: left " link M180} @{" layout/line: right " link M180} @endnode @node M046 "layout/indent block" @{b}layout/indent block@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Shifting Changes indention of marked lines (@{" block/mark " link M172}). Use the arrow gadgets to shift the block to the left or to the right. Currently selected keyboard-tab distance (see @{" extras/options local/tabs " link EXTRAS_OPTIONS_LOCAL_TABS}) is used as default indention step. Indention functions are assigned to the cursor keys, too (see @{" cursor keys " link CURSOR_KEYS}). @endnode @node M180 "layout/indent line" @{b}layout/indent line@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} layout/line: left layout/line: right Modifies indention of the cursor line. Shifting distance is the tab distance set using @{" extras/options local/tabs " link EXTRAS_OPTIONS_LOCAL_TABS}. @endnode @node M060 "layout/paragraph justified" @{b}layout/paragraph justified@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Reformats current paragraph (see @{" Paragraph vs. block " link LAYOUT_MENU}) in order to make the lines left & right aligned. Please refer to @{" layout/block justified " link M056} for further explanations. @endnode @node M061 "layout/paragraph left" @{b}layout/paragraph left@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Reformats current paragraph (see @{" Paragraph vs. block " link LAYOUT_MENU}) in order to make the lines left aligned. Please refer to @{" layout/block left " link M057} for further explanations. @endnode @node M062 "layout/paragraph right" @{b}layout/paragraph right@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Reformats current paragraph (see @{" Paragraph vs. block " link LAYOUT_MENU}) in order to make the lines right aligned. Please refer to @{" layout/block left " link M057} for further explanations. @endnode @node M063 "layout/paragraph centered" @{b}layout/paragraph centered@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Reformats current paragraph (see @{" Paragraph vs. block " link LAYOUT_MENU}) in order to center the lines within the layout area. Please refer to @{" layout/block centered " link M059} for further explanations. @endnode @node M110 "layout/NumPad = movement" @{b}layout/NumPad = movement@{ub} of: @{" LAYOUT MENU " link LAYOUT_MENU} Enables/disables special configuration of NumPad keys. Standard assignments are used if this option is disabled (numbers). PC-bindings (e.g. PgUp = previous page) are used if "NumPad = movement" is enabled. @endnode @node SEARCH_MENU "SEARCH MENU" @{b} SEARCH MENU @{ub} menu tree of search menu @{" search/find " link M066} @{" search/reference... " link M075} @{" search/find next " link M067} @{" search/complete " link M076} @{" search/find previous " link M068} @{" search/ASCII table " link M077} @{" search/replace " link M069} @{" search/ASCII code ? " link M079} @{" search/replace next " link M070} @{" search/ASCII code insert " link M078} @{" search/count pattern " link M071} @{" search/character set " link M080} @{" search/check " link M072} @{" search/function list " link M085} @{" search/matching bracket " link M073} @{" search/function find " link M086} @{" search/reference " link M074} @endnode @node M066 "search/find" @{b}search/find@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} Shows a requester to enter the text to search for. You may choose the search to be case sensitive or not by setting the appropriate checkmark gadget in the requester. The OK gadget makes the editor search the next (i.e. after current cursor position) occurrence of the text in the current document. Use the FIRST gadget to find the first occurrence of the search pattern in the document. @{" extras/project filter " link M126} allows you to search multiple files. Wildcards GoldED supports AmigaDOS wildcard pattern matching if are enabled, thus giving you access to advanced search functions: The reserved pattern matching characters (e.g. "*" or "|") are interpreted in wildcard mode instead of being searched literally. Valid patterns are described in your AmigaDOS manuals. Wildcard search is based on lines. The pattern "Prototype*" would make the editor look for a line beginning with "Prototype". Add a leading "*" and a trailing "*" if looking for words within lines. The editor automatically switches to fast non-wildcard search if the search string doesn't contain any wildcard characters. Search/replace history Use the block gadget next to the arrow gadget to search for the marked text. Use the arrow gadget to open a search/replace history listview. The listview offers previously used search/replace strings as well as the word under the cursor for fast selection. @endnode @node M067 "search/find next" @{b}search/find next@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} Moves cursor to the next occurrence (i.e. after current cursor position) of the pattern to search for. Use @{" search/find " link M066} to adjust the search pattern. @endnode @node M068 "search/find previous" @{b}search/find previous@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} Moves cursor to the previous occurrence (i.e. before current cursor position) of the pattern to search for. Use @{" search/find " link M066} to adjust the search pattern. @endnode @node M069 "search/replace" @{b}search/replace@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} Displays a requester to enter both, the text to search for as well as a replacement. You may choose the operation to be case sensitive or not by using the appropriate checkmark gadget. Select the NEXT gadget to replace the next occurrence of the search text by the replace text. Use the ALL gadget to replace all occurrences of the search text. Decide for the BLOCK gadget if you want the replacement operation to be restricted to marked lines (see @{" block/mark " link M172}). Please refer to the @{" search/find " link M066} section for further details (history, wildcards). @endnode @node M070 "search/replace next" @{b}search/replace next@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} Replaces next occurrence of search pattern by replace text. Replacement as well as the search pattern are set using the @{" search/replace " link M069} requester. @endnode @node M071 "search/count pattern" @{b}search/count pattern@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} Displays a requester to enter a search text. You may choose the search operation to be case sensitive by using the appropriate checkmark gadget. Select the gadget to count all occurrences of the search pattern within your text or the gadget to start counting at the current cursor position. Please refer to the @{" search/find " link M066} paragraph for further details (history, wildcards). @endnode @node M072 "search/check" @{b}search/check@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} Checks for correct use of brackets '(' within current line. You will be warned if the are more opening braces than closing ones or vice versa. Brackets in strings are recognized and ignored. @endnode @node M073 "search/matching bracket" @{b}search/matching bracket@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} Moves cursor to matching bracket. Handles several bracket types: (), , etc. Useful to check levels of execution within a program. Example usage: move cursor over first opening parenthesis "{" of a function (C source code), then use this function twice: the cursor position shouldn't change if nesting of brackets is correct. @endnode @node M074 "search/reference" @{b}search/reference@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} QuickReference Opens a help text related to the word your cursor is placed over. Example usage: Type 'struct RastPort', move the cursor over 'RastPort' and call this function. A new text window should pop up, showing you the file 'graphics.h' from you compiler's include directory. The cursor will be placed in the first line of the structure definition 'RastPort'. This feature requires that the reference system has been set up correctly. Files displayed by the reference function are read-only to prevent you from accidentally overwriting those files. Setting up the reference system You'll have to set up GoldED's reference system first in order to have this command work properly (i.e. tell the editor where to look for files like 'graphics.h'): Use @{" extras/options local/reference " link EXTRAS_OPTIONS_LOCAL_REFERENCE} to do this. Setting up the reference system basically consists of selecting the files or directories to be referenced (where to look for help). C-sources, include files, AutoDocs, BASIC programs, assembler sources and Pascal sources are understood by the editor. Add those files to the list of files to be scanned. A database is created during setup of the reference system based on these files. The database contains a list of keywords and information where to look for help related to the keywords. The database is created automatically: the editor scans all files and directories you have named. It recognized the text types of those files (checking the file name suffix) and selects a matching parser to extract keywords. Recognized file name extensions can be modified (@{" search/function list " link M085}). Adding further parser (same requester) dealing with so-far-unknown text types allows you to extend the editors reference capabilities. @{" search/function list " link M085} explains how to program parsers. @endnode @node M075 "search/reference..." @{b}search/reference...@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} Prompts you for a string to be referenced: The editor then attempts to display a help text related to this string. Similar to @{" search/reference " link M074} except that the word to be checked is entered in a string requester (as opposed to referencing the word under the cursor). Example usage: Enter "RastPort" (not "struct rastPort") to have the structure definition "RastPort" displayed. This feature will not work until the reference system has been set up correctly @{" search/reference " link M074}. @endnode @node M076 "search/complete" @{b}search/complete@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} COMPLETE DICTIONARY APC Completes the word your cursor is placed over depending on the dictionary currently loaded (see @{" IntelliSense " link SPACE_KEY}). Example usage: type 'swin', then call this function. 'swin' is replaced by 'struct Window' if the C-dictionary is present (see @{" extras/options local/words " link EXTRAS_OPTIONS_LOCAL_WORDS}). A smart algorithm is used to find the full form in the dictionary: "swindow' or "swdow" would have been recognized, too (however, the first letter of the word to be completed must match the first letter of the full form). The larger your dictionary grows the more detailed your abbreviations will have to be to ensure unique identification. We recommend to keep the dictionary small and to add often-used expressions only. COMPLETE CONTEXT Completes the expression under the cursor depending on the context of the document (@{" IntelliSense " link SPACE_KEY}). Example usage: Place the cursor over "al" and press SHIFT-SPACE: "al" is expanded to an expression starting with "al" found in the same document. @endnode @node M077 "search/ASCII table" @{b}search/ASCII table@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} Opens a character selection requester: All characters of your current font are listed in a table. Pick the character you are looking for: it is inserted at the current cursor position. Useful to insert special characters if you don't know the character's keystroke sequence. @endnode @node M079 "search/ASCII code ?" @{b}search/ASCII code ?@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} Shows ASCII code of character under cursor. @endnode @node M078 "search/ASCII code insert" @{b}search/ASCII code insert@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} ESC, FF, TAB Allows you to insert special codes into the text (escape, form feed, tab). Intended usage: preparing a text for printing. INSERT ASCII CODE Prompts you for an ASCII code to be inserted at the cursor position. Available codes (ASCII tables) usually can be found in printer manuals. This function allows you to insert control codes into a text. For example, the sequence 27 91 49 109 is recognized as "bold printing" command by many printers. Most text viewers support control codes, too, setting color and style of the displayed text. @endnode @node M080 "search/character set" @{b}search/character set@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} Character set remap Allows you to select a character set conversion file to be applied on the text: the text is remapped according to the conversion table. Remapping means that each character is replaced by another character defined in the translation file. The result depends on the translation file. Example: the text is remapped to make it readable by MSDOS machines if you load the 'AmigaToMSDOS' table. Without this conversion some characters would have been displayed incorrectly if the file were transfered to a PC. Remapping may be lossy. Example: the "©" character can not be mapped to a similar MS-DOS character (there is no such character in the PC character set). "c" is used instead. @endnode @node M085 "search/function list" @{b}search/function list@{ub} of: @{" SEARCH MENU " link SEARCH_MENU} QuickFunc Presents a new window listing recognized "markers" found in the document. Click at one of those entries to move the cursor to where the "marker" has been found. Recognized markers depend on the document's filetype (the file name suffix): C-Functions are listed if the document is a C source code. Other recognized filetypes include Pascal (listing procedures/functions), AutoDocs, Assembler, etc. GoldED uses "marker parsers" to handle different filetypes. Use the "mode" gadget of the QuickFunc window to modify filetypes recognized by the editor (file name patterns) or to add new external marker scanners. Marker detection quality depends on the scanner. For example, the C scanner shipped with GoldED recognizes only a very common type of source code formatting (function name and arguments in one line, function type in the previous line). You may add additional scanners to adjust the system to your likings @{" search/Function find " link M086}). Marker parsers are selected by GoldED automatically depending on the file type of the text (derived from the file name suffix) and the marker configuration (marker pattern). Marker setup affects the reference system, too (extras/options local/reference), since marker scanners are uses to create the reference database. @endnode @node M086 "search/function find" @{b}search/function find@{ub} Move the cursor over an expression (e.g. a function name) and execute this function: the cursor is moved to the "expression definition" if one available in the same document. Internally, an invisible list of all markers found in the text is created (see @{" QuickFunc " link M085}) and searched for the expression. Marker list creation depends on the text type and the @{" QuickFunc " link M085} setup. Technical information: programming marker scanners GoldED supports external marker scanners: select the "mode" gadget (@{" QuickFunc " link M085} window) to open a setup requester, then load a scanner using "add". The scanner is LoadSeg()'ed by GoldED, i.e. it is expected to be an executable. External scanners are called for every line of a document. It will receive the address of a line's text (char **) in A0. The line's length is available in D0, the line number is available in D1. The scanner will have to examine this line. It is expected to return NULL if the line is of no interest from the scanners point of view (e.g. a scan handler looking for #defines will return NULL if the line doesn't contain a #define). Or it may return the length of a result string to be displayed within the jump table. Set the string pointer (address available in A0) to the address of a NULL-terminated result string in this case. Example source code is available in the golded:developer/examples/scanner drawer. @endnode @node VIEW_MENU "VIEW MENU" @{b} VIEW MENU @{ub} menu tree of view menu @{" view/new window " link M004} @{" view/syntax highlighting " link M198} @{" view/go to line " link M091} @{" view/debugger " link M173} @{" view/go to top-bottom " link M092} @{" view/toolbar " link M178} @{" view/go to modification " link M093} @{" view/window " link VIEW_WINDOW} @{" view/position store " link M094} @{" view/window next " link M122} @{" view/position recall " link M100} @{" view/window previous " link M123} @{" view/fold " link M106} @{" view/hidden buffers " link M118} @{" view/preview " link M117} @endnode @node M004 "view/new window" @{b}view/new window@{ub} of: @{" VIEW MENU " link VIEW_MENU} Opens a further text window. Window size and window position are determined by the local configuration (@{" extras/options local/display " link EXTRAS_OPTIONS_LOCAL_DISPLAY}): the window is centered on screen, aligned or enlarged. You may specify a fixed position/size, too: disable AutoArrange and disable AutoCenter. Resize the window according to your wishes, then save the display configuration. @endnode @node M091 "view/go to line" @{b}view/go to line@{ub} of: @{" VIEW MENU " link VIEW_MENU} Moves the cursor to the line you specify (1, ...). Check the 'unfold' gadget to enable absolute line numbers (folded lines are counted). Folded lines are ignored if this gadget is unchecked. @endnode @node M092 "view/go to top-bottom" @{b}view/go to top-bottom@{ub} of: @{" VIEW MENU " link VIEW_MENU} Moves the cursor to the document's first line or to the document's last line. The cursor is moved to the first text line if closer to the text end so far (and vice versa). @endnode @node M093 "view/go to modification" @{b}view/go to modification@{ub} of: @{" VIEW MENU " link VIEW_MENU} Moves the cursor to the line of the last change (or at least close to that position it if the last operation was a 'delete line'). @endnode @node M094 "view/position store" @{b}view/position store@{ub} of: @{" VIEW MENU " link VIEW_MENU} Records the position of the cursor & the view area of the text in the window. Use @{" view/position recall " link M100} to restore the cursor position and view area. You may store five positions for each text window separately. @endnode @node M100 "view/position recall" @{b}view/position recall@{ub} of: @{" VIEW MENU " link VIEW_MENU} Recall cursor position stored by @{" view/position store " link M094}. @endnode @node M106 "view/fold" @{b}view/fold@{ub} of: @{" VIEW MENU " link VIEW_MENU} Folding INTRODUCTION One of GoldED's most useful features is its folding capability: Folding means hiding some lines of a document temporarily. The lines are replaced by a single (highlighted) lines called the "fold comment". Folding simplifies editing large files: you don't get lost in thousands of lines if you fold parts you are (currently) not interested in. Unfold the ones you are working on. Nest folding is supported: folds may contain further folds. How to fold lines Enclose the section to be folded (hidden) into 'fold markers'. Fold markers are plain character sequences. Default sequence is /// (which is recognized as a comment by most C compilers). Example: /// "important function" void main() { puts("fold me !"); } /// Now move the cursor over any line of the example above (except the last line) and press the HELP key. The lines vanish, a single new line (the fold header) appears: > important function Press the HELP key again to unfold the fold. There number of folds used in a text is not limited. Using some folds will increase the performance of most functions (e.g. line insertion) though using a large number of folds may decrease the performance. Fold markers may be set to any string of up to 10 letters. The shorter the faster. Nested folding is supported only if different markers for beginning/end of a fold section are used (see @{" extras/options local/misc " link EXTRAS_OPTIONS_LOCAL_MISC}). You should choose fold markers carefully: we recommend to use a sequence regarded as comment by your compiler. Or embed the fold markers into comments. Fold comments (displayed instead of the folded text) are write-protected. You can not edit those lines: keyboard input is suppressed if the cursor is placed over a fold header. Folded sections are not recognized by find & replace operations. Unfold a fold if you want to edit it (or search text in it). Block operations (@{" block menu " link BLOCK_MENU}) don't modify folded sections, however, folds are not ignored completely: It is possible to copy, duplicate, cut or remove a fold if it has been marked as a block. Saving or printing a file is not influenced by folding - the text is treated as if all folds were unfolded. FOLD ALL Scans text for fold markers. Folds all text sections surrounded by fold markers (see below for general information on GoldED's folding facilities). There is a keyboard shortcut quite similar to this function: CTRL + HELP; it toggles all folds: if the cursor is placed over a fold header, all folds are unfolded. If the cursor is placed over a normal text line, all sections surrounded by fold markers are folded. UNFOLD ALL Scans text for folds. All folds (and sub-folds) are unfolded. @endnode @node M117 "view/preview" @{b}view/preview@{ub} of: @{" VIEW MENU " link VIEW_MENU} Toggles display mode of current window from 'normal' mode (standard text font used) to 'preview' mode (preview font used; usually a small font to increase the overall view). See @{" Preview " link EXTRAS_OPTIONS_LOCAL_DISPLAY} for more details. @endnode @node M198 "view/syntax highlighting" @{b}view/syntax highlighting@{ub} of: @{" VIEW MENU " link VIEW_MENU} Toggles syntax highlighting on/off: GoldED color-codes syntax elements recognized by syntax parsers (e.g. reserved words of a programming language) if syntax highlighting is enabled @{" extras/options local/syntax " link EXTRAS_OPTIONS_LOCAL_SYNTAX}). @endnode @node M173 "view/debugger" @{b}view/debugger@{ub} of: @{" VIEW MENU " link VIEW_MENU} Debugger Toggles the breakpoint display of the current window on/off. Requires a source level debugger recognizing GoldED. Usually debuggers recognizing GoldED enable/disable breakpoint displays on their own. This menu allows you to override debugger control. Breakpoints usually are created by the compiler or debugger and set by the user to either active or inactive. Click at a breakpoint to toggle its state. Breakpoints can be deleted (SHIFT-click). A typical debugger session using GoldED as debugger frontend: Compiler and debugger are started by the compiler environment. The debugger assumes control over GoldED if it has been prepared for GoldED. Breakpoint displays automatically appear in all text windows connected to your project. You'll use the debugger window to step through the program or inspect variables and the breakpoints displayed by GoldED to tell the debugger where to stop execution. Breakpoints are hidden at the end of the debugger session automatically. GoldED allows you to modify buffers during a debugger session. You can correct errors immediately. Unmodified buffers are simulated towards the debugger: the debugger is not confused, breakpoints remain usable. Information about breakpoints optionally is stored in files so that you can restore the breakpoints quickly to a specific state during the next debugger session (@{" extras/options local/misc " link EXTRAS_OPTIONS_LOCAL_MISC}): The editor optionally saves breakpoint information to files named like the original text with the suffix set to ".bpt". These files are created automatically if you save a text containing breakpoints and loaded automatically if found while loading a text. They are deleted automatically if you save the text again without defined breakpoints (you may prefer to manually delete). Please note that it depends on your debugger whether pre-set breakpoints loaded from a bpt-file are accepted during a debugger session: the debugger needs to support coordination/synchronization of pre-set breakpoints with the list of available breakpoints produced by the compiler. @endnode @node M178 "view/toolbar" @{b}view/toolbar@{ub} Toolbar Shows/hides the toolbar. Look and feel of the toolbar and the functions assigned to the buttons are configurable: @{" extras/options local/gadgets " link EXTRAS_OPTIONS_LOCAL_GADGETS}. @endnode @node VIEW_WINDOW "view/window" @{b}view/window @{ub} This menu offers window-oriented functions: @{" view/arrange vertical " link M111} @{" view/arrange horizontal " link M111} @{" view/window maximize " link M116} @{" view/window center " link M181} @{" view/window zip " link M115} @{" view/remember size " link M182} @endnode @node M111 "view/window arrange" @{b}view/window arrange@{ub} of: @{" VIEW MENU " link VIEW_MENU} view/arrange vertical view/arrange horizontal Arranges windows on screen while avoiding overlapping windows. The windows are made to share the display without overlapping. The screen's title bar is kept uncovered (correct recognition of the title bar is not possible if the screen has not been dragged down). You may assign extra weight to the current window using the "weight" gadget of @{" extras/options local/display " link EXTRAS_OPTIONS_LOCAL_DISPLAY}. This function recognizes AutoScroll screens (screens larger then the display): the window(s) are arranged within the visible section only. However, you may instruct the editor to use the full screen (display configuration, full screen option). Screen areas to be ignored while arranging windows may be specified (@{" extras/options local/display " link EXTRAS_OPTIONS_LOCAL_DISPLAY}, margins). Adjusting those margins allows you to keep important display elements visible. @endnode @node M116 "view/window maximize" @{b}view/window maximize@{ub} of: @{" VIEW MENU " link VIEW_MENU} Enlarges the current window to cover the visible display area. User defined margins and the position of the screen's title bar are considered (see @{" view/window arrange " link M111}). @endnode @node M181 "view/window center" @{b}view/window center@{ub} of: @{" VIEW MENU " link VIEW_MENU} Centers the current window. User defined margins and the position of the screen's title bar are considered (see @{" view/window arrange " link M111}). @endnode @node M115 "view/window zip" @{b}view/window zip@{ub} of: @{" VIEW MENU " link VIEW_MENU} Resizes current window as if the window's zip (zoom) gadget were used: The OS keeps track of two alternative window sizes for each window. This functions toggles between them. The alternative window size is preset by GoldED to the minimum window size the editor can handle. @endnode @node M182 "view/remember size" @{b}view/remember size@{ub} of: @{" VIEW MENU " link VIEW_MENU} Size and position of the current window are used as default window dimensions for windows sharing the display configuration of the current text. You can save default dimensions permanently using @{" extras/save preferences " link M177}. Please note that other configurable options of GoldED may override default window dimensions (e.g. @{" AUTOARRANGE " link EXTRAS_OPTIONS_LOCAL_DISPLAY}). @endnode @node M122 "view/window next" @{b}view/window next@{ub} of: @{" VIEW MENU " link VIEW_MENU} Activates the next window (based on window creation order). A very handy function: you don't need to grab the mouse for window activation. Simply flip from one window to another window using this command. @endnode @node M123 "view/window previous" @{b}view/window previous@{ub} of: @{" VIEW MENU " link VIEW_MENU} Activates the previous window (based on window creation order). This menu is the counterpart for @{" view/window next " link M122}. @endnode @node M118 "view/hidden buffers" @{b}view/hidden buffers@{ub} of: @{" VIEW MENU " link VIEW_MENU} HIDE Hides a text buffer, i.e. closes the window but keeps the document. Useful to have several text files present without overloading the display. Use BUFFER SHOW to reopen the window. Freezing the last window leaves you without menus and without a GoldED screen. You'll then have to use the @{" hotkey " link M020} to reopen the display: right ALT plus right SHIFT plus RETURN. Or the commodities exchange program of your Workbench. BUFFER SHOW... Asks you for a hidden buffer to be reopened. This functions tries to restore the old window position/size. BUFFER SWAP... A list of hidden buffers is display. Select a buffer to be reopened. The current window is hidden instead. BUFFER SWAP (NEXT) Reopens the next hidden buffer. The current window is hidden instead. BUFFER SWAP (PREV) Reopens the previous hidden buffer. The current window is hidden instead. @endnode @node EXTRAS_MENU "EXTRAS MENU" @{b} EXTRAS MENU @{ub} menu tree of extras menu @{" extras/project filter " link M126} @{" extras/redo " link M133} @{" extras/search file " link M127} @{" extras/AmigaDOS shell " link M135} @{" extras/search file... " link M174} @{" extras/HiSpeed " link M137} @{" extras/line swap " link M128} @{" extras/files " link M138} @{" extras/line double " link M129} @{" extras/insert text " link M142} @{" extras/line remove " link M130} @{" extras/options local " link M175} @{" extras/line insert " link M131} @{" extras/options global " link M176} @{" extras/undo " link M132} @{" extras/save preferences " link M177} @endnode @node M126 "extras/project filter" @{b}extras/project filter@{ub} of: @{" EXTRAS MENU " link EXTRAS_MENU} Global search Displays a requester to enter the text to search for. Searches all files added to the project list (@{" extras/options local/project " link EXTRAS_OPTIONS_LOCAL_PROJECT}). File names are highlighted if the pattern is found in the file (OS3.0). The file name is removed from the list if the pattern is not found in the file (OS2.0). You may choose between fast case sensitive and slow case-insensitive searching using the appropriate checkmark gadget. Doubleclick at a filename to load the corresponding file. Hold the SHIFT button down to toggle selections (OS3 only). The list displayed by this requester is a copy of the project list, adding files or removal of files doesn't affect the project list. List access (programmers only) External programs may read the project list by sending the @{" QUERY " link QUERY} command to GoldED's ARexx port (QUERY PRJLIST). The editor returns a pointer to a standard exec list. This pointer stays valid until the next ARexx command is sent to GoldED (@{" LOCK " link LOCK}/@{" UNLOCK " link UNLOCK} protocol required). Example source code is available in the developer drawer ("golded:developer/examples/project"). The list may not be modified directly (use the @{" PROJECT " link PROJECT} command to edit the list). @endnode @node M127 "extras/search file" @{b}extras/search file@{ub} of: @{" EXTRAS MENU " link EXTRAS_MENU} File hunter Extracts a file name from the text under the cursor. The editor understands several different file name delimiters (e.g. <...> or quotations marks). It defaults to extracting the full word under the cursor if no known delimiters are detected. The editor will then try to find the file on your disk(s). All locations specified by the hunter setup (@{" extras/options local/hunter " link EXTRAS_OPTIONS_LOCAL_HUNTER}) are scanned. @endnode @node M174 "extras/search file..." @{b}extras/search file...@{ub} of: @{" EXTRAS MENU " link EXTRAS_MENU} Function to locate a file on your disk(s) (@{" file hunter " link M127}); enter the file you are looking for. @endnode @node M128 "extras/line swap" @{b}extras/line swap@{ub} of: @{" EXTRAS MENU " link EXTRAS_MENU} Swaps current line with next line. @endnode @node M129 "extras/line double" @{b}extras/line double@{ub} of: @{" EXTRAS MENU " link EXTRAS_MENU} Doubles current line (faster than using @{" block/copy " link M039}). @endnode @node M130 "extras/line remove" @{b}extras/line remove@{ub} of: @{" EXTRAS MENU " link EXTRAS_MENU} Deletes current line. The line is not lost - it is put to a pick-push ring buffer (last in, first out). You may reinsert it anywhere else using @{" extras/line insert " link M131}. This function is assigned to the keyboard, too (CTRL-DEL). Note: keyboard access (CTRL-DEL) will give you a much better response time than menus due to the Amiga's OS (keyboard queue settings unfortunately don't affect menu shortcuts). Example usage: Delete 3 lines, move to another line and call @{" extras/line insert " link M131} three times to reinsert the lines. The pick/push buffer holds up up 50 lines. @endnode @node M131 "extras/line insert" @{b}extras/line insert@{ub} of: @{" EXTRAS MENU " link EXTRAS_MENU} Reinserts the last line of the pick/push buffer before current line. See @{" extras/line remove " link M130} for further explanations. @endnode @node M132 "extras/undo" @{b}extras/undo@{ub} of: @{" EXTRAS MENU " link EXTRAS_MENU} undo & redo Undos last operation if undo has been enabled (@{" extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC}). You can undo the undo using @{" extras/redo " link M133} immediately. You won't be able to redo undos if you modify the text. The number of undoable operations depends on how much memory you have assigned to the undo mechanism (see @{" extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC}). All operations including block-related functions, formatting and loading can be undone. However, depending on the selected undo mode (@{" extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC}), some operations can not be undone separately. In standard mode, all modifications within a single line count as one undo step. In "High" mode, all major changes (e.g. "delete until end of line") within a line can be undone separately while minor changes (single keystrokes) still are collected as one undo step. In "Auto" mode, all modifications can be undone separately. A garbage collection has been added to reduce memory consumption in "Auto" mode: multiple "old" minor steps are converted to one major step automatically (occasionally). Memory consumption created by he undo system can be checked using @{" project/information " link M134} (undo bytes display). @endnode @node M133 "extras/redo" @{b}extras/redo@{ub} of: @{" EXTRAS MENU " link EXTRAS_MENU} Undos the last undo. This command can only be used immediately after an undo: All redo information is discarded once you start editing the text. @endnode @node M135 "extras/AmigaDOS shell" @{b}extras/AmigaDOS shell@{ub} of: @{" EXTRAS MENU " link EXTRAS_MENU} Opens a shell window on GoldED's screen. The window is arranged on the screen: it will open within the visible display area of overscan screens. @endnode @node M137 "extras/HiSpeed" @{b}extras/HiSpeed@{ub} of: @{" EXTRAS MENU " link EXTRAS_MENU} Runs the external @{" HiSpeed " link HISPEED} printer utility. The document name is passed as argument to this program. Note: HiSpeed will read the file, it will not read the buffer maintained by GoldED. Save the file first if it has been modified. @endnode @node M138 "extras/files" @{b}extras/files@{ub} of: @{" EXTRAS MENU " link EXTRAS_MENU} DELETE FILE Asks you for a list of files to be deleted. Hold down the SHIFT button to select multiple files. You are asked for confirmation before files are deleted. It is not possible to delete delete-protected files. RENAME FILE Allows you to rename a file. Select a file and enter the new name. CREATE DIRECTORY Creates new drawers. Enter the drawer name. Attempts to re-create existing directories result in an 'object in use' error. @endnode @node M142 "extras/insert text" @{b}extras/insert text@{ub} of: @{" EXTRAS MENU " link EXTRAS_MENU} INSERT DATE Inserts the current date (e.g. "Boston, 3/5/96") at the cursor position. You should set the environment variable USERTOWN to the name of your town using the DOS command setenv (e.g. setenv USERTOWN "Boston"). DOS/setenv saves variables to the 'env:' directory only. Unfortunately this directory usually is located in the RAM disk, ie. your modifications are lost after a reset. Copy env:usertown to envarc:usertown to avoid loosing modifications. INSERT TIME Inserts current time into the document. INSERT PATH Allows you to inserts a file name at cursor position (a file requester supports fast selection). @endnode @node M175 "extras/options local" @{b}extras/options local@{ub} OPTIONS LOCAL @{" extras/options local/project " link EXTRAS_OPTIONS_LOCAL_PROJECT} @{" extras/options local/misc " link EXTRAS_OPTIONS_LOCAL_MISC} @{" extras/options local/hunter " link EXTRAS_OPTIONS_LOCAL_HUNTER} @{" extras/options local/API " link EXTRAS_OPTIONS_LOCAL_API} @{" extras/options local/reference " link EXTRAS_OPTIONS_LOCAL_REFERENCE} @{" extras/options local/tabs " link EXTRAS_OPTIONS_LOCAL_TABS} @{" extras/options local/printer " link EXTRAS_OPTIONS_LOCAL_PRINTER} @{" extras/options local/layout " link EXTRAS_OPTIONS_LOCAL_LAYOUT} @{" extras/options local/words " link EXTRAS_OPTIONS_LOCAL_WORDS} @{" extras/options local/GUI " link EXTRAS_OPTIONS_LOCAL_GUI} @{" extras/options local/templates " link EXTRAS_OPTIONS_LOCAL_TEMPLATES} @{" extras/options local/display " link EXTRAS_OPTIONS_LOCAL_DISPLAY} @{" extras/options local/menu " link EXTRAS_OPTIONS_LOCAL_MENU} @{" extras/options local/syntax " link EXTRAS_OPTIONS_LOCAL_SYNTAX} @{" extras/options local/mouse " link EXTRAS_OPTIONS_LOCAL_MOUSE} @{" extras/options local/gadgets " link EXTRAS_OPTIONS_LOCAL_GADGETS} @{" extras/options local/keyboard " link EXTRAS_OPTIONS_LOCAL_KEYBOARD} @{" extras/options local/indent " link EXTRAS_OPTIONS_LOCAL_INDENT} This multi-page notebook requester provides access to the local configuration options ("environment"): configure the menu, the keyboard or the display. Environments are assigned to documents automatically: the editor selects environments based on the document type (derived from the file name). For example, you could instruct GoldED to use an environment designed for editing C sources if a C source code is loaded. Creation of environments is handled by @{" extras/options global/filetypes " link EXTRAS_OPTIONS_GLOBAL_FILETYPES} (as is selection of environments depending on the filetype). GoldED is shipped with a single preconfigured environment called "TEXT". Further preconfigured environments are available at the GoldED WWW support site (@{" WWW support " link ADDRESS}). It is important to understand that all environments consist of smaller units called "presets". Some presets have been mentioned above already: menu configuration, keyboard configuration or display configuration to name a few. The local configuration requester lists all presets assigned to the current document (forming its environment). GoldED allows you to share presets between environments and thus supports shared resources and centralized maintenance of configuration. That's why the term "local configuration" is slightly misleading: It's your decision to use presets locally only or to share them among multiple environments (@{" extras/options global/filetypes " link EXTRAS_OPTIONS_GLOBAL_FILETYPES}). Technical information: presets are stored in "golded:registry/presets/". Environments are saved to "golded:registry/registry". These files and directories may not me modified manually (don't copy files to these directories, don't delete or rename files). Ignoring this warning could destroy the registry and all configuration information. Installation scripts should use the tool "golded:tools/regedit/regedit" to install new presets and new environments. @endnode @node EXTRAS_OPTIONS_LOCAL_PROJECT "extras/options local/project" @{b}extras/options local/project @{ub} of: @{" options local " link M175} Project management: Add all source files of your current project to this list. The project list should be viewed as a basis for external project management utilities. No project management capabilities have been added to GoldED. GoldED usually will not access this list with exception of the grep command (extras/project filter). @endnode @node EXTRAS_OPTIONS_LOCAL_HUNTER "extras/options local/hunter" @{b}extras/options local/hunter @{ub} of: @{" options local " link M175} Used to tell GoldED where to search for files if the file location functions are used (@{" extras/search file " link M127}). Subdirectories are examined, too, if the "recursive" gadget is selected. @endnode @node EXTRAS_OPTIONS_LOCAL_REFERENCE "extras/options local/reference" @{b}extras/options local/reference @{ub} of: @{" options local " link M175} Configuration requester for the reference system. The reference system is based on databases: databases are collections of keywords accessed by the editor if the user asks GoldED to display a help file (@{" search/reference " link M074}). For each known keyword the path to a help file is stored in the databases. Databases are created by GoldED ("create" gadget). All you have to do is to provide a list of help files: source codes, AutoDocs, HTML files (or whatever you consider useful). You may add directories to the list, too (subdirectories are scanned). GoldED will scan these files and extract keywords to build databases ("create" gadget). Database creation may take a long time depending on the number of files to be scanned. Keyword extraction is performed by parsers made for parsing special filetypes (e.g. C sources are parsed by a C parser extracting function definitions). External parsers may be added in order to increase the editor's capability to understand more file types. Parsers are added and configured using @{" search/function list " link M085}. GoldED is shipped with parsers for C source codes, C header files, C include files, assembler source codes, Pascal source codes, BASIC source codes, AmigaGuide files, AutoDocs and HTML documents. @endnode @node EXTRAS_OPTIONS_LOCAL_PRINTER "extras/options local/printer" @{b}extras/options local/printer @{ub} of: @{" options local " link M175} Printer Provides additional configuration options (basic configuration is provided by the Workbench printer preferences utility). Supports all Workbench printer drivers as opposed to @{" extras/HiSpeed " link M137} supporting PCL printers only. INIT The contents of the init string gadget are send to the printer after basic printer initialization. The init string may be used to pass additional control codes to the printer device. The init string is interpreted (see @{" magic codes " link EVENT_DEFINITION}), non-ASCII codes can be added. Usually the printer device doesn't allow you to pass printer-specific codes to the printer - only printer device control codes are available (translated to printer specific control codes by the printer device). However, a special printer device command called "aRaw" supports sending embedded binary data to the printer. Syntax: 27 [ 34 r. The following example init string sends the string 0123456 (seven letters) to the printer: %27 "[7" %34 "r" "0123456" SPOOLER Check the spooler gadget to have data sent to the printer in the background: Printing won't block text input, you can continue to edit documents while printing. A copy of the original text (spooler usage increases memory consumption) is sent to the printer, modifications added while printing will not affect the output. @endnode @node EXTRAS_OPTIONS_LOCAL_WORDS "extras/options local/words" @{b}extras/options local/words @{ub} of: @{" options local " link M175} Dictionary configuration. Several input aids provided by GoldED depend on the dictionary composition: AutoCase (automatic case correction) and expression completion (@{" APC " link M076}). AutoCase Text input is spell-checked (correct case ?) if this option has been enabled. Checks are performed after a line has been modified. Misspelled expressions are replaced by the correct form found in the dictionary. General hints Don't let the dictionary grow too big. A large dictionary reduces usability of the @{" APC " link M076} function (you'll have to type more letters to ensure unique identification). Add unique expressions only. Add spaces to the dictionary if the expression usually is followed by a space character; example: add "int " (C type: integer) and not "int" (prevents GoldED from converting INTERNATIONAL to intERNATIONAL). Use this strategy for brackets, too: Add "Open(" to the dictionary, not "Open". @endnode @node EXTRAS_OPTIONS_LOCAL_TEMPLATES "extras/options local/templates" @{b}extras/options local/templates @{ub} of: @{" options local " link M175} Templates configuration (@{" Templates " link M055}). Templates are search patterns expected in the input stream. If a known template (a keystroke sequence) is detected in the user input the "action" assigned to the template is performed (provided that templates detection has been enabled: @{" layout/templates " link M055}). Only single words may be added as templates; no spaces. Action configuration is similar to event configuration of menu items or keyboard bindings (see @{" event definition " link EVENT_DEFINITION}). Doubleclick at one of the templates displayed in the list to modify event definitions. @endnode @node EXTRAS_OPTIONS_LOCAL_MENU "extras/options local/menu" @{b}extras/options local/menu @{ub} of: @{" options local " link M175} Menu configuration Menu titles (left list), menu items (middle list) and subitems (right list) are displayed and can be modified. The number of menus, items and subitems is limited by the Amiga operating system: for example, you may not add more than 32 items to each menu title. Doubleclick at any item to enter item configuration (@{" event definition " link EVENT_DEFINITION}). Item configuration is similar to keyboard configuration, mouse configuration, etc. The guide gadget allows you to specify a guide file used while processing @{" MenuHelp " link GETTING_STARTED} requests. File list All documents currently loaded (hidden buffers included) are listed in the menu if this option is used, providing a fast document selection method. Holding the SHIFT key down while selecting a hidden buffer in the file menu will show the hidden buffer and close the current window. Activation of the file list feature affects performance: The OS functions used to maintain the list are slow (updates of the file list are required if a window is closed or a text is loaded). @endnode @node EVENT_DEFINITION "Event definition" @{b} Event definition @{ub} The event definition requester is used to configure menu items, the keyboard, mouse keys and several other resources generating events if used. It allows you to assign internal commands, macros, text, etc. to events (e.g. a menu selection: @{" extras/options local/menu " link EXTRAS_OPTIONS_LOCAL_MENU}). Add the command, script or string (use quotation marks) to the action list and set the action type to command, script, string, etc. DOS, AREXX and TEXT action entries are interpreted: predefined keywords are replaced by a corresponding "value" at execution time (quote a string if you don't want it to be interpreted). The following keywords are recognized: Magic codes "text" ............... raw text \n ................... inserts line feed \t ................... inserts tab \" ................... inserts quotation mark \DATE ................ \ inserts value of internal variable (e.g. DATE) $HOME ................ $ inserts value of environment variable (e.g. HOME) %27 .................. % inserts ASCII code (e.g. ASCII code 27) The number of actions that can be added to event definitions is not limited. Mixed action types (e.g. internal command to save a text followed by a macro call) are supported. ARexx macros are started asynchronously: event processing will not stop. Event configuration should not depend on assumptions about if or when a macro has been processed by the ARexx server. PATH Sets current path for event processing. @{" Magic codes " link EVENT_DEFINITION} are supported. OUTPUT Sets output path/device. @{" Magic codes " link EVENT_DEFINITION} can be used in this gadget. Example: con:0/0/640/400. The default console is used if this field is left empty (@{" extras/options local/GUI " link EXTRAS_OPTIONS_LOCAL_GUI}). PATH and OUPUT settings affect DOS and AREXX actions only. SHANGHAI Windows meant to appear on the default public screen (Workbench screen) are redirected to GoldED's screen if this option is set to a positive value. Units are seconds. Redirection is active for the selected interval only. Not all windows can be redirected. ASYNC Asynchronous and synchronous DOS actions are supported. Synchronous DOS actions block event processing until the DOS command terminates. HOTKEY Menu shortcut definition (ignored if the event is not assigned to a menu item). Many shortcuts are consumed by the standard menu already. Click at the arrow gadget to make GoldED list unused shortcuts. Only ASCII characters (ASCII codes below 128) are listed. National characters are not listed. Uppercase shortcuts and lowercase shortcuts are listed separately. The text you enter into this field will not work as a menu shortcut if you enter more than one character: Instead, the text appears in the menu literally (OS3 required). Recommended usage is to notify the user of keyboard bindings that could be used as a menu shortcut. VARIABLE Variable selection (ignored if the event is not assigned to a menu item): A checkmark is added to the menu. The (boolean) variable value is used to control the checkmark state. This is just a rendering operation, usage of the menu will not change the checkmark state until you add internal commands to to the event setting the variable (e.g. the @{" SET " link SET} command). GUIDE You may assign pages of AmigaGuide documents to events in order to provide online help. For example, online help is displayed if the user holds down the HELP key while selecting a menu ([menu help]). Enter the name of an AmigaGuide page into the guide gadget. The page name usually refers to the menu's AmigaGuide documentation (@{" extras/options local/menu " link EXTRAS_OPTIONS_LOCAL_MENU}). However, you may specify a specific AmigaGuide file, too: enter the name of the guide file followed by "@" followed by a page name. You may assign a short help text directly to an event, too: the contents of the guide gadget are interpreted as text (and not as a reference to an AmigaGuide document) if put in quotation marks. The help text of toolbar events is is displayed as "bubble help" if the user moves the mouse pointer over a @{" toolbar " link M178} symbol for a few seconds. @endnode @node EXTRAS_OPTIONS_LOCAL_MOUSE "extras/options local/mouse" @{b}extras/options local/mouse @{ub} of: @{" options local " link M175} Mouse configuration. This requester is used to configure the mouse buttons. The left mouse button and the middle mouse button (if available) can be reconfigured. Event definition is similar to menu/keyboard configuration (@{" event definition " link EVENT_DEFINITION}). @endnode @node EXTRAS_OPTIONS_LOCAL_KEYBOARD "extras/options local/keyboard " @{b}extras/options local/keyboard @{ub} of: @{" options local " link M175} Keyboard configuration. The keyboard requester is used to map actions to keys or to key-qualifier combinations. GoldED recognizes the qualifiers ALT, CTRL and SHIFT or a combination of these keys. The system's default keymap is used for unconfigured keys: The "A"-key inserts "A" at the current cursor position if unconfigured. Control keys are initially undefined, ie. unconfigured cursor keys will not move the cursor, etc. GoldED is shipped with all control keys configured to useful defaults. Configuration of a key(-combination) is easy: Use the "record" gadget to add a key to the list of configured keys. Doubleclick at any of the listed key definitions to modify it. Keyboard event definition is similar to menu configuration: @{" event definition " link EVENT_DEFINITION}. Some key combinations are consumed by the OS and are not available for remapping. These keys are called 'dead keys'. For example, ALT-G doesn't insert a character but determines how to modify the next character: ALT-G + "a" appears as "à". The following keys are dead keys: ` ALT-H ALT-F ALT-J ALT-G ALT-K @endnode @node EXTRAS_OPTIONS_LOCAL_MISC "extras/options local/misc" @{b}extras/options local/misc @{ub} of: @{" options local " link M175} General configuration options. Fold start, fold end Fold marker strings (see @{" folding " link M106}). Different markers are required if nested folding (folds within folds) is used. Otherwise the same marker should be used for fold start and fold end. AutoFold Folds found in a text are automatically folded while loading if this option is enabled (before the text is displayed for the first time). XPK compression mode The XPK listview (arrow gadget) presents a list of available XPK compressors, found within the libs:compressors subdirectory. The compressor you select is used if saving XPK files (@{" project/save as XPK " link M015}). Additionally you may set the efficiency for compression (0% to 100%). Please read the original XPK documentation. Some XPK compressors require a password set using @{" extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC}. Create *.bak The editor backups old copies of a file before saving a new version over it if 'create *.bak' is enabled (otherwise the old version is overwritten). Backups are saved to the backup path you name (backup path gadget) or to the document's directory if you don't specify a backup path. The suffix ".bak" is appended to the file name. Create *.info, *.info file This option decides if icons are created for the files saved by GoldED. (existing original icons are not overwritten). Create *.bpt Information about defined breakpoints is saved permanently if you enable this option (so that breakpoints can be restored quickly to a specific state during your next debugger session). Breakpoint information is saved under the name of the original text with the suffix set to ".bpt". These files are created automatically if you save a text containing breakpoints (@{" Debugger " link M173}) and they are loaded automatically if the text is loaded (@{" project/open " link M005}). Default tool Default tool inserted into icons created by GoldED. File protection bits (Readable, Writable, Executable, Deletable) These gadgets are used to set the default bits for a new text (created by @{" view/new window " link M004}). Use @{" project/protection " link M017} to modify protection bits of open buffers. Overwrite Existing copies of a document are overwritten without further notification (confirmation requester) if this gadget is checked. Save Tabs Leading spaces of each line are replaced by tabs while saving if this option is enabled. Saving tabs instead of spaces reduces the file size. The number of spaces saved as one tab code can be adjusted; default is eight characters (@{" extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC}). This option should not be used unless you a very short of disk space (GoldED can load files without tabs faster). @endnode @node EXTRAS_OPTIONS_LOCAL_API "extras/options local/API" @{b}extras/options local/API @{ub} of: @{" options local " link M175} API interface configuration: Select the clients you would like to use locally. Clients are editor extensions providing additional features. They are added to GoldED using a dedicated library-based protocol. Add the API clients to the list and - if required (read the documentation of the API clients you add) - enter a command string in the "arguments" gadget. API example source codes are available in the "golded:developer/examples/api" drawer. Specifications of the API interface can be found in "golded:developer/api". API clients provide ways and means to add complex new functions to GoldED. A few simple examples are shipped with GoldED: MIRROR.API The mirror client highlights the matching bracket while typing: move the cursor over a bracket to have the matching bracket highlighted. Highlighting is not available while the block marker is used. Direct neighbours are not highlighted to avoid confusion with the cursor. REXX.API Command set extension The API interface supports command set extension. The REXX.API example adds the commands DISPLAYBEEP and ABOUT to GoldED. These commands can be used in menus, keyboard configuration, etc. STARTUP.API This API client runs a macro if activated; it can be used to automatically start external programs. Enter the macro to be executed in the arguments field. QUICKINFO.API This client displays information for the word under the cursor in the status bar. Example usage: have function prototypes displayed. Enter the dictionary file with the explanations in the arguments field (e.g. golded:tools/quickinfo/standard.words). Each line of that file defines a keyword and - separated by a space - keyword-related information to be displayed if the cursor moves over that word. Keywords may contain the letters "a-Z", numbers, the underscore and a trailing paranthesis "(". The dictionary file has to be kept sorted (case-sensitive). Use GoldED's BLOCK SORT CHKCASE command to resort a dictionary file after modifications. Technical information: API clients are libraries. The AmigaOS doesn't allow renaming libraries: Renamed API clients can not be used. Be careful to add the correct name to the list of API clients (case sensitive). @endnode @node EXTRAS_OPTIONS_LOCAL_TABS "extras/options local/tabs" @{b}extras/options local/tabs @{ub} of: @{" options local " link M175} Tab configuration requester. GoldED supports several tab modes: regular tabs are spaced at a constant distance (tab distance gadget). Standard tab distance of Amiga editors is 4 spaces. Fixed tabs can be set to arbitrary positions: add the desired tab stops to the list. Fixed tabs should be used for tables or assembler source codes. Last but not least dynamic tabs are available: Dynamic tabs In dynamic mode tab stop positions depend on the context: GoldED will examine the last line(s) to determine appropriate positions. Regular tabs are used if the context doesn't indicate possible positions. All tab modes mentioned above can be used in light mode (cursor is moved to the next tab stop) or in editing mode: spaces are inserted while moving the cursor to the next tab stop, indenting the text after the cursor. GoldED doesn't use tabs codes (ASCII 9) internally nor will it assign a special meaning ("indention") to this code. Other Amiga editors may use tab codes to indent text. GoldED expands those tab codes to spaces while loading (see @{" project/open " link M005}). Usually one tab code is expanded to eight spaces. You may modify this value (@{" extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC}). A few programs use tab codes in their configuration files. Those tab codes usually may not be expanded to space. Solution: use the RAW option of the @{" OPEN " link OPEN} command to override tab expansion. @endnode @node EXTRAS_OPTIONS_LOCAL_LAYOUT "extras/options local/layout" @{b}extras/options local/layout @{ub} of: @{" options local " link M175} Layout configuration. These settings affect several functions of GoldED (@{" Layout menu " link LAYOUT_MENU}). Layout borders (left margin, right margin) set by this requester are related to formatting functions only, they usually don't restrict cursor movements. Two WordWrap levels are available: in standard mode linefeeds are inserted automatically if the user input exceeds the right margin. Improved mode ("reformat" enabled) additionally reformats the text until the end of the current paragraph. Enable "reformat hyphens" if you want to have hyphens at the end of lines removed if appropriate. This feature avoids hyphens within lines after reformatting paragraphs: word parts are concatenated without a hyphen. @endnode @node EXTRAS_OPTIONS_LOCAL_GUI "extras/options local/GUI" @{b}extras/options local/GUI @{ub} of: @{" options local " link M175} Configuration of user interface related options FAST SCROLLING GoldED will speed up scrolling after the cursor has reached the borders of a text window if the FastScroll gadget is checked. You might want to turn this feature off in monochrome mode (provided you own a fast A4000) to slow down the display. ERROR BEEP Error beep volume. SCROLL BORDERS Sets the minimum cursor-to-window-border distance triggering scrolling to make more text visible. WHITE SPACE Tells GoldED what characters should be handled as if they were spaces (white space characters). This definition is used by several functions. For example, including "(" to the list would make the 'jump to next word' function (SHIFT CURSOR RIGHT) consider the "(" as word separator. Format of this string: The list of white space characters may consist of ASCII codes, code ranges or strings, separated by colons (no spaces). Example: 0-" ",128-160,".,;()". EOL WRAP Enable the EOL-wrap mode to make the cursor jump to the beginning of the next line if the cursor passes the last character of a line (during user input). CONSOLE Standard output device: used while processing menu/mouse/keyboard events (if no other output device has been specified for the event). The console description string is interpreted, you may use the @{" magic codes " link EVENT_DEFINITION} within the console description. Defaults to a reasonably-sized window on the editor's screen. EXCLUDE CURSOR Determines whether the cursor is part of the block while marking. You might want to adjust cursor color settings (@{" extras/options local/display " link EXTRAS_OPTIONS_LOCAL_DISPLAY}) after changing this option in order to visually separate block and cursor. PARENTHESIS CHECK Enable ()-check if you want the current line checked for correct use of brackets if accepted (cursor leaving line); see @{" search/check " link M072}. @endnode @node EXTRAS_OPTIONS_LOCAL_DISPLAY "extras/options local/display" @{b}extras/options local/display @{ub} of: @{" options local " link M175} Display mode Font Display configuration: adjust screen resolution, fonts, window look and more. You shouldn't modify the display configuration if running low on (CHIP-)RAM: The editor might not be able to allocate enough RAM to reopen the screen. You may select different fonts to be used for the text, for requesters and for menus (if the editor is running on a custom screen). Fonts have to be fixed width fonts. Only the screen font may be a proportional font. Line spacing of the text font is variable; default is 0 (no extra spacing between lines). Fonts smaller than eight pixels (width or height; e.g. XEN, thinpaz) in text windows may cause problems on a few Amigas: random pixels appear in the text. This problem can not be fixed. PREVIEW You may specify a preview font: This font is used by GoldED if you switch a window to preview mode (@{" view/preview " link M117}). The preview font should be considerably smaller than the standard text font. Intended usage is to increase the overall view on the fly, thus avoiding to loose track while working on complex sections of a source code. ICONS Enable/disable use of icons within requesters. Since the editor's icons have been designed with the OS2/OS3 color scheme they might not look that good if you use your own color scheme. Use this gadget to turn icons on/off. PENS You may set the pens used by the OS (and GoldED) to render the user interface. Some pens are not adjustable under OS2.1 or earlier. For example setting the menu background pen used to render menus requires at least OS3.0. CHUNKY PIXEL Many external graphics boards don't use a bitplane representation of graphics (as the current Amiga chipsets do) but a chunky pixel organization. Use the 'chunky mode' gadget to configure GoldED according to your hardware. Usually (chunky pixel gadget not checked) GoldED will try to speed up the display by restricting output to single planes - this will give you a considerable speed increase as long as a native plane-based Amiga chipset (e.g. the ECS chipset) is used. But it won't give you a speed increase at all if your external graphics board is based on a chunky pixel organization. In fact write-protecting planes might even slow down output, so switching GoldED to chunky mode might be a good idea if you own such a board. Be careful to have this gadget set properly to avoid loss of performance. Uncheck it if in doubt. FULL SCREEN Functions related to arranging windows (e.g. @{" view/window arrange " link M111}) usually determine the screen's visible display rectangle and try to arrange the windows within this area. Enable the full-screen option if you want to have the screen's real size considered instead. Useful if the driver software of your graphics board doesn't support the OS functions QueryOverscan() and VideoControl() required to read the overscan size. CENTER WINDOWS Activate this option to have new windows opened centered on the screen (minus margins; see below). AUTOARRANGE Windows are rearranged automatically after a window has been closed or while a new window is prepared if AutoArrange has been enabled (see @{" view/window arrange " link M111}). WEIGHT Used to assign extra space to the current window for window arrangement (@{" view/window arrange " link M111}). Choose a weight of two to make the current window appear twice as big as the other windows. MARGINS These gadgets allow you to specify borders to be left free during window arrangement (@{" view/window arrange " link M111}). SCROLL BAR The bottom scrollbar may be turned on or off (turning the scrollbar off enlarges the text area). @endnode @node EXTRAS_OPTIONS_LOCAL_SYNTAX "extras/options local/syntax" @{b}extras/options local/syntax @{ub} of: @{" options local " link M175} Syntax Highlighting Syntax highlighting preferences: GoldED can color-code text and thus increase usability. Colors to be used are set by this requester. Typical usage of syntax highlighting is to have reserved words of a programming language highlighted. Syntax parsing is performed by external parsers selected using this requester: the editor is responsible for refreshing the display. The syntax parsers is responsible for parsing the text and for creating a syntax description. The highlighting scheme depends on the parser. Parser for C(++) sources, Assembler and HTML are shipped with GoldED. Example source is included, too, in case you want to write your own syntax parser (golded:developer/examples/syntax). Preparsing option Syntax highlighting is prepared either immediately after loading (preparsing enabled) or "on-demand": on-demand parsing reduces loading time and short-time RAM usage by restricting parsing to the visible lines. Invisible lines are not parsed until they are displayed for the first time. On-demand parsing will slow down the display refresh until all lines have been displayed at least once. Preparsing should be disabled for complex (slow) parsers only. Parser names Please consider that syntax parsers are standard libraries and that the AmigaOS doesn't support renaming of libraries: a syntax parser won't work after it has been renamed (parser names are case sensitive). Hardware Usage of color highlighting should be restricted to a few colors only with respect to speed. Performance depends on the graphics hardware: a fast external graphics board is required to ensure sufficient performance. Amiga chipsets are based on bitplanes and therefor too slow. CPU speed is less important; suggested system is a 68030 CPU or better. @endnode @node EXTRAS_OPTIONS_LOCAL_GADGETS "extras/options local/gadgets" @{b}extras/options local/gadgets @{ub} of: @{" options local " link M175} Configurable gadgets GoldED supports two types of user-defined gadgets: text-only gadgets in window borders and toolbar gadgets. Add the button label respectively the path to a graphic (IFF) to the gadget lists. Doubleclick at a gadget definition to modify the action attached to the gadget (@{" event definition " link EVENT_DEFINITION}). @endnode @node EXTRAS_OPTIONS_LOCAL_INDENT "extras/options local/indent" @{b}extras/options local/indent @{ub} of: @{" options local " link M175} Indention configuration. These settings control the new cursor position after a linefeed (see @{" return key " link RETURN_KEY}). AutoIndention Enable AutoIndention to re-use the current indention. SmartIndention SmartIndention is context sensitive: the indention scheme and the new cursor position depend on keywords and on the indention scheme assigned to those keywords. For example, you can instruct the editor indent after the "IF" statement. The first and the last word of the cursor line determine the indention scheme of the cursor line and the new cursor position in the next line. Use the listview gadget to edit or add keywords. Supported smart indention schemes are: --> next line: cursor indention <-- next line: cursor outdention >>> shift current line right <<< shift current line left <<< -> shift current line left; next line: indention @endnode @node M176 "extras/options global" @{b}extras/options global@{ub} OPTIONS GLOBAL @{" extras/options global/filetypes " link EXTRAS_OPTIONS_GLOBAL_FILETYPES} @{" extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC} @{" extras/options global/variables " link EXTRAS_OPTIONS_GLOBAL_VARIABLES} @{" extras/options global/gui " link EXTRAS_OPTIONS_GLOBAL_GUI} Global configuration: Modify global options affecting all documents independent of filetypes and local environments. @endnode @node EXTRAS_OPTIONS_GLOBAL_FILETYPES "extras/options global/filetypes" @{b}extras/options global/filetypes @{ub} of: @{" options global " link M176} Basis of GoldED's configuration system are presets: several presets are assigned to a document (while loading) and control the menu, the keyboard configuration, the window look, etc. The presets control the environment of a text. Presets are selected from a large pool of available preset. Selection usually depends on the file name and thus indirectly on the file type: GoldED selects a set of presets based on the document's type. Combining presets to sets and assigning sets to filetypes is handled by this requester. Preset configuration is handled by @{" options local " link M175}. Filetypes Add the filetypes to be recognized to the left list: click at any of the existing entries (preferably the last entry in the list - that's the default filetype) and adjust the trigger pattern displayed below the list. The trigger pattern is a standard DOS file pattern. It determines when the environment is activated. Example: setting the pattern to "*.c" tells GoldED to use the new environment if editing C source codes. Please consider that the editor internally always uses expanded absolute file names (e.g. "dh0:s/startup-sequence", not "s:startup-sequence"). Filetypes are priority sorted: The list is scanned from top to bottom while determining the type of a text. The list's last entry is used if no match is found. Files types don't necessarily have to be DOS patterns: add any name you like. However, automatic file type detection is available for pattern-style filetypes only. Other filetypes require dedicated filetype selection: the Quickstarter provides a FILETYPE option to select a filetype. GoldED supports file type selection via the @{" SET " link SET} command (e.g. SET TYPE=".c"). The preset combination associated with the new filetype is controlled by the properties listview: it lists one preset for each configurable subsystem of GoldED (menu, keyboard, display, ...). The pool of available presets is displayed by the right list. Use the arrow gadget to add a preset to the filetype's properties. Duplicate a pool entry to create a completely new preset. Presets should be shared between multiple environments (filetypes) if possible to use resources efficiently and to share unique resources (e.g. screens). @endnode @node EXTRAS_OPTIONS_GLOBAL_MISC "extras/options global/misc" @{b}extras/options global/misc @{ub} of: @{" options global " link M176} Global configuration options. RESIDENT GoldED supports @{" HotKey " link M020} activation: The editor is not removed from memory even after the last window has been closed if hotkey activation is enabled (resident gadget checked). Instead, it will wait for a hotkey combination (right SHIFT & right ALT & RETURN) before it attempts to reopen its screen. HotKey activation will give you a quick response time though it will consume some memory, too. You might want to disable this feature on systems with less than 3 MB RAM. Use @{" project/quit all & exit " link M019} to remove the editor completely from RAM. The commodities exchange program of your workbench can be used to reactivate or unload GoldED, too. AREXX DEBUGGER Activates debug information output while processing incoming ARexx commands (commands arriving at the ARexx port are displayed). Informations are printed to the shell window GoldED has been started from. Simplifies macro development. DISABLE FONT CACHE Deactivates CPU cache while generating fonts. On some machines random pixels appear in text windows, especially if using narrow fonts (width below eight pixels, e.g. xen, thinpaz). This is probably a bug in the operating system. Enable this option and restart GoldED. Don't use fonts smaller than eight pixels (@{" extras/options local/display " link EXTRAS_OPTIONS_LOCAL_DISPLAY}) if experiencing display problems. NUMPAD = MOVEMENT Enables/disables special configuration of numpad keys: numbers (in standard mode) or cursor control commands. UNDO RAM WARNINGS The editor usually will notify you if the backup data generated by the undo system doesn't fit into the undo buffer: you will not be able to undo the last operation. Increase the undo buffer size (see below) if undo warnings appear frequently. No warnings are displayed if you uncheck this gadget. REDUCED CHIP-RAM USAGE Allows you to select a window refresh strategy for text windows. A window refresh is required if hidden parts of a window are made visible. You can not modify the refresh strategy for existing windows: this option affects new windows only. Two strategies are available: refresh performed by the operating system or refresh performed by GoldED. Refresh performed by OS: REDUCED CHIP-RAM USAGE disabled The operating system will refresh the windows using CHIP RAM to buffer hidden parts. Advantage: fast. Disadvantages: high CHIP RAM consumption. Performance suffers if the number of open windows increases. Refresh performed by GoldED: REDUCED CHIP-RAM USAGE enabled GoldED will refresh the windows. Advantages: reduced CHIP RAM consumption. Performance doesn't depend on the number of open windows. Disadvantage: Delayed refresh if GoldED is busy. ALLOW DUPLICATES Enable ALLOW DUPLICATES to permit loading the same file multiple times. You'll be notified if a file has already been loaded. GoldED will immediately activate the existing copy if duplicates are not allowed. BACKUP [min] AutoBackup Sets interval for automatic backups (0 deactivates backups). Backups are written to a configurable backup directory (@{" extras/options local/misc " link EXTRAS_OPTIONS_LOCAL_MISC}). You may instruct the editor to display a confirmation requester before creating backups (@{" extras/options global/gui " link EXTRAS_OPTIONS_GLOBAL_GUI}). PASSWORD Global password. Used while reading/saving encrypted XPK files (XPK compression mode is selected via @{" extras/options local/misc " link EXTRAS_OPTIONS_LOCAL_MISC}). UNDO MODE Enables/disables the undo mechanism (@{" undo & redo " link M132}) and selects an undo mode: Standard mode, high mode and auto mode are available. Standard mode allows you to undo/redo all major changes. However, changes within lines can not be undone separately. In high/auto mode changes within lines can be undone separately (@{" extras/undo " link M132}). UNDO BYTES, UNDO STEPS The editor backups text lines/parts you are about to change or delete if the undo mechanism has been turned on. Backup data is written to the undo buffer. The larger this buffer is, the more steps can be taken back using @{" extras/undo " link M132}. You can specify both, the undo buffer size and the maximum number of steps to be stored within the buffer. Old steps are deleted from the undo buffer if one of these limits is exceeded to allow storage of new information. The number of steps is a per-text limit while the undo buffer size is a global limit for the added undo memory consumption of all text buffers. Setting one or both of the limits to high values virtually disables the limit(s). Setting the size limit to low values has a bad effect on the editors performance. Avoid sizes below 100K. The undo buffer size is understood as "suggestion" only. Short time memory usage may exceed the limit. For example, buffer overflows created by @{" extras/undo " link M132} are tolerated to allow a redo @{" extras/redo " link M133}. TAB STANDARD Informs GoldED about the standard tab distance used by other editors (in saved files). Amiga standard is that tabs indent 8 positions. A few editors assume that tabs indent four positions. You'll recognize documents saved by those editors immediately: excessive indention of lines if loaded with GoldED. @endnode @node EXTRAS_OPTIONS_GLOBAL_VARIABLES "extras/options global/variables" @{b}extras/options global/variables @{ub} of: @{" options global " link M176} Configuration of user-defined variables: you may add an unlimited number of user-defined variables to GoldED. These variables can be read (@{" QUERY " link QUERY}) and set (@{" SET " link SET}) as if they were built-in variables. They can be used to control the state of menu checkmarks (@{" extras/options local/menu " link EXTRAS_OPTIONS_LOCAL_MENU}), too. User-defined variables have been created to support ARexx macro programmers: the main advantage compared to ARexx variables is that values are saved to the configuration (@{" extras/save preferences " link M177}). @endnode @node EXTRAS_OPTIONS_GLOBAL_GUI "extras/options global/gui" @{b}extras/options global/gui @{ub} of: @{" options global " link M176} DATE FORMAT Configures date strings (modifications don't affect existing date displays). Besides standard text, the following keywords can be used: %a - abbreviated weekday name %A - weekday name %b - abbreviated month name %B - month name %d - day number with leading 0s %D - same as "%m/%d/%y" %e - day number with leading spaces %j - julian date %m - month number with leading 0s %U - week number, taking Sunday as first day of week %W - week number, taking Monday as first day of week %w - weekday number %x - same as "%m/%d/%y" %y - year (two digits) %Y - year (four digits) WINDOW TITLE Format of window titles. The first "%s" found in this template is replaced by the file name at window creation time, the second "%s" is replaced by the filetype (@{" extras/options global/filetypes " link EXTRAS_OPTIONS_GLOBAL_FILETYPES}). ASL FILE REQUESTER Instructs GoldED to use the ASL file requester instead of the Reqtools file requester. Position and size of the ASL requester are saved to GoldED's configuration (@{" extras/save preferences " link M177}) while position and size of the Reqtools requester are set using the Reqtools preferences program. BRIEF MESSAGES Enable "brief messages" to make GoldED write simple messages (no options to be selected) to the window status bar instead of using a requester. CONFIRM BACKUPS Automatic backups have to be confirmed by you if this option is enabled (@{" extras/options global/misc " link EXTRAS_OPTIONS_GLOBAL_MISC}). CONFIRM ERRORS If set: Error requesters stop execution until the requester is confirmed. BEEP Error beep volume. @endnode @node M177 "extras/save preferences" @{b}extras/save preferences@{ub} of: @{" EXTRAS MENU " link EXTRAS_MENU} Saves configuration (@{" options local " link M175}, @{" options global " link M176}). @endnode @node MACRO_MENU "MACRO MENU" @{b} MACRO MENU @{ub} menu tree of macro menu @{" macros/session load " link M169} @{" macros/sequence save " link M151} @{" macros/session save " link M170} @{" macros/sequence play " link M152} @{" macros/macro edit " link M147} @{" macros/sequence play... " link M153} @{" macros/macro start " link M148} @{" macros/macros " link M154} @{" macros/macro execute " link M171} @{" macros/execute command " link M145} @{" macros/sequence record " link M149} @{" macros/execute line " link M162} @{" macros/sequence load " link M150} @endnode @node M169 "macros/session load" @{b}macros/session load@{ub} of: @{" MACRO MENU " link MACRO_MENU} Reads a session file saved by @{" macros/session save " link M170}: Text buffers and windows are restored according to the contents of the session file. All open text buffers are closed before the old session is restored. @endnode @node M170 "macros/session save" @{b}macros/session save@{ub} of: @{" MACRO MENU " link MACRO_MENU} A session description (position and size of text windows, list of frozen buffers) is saved to a session file. All modified text buffers are saved if requested. Use @{" macros/session load " link M169} to load a preset file created by this menu and thus restore the window layout of a previous session. @endnode @node M147 "macros/macro edit" @{b}macros/macro edit@{ub} of: @{" MACRO MENU " link MACRO_MENU} Changes to GoldED's macro directory and asks you for an ARexx macro to load. You should save your current text first or open a new window. GoldED's ARexx macros use the suffix ".ged" (e.g. number.ged). All macros made for GoldED must use a special protocol to register with GoldED before performing operations to prevent race conditions if user and macro are trying to control the editor simultaneously (see @{" ARexx port " link AREXX_PORT}). We have provided an empty macro (empty.ged) to be used as basis for your own development efforts. Simply load this macro, insert your code and save it under a new name. @endnode @node M148 "macros/macro start" @{b}macros/macro start@{ub} of: @{" MACRO MENU " link MACRO_MENU} Executes the current text as macro. You should save the text before you call this function: the copy on disk is executed, not the text in memory. All ARexx macros must start with a comment (/* ... */) to get recognized by the ARexx server as a valid macro. Macros not starting with a comment are (quietly) ignored. A script executed by this functions has its host set up properly already (i.e. you don't need an ADDRESS command). This manual doesn't contain a description of ARexx or an introduction into ARexx programming. Please contact your local bookstore. Included below is a simple demonstration example only: /* $VER: 1.0, ©1996 Dietmar Eilert. Empty GoldED macro */ OPTIONS RESULTS /* enable return codes */ if (LEFT(ADDRESS(), 6) ~= "GOLDED") then /* not started by GoldEd ? */ address 'GOLDED.1' 'LOCK CURRENT RELEASE=4' /* lock GUI, gain access */ if (RC ~= 0) then exit OPTIONS FAILAT 6 /* ignore warnings */ SIGNAL ON SYNTAX /* ensure clean exit */ /* ------------------------ INSERT YOUR CODE HERE: ------------------- */ 'REQUEST BODY="Hi, I''m an empty macro"' /* ---------------------------- END OF YOUR CODE --------------------- */ 'UNLOCK' /* VERY important: unlock GUI */ EXIT SYNTAX: SAY "Sorry, error line" SIGL ":" ERRORTEXT(RC) ":-(" 'UNLOCK' EXIT @endnode @node M171 "macros/macro execute" @{b}macros/macro execute@{ub} of: @{" MACRO MENU " link MACRO_MENU} Execute a macro file. ARexx macro examples are placed in the "GoldED:ARexx" drawer. This kind of macro execution should be used if you don't intend to assign the macro to a menu or a key (see @{" event definition " link EVENT_DEFINITION}). @endnode @node M149 "macros/sequence record" @{b}macros/sequence record@{ub} of: @{" MACRO MENU " link MACRO_MENU} Sequences Start (1st call) respectively stop (2nd call) recording of a sequence. This command usually is assigned to the SHIFT-F10 key, too. During recording all key presses and menu selections are recorded. Mouse movements and mouse clicks are not recorded. Use @{" macros/sequence play " link M152} to replay a recorded sequence. Use @{" macros/sequence save " link M151} to save the sequence to disk or @{" macros/sequence load " link M150} to load a sequence. Saved sequences can be assigned to keys and menus (@{" event definition " link EVENT_DEFINITION}). If a requester appears while recording you'll often be asked whether this requester should pop up in playback mode, too, or if the selections you made in the requester should be recoded to the macro directly. @endnode @node M150 "macros/sequence load" @{b}macros/sequence load@{ub} of: @{" MACRO MENU " link MACRO_MENU} Loads a recorded sequence @{" macros/sequence record " link M149}. @endnode @node M151 "macros/sequence save" @{b}macros/sequence save@{ub} of: @{" MACRO MENU " link MACRO_MENU} Saves recorded sequence, created by @{" macros/sequence record " link M149}. Sequences should be saved to golded:recordings, the file extension should be "*.seq". @endnode @node M152 "macros/sequence play" @{b}macros/sequence play@{ub} of: @{" MACRO MENU " link MACRO_MENU} Replays recorded sequence (see @{" macros/sequence record " link M149}). @endnode @node M153 "macros/sequence play..." @{b}macros/sequence play...@{ub} of: @{" MACRO MENU " link MACRO_MENU} Replays recorded sequence (see @{" macros/sequence record " link M149}) multiple times. Sequence playback stops if an error occurs (e.g. if the find function can't find the search pattern). @endnode @node M154 "macros/macros" @{b}macros/macros@{ub} of: @{" MACRO MENU " link MACRO_MENU} MACRO REVISION (by Marius Gröger) Updates version string, revises history: This function scans your text for a version string matching the format described in Commodore's programmers' style guide. The revision number is increased by one if a version string is found. Versions strings are embedded into programs to provide required information for the AmigaDOS VERSION command. The following format is supported: $VER . () Additionally, you are asked for a short comment about the new revision if a '$HISTORY:' section has been detected within the text. The comment is added at the top of the history list. Example text header understood by the REVISION macro: char *Version = "$VER: revision 0.8 (21 Jul 1993)"; /* $HISTORY: 18 Jul 1993 : 000.003 : added commandline args 18 Jul 1993 : 000.001 : initial release */ MACRO NUMBER LINES Numbers a text. You are asked for the start value and the step value to be used. Choosing 1000 and 10 would start numbering at 1000 (1000, 1010 ...). MACRO FOLD Folds marked lines (see @{" block/mark " link M172} on how to mark lines). You are asked for a comment to be used as fold header. Please read the @{" Folding " link M106} section of this manual if you are unfamiliar with GoldED's folding feature. MACRO C FUNCTION Inserts an empty function body (C style) into the text. You are asked for the function's name (e.g. "main") and the return type (e.g. UWORD). This macro accepts two BOOL arguments (TRUE, FALSE): one controls if a comment should be inserted before the function, the other controls if fold markers should be inserted, too. Default is that only a comment is inserted. Edit the menu to modify the defaults (@{" extras/options local/menu " link EXTRAS_OPTIONS_LOCAL_MENU}). MACRO C BLOCK Marks all lines between the nearest pair of curly brackets. @endnode @node M145 "macros/execute command" @{b}macros/execute command@{ub} Asks you for one of GoldED' internal commands to be executed (see list of @{" internal commands " link INTERNAL_COMMANDS}). This function is assigned to SHIFT ESC, too. Parsing is done by the OS function ReadArgs(): same syntax as used by most DOS commands (e.g. put strings into quotation marks). Example: INFO VERSION @endnode @node M162 "macros/execute line" @{b}macros/execute line@{ub} Executes the current line as DOS command. Useful to embed compiler calls (hidden as comments) into source codes. Included below is an example file header demonstrating how to embed the DICE-C compile command into a source code: /* ---------------------------------------------------------------- ED v3.0 - GoldED quick starter, ©1996 Dietmar Eilert. DICE: dcc main.c -// -proto -mRR -mi -r -2.0 -o ram:ED ------------------------------------------------------------------ */ @endnode @node M001 "About GoldED" @{b}About GoldED@{ub} Displays version information. Additionally, the name of GoldED's ARexx port and the screen name used by the editor are displayed. Screen created by GoldED always are public, i.e. you are invited to run other tasks on the same screen. Example: SHELL CON:0/11/640/100/Shell/screenGOLDED.1 ... opens a shell window on GoldED's screen (note that there is no space between the "screen" keyword and the screen's name "GOLDED.1"). @endnode @node KEYBOARD "Keyboard" @{b} Keyboard @{ub} @{" Cursor keys " link CURSOR_KEYS} @{" TAB key " link TAB_KEY} @{" HELP key " link HELP_KEY} @{" ESC key " link ESC_KEY} @{" RETURN key " link RETURN_KEY} @{" F-keys " link F-KEYS} @{" DEL key " link DEL_KEY} @{" SPACE key " link SPACE_KEY} Please read this chapter carefully if you want to take full advantage of this editor's features. Several useful functions assigned to keys are not available in the menu. Other functions are available in the menu, too, but processing of menus (and menu shortcuts) is considerably slower than processing keys. Keys usually perform different tasks depending on what qualifier key(s) are pressed simultaneously. Qualifier keys are SHIFT, ALT or CTRL. For example, the cursor keys offer seven different functions depending on what qualifiers are used. Key bindings are not fixed; use @{" extras/options local/keyboard " link EXTRAS_OPTIONS_LOCAL_KEYBOARD} to adjust them to your likings. This manual describes the default setup. @endnode @node CURSOR_KEYS "Cursor keys" @{b} Cursor keys @{ub} CURSOR UP/DOWN + ALT This sequence provides fast scrolling (up or down). Cursor position doesn't change (e.g. the cursor will stay in the middle of the screen if it was there before you started scrolling). CURSOR UP/DOWN + SHIFT Moves the cursor to the next (DOWN) or the previous (UP) page. Pages do overlap to make navigation more comfortable. CURSOR UP/DOWN + CTRL Fast jump: the cursor moves to the next quarter of your text. Useful to roughly set a new position before using fast/normal scrolling for fine tuning. CURSOR LEFT/RIGHT + ALT Shifts the display area to the left or right (without moving the cursor). Usually the display is shifted automatically if the cursor reaches the right/left window borders. LEFT/RIGHT + CTRL Indents marked block (@{" block/mark " link M172}). Hold down the SHIFT key simultaneously to indent one tab position instead of one character. LEFT/RIGHT + SHIFT Moves the cursor to the beginning of the next (RIGHT) or the previous word (LEFT). LEFT/RIGHT + SHIFT + ALT Moves the cursor to the end of the current/next (RIGHT) respectively previous (LEFT) word. @endnode @node HELP_KEY "HELP key" @{b} HELP key @{ub} HELP Folds/unfolds current section: Unfold if cursor is placed over a fold header (see @{" Folding " link M106}), otherwise look for fold markers & fold lines between markers (cursor must bee placed between a fold start marker and a fold end marker). HELP + CTRL Fold/unfold the whole text: Unfold all folded sections if cursor is placed on a fold header (see @{" Folding " link M106}), otherwise fold all sections surrounded by fold markers. @endnode @node TAB_KEY "TAB key" @{b} TAB key @{ub} TAB (+ SHIFT) Moves the cursor to next tab position. This editor supports regular tabs (e.g. every 4th column), fixed tabs (any column you want) and dynamic tabs. Use @{" extras/options local/tabs " link EXTRAS_OPTIONS_LOCAL_TABS} to set mode & tab positions. Press the SHIFT key simultaneously if you want to jump to the previous instead of to the next tab position (backtab). Tabs are either solid (i.e. they behave as if they were a sequence of spaces) or light (i.e. they simply move the cursor without inserting any character). TAB + ALT (+ SHIFT) Holding down ALT while you press the tab key instructs GoldED to use fixed tabs no matter what tab mode has been selected. @endnode @node RETURN_KEY "RETURN key" @{b} RETURN key @{ub} RETURN Splits current line at cursor position and moves the cursor to the next line. This editor supports @{" AutoIndention " link EXTRAS_OPTIONS_LOCAL_INDENT}: if you press the RETURN key, the current line's indention is used as default indention for the next line. Additionally, context sensitive indention (SmartIndention] is available: indention depends on the text. RETURN + SHIFT Similar to RETURN except that the cursor line is not splitted at the cursor position. RETURN + CTRL Inserts an empty line before the cursor line. @endnode @node DEL_KEY "DEL key" @{b} DEL key @{ub} DELETE (+ SHIFT) Deletes character under the cursor and shifts the rest of line one position to the left. Deletes until the end of line if the SHIFT key is held down simultaneously. DELETE + CTRL Deletes the current line. You can recall up to 50 deleted lines using @{" extras/line insert " link M131} command. Similar to @{" extras/line remove " link M130} but faster (no menu handling required). DELETE + ALT Deletes the current word. You can recall up to 100 deleted words (DEL-ALT-SHIFT). DELETE + ALT + SHIFT Reinsert deleted word (see above). @endnode @node ESC_KEY "ESC key" @{b} ESC key @{ub} AutoCompletion Completes the word under the cursor based on the user dictionary (@{" extras/options local/words " link EXTRAS_OPTIONS_LOCAL_WORDS}). Example usage: type 'TIG', then press the ESC key. 'TIG' is replaced by 'TAG_IGNORE' if the C-dictionary is present. GoldED uses a pattern matching algorithm to find appropriate dictionary entries: you can use other abbreviations than 'TIG', too (e.g. 'TAGI'). However, the first letter of the word to be completed must match the first letter of the full form. The number of letters required to ensure unique identification depends on the dictionary size (keep your dictionary small). Try GoldED's @{" IntelliSense " link SPACE_KEY} function if you don't like the idea of maintaining a dictionary. @endnode @node SPACE_KEY "SPACE key" @{b} SPACE key @{ub} IntelliSense One major disadvantage of GoldED's dictionary based completion function (@{" APC " link M076}) is that a dictionary has to be maintained. The IntelliSense feature doesn't suffer from this restriction: it completes words based on the context, scanning the document to find a possible expanded form. Type the first few letters of the word, then call the IntelliSense function (assigned to SHIFT-SPACE): the word is completed. The number of letters to be typed depends on the context and requires some experience. Technical information: Strategy and speed of the IntelliSense function are controlled by a "trigger parameter" and can be adjusted if you edit the menu/keyboard configuration. The trigger parameter determines how thoroughly the context is searched. Default is 4. Useful values range from 1 to 10. The smaller, the faster. @endnode @node F-KEYS "F-Keys" @{b} F-Keys @{ub} Function keys are configurable (as are all other keys): use the @{" extras/options local/keyboard " link EXTRAS_OPTIONS_LOCAL_KEYBOARD} requester to configure the keyboard. However, some commodities consume all F-keys (including the F-key commodity): GoldED will not recognize or handle function keys if such a commodity is installed. Default mappings of the function keys are: key description see -------------------------------------------------------- F1 open file @{" project/open " link M005} F2 merge file @{" project/insert " link M009} F3 print file @{" project/print " link M018} F4 hide block @{" block/mark hide " link M022} F5 mark line @{" block/mark " link M172} F6 find next @{" search/find next " link M067} F7 next page @{" cursor keys " link CURSOR_KEYS} F8 set insert mode @{" layout/insert mode " link M108} F9 toggle tab mode @{" layout/solid tabs " link M109} F10 play macro @{" macros/sequence play " link M152} SHIFT & key description see -------------------------------------------------------- F1 save as @{" project/save as " link M014} F2 save as XPK @{" project/save as XPK " link M015} F3 quit @{" project/quit buffer " link M020} F4 clear text @{" project/clear window " link M003} F5 mark line @{" block/mark " link M172} F6 replace @{" search/replace " link M069} F7 page up @{" cursor keys " link CURSOR_KEYS} F8 overwrite mode @{" layout/insert mode " link M108} F9 project setup @{" extras/options local/project " link EXTRAS_OPTIONS_LOCAL_PROJECT} F10 record macro @{" macros/sequence record " link M149} @endnode @node AREXX_PORT "ARexx port" @{b} ARexx port @{ub} ARexx macros vs. recorded sequences GoldED supports two methods of automated control: ARexx scripts and recorded sequences. ARexx scripts are programs similar to programming languages like BASIC. They are started by GoldED (examples: @{" macros/macros " link M154}) but are actually executed by the ARexx server RexxMast (part of the Amiga operating system, usually started in the startup-sequence). The ARexx server will run the script line-by-line and send messages to GoldED if it detects commands it doesn't understand (commands intended to be handled by GoldED). ARexx is a very powerful method to automate control. However, this approach requires at least some basic knowledge of ARexx. If you need automated control but are not interested in ARexx you might want to use GoldED's ability to record command sequences instead: Enable recording using @{" macros/sequence record " link M149} and perform a sequence of commands. In other words: make the editor "learn" how to do it. Once you have recorded a sequence you may replay it as many times as you like (see @{" macros/sequence play " link M152}). You may save sequences @{" macros/sequence save " link M151}) or assign them to events like menus or keystrokes. Sequences are far less powerful than ARexx script. But they are more handy. The following sections describe the editor's ARexx interface. We expect that you are familiar with ARexx basics, i.e. you should know about the purpose of ARexx, how to write scripts, how to talk to applications, etc. ARexx basics It is important that ARexx macros made for GoldED follow a special protocol to avoid collisions with user input. The protocol consists of the following steps: 1. @{" Select a host " link SELECT_A_HOST} 2. @{" Lock a window " link LOCK_A_WINDOW} 3. @{" Do your job " link DO_YOUR_JOB} 4. @{" unlock GUI " link UNLOCK_GUI} @endnode @node SELECT_A_HOST "Select a host" @{b}Select a host @{ub} If you run ARexx scripts from within the editor (i.e. if you set up menu items of type 'ARexx' or if you execute the current text as macro using @{" macros/macro start " link M148}), any script commands which are not part of ARexx itself are sent to the editor (the 'host') automatically. However, if your script is started by a different program (e.g. rx), it will have to select a port (GoldED's port) for communication on its own: use ADDRESS for this purpose. Port name The editor's ARexx port is called "GOLDED.1" if the editor is run only once. The port of a further editor task would be "GOLDED.2". Select @{" about GoldED " link M001} (or use the @{" QUERY " link QUERY} command (@{" macros/execute command " link M145}: QUERY HOST) if you want to know the current port name and screen name. Most users will never run more than one GoldED task, so assuming that the port is "GOLDED.1" should work in most cases. @endnode @node LOCK_A_WINDOW "Lock a window" @{b}Lock a window @{ub} Your script will have to tell the editor what window is used first: send the @{" LOCK " link LOCK} command (e.g. LOCK CURRENT RELEASE=4 to lock the current window). This commands locks the complete user interface: the user will not be able interfere with your macro. The return code has to be checked: RC=0 signals that GoldED has been locked successfully. Take care of unlocking the GUI before your scripts exits: the user will not be able to use the editor if a script exits without unlocking the GUI. Programming errors in macros could leave the editor in a locked state: use error trapping commands provided by ARexx to solve this problem. In interactive mode, results of the @{" QUERY " link QUERY} command are displayed in a window (e.g. LINE=3). In ARexx mode (after a @{" LOCK " link LOCK}), results are not displayed but written to the variable RESULT without prefixed variable name (e.g. 3). @endnode @node DO_YOUR_JOB "Do your Job" @{b}Do your Job @{ub} You can use any of the editor's @{" internal commands " link INTERNAL_COMMANDS} within your macro. Please keep in mind that commands send from ARexx to GoldED are parsed twice: first by the ARexx server while executing the script, then by GoldED using the ReadArgs() function of the DOS library. This sometimes screws things up (especially as far as quotes are concerned). Suggestion: Write the lines of your script as if you were talking directly to GoldED: quote strings, command names uppercase (step 1). Then put the lines to be sent to GoldED into single quotation marks to mark them as commands (step 2). Finally double single quotation marks within these lines to prevent ARexx from regarding them as string delimiters (step 3). Example: step 1: REQUEST BODY "Hi, I'm an empty macro" step 2: 'REQUEST BODY "Hi, I'm an empty macro"' step 3: 'REQUEST BODY "Hi, I''m an empty macro"' Usually GoldED returns command results to your script using the special ARexx variable RESULT (provided that you have asked for results using the ARexx command OPTIONS RESULTS). Some commands (e.g. @{" QUERY " link QUERY}) allow you to specify a variable to receive the result (VAR/K option). Example: 'QUERY ABSLINE VAR=LINE'. No result is returned if a command fails. Instead, the special variable RC is set to the error level: 5 = warning, 10 = error, 20 = fatal error (RC is 0 if a command has been processed successfully). Additional error explanations usually are available in the special variable RC2. @endnode @node UNLOCK_GUI "Unlock GUI" @{b}Unlock GUI @{ub} An ARexx script must @{" unlock " link UNLOCK} the GUI before it terminates, if a prior call to @{" Lock " link LOCK} (see @{" Lock a window " link LOCK_A_WINDOW}) has been successful. It mustn't use unlock if a prior attempt to lock has failed. Omitting unlock will leave the editor dead-locked, so take care to unlock the GUI even if your script breaks (maybe due to a syntax error). This can be achieved using the error handling facilities of ARexx (e.g. SIGNAL or OPTION FAILAT). Just have a look at the script examples in the golded:arexx drawer. As a last resort the Unlock macro (GoldED drawer) is provided: doubleclick at its icon to unlock all editors. @endnode @node INTERNAL_COMMANDS "Internal commands" @{b} Internal commands @{ub} GoldED offers a set of about 250 commands and options (see @{" Command list " link COMMAND_LIST}), supported by all interfaces of GoldED: you may use them in ARexx macros, bind them to menu items (see @{" extras/options local/menu " link EXTRAS_OPTIONS_LOCAL_MENU}), attach them to keys (@{" extras/options local/keyboard " link EXTRAS_OPTIONS_LOCAL_KEYBOARD}) or execute them directly using @{" macros/execute command " link M145}. DOS rules apply as far as arguments are concerned since GoldED uses the ReadArgs() function of the Amiga operating system: strings containing spaces must be quoted, option and keywords may be uppercase or lowercase. The line below is an example for the syntax descriptions found on the following pages: PRINT FORCE/S,ITALICS/K,ALL/S,LPI/N,CONFIG/K The PRINT command obviously accepts five options: FORCE, ITALICS, ALL, LPI and CONFIG. Usage of these options depends on the option type, indicated by a single letter after the slash: some options are used to pass numbers to GoldED, other introduce strings, etc. All options can be used simultaneously. Options followed by "/A" may not be omitted. The option FORCE is a switch (/S = "switch"): it makes the print command behave in a special way (described in this manual) if this option is specified. No further arguments are expected. PRINT ALL The second option ITALICS introduces a keyword/value pair (/K = "key"): an argument is expected after the option name. The argument type depends on the context (the command) and is described in this manual: some commands expect a text argument, other commands expect boolean values (TRUE or FALSE). Example: PRINT ALL ITALICS=TRUE The equality sign may be omitted. Quotation marks can not be used directly in text arguments: the editor would misinterpret them as "end of string" marker. Put a star in front of the quotation mark (*") to tell the parser that the next quotation mark doesn't mark the end of a string (single "*" have to written as "**"). The LPI option in the example above introduces a numerical (/N) argument. Example: PRINT ALL LPI=10. The equality sign may be omitted. The valid argument range depends on the command. Further option types not shown in the example are "\F" (accepts rest of line as string, no quotation marks required) and "\M" (accepts multiple strings separated by spaces). @endnode @node COMMAND_LIST "Command list" @{b}Command list @{ub} (use: see @{" internal commands " link INTERNAL_COMMANDS}): @{" API " link API} @{" DPAGE " link DPAGE} @{" HELP " link HELP} @{" NAME " link NAME} @{" REDO " link REDO} @{" TABS " link TABS} @{" BACK " link BACK} @{" ELSE " link ELSE} @{" HUNTER " link HUNTER} @{" NEW " link NEW} @{" REFRESH " link REFRESH} @{" TASK " link TASK} @{" BEEP " link BEEP} @{" ENDIF " link ENDIF} @{" IF " link IF} @{" NEXT " link NEXT} @{" REMAP " link REMAP} @{" TEXT " link TEXT} @{" BIND " link BIND} @{" ENDWORD " link ENDWORD} @{" INDENT " link INDENT} @{" NOTIFY " link NOTIFY} @{" REPLACE " link REPLACE} @{" TMPLATE " link TMPLATE} @{" BITS " link BITS} @{" EXALL " link EXALL} @{" INFO " link INFO} @{" OPEN " link OPEN} @{" REQLIST " link REQLIST} @{" TYPE " link TYPE} @{" BLOCK " link BLOCK} @{" EXTRACT " link EXTRACT} @{" INSERT " link INSERT} @{" PATH " link PATH} @{" REQUEST " link REQUEST} @{" UJUMP " link UJUMP} @{" BRACKET " link BRACKET} @{" FDOWN " link FDOWN} @{" KEY " link KEY} @{" PC " link PC} @{" RIGHT " link RIGHT} @{" UNDO " link UNDO} @{" BREAKPT " link BREAKPT} @{" FILE " link FILE} @{" LAYOUT " link LAYOUT} @{" PHRASE " link PHRASE} @{" RUN " link RUN} @{" UNLOCK " link UNLOCK} @{" CLIP " link CLIP} @{" FIND " link FIND} @{" LEFT " link LEFT} @{" PING " link PING} @{" RX " link RX} @{" UP " link UP} @{" CMD " link CMD} @{" FIRST " link FIRST} @{" LINES " link LINES} @{" PONG " link PONG} @{" SAVE " link SAVE} @{" UPAGE " link UPAGE} @{" CODE " link CODE} @{" FIX " link FIX} @{" LOCK " link LOCK} @{" POP " link POP} @{" SCREEN " link SCREEN} @{" USE " link USE} @{" COLON " link COLON} @{" FOLD " link FOLD} @{" MACRO " link MACRO} @{" PREFS " link PREFS} @{" SESSION " link SESSION} @{" VIEW " link VIEW} @{" CR " link CR} @{" FORMAT " link FORMAT} @{" MARK " link MARK} @{" PREV " link PREV} @{" SET " link SET} @{" VLEFT " link VLEFT} @{" DEBUG " link DEBUG} @{" FREEZE " link FREEZE} @{" MAXDOWN " link MAXDOWN} @{" PREVEND " link PREVEND} @{" SHIFT " link SHIFT} @{" VRIGHT " link VRIGHT} @{" DEL " link DEL} @{" FUNC " link FUNC} @{" MAXUP " link MAXUP} @{" PRINT " link PRINT} @{" SMARTCR " link SMARTCR} @{" WINDOW " link WINDOW} @{" DELETE " link DELETE} @{" FUP " link FUP} @{" MENUS " link MENUS} @{" PROJECT " link PROJECT} @{" STOP " link STOP} @{" WORD " link WORD} @{" DIR " link DIR} @{" GOTO " link GOTO} @{" MISC " link MISC} @{" PUSH " link PUSH} @{" SUFFIX " link SUFFIX} @{" XREF " link XREF} @{" DJUMP " link DJUMP} @{" GREP " link GREP} @{" MORE " link MORE} @{" QUERY " link QUERY} @{" SYNTAX " link SYNTAX} @{" DOWN " link DOWN} @{" GUI " link GUI} @{" MOUSE " link MOUSE} @{" QUIT " link QUIT} @{" TAB " link TAB} @endnode @node API "API" @{b}API @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- API ASK/S open API configuration requester @endnode @node BACK "BACK" @{b}BACK @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- BACK (no options) backspace operation SMART/S backspace over marked word deletes word @endnode @node BEEP "BEEP" @{b}BEEP @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- BEEP (no options) beep @endnode @node BIND "BIND" @{b}BIND @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- BIND ASK/S open keyboard configuration requester @endnode @node BITS "BITS" @{b}BITS @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- BITS ASK/S open a requester to edit protection bits R/K set readable bit (BOOL) W/K set writable bit (BOOL) D/K set deletable bit (BOOL) S/K set script bit (BOOL) COMMENT/K set comment (STRING) @endnode @node BLOCK "BLOCK" @{b}BLOCK @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- BLOCK UPPER/S convert block to uppercase LOWER/S convert block to lowercase SORT/S sort block CHKCASE/S sort block: consider case CURSOR/S sort option: compare starts at cursor position COPY/S copy block to cursor position MOVE/S move block to cursor position HIDE/S hide marker after operation @endnode @node BRACKET "BRACKET" @{b}BRACKET @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- BRACKET MATCH/S move cursor to matching bracket CHECK/S check use of () in current line TWINS/K bracket type to be considered (STRING, e.g. "()") @endnode @node BREAKPT "BREAKPT" @{b}BREAKPT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description ---------------------------------------------------------------------------- BREAKPT LINE/N line number (ULONG: 1, ...) LOCKED/S use locked debugger line numbers UNFOLD/S unfold STATE/N new breakpoint state (UWORD: 0, 1) TOGGLE/S toggle breakpoint state NEXT/S move cursor to next breakpoint PREV/S move cursor to prev breakpoint SAVE/S save breakpoints ALL/N set breakpoints (UWORD: 0, 1) CLEANUP/S delete all breakpoints in all buffers FILE/K file name FORMAT/K debugger data format (STRING) DATA/N debugger data (APTR) ELEMENTS/N debugger data size (ULONG) NONOTIFY/S don't notify debugger QUERY/K breakpoint array request (STRING) Comment: The options FILE/K, FORMAT/K, DATA/N, ELEMENTS/N, NONOTIFY/S and QUERY/K are reserved for use by debuggers. @endnode @node CLIP "CLIP" @{b}CLIP @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- CLIP CUT/S move block to clipboard COPY/S copy block to clipboard PASTE/S insert clipboard contents at cursor position VPASTE/S vertical clipboard paste UNIT/N clipboard unit to use (UBYTE); defaults is 0 @endnode @node CMD "CMD" @{b}CMD @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- CMD (no options) open command requester @endnode @node CODE "CODE" @{b}CODE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- CODE SHOW/S show ASCII code of character under cursor SET/N insert code (UBYTE) ASK/S ask for ASCII code to be inserted TABLE/S open character set table requester TOGGLE/S toggle case of character under cursor UPPER/S convert character under cursor to uppercase LOWER/S convert character under cursor to lowercase Comment: The SET option is influenced by current writing mode: in insert mode a character is inserted, in overwrite mode the character under the cursor is overwritten. @endnode @node COLON "COLON" @{b}COLON @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- COLON (no options) insert semicolon and possibly a CR (return) Comment: Suggested use is mapping to the ;-Key. Useful for C/C++ programmers. The editor tries to figure out whether a CR should be inserted (e.g. no CR is inserted if the semicolon is part of a 'for' statement). Press CTRL simultaneously to disable CR insertion temporarily. @endnode @node CR "CR" @{b}CR @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- CR (no options) command; splits line at cursor position Comment: see @{" extras/options local/indent " link EXTRAS_OPTIONS_LOCAL_INDENT} @endnode @node DEBUG "DEBUG" @{b}DEBUG @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- DEBUG START/S start debugger support STOP/S stop debugger support PORT/K ARexx port of debugger (STRING) Comment: Reserved for usage by external debugger. @endnode @node DEL "DEL" @{b}DEL @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- DEL (no options) deletes character under cursor @endnode @node DELETE "DELETE" @{b}DELETE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- DELETE WORD/S delete next word EOW/S delete until end of word SMART/S consider white space settings EOL/S delete until end of line LEFT/S delete until beginning of line LINE/S delete current line BLOCK/S delete block COLUMN/S delete column (see AT/N) from block AT/N column to be deleted (UWORD); defaults to current Comment: The last 100 deleted words (WORD/S) can be reinserted using @{" INSERT " link INSERT} (INSERT WORD). @endnode @node DIR "DIR" @{b}DIR @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- DIR ASK/S open requester to set current directory NEW/F set current directory (STRING) CURRENT/S use document's path as new current directory Comment: See @{" project/current dir " link M161} @endnode @node DJUMP "DJUMP" @{b}DJUMP @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- DJUMP (no options) jump to bottom of window/next page Comment: Cursor jumps to the window's last line if placed above that line so far. Jumps to the next page otherwise. Compare: @{" DPAGE " link DPAGE}. @endnode @node DOWN "DOWN" @{b}DOWN @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- DOWN (no options) move cursor one line down @endnode @node DPAGE "DPAGE" @{b}DPAGE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- DPAGE (no options) show next page (compare: @{" DJUMP " link DJUMP}) @endnode @node ELSE "ELSE" @{b}ELSE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- else (no options) introduces alternative @{" IF " link IF} section @endnode @node ENDIF "ENDIF" @{b}ENDIF @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- ENDIF (no options) terminates @{" IF " link IF} @endnode @node ENDWORD "ENDWORD" @{b}ENDWORD @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- ENDWORD (no options) move cursor to end of word @endnode @node EXALL "EXALL" @{b}EXALL @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- EXALL (no options) examine text Comment: To be used within ARexx macros only. Used to update variables related to text statistics (see @{" QUERY " link QUERY}). @endnode @node EXTRACT "EXTRACT" @{b}EXTRACT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- EXTRACT (no options) extract file name under cursor VAR/K where to put the result: ARexx variable (STRING) LEFT/K left delimiter(s) (STRING); e.g. "<[(" RIGHT/K right delimiter(s) (STRING); e.g. ">])" Comment: Left & right delimiter strings must be of paired and of the same length. Priority is from left to right. @endnode @node FDOWN "FDOWN" @{b}FDOWN @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- FDOWN (no options) scroll down (fast) @endnode @node FILE "FILE" @{b}FILE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- FILE NAME/K file to deleted/searched (STRING) DELETE/S delete file RENAME/S rename file FORCE/S don't ask for confirmation SEARCH/K search this path for specified file (STRING) VAR/K where to put the result: ARexx variable (STRING) NEWDIR/K create directory (STRING) Comment: Delete-protected files are not deleted unless the FORCE mode is used. @endnode @node FIND "FIND" @{b}FIND @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- FIND STRING/K search pattern (STRING) BLOCK/S search marked text INDEX/S list found strings in a requester WILD/K set wildcard mode (BOOL) COUNT/S count pattern (doesn't affect cursor position) PREV/S jump to previous occurrence NEXT/S jump to next occurrence FIRST/S jump to first occurrence ASK/S open requester CASE/K case (in)sensitive (BOOL) QUIET/S don't complain about missing pattern ('not found') WORDS/K look for whole words only ? (BOOL) @endnode @node FIRST "FIRST" @{b}FIRST @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- FIRST (no options) move to beginning of line (see @{" GOTO " link GOTO}) @endnode @node FIX "FIX" @{b}FIX @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- FIX VAR/K/A ARexx variable name (STRING) Comment: To be used within macros only. Fixes the contents of the given ARexx string variable to make it "parser-proof" (e.g. handles embedded '"'); compare @{" internal commands " link INTERNAL_COMMANDS}). @endnode @node FOLD "FOLD" @{b}FOLD @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- FOLD OPEN/K open fold or (ALL/S specified) folds (BOOL) ALL/S consider all lines TOGGLE/S toggle fold (open/close) @endnode @node FORMAT "FORMAT" @{b}FORMAT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- FORMAT LINES/S format paragraph MARK/S format block LEFT/S mode: left -aligned RIGHT/S mode: right-aligned BLOCK/S mode: justified CENTER/S mode: centered @endnode @node FREEZE "FREEZE" @{b}FREEZE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- FREEZE CURRENT/S hide current window ASK/S show list of hidden buffers SWAP/S swap current/next frozen window PREV/S swap backwards ADD/M load file(s) directly to frozen list @endnode @node FUNC "FUNC" @{b}FUNC @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- FUNC (no options) open Quickref requester MODE/K mode selection: scanner name (STRING) SMART/S mode selection: automatic according to file name INDEX/S mode selection: standard search CURRENT/S search reference for word under cursor UNFOLD/K examine folds (BOOL) SORT/S sort list @endnode @node FUP "FUP" @{b}FUP @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- FUP (no options) scroll backwards (fast) @endnode @node GOTO "GOTO" @{b}GOTO @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- GOTO LINE/N line number to go to (ULONG: 1, ...) COLUMN/N column to go to (UWORD: 1, ...); see @{" FIRST " link FIRST} UNFOLD/K unfold if necessary ? (BOOL) TOP/S go to first line of text BOTTOM/S go to last line of text OTHEREND/S toggle position CHANGE/S go to last change ASK/S ask for line number to go to EOL/S move cursor after last character of line INDENT/S move cursor to first character of line BFIRST/S go to beginning of block BLAST/S go to end of block STEP/N move cursor left/right (WORD) TOF/S move cursor to first line of screen BOF/S move cursor to last line of screen BYTE/N byte offset to go to (LF's included) LOCKED/S use locked debugger line numbers Comment: Line numbers are expected to be absolute numbers if UNFOLD=TRUE is set. Folded blocks count as a single line in UNFOLD=FALSE mode. @endnode @node GREP "GREP" @{b}GREP @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- GREP STRING/K string to search project files for (STRING) ASK/S ask for string to search for case/K case sensitive search ? (BOOL) @endnode @node GUI "GUI" @{b}GUI @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- GUI ASK/S open GUI configuration window @endnode @node HELP "HELP" @{b}HELP @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- HELP CATALOG/K guide file (STRING) TOPIC/K node to be displayed (STRING, e.g. "MAIN") STOP/S stop guide task Comment: The menu's guide is used (@{" extras/options local/menu " link EXTRAS_OPTIONS_LOCAL_MENU}) if no guide is specified. @endnode @node HUNTER "HUNTER" @{b}HUNTER @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- HUNTER ASK/S open hunter configuration window CURRENT/S hunt (i.e. search & open) filename under cursor NAME/K search this file (STRING) DEEP/K scan subdirectories ? (BOOL) @endnode @node IF "IF" @{b}IF @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- IF VAR/K internal variable (STRING); see @{" Variables " link QUERY} MATCH/K pattern (STRING) NOT/S negate result Comment: Disables menu/mouse/keyboard related command execution until the next @{" ENDIF " link ENDIF} if the contents of VAR/K doesn't match the pattern. @endnode @node INDENT "INDENT" @{b}INDENT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- INDENT ASK/S open indention configuration requester @endnode @node INFO "INFO" @{b}INFO @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- INFO VERSION/S show version USER/S show copyright requester TEXT/S show statistics ERROR/S show last error @endnode @node INSERT "INSERT" @{b}INSERT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- INSERT LINE/S insert a line BLOCK/S insert into block (see the following options) COLUMN/S BLOCK/S: insert empty column; see AT/N STRING/K BLOCK/S: insert text; see AT/N (STRING) AT/N BLOCK/S: column where to insert (UWORD) APPEND/S BLOCK/S: append text to marked lines WORD/S reinsert deleted word (see @{" DELETE " link DELETE}) PATH/S insert filename (file requester selection) @endnode @node KEY "KEY" @{b}KEY @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- KEY EVENT/K input event description (STRING) RAW/S event is a plain character sequence Comment: See @{" input events " link INPUT_EVENTS} for details @endnode @node LAYOUT "LAYOUT" @{b}LAYOUT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- LAYOUT ASK/S open layout configuration requester LEFT/S use cursor position as left border RIGHT/S use cursor position as right border Comment: Borders can be set using @{" SET " link SET}, too. @endnode @node LEFT "LEFT" @{b}LEFT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- LEFT (no options) move cursor one position to the left @endnode @node LINES "LINES" @{b}LINES @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- LINES JOIN/S join current line & next line SWAP/S swap current line <-> next line DOUBLE/S duplicate current line @endnode @node LOCK "LOCK" @{b}LOCK @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- LOCK CURRENT/S lock current window NAME/K lock this window (STRING: file name) QUIET/S don't activate window RELEASE/N required editor version (ULONG, this release: 4) Comment: To be used within ARexx macros. Return code has to be checked. An @{" UNLOCK " link UNLOCK} command must follow later to avoid deadlocks. @{" LOCK " link LOCK} can not be nested: a single @{" UNLOCK " link UNLOCK} unlocks all locks. This call moves GoldED's screen to the front. @endnode @node MACRO "MACRO" @{b}MACRO @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- MACRO RECORD/S start/stop sequence recording PLAY/S play recorded sequence LOOPS/N number of playback loops (UWORD); defaults to 1 ASK/S ask for number of loops FILE/K sequence file to load/write (STRING) SAVE/S save recorded sequence LOAD/S load a sequence Comment: Sequence playback is disabled during execution of ARexx macros. @endnode @node MARK "MARK" @{b}MARK @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- MARK HIDE/S hide mark PARAGRAPHE/S mark paragraph WORD/S mark word under cursor SET/S set marker start/end BEGIN/S set beginning of block END/S set end of block FLOW/K should cursor movements size block ? (BOOL) EXCLUDE/K cursor part of block ? (BOOL) LINE/S resolution = lines COLUMN/S resolution = characters STRICT/S only SPC (ASCII 32) is regarded as word delimiter @endnode @node MAXDOWN "MAXDOWN" @{b}MAXDOWN @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- MAXDOWN (no options) move cursor to next quarter of document @endnode @node MAXUP "MAXUP" @{b}MAXUP @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- MAXUP (no options) move cursor to previous quarter of document @endnode @node MENUS "MENUS" @{b}MENUS @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- MENUS ASK/S open menu configuration requester @endnode @node MISC "MISC" @{b}MISC @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- MISC ASK/S open misc configuration requester @endnode @node MORE "MORE" @{b}MORE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- MORE (no options) open further window NAME/K window name (STRING); default: "unnamed" FILETYPE/K overrides automatic file type selection (STRING) SMART/S use current window if empty @endnode @node MOUSE "MOUSE" @{b}MOUSE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- MOUSE ASK/S open mouse preferences requester SET/S move cursor to mouse position MARK/S mark block (to be used in conjunction with SET/S) LINE/S mark whole lines only DRAG/S activate drag & drop support Comment: SET/S, MARK/S, DRAG/S and LINE/S are reserved for mouse configuration. @endnode @node NAME "NAME" @{b}NAME @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- NAME ASK/S display text name requester NEW/F set new text name (STRING) @endnode @node NEW "NEW" @{b}NEW @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- NEW (no option) clear text (user is asked for confirmation) FORCE/S no user confirmation NONAME/S reset name to 'unnamed' @endnode @node NEXT "NEXT" @{b}NEXT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- NEXT (no options) move cursor to next word @endnode @node NOTIFY "NOTIFY" @{b}NOTIFY @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- NOTIFY FILE/K/A file to be monitored (STRING) START/S start monitoring STOP/S stop monitoring CHECK/S number of write accesses since last check (UWORD) MACRO/K macro to be executed upon write access (STRING) Comment: Provides access to the notification mechanism of AmigaDOS. The file name is passed as argument to the macro. @endnode @node OPEN "OPEN" @{b}OPEN @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- OPEN NAME/M file(s) to open (STRING or STRINGS) FAST/S fast loading NEW/S open new window for each file AGAIN/S reload current file APPEND/S append file(s) to current text INSERT/S insert file(s) into current text ASK/S display file requester QUIET/S don't complain about missing files PATH/K default path for file requester (STRING) OLDPATH/S use path of current text as default path SMART/S use current window if empty RAW/S don't expand tabs to spaces FORCE/S don't display "file modified" warning FILETYPE/K overrides automatic file type selection (STRING) Comment: Returns window handle in ARexx mode. The window handle may be used to activate a window later on (see @{" WINDOW " link WINDOW}). @endnode @node PATH "PATH" @{b}PATH @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- PATH ASK/S open hunter configuration requester @endnode @node PC "PC" @{b}PC @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- PC COLUMN/N column (UWORD: 1, ...) LINE/N/A line (UWORD: 1, ...) FILE/K buffer name/file name (STRING) PRESENT/S activate window HIGHLIGHT/S highlight line LOCKED/S use locked debugger line numbers UNFOLD/S unfold ONEWINDOW/S don't use multiple windows while debugging FREEZE/S hide unused buffers (default: unload buffers) FILETYPE/K overrides filetype detection (STRING) FORMAT/K debugger data format (STRING) DATA/N debugger data (APTR) ELEMENTS/N debugger data size (ULONG) Comment: Reserved for usage by debugger. @endnode @node PHRASE "PHRASE" @{b}PHRASE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- PHRASE ASK/S open dictionary configuration requester CURRENT/S complete current word SMART/S activate @{" IntelliSense " link SPACE_KEY} completion ADD/K add keyword to dictionary (STRING) TRIGGER/N IntelliSense trigger parameter (UWORD: 1...10) @endnode @node PING "PING" @{b}PING @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- PING SLOT/N save cursor position to slot (UWORD: 0...9) Comment: see @{" PONG " link PONG} @endnode @node PONG "PONG" @{b}PONG @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- PONG SLOT/A/N recall cursor positions (UWORD 0-9) Comment: GoldED offers ten bookmark storages (0-9) for each window. Slot 0 usually is reserved for use within ARexx scripts (see @{" PING " link PING}). @endnode @node POP "POP" @{b}POP @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- POP (no options) move line from text to pick/push buffer Comment: The pick/push buffer can hold up to 50 entries (lines). It is a last-in-first-out buffer. @endnode @node PREFS "PREFS" @{b}PREFS @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- PREFS ASK/S open configuration requester LOCAL/S local configuration GLOBAL/S global configuration SAVE/S save configuration PAGE/N preselect notebook page (UWORD: 0, ...) @endnode @node PREV "PREV" @{b}PREV @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- PREV (no options) move cursor to previous word @endnode @node PREVEND "PREVEND" @{b}PREVEND @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- PREVEND (no options) move cursor to end of previous word @endnode @node PRINT "PRINT" @{b}PRINT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- PRINT ASK/S open printer configuration requester FORCE/S no "print ?" confirmation requester WINDOW/S print hardcopy of window ALL/S text printing: print complete file BLOCK/S text printing: print block @endnode @node PROJECT "PROJECT" @{b}PROJECT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- PROJECT ASK/S open project configuration requester ADD/K add source file (STRING) DEL/N remove a source file (UWORD: 0, ...) CLR/S clear project list LIST/N copy this list (struct List *) @endnode @node PUSH "PUSH" @{b}PUSH @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- PUSH (no options) insert last line of @{" push " link PUSH}/@{" pop " link POP} buffer into text KEEP/S do not delete line from buffer @endnode @node QUERY "QUERY" @{b}QUERY @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- QUERY NAME/A variable name (STRING) VAR/K variable to hold result (STRING); default: RESULT Comment: Returns value of the specified internal variable. This function may be used in macros and in interactive mode (see @{" macros/execute command " link M145}). In interactive mode a requester displays the result. In non-interactive mode the result is stored in a variable. You may specify the name of an ARexx variable (VAR/K, defaults to RESULT) or of an environment variable (first letter of variable name = '$') to hold the result. Valid variable names are: Variables Name Type Description =========================================================================== ABAK BOOL AutoBackups enabled ? ABSLINE READONLY NUMBER absolute line number; see LINE ABSLINES READONLY NUMBER absolute lines; see LINES ABSNAME STRING absolute file name (expanded); see DOC ACENTER BOOL center new windows ? AFOLD BOOL AutoFold after loading ? ALEFT BOOL layout: use current indention ? ALT READONLY BOOL ALT key pressed ? ANSI READONLY NUMBER number of non-ASCII-characters (*) ANYCHAR READONLY BOOL current line not empty ? ANYFOLDS READONLY BOOL any folds in document ? ANYTEXT READONLY BOOL current window not empty ? ARRANGE BOOL AutoArrange windows ? ASKBAK BOOL confirm backups ? AUTOINDENT BOOL keep indention after CR ? BACKUP BOOL create backups ? BAKDIR STRING backup directory BLOCK READONLY NUMBER block type (0=hidden 1=lines 2=characters) BLOCKB READONLY NUMBER block end (line) BLOCKR READONLY NUMBER block end (column) BLOCKX READONLY NUMBER block start (column) BLOCKY READONLY NUMBER block start (line) BOLD BOOL bold printing ? BRACKET BOOL automatic () checks ? BUFFER READONLY STRING contents of current line BYTES READONLY NUMBER text size (bytes) (*) CAPS READONLY BOOL CAPSLOCK key pressed ? CAT READONLY STRING catalog used by GoldED CHKCASE BOOL AutoCase enabled ? CODE READONLY NUMBER ASCII code of character under cursor COLUMN READONLY NUMBER cursor column (1, ...) COLUMNS READONLY NUMBER window width (1, ...); see WINW CON READONLY STRING recommended console description string CTRL READONLY BOOL CTRL key pressed ? CURRENT READONLY NUMBER input buffer (char *) DATE STRING date DEBUG BOOL save breakpoints ? DEBUGGER BOOL breakpoint display visible ? DOC STRING document's name, path included (see ABSNAME) DOUBLE BOOL double printing ? EOL BOOL EOL wrap ? ERR READONLY STRING last error message EXCLUDE BOOL cursor inside/outside marker while marking FILE STRING file name (without path); see DOC FIND STRING search pattern FOLDA STRING fold marker: start FOLDB STRING fold marker: end FOLDS READONLY NUMBER number of folds in text (*) FUNC READONLY STRING QuickFunc scanner HANDLE READONLY NUMBER internal window handle HMI NUMBER printer line feed (0 - 2) HOST READONLY STRING ARexx port name INBLOCK READONLY BOOL cursor in block ? INFO STRING icon file (*.info) INFOS BOOL create icons ? INSERT BOOL insert mode ? ITALICS BOOL italics printing ? LEFT NUMBER layout: left border LEN READONLY NUMBER length of current line LEVEL READONLY NUMBER syntax level of character under cursor LINE READONLY NUMBER line number (relative); ABSLINE LINES READONLY NUMBER lines (relative); see ABSLINES LPI NUMBER lines/inch: 6 lpi or 8 lpi (UWORD: 0, 1) LQ BOOL letter quality printing ? MARKED READONLY BOOL block marked ? See BLOCK MAXLEN READONLY NUMBER length of longest line (*) MODIFY READONLY BOOL text modified ? NODEMO READONLY BOOL registered version ? NUMPAD BOOL numpad configurable ? ORDINAL READONLY NUMBER window number (0, ...) OUTPUT STRING output console OVERWRITE BOOL overwrite files ? PARSER READONLY STRING syntax parser name PASSWORD STRING password PATH STRING document's path; see DOC PICKED READONLY NUMBER number of lines in pick/push buffer PREVIEW BOOL preview active ? PRJLIST READONLY NUMBER project files (struct List *) PROG READONLY STRING program name RC READONLY NUMBER error code of last command READONLY BOOL document write protected ? REFORMAT BOOL reformat during word wrap ? REM STRING file comment RESET BOOL reset printer before output ? RESULT READONLY STRING result string of last command RIGHT NUMBER layout: right border ROWS READONLY NUMBER window height; see WINH RPLC STRING replace text RXDEBUG BOOL output ARexx debug information ? SCREEN READONLY STRING public screen name SCREENH READONLY NUMBER screen height SCREENW READONLY NUMBER screen width SHIFT READONLY BOOL SHIFT key pressed ? SMARTINDENT BOOL context-sensitive indention ? SOLID BOOL tabs insert spaces ? SPC STRING white space definition string STDLINE READONLY BOOL current line not write-protected ? SYNTAX BOOL syntax highlighting activated ? TAB NUMBER tab distance (keyboard) TABFILE NUMBER tab distance (import/export) TABMODE NUMBER tab mode (0...2) TEMPLATES BOOL templates activated ? TIME READONLY STRING time TOOLBAR BOOL toolbar visible ? TOPLINE READONLY NUMBER number of first line in window (relative) TYPE STRING filetype; example (write access): ".c" UNFOLD BOOL GOTO unfolds text ? USECASE BOOL case-sensitive search ? USER READONLY USER user name VER READONLY STRING version string VERSION READONLY NUMBER version code WILDCARDS BOOL wildcard search ? WINDOWS READONLY NUMBER open windows WINH READONLY NUMBER window height (units = pixels) WINW READONLY NUMBER window width (units = pixels) WORD READONLY STRING word under cursor WORDS READONLY NUMBER number of words in text (*) WRAP BOOL wordWrap activated ? X READONLY NUMBER window position (X) XPK STRING selected XPK compressor Y READONLY NUMBER window position (Y) (*) Variable values are not valid until execution of the @{" EXALL " link EXALL} command. @endnode @node QUIT "QUIT" @{b}QUIT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- QUIT (no option) close current window FORCE/S don't ask for confirmation UNLOAD/S close window, unload editor (see @{" HotKey " link M020}) ALL/S close all open text buffers @endnode @node REDO "REDO" @{b}REDO @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- REDO LAST/S undo last @{" undo " link UNDO} @endnode @node REFRESH "REFRESH" @{b}REFRESH @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- REFRESH PAGE/S redraw current text LINE/S redraw current line @endnode @node REMAP "REMAP" @{b}REMAP @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- REMAP TABLE/K use this conversion file to remap text (STRING) ASK/S open remap requester @endnode @node REPLACE "REPLACE" @{b}REPLACE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- REPLACE STRING/K search pattern (STRING) BY/K replace pattern (STRING) WILD/K set wildcard mode (BOOL) NEXT/S replace next occurrence of pattern (*) ALL/S replace all occurrences of pattern (*) BLOCK/S replace pattern within marked lines (*) ASK/S open find/replace requester CASE/K set case sensitive mode (BOOL) QUIET/S don't complain about missing pattern ('not found') WORDS/K look for whole words only ? (BOOL) CONFIRM/K ask for confirmation ? (BOOL) (*) only one of these options may be specified. @endnode @node REQLIST "REQLIST" @{b}REQLIST @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- REQLIST ENTRY/M/A strings to be displayed as listview (STRINGS) SORT/S sort list VAR/K ARexx variable: where to put the result (STRING) Comment: Presents a listview. Selected string is returned. @endnode @node REQUEST "REQUEST" @{b}REQUEST @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- REQUEST HIDE/K disable requesters (BOOL) DEFAULT/K default if requesters are disabled (UWORD) BODY/K body text, lines separated by '|' (STRING) BUTTON/K button(s) text, separated by '|' (STRING) TITLE/K requester title (STRING) LONG/S ask for a number MIN/N lower limit for number (WORD) MAX/N upper limit for number/characters (WORD) OLD/K default value (STRING) FILE/S ask for a file SAVE/S put ASL file requester into SAVE mode PATH/K default path if asking for a file (STRING) MASK/K file requester mask (e.g."#?.c") (STRING) VAR/K ARexx variable: where to put the result (STRING) STRING/S ask for a string STATUS/K text to display in status line (STRING) STAY/S turn off automatic status line refresh KEY/S ask for key (returns code and qualifier) PROBLEM/K error message to be displayed (STRING) Comment: HIDE/K may be used in macros only; re-enable requesters before before the macro is terminated. @endnode @node RIGHT "RIGHT" @{b}RIGHT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- RIGHT (no options) move cursor one position to the right @endnode @node RUN "RUN" @{b}RUN @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- RUN CMD/K run this program (STRING) DIR/K current path (STRING); default: path of text LINE/S execute current line of text PRIO/N priority to be used (WORD: -3...3) STACK/N stack to be used (ULONG) ASYNC/S run program asynchronously OUTPUT/K output (STRING) SHANGHAI/N temporary shanghai time: seconds (UWORD) WAITPORT/K wait for appearance of this port (STRING) SECONDS/N WAITPORT timeout; defaults to 5 seconds (UWORD) @endnode @node RX "RX" @{b}RX @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- RX CMD/K command to be send to PORT/K (STRING) SYNC/S send in synchronous mode (default: asynchronous) ASK/S ask for command PORT/K destination: default is "AREXX" (STRING) MACRO/K macro to execute if PORT is not valid (STRING) Comment: The macro is called with the command string as first argument. Usage similar to the AmigaDOS command RX if you set the port to AREXX: Commands in '...' are interpreted as commands, commands in "..." are interpreted as macro names. @endnode @node SAVE "SAVE" @{b}SAVE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- SAVE BLOCK/S save block only ALL/S save complete file BUFFERS/S all modified buffers are save FORCE/S no "overwrite ?" requester SMART/S don't save unmodified file(s) NAME/K file name (where to save) (STRING) EXPORT/S don't rename buffer ASK/S open save-as requester EXIT/S close window if save operation is successful CRUNCH/S compress file (XPK) while saving it NOLF/S don't save linefeeds after text lines Comment: NOLF should be used carefully since the editor's line length is limited. Loading a text without linefeeds may cause a line length overflow. @endnode @node SCREEN "SCREEN" @{b}SCREEN @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- SCREEN ASK/S open display mode configuration requester ICONIFY/S iconify FRONT/S move GoldED's screen to the front BACK/S move GoldED's screen to the back NOSIZE/S use standard screen size @endnode @node SESSION "SESSION" @{b}SESSION @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- SESSION CONFIG/K name of a session file (STRING) LOAD/S load session file SAVE/S save session file QUIET/S save modified buffers without confirmation NOSAVE/S don't save modified text buffers @endnode @node SET "SET" @{b}SET @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- SET NAME/K variable to be set (STRING): @{" Variables " link QUERY} VALUE/K new value (STRING) @endnode @node SHIFT "SHIFT" @{b}SHIFT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- SHIFT LEFT/S shift to the left RIGHT/S shift to the right (indent) COLUMNS/N indention: number of columns (UWORD) TAB/S set shifting distance to tab size ASK/S open requester (left/right shifting) LINE/S indent line under cursor (default: block) @endnode @node SMARTCR "SMARTCR" @{b}SMARTCR @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- SMARTCR (no options) return (line is not splitted at cursor position) @endnode @node STOP "STOP" @{b}STOP @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- STOP (no options) stop command execution @endnode @node SUFFIX "SUFFIX" @{b}SUFFIX @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- SUFFIX STRING/K file name (STRING) SUFFIX/K desired suffix (STRING, e.g. ".c") @endnode @node SYNTAX "SYNTAX" @{b}SYNTAX @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- SYNTAX ASK/S open syntax highlighting configuration requester UNPARSE/S reset parser cache for current line ALL/S reset parser cache for all lines @endnode @node TAB "TAB" @{b}TAB @{ub} command option description --------------------------------------------------------------------------- TAB (no option) standard tab BACK/S backwards @endnode @node TABS "TABS" @{b}TABS @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- TABS ASK/S open tab configuration requester @endnode @node TASK "TASK" @{b}TASK @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- TASK WAIT/N wait interval (1/50 sec) (UWORD) BENCH/S run graphics benchmark @endnode @node TEXT "TEXT" @{b}TEXT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- TEXT T/K text to be inserted at cursor position (STRING) VAR/K variable to be inserted; see @{" QUERY " link QUERY} (STRING) STAY/S don't move cursor while inserting text CR/S append linefeed to text Comment: Use *" within T/K to insert quotation marks. Single "*" have to have written as "**". @endnode @node TMPLATE "TMPLATE" @{b}TMPLATE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- TMPLATE ASK/S open templates configuration requester CHECK/S check word under cursor @endnode @node TYPE "TYPE" @{b}TYPE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- TYPE RESET/S autodetect filetype of current text @endnode @node UJUMP "UJUMP" @{b}UJUMP @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- UJUMP (no options) jump to beginning of window/previous page Comment: Cursor jumps to the windows's first line if placed below that line so far. Jumps to previous page if placed in line one already. Compare: @{" UPAGE " link UPAGE}. @endnode @node UNDO "UNDO" @{b}UNDO @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- UNDO LAST/S undo last operation FLUSH/S free undo data of current text @endnode @node UNLOCK "UNLOCK" @{b}UNLOCK @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- UNLOCK (no option) unlock GUI; to be used after @{" LOCK " link LOCK} DELAY/S unlock GUI, delay until exit of GoldED STICKY/S unlock GUI, delay until current window is closed Comment: The DELAY/STICKY options are reserved for use by external applications (e.g. the @{" QuickStarter " link GETTING_STARTED}). They provide ways and means to synchronize with GoldED. @endnode @node UP "UP" @{b}UP @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- UP (no options) move cursor one line up @endnode @node UPAGE "UPAGE" @{b}UPAGE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- UPAGE (no options) show previous page (compare @{" UJUMP " link UJUMP}) @endnode @node USE "USE" @{b}USE @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- USE (no options) accept current line Comment: To be used within ARexx macros only. After having written directly to the memory area of the current line (which is dangerous) you have to call this function to make GoldED accept your changes. Use QUERY CURRENT (see @{" QUERY " link QUERY}) to get a pointer to the current line's buffer. It is not possible to change the length of the current line by poking into the line buffer. @endnode @node VIEW "VIEW" @{b}VIEW @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- VIEW LEFT/S shift view left RIGHT/S shift view right COLUMNS/N distance (UWORD); defaults to 5 columns Comment: @{" VLEFT " link VLEFT} and @{" VRIGHT " link VRIGHT} provide a better performance and therefore should be preferred. @endnode @node VLEFT "VLEFT" @{b}VLEFT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- VLEFT (none) shift view 5 columns left @endnode @node VRIGHT "VRIGHT" @{b}VRIGHT @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- VRIGHT (none) shift view 5 columns right @endnode @node WINDOW "WINDOW" @{b}WINDOW @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- WINDOW MAX/S maximize current window CENTER/S center current window on screen ARRANGE/N arrange windows (0: vertical, 1: horizontal) ZIP/S zip window USE/K activate named window/file (STRING) FORCE/S load named file if necessary (see USE/K) FILETYPE/K overrides filetype detection (STRING) WIDTH/N resize window width (UWORD) HEIGHT/N resize window height (UWORD) X/N set window's x position (UWORD) Y/N set window's y position (UWORD) NEXT/S activate next window PREV/S activate previous window RECOVER/S redraw window HANDLE/N activate window using its handle (ULONG) ORDINAL/N activate 1st , 2nd, ... window (ULONG: 0, ...) QUIET/S NEXT/USE/ORDINAL: leave window in the background SNAP/S use current window's dimensions as default size Comment: A window handle is returned by the @{" OPEN " link OPEN} function and by @{" QUERY " link QUERY} (QUERY HANDLE). @endnode @node WORD "WORD" @{b}WORD @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- WORD UPPER/S convert word under cursor to uppercase LOWER/S convert word under cursor to lowercase @endnode @node XREF "XREF" @{b}XREF @{ub} Description of @{" internal commands " link INTERNAL_COMMANDS} command option description --------------------------------------------------------------------------- XREF CURRENT/S find/open reference file related to current word PHRASE/K find/open file related to this phrase (STRING) ASK/S ask for topic CHECK/S just determine whether a reference is available PROTECT/S write-protect reference windows ? @endnode @node INPUT_EVENTS "Input events" @{b} Input events @{ub} Input event insertion GoldED's @{" KEY " link KEY} command may be used to insert "input events" (e.g. keystrokes) into intuition's global input stream. Inserting events makes the current application (the active GoldED window) behave as if the user had performed the described action. A key event description string EVENT/K may consist of plain text or plain text mixed with "event descriptions" in angle brackets (e.g. ""). You would have to specify the RAW/S option if you want to insert plain text containing angle brackets. Examples: KEY EVENT="hello world" KEY EVENT="hello world" KEY EVENT="--->" RAW If you do not specify RAW, event descriptions like "" are not treated as plain text but translated into input events ( would act as if the return key were pressed). The following expression outlines the format of description strings: A) CLASS may be one of the following (assuming if none is given): rawkey ....................... this is a keyboard event rawmouse ...................... this is a mouse button event B) QUALIFIER(s) may be one or more of ... shift ......................... shift control ....................... ctrl capslock ...................... capslock alt ........................... alt lcommand ...................... left Amiga rcommand ...................... right Amiga numericpad .................... numeric pad leftbutton .................... left mouse button rbutton ....................... right moue button C) KEY may either be a plain character or ... space ......................... space backspace ..................... backspace tab ........................... tab enter ......................... enter return ........................ return esc ........................... esc del ........................... delete up ............................ cursor up down .......................... cursor down right ......................... cursor right left .......................... cursor left f1 - f10 ...................... function key help .......................... help Examples: KEY EVENT="" KEY EVENT="" KEY EVENT="" KEY EVENT="" @endnode @node TOOLS "TOOLS" @{b} TOOLS @{ub} GoldED is shipped with a couple of useful tools supporting your daily work with this package; some of them are described on the next pages: @{" HiSpeed " link HISPEED} ..... Printer utility for LaserJet and DeskJet printers @{" Recover " link RECOVER} ..... Recover lost text buffers after a system crash @endnode @node HISPEED "HiSpeed" @{" Tools " link TOOLS}: @{b} HiSpeed @{ub} The HiSpeed printer utility has been designed for PCL printers like Hewlett Packard's DeskJet and LaserJet family. It can be used to reduce the amount of paper when printing large files since it is able to print with small typefaces and to multiple columns on both sides of a sheet. Up to 8 A4 pages are redirected to a single A4 sheet. It is fast. Speed depends on your DeskJet model; DeskJet+: about 4 pages/minute if you switch to HiSpeed mode. You will like this program if you have to do a lot of printing. HiSpeed is shareware. The registered version is not part of GoldED Light but it is part of the GoldED Pro(/NET) package; see @{" Register GoldED " link REGISTER_GOLDED}. Some of HiSpeed's features are: o workbench interface o spooler (job list) o AppWindow/AppIcon support o HiSpeed mode: fast printing o shell interface o preview (WYSIWYG) o ARexx port o many fonts supported o single or double sided printing o page headers o descending printing available o numbering of lines o free layout - e.g. two columns o index/appendix creation o ANSI ESC sequences supported o portrait/landscape o Linefeed adjustable o book mode to print A5 books @{" hardware requirements " link HARDWARE_REQUIREMENTS} @{" book " link BOOK} @{" configuration " link CONFIGURATION} @{" cover " link COVER} @{" page header " link PAGE_HEADER} @{" single/doublesided " link SINGLE_DOUBLESIDED} @{" printing " link PRINTING} @{" perforate " link PERFORATE} @{" settings & units " link SETTINGS_&_UNITS} @{" output device " link OUTPUT_DEVICE} @{" page layout " link PAGE_LAYOUT} @{" shell interface " link SHELL_INTERFACE} @{" page preview " link PAGE_PREVIEW} @{" ARexx port HiSpeed " link AREXX_PORT_HISPEED} @{" files " link FILES} @{" ARexx commands HiSpeed " link AREXX_COMMANDS_HISPEED} @{" ESC-sequences " link ESC-SEQUENCES} @{" macros " link MACROS} @{" character height " link CHARACTER_HEIGHT} @{" filter " link FILTER} @{" landscape " link LANDSCAPE} @{" sleep-icon " link SLEEP-ICON} @endnode @node HARDWARE_REQUIREMENTS "HARDWARE REQUIREMENTS" @{" HiSpeed " link HISPEED}: @{b} HARDWARE REQUIREMENTS @{ub} Amiga, at least 512K, OS2.04, DeskJet/Laser. You'll need a softfont cartridge (a RAM expansion card) for your DeskJet if you want to use all functions of this program - otherwise you are limited to the printer's ROM fonts. @endnode @node CONFIGURATION "CONFIGURATION" @{" HiSpeed " link HISPEED}: @{b} CONFIGURATION @{ub} HiSpeed has to be configured according to your printer - just choose your model from the list of supported printers. Set the RAM gadget to 'RAM' if your printer is equipped with a RAM expansion cartridge (DeskJet) or doesn't require additional RAM in order to use softfonts. The number of available typefaces depends on Printer/RAM selection - while a standard DeskJet without RAM is limited to one typeface, a DeskJet 550C with RAM will offer 4 portrait fonts and 3 landscape fonts. If you printer is not supported by HiSpeed so far, you'll have use the SetUp option to register your printer with HiSpeed: HiSpeed may be adjusted to any PCL printer and its fonts. If your printer supports softfonts (DeskJet printers don't unless they are equipped with an additional RAM cartridge) you may use your own fonts with HiSpeed, too. Unfortunately setup isn't that easy. You should have read your printer's manual at least once. You have to be familiar with the use of PCL ESC codes. A bad setup will cause TROUBLE. Example session Select the SETUP gadget. The setup requester will appear, giving you the opportunity to set up a printer and its fonts. On the left side available printers are listed. Select NEW (next to the list of printers) if your model isn't available so far: A new printer 'unnamed' will be added to the list. Use the string gadget below the list to change this name to whatever you like. Toggle the 'DeskJet tray' gadget to ON if your printer's paper tray looks like that of a DeskJet (HiSpeed will use this information to give you some hints if it asks you to reinsert ejected pages). Toggle the 'faces down' gadget to ON if the sheets are eject faces down by your printer. Some printers (especially laser printers) are not able to use the first 5 to 7 mm of a page for output - turn OFFSET HEADER on in these cases. Finally you should select a file pattern used when selecting cover files (e.g. if you don't want HiSpeed to list color files). A pattern like '#?' would display all files while "~(#?.CYMK)" would suppress cover files made for the DeskJet 550C. The following extensions are supported: CYM files (color, used by DJ500C/DJ550C)...... #?.CYM CYMK files (color, used by DJ550C) ............ #?.CYMK B&W files (PCL level 3) ...................... no suffix After having selected a printer, its fonts are displayed in the font listview on the right side. This list initially is empty if you have added a new printer. Use NEW (next to the font list) to add a new font (i.e. to register one of the printer's font with HiSpeed). New fonts are named 'unnamed'; use the string gadget below the list to edit the name. Having done this you have to enter a description of the font - HiSpeed needs to know the font's basic characteristics (e.g. its size). Only fixed width fonts are supported. Have a look at your printer's manual to determine all required values. Example: If you own a DeskJet 550C, look for a manual section called 'Specifications'. There you'll find a list of available fonts supported by your printer. Among many other entries a 'LetterGothic' font with a font size of 6 points is described. According to the manual this fixed width font is available in portrait/landscape mode. Spacing is 24 cpi (characters per inch): Typeface: LetterGothic Point size: 6p Spacing: 24 cpi (fixed width) Orientation: portrait or landscape Use these specifications to set up HiSpeed's font entry: Toggle the type gadget to 'any direction' since portrait as well as landscape mode are supported. The HMI gadget is used to set the font's spacing. Units are 1/1200", so you would enter 50 (1200/24 = 50). Specify the LPI (lines per inch) value for single linefeeds using the LPI gadget. Suggestion: Set the LPI value to 72/ (e.g. 72/6 = 12). While the HMI value has to be chosen as precisely as possible, the LPI may be set more roughly. If your font isn't a built-in one but a softfont file, enter the file name(s) using the NORM/ITAL gadgets (upright respectively italics version). Leave these gadgets empty if the font is a ROM font. Softfonts have to use the ECMA latin character set; the printer will refuse your fonts if they use a different character set (e.g. PC8). Finally we have to provide a PCL ESC sequence used by HiSpeed to activate the font. Have a look at you printer's documentation as far as PCL sequences (PCL = printer command language) are concerned. The sequence will have to set typeface, spacing and character height (point size). It mustn't set any other attribute. Example: ESC(s6v24h6T ESC introduces a PCL sequence. The last character of a PCL command has to be uppercase ('T') while all other characters (except ESC) have to be lowercase. The font height is set to 6 points by '(s6v'. '24h' sets spacing to 24 cpi. Finally '6T' selects a typeface called LetterGothic. Don't use spaces within PCL sequences. Pay attention to case. @endnode @node PAGE_HEADER "PAGE HEADER" @{" HiSpeed " link HISPEED}: @{b} PAGE HEADER @{ub} It is possible to change the text (or the style) of page headers using the setup requester, too. The header text is not printed directly. Instead, it is interpreted before output: after scanning it for keywords (like \DATE), found keywords are replaced by their 'current value' (e.g. the date). Put a text into quotation marks if you don't want to have it interpreted. HiSpeed does support the following keywords: keyword example description ---------------------------------------------------------- "" "Hi!" print quoted text \DATE "Date: " \DATE insert date \TIME "Time: " \TIME insert time \NAME "File: " \NAME insert file name \PATH "Path: " \PATH insert fully qualified name \PAGE "Page: " \PAGE insert page number $ $USER insert environment variable (*) (*): see AmigaDOS manual (SETENV command) @endnode @node PRINTING "PRINTING" @{" HiSpeed " link HISPEED}: @{b} PRINTING @{ub} The files ("jobs") to be printed are displayed as "job list" (bottom left). Scroll through that list using the arrow gadgets. Use 'Add' to add new jobs. A file requester will appear. You may add more than one file at once by holding down the shift key during selection. There are other methods to add files to the job list, too: Just drag a file's icon over the HiSpeed window. Or set up a file via ARexx. Or let a file drop on HiSpeed's sleep icon (however, if you do so, it will be printed at once but not included into the job list). Use job to clear the complete list respectively the 'del' gadget to remove a single file. Select "SORT A" if you want to have the list sorted alphabetically. Use "sort #" to sort by size. Start printing by clicking at the print gadget. Jobs are processed from top to bottom. If none has been set up so far, you will be asked for a file. You may stop printing by closing the progress window (HiSpeed will ask for confirmation). Downloads mustn't be interrupted for this would confuse the printer. It is possible to print single sheets, too, using the 'page' gadget. This option is useful to reprint some lost passages of a large job (e.g. if ink cartridge went empty during printing). If you want a page header (file name, page number), activate "PAGE HEADER". See 'SetUp' on how to set up the header text (for example it is possible to have time/date strings or environment variables inserted). If you print more than one file, you might want an index: switch to header & index. @endnode @node SETTINGS_&_UNITS "SETTINGS & UNITS" @{" HiSpeed " link HISPEED}: @{b} SETTINGS & UNITS @{ub} Usually you won't have to change paper dimensions. Default settings are valid for output to A4. The left border should be sufficient for perforating. Paper dimension settings offered by the main window of HiSpeed only describe the area used for printing (e.g. if you want to restrict output to the upper half of a sheet, do it here). The actual physical paper size is set by a different requester (setup requester): usually to A4 in Europe respectively to US-Letter/US-Legal in the US. Use "RESET ALL" go get the defaults. All settings are written to HiSpeed's configuration file by . Be careful as far as the dimensions setup is concerned - wrong values (especially insufficient borders) will confuse HiSpeed. HiSpeed v5.0 or better does write its configuration file to "ENVARC:HISPEED" unless a different directory is specified. Former releases used to write to 's:' or directly to 'envarc:'. Those files should be removed. Units are 'mm' with exception of the block size display - which uses to display text block dimensions. The block size depends on border/paper settings as well as font selection (font width). @endnode @node PAGE_LAYOUT "PAGE LAYOUT" @{" HiSpeed " link HISPEED}: @{b} PAGE LAYOUT @{ub} Layout definition (the number/arrangement of text blocks on a page) is of great importance for a pleasing result: The more block columns you order, the less characters will fit into a block line. If the block with is too small, lines have to be splitted. Block width depends on the selected font, too. If you select Courier 6 (this is the only font offered by the standard DeskJet), no more than 75 characters will fit into a single line provided you use a layout of two columns. In generally 75 characters is not enough. You might use the Adjust-LF option in this case: It will remove LF (line feed) codes. However, don't use this option with formatted data (tables or source codes). Edit contents of the dx/dy gadgets to set the distance between columns/rows. Enable the 'separate' option if you want to have a line drawn between two block rows. Blocks are linked from left to right and from top to bottom. @endnode @node PAGE_PREVIEW "PAGE PREVIEW" @{" HiSpeed " link HISPEED}: @{b} PAGE PREVIEW @{ub} HiSpeed offers two ways of quality/volume precalculation without having to waste a single page of paper: Use 'preview' to order a WYSIWYG preview. Or use 'scan' to get some statistics ( e.g. required number of sheets). While scanning is faster than a preview, the latter is more useful to get a general impression of the output. Use the cursor keys to flip through pages in preview mode. Use the help key to open the statistics requester. The distortions value of the statistics display is related to text lines that were to long to fit into a single block line (i.e. lines that had to be splitted). Possible values are from 0% to 100%. This value should be as low as possible since splitted lines don't look that well. Decide for a smaller font, use less columns or decrease margins to avoid distortions. @endnode @node FILES "FILES" @{" HiSpeed " link HISPEED}: @{b} FILES @{ub} HiSpeed has been designed to process ASCII files with or without ANSI codes. Lines have to be terminated by LF codes. Additional CR codes (used by MS-DOS software) are recognized and removed. Turn the MS-DOS option ON if you want to print MS-DOS files (maybe received from a BBS system) - HiSpeed will use a different character set to cope with these files. Softfonts are not available in MS-DOS mode because they have been developed with the Amiga character set (ecma latin) in mind. @endnode @node ESC-SEQUENCES "ESC-SEQUENCES" @{" HiSpeed " link HISPEED}: @{b} ESC-SEQUENCES @{ub} Switch to HiSpeed mode or turn PERFORM ESC off if you want to have ESC-Sequences ignored (and thus speed up output). If you enable FFs (form feeds), every detected FF-code (12 dez) results in a new text block. You better have a prescan to estimate paper needs - some files (especially library manuals using the AutoDoc format) send FF codes after each paragraph. HiSpeed mode does imply draft printing/normal stroke. Other modes use LQ printing, draft printing or bold printing. These settings stay valid until they are turned off by appropriate ANSI ESC sequences being part of the file(s) to print. The are not affected by ESC sequences if 'perform ESC' is off. @endnode @node CHARACTER_HEIGHT "CHARACTER HEIGHT" @{" HiSpeed " link HISPEED}: @{b} CHARACTER HEIGHT @{ub} Several fonts are available (number depends on your printer model), e.g. LinePrinter-5, LinePrinter-6, Courier-6 and LetterGothic-5. You should use LinePrinter-5 or LGothic-6, if the average line width of your text files is greater than 80 characters. LinePrinter-6 looks better but block width might become too small (e.g. 80 characters if you choose a layout of two columns). Courier-6 is the worst choice: no more than about 75 characters will fit into a line if you decide for a layout of two columns. @endnode @node LANDSCAPE "LANDSCAPE" @{" HiSpeed " link HISPEED}: @{b} LANDSCAPE @{ub} All DeskJet models apart from the original DeskJet do support landscape printing. The number of fonts available in landscape mode depends on your printer model. @endnode @node BOOK "BOOK" @{" HiSpeed " link HISPEED}: @{b} BOOK @{ub} Output is sorted in a way to support manual creation if you enable book mode: simply fold printed sheets to get A5 manuals. HiSpeed relies on the user's settings: if you set the block width to 120 columns but the actual (average) line width of a text is 60 characters, output won't look good (columns are not centered). Simply run the AdjustBook macro after switching to book mode to have the layout adjusted automatically. Since book mode usually implies landscape printing (not supported by the original DeskJet), this mode should only be used with a DeskJet+ or better. @endnode @node COVER "COVER" @{" HiSpeed " link HISPEED}: @{b} COVER @{ub} Select 'cover' to order printing of A5 covers. Several templates are available. Quality of cover printing depends on the LQ/NLQ gadget. This function requires the XPK library. Coverfiles actually are PCL files (i.e. files usually sent to a printer). They have been crunched using xDrop of the XPK package. Recommended file extension for color files is *.CYM (DeskJet 500C) or *.CYMK (DeskJet 550C). Have a look at the templates directory if you are looking for the Pagestream documents used to create the original HS cover files. @endnode @node SINGLE_DOUBLESIDED "SINGLE/DOUBLESIDED" @{" HiSpeed " link HISPEED}: @{b} SINGLE/DOUBLESIDED @{ub} Single sided as well as double sided printing is available. Don't get confused if HiSpeed appears to eject empty pages in double sided mode - those pages are required by the second pass of printing. Consider HiSpeed's advice if the program asks you to reinsert ejected pages in order to print the backsides. Handling depends on printing mode ! @endnode @node PERFORATE "PERFORATE" @{" HiSpeed " link HISPEED}: @{b} PERFORATE @{ub} Enable 'perforate' if you want to have perforation considered during double-sided output, i.e. to make HiSpeed swap left/right borders if necessary to ensure a sufficient left margin. @endnode @node OUTPUT_DEVICE "OUTPUT DEVICE" @{" HiSpeed " link HISPEED}: @{b} OUTPUT DEVICE @{ub} Use the port gadget to select desired output device respectively output file. If output goes to a file, HiSpeed will create two files (even/odd pages) using file extension 1 respectively 2. File 1 has to be sent to your printer before file 2 later on since (only) this file will keep softfont data. @endnode @node SHELL_INTERFACE "SHELL INTERFACE" @{" HiSpeed " link HISPEED}: @{b} SHELL INTERFACE @{ub} HiSpeed can be used from a shell or be run by any program providing a shell startup. Supported arguments are according to the template scheme used by the AmigaDOS manual (the following options perform the same action as the gadgets of HiSpeed's GUI, so please have a look at the explanations above for details): FILE/M, S=SLEEP/S, D=DOUBLE/K, RESET/S, H=HEADER/K, N=NUMBER/K, H=HISPEED/K, P=PREVIEW/S, C=SCAN/S, L=LANDSCAPE/K, B=BOOK/K, F=FEED/N, I=INDEX/S, LQ/S, EDV/S, BOLD/S, ADJUSTLF/K, SORTNAME/S, SORTSIZE/S, ASL/S, SCREEN/K, PERFORATE/K, CMDFILE/K, MSDOS/K, UNI/K, ANSI/K, PARSEFF/K, FILTER/K, PAR:/S, SER:/S @endnode @node AREXX_PORT_HISPEED "AREXX PORT HISPEED" @{" HiSpeed " link HISPEED}: @{b} AREXX PORT HISPEED @{ub} HiSpeed offers an ARexx port. Using ARexx it is possible to add headers to files before printing them, to format a text, to generate an appendix or to move HiSpeed to a different (public) screen. Usually you can operate the program from WB and ARexx (@{" AREXX COMMANDS HISPEED " link AREXX_COMMANDS_HISPEED}) simultaneously. @endnode @node AREXX_COMMANDS_HISPEED "ARexx commands HiSpeed" @{" HiSpeed " link HISPEED}: @{b} ARexx commands HiSpeed @{ub} Group 1 - set variables (SET); Syntax: SET SET LAYOUTX ....................... set columns SET LAYOUTY .......................... set rows SET LEFT ............................... left border SET RIGHT .............................. right border SET TOP ................................ top border SET BOTTOM ............................. bottom border SET DX ................................. space between columns SET DY ................................. space between rows SET COPIES ......................... copies (max. 99) SET FEED <0...12>........................... linefeed SET PORT <'PAR:'|'SER:'|FILE>............... output port SET OUTFILE ''................... output file SET QUALITY ... style SET FILE '' ..................... add file to list SET PERFORMESC ................... perform ESC codes ? SET PERFORMFF ..................... perform FF codes ? SET NUMBER ........................ number lines ? SET HEADER ......... header type SET SIZE ........................ font SET DOUBLE ........................ double sided ? SET SINGLE ........................ ditto SET SEPARATE ...................... draw lines ? SET ADJUSTLF ...................... ignore LF ? SET KEEPLF ........................ perform LF ? SET REQUESTER ..................... no requesters ? (1) SET ASK '' ........................... show YES/NO requester SET WARN '' .......................... show I SEE requester SET BOOK .......................... toggle book mode SET COVER ...................... print a cover SET KEYLIST ......................... keyword file (*) SET KEYCODE ................ set keyword qualifier SET PAPERX ................................. set paper width SET PAPERY ................................. set paper height SET PERFORATE ..................... prepare perforation ? SET ORIENTATION ....... paper orientation SET MSDOS ......................... toggle MS-DOS mode SET UNIDIR ........................ uni/bidirectional SET SCREEN ................. select a screen Group 2 - subroutines QUIT ....................................... quit HiSpeed SLEEP ...................................... iconify OPENWIN .................................... open main window SORTNAME ................................... sort jobs by name SORTSIZE ................................... sort jobs by size NEW ........................................ clear job list CLR ........................................ ditto REQUESTFILE ................................ ask for files PRINT ...................................... print jobs SCAN ....................................... scan jobs VSCAN ...................................... ditto (visualize) RESET ...................................... get default settings INFO ....................................... show scan results SAVECONFIG ................................. save settings Group 3 - read variables (QUERY) Syntax: QUERY (result is placed in RESULT) QUERY LAYOUTX .............................. layout (columns) QUERY LAYOUTY .............................. layout (rows) QUERY LEFT ................................. left border QUERY RIGHT ................................ right border QUERY TOP .................................. top border QUERY BOTTOM ............................... bottom border QUERY DX ................................... space between columns QUERY DY ................................... space between rows QUERY COPIES ............................... number of copies QUERY FEED ................................. linefeed QUERY PORT ................................. port QUERY OUTFILE .............................. output file (port=FILE) QUERY QUALITY .............................. style of printing QUERY PERFORMESC ........................... perform ESC codes ? QUERY PERFORMFF ............................ perform FF codes ? QUERY NUMBER ............................... number lines ? QUERY HEADER ............................... header type QUERY SIZE ................................. font QUERY DOUBLE ............................... printing mode QUERY SINGLE ............................... ditto QUERY SEPARATE ............................. draw lines ? QUERY ADJUSTLF ............................. adjust-LF setting QUERY KEEPLF ............................... ditto QUERY BLOCKX ............................... characters/line QUERY BLOCKY ............................... lines/block QUERY PAGES ................................ required pages (*) QUERY SHEETS ............................... required sheets (*) QUERY DISTORTIONS .......................... get distortions (*) QUERY BYTES ................................ output size (bytes) QUERY JOBS ................................. # of files to print QUERY VERSION .............................. get version string QUERY JOBNAME ....................... get a job's name QUERY STATE ................................ read HiSpeed's state QUERY JOBPAGE ....................... get job's page (*) QUERY BOOK ................................. book mode set ? QUERY MAXLINE .............................. longest line (*) QUERY KEYCODE .............................. keyword qualifier QUERY PERFORATE ............................ border handling QUERY ORIENTATION .......................... paper orientation QUERY MSDOS ................................ MS-DOS mode ? QUERY UNIDIR ............................... uni/bidirectional ? (1) supported only within ARexx scripts (*) these variables become valid after a SCAN (or VSCAN) @endnode @node MACROS "MACROS" @{" HiSpeed " link HISPEED}: @{b} MACROS @{ub} ARexx macros found within the HISPEED/AREXX directory during startup are gathered as MACRO menu. Please read the 'ARexxEDoc' manual for more details about ARexx. @endnode @node FILTER "FILTER" @{" HiSpeed " link HISPEED}: @{b} FILTER @{ub} Toggle 'FILTER' ON if you want the '@' character to be regarded as keyword qualifier. It will be removed before output. Have a look at the MakeAppendix macro. @endnode @node SLEEP-ICON "SLEEP-ICON" @{" HiSpeed " link HISPEED}: @{b} SLEEP-ICON @{ub} Use the 'Zzz' gadget to iconify HiSpeed. You may drag files over the icon to have them printed - it's an AppIcon. Doubleclick the icon to wake HiSpeed up again. Since the Amiga OS does not support reading AppIcon coordinates, HiSpeed won't be able to remember the icon position after you have moved it to another location. Nevertheless it is possible to snapshot the preferred position: Open the 'hispeed:config' directory. Move the 'AppIcon' icon from within that directory to desired location, than snapshot it (icon menu of workbench). Finally move the icon back to its drawer. HiSpeed will read the new position the next time it is evoked. @endnode @node RECOVER "RECOVER" @{" Tools " link TOOLS}: @{b} RECOVER @{ub} A program to recover text buffers after your system has crashed. Recover will scan all available memory locations (the free memory pool as well as memory allocated by other task), looking for lost buffers. Since freed memory is not protected by the OS, lost buffers may become trashed. Recover will still try to restore trashed buffers but they may contain garbage lines. You'll have to verify that restored buffers are intact before you copy them over your old files. Recover will try to figure out how many lines are corrupt to give you a rough idea of whether additional work is required. Be warned: these figures are not exact since it's hard to determine whether a line is corrupt or not. To increase your chances, run this program as soon as possible. Interrupt your startup sequence (type CTRL-D) and run recover IMMEDIATELY. Recover disables multitasking while scanning memory to prevent other tasks from allocating memory - this means that your mouse pointer freezes temporarily. Recover should be run from a shell window. The following arguments are supported: RECOVER DRIVE/K,ALL/S,TEST/S,MAXLEN/N,MAXLINES/N DRIVE Drive where to write restored files (e.g. df0:). Don't use a ram disk (might overwrite the text to recover) or a hard disk (program might fail while writing since it has to do some non-system-friendly stuff). ALL Recover file even if it appears to be unchanged (Recover defaults to ignoring a text if it has never been modified). TEST Just scan memory for text buffers to recover but don't write to a disk. Recover tries to figure out how many lines can be restored respectively are corrupt. A line is considered corrupt if it contains ASCII-Codes below 32 or from 128 to 160. Nevertheless, even corrupt lines are restored since parts of them may still be usable. MAXLEN Maximum line length to be considered valid. If Recover happens to encounter a longer line while scanning memory it will refuse to restore the line (might be corrupt). Defaults to 255. MAXLINES Maximum number of lines (per text) to restore. Recover will stop recovery as soon as a text exceeds this limit (text might be corrupt). Defaults to 10000 lines. @endnode @node REGISTER_GOLDED "REGISTER GOLDED" @{b} REGISTER GOLDED @{ub} A GoldED keyfile or the GoldED software and a keyfile are mailed to you on disk(s) or send to your e-mail address if you register. The keyfile removes the 1000-lines restriction from the trial version, turning it into a registered version. Please use the Order program (available in the GoldED drawer) to print your order. Addresses for support, orders and bug reports are listed on the following pages (@{" address " link ADDRESS}). Delivery usually can be expected in four to eight weeks, under special circumstances delivery may take longer. A keyfile is e-mailed to you in advance (if requested) to allow you working with GoldED while waiting for your disk(s). Keyfile requests should include your full address and your PGP key. Requests without a PGP key are not processed. PGP is a freeware encryption utility. Please read the PGP documentation if you haven't used PGP before. Eurochecks (made out in DM) and cash are accepted as payment for GoldED. Postal money cash orders are accepted, too. Other checks (American Express Checks, Visa Checks, Traveller Checks, Postal money Order Checks) are not accepted. Payment via a bank account is available for GoldED NET only (Dietmar Eilert, account 5129 92-505, Postbank Köln, BLZ 370 100 50). All offers valid until end of 3/1997. Special discounts are available if you order more than one copy (don't forget to provide a user name/address for each registration): 2 registrations ............... minus 20% each 3 or more registrations ....... minus 30% each GoldED Light (29.90 DM Germany, 35 DM Europe, 25$ international) ----------------------------------------------------------------------------- Mailing consists of one disk. Includes a keyfile for GoldED (only). The latest versions of the GoldED package as well as standard disk-based documentation is shipped. Please state whether you own a 1.7 MB HD disk drive. GoldED Pro (39.90 DM Deutschland, 45 DM Europa, 35$ international) ----------------------------------------------------------------------------- Mailing consists of one or two disks and a printed manual of about 70 pages. Please state whether you own a 1.7 MB HD disk drive. Includes a single user licence for the latest versions of GoldED & HiSpeed. Please choose the manual translation you would like to receive (English and German are available). GoldED NET (25 DM international) ----------------------------------------------------------------------------- The net distribution: you'll receive a PGP-encrypted keyfile for GoldED and HiSpeed at your e-mail address. You can use your currently installed unregistered GoldED/HiSpeed (4.0.0 or better) without restrictions after installing the keyfile. Send your order to dietmar@tomate.tng.oche.de. Include your full name and address and your PGP key (pgp -kxa). Orders without a PGP key are not processed. @endnode @node UPDATES "UPDATES" @{b} UPDATES @{ub} Registered GoldED users have received a keyfile for GoldED, allowing them to use future updates without restrictions. However, purchase of GoldED doesn't include unlimited access to free updates: the author may cease to provide free updates or updates at all without prior notice. Major updates may or may not require payment of a reasonable update fee. Users of GoldED OEM versions will have to return the GoldED registration card first in order to receive support or access to updates (please read the documentation of your software). GoldED updates usually are available at AmiNet sites and at the GoldED WWW support site (@{" WWW support " link ADDRESS}) free of charge. Updates on disk can be ordered (@{" address " link ADDRESS}) for a fee of 15 DM, disk and postage (Europe) included. Prices for delivery into other parts of the world available on request. @endnode @node UPGRADING_TO_GOLDED_4 "Upgrading to GoldED 4" @{b} Upgrading to GoldED 4 @{ub} GoldED 4 doesn't accept keyfiles made for former GoldED distributions: a new keyfile is required to use GoldED 4. Keyfile updates are free if you have received your GoldED registration between 1/96 and 8/96: the new keyfile is e-mailed to your e-mail address after we have received your PGP key. Delivery on disks is available, too: return your original disk and a self addressed envelope, postage paid (postal reply coupon, available at your post office). Updates of GoldED registrations received before 1/96 are available for an update fee of 15 DM, disk and European postage included. Prices for delivery into other parts of the world on request. Eurochecks, postal money cash orders and cash are accepted as payment. Other checks are not accepted. You may choose between delivery to your e-mail address (new keyfile only, PGP key required) or delivery on disk. Delivery on disk includes the latest GoldED version, e-mail orders are processed faster. @endnode @node CREDITS "CREDITS" @{b} CREDITS @{ub} * DICE * Reqtools * XPK * ARexxBox * GadToolsBox * This program has been developed using Matt Dillon's Dice. Most of the requester design has been done using Jan van den Baard's GadToolsBox. Thanks to Nico François for his Reqtools library and to the developers of the XPK (de)compression system. The ARexx routines of GoldED have been inspired by source code created by Michael Balzer's ARexxBox (though less sophisticated). Thanks to Stefan Zeiger for Boopsi example source code. And thanks to Joerg Gutzke, Dario Fava & Thomas Lechner, sysops of the Mowgli BBS, Mailway BBS and Tomate BBS (sources of most of the tools mentioned above). GUIMake has been developed by Rico Krasowski. Finally, I would like to thank these people for their invaluable suggestions, translations, ideas & support: Giovanni Addabbo, Henric Andersson, Markus Aretz, Cristian Castellari, Martin Fay, David 'Edi' Göhler, Georges Goncalves, Christian Gottschling, Serge Hammouche, Andreas Harrenberg, Mick Hohmann, Henning Hucke, René Laederach, Lieven Lema, Lars Renström, Maarten Ter Mors, Rodolphe Sanderson (French translations) and Stefan Schor. Further acknowledgements go to the following people who created many useful GoldED ARexx scripts: Eric Burghard, Oliver Clouth, Leu Simon Gris, Francois Helsen, Tattoo Mabonzo, Krzysztof P. Jasiutowicz, Fin Schuppenhauer and Markus Zahn. @endnode @node ADDRESS "ADDRESS" @{b} ADDRESS @{ub} Bugreports, comments and suggestions (e-mail, phone) are welcome. However, personal support is available for registered users only: please name the registration you own. Users of GoldED OEM versions will have to return the GoldED registration card first in order to receive support or access to updates (please read the documentation of your software). Users of a GoldED trial version can find some GoldED-related information at the WWW site (information about new versions, prices). WWW SUPPORT Visit our Internet WWW support site. GoldED related news, updates, tools: http://www.clearlight.com/~dietmar SUPPORT FOR UNREGISTERED USERS A file server has been set up to answer standard questions. The file server responds to e-mails. Send an e-mail to the file server address with the subject set to "send file info" to receive further information. E-mail address of the file server: dietmar@clearlight.com BUG REPORTS, SUGGESTIONS Suggestions are welcome but usually are not answered (due to lack of time). Questions related to if or when special features are implemented can not be answered - new features and new versions are announced at the WWW support instead. Bugreports are answered if the bugs can be reproduced or if the quality of the report (please include enforcer report, mungwall report, snoopdos log) suggests that there actually is a bug to be fixed. E-mail address: Dietmar.Eilert@post.rwth-aachen.de ORDERS, SUPPORT FOR REGISTERED USERS Technical questions and orders should be send to the address below. Bug reports, suggestions or non-technical questions should not be send to this address (and are ignored if send to this address). Dietmar Eilert Mies-v-d-Rohe-Str. 31 D-52074 Aachen Germany E-Mail: dietmar@tomate.tng.oche.de Phone: 0241/81665 Fax: 0241-81665-22 (+49-241-81665) @endnode @node INDEX " GoldED " @{" " link M073} @{"FILETYPES " link EXTRAS_OPTIONS_GLOBAL_FILETYPES} @{"PROJECT/CLEAR WINDOW " link M003} @{"ABOUT GOLDED " link M001} @{"FILTER " link FILTER} @{"PROJECT/CURRENT DIR " link M161} @{"ADDRESS " link ADDRESS} @{"FIND " link FIND} @{"PROJECT/CURRENT DIR... " link M012} @{"APC " link M076} @{"FIRST " link FIRST} @{"PROJECT/INFORMATION " link M134} @{"API " link API} @{"FIX " link FIX} @{"PROJECT/INSERT " link M009} @{"APPWINDOWS " link M005} @{"FOLD " link FOLD} @{"PROJECT/NAME " link M011} @{"AREXX COMMANDS HISPEED " link AREXX_COMMANDS_HISPEED} @{"FOLDING " link M106} @{"PROJECT/OPEN " link M005} @{"AREXX PORT " link AREXX_PORT} @{"FONT " link EXTRAS_OPTIONS_LOCAL_DISPLAY} @{"PROJECT/OPEN FAST " link M006} @{"AREXX PORT HISPEED " link AREXX_PORT_HISPEED} @{"FORMAT " link FORMAT} @{"PROJECT/OPEN NEW " link M007} @{"AREXXBOX " link CREDITS} @{"FORMATTER " link LAYOUT_MENU} @{"PROJECT/OPEN ORIGINAL " link M008} @{"ARGUMENTS " link GETTING_STARTED} @{"FREEZE " link FREEZE} @{"PROJECT/PRINT " link M018} @{"AUTOARRANGE " link EXTRAS_OPTIONS_LOCAL_DISPLAY} @{"FULL SCREEN " link EXTRAS_OPTIONS_LOCAL_DISPLAY} @{"PROJECT/PROTECTION " link M017} @{"AUTOBACKUP " link EXTRAS_OPTIONS_GLOBAL_MISC} @{"FUNC " link FUNC} @{"PROJECT/QUIT ALL & EXIT " link M019} @{"AUTOCASE " link EXTRAS_OPTIONS_LOCAL_WORDS} @{"FUP " link FUP} @{"PROJECT/QUIT BUFFER " link M020} @{"AUTOCOMPLETION " link ESC_KEY} @{"GADTOOLSBOX " link CREDITS} @{"PROJECT/SAVE " link M013} @{"AUTOFOLD " link EXTRAS_OPTIONS_LOCAL_MISC} @{"GETTING STARTED " link GETTING_STARTED} @{"PROJECT/SAVE AND CLOSE " link M016} @{"AUTOINDENTION " link EXTRAS_OPTIONS_LOCAL_INDENT} @{"GLOBAL SEARCH " link M126} @{"PROJECT/SAVE AS " link M014} @{"BACK " link BACK} @{"GOTO " link GOTO} @{"PROJECT/SAVE AS XPK " link M015} @{"BEEP " link BEEP} @{"GREP " link GREP} @{"PUSH " link PUSH} @{"BIND " link BIND} @{"GUI " link GUI} @{"QUERY " link QUERY} @{"BITS " link BITS} @{"HARDWARE REQUIREMENTS " link HARDWARE_REQUIREMENTS} @{"QUICKFUNC " link M085} @{"BLOCK " link BLOCK} @{"HELP " link HELP} @{"QUICKREFERENCE " link M074} @{"BLOCK MENU " link BLOCK_MENU} @{"HELP KEY " link HELP_KEY} @{"QUICKSTARTER " link GETTING_STARTED} @{"BLOCK/APPEND TEXT " link M044} @{"HIDE " link M118} @{"QUIT " link QUIT} @{"BLOCK/BLOCK PRINT " link M051} @{"HISPEED " link HISPEED} @{"RECOVER " link RECOVER} @{"BLOCK/BLOCK SAVE " link M050} @{"HOTKEY " link M020} @{"REDO " link REDO} @{"BLOCK/BLOCK SORT " link M047} @{"HOW TO FOLD LINES " link M106} @{"REFRESH " link REFRESH} @{"BLOCK/BLOCK TO LOWERCASE " link M049} @{"HUNTER " link HUNTER} @{"REGISTER GOLDED " link REGISTER_GOLDED} @{"BLOCK/BLOCK TO UPPERCASE " link M048} @{"IF " link IF} @{"REMAP " link REMAP} @{"BLOCK/CLIPBOARD COPY " link M027} @{"INDENT " link INDENT} @{"REMOVAL OF COLUMNS " link M042} @{"BLOCK/CLIPBOARD CUT " link M023} @{"INDEX " link INDEX} @{"REPLACE " link REPLACE} @{"BLOCK/CLIPBOARD PASTE " link M031} @{"INFO " link INFO} @{"REQLIST " link REQLIST} @{"BLOCK/COLUMN " link BLOCK_COLUMN} @{"INPUT EVENTS " link INPUT_EVENTS} @{"REQTOOLS " link CREDITS} @{"BLOCK/COLUMN DELETE " link M042} @{"INSERT " link INSERT} @{"REQUEST " link REQUEST} @{"BLOCK/COLUMN INSERT " link M043} @{"INSERTION OF COLUMNS " link M043} @{"REQUIRED SYSTEM " link REQUIRED_SYSTEM} @{"BLOCK/COLUMN TEXT " link M045} @{"INTELLISENSE " link SPACE_KEY} @{"RETURN KEY " link RETURN_KEY} @{"BLOCK/COPY " link M039} @{"INTERNAL COMMANDS " link INTERNAL_COMMANDS} @{"RIGHT " link RIGHT} @{"BLOCK/DELETE " link M040} @{"INTRODUCTION " link INTRODUCTION} @{"RUN " link RUN} @{"BLOCK/MARK " link M172} @{"KEY " link KEY} @{"RX " link RX} @{"BLOCK/MARK HIDE " link M022} @{"KEYBOARD " link KEYBOARD} @{"SAVE " link SAVE} @{"BLOCK/MARK LINE " link M021} @{"LANDSCAPE " link LANDSCAPE} @{"SCREEN " link SCREEN} @{"BLOCK/MARK PARAGRAPH " link M179} @{"LANGUAGE " link GETTING_STARTED} @{"SCROLL BORDERS " link EXTRAS_OPTIONS_LOCAL_GUI} @{"BLOCK/MOVE " link M041} @{"LAYOUT " link LAYOUT} @{"SEARCH MENU " link SEARCH_MENU} @{"BLOCK/PASTE COLUMN " link M035} @{"LAYOUT MENU " link LAYOUT_MENU} @{"SEARCH/ASCII CODE ? " link M079} @{"BOOK " link BOOK} @{"LAYOUT/AUTOCASE " link M064} @{"SEARCH/ASCII CODE INSERT " link M078} @{"BRACKET " link BRACKET} @{"LAYOUT/BLOCK CENTERED " link M059} @{"SEARCH/ASCII TABLE " link M077} @{"BREAKPT " link BREAKPT} @{"LAYOUT/BLOCK JUSTIFIED " link M056} @{"SEARCH/CHARACTER SET " link M080} @{"CENTER WINDOWS " link EXTRAS_OPTIONS_LOCAL_DISPLAY} @{"LAYOUT/BLOCK LEFT " link M057} @{"SEARCH/CHECK " link M072} @{"CHARACTER HEIGHT " link CHARACTER_HEIGHT} @{"LAYOUT/BLOCK RIGHT " link M058} @{"SEARCH/COMPLETE " link M076} @{"CHARACTER SET REMAP " link M080} @{"LAYOUT/INDENT " link LAYOUT_INDENT} @{"SEARCH/COUNT PATTERN " link M071} @{"CHUNKY PIXEL " link EXTRAS_OPTIONS_LOCAL_DISPLAY} @{"LAYOUT/INDENT BLOCK " link M046} @{"SEARCH/FIND " link M066} @{"CLIP " link CLIP} @{"LAYOUT/INDENT LINE " link M180} @{"SEARCH/FIND NEXT " link M067} @{"CLIPBOARD " link M031} @{"LAYOUT/INSERT MODE " link M108} @{"SEARCH/FIND PREVIOUS " link M068} @{"CMD " link CMD} @{"LAYOUT/LINE: LEFT " link M180} @{"SEARCH/FUNCTION FIND " link M086} @{"CODE " link CODE} @{"LAYOUT/LINE: RIGHT " link M180} @{"SEARCH/FUNCTION LIST " link M085} @{"COLON " link COLON} @{"LAYOUT/NUMPAD = MOVEMENT " link M110} @{"SEARCH/MATCHING BRACKET " link M073} @{"COMMAND LIST " link COMMAND_LIST} @{"LAYOUT/PARAGRAPH CENTERED" link M063} @{"SEARCH/REFERENCE " link M074} @{"CONFIGURABLE GADGETS " link EXTRAS_OPTIONS_LOCAL_GADGETS} @{"LAYOUT/PARAGRAPH JUSTIFIE" link M060} @{"SEARCH/REFERENCE... " link M075} @{"CONFIGURATION " link CONFIGURATION} @{"LAYOUT/PARAGRAPH LEFT " link M061} @{"SEARCH/REPLACE " link M069} @{"CONSOLE " link EXTRAS_OPTIONS_LOCAL_GUI} @{"LAYOUT/PARAGRAPH RIGHT " link M062} @{"SEARCH/REPLACE HISTORY " link M066} @{"COVER " link COVER} @{"LAYOUT/SET RIGHT MARGIN " link M052} @{"SEARCH/REPLACE NEXT " link M070} @{"CR " link CR} @{"LAYOUT/SOLID TABS " link M109} @{"SELECT A HOST " link SELECT_A_HOST} @{"CREDITS " link CREDITS} @{"LAYOUT/TEMPLATES " link M055} @{"SEQUENCES " link M149} @{"CURSOR KEYS " link CURSOR_KEYS} @{"LAYOUT/USE CURRENT MARGIN" link M053} @{"SESSION " link SESSION} @{"DEBUG " link DEBUG} @{"LAYOUT/WORD WRAP " link M054} @{"SET " link SET} @{"DEBUGGER " link M173} @{"LEFT " link LEFT} @{"SETTINGS & UNITS " link SETTINGS_&_UNITS} @{"DEL " link DEL} @{"LICENCE " link LICENCE} @{"SHELL INTERFACE " link SHELL_INTERFACE} @{"DEL KEY " link DEL_KEY} @{"LINES " link LINES} @{"SHIFT " link SHIFT} @{"DELETE " link DELETE} @{"LOCK " link LOCK} @{"SHIFTING " link M046} @{"DICE " link CREDITS} @{"LOCK A WINDOW " link LOCK_A_WINDOW} @{"SINGLE/DOUBLESIDED " link SINGLE_DOUBLESIDED} @{"DIR " link DIR} @{"MACRO " link MACRO} @{"SLEEP-ICON " link SLEEP-ICON} @{"DISPLAY MODE " link EXTRAS_OPTIONS_LOCAL_DISPLAY} @{"MACRO MENU " link MACRO_MENU} @{"SMARTCR " link SMARTCR} @{"DJUMP " link DJUMP} @{"MACROS " link MACROS} @{"SMARTINDENTION " link EXTRAS_OPTIONS_LOCAL_INDENT} @{"DO YOUR JOB " link DO_YOUR_JOB} @{"MACROS/EXECUTE COMMAND " link M145} @{"SPACE KEY " link SPACE_KEY} @{"DOWN " link DOWN} @{"MACROS/EXECUTE LINE " link M162} @{"SPOOLER " link EXTRAS_OPTIONS_LOCAL_PRINTER} @{"DPAGE " link DPAGE} @{"MACROS/MACRO EDIT " link M147} @{"STOP " link STOP} @{"DRAG & DROP " link MOUSE_CONFIGURATION} @{"MACROS/MACRO EXECUTE " link M171} @{"SUFFIX " link SUFFIX} @{"DYNAMIC TABS " link EXTRAS_OPTIONS_LOCAL_TABS} @{"MACROS/MACRO START " link M148} @{"SYNTAX " link SYNTAX} @{"ELSE " link ELSE} @{"MACROS/MACROS " link M154} @{"SYNTAX HIGHLIGHTING " link EXTRAS_OPTIONS_LOCAL_SYNTAX} @{"ENDIF " link ENDIF} @{"MACROS/SEQUENCE LOAD " link M150} @{"TAB " link TAB} @{"ENDWORD " link ENDWORD} @{"MACROS/SEQUENCE PLAY " link M152} @{"TAB KEY " link TAB_KEY} @{"EOL WRAP " link EXTRAS_OPTIONS_LOCAL_GUI} @{"MACROS/SEQUENCE PLAY... " link M153} @{"TABS " link TABS} @{"ERROR BEEP " link EXTRAS_OPTIONS_LOCAL_GUI} @{"MACROS/SEQUENCE RECORD " link M149} @{"TASK " link TASK} @{"ESC KEY " link ESC_KEY} @{"MACROS/SEQUENCE SAVE " link M151} @{"TEMPLATES " link M055} @{"ESC-SEQUENCES " link ESC-SEQUENCES} @{"MACROS/SESSION LOAD " link M169} @{"TEXT " link TEXT} @{"EVENT DEFINITION " link EVENT_DEFINITION} @{"MACROS/SESSION SAVE " link M170} @{"TMPLATE " link TMPLATE} @{"EXALL " link EXALL} @{"MAGIC CODES " link EVENT_DEFINITION} @{"TOOLBAR " link M178} @{"EXCLUDE CURSOR " link EXTRAS_OPTIONS_LOCAL_GUI} @{"MAIN " link MAIN} @{"TOOLS " link TOOLS} @{"EXTRACT " link EXTRACT} @{"MARGINS " link EXTRAS_OPTIONS_LOCAL_DISPLAY} @{"TYPE " link TYPE} @{"EXTRAS MENU " link EXTRAS_MENU} @{"MARK " link MARK} @{"UJUMP " link UJUMP} @{"EXTRAS/AMIGADOS SHELL " link M135} @{"MAXDOWN " link MAXDOWN} @{"UNDO " link UNDO} @{"EXTRAS/FILES " link M138} @{"MAXUP " link MAXUP} @{"UNDO & REDO " link M132} @{"EXTRAS/HISPEED " link M137} @{"MENU " link MENU} @{"UNLOCK " link UNLOCK} @{"EXTRAS/INSERT TEXT " link M142} @{"MENU CONFIGURATION " link EXTRAS_OPTIONS_LOCAL_MENU} @{"UNLOCK GUI " link UNLOCK_GUI} @{"EXTRAS/LINE DOUBLE " link M129} @{"MENU TREE OF BLOCK MENU " link BLOCK_MENU} @{"UP " link UP} @{"EXTRAS/LINE INSERT " link M131} @{"MENU TREE OF EXTRAS MENU " link EXTRAS_MENU} @{"UPAGE " link UPAGE} @{"EXTRAS/LINE REMOVE " link M130} @{"MENU TREE OF LAYOUT MENU " link LAYOUT_MENU} @{"UPDATES " link UPDATES} @{"EXTRAS/LINE SWAP " link M128} @{"MENU TREE OF MACRO MENU " link MACRO_MENU} @{"UPGRADING TO GOLDED 4 " link UPGRADING_TO_GOLDED_4} @{"EXTRAS/OPTIONS GLOBAL " link M176} @{"MENU TREE OF PROJECT MENU" link PROJECT_MENU} @{"USE " link USE} @{"EXTRAS/OPTIONS GLOBAL/FIL" link EXTRAS_OPTIONS_GLOBAL_FILETYPES} @{"MENU TREE OF SEARCH MENU " link SEARCH_MENU} @{"VARIABLES " link QUERY} @{"EXTRAS/OPTIONS GLOBAL/GUI" link EXTRAS_OPTIONS_GLOBAL_GUI} @{"MENU TREE OF VIEW MENU " link VIEW_MENU} @{"VIEW " link VIEW} @{"EXTRAS/OPTIONS GLOBAL/MIS" link EXTRAS_OPTIONS_GLOBAL_MISC} @{"MENUHELP " link GETTING_STARTED} @{"VIEW MENU " link VIEW_MENU} @{"EXTRAS/OPTIONS GLOBAL/VAR" link EXTRAS_OPTIONS_GLOBAL_VARIABLES} @{"MENUS " link MENUS} @{"VIEW/ARRANGE HORIZONTAL " link M111} @{"EXTRAS/OPTIONS LOCAL " link M175} @{"MISC " link MISC} @{"VIEW/ARRANGE VERTICAL " link M111} @{"EXTRAS/OPTIONS LOCAL/API " link EXTRAS_OPTIONS_LOCAL_API} @{"MORE " link MORE} @{"VIEW/DEBUGGER " link M173} @{"EXTRAS/OPTIONS LOCAL/DISP" link EXTRAS_OPTIONS_LOCAL_DISPLAY} @{"MOUSE " link MOUSE} @{"VIEW/FOLD " link M106} @{"EXTRAS/OPTIONS LOCAL/GADG" link EXTRAS_OPTIONS_LOCAL_GADGETS} @{"MOUSE CONFIGURATION " link MOUSE_CONFIGURATION} @{"VIEW/GO TO LINE " link M091} @{"EXTRAS/OPTIONS LOCAL/GUI " link EXTRAS_OPTIONS_LOCAL_GUI} @{"MULTISELECTION " link M005} @{"VIEW/GO TO MODIFICATION " link M093} @{"EXTRAS/OPTIONS LOCAL/HUNT" link EXTRAS_OPTIONS_LOCAL_HUNTER} @{"NAME " link NAME} @{"VIEW/GO TO TOP-BOTTOM " link M092} @{"EXTRAS/OPTIONS LOCAL/INDE" link EXTRAS_OPTIONS_LOCAL_INDENT} @{"NEW " link NEW} @{"VIEW/HIDDEN BUFFERS " link M118} @{"EXTRAS/OPTIONS LOCAL/KEYB" link EXTRAS_OPTIONS_LOCAL_KEYBOARD} @{"NEXT " link NEXT} @{"VIEW/NEW WINDOW " link M004} @{"EXTRAS/OPTIONS LOCAL/LAYO" link EXTRAS_OPTIONS_LOCAL_LAYOUT} @{"NOTIFY " link NOTIFY} @{"VIEW/POSITION RECALL " link M100} @{"EXTRAS/OPTIONS LOCAL/MENU" link EXTRAS_OPTIONS_LOCAL_MENU} @{"OPEN " link OPEN} @{"VIEW/POSITION STORE " link M094} @{"EXTRAS/OPTIONS LOCAL/MISC" link EXTRAS_OPTIONS_LOCAL_MISC} @{"OPTIONS GLOBAL " link M176} @{"VIEW/PREVIEW " link M117} @{"EXTRAS/OPTIONS LOCAL/MOUS" link EXTRAS_OPTIONS_LOCAL_MOUSE} @{"OPTIONS LOCAL " link M175} @{"VIEW/REMEMBER SIZE " link M182} @{"EXTRAS/OPTIONS LOCAL/PRIN" link EXTRAS_OPTIONS_LOCAL_PRINTER} @{"OUTPUT DEVICE " link OUTPUT_DEVICE} @{"VIEW/SYNTAX HIGHLIGHTING " link M198} @{"EXTRAS/OPTIONS LOCAL/PROJ" link EXTRAS_OPTIONS_LOCAL_PROJECT} @{"PAGE HEADER " link PAGE_HEADER} @{"VIEW/TOOLBAR " link M178} @{"EXTRAS/OPTIONS LOCAL/REFE" link EXTRAS_OPTIONS_LOCAL_REFERENCE} @{"PAGE LAYOUT " link PAGE_LAYOUT} @{"VIEW/WINDOW " link VIEW_WINDOW} @{"EXTRAS/OPTIONS LOCAL/SYNT" link EXTRAS_OPTIONS_LOCAL_SYNTAX} @{"PAGE PREVIEW " link PAGE_PREVIEW} @{"VIEW/WINDOW ARRANGE " link M111} @{"EXTRAS/OPTIONS LOCAL/TABS" link EXTRAS_OPTIONS_LOCAL_TABS} @{"PARAGRAPH VS. BLOCK " link LAYOUT_MENU} @{"VIEW/WINDOW CENTER " link M181} @{"EXTRAS/OPTIONS LOCAL/TEMP" link EXTRAS_OPTIONS_LOCAL_TEMPLATES} @{"PARENTHESIS CHECK " link EXTRAS_OPTIONS_LOCAL_GUI} @{"VIEW/WINDOW MAXIMIZE " link M116} @{"EXTRAS/OPTIONS LOCAL/WORD" link EXTRAS_OPTIONS_LOCAL_WORDS} @{"PATH " link PATH} @{"VIEW/WINDOW NEXT " link M122} @{"EXTRAS/PROJECT FILTER " link M126} @{"PC " link PC} @{"VIEW/WINDOW PREVIOUS " link M123} @{"EXTRAS/REDO " link M133} @{"PERFORATE " link PERFORATE} @{"VIEW/WINDOW ZIP " link M115} @{"EXTRAS/SAVE PREFERENCES " link M177} @{"PHRASE " link PHRASE} @{"VLEFT " link VLEFT} @{"EXTRAS/SEARCH FILE " link M127} @{"PING " link PING} @{"VRIGHT " link VRIGHT} @{"EXTRAS/SEARCH FILE... " link M174} @{"PONG " link PONG} @{"WEIGHT " link EXTRAS_OPTIONS_LOCAL_DISPLAY} @{"EXTRAS/UNDO " link M132} @{"POP " link POP} @{"WHITE SPACE " link EXTRAS_OPTIONS_LOCAL_GUI} @{"F-KEYS " link F-KEYS} @{"PREFS " link PREFS} @{"WILDCARDS " link M066} @{"FAST SCROLLING " link EXTRAS_OPTIONS_LOCAL_GUI} @{"PREV " link PREV} @{"WINDOW " link WINDOW} @{"FASTLOAD " link M006} @{"PREVEND " link PREVEND} @{"WORD " link WORD} @{"FDOWN " link FDOWN} @{"PREVIEW " link EXTRAS_OPTIONS_LOCAL_DISPLAY} @{"WORDWRAP " link M054} @{"FEATURES " link FEATURES} @{"PRINT " link PRINT} @{"WWW SUPPORT " link ADDRESS} @{"FILE " link FILE} @{"PRINTER " link EXTRAS_OPTIONS_LOCAL_PRINTER} @{"XPK " link CREDITS} @{"FILE HUNTER " link M127} @{"PRINTING " link PRINTING} @{"XPK SUPPORT " link M015} @{"FILE LIST " link EXTRAS_OPTIONS_LOCAL_MENU} @{"PROJECT " link PROJECT} @{"XREF " link XREF} @{"FILES " link FILES} @{"PROJECT MENU " link PROJECT_MENU} @{"FILETYPES " link EXTRAS_OPTIONS_GLOBAL_FILETYPES} @{"PROJECT/APPEND " link M010} @endnode