README file for xml-server, a program that organizes XML files for viewing. Created by Douglas M. Auclair, dauclair@hotmail.com Copyright (c) 2000, Douglas M. Auclair under the GPL (www.fsf.org/copyleft/gpl.html) DESCRIPTION =========== This program takes the document management title name and creates an organized HTML file of all the .xml files in xml/ with links to a Jade script that outputs .html results. The .xml files must be named in the following manner: --.xml xml-server will sort and print by program, then by group ... the link printed will be where '-' is replaced by ' '. REQUIREMENTS ============ * I wrote xml-server entirely in Dylan. A Dylan compiler must be installed. You can get the source or the binaries for d2c (a multi-platform Dylan compiler) from www.gwydiondylan.org * You must have the html library installed. It is available from the same download site. * For Windows systems, you must have Cygnus installed (http://sources.redhat.com/cygwin/) * Apache server installed and working (www.apache.org) (I refer to where apache operates as apache/ from now on) * Jade (a converter that takes XML, parses it with DSSSL, and outputs various formats, including HTML) installed and working ... I have included a sample script (called 'jade') that calls Jade to process the XML documents when requested by the user. * The jade script installed at or under apache/cgi-bin * All XML documents, the .dtd file, the catalog file, and the .dsl file must be in a directory named xml/ and must be directly below the jade script. You must create your own documents (the XML files, the .dtd, the .dsl and the catalog), but I have included a sample set to get you started. INSTALLATION ============ * Make sure you have installed the html library. * Unzipping the .tar.gz file creates a hierarchy of directories (xml-server/ and under that, xml/, meta/ and meta/xml/) and some files (notably the jade script). Move jade to apache/cgi-bin/ and xml/ and all of meta/ below jade. * Modify the files in meta/ and meta/xml/ to point to the appropriate server and linked locations. * Now you must create the executable $ cd xml-server (change, in the source code, the IP-address or name of the server to what your server is). $ make * Move the executable (xml-server) to apache/cgi-bin/. * From an HTML file, call /cgi-bin/xml-server?Document+Name (where Document+Name is of any length and is the name of the XML files page). USAGE ===== * When the client clicks on the link pointing to the xml-server, it will generate a page that sorts and displays all the xml files in xml/. * All the xml files are linked to the jade script. When the client selects an xml file link, the jade script will process the xml file and return an HTML page translation of the xml file. CHANGES ======= * I've factored out the CGI functionality and put it into the html library, both this executable and diane (diane is a notation enhancer) use the html library for CGI chores.