* Move internal/library to internal, xerox font dirs, loadup and medleydir * and MEDLEYDIR too * mised some changes in 'promote/internal' * tiny typo
8 lines
34 KiB
Plaintext
8 lines
34 KiB
Plaintext
|
||
****** The IMTEDIT IM-to-TEDIT translation program. ******
|
||
|
||
author: Michael Sannella
|
||
file: IMTEDIT.DCOM
|
||
loads file: IMTRAN.DCOM
|
||
related files: IMTOOLS.DCOM
|
||
|
||
IM format is the text formatting language that the Interlisp Reference Manual is represented in. It is somewhat like TEX source code, in that there are keywords, and brackets are used to delimit text. However, IM format was specifically designed for representing the Interlisp Manual, so the "text objects" used are semantically meaningful objects within the manual, such as "function definition", "lisp code", "subsection". IM format is described in detail below.
|
||
|
||
IM format files are easy to edit using Tedit, but they don't look very pretty. To produce the manual, use the function IM.TEDIT, which translates IM format files to formatted Tedit text streams. These text streams can be proofread and edited by the user, or automatically printed.
|
||
|
||
A useful feature of IM.TEDIT is that is very forgiving about errors in IM format, even misplaced bracket errors! This is not to say that the output will be pretty, but at least the translation program will not bomb out on you.
|
||
|
||
|
||
***** Formatting a File with IM.TEDIT *****
|
||
|
||
To translate an IM format file into a formatted Tedit text stream, use the following function:
|
||
|
||
(IM.TEDIT INFILE.NAME OUTFILE.FLG) [Function]
|
||
|
||
This function takes an IM format file, and produces a formatted Tedit text stream. INFILE.NAME is the name of an IM format file. OUTFILE.FLG determines what happens to the translated textstream. If OUTFILE.FLG = T, the Tedit textstream is returned by IM.TEDIT. A Tedit window showing the translated document can be created by typing (TEDIT (IM.TEDIT xxx T)). If OUTFILE.FLG = NIL, the document is immediately sent to the printer. If OUTFILE.FLG = anything else, it is taken as a file name for the Interpress file which is created <but not printed>.
|
||
|
||
As IM.TEDIT runs, it prints out warning messages. These messages are also saved in the file <infile>.IMERR.
|
||
|
||
Important note: It is necessary to understand that IM.TEDIT produces a totally separate document from the IM format original. Any edits to this document will NOT be reflected in the original. In general, all of the editing should be done to the IM format files, to insure that there are no inconsistancies.
|
||
|
||
Note: If IM.TEDIT is called with OUTFILE.FLG = T to produce a textstream, and IM.INDEX.FILE.FLG (below) is set to T to add index information to the textstream, the textstream cannot be stored or printed. IM.INDEX.FILE.FLG should only be set to T if IM.TEDIT is called with OUTFILE.FLG not T, so it automatically prints the document to a printer or interpress file.
|
||
|
||
|
||
***** Variables Affecting IM.TEDIT *****
|
||
|
||
The operation of IM.TEDIT affected by a number of variables:
|
||
|
||
IM.NOTE.FLG [Variable]
|
||
If T, notes will be printed out, otherwise they will be suppressed. Initially NIL. (Note: If this is T, the translation programs will print out a message to remind you that notes will be printed.)
|
||
|
||
IM.DRAFT.FLG [Variable]
|
||
If T, the output will have "--DRAFT--" and the date printed on the top and bottom of every page. Initially NIL.
|
||
|
||
IM.CHECK.DEFS [Variable]
|
||
If T, checks whether variables and functions are bound/defined in the current Interlisp environment, and prints a warning if not. For functions, will also check arg list consistancy. Initially NIL.
|
||
|
||
IM.EVEN.FLG [Variable]
|
||
If T, IM.TEDIT will add an extra page at the end of the file saying "[This page intentionally left blank]". This can be used if you need a document with an even number of pages (for double-sided copying). Initially NIL.
|
||
|
||
The following FLGs are only of interest when generating an index:
|
||
|
||
IM.INDEX.FILE.FLG [Variable]
|
||
If T, index information will be added to the formatted Tedit text stream, and the file <infile>.IMPTR will be generated containing index information when the formatted Tedit textstream is printed. Initially NIL.
|
||
|
||
IM.REF.FLG [Variable]
|
||
If T, the translation program will try to resolve cross-references by looking at various hash tables. Initially NIL.
|
||
|
||
IM.SEND.IMPLICIT [Variable]
|
||
If T, send "implicit references" for functions and variables (if not in index hash array). Initially NIL.<2E><> |