RISC DISC 1/RISC_DISC_1.iso/pd_share/utilities/zap/!Zap/HelpData

Text File | 1994-03-05 | 19.8 KB | 687 lines

| Zaps data for interactive Help.
| Labels are of the form:
|   zap.item1.item2.etc    for menu items (lower case and spaces removed)
|   window.name        for leaf window with given template name
|   mode_n        for help on a window in mode n
|   zap.icon        for zaps main icon

| Main icon

zap.icon
This is the Zap application.
Zap is a text editor.
Click SELECT to open a new text file.
Drag a file onto this icon to load it.

| Window in mode 'n'

mode_0
This is a Zap window in text editing mode.
Click SELECT to set the cursor or ADJUST to select region to cursor.
Drag SELECT to set a selection or ADJUST to alter a selection.
Double click SELECT to select a word etc.

mode_1
This is a Zap window in byte editing mode.
Toggle hex entry mode via F2 and insert/overwrite mode via INSERT.
In hex entry mode keys 0-9,A-F,a-f enter hex bytes.

mode_2
This is a Zap window in word editing mode.
In hex entry mode keys 0-9,A-F,a-f enter hex words.
DELETE deletes a whole word.
Use undo (F8 or Shift <-|) to remove last digit typed.

mode_3
This is a Zap window in ASCII editing mode.
Type characters to insert them.

mode_4
This is a Zap window in assembler instruction examining mode.
Press RIGHT arrow to follow a branch and LEFT arrow to go back.
Press CTRL-I to indirect to a word (eg in module header).

mode_5
This is a Zap window in tokenised BASIC editing mode.
Press SHIFT-F8 to renumber the program.
Press SHIFT-CTRL-F or SHIFT-CTRL-U to run the program.

mode_6
This is a Zap window in detokenised BASIC editing mode.
Use as for text mode.

mode_11
This is a Zap throwback window.
Double click SELECT or press RETURN on a line to go to the match.
Click ADJUST or press DELETE on a line to remove the line.

mode_12
This is a Zap taskwindow output window.
Change to TEXT mode to suspend the task.
Change back to TASKWINDOW mode to resume the task.
Use the COPY key to copy text.

| Leaf windows

window.InfoBox
This is the Zap info window.
The application Zap is copyright Dominic Symes - see 'Copyright' file.
Click on the 'Dominic Symes' for a list of mode authors.
See the 'Copyright' file for my address.

window.GotoBox
This window displays your current position in the text.
Type the line number or address you wish to move to in the file.
You may use expressions (eg '&100+32*78').
Press CTRL U to clear the buffer.

window.SaveBox
Drag the file type icon to a directory window to save the file.
Press RETURN or click on 'OK' to save the file.
Click ADJUST on 'OK' to save the file but leave the window open.
Click MENU to bring up a file type menu.

window.DyingBox
Click SAVE    (or press 'S') to save the file before it is discarded.
Click DISCARD (or press 'D') to delete the file.

window.QuitBox
Click QUIT (or press 'Q') if you wish to leave zap WITHOUT saving any files.

window.SaveSelBox
Drag the file type icon to a directory window to save the selection.

window.SearchBox
Type the search string and press RETURN to search for it.
Press CTRL U to clear the buffer.
Click on 'Show Macros' to change Case Sensitivity and Macros.
Press TAB to recall the old search string.

window.MacroBox
The small boxes give the macro to match.
The large boxes give the text to replace the macro with.

window.ReplaceBox
Type search string then RETURN.
Type replace string then RETURN.
Press CTRL U to clear a buffer.
See !Help file for more details.

window.NextBox
Click REPLACE (or press R) to replace one match.
Click TO END  (or press T or E) to replace all following matches.
Click SKIP    (or press S) to move to the next match without replacement.

window.PrintBox
Prints a file by use of the !Printers (printer driver) application.
Printing uses the outline font selected via the display menu.
Press PRINT to start printing.

window.DzapBox
Type the filing system name (CASE SENSITIVE) and then press RETURN.
The default drive number should then be filled in for you.
Type the drive number then RETURN to change drive.
Press READ SECTOR to read the disc.

