Wrap the list of command line options if needed.
[maxima.git] / doc / implementation / external-interface.txt
blob380cae71829a51a0336d417c28bcb2893907753a
1 This document describes the hooks I added to Maxima in September 2003
2 to aid interfaces to external programs such as TeXmacs.
3 -- James Amundson 
5 Hooks for prompts
6 -----------------
8 *prompt-prefix* : string printed at the beginning of each prompt
9 *prompt-suffix* : string printed at the end of each prompt
11 TeXmacs example:
12 (setf *prompt-prefix* "channel:promptlatex:\\red ")
13 (setf *prompt-suffix* "\\black")
15 (The preceding lines contain control characters.)
17 Hooks for display
18 -----------------
20 *general-display-prefix* : string printed before each displayed output label
21                            Exactly what that means my need refinement.
23 *maxima-prolog* : string printed at the beginning of a Maxima session
24 *maxima-epilog* : string printed at the end of a Maxima session
26 TeXmacs example:
28 (setf *general-display-prefix* "\x02verbatim:")
29 (setf *maxima-prolog* "\x02verbatim:")
30 (setf *maxima-epilog* "\x02latex:\\red The end\\black\x05\x05")
32 (Again, the preceding lines contain control characters.)
34 Alternate display functions
35 ---------------------------
37 *alt-display2d* : function to be used to display maxima equations
38                   when display2d is true
40 *alt-display1d* : function to be used to display maxima equations
41                   when display2d is false
43 TeXmacs example:
45 (setf *alt-display2d* 'latex)
47 The function latex is defined as
49 (defun latex (x)
50   (let ((ccol 1))
51     (mapc #'myprinc
52       (if (and (listp x) (cdr x) (equal (cadr x) "Is  "))
53         (tex x '("\x03$\\displaystyle ") '("$ \x04") 'mparen 'mparen)
54         (tex x '("\x02latex:$\\displaystyle ") '("$\x05
55 ") 'mparen 'mparen)))))