Automated SGML Markup

Instructions for Download and Setup


These instructions are based on the system this was written on, an IBM RS6000 running AIX3.1 and httpd 1.4.

1. Set up a directory structure
Mu uses three (or four) directories: MuHome, where the HTML is stored, and a raw and a cooking directory. MuRoot is the URL pointer to where all the scripts are stored (this may be your cgi-bin directory, or it may be somewhere else- the scripts can be anywhere as long as the server knows where to find them. A directory called cgi under MuHome is a pretty good place). The raw directory contains the sgml template file (more on this in a second). The cooking directory is where the marked up SGML files will be stored. Make these three directories and ensure that they are writeable by your web server.

2. Unpack mu.tar.Z
Download mu.tar.Z if you haven't already and save or move it into the MuHome directory from step 1. Now uncompress and untar that file in that directory (use "uncompress mu.tar.Z" and "tar -xvf mu.tar", for example). The files will be untarred into that directory. Depending on your sever, you may need to rename mu.pl to mu.cgi. You may want to move instruc.html and mu.html somewhere else, also. Make sure all the scripts in muconfig are executable by your web server.

3. Tweak muconfig.pl
Now you need to tell muconfig where your directories are. Open muconfig.pl with your favorite editor, and change $MuRoot, $Raw and $Cooking to the positions of the directories you made. Also, change $Template to the name of the file you are using as a template, i.e. header.raw.sgml. You can also customize the header and tail that gets printed out each time in this file. Make sure not to delete the open and first print statement in Header().

Also, the sizes of the various text input boxes on the form can be changed in muconfig to suit different screens or preferences.

4. Tweak mu.html
Change the lines indicated by the <!--...--> comments in mu.html to the URL for MuHome. You may want to fill in the title of the project and include links to other places on this page, too.

5. SGML template
Put your sgml template file in the raw directory.

6. Check your UNIX permissions again.
Make sure your web server can write to your cooking directory and read from the raw directory!

7. Fire it up!
It should work now. Check out the instructions for use. You will proably have to change some of the switches in your template and customize the input box sizes in muconfig.pl to get it just right.

8. Write a filter Once you have made some SGML files in your cooking directory, write a filter that will remove what you want removed from those cooking files, and store them in a new directory called "done". An example of this will be coming soon- stay tuned to the distribution site at /public/markupdemo/.


Mu : Forms Assisted SGML Markup
By Dan Ancona

© 1996 Board of Visitors of the University of Virginia