window.QuickBox
Click on PRINT or type RETURN to send the file to the printer.
If this does not work for your printer then change the CR/LF DIP switch OR:
Load the printer driver and save the file onto it.

window.MzapBox
Drag the 'switcher' icon to a window/icon belonging to the task you want.
Press RETURN or click on READ.

window.UndoBox
If you turn off the UNDO remember that PASTE and YANK will no longer work.

window.LoadBox
Click on 'EDIT' (or press E) to load the file into a separate buffer.
Click on 'OVERWRITE' (or press O) to replace the current buffer.

window.SaveOBox
Click on 'OVERWRITE' (or press O) to replace the file on disc.

window.SaveCBox
Click on 'SAVE TO CSD' to save to the currently selected directory.

window.MiniBuf
This is the Zap minibuffer.
Drag with SELECT to move.
Drag near the right hand edge to resize.
Press ESCAPE to leave the minibuffer.

| Window menu

zap.file
Bring up save box (SAVE).

zap.file.save
Saves file to disc directly (QUICKSAVE).

zap.file.search
Bring up search box with current options.

zap.file.goto
Bring up goto box (GOTO).

zap.file.replace
Bring up search and replace box (REPLACE).

zap.file.print
The submenu lists various ways of printing a file from Zap.
If these don't work then load the printer driver !Printers and save the
file onto it.

zap.file.print.quick
Brings up quick print box (QUICKPRINT).

zap.file.print.fancy
Brings up fancy print box (PRINTFILE).
You must have the printer driver loaded.

zap.file.print.open
Opens the 'printer:$' filer window (OPENPRINTER).

zap.file.print.close
Closes the 'printer:$' filer window (CLOSEPRINTER).

zap.file.print.dump
Creates a text image of the current display (DUMPFILE).

zap.file.readonly
Toggles the file in/out of read only mode (READONLY).

zap.file.newview
Creates a new view on the indicated file (NEWVIEW).

zap.file.undoon
Toggles the undo buffer on and off.
Switching it off will cause all undo data to be lost.
While the buffer is off, PASTE (ctrl-Y) will not work.
Switch off undo before dropping in large files.

zap.selection
The submenu handles selected regions.
Hold down SELECT and drag with the mouse to select a region.
Alternatively, use CTRL-COPY.

zap.selection.save
Saves the selected region if there is one.

zap.selection.clear
Clears any selected region (CLEARSEL).

zap.selection.cut
Cuts the selected region.
If undo buffer is on then you may paste it with Ctrl-Y.
If the undo buffer is off then the region is deleted PERMANENTLY.

zap.selection.paste
This pastes the last region cut from this file repeatedly.
To paste previously deleted regions use yank (shift-ctrl-Y). (PASTE)

zap.selection.yank
This pastes the last region cut from this file.
Repeated presses will cycle thorough previously deleted regions.
Use ESCAPE to halt the operation (or move the cursor) (YANK).

zap.selection.copy
This copies the selected region to the current cursor position (COPYSEL).

zap.selection.move
This moves the selected region to the current cursor position (MOVESEL).

zap.selection.keep
This copies the region to the kill ring without deleting it.
Press CTRL Y to paste the region (KEEPREGION).

zap.selection.indent
This indents the selected region (INDENT).
Insert number 'n' to insert by n spaces.
Insert number '-n' to remove n spaces.
Insert a string to indent by that string.

zap.selection.outdent
This outdents the selected region by the same number of characters as the
indent string (OUTDENT).

zap.edit
The submenu lists various options concerning the editing of text.

zap.edit.fastundo
This undoes the last operation in direct line to the file start state.
(FASTUNDO)

zap.edit.undo
This undoes the last operation regardless of what it was. (FULLUNDO)

zap.edit.redo
This negates the effect of the last undo whether full or fast. (REDO)

zap.edit.misc.swapcase
This swaps the case of the next character/selected region. (SWAPCASE)

zap.edit.misc.selectbuffer
This selects the entire buffer. (SELECTBUFFER)

