Add support for external html docs
[maxima.git] / interfaces / xmaxima / Readme.txt
blobcc61ad105f51399f5822a3e32239625946587615
1 # -*-mode: text; fill-column: 75; tab-width: 8; coding: iso-latin-1-unix -*-
3 #       $Id: Readme.txt,v 1.2 2002-09-05 22:02:12 mikeclarkson Exp $
6 Maxima Tcl Development Notes (by Mike Clarkson):
7 ===============================================
9 Tkmaxima subdirectory
10 ---------------------
12 The file xmaxima is generated from its components
13 by simply cating the components together. Originally the
14 components were mainly one file, xmaxima.tcl, but that
15 has now been broken up into files in the Tkmaxima
16 subdirectory. This will make the files easier to maintain, 
17 and ultimately allow much of the Tcl code to autoload.
18 The only problem about auto-loading them is that the way of finding
19 the directory they're in may differ in a wrapped executable.
21 There is a trick to breaking up the old file into the 
22 Tkmaxima pieces: the order of usage of global constants
23 may have to be preserved. Ultimately may of these
24 constants will go away, but for now the breaking up
25 must be done carefully.
27 Utils subdirectory
28 ------------------
30 There are a number of simple Tcl utilities that are
31 used to help improve and/or clean up the code, in the
32 Utils directory. These should all be auto-loadable.
33 These originally come from the Tixapps collection:
34 http://tix.sourceforge.net/Tixapps/. The latter may
35 contain more recent versions, which should drop in
36 to overwrite these files at any time.
38 Naming Conventions
39 ------------------
41 Filenames should always be Mixed Case, to allow for easier
42 cross-platform work with Windows and Unix. It makes sure
43 long filenames are used on Windows partitions which can be
44 important when working on a Windows partition from Linux.