Poplog/VED

Copy of Documentation from elseweb

from: http://www.cs.bham.ac.uk/research/projects/poplog/ved-docs/help/ved

HELP VED Andrew Law, April, 1987

                                              Updated A.Sloman Oct 1990

   This help file describes some of the files relating to POPLOG's

screen editor - VED. It assumes some knowledge of how to use the VED editor.

        CONTENTS - (Use <ENTER> g to access required sections)

-- Introductions 
-- General Facilities
-- Wordprocessing and text formatting
-- Programming in VED
-- Running shell or DCL from a VED window
-- VED input/output
-- Information about files
-- Altering VED's behaviour for different kinds of files
-- Making VED emulate EMACS
-- Customising VED
-- Terminal setups for different terminals
-- Information on key-bindings and terminals
-- Interacting with VED under program control
-- Graphics facilities in VED
-- Using VED with mail and net news
-- Associated Documentation

Introductions ----------------------------------------------------

There are various introductions to VED available.

The printed Poplog User Guide. (You may also have access to a printed VED user guide, though it is likely to be out of date.)

Others:

HELP * VED, - this file
TEACH * TEACH - getting started using VED to read  teach files.
TEACH * VED,  * MOREVED - introductions

DOC * VEDMANUAL, * VEDUSERGUIDE
   - more detailed overviews. (May be in need of revision)

REF * VEDCOMMS
   Information about VED ENTER commands
REF * VEDPROCS
   Information about other VED procedures
REF * VEDVARS
   Information about VED global variables

HELP * XVED
   Information on the X windows orientated editor XVed.

General Facilities -----------------------------------------------

HELP *VEDCOMMANDS, REF *VEDCOMMS

   Using ENTER commands

HELP *MARK

   Marking text for functions to be performed on sections of it

HELP *WINDOWS, *WINDOW, *BUFFERS, *VEDFILESELECT, *VED_GO *SWITCHWINDOW

   Editing more than one file, switching between files

TEACH *MOREVED, HELP *VEDSEARCH, *SUBSTITUTE, *VED_SS, *VED_WW

   Search, substitution and deletion of text

HELP * ENTER_G

   Searching for section headings, creating VED files with headings and
   tables of contents in the format of this file.

HELP * STANDARDS

   Advice on producing online documentation and libraries.

HELP *YANK

   Retrieving text deleted using ENTER d

HELP *DIFF, *CDIFF

   Comparing two files for differences

HELP *WORDCOUNT, *COUNTITEM, *WC, *VEDWORDCOUNT_TEXT

   Counting the items in the text

HELP * COPY, *YANK, *INOROUT

   Moving text from one file to another

HELP * SWL, * SWR

   Swap word left or right

HELP * VED_PRINT

   Printing current file on printer

HELP * VEDBLOCKS

   Facilities for manipulating rectangular blocks of text in VED

HELP * PIPEUTILS (Unix only)

   Facilities for spawning sub-shells and getting output into
   a VED file.

Wordprocessing and text formatting -------------------------------

HELP *FORMAT, *PAGE

   Formatting facilities available in VED

REF * VEDCOMMS/Justification

   Including ved_j, ved_jj, ved_jp, ved_jjp, ved_fp, ved_gobble
       ved_fill, ved_centre, ved_right, ved_ljmr, ved_bl, etc.

HELP * STANDARDS

   Advice on producing online documentation and libraries.

Programming in VED -----------------------------------------------

HELP *LISPVED, *VEDPOP

HELP * LMR

   Compiling marked ranges

HELP *LCP

   Loading current procedure

HELP *IM *VEDCOMMS/ved_im

   Immediate compilation mode in (for POP-11, PROLOG and LISP)

Running shell or DCL from a VED window ---------------------------

HELP *IMCSH, *IMSH, * VED_CSHFILE (Unix only) HELP *IMDCL (VMS only),

VED input/output -------------------------------------------------

HELP *VEDINPUT, *VEDOUTASCII, *VEDINASCII, *VEDOUT

   IO procedures used by VED

HELP * VEDSCREENCONTROL

   Terminal control procedure

HELP *VEDIOCONTROL (Unix only)

   Changing IO behaviour in VED

HELP *IC, *VED_CC

   Inserting or examining control characters etc. into the VED buffer

See also relevant sections in HELP *IO, REF * CHARIO, REF * SYSIO

Information about files ------------------------------------------

HELP * VEDSYSFILE

   Accessing documentation files

HELP * VEDGETSYSFILE, * VEDGETSYSFILEPDR

   Browsing files and cross referencing using <ESC> h.

Altering VED's behaviour for different kinds of files ------------

HELP * VEDNONBREAKFILES

   Preventing automatic line breaks in certain types of files.

HELP * VEDVEDDEFAULTS

   Setting VED's defaults before each file is first created.

HELP * VEDFILETYPES

   Tailoring VED to different sorts of files, on the basis of the file
   (path) name.

HELP * VEDINITIALISE

   Tailoring VED to a particular file's contents.

REF * VEDINITFILE

   Tailoring VED's behaviour whenever a file is put on screen.

Making VED emulate EMACS -----------------------------------------

HELP * VEDEMACS

   Partial EMACS emulation in VED

Customising VED --------------------------------------------------