zap.edit.misc.swapchars
This swaps the two characters either side of the cursor. (SWAPCHARS)

zap.edit.misc.copymode
This starts split cursor copying.
Move cursor and press copy key to copy characters. (COPY)

zap.edit.misc.select
This starts select by keyboard mode.
Move the cursor as to delimit the selected region.
Press ESCAPE to end the selection.
This is much faster than using the mouse. (SELREGION)

zap.edit.misc.splitline
Splits the current line in two at the cursor position. (SPLITLINE)

zap.edit.misc.joinline
Joins the next line onto that with the cursor. (JOINLINE)

zap.edit.misc.formattext
Formats the text from cursor position to paragraph end. (FORMATTEXT)

zap.edit.misc.closewindow
Swaps the cursor to the next available window and closes the original one.
(CLOSEWINDOW)

zap.edit.misc.closeother
Closes the next window in line (the one which SHIFT F2 would swap to).
Useful for getting rid of throwback windows (CLOSEOTHER).

zap.edit.misc.togglesize
Toggles the size of the window (TOGGLEWIND).

zap.edit.overwrite
Toggles text entry between insert/overwrite modes. (TOGGLEINSERT)

zap.edit.hexentry
Toggles text entry between hex and ascii modes in modes Byte and Word.
(HEXASCII)

zap.edit.wordwrap
Toggles wordwrap mode on and off and sets wordwrap text width. (WORDWRAP)
When on, paragraphs are dynamically wrapped when you edit text.

zap.edit.linewrap
Toggles linewrap mode on and off (LINEWRAP).
When on, lines wrap when you type beyond the wrap width.
Unlike wordwrap, lines cannot be 'pulled back' when you delete.
Use the wordwrap submenu to set the width.

zap.edit.lineedit
Toggles edit paradigm between line edit mode and stream edit mode.
In stream edit mode, the return key acts as splitline, and the delete key
at the start of a line acts as joinline.

zap.edit.nonstandard
Enables non standard mode features.
(eg in Basic spaces at the end of lines are automatically removed
and colons are added on a joinline call).

zap.edit.autoindent
Turns auto indent mode on and off.

zap.mode
Gives a menu of the currently installed modes.
Each mode has its own leaf menu.
Use these menus to set mode aspects such as the display width.

zap.mode.text
Display is in standard text format.

zap.mode.byte
Display is in hexadecimal bytes.

zap.mode.word
Display is in hexadecimal words.

zap.mode.ascii
Display is in characters with no 'return symbol'.
It handles this much faster than text mode would.

zap.mode.code
Display is in disassembled instructions at one per line.

zap.mode.basic
Handles TOKENISED basic programs.

zap.mode.bastxt
Handles Basic programs by detokenising them on loading and tokenising
them on saving.

zap.mode.cmode
Handles bracket matching and C function listing.

zap.mode.throwback
Handles throwback buffers. Use F7 to create a buffer.

zap.mode.taskwindow
Handles taskwindow buffers.
Use the create.taskwindow menu option to create such a buffer.

zap.display.linenumbers.none
Removes all line numbers (NOLINENOS).

zap.display.linenumbers.logical
Displays line numbers in logical format (logical lines for text mode and
actual line number in basic mode) (LOGICAL).

zap.display.linenumbers.physical
Displays line numbers in physical format.
Ie, the line offset from the start of the display plus the given start
line value. (PHYSICAL)

zap.display.linenumbers.addresses
Displays line numbers as file offsets from the start of the file plus the
given start 'address' of the file. (ADDRESS)

zap.display.linenumbers.startline
Gives the start line number to use for logical/physical line numbers.

zap.display.linenumbers.startaddr
Gives the start address to use for address offsets.

zap.display.tabs.none
Displays the tab character as its usual ascii character.

zap.display.tabs.asspaces
Expands tabs to next column of 8 as spaces.

zap.display.tabs.tabchar
Gives the tab character value.
Please leave this as 9 in all but exceptional circumstances.

zap.display.linespacing
Sets the line spacing in 1/8ths of a character.

