next up previous contents index
Next: Threads Up: Help files Previous: Structure of help files   Contents   Index

Colors in help files

It is possible to add colors to the contents of the subjects of a help file, by typing directly ANSI color codes or by using the tool help_convert. This program will convert help files containing simple color codes into help files containing the corresponding ANSI color codes. The color codes are

$\backslash$0 : black
$\backslash$r : red
$\backslash$g : green
$\backslash$y : yellow
$\backslash$b : blue
$\backslash$m : magenta
$\backslash$l : lightblue
$\backslash$w : white

The program help_convert must be used as follows :

help_convert in_file out_file n

where n is 0 or 1. Here in_file is the preliminary help file containing the colour codes, out_file the final help file with ANSI color codes if n is 1, and with no color codes if n is 0.

Example : the beginning of a help file with color codes :

\badd  \mobj1  obj2  obj3\0
This command is used to add two objects. 
Here the objects \mobj1\0, \mobj2\0 are added and the result is stored in 
object \mobj3\0. 
The objects must have been defined and be of the same type. Their dimensions 
must be the same.
\bassign \mstruc mb_name obj_name\0
This command assigns the object (or structure) whose name is \mobj_name\0 
to the member \mmb_name\0 of the structure \mstruc\0.
If the member \mmb_name\0 is a variable of the expression evaluator, the 
syntax is different :

\bassign \mstruc mb_name xxx\0

where \mxxx\0 is a numerical expression. The name of the variable is the 
name of the structure, followed by _  and by the name of the member.