(See also next section) HELP * INITIAL * INITIAL.EX

   Tailoring POPLOG and VED. The second file has some examples supplied
   by users

HELP * VEDSET

   Tailoring VED to a particular screen or keyboard

HELP * DM, * DK, * VEDSETKEY, * VEDMACROS

   Defining new key sequences and VED <ENTER> commands.

HELP * VEDPROCS

   Procedures available in VED for defining user extensions

REF * VEDVARS

   Variables used by VED, including user-assignable variables that
   control VED's behaviour (see section on Altering VED's behaviour
   for different kinds of files, above).

HELP * VEDEXPAND

   A VED command line abbreviation facility

HELP * VEDINDENTSTEP

   Defining the tab step in VED

HELP * TABIFY

   Converting spaces in a VED file to tabs

HELP * VEDNOTABS, * VEDHARDTABS, * VEDREADINTABS

   Determining whether VED should keep tabs in files or simply use
   spaces

REF * VEDTERMINALS, HELP * VEDTERMINALSELECT

   How VED interrogates terminal on startup

HELP *VEDVERSIONS

   Altering the number of versions of files saved on disk

The next section includes information on VED libraries that customise VED key bindings for particular terminals. The following section lists facilities for tailoring the mappings from keys to VED functions.

Terminal setups for different terminals --------------------------

Other help files on specific terminals are available:

   HELP * AUTOV55   for automatic recognition of a Visual 55
   HELP * TVI       for TELEVIDEO model 920C with VT-52 equivalence.
   HELP * V55       for Visual 55
   HELP * V550      for Visual 550
   HELP * VEDCIFER  for CIFER model 2634 (supercedes * CIFER)
   HELP * VEDSUN    for SUN monitor emulating a VDU
   HELP * VEDWINSUN extends SUN facilities in a Shelltool window
   HELP * VEDWYSE   for WYSE emulating Televideo 925
   HELP * VT220KEYS for Falco 5220, Televideo 9220, DEC VT220
   HELP * VT52      for a 'dumb' VT52 type VDU
   HELP * VT100     for a VT100 type terminal

Others:

HELP *MOREVT100 *SETV55KEYS *BBCVT100 BBCVT100KEYS *CIFERKEYS *NCDKEYS
     *OLDVEDSUN *SETV55KEYS *V200 *V500 *V55KEYS *ANSIKEYS *VEDATARI
     *VEDATARIKEYS *VEDKEY5 *VEDSUN *VEDWINSUN *VEDWYSE
     *VT100KEYS *VT101KEYS

== Information on key-bindings and terminals -------------------------- HELP * VEDKEYS

   General information on key sequences

HELP * VEDSET

   Information on setting up new key bindings

HELP * VEDSETKEY

   Changing individual key bindings

HELP *LOGICAL_KEYS

   Logical names for VED key sequences

HELP *VED_HKEY,

   Procedures associated with VED keys

HELP *DK

   Redefining key sequences

HELP *VEDTERMINALSELECT

   Program control over terminal selection

HELP * VEDEMACS

   Describes how to get Emacs-style key bindings set up.

HELP * VEDOLDKEYS

   Describes the VED default settings prior to Poplog Version 14, and
   how to set them.

See Also REF * VEDTERMINALS, HELP * TERMINAL

   Give information about VED initialisation processes and automatic
   terminal setup.

== Interacting with VED under program control -------------------------

HELP * VEDPROCS

   Procedures available for driving VED

HELP * VEDDO

   A procedure for executing VED command strings

HELP * VEDOPEN

   Creating a new ved buffer under program control

HELP * VEDPOPEXIT

   Leaving POP/VED

HELP * VEDPOPREADY

   Handling interrupt breaks in VED

== Graphics facilities in VED -----------------------------------------

HELP *SHOWTREE

   Printing structures into a VED buffer with graphics

HELP *SEETREE

   Interface to SHOWTREE

HELP *SHOWTREE, *VTURTLE

   Graphics libraries using character displays

HELP * DRAWLINE, *RUBOUT

   Drawing horizontal and vertical lines in VED buffer.

REF *VEDPROCS/Graphics *VEDCOMMS/Attributes

   Graphics characters in Ved files

== Using VED with mail and net news -----------------------------------

HELP * SEND , * VED_SEND

   Sending mail from inside a VED file (Sussex local files)

HELP * VED_MAIL (Unix only)

   Reading Unix mail into VED

HELP * VED_MDIR (Unix only)

   Build an index or directory for a Unix mail file

HELP * VED_REPLY (Unix only)

   Reply to unix mail in VED buffer

HELP * VED_NET

   Reading Unix net news bulletins in VED

HELP * VED_POSTNEWS

   Posting or replying to Unix net news bulletins from VED

== Associated Documentation -------------------------------------------

HELP *INDEX

   A list of HELP files

HELP * DOCUMENTATION

   Information about reading/creating online documentation in Poplog

HELP * HELPFILES

   Information on HELP files in POPLOG

REF * REFFILES

   Information on REF files  available

DOC *VEDUSERGUIDE, *VEDMANUAL (out of date, but may still be useful)

   General overviews of VED.

HELP * NEWS

   A summary of recent changes to Poplog, including changes to VED.

-== C.all/help/ved -== Copyright University of Sussex 1993. All rights reserved. ----------