zap.display.font.system(at1dpp)
Sets the standard fast redraw zap font at 1 dot per pixel resolution.

zap.display.font.system(scaled)
Sets the standard fast redraw zap font at variable resolution.
Height is scaled to match the size of standard OS characters in this mode.
This is the default option.

zap.display.font.system(viavdu)
This uses the standard vdu drivers for redrawing the screen.
It is provided mainly as a test font.
Try the fonts out in mode 22 to see the difference.

zap.display.font.other(quick)
Sets fast redraw for the current anti-aliased font.
Use 'Other font name' and 'Other font size' to change the font.
Zap caches the characters so will require extra memory.

zap.display.font.other(viavdu)
As for the 'other (quick)' option, but uses the system call "Font_Paint".

zap.display.font.otherfontname
Sets the anti-aliased font name.
Change the default font name in the 'Keys' file.

zap.display.font.otherfontsize
Sets the anti-aliased font size in points.
Change the default font size in the 'Keys' file.

zap.display.colours
Changes colours for current window and mode.

zap.display.width
Changes the width of the current window.
What the width means will depend on the mode.
Eg, in Word mode it is the number of words per line.

zap.display.misc.returnchar
Sets the return character value. (please use 10 as standard value).

zap.display.misc.margin
Sets the margin width in characters.

zap.display.misc.autowidth
Sets the display width of loaded text files automatically when the file is
loaded to the longest line in that file.

zap.display.misc.bigendian
Reverses all word reads/writes as if you were on an Arm 6 processor with
endianness reversed.
I suggest most people leave this off!

zap.misc.keymap.command
This opens the minibuffer for you to type a zap command.
The command will then be executed (COMMAND).

zap.misc.keymap.default
Returns to the default keymap (DEFAULTMAP).

zap.misc.keymap.bind
Enables you to bind the learnt key sequence to any key (BINDTOKEY).

zap.misc.keymap.emacs
Switches to keymap number 1.
This is the Emacs emulation keymap.
The ESCAPE key acts as META (EMACS).

zap.misc.markers.togglemark
Toggles a marker at the current cursor position (TOGGLEMARK)

zap.misc.markers.lastmark
Goes to the last set mark. (eg use after a ctrl-down) (LASTMARK)

zap.misc.markers.nextmark
Goes to the next set mark. (NEXTMARK)

zap.misc.tabmode.unixtab
Makes the tab key insert the tab character.

zap.misc.tabmode.!edittab
Makes the tab key align to the next column using the text above as a guide.

zap.misc.tabmode.columntab
Makes the tab key align to the next column of a given width.

zap.misc.tabmode.asspaces
The tab actions above insert as many tab chars as possible.
If this option is set then spaces are inserted instead.

zap.misc.tabmode.toggletab
Toggles between UNIX and !Edit tab modes (SWITCHTAB).

zap.misc.insert.date
Insert current data. Format set in keys file. (INSERTDATE)

zap.misc.insert.time
Insert current time. Format set in keys file. (INSERTTIME)

zap.misc.delete.deleteline
Deletes current line containing cursor. (DELLINE)

zap.misc.delete.deletetostart
Deletes from start of line to cursor. (DELTOSTART)

zap.misc.delete.deletetoend
Delete from cursor to end of line, or line terminator if it is empty as in
emacs. (DELTOEND)

zap.misc.move.indirect
Move to address contained in word at cursor, most useful in Code mode.
(INDIRECT)

zap.misc.move.swapwindow
Swaps to next window. (SWAPWINDOW)

zap.misc.move.lastsector
Moves to last sector on a read-disc file.

zap.misc.move.nextsector
Moves to next sector on a read-disc file.

zap.misc.move.lasttrack
Moves to last track on a read-disc file.

zap.misc.move.nexttrack
Moves to next track on a read-disc file.

zap.misc.learn.learn
Start/stop learning a key sequence.
(see the !Help, Sect D file for details) (LEARN)

zap.misc.learn.execute
Execute last learnt key sequence. (EXECUTE)

