README
1XMLGEN -- A module to generate XML and/or HTML by writing Tcl code which
2 translates itself.
3 (C) 2002 Harald Kirsch
4
5WHAT IS IT?
6===========
7
8You declare the XML tags you want as Tcl commands. Then you can use
9the natural bracing structure of Tcl to write XML while having all the
10niceties of the script language to define shortcuts or add dynamic
11content.
12
13A simple example based on htmlgen, a module which predefines all the
14HTML tags.
15
16set Title "A Simple Example"
17html ! {
18 head ! {
19 title - $Title
20 }
21 body ! {
22 h1 - $Title
23 p - As you can see, title and major headline agree.
24 }
25}
26
27INSTALLATION
28============
29This package contains three pieces to be installed in different
30directories of your choice:
31
32 1) the Tcl package xmlgen (contains htmlgen)
33 2) HTML documentation for both
34 3) cgi-enabled documentation, mainly here as a proof of concept and
35 as an example
36
37The QUICK INSTALL goes like
38
39 tclsh bras-sa prefix=/usr/local cgi_prefix=/home/html/cgi install
40
41This will create the following directories with some content:
42
43 /usr/local/lib/xmlgen-1.0 (possibly different version number)
44 /usr/local/doc/xmlgen-1.0 (dto.)
45 /home/html/cgi/xmlgen-1.0 (dto.)
46
47NOTES:
48
491) For the cgi-enabled documentation to work you need two things:
50 a) Convince your web server to run $CGDIR/index as a Tcl script.
51 b) Make sure this script can find a recent tcllib. It needs the
52 package ncgi.
53
542) If you want to set the subdirectory names yourself, then specify
55*all* of PKGDIR, DOCDIR and CGIDIR instead of prefix and cgi_prefix.
56
573) In any case, the parent directory of PKGDIR, /usr/local/lib in the
58example, MUST appear in the auto_path variable of the tclsh you intend
59to use. (HINT: auto_path is initialized also from the TCLLIBPATH
60environment variable.)
61
624) bras-sa is a standalone version of bras, the make replacement
63written in Tcl to be found at http://bras.berlios.de/ . It uses the
64brasfile in this directory to do its work.
65
66
67LICENSE
68=======
69BSD derived, see file LICENSE
70
71
72CONTACT
73=======
74Harald Kirsch
75pifpafuf bei gmx punkt de
76
77----------------------
78last modified: $Date: 2002/05/27 21:50:52 $
79