HOMEWORK REVIEW GENERATOR v1.2 This program is used to generate homework reviews and reports for Dr. Fulling's MATH 311 class. The program is not complicated, and it can save a great deal of time when reviewing homework. This document explains how to use the program. It is divided into the following sections: A) Creating an Alias B) Running the Program C) Adding and Editing Reviews D) Mailing E) Remarks on the PICO Editor NOTE: In this document, when you are supposed to type a command at the command prompt, it will be enclosed in quotation marks. DO NOT include the quotation marks when you enter the command. ************************************************************************** * (A) Creating an Alias * ************************************************************************** To use this program, the first thing you need to do is add an alias in your .cshrc file. First, log in to any calclab machine, and then type the command "chmod 700 .cshrc" This will allow you to edit your log-in file. (If you are familiar with MS-DOS, this file is similar to AUTOEXEC.BAT.) Then type "pico .cshrc" This will invoke the pico editor and load the file .cshrc. Go down to the bottom of the file (it will probably contain only one line) and add the following line: alias report ~fulling/hreview/report Make sure you press Enter (or Return) at the end of the line. Then hit Control-X to exit the editor. It will ask you if you want to save; press Y and then Enter. (You can also save by typing Control-O before Control-X.) Finally, type "source .cshrc" and Enter. You will need to do all these things only once, not every time you log in. ************************************************************************** * (B) Running the Program * ************************************************************************** Now you can simply type "report" to run the program. Always do this from the same directory, preferably your home directory (where you're put automatically when you log in). When you run the program the first time, it will create a subdirectory named "math311" and copy the blank forms (hreview.txt and hreport.txt) and this documentation file (instruct.txt) into that directory. (If you already have a directory named "math311", the files will not be copied; in that case, use the Unix cp command to copy them from the directory ~fulling/hreview .) When you run the program, you will be asked for the current week and exercise number. After that, you will enter the main menu. This menu will allow you to edit reviews, edit the summary report, or mail the reviews and report. If you choose "Edit Report", it will invoke the pico editor and load the standard report form. Fill in the appropriate fields, and then press Control-X when finished editing. The other two options are explained below. ************************************************************************** * (C) Adding and Editing Reviews * ************************************************************************** When you enter the "Edit Reviews" menu, you should see the option "New Review" at the top, followed by a list of all the reviews you have created. (This will be empty initially.) To edit a given review, simply type the number beside the name. (See (E) below.) To add a new review, type "1" and press enter. You will be asked for the author's calclab email address. This should be seven characters long in the pattern abc1234, and SHOULD NOT include "@calclab.math...". You will then be asked to verify that it is correct. If you have typed it correctly, hit Y and Enter, otherwise hit N and Enter. To return to the main menu, type a Q and press Enter. (The program will leave files in the math311 directory. You should keep these for a couple of weeks in case a problem arises, but eventually you can delete those files whose names begin with exercise numbers. Don't erase the files whose names begin with `h'.) ************************************************************************** * (D) Mailing * ************************************************************************** Once you have edited all the reviews and the summary report, select option 3 from the main menu. You will be asked to confirm your decision to send mail. If you push Y, the report and all reviews will be mailed to the professor and the grader, and each review will be mailed to he appropriate student. If you get an error message, the most likely cause is that you forgot to edit one of the reviews or the report. You must create a review for every student on the list, and you must write a report, or else the mailing program will refuse to work. Once the omission is remedied, it will work. ************************************************************************** * (E) Remarks on the PICO Editor * ************************************************************************** The pico program is essentially the same editor as is used in the pine e-mail program, with which you are probably familiar. It can be used easily over a modem or from any terminal. (Don't try to use a mouse, only cursor keys.) To learn more about how to use pico, explore the menu at the bottom of its screen. Note that it is not necessary to compose a review or report all the way to its final form in one sitting. After you save a file and exit from it, you can return later to to correct or add to it, even after exiting from the report program entirely and later restarting it. Also, you can use the Control-R command in pico to bring in text that you or your partner typed and saved in another file -- composed with any text editor on any computer. (This is especially useful when you need to make the same comments in several reviews.) The only restriction is that you should not choose the mailing option until you have finished all the reviews and the report on the problem concerned. Justin Sadowski February, 1996 revised by S. A. Fulling September, 1996