zap.misc.match.last
Move to last match after using the Search window. (LASTMATCH)

zap.misc.match.next
Move to next match after using the Search window. (NEXTMATCH)

zap.misc.search.forward
Start search as you type forward/move to next match. (SEARCHFORWARD)

zap.misc.search.backward
Start search as you type backward/move to last match. (SEARCHBACK)

zap.misc.basic.renumber
Renumber a basic program. (RENUMBER)

zap.misc.basic.dropintobasic
Load the basic program at PAGE. (BASIC)

zap.misc.basic.run
Run the basic program at PAGE. (RUN)

zap.misc.basic.runthenquit
Run the basic program at PAGE then quit. (RUNANDQUIT)

zap.misc.basic.saveandrun
Save the basic program and chain from disc. (COMPILE)

zap.misc.basic.save,run,quit
Save the basic program, chain from disc and then quit. (SAVEANDRUN)

zap.misc.copyops
Copy the windows options to being the default option.
This is still not fully tested and doesn't copy all mode dependent options.

| Iconbar menu

zap.options.saveoptions
Save current options as shown in the options menu.
Options are saved in the !Config file.
Delete the !Config file to restore default options.

zap.options.editkeys
Loads the 'keys' file for editing.

zap.options.reloadkeys
Rereads the 'keys' file and sets to set up any new key bindings.

zap.options.misc.auto-delfiles
This causes a file to be deleted when the last window on it is closed.
If you switch this off then it will behave like !Impression.
Files will remain resident and can be got at via 'Create.NewView'.

zap.options.misc.auto-clrregions
When this option is on, changing the text causes the region to be
deselected as in !Impression.

zap.options.misc.undosupported
Sets whether the undo buffer should be on by default.
Only switch this off if you are very short of memory.
(Cut and paste will not work if you switch this off)

zap.options.misc.flashingcursor
This option gives a flashing cursor.
The flash rate can be set in the keys file.

zap.options.misc.checkdatestamp
This option checks the date stamp of the file when saving.
If it is on and the file you save is dated earlier than the version on disc
then a warning will be given.
There are time lag problems with this on networks/MSDOS discs.

zap.options.misc.auto-clrsearch
When on, the search string in the search box is automatically cleared when
the box is opened (by F4/F7).
Press TAB while in the search box to get the old search string.

zap.options.misc.confinecursor
Keeps the cursor in the window when the window is scrolled via arrow keys.

zap.options.mode
Sets default mode to be used for unrecognised filetypes.
Also sets the source mode for mode dependent options to be shown in the
options menus. Please see the !Help file for details.

zap.options.display
As for the window display menu, but changes the default options.

zap.options.ctrlchars
Sets the character set used by zap windows for characters &00-&1f on fast
redraw. Also use this to update the font on a font change.

zap.options.colours
Set the colours used for the various parts of zap.
If you change the background colour then change the cursor colour as well.

zap.options.edit
As for the window edit menu, but changes the default options.

zap.options.tabmode
As for the window tab menu, but changes the default options.

zap.options.minibuffer
Sets the minibuffer status.

zap.options.minibuffer.popup
Causes the minibuffer to 'pop up' only when needed.
Escape will cause it to disappear.

zap.options.minibuffer.permanent
Causes the minibuffer to be open permanently.
This also enables you to see the Meta/Ctrl prefixes.

zap.options.minibuffer.cursortypes
Selects what shape of cursor is used for which cursor action.

zap.options.debug
Debug menu which should not be present in release versions.

zap.newview
Open a new window on the given file.

zap.delete
Remove a given file from memory.

zap.type
Open an empty file of the given type.

zap.create.getmodule
Import given module from memory.
Use Ctrl-I to jump to the header entry points.

zap.create.getworkspace
Import the workspace of a given module.

zap.create.readmemory
Opens a window to import the memory from another task.

zap.create.readdisc
Opens a window to import data from a filecore filing system.

zap.create.taskwindow
Creates a task window.
You will need the module called 'Task' or 'TaskWindow' as supplied
with desktop C.

zap.help
Import the !Help file